airship
/
shipyard
Code Issues Proposed changes
A cluster lifecycle orchestrator for Airship.
188 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 fde16f218e Move most Shipyard docs to .rst 
This patchset moves most of the documentation for
shipyard from markdown to reStructuredText.
README.md remains as it is nice for Github consumption
and serves as a gateway to the rest of the generated
documentation.

Change-Id: I8cec38fe0e30e9a545cb6e79ae6de1934f7dfc4e
 		2017-12-04 13:36:26 -06:00
alembic Document staging api 2017-10-18 18:39:24 -05:00
charts/shipyard Images: Remove Kolla-Toolbox image as not required 2017-11-16 12:12:05 -05:00
docs Move most Shipyard docs to .rst 2017-12-04 13:36:26 -06:00
etc/shipyard Unit Tests for ActionsResource 2017-11-30 08:44:32 -06: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 Merge "Update DeckhandOperator to do filtering/sorting server-side" 2017-12-01 17:31:56 -05:00
shipyard_client Add samples to CLI command documentation 2017-11-27 15:32:39 -06:00
tests Merge "Unit Tests for ActionsIdResource" 2017-12-01 13:38:09 -05:00
tools Update deploy_site script 2017-11-30 01:53:35 +00:00
.coveragerc Add bandit, coverage and docs to tox 2017-10-25 22:36:39 -05:00
.gitignore Move most Shipyard docs to .rst 2017-12-04 13:36:26 -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 Add CLI formatted responses to Shipyard CLI 2017-11-20 10:38:46 -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 CLI formatted responses to Shipyard CLI 2017-11-20 10:38:46 -06:00
tox.ini Add basepython=python3.5 to tox.ini to avoid error in some envs 2017-11-30 04:47:24 +00: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)