airship
/
shipyard
Code Issues Proposed changes
A cluster lifecycle orchestrator for Airship.
341 Commits 3 Branches 0 Tags 8.1 MiB
Python 95.7%
Shell 3.1%
Smarty 0.8%
Makefile 0.4%
Go to file
Bryan Strassner a0a744fd88 Documentation for Shipyard deployment-configuration 
Updates workflow documentation to include information explaining the
deployment configuration document used by Shipyard

Change-Id: I1062958f51b7d9a49711d40d4dc892e7f6bfc1af
 		2018-03-13 17:54:21 -05:00
alembic Document staging api 2017-10-18 18:39:24 -05:00
charts/shipyard Shipyard_API - Liveness and Readiness Probes 2018-03-12 04:54:46 +00:00
docs Documentation for Shipyard deployment-configuration 2018-03-13 17:54:21 -05:00
etc/shipyard Shipyard deployment configuration 2018-03-12 13:31:11 -05:00
generator Add Action API 2017-09-22 21:47:13 -05:00
images Pin Deckhand Client Version 2018-03-07 02:54:48 +00:00
shipyard_airflow Shipyard deployment configuration 2018-03-12 13:31:11 -05:00
shipyard_client Shipyard CLI guard empty directory 2018-02-25 20:54:14 -05:00
tests Shipyard deployment configuration 2018-03-12 13:31:11 -05:00
tools Update Makefile 2018-02-25 13:23:33 -05:00
.coveragerc Unit Test for WorkflowResource and WorkflowIdResource 2017-12-05 11:43:26 -06:00
.editorconfig Cleanup dockerfile and add editorconfig 2018-02-16 13:44:15 -06:00
.gitignore Cleanup dockerfile and add editorconfig 2018-02-16 13:44:15 -06:00
.gitreview Add gitreview file 2017-08-11 01:20:56 -05:00
Makefile Removing Whitespace 2018-02-25 12:40:27 -06:00
README.md Testing Merge 2018-03-02 10:02:29 -06: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 Shipyard deployment configuration 2018-03-12 13:31:11 -05:00
tox.ini Shipyard deployment configuration 2018-03-12 13:31:11 -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.

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