A cluster lifecycle orchestrator for Airship.
Go to file
Rick Bartra 35e5a7f796 Update pip package versions in preparation of pip 20.3
When pip is upgraded to 20.3, the pip dependency resolver is much more
strict and will no longer install a combination of packages that is mutually
inconsistent[0].

These changes account for the fact that Shipyard imports Armada, Drydock,
Promenade, and Deckhand. Having said that, with pip 20.3, the pip
packages amongst those projects cannot conflict. A follow-up change may
be needed if more conflicts are found.

Change-Id: Idd9ea0d57b5be063b133036cfc9ebaa69956f4fc
2020-09-30 01:19:51 +00:00
.github Update Airship vulnerability link 2020-05-18 21:27:25 +00:00
charts/shipyard Change helm-toolkit dependency version to ">= 0.1.0" 2020-09-24 19:43:13 -05:00
doc Add support for Ubuntu bionic base image 2020-02-04 13:38:39 -06:00
etc/shipyard Refactor shipyard to UCP target layout 2018-04-24 16:47:13 -05:00
images Update pip package versions in preparation of pip 20.3 2020-09-30 01:19:51 +00:00
src/bin Update pip package versions in preparation of pip 20.3 2020-09-30 01:19:51 +00:00
tools fix: Docker image build jobs 2020-09-22 09:23:18 -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 (fix) - updated to pip3 2020-06-18 19:51:47 +00:00
LICENSE Add Apache 2.0 LICENSE file 2018-05-14 13:46:28 +00:00
Makefile Upgrade apache-airflow to 1.10.5 2020-03-30 05:21:31 +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.