airship
/
shipyard
Code Issues Proposed changes
A cluster lifecycle orchestrator for Airship.
121 Commits 3 Branches 0 Tags 8.1 MiB
Python 95.7%
Shell 3.1%
Smarty 0.8%
Makefile 0.4%
Go to file
Hassan Kaous 3ac47328c3 Document staging api 
The purpose of the document staging api is to provide a client of
shipyard to ingest and manipulate documents within the UCP platform

In support of the need to reach out to other services, this change
also introduces the use of keystone for service discovery and connection
to other UCP services.

Change-Id: I6fa113f8786cad2884c0b791788a4ef40cd1a6b6
 		2017-10-18 18:39:24 -05:00
alembic Document staging api 2017-10-18 18:39:24 -05:00
docs Document staging api 2017-10-18 18:39:24 -05:00
etc/shipyard Document staging api 2017-10-18 18:39:24 -05:00
generator Add Action API 2017-09-22 21:47:13 -05:00
shipyard_airflow Document staging api 2017-10-18 18:39:24 -05:00
tests Document staging api 2017-10-18 18:39:24 -05:00
.gitignore Shipyard documentation via build_sphinx 2017-10-06 15:51:35 -04:00
.gitreview Add gitreview file 2017-08-11 01:20:56 -05:00
AUTHORS Document staging api 2017-10-18 18:39:24 -05:00
Dockerfile Add Action API 2017-09-22 21:47:13 -05: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 Requirements for memcached. 2017-10-06 15:12:54 -04:00
setup.cfg Shipyard documentation via build_sphinx 2017-10-06 15:51:35 -04:00
setup.py Add Action API 2017-09-22 21:47:13 -05:00
test-requirements.txt Shipyard documentation via build_sphinx 2017-10-06 15:51:35 -04:00
tox.ini Fix PEP8 Issues in Shipyard 2017-10-17 19:41:06 -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 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)