A cluster lifecycle orchestrator for Airship.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Anthony Lin ed8107baad Add Backoff time before checking cluster join 5 years ago
alembic Document staging api 5 years ago
charts/shipyard Add Backoff time before checking cluster join 5 years ago
docs Add Shipyard Client user guide 5 years ago
etc/shipyard Add Backoff time before checking cluster join 5 years ago
generator Add Action API 5 years ago
images Move Shipyard and Airflow Dockerfiles 5 years ago
shipyard_airflow Add Backoff time before checking cluster join 5 years ago
shipyard_client Add samples to CLI command documentation 5 years ago
tests Add Backoff time before checking cluster join 5 years ago
tools Update deploy_site script 5 years ago
.coveragerc Unit Test for WorkflowResource and WorkflowIdResource 5 years ago
.gitignore ActionsValidationsResource and VersionsResource Unit Tests 5 years ago
.gitreview Add gitreview file 5 years ago
Makefile Add docs target to Makefile 5 years ago
README.md Enhance the README for Shipyard 5 years ago
alembic.ini Add Action API 5 years ago
entrypoint.sh Add Action API 5 years ago
requirements.txt Add CLI formatted responses to Shipyard CLI 5 years ago
setup.cfg CLI for Shipyard API 5 years ago
setup.py Add Action API 5 years ago
test-requirements.txt Adds keystonemiddleware and falcon to test-requirements 5 years ago
tox.ini Unit Test for WorkflowResource and WorkflowIdResource 5 years ago

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)