shipyard/docs
Anthony Lin dcc6c3fb6e Correct Formatting of Deployment Guide
The code blocks were in incorrect format due to wrong
alignment in the .rst file.

This patch set is meant to correct that.

Change-Id: I30378b5d970d4394db5309dd1d09e108b3a96343
2017-12-19 14:59:51 +00:00
..
source Correct Formatting of Deployment Guide 2017-12-19 14:59:51 +00:00
README.md Move most Shipyard docs to .rst 2017-12-04 13:36:26 -06:00

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.

Roadmap

The detailed Roadmap can be viewed on the LCOO JIRA

  • Integrate with DeckHand, DryDock/Promenade, Armada
  • Expand funcitionality to provide visibility into and options for operation of a UCP installation

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