airship
/
shipyard
Code Issues Proposed changes
A cluster lifecycle orchestrator for Airship.
240 Commits 3 Branches 0 Tags 8.1 MiB
Python 95.7%
Shell 3.1%
Smarty 0.8%
Makefile 0.4%
Go to file
One-Fine-Day 6994db10ca Shipyard Client API for Configdocs Status 
Shipyard API to discover buffered and committed collections of configdocs

2 of 4 Commits (API, CLI, Documentation are in separate commits)

API Client
-added url access function in shipyard_api_client.py
-unit tests are located in test_shipyard_api_client.py

Change-Id: I9c78724a96e803a70689b0028601f043ebc3b46c
 		2018-01-05 16:43:35 -05:00
alembic Document staging api 2017-10-18 18:39:24 -05:00
charts/shipyard RBAC: Update serviceaccount and k8s rbac for shipyard 2017-12-28 17:56:02 +00:00
docs Conform expected validation responses to status standard 2018-01-03 07:37:18 -06:00
etc/shipyard Refactor UCP Health Check Operator 2017-12-18 17:24:28 +00:00
generator Add Action API 2017-09-22 21:47:13 -05:00
images Update makefile with run commands 2017-12-11 12:07:44 -06:00
shipyard_airflow Shipyard API for Configdocs Status 2018-01-05 09:50:09 -06:00
shipyard_client Shipyard Client API for Configdocs Status 2018-01-05 16:43:35 -05:00
tests Shipyard API for Configdocs Status 2018-01-05 09:50:09 -06:00
tools Update Deploy Site Script 2017-12-20 02:57:08 -05:00
.coveragerc Unit Test for WorkflowResource and WorkflowIdResource 2017-12-05 11:43:26 -06:00
.gitignore ActionsValidationsResource and VersionsResource Unit Tests 2017-12-06 13:27:18 -06:00
.gitreview Add gitreview file 2017-08-11 01:20:56 -05:00
Makefile Update makefile with run commands 2017-12-11 12:07:44 -06: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 Adds keystonemiddleware and falcon to test-requirements 2017-12-06 09:54:37 -06:00
tox.ini Unit Test for WorkflowResource and WorkflowIdResource 2017-12-05 11:43:26 -06: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)