summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRoman Gorshunov <roman.gorshunov@att.com>2018-09-24 12:53:27 +0200
committerRoman Gorshunov <roman.gorshunov@att.com>2018-09-26 08:21:14 +0000
commitec17405606b679791e8bf3cc9d494515849f4ce3 (patch)
treef1c58209f74057d2549b1902c1cd5c9dae961038
parentb1d24ad254c04cdbb4dc4e06f2bfe92c266aad70 (diff)
Fix: various documentation and URL fixes
1) UCP -> Airship 2) readthedocs.org -> readthedocs.io (there is redirect) 3) http -> https 4) attcomdev -> airshipit (repo on quay.io) 5) att-comdev -> openstack/airship-* (repo on github/openstack git) 6) many URLs have been verified and adjusted to be current 7) no need for 'en/latest/' path in URL of the RTD 8) added more info to some setup.cfg and setup.py files 9) ucp-integration docs are now in airship-in-a-bottle 10) various other minor fixes Change-Id: I64fb508a3ff72258d82c795193e918f2945deb29
Notes
Notes (review): Code-Review+2: Pete Birley <petebirley@gmail.com> Code-Review+2: Aaron Sheffield <ajs@sheffieldfamily.net> Workflow+1: Aaron Sheffield <ajs@sheffieldfamily.net> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Mon, 01 Oct 2018 19:18:16 +0000 Reviewed-on: https://review.openstack.org/604428 Project: openstack/airship-drydock Branch: refs/heads/master
-rw-r--r--README.md14
-rw-r--r--charts/drydock/Chart.yaml6
-rw-r--r--docs/source/development.rst4
-rw-r--r--docs/source/getting_started.rst8
-rw-r--r--docs/source/task.rst2
-rw-r--r--python/drydock_provisioner/statemgmt/design/resolver.py2
-rw-r--r--python/setup.py8
7 files changed, 23 insertions, 21 deletions
diff --git a/README.md b/README.md
index 36249b1..75eca6c 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,7 @@
3A python REST orchestrator to translate a YAML host topology to a provisioned 3A python REST orchestrator to translate a YAML host topology to a provisioned
4set of hosts and provide a set of post-provisioning instructions. 4set of hosts and provide a set of post-provisioning instructions.
5 5
6See full documentation at [http://att-comdev-drydock.readthedocs.io/](http://att-comdev-drydock.readthedocs.io/). 6See full documentation at [https://airship-drydock.readthedocs.io/](https://airship-drydock.readthedocs.io/).
7 7
8## Required 8## Required
9 9
@@ -15,7 +15,7 @@ See full documentation at [http://att-comdev-drydock.readthedocs.io/](http://att
15## Recommended 15## Recommended
16 16
17* A running Kubernetes cluster with Helm initialized 17* A running Kubernetes cluster with Helm initialized
18* Familiarity with the AT&T Community Undercloud Platform (UCP) suite of services 18* Familiarity with the Airship platform suite of services
19 19
20## Building 20## Building
21 21
@@ -44,14 +44,14 @@ and policy file templates to be customized
44 44
45The preferred deployment pattern of Drydock is via a Helm chart 45The preferred deployment pattern of Drydock is via a Helm chart
46to deploy Drydock into a Kubernetes cluster. Additionally use of 46to deploy Drydock into a Kubernetes cluster. Additionally use of
47the rest of the UCP services provides additional functionality 47the rest of the Airship services provides additional functionality
48for deploying (Armada) and using (Promenade, Deckhand) Drydock. 48for deploying (Armada) and using (Promenade, Deckhand) Drydock.
49 49
50You can see an example of a full UCP deployment in the [UCP Integration](https://github.com/att-comdev/ucp-integration) repository. 50You can see an example of a full Airship deployment in the [Airship in a Bottle](https://github.com/openstack/airship-in-a-bottle) repository.
51 51
52### Stand up Kubernetes 52### Stand up Kubernetes
53 53
54Use the UCP [Promenade](https://github.com/att-comdev/promenade) 54Use the Airship [Promenade](https://github.com/openstack/airship-promenade)
55tool for starting a self-hosted Kubernetes cluster with Kubernetes 55tool for starting a self-hosted Kubernetes cluster with Kubernetes
56Helm deployed. 56Helm deployed.
57 57
@@ -62,11 +62,11 @@ Use them for preparing your Kuberentes cluster to host Drydock.
62 62
63* [Postgres](https://github.com/openstack/openstack-helm/tree/master/postgresql) 63* [Postgres](https://github.com/openstack/openstack-helm/tree/master/postgresql)
64* [Keystone](https://github.com/openstack/openstack-helm/tree/master/keystone) 64* [Keystone](https://github.com/openstack/openstack-helm/tree/master/keystone)
65* [MAAS](https://github.com/att-comdev/maas) 65* [MAAS](https://github.com/openstack/airship-maas)
66 66
67### Deploy Drydock 67### Deploy Drydock
68 68
69Ideally you will use the UCP [Armada](https://readthedocs.org/projects/armada-helm/) 69Ideally you will use the Airship [Armada](https://airship-armada.readthedocs.io)
70tool for deploying the Drydock chart with proper overrides, but if not you can 70tool for deploying the Drydock chart with proper overrides, but if not you can
71use the `helm` CLI tool. The below are overrides needed during deployment 71use the `helm` CLI tool. The below are overrides needed during deployment
72 72
diff --git a/charts/drydock/Chart.yaml b/charts/drydock/Chart.yaml
index ee50e06..99a0672 100644
--- a/charts/drydock/Chart.yaml
+++ b/charts/drydock/Chart.yaml
@@ -18,8 +18,8 @@ name: drydock
18version: 0.1.0 18version: 0.1.0
19keywords: 19keywords:
20- drydock 20- drydock
21home: https://github.com/att-comdev/drydock 21home: https://github.com/openstack/airship-drydock
22sources: 22sources:
23- https://github.com/att-comdev/aic-helm 23- https://github.com/openstack/airship-drydock/tree/master/charts/drydock
24maintainers: 24maintainers:
25- name: att-comdev 25- name: airship
diff --git a/docs/source/development.rst b/docs/source/development.rst
index a179947..009460e 100644
--- a/docs/source/development.rst
+++ b/docs/source/development.rst
@@ -48,7 +48,7 @@ Control
48The ``control`` module is simply the RESTful API. It is based on the 48The ``control`` module is simply the RESTful API. It is based on the
49`Falcon Framework <https://falconframework.org/>`_ and utilizes oslo_policy 49`Falcon Framework <https://falconframework.org/>`_ and utilizes oslo_policy
50for RBAC enforcement of the API endpoints. The normal deployment of Drydock 50for RBAC enforcement of the API endpoints. The normal deployment of Drydock
51uses `uWSGI <http://uwsgi-docs.readthedocs.io/en/latest/>`_ and PasteDeploy 51uses `uWSGI <http://uwsgi-docs.readthedocs.io/>`_ and PasteDeploy
52to build a pipeline that includes Keystone Middleware for authentication 52to build a pipeline that includes Keystone Middleware for authentication
53and role decoration of the request. 53and role decoration of the request.
54 54
@@ -96,7 +96,7 @@ for testing and publishing. It also requires Drydock to produce multiple artifac
96but separate: the Python package, the Docker image and the Helm chart. The code is published via the 96but separate: the Python package, the Docker image and the Helm chart. The code is published via the
97Docker image artifact. 97Docker image artifact.
98 98
99Drydock strives to conform to the `Airship coding conventions <http://airshipit.readthedocs.io/en/latest/conventions.html>`_. 99Drydock strives to conform to the `Airship coding conventions <https://airshipit.readthedocs.io/en/latest/conventions.html>`_.
100 100
101Python 101Python
102------ 102------
diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst
index dbb5e4b..0b2d152 100644
--- a/docs/source/getting_started.rst
+++ b/docs/source/getting_started.rst
@@ -23,7 +23,7 @@ Bootstrap Kubernetes
23 23
24You can bootstrap your Helm-enabled Kubernetes cluster via the Openstack-Helm 24You can bootstrap your Helm-enabled Kubernetes cluster via the Openstack-Helm
25`AIO <https://docs.openstack.org/openstack-helm/latest/install/developer/index.html>`_ 25`AIO <https://docs.openstack.org/openstack-helm/latest/install/developer/index.html>`_
26or the `Promenade <https://airshipit.readthedocs.io/projects/promenade/en/latest/>`_ tools. 26or the `Promenade <https://airship-promenade.readthedocs.io/>`_ tools.
27 27
28Deploy Drydock and Dependencies 28Deploy Drydock and Dependencies
29------------------------------- 29-------------------------------
@@ -35,9 +35,9 @@ the deployments of the `MaaS <https://git.openstack.org/cgit/openstack/airship-m
35chart and the `Keystone <https://git.openstack.org/cgit/openstack/openstack-helm/>`_ chart. 35chart and the `Keystone <https://git.openstack.org/cgit/openstack/openstack-helm/>`_ chart.
36 36
37A integrated deployment of these charts can be accomplished using the 37A integrated deployment of these charts can be accomplished using the
38`Armada <https://airshipit.readthedocs.io/projects/armada/en/latest/>`_ tool. An example integration 38`Armada <https://airship-armada.readthedocs.io/>`_ tool. An example integration
39chart can be found in the 39chart can be found in the
40`Airship in a Bottle <http://git.openstack.org/cgit/openstack/airship-in-a-bottle/>`_ repo in the 40`Airship in a Bottle <https://git.openstack.org/cgit/openstack/airship-in-a-bottle/>`_ repo in the
41``./manifests/dev_single_node`` directory. 41``./manifests/dev_single_node`` directory.
42 42
43Load Site 43Load Site
@@ -49,7 +49,7 @@ YAML. An example of this is in ``./test/yaml_samples/deckhand_fullsite.yaml``.
49Documentation on building your topology document is at :ref:`topology_label`. 49Documentation on building your topology document is at :ref:`topology_label`.
50 50
51Drydock requires that the YAML topology be hosted somewhere, either the preferred 51Drydock requires that the YAML topology be hosted somewhere, either the preferred
52method of using `Deckhand <https://airshipit.readthedocs.io/projects/deckhand/en/latests/>`_ 52method of using `Deckhand <https://airship-deckhand.readthedocs.io/>`_
53or through a simple HTTP server like Nginx or Apache. 53or through a simple HTTP server like Nginx or Apache.
54 54
55Use the CLI to create tasks to deploy your site 55Use the CLI to create tasks to deploy your site
diff --git a/docs/source/task.rst b/docs/source/task.rst
index 3c08d2a..d541d0c 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
116 "result": Status object 116 "result": Status object
117 } 117 }
118 118
119The Status object is based on the UCP standardized response format:: 119The Status object is based on the Airship standardized response format::
120 120
121 { 121 {
122 "Kind": "Status", 122 "Kind": "Status",
diff --git a/python/drydock_provisioner/statemgmt/design/resolver.py b/python/drydock_provisioner/statemgmt/design/resolver.py
index e4ac39c..dcde8e6 100644
--- a/python/drydock_provisioner/statemgmt/design/resolver.py
+++ b/python/drydock_provisioner/statemgmt/design/resolver.py
@@ -109,7 +109,7 @@ class ReferenceResolver(object):
109 109
110 @classmethod 110 @classmethod
111 def resolve_reference_ucp(cls, design_uri): 111 def resolve_reference_ucp(cls, design_uri):
112 """Retrieve artifacts from a UCP service endpoint. 112 """Retrieve artifacts from a Airship service endpoint.
113 113
114 Return a byte array of the response content. Assumes Keystone 114 Return a byte array of the response content. Assumes Keystone
115 authentication required. 115 authentication required.
diff --git a/python/setup.py b/python/setup.py
index a35d294..16a894c 100644
--- a/python/setup.py
+++ b/python/setup.py
@@ -21,9 +21,11 @@ from setuptools import setup, find_packages
21setup( 21setup(
22 name='drydock_provisioner', 22 name='drydock_provisioner',
23 version='0.1a1', 23 version='0.1a1',
24 description='Bootstrapper for Kubernetes infrastructure', 24 description=('A python REST orchestrator to translate a YAML host '
25 url='http://github.com/att-comdev/drydock', 25 'topology to a provisioned set of hosts and provide a set of '
26 author='AT&T - AIC UCP Developers', 26 'post-provisioning instructions.'),
27 url='https://github.com/openstack/airship-drydock',
28 author='The Airship Authors',
27 license='Apache 2.0', 29 license='Apache 2.0',
28 packages=find_packages(), 30 packages=find_packages(),
29 package_data={ 31 package_data={