shipyard/src/bin/shipyard_airflow
Bryan Strassner e5a0bf4a32 [trivial] fix several minor issues
This cleanup fixes a handful of items identified as not
blocking a larger patchset.

Change-Id: I4642112c444c546c0bb271ed58a2d9b76155cad7
2018-06-22 13:05:32 -05:00
..
alembic Add Apache 2.0 LICENSE file 2018-05-14 13:46:28 +00:00
etc/shipyard Add Keystone options to registration of config 2018-06-06 14:50:54 -05:00
generator Refactor shipyard to UCP target layout 2018-04-24 16:47:13 -05:00
shipyard_airflow [trivial] fix several minor issues 2018-06-22 13:05:32 -05:00
tests Workflow to support deployment groups 2018-06-20 09:55:15 -05:00
.coveragerc Refactor shipyard to UCP target layout 2018-04-24 16:47:13 -05:00
README.md Refactor shipyard to UCP target layout 2018-04-24 16:47:13 -05:00
alembic.ini Refactor shipyard to UCP target layout 2018-04-24 16:47:13 -05:00
entrypoint.sh Refactor shipyard to UCP target layout 2018-04-24 16:47:13 -05:00
requirements.txt Update Deckhand commit 2018-06-01 21:16:08 +01:00
setup.py Refactor shipyard to UCP target layout 2018-04-24 16:47:13 -05:00
test-requirements.txt [refactor] logging refactor + redaction filter 2018-06-01 17:14:15 -05:00
tox.ini Add Keystone options to registration of config 2018-06-06 14:50:54 -05: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.

Find more documentation for Shipyard on Read the Docs

Integration 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 management 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)