Browse Source

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
Roman Gorshunov 7 months ago
parent
commit
ec17405606

+ 7
- 7
README.md View File

@@ -3,7 +3,7 @@
3 3
 A python REST orchestrator to translate a YAML host topology to a provisioned
4 4
 set of hosts and provide a set of post-provisioning instructions.
5 5
 
6
-See full documentation at [http://att-comdev-drydock.readthedocs.io/](http://att-comdev-drydock.readthedocs.io/).
6
+See full documentation at [https://airship-drydock.readthedocs.io/](https://airship-drydock.readthedocs.io/).
7 7
 
8 8
 ## Required
9 9
 
@@ -15,7 +15,7 @@ See full documentation at [http://att-comdev-drydock.readthedocs.io/](http://att
15 15
 ## Recommended
16 16
 
17 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 20
 ## Building
21 21
 
@@ -44,14 +44,14 @@ and policy file templates to be customized
44 44
 
45 45
 The preferred deployment pattern of Drydock is via a Helm chart
46 46
 to deploy Drydock into a Kubernetes cluster. Additionally use of
47
-the rest of the UCP services provides additional functionality
47
+the rest of the Airship services provides additional functionality
48 48
 for deploying (Armada) and using (Promenade, Deckhand) Drydock.
49 49
 
50
-You can see an example of a full UCP deployment in the [UCP Integration](https://github.com/att-comdev/ucp-integration) repository.
50
+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.
51 51
 
52 52
 ### Stand up Kubernetes
53 53
 
54
-Use the UCP [Promenade](https://github.com/att-comdev/promenade)
54
+Use the Airship [Promenade](https://github.com/openstack/airship-promenade)
55 55
 tool for starting a self-hosted Kubernetes cluster with Kubernetes
56 56
 Helm deployed.
57 57
 
@@ -62,11 +62,11 @@ Use them for preparing your Kuberentes cluster to host Drydock.
62 62
 
63 63
 * [Postgres](https://github.com/openstack/openstack-helm/tree/master/postgresql)
64 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 67
 ### Deploy Drydock
68 68
 
69
-Ideally you will use the UCP [Armada](https://readthedocs.org/projects/armada-helm/)
69
+Ideally you will use the Airship [Armada](https://airship-armada.readthedocs.io)
70 70
 tool for deploying the Drydock chart with proper overrides, but if not you can
71 71
 use the `helm` CLI tool. The below are overrides needed during deployment
72 72
 

+ 3
- 3
charts/drydock/Chart.yaml View File

@@ -18,8 +18,8 @@ name: drydock
18 18
 version: 0.1.0
19 19
 keywords:
20 20
 - drydock
21
-home: https://github.com/att-comdev/drydock
21
+home: https://github.com/openstack/airship-drydock
22 22
 sources:
23
-- https://github.com/att-comdev/aic-helm
23
+- https://github.com/openstack/airship-drydock/tree/master/charts/drydock
24 24
 maintainers:
25
-- name: att-comdev
25
+- name: airship

+ 2
- 2
docs/source/development.rst View File

@@ -48,7 +48,7 @@ Control
48 48
 The ``control`` module is simply the RESTful API. It is based on the
49 49
 `Falcon Framework <https://falconframework.org/>`_ and utilizes oslo_policy
50 50
 for RBAC enforcement of the API endpoints. The normal deployment of Drydock
51
-uses `uWSGI <http://uwsgi-docs.readthedocs.io/en/latest/>`_ and PasteDeploy
51
+uses `uWSGI <http://uwsgi-docs.readthedocs.io/>`_ and PasteDeploy
52 52
 to build a pipeline that includes Keystone Middleware for authentication
53 53
 and role decoration of the request.
54 54
 
@@ -96,7 +96,7 @@ for testing and publishing. It also requires Drydock to produce multiple artifac
96 96
 but separate: the Python package, the Docker image and the Helm chart. The code is published via the
97 97
 Docker image artifact.
98 98
 
99
-Drydock strives to conform to the `Airship coding conventions <http://airshipit.readthedocs.io/en/latest/conventions.html>`_.
99
+Drydock strives to conform to the `Airship coding conventions <https://airshipit.readthedocs.io/en/latest/conventions.html>`_.
100 100
 
101 101
 Python
102 102
 ------

+ 4
- 4
docs/source/getting_started.rst View File

@@ -23,7 +23,7 @@ Bootstrap Kubernetes
23 23
 
24 24
 You can bootstrap your Helm-enabled Kubernetes cluster via the Openstack-Helm
25 25
 `AIO <https://docs.openstack.org/openstack-helm/latest/install/developer/index.html>`_
26
-or the `Promenade <https://airshipit.readthedocs.io/projects/promenade/en/latest/>`_ tools.
26
+or the `Promenade <https://airship-promenade.readthedocs.io/>`_ tools.
27 27
 
28 28
 Deploy Drydock and Dependencies
29 29
 -------------------------------
@@ -35,9 +35,9 @@ the deployments of the `MaaS <https://git.openstack.org/cgit/openstack/airship-m
35 35
 chart and the `Keystone <https://git.openstack.org/cgit/openstack/openstack-helm/>`_ chart.
36 36
 
37 37
 A 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
39 39
 chart 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 41
 ``./manifests/dev_single_node`` directory.
42 42
 
43 43
 Load Site
@@ -49,7 +49,7 @@ YAML. An example of this is in ``./test/yaml_samples/deckhand_fullsite.yaml``.
49 49
 Documentation on building your topology document is at :ref:`topology_label`.
50 50
 
51 51
 Drydock requires that the YAML topology be hosted somewhere, either the preferred
52
-method of using `Deckhand <https://airshipit.readthedocs.io/projects/deckhand/en/latests/>`_
52
+method of using `Deckhand <https://airship-deckhand.readthedocs.io/>`_
53 53
 or through a simple HTTP server like Nginx or Apache.
54 54
 
55 55
 Use the CLI to create tasks to deploy your site

+ 1
- 1
docs/source/task.rst View File

@@ -116,7 +116,7 @@ When querying the state of an existing task, the below document will be returned
116 116
       "result": Status object
117 117
     }
118 118
 
119
-The Status object is based on the UCP standardized response format::
119
+The Status object is based on the Airship standardized response format::
120 120
 
121 121
     {
122 122
       "Kind": "Status",

+ 1
- 1
python/drydock_provisioner/statemgmt/design/resolver.py View File

@@ -109,7 +109,7 @@ class ReferenceResolver(object):
109 109
 
110 110
     @classmethod
111 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 114
         Return a byte array of the response content. Assumes Keystone
115 115
         authentication required.

+ 5
- 3
python/setup.py View File

@@ -21,9 +21,11 @@ from setuptools import setup, find_packages
21 21
 setup(
22 22
     name='drydock_provisioner',
23 23
     version='0.1a1',
24
-    description='Bootstrapper for Kubernetes infrastructure',
25
-    url='http://github.com/att-comdev/drydock',
26
-    author='AT&T - AIC UCP Developers',
24
+    description=('A python REST orchestrator to translate a YAML host '
25
+                 'topology to a provisioned set of hosts and provide a set of '
26
+                 'post-provisioning instructions.'),
27
+    url='https://github.com/openstack/airship-drydock',
28
+    author='The Airship Authors',
27 29
     license='Apache 2.0',
28 30
     packages=find_packages(),
29 31
     package_data={

Loading…
Cancel
Save