airship/shipyard
Code Issues Proposed changes

Update Deckhand commit

Browse Source 
This patchset uplifts Deckhand commit to include fix
for document replacement.

This uplift is the same one used in Promenade [0].

The Shipyard README.md was renamed to README.rst for
2 reasons:

* To fix an issue with [1] breaking.
* To update content for OpenStack migration.

[0] I32d22110749b334d1fbf19f910e41ab0b7ff3a16
[1] http://logs.openstack.org/96/571296/1/check/airship-shipyard-pep8/76f6cb1/job-output.txt.gz#_2018-05-30_20_19_47_616403

Change-Id: Ie15f4234d504223e961c525339c87fca3a883ffc
This commit is contained in:
Felipe Monteiro 2018-05-30 16:03:47 -04:00
parent b87569abe8
commit 0c9152d62e
4 changed files with 54 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
README.rst Normal file
View File

@ -0,0 +1,52 @@
========
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. Initial 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.
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`_.
.. _Deckhand: https://github.com/openstack/airship-deckhand
.. _Drydock: https://github.com/openstack/airship-drydock
.. _Promenade: https://github.com/openstack/airship-promenade
.. _Armada: https://github.com/openstack/airship-armada
.. _OpenStack Helm: https://github.com/openstack/openstack-helm
.. _documentation: http://airship-shipyard.readthedocs.io/en/latest/
.. _Storyboard issue: https://storyboard.openstack.org/#!/project/1010

44
docs/README.md
View File

@ -1,44 +0,0 @@
## 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](https://github.com/att-comdev/deckhand) for validation and
storage
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 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 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](http://shipyard.readthedocs.io/en/latest/)
### Bugs
If you find a bug, please feel free to create a
[GitHub issue](https://github.com/att-comdev/shipyard/issues)

2
images/airflow/requirements.txt
View File

@ -23,6 +23,6 @@ python-openstackclient==3.11.0
kubernetes>=6.0.0
# Dependencies for other UCP components
git+https://github.com/att-comdev/deckhand.git@3cdf3d2d896d43c6e3bc26170522c3eee0d7158f#egg=deckhand
git+https://git.openstack.org/openstack/airship-deckhand@177675e96fffcda9799c68bbce831424c1167020#egg=deckhand
git+https://github.com/att-comdev/drydock.git@8af92eaf29ca0dd6a129748c132ea7f6593eae83#egg=drydock_provisioner
git+https://github.com/att-comdev/armada.git@7a2ba22ab12a3f1f180b6af4085972ba44853377#egg=armada

2
src/bin/shipyard_airflow/requirements.txt
View File

@ -35,5 +35,5 @@ ulid==1.1
uwsgi==2.0.15
# Dependencies for other UCP components
git+https://github.com/att-comdev/deckhand.git@3cdf3d2d896d43c6e3bc26170522c3eee0d7158f#egg=deckhand
git+https://git.openstack.org/openstack/airship-deckhand@177675e96fffcda9799c68bbce831424c1167020#egg=deckhand
git+https://github.com/att-comdev/drydock.git@8af92eaf29ca0dd6a129748c132ea7f6593eae83#egg=drydock_provisioner