airship/shipyard
Code Issues Proposed changes
8d486b22db
shipyard/docs
History
One-Fine-Day 5335622671 Shipyard Documentation for Dryrun Option/Query 
Shipyard API to retrieve validation status of a collection of configdocs

4 of 4 Commits (API, API Client, CLI are in separate commits)

Documentation
-Read the Docs documentation has been updated to include the CLI command,
 commit configdocs, option dryrun in docs/source/CLI.rst
-Read the Docs documentation has been updated to include the API,
 commitconfigdocs, query dryrun in docs/source/API.rst

Change-Id: I1dfea75cb2886aa57052c30362c2992051ef56a8
2018-01-12 16:07:20 -05:00
..
source
Shipyard Documentation for Dryrun Option/Query
2018-01-12 16:07:20 -05:00
README.md
Move most Shipyard docs to .rst
2017-12-04 13:36:26 -06:00

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.

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