2edd8e6531
The Shipyard API docs and shipyard_api_client incorrectly reference the wrong API endpoints for some APIs. This commit updates the API docs to reference the correct API endpoints for: - getting action validation details - triggering a control action against an activity The following is updated in the shipyard_api_client.py: - API endpoint for getting action validation details Change-Id: I04b770acfd64f331efce6f83f51cb41d0818a6b2
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:
- Initial region/site data will be passed to Shipyard from either a human operator or Jenkins
- The data (in YAML format) will be sent to Deckhand for validation and storage
- Shipyard will make use of the post-processed data from DeckHand to interact with Drydock.
- 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
- Once the Kubernetes clusters are up and validated to be working properly, Shipyard will interact with Armada to deploy OpenStack using OpenStack Helm
- 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 Storyboard issue.