A cluster lifecycle orchestrator for Airship.
Go to file
Crank, Daniel (dc6350) 0ab1bf552d Don't log OS_PASSWORD in auth.log
By default, all sudo commands are logged to auth.log with their
full command line. Previously, Shipyard scripts called 'sudo docker'
with -e OS_PASSWORD=foo, resulting in the password value appearing
in auth.log in plaintext. This change adds -E to the sudo command
to pass the user's environment through, and removes the value from
-e OS_PASSWORD which tells Docker to use the environment value
directly. This prevents the password value from being logged.

Change-Id: Ifcf7f6525876144a609ff42be42da57a3f7f6f60
2019-04-26 17:17:06 -05:00
charts/shipyard Update mq queue mirror directive to match vhost 2019-04-17 16:30:14 -05:00
doc Move Airflow web container into Shipyard pod 2019-01-29 09:41:16 -06: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 Airflow: Update Deckhand / Drydock version 2019-04-18 11:50:41 -05:00
tools Don't log OS_PASSWORD in auth.log 2019-04-26 17:17:06 -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.