From 8f70f485f28b68413bf3862c1f453273145749b4 Mon Sep 17 00:00:00 2001 From: eanylin Date: Mon, 3 Jul 2017 12:31:14 -0500 Subject: [PATCH 1/3] Update README Updated README with Mission, Roadmap, Getting Started and Bugs --- docs/README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 45 insertions(+), 2 deletions(-) diff --git a/docs/README.md b/docs/README.md index 373057e1..d9452c67 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,5 +1,48 @@ ## Shipyard ## -Shipyard adopts the Falcon web framework and uses Apache Airflow as backend engine to programmatically -author, schedule and monitor workflows +Shipyard adopts the Falcon web framework and uses Apache Airflow as 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](https://github.com/att-comdev/deckhand) for processing +3. Shipyard will make use of the post-processed data from DeckHand to interact with [DryDock](https://github.com/att-comdev/drydock) +4. DryDock will interact with [Promenade](https://github.com/att-comdev/promenade) to provision and deploy + bare metal nodes using Ubuntu MAAS and Promenade will create a resilient Kubernetes cluster. +5. Once the Kubernetes clusters are up and validated to be working properly, Shipyard will interact with + [Armada](https://github.com/att-comdev/armada) to deploy OpenStack using [OpenStack Helm](https://github.com/openstack/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](https://openstack-lcoo.atlassian.net/projects/SHIPYARD/issues/) + +- 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](https://github.com/att-comdev/shipyard/tree/master/docs) documentation + + +### Bugs ### + +Bugs are traced in [LCOO JIRA](https://openstack-lcoo.atlassian.net/projects/SHIPYARD/issues/). If you find +a bug, please feel free to create a GitHub issue and it will be synced to JIRA. From 2a1c3292c89737fdf908b8d3db561ef9d0366832 Mon Sep 17 00:00:00 2001 From: eanylin Date: Mon, 3 Jul 2017 12:37:17 -0500 Subject: [PATCH 2/3] Update deployment guide link Corrected the deployment guide link --- docs/README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/README.md b/docs/README.md index d9452c67..2e46b284 100644 --- a/docs/README.md +++ b/docs/README.md @@ -9,7 +9,8 @@ The current workflow is as follows: 2. The data (in YAML format) will be sent to [DeckHand](https://github.com/att-comdev/deckhand) for processing 3. Shipyard will make use of the post-processed data from DeckHand to interact with [DryDock](https://github.com/att-comdev/drydock) 4. DryDock will interact with [Promenade](https://github.com/att-comdev/promenade) to provision and deploy - bare metal nodes using Ubuntu MAAS and Promenade will create a resilient Kubernetes cluster. + 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](https://github.com/att-comdev/armada) to deploy OpenStack using [OpenStack Helm](https://github.com/openstack/openstack-helm) 6. Once the OpenStack cluster is deployed, Shipyard will trigger a workflow to perform basic sanity health @@ -38,7 +39,7 @@ The detailed Roadmap can be viewed on the [LCOO JIRA](https://openstack-lcoo.atl ### Getting Started ### This project is under development at the moment. We encourage anyone who is interested in Shipyard to review -our [Installation](https://github.com/att-comdev/shipyard/tree/master/docs) documentation +our [Installation](https://github.com/att-comdev/shipyard/blob/master/docs/deployment_guide.md) documentation ### Bugs ### From 9480b7cc19d8942b372d1e40aa951d68a6669e84 Mon Sep 17 00:00:00 2001 From: eanylin Date: Mon, 3 Jul 2017 12:55:28 -0500 Subject: [PATCH 3/3] Update README --- docs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 2e46b284..433b30b0 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ ## Shipyard ## -Shipyard adopts the Falcon web framework and uses Apache Airflow as backend engine to programmatically +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: