diff --git a/README.md b/README.md index 36249b15..75eca6c2 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ A python REST orchestrator to translate a YAML host topology to a provisioned set of hosts and provide a set of post-provisioning instructions. -See full documentation at [http://att-comdev-drydock.readthedocs.io/](http://att-comdev-drydock.readthedocs.io/). +See full documentation at [https://airship-drydock.readthedocs.io/](https://airship-drydock.readthedocs.io/). ## Required @@ -15,7 +15,7 @@ See full documentation at [http://att-comdev-drydock.readthedocs.io/](http://att ## Recommended * A running Kubernetes cluster with Helm initialized -* Familiarity with the AT&T Community Undercloud Platform (UCP) suite of services +* Familiarity with the Airship platform suite of services ## Building @@ -44,14 +44,14 @@ and policy file templates to be customized The preferred deployment pattern of Drydock is via a Helm chart to deploy Drydock into a Kubernetes cluster. Additionally use of -the rest of the UCP services provides additional functionality +the rest of the Airship services provides additional functionality for deploying (Armada) and using (Promenade, Deckhand) Drydock. -You can see an example of a full UCP deployment in the [UCP Integration](https://github.com/att-comdev/ucp-integration) repository. +You can see an example of a full Airship deployment in the [Airship in a Bottle](https://github.com/openstack/airship-in-a-bottle) repository. ### Stand up Kubernetes -Use the UCP [Promenade](https://github.com/att-comdev/promenade) +Use the Airship [Promenade](https://github.com/openstack/airship-promenade) tool for starting a self-hosted Kubernetes cluster with Kubernetes Helm deployed. @@ -62,11 +62,11 @@ Use them for preparing your Kuberentes cluster to host Drydock. * [Postgres](https://github.com/openstack/openstack-helm/tree/master/postgresql) * [Keystone](https://github.com/openstack/openstack-helm/tree/master/keystone) -* [MAAS](https://github.com/att-comdev/maas) +* [MAAS](https://github.com/openstack/airship-maas) ### Deploy Drydock -Ideally you will use the UCP [Armada](https://readthedocs.org/projects/armada-helm/) +Ideally you will use the Airship [Armada](https://airship-armada.readthedocs.io) tool for deploying the Drydock chart with proper overrides, but if not you can use the `helm` CLI tool. The below are overrides needed during deployment diff --git a/charts/drydock/Chart.yaml b/charts/drydock/Chart.yaml index ee50e069..99a0672b 100644 --- a/charts/drydock/Chart.yaml +++ b/charts/drydock/Chart.yaml @@ -18,8 +18,8 @@ name: drydock version: 0.1.0 keywords: - drydock -home: https://github.com/att-comdev/drydock +home: https://github.com/openstack/airship-drydock sources: -- https://github.com/att-comdev/aic-helm +- https://github.com/openstack/airship-drydock/tree/master/charts/drydock maintainers: -- name: att-comdev +- name: airship diff --git a/docs/source/development.rst b/docs/source/development.rst index a179947d..009460eb 100644 --- a/docs/source/development.rst +++ b/docs/source/development.rst @@ -48,7 +48,7 @@ Control The ``control`` module is simply the RESTful API. It is based on the `Falcon Framework `_ and utilizes oslo_policy for RBAC enforcement of the API endpoints. The normal deployment of Drydock -uses `uWSGI `_ and PasteDeploy +uses `uWSGI `_ and PasteDeploy to build a pipeline that includes Keystone Middleware for authentication and role decoration of the request. @@ -96,7 +96,7 @@ for testing and publishing. It also requires Drydock to produce multiple artifac but separate: the Python package, the Docker image and the Helm chart. The code is published via the Docker image artifact. -Drydock strives to conform to the `Airship coding conventions `_. +Drydock strives to conform to the `Airship coding conventions `_. Python ------ diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst index dbb5e4ba..0b2d1524 100644 --- a/docs/source/getting_started.rst +++ b/docs/source/getting_started.rst @@ -23,7 +23,7 @@ Bootstrap Kubernetes You can bootstrap your Helm-enabled Kubernetes cluster via the Openstack-Helm `AIO `_ -or the `Promenade `_ tools. +or the `Promenade `_ tools. Deploy Drydock and Dependencies ------------------------------- @@ -35,9 +35,9 @@ the deployments of the `MaaS `_ chart. A integrated deployment of these charts can be accomplished using the -`Armada `_ tool. An example integration +`Armada `_ tool. An example integration chart can be found in the -`Airship in a Bottle `_ repo in the +`Airship in a Bottle `_ repo in the ``./manifests/dev_single_node`` directory. Load Site @@ -49,7 +49,7 @@ YAML. An example of this is in ``./test/yaml_samples/deckhand_fullsite.yaml``. Documentation on building your topology document is at :ref:`topology_label`. Drydock requires that the YAML topology be hosted somewhere, either the preferred -method of using `Deckhand `_ +method of using `Deckhand `_ or through a simple HTTP server like Nginx or Apache. Use the CLI to create tasks to deploy your site diff --git a/docs/source/task.rst b/docs/source/task.rst index 3c08d2a0..d541d0ce 100644 --- a/docs/source/task.rst +++ b/docs/source/task.rst @@ -116,7 +116,7 @@ When querying the state of an existing task, the below document will be returned "result": Status object } -The Status object is based on the UCP standardized response format:: +The Status object is based on the Airship standardized response format:: { "Kind": "Status", diff --git a/python/drydock_provisioner/statemgmt/design/resolver.py b/python/drydock_provisioner/statemgmt/design/resolver.py index e4ac39cf..dcde8e64 100644 --- a/python/drydock_provisioner/statemgmt/design/resolver.py +++ b/python/drydock_provisioner/statemgmt/design/resolver.py @@ -109,7 +109,7 @@ class ReferenceResolver(object): @classmethod def resolve_reference_ucp(cls, design_uri): - """Retrieve artifacts from a UCP service endpoint. + """Retrieve artifacts from a Airship service endpoint. Return a byte array of the response content. Assumes Keystone authentication required. diff --git a/python/setup.py b/python/setup.py index a35d2948..16a894cc 100644 --- a/python/setup.py +++ b/python/setup.py @@ -21,9 +21,11 @@ from setuptools import setup, find_packages setup( name='drydock_provisioner', version='0.1a1', - description='Bootstrapper for Kubernetes infrastructure', - url='http://github.com/att-comdev/drydock', - author='AT&T - AIC UCP Developers', + description=('A python REST orchestrator to translate a YAML host ' + 'topology to a provisioned set of hosts and provide a set of ' + 'post-provisioning instructions.'), + url='https://github.com/openstack/airship-drydock', + author='The Airship Authors', license='Apache 2.0', packages=find_packages(), package_data={