airship
/
shipyard
Code Issues Proposed changes
shipyard/src/bin/shipyard_airflow
History
Drew Walters 6f8b9f858a Refactor validations retrieval for performance 
The goal of this commit is to reduce the average time spent retrieving
validations from Deckhand. Currently, wait times when committing
configdocs can be significant due to unnecessary API calls. This change
reduces the number of API calls during this process by utilizing the
`/revisions/{{revision_id}}/validations/detail` endpoint exposed by
Deckhand. During testing, this introduced a 71% decrease in cumulative
time for committing configdocs. Note, this commit does not introduce
usage of the official Deckhand client, which will be addressed in a
future change.

Change-Id: I3c86fca6bae1a5a2f74963a87b2198c1705cf3a6
 		2018-10-05 13:57:27 +00:00
..
alembic Add Apache 2.0 LICENSE file 2018-05-14 13:46:28 +00:00
etc/shipyard [docs] Update docs to match site_statuses API 2018-09-26 15:43:39 -05:00
generator Refactor shipyard to UCP target layout 2018-04-24 16:47:13 -05:00
shipyard_airflow Refactor validations retrieval for performance 2018-10-05 13:57:27 +00:00
tests Refactor validations retrieval for performance 2018-10-05 13:57:27 +00: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 Rollback to revision 0 instead of clearing Deckhand DB 2018-09-25 16:04:32 -04:00
setup.py Minor: drop AT&T from authors 2018-09-25 11:42:42 +02:00
test-requirements.txt Rollback to revision 0 instead of clearing Deckhand DB 2018-09-25 16:04:32 -04:00
tox.ini Update to Airflow 1.10 2018-09-24 15:32:31 -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 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