A cluster lifecycle orchestrator for Airship.
Go to file
Anthony Lin 768981df44 Refactor UCP Health Check Operator
There has been significant changes to the Shipyard code base
since the last major update to the UCP Health Check Operator.
This patch set is meant to align its implementation with the
rest of the Operators.

It removes the usage of 'urlopen' which can be a security
risk and make use of the python 'requests' module instead.

We are also adding 'timeout' parameters to the other Operators
that are using 'requests.get' as failure to do so can cause
the Operator(s) to hang indefinitely. The default time out
has been set to 30 seconds. It is noted that nearly all production
code should use this parameter in nearly all requests.

Change-Id: I1205aab38ff120cd239c236dc9bdffd1660c9afb
2017-12-18 17:24:28 +00:00
alembic Document staging api 2017-10-18 18:39:24 -05:00
charts/shipyard Refactor UCP Health Check Operator 2017-12-18 17:24:28 +00:00
docs Add Shipyard Client user guide 2017-12-05 13:52:11 -06:00
etc/shipyard Refactor UCP Health Check Operator 2017-12-18 17:24:28 +00:00
generator Add Action API 2017-09-22 21:47:13 -05:00
images Update makefile with run commands 2017-12-11 12:07:44 -06:00
shipyard_airflow Refactor UCP Health Check Operator 2017-12-18 17:24:28 +00:00
shipyard_client Add samples to CLI command documentation 2017-11-27 15:32:39 -06:00
tests Refactor UCP Health Check Operator 2017-12-18 17:24:28 +00:00
tools Refactor UCP Health Check Operator 2017-12-18 17:24:28 +00:00
.coveragerc Unit Test for WorkflowResource and WorkflowIdResource 2017-12-05 11:43:26 -06:00
.gitignore ActionsValidationsResource and VersionsResource Unit Tests 2017-12-06 13:27:18 -06:00
.gitreview Add gitreview file 2017-08-11 01:20:56 -05:00
Makefile Update makefile with run commands 2017-12-11 12:07:44 -06:00
README.md Enhance the README for Shipyard 2017-10-13 21:30:01 -05:00
alembic.ini Add Action API 2017-09-22 21:47:13 -05:00
entrypoint.sh Add Action API 2017-09-22 21:47:13 -05:00
requirements.txt Add CLI formatted responses to Shipyard CLI 2017-11-20 10:38:46 -06:00
setup.cfg CLI for Shipyard API 2017-11-08 14:28:08 -06:00
setup.py Add Action API 2017-09-22 21:47:13 -05:00
test-requirements.txt Adds keystonemiddleware and falcon to test-requirements 2017-12-06 09:54:37 -06:00
tox.ini Unit Test for WorkflowResource and WorkflowIdResource 2017-12-05 11:43:26 -06:00

README.md

Shipyard

Shipyard is the directed acyclic graph controller for Kubernetes and OpenStack control plane life cycle management, and a component of the Undercloud Platform (UCP)

Shipyard provides the entrypoint for the following aspects of the control plane established by the UCP:

Designs and Secrets
Site designs, including the configuration of bare metal host nodes, network design, operating systems, Kubernetes nodes, Armada manifests, Helm charts, and any other descriptors that define the build out of a group of servers enter the UCP via Shipyard. Secrets, such as passwords and certificates use the same mechanism.
The designs and secrets are stored in UCP's Deckhand, providing for version history and secure storage among other document-based conveniences.
Actions
Interaction with the site's control plane is done via invocation of actions in Shipyard. Each action is backed by a workflow implemented as a directed acyclic graph (DAG) that runs using Apache Airflow. Shipyard provides a mechanism to monitor and control the execution of the workflow.

Intgration Points:

OpenStack Identity (Keystone) provides authentication and support for role based authorization.
Apache Airflow provides the framework and automation of workflows provided by Shipyard.
PostgreSQL is used to persist information to correlate workflows with users and history of workflow commands.
Deckhand supplies storage and mangement of site designs and secrets
Drydock is orchestrated by Shipyard to perform bare metal node provisioning.
Promenade is indirectly orchestrated by Shipyard to configure and join Kubernetes nodes
Armada is orchestrated by Shipyard to deploy and test Kubernetes workloads

Getting Started:

Shipyard @ Gerrithub
Helm chart

See also:

Undercloud Platform (UCP)