airship
/
shipyard
Code Issues Proposed changes
A cluster lifecycle orchestrator for Airship.
139 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 7b67b8faf2 Add bandit, coverage and docs to tox 
Introduces code coverage and expands the use of bandit to include
the shipyard_client. Triggers the run of bandit, coverage, and docs
to the base tox execution. Addresses several bandit issues by either
fixing or supplying # nosec to known "ok" uses of code that would
otherwise trigger a bandit error being reported.

This change also removes an artifact from refactoring (deckhand_client.py)
which moved to a subdirectory.

Change-Id: I47b4a6b945ade7ba42bc73a850848cd45c0b2390
 		2017-10-25 22:36:39 -05:00
alembic Document staging api 2017-10-18 18:39:24 -05:00
charts/shipyard Update DryDock Operator & Shipyard Chart 2017-10-24 01:53:58 +00:00
docs Implement the inquiry API for Shipyard. 2017-10-19 14:54:31 -04: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
images Move Shipyard and Airflow Dockerfiles 2017-10-20 19:31:06 +00:00
shipyard_airflow Add bandit, coverage and docs to tox 2017-10-25 22:36:39 -05:00
shipyard_client Shipyard api client 2017-10-23 16:05:50 -05:00
tests Refactor API to organize directories 2017-10-19 15:54:06 -05:00
.coveragerc Add bandit, coverage and docs to tox 2017-10-25 22:36:39 -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
Makefile Move Shipyard and Airflow Dockerfiles 2017-10-20 19:31:06 +00: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 Implement the inquiry API for Shipyard. 2017-10-19 14:54:31 -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 Add bandit, coverage and docs to tox 2017-10-25 22:36:39 -05:00
tox.ini Add bandit, coverage and docs to tox 2017-10-25 22:36:39 -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)