airship/shipyard
Code Issues Proposed changes
467358dcc2
shipyard/docs
History
Felipe Monteiro 467358dcc2 Shipyard documentation via build_sphinx 
This PS adds tooling and automation to automatically generate
Shipyard's documentation into feature-rich HTML pages that can
be hosted.

To run the documentation job, simply execute:

    tox -e docs

Shipyard's .md documentation will have to be changed to .rst
in a future PS for sphinx to be able to render them into HTML.

Change-Id: Iba8cfd68e4905d49cd5a1dfd39d556044efdabbd
2017-10-06 15:51:35 -04:00
..
source Shipyard documentation via build_sphinx 2017-10-06 15:51:35 -04:00
API_action_commands.md Update to make the commitconfigdocs API be sync. 2017-08-29 09:55:42 -05:00
API.md Update Action API documentation 2017-09-25 18:26:42 -05:00
CLI.md Add design for CLI 2017-09-21 11:45:28 -05:00
deployment_guide.md Update Deployment Guide 2017-08-16 19:12:00 +00:00
README.md Update README with new location of issues for github 2017-08-30 10:33:20 -05: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 processing
  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

  • Create Helm Charts for Airflow
  • Create Helm Charts for Shipyard
  • Create Falcon API Framework
  • Integrate with DeckHand, DryDock/Promenade, Armada

Getting Started

This project is under development at the moment. We encourage anyone who is interested in Shipyard to review our Installation documentation

Bugs

Bugs are traced in LCOO JIRA. If you find a bug, please feel free to create a GitHub issue and it will be synced to JIRA.