airship/shipyard
Code Issues Proposed changes
068b6e193b
shipyard/docs
History
Bryan Strassner 59fabf8cac Updated the API documentation for shipyard: 
Incorporated feedback from reviews

Added steps to the action commands document

Added renderedconfigdocs resource for rendered representations of
documents

Updated POST configdocs to be collection based

Added append and force parameter behaviors for POST configdocs

Updated verbiage for the document staging API to be collection
based

Update GET behaviors for configdocs to clarify when collections
are removed vs. not represented.

Remove the secrets API, as it will be handled by the configdocs

change to have document versions referenced by verion=rollback|staged
instead of lastDeployed=true|false.
Updated to make clearer when documents move from staged to rollback

reformatted for 80 cols

removed extraneous trailing whitespace

Change-Id: I59ceb8643d7da5ef335b746ea98053a8338207be
2017-08-24 09:55:47 -05:00
..
API_action_commands.md Updated the API documentation for shipyard: 2017-08-24 09:55:47 -05:00
API.md Updated the API documentation for shipyard: 2017-08-24 09:55:47 -05:00
deployment_guide.md Update Deployment Guide 2017-08-16 19:12:00 +00:00
README.md Update README 2017-07-03 12:55:28 -05:00
REST_API.md Add documentation for the shipyard API. 2017-07-28 15:07:30 -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.