airship
/
shipyard
Code Issues Proposed changes
A cluster lifecycle orchestrator for Airship.
378 Commits 3 Branches 0 Tags 8.1 MiB
Python 95.7%
Shell 3.1%
Smarty 0.8%
Makefile 0.4%
Go to file
Bryan Strassner 769d0ded47 Refactor shipyard to UCP target layout 
Refactor Shipyard to be better able to leverage common
packages and conform with the target UCP standard layout.

This change supports the same tox entrypoints at
the root level, but the preferred approach is to use make
targets defined in the Makefile such as 'make tests' and
'make lint'

The previous tox.ini has moved and been
tailored to the specifics of each subproject at
src/bin/*/tox.ini

Autotmatic generation of the policy and configuration
files has been removed from the sphinx build for now
but these files will be automatically generated locally
into the docs source by using a 'make docs' command.
This may need to be revisited later to re-enable the
automatic generation of these files such that readthedocs
would still support the project layout.

Change-Id: Ifdc1cd4cf35fb3c5923414c677b781a60a9bae42
 		2018-04-24 16:47:13 -05:00
charts/shipyard Refactor shipyard to UCP target layout 2018-04-24 16:47:13 -05:00
docs Refactor shipyard to UCP target layout 2018-04-24 16:47:13 -05:00
etc/shipyard Refactor shipyard to UCP target layout 2018-04-24 16:47:13 -05:00
images Refactor shipyard to UCP target layout 2018-04-24 16:47:13 -05:00
shipyard_airflow/schemas Refactor shipyard to UCP target layout 2018-04-24 16:47:13 -05:00
src/bin Refactor shipyard to UCP target layout 2018-04-24 16:47:13 -05:00
tests/unit Refactor shipyard to UCP target layout 2018-04-24 16:47:13 -05:00
tools Refactor shipyard to UCP target layout 2018-04-24 16:47:13 -05:00
.dockerignore Refactor shipyard to UCP target layout 2018-04-24 16:47:13 -05:00
.editorconfig Cleanup dockerfile and add editorconfig 2018-02-16 13:44:15 -06:00
.gitignore Refactor shipyard to UCP target layout 2018-04-24 16:47:13 -05:00
.gitreview Add gitreview file 2017-08-11 01:20:56 -05:00
Makefile Refactor shipyard to UCP target layout 2018-04-24 16:47:13 -05:00
requirements.readthedocs.txt Refactor shipyard to UCP target layout 2018-04-24 16:47:13 -05:00
tox.ini Refactor shipyard to UCP target layout 2018-04-24 16:47:13 -05:00

docs/README.md

Shipyard

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

The current workflow is as follows:

  1. Inital 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 GitHub issue