A cluster lifecycle orchestrator for Airship.
Go to file
One-Fine-Day 0bd4d339cb Unit Tests for BaseResouce and ShipyardRequestContext
test_base_resource.py contains the unit tests for the BaseResource

test_shipyard_request_context.py contains the unit tests for the ShipyarRequestContext

Change-Id: Idad82c06828e5ce2ef4e2ceb9fe2f2805e5746a1
2017-11-16 15:55:21 -06:00
alembic Document staging api 2017-10-18 18:39:24 -05:00
charts/shipyard Fix typo in Shipyard Chart 2017-11-04 15:32:31 +00:00
docs Update docs and CLI options to match 2017-11-13 12:43:48 -04:00
etc/shipyard Document staging api 2017-10-18 18:39:24 -05:00
generator Add Action API 2017-09-22 21:47:13 -05:00
images Move Shipyard and Airflow Dockerfiles 2017-10-20 19:31:06 +00:00
shipyard_airflow Unit Tests for BaseResouce and ShipyardRequestContext 2017-11-16 15:55:21 -06:00
shipyard_client Update docs and CLI options to match 2017-11-13 12:43:48 -04:00
tests Unit Tests for BaseResouce and ShipyardRequestContext 2017-11-16 15:55:21 -06:00
tools Update deploy_site script 2017-11-07 17:56:15 +00:00
.coveragerc Add bandit, coverage and docs to tox 2017-10-25 22:36:39 -05:00
.gitignore Action lifecycle mapping include unknown 2017-11-07 10:45:24 -06:00
.gitreview Add gitreview file 2017-08-11 01:20:56 -05:00
Makefile Fix: deps before charts 2017-11-06 11:10:41 -07: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 CLI for Shipyard API 2017-11-08 14:28:08 -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 Add bandit, coverage and docs to tox 2017-10-25 22:36:39 -05:00
tox.ini Unit Tests for BaseResouce and ShipyardRequestContext 2017-11-16 15:55:21 -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)