A cluster lifecycle orchestrator for Airship.
Go to file
Anthony Lin b8bb66d412 Update Scripts
We will no longer need to manually update the '/etc/hosts' file
for 'in-cluster' scenario with the bug fix in [0]. This patch set
is meant to update the scripts in the tools directory to reflect
that change.

Note that user will still need to ensure that the DNS is set up or
'/etc/hosts' file is properly updated if he/she is executing the
workflow from outside the cluster, e.g. via jump server

[0] https://review.gerrithub.io/#/c/398739/

Change-Id: I0580cfc473b0f1b0ed824a578d3e6c89dd6f1443
2018-02-09 15:48:30 +00:00
alembic Document staging api 2017-10-18 18:39:24 -05:00
charts/shipyard Shipyard DB init grant use admin user 2018-02-07 18:11:12 -06:00
docs Shipyard Documentation for Dryrun Option/Query 2018-01-12 16:07:20 -05:00
etc/shipyard Make Request Timeout Configurable 2018-02-07 01:32:10 +00:00
generator Add Action API 2017-09-22 21:47:13 -05:00
images Shipyard-270 - Rendered document schema validation check 2018-01-27 01:51:34 +00:00
shipyard_airflow Make Request Timeout Configurable 2018-02-07 01:32:10 +00:00
shipyard_client Support ValidationMessage for validations 2018-01-30 11:24:12 -05:00
tests Make Request Timeout Configurable 2018-02-07 01:32:10 +00:00
tools Update Scripts 2018-02-09 15:48:30 +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 Make Ingress proxy-read-timeout Configurable 2018-02-07 18:37:12 +00:00
requirements.txt Add CLI formatted responses to Shipyard CLI 2017-11-20 10:38:46 -06:00
setup.cfg Add database upgrade entrypoint 2018-01-25 09:37:00 -05:00
setup.py Add Action API 2017-09-22 21:47:13 -05:00
test-requirements.txt Align test-reqs with airflow image 2018-02-05 11:26:54 -05: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)