airship/shipyard
Code Issues Proposed changes
A cluster lifecycle orchestrator for Airship.
649 Commits 3 Branches 0 Tags 8.3 MiB
Python 95.5%
Shell 3.2%
Smarty 0.8%
Makefile 0.5%
222b074cb1
Go to file
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
charts/shipyard Be configuration driven when referencing document names/schemas 2019-05-02 10:47:38 -05:00
doc Be configuration driven when referencing document names/schemas 2019-05-02 10:47:38 -05:00
etc/shipyard Refactor shipyard to UCP target layout 2018-04-24 16:47:13 -05:00
images Airflow: Update Deckhand / Drydock version 2019-04-18 11:50:41 -05:00
src/bin Be configuration driven when referencing document names/schemas 2019-05-02 10:47:38 -05:00
tools Be configuration driven when referencing document names/schemas 2019-05-02 10:47:38 -05: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 OpenDev Migration Patch 2019-04-19 19:52:20 +00:00
.zuul.yaml CI: Add Airskiff check 2019-04-22 16:39:58 +00:00
LICENSE Add Apache 2.0 LICENSE file 2018-05-14 13:46:28 +00:00
Makefile images: Update default image tag to latest 2019-03-22 18:42:48 +00: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.