airship
/
shipyard
Code Issues Proposed changes
shipyard/src/bin/shipyard_airflow
History
Carter, Matthew (mc981n) 222b074cb1 Be configuration driven when referencing document names/schemas 
Currently, any document name or schema referenced in the Shipyard
code base is a hard-coded string. Often times, these strings are
repeated throughout the code. This patch set adds a new configuration
section to shipyard.conf to define document names and schemas so they
can then be referenced in the Shipyard code via the oslo
configuration object. This functionality will be important for
upcoming Shipyard features which will call for more documents to be
validated as well as some new Shipyard-created docs.

Change-Id: I34ae8cd578bab730d004c3d176e3817b5a45c89e
 		2019-05-02 10:47:38 -05:00
..
alembic Add notes common code for Shipyard 2018-10-05 15:40:48 -05:00
etc/shipyard Be configuration driven when referencing document names/schemas 2019-05-02 10:47:38 -05:00
generator Refactor shipyard to UCP target layout 2018-04-24 16:47:13 -05:00
shipyard_airflow Be configuration driven when referencing document names/schemas 2019-05-02 10:47:38 -05:00
tests Be configuration driven when referencing document names/schemas 2019-05-02 10:47:38 -05:00
.coveragerc Set ULID of action on DAG request 2018-08-10 10:23:30 -05:00
README.md Fix: various documentation and URL fixes 2018-09-24 12:53:27 +02:00
alembic.ini Refactor shipyard to UCP target layout 2018-04-24 16:47:13 -05:00
entrypoint.sh Refactor shipyard to UCP target layout 2018-04-24 16:47:13 -05:00
requirements.txt Airflow: Update Deckhand / Drydock version 2019-04-18 11:50:41 -05:00
setup.cfg Enable shipyard to use PBR 2018-10-25 14:23:50 +00:00
setup.py Enable shipyard to use PBR 2018-10-25 14:23:50 +00:00
test-requirements.txt Merge "Support clearing collections of configdocs" 2018-12-21 14:40:00 +00:00
tox.ini [FIX] Fix document build 2019-02-22 15:43:08 -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 Airship Undercloud Platform (UCP).

Shipyard provides the entrypoint for the following aspects of the control plane established by the Airship:

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 Airship via Shipyard. Secrets, such as passwords and certificates use the same mechanism.
The designs and secrets are stored in Airship'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.

Find more documentation for Shipyard on Read the Docs

Integration 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 @ Openstack Gerrit
Helm chart

See also:

Airship in a Bottle