A cluster lifecycle orchestrator for Airship.
Go to file
Bryan Strassner 06de84e0ab Add notes processing to the Shipyard API+CLI
Enhance the Shipyard API and CLI to retrieve notes that have been
specified against actions and steps. Includes a new reusable parameter
for verbosity.

Change-Id: I1c7f47c0346ce783dacd62b8bbc1fd35a0bf285b
2018-10-11 15:36:22 -05:00
charts/shipyard Merge "Add Shipyard profiler" 2018-10-05 21:20:26 +00:00
doc Add notes processing to the Shipyard API+CLI 2018-10-11 15:36:22 -05:00
etc/shipyard Refactor shipyard to UCP target layout 2018-04-24 16:47:13 -05:00
images Merge "Fix: git commit id labels on images" 2018-09-28 14:15:35 +00:00
src/bin Add notes processing to the Shipyard API+CLI 2018-10-11 15:36:22 -05:00
tools Merge "Fix: git commit id labels on images" 2018-09-28 14:15:35 +00:00
.dockerignore Minor: docs location fix 2018-09-14 23:38:29 +02:00
.editorconfig Fix: various documentation and URL fixes 2018-09-24 12:53:27 +02:00
.gitignore Minor: docs location fix 2018-09-14 23:38:29 +02:00
.gitreview Update .gitreview for openstack infra 2018-05-17 19:26:55 +01:00
.zuul.yaml Set up publishing of docs 2018-09-14 21:32:41 +02:00
LICENSE Add Apache 2.0 LICENSE file 2018-05-14 13:46:28 +00:00
Makefile Minor fix: duplicate items in .title label of container images 2018-10-09 15:36:03 +02:00
README.rst Fix: various documentation and URL fixes 2018-09-24 12:53:27 +02:00
requirements.readthedocs.txt Refactor shipyard to UCP target layout 2018-04-24 16:47:13 -05:00
tox.ini Set up publishing of docs 2018-09-14 21:32:41 +02:00

README.rst

Shipyard

Shipyard adopts the Falcon web framework and uses Apache Airflow as the backend engine to programmatically author, schedule and monitor workflows.

Find more documentation for Shipyard on Read the Docs.

The current workflow is as follows:

  1. Initial region/site data will be passed to Shipyard from either a human operator or Jenkins
  2. The data (in YAML format) will be sent to Deckhand for validation and storage
  3. Shipyard will make use of the post-processed data from DeckHand to interact with Drydock.
  4. Drydock will interact with Promenade to provision and deploy bare metal nodes using Ubuntu MAAS and a resilient Kubernetes cluster will be created at the end of the process
  5. Once the Kubernetes clusters are up and validated to be working properly, Shipyard will interact with Armada to deploy OpenStack using OpenStack Helm
  6. Once the OpenStack cluster is deployed, Shipyard will trigger a workflow to perform basic sanity health checks on the cluster

Note: This project, along with the tools used within are community-based and open sourced.

Mission

The goal for Shipyard is to provide a customizable framework for operators and developers alike. This framework will enable end-users to orchestrate and deploy a fully functional container-based Cloud.

Getting Started

This project is under development at the moment. We encourage anyone who is interested in Shipyard to review our documentation.

Bugs

If you find a bug, please feel free to create a Storyboard issue.