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.
Pete Birley fb7548230d Git: update gitignore to exclude built charts 4 years ago
alembic Document staging api 4 years ago
charts/shipyard [fix] add labels to shipyard jobs 4 years ago
docs Documentation for Shipyard deployment-configuration 4 years ago
etc/shipyard Shipyard deployment configuration 4 years ago
generator Add Action API 4 years ago
images Add Airflow Worker Upgrade Workflow 4 years ago
shipyard_airflow Update K8s Preflight Check Operator 4 years ago
shipyard_client [391107] Sorting of commit configdocs results 4 years ago
tests [Fix] Armada Operator/Dag - Task Id and Xcom Key 4 years ago
tools Use Shipyard Docker Container for Tools Scripts 4 years ago
.coveragerc Unit Test for WorkflowResource and WorkflowIdResource 4 years ago
.editorconfig Cleanup dockerfile and add editorconfig 4 years ago
.gitignore Git: update gitignore to exclude built charts 4 years ago
.gitreview Add gitreview file 5 years ago
Makefile Removing Whitespace 4 years ago
README.md [docs] Include Read the Docs link in README 4 years ago
alembic.ini Add Action API 4 years ago
entrypoint.sh Make Ingress proxy-read-timeout Configurable 4 years ago
requirements.txt Add CLI formatted responses to Shipyard CLI 4 years ago
setup.cfg Add database upgrade entrypoint 4 years ago
setup.py Add Action API 4 years ago
test-requirements.txt SY/AF Test version pinning 4 years ago
tox.ini Shipyard deployment configuration 4 years ago



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.
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)