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: I55f546b8ad22bf2e3097ff831d021ed5a35059de
Roman Gorshunov 7 months ago
parent
commit
f44b3cc384

+ 1
- 1
charts/promenade/values.yaml View File

@@ -33,7 +33,7 @@ conf:
33 33
 
34 34
 images:
35 35
   tags:
36
-    promenade: quay.io/attcomdev/promenade:latest
36
+    promenade: quay.io/airshipit/promenade:latest
37 37
     ks_user: docker.io/openstackhelm/heat:newton
38 38
     ks_service: docker.io/openstackhelm/heat:newton
39 39
     ks_endpoints: docker.io/openstackhelm/heat:newton

+ 1
- 1
doc/source/configuration/genesis.rst View File

@@ -37,7 +37,7 @@ Here is a complete sample document:
37 37
           - promenade-genesis=enabled
38 38
           - ucp-control-plane=enabled
39 39
       images:
40
-        armada: quay.io/attcomdev/armada:latest
40
+        armada: quay.io/airshipit/armada:latest
41 41
         helm:
42 42
           tiller: gcr.io/kubernetes-helm/tiller:v2.10.0
43 43
         kubernetes:

+ 2
- 2
doc/source/configuration/index.rst View File

@@ -25,5 +25,5 @@ The provided Armada_ manifest and will be applied on the genesis node as soon
25 25
 as it is healthy.
26 26
 
27 27
 
28
-.. _Armada: https://github.com/att-comdev/armada
29
-.. _Deckhand: https://github.com/att-comdev/deckhand
28
+.. _Armada: https://github.com/openstack/airship-armada
29
+.. _Deckhand: https://github.com/openstack/airship-deckhand

+ 5
- 5
doc/source/design.rst View File

@@ -6,7 +6,7 @@ Promenade is a Kubernetes_ cluster deployment tool with the following goals:
6 6
 * Resiliency in the face of node loss and full cluster reboot.
7 7
 * Bare metal node support without external runtime dependencies.
8 8
 * Providing a fully functional single-node cluster to allow cluster-hosted
9
-  `tooling <https://github.com/att-comdev/treasuremap>`_ to provision the
9
+  `tooling <https://github.com/openstack/airship-treasuremap>`_ to provision the
10 10
   remaining cluster nodes.
11 11
 * Helm_ chart managed component life-cycle.
12 12
 * API-managed cluster life-cycle.
@@ -260,18 +260,18 @@ Alternatives
260 260
     * Does not support chart-based management of components
261 261
 
262 262
 
263
-.. _Armada: https://github.com/att-comdev/armada
263
+.. _Armada: https://github.com/openstack/airship-armada
264 264
 .. _Bootkube: https://github.com/kubernetes-incubator/bootkube
265 265
 .. _CNI: https://github.com/containernetworking/cni
266 266
 .. _Calico: https://github.com/projectcalico/calico
267 267
 .. _CoreDNS: https://github.com/coredns/coredns
268
-.. _Deckhand: https://github.com/att-comdev/deckhand
268
+.. _Deckhand: https://github.com/openstack/airship-deckhand
269 269
 .. _Docker: https://www.docker.com
270
-.. _Drydock: https://github.com/att-comdev/drydock
270
+.. _Drydock: https://github.com/openstack/airship-drydock
271 271
 .. _Etcd: https://github.com/coreos/etcd
272 272
 .. _HAProxy: http://www.haproxy.org
273 273
 .. _Helm: https://github.com/kubernetes/helm
274 274
 .. _kops: https://github.com/kubernetes/kops
275 275
 .. _Kubeadm: https://github.com/kubernetes/kubeadm
276 276
 .. _Kubernetes: https://github.com/kubernetes/kubernetes
277
-.. _Shipyard: https://github.com/att-comdev/shipyard
277
+.. _Shipyard: https://github.com/openstack/airship-shipyard

+ 2
- 2
doc/source/getting-started.rst View File

@@ -3,7 +3,7 @@ Getting Started
3 3
 
4 4
 Note: This document is meant to give a general understanding of how Promenade
5 5
 could be exercised in a development environment or for general learning and
6
-understanding. For holistic UCP deployment procedures, refer to `Treasuremap <https://github.com/att-comdev/treasuremap>`_
6
+understanding. For holistic Airship deployment procedures, refer to `Treasuremap <https://github.com/openstack/airship-treasuremap>`_
7 7
 
8 8
 Basic Deployment
9 9
 ----------------
@@ -58,7 +58,7 @@ Perform the following steps to execute the deployment:
58 58
 3. Nodes for which ``join-<NODE>.sh`` scripts have been generated should be
59 59
    provisioned at this point, and need to have network connectivity to the
60 60
    genesis node. (This could be a manual Ubuntu provision, or a Drydock-
61
-   initiated PXE boot in the case of a full fledged UCP deployment).
61
+   initiated PXE boot in the case of a full fledged Airship deployment).
62 62
 4. Join master nodes by copying their respective ``join-<NODE>.sh`` scripts to
63 63
    them and running them.
64 64
 5. Validate the master nodes by copying and running their respective

+ 1
- 1
examples/basic/armada-resources.yaml View File

@@ -86,7 +86,7 @@ metadata:
86 86
     layer: site
87 87
   storagePolicy: cleartext
88 88
 data:
89
-  description: UCP platform components
89
+  description: Airship platform components
90 90
   sequenced: true
91 91
   chart_group:
92 92
     - promenade

+ 2
- 2
examples/complete/armada-resources.yaml View File

@@ -101,7 +101,7 @@ metadata:
101 101
     layer: site
102 102
   storagePolicy: cleartext
103 103
 data:
104
-  description: UCP Infrastructure
104
+  description: Airship Infrastructure
105 105
   sequenced: false
106 106
   chart_group:
107 107
     - ucp-mariadb
@@ -123,7 +123,7 @@ metadata:
123 123
     layer: site
124 124
   storagePolicy: cleartext
125 125
 data:
126
-  description: UCP platform components
126
+  description: Airship platform components
127 127
   chart_group:
128 128
     - armada
129 129
     - deckhand

+ 1
- 1
promenade/utils/success_message.py View File

@@ -18,7 +18,7 @@ from promenade.utils.message import Message
18 18
 
19 19
 
20 20
 class SuccessMessage(Message):
21
-    """SuccessMessage per UCP convention:
21
+    """SuccessMessage per Airship convention:
22 22
     https://airshipit.readthedocs.io/en/latest/api-conventions.html#status-responses
23 23
     """
24 24
 

+ 2
- 2
promenade/utils/validation_message.py View File

@@ -19,8 +19,8 @@ from promenade.utils.message import Message
19 19
 
20 20
 
21 21
 class ValidationMessage(Message):
22
-    """ ValidationMessage per UCP convention:
23
-    https://github.com/att-comdev/ucp-integration/blob/master/docs/source/api-conventions.rst#output-structure  # noqa
22
+    """ ValidationMessage per Airship convention:
23
+    https://github.com/openstack/airship-in-a-bottle/blob/master/doc/source/api-conventions.rst#output-structure  # noqa
24 24
 
25 25
     Construction of ValidationMessage message:
26 26
 

+ 6
- 1
setup.py View File

@@ -1,6 +1,6 @@
1 1
 #!/usr/bin/env python
2 2
 
3
-# Copyright 2017 The Promenade Authors.
3
+# Copyright 2017 AT&T Intellectual Property.  All other rights reserved.
4 4
 #
5 5
 # Licensed under the Apache License, Version 2.0 (the "License");
6 6
 # you may not use this file except in compliance with the License.
@@ -21,6 +21,11 @@ setup(
21 21
     name='promenade',
22 22
     version='0.8.0',
23 23
     packages=['promenade'],
24
+    description=('Promenade is a tool for bootstrapping a resilient '
25
+                 'Kubernetes cluster and managing its life-cycle via Helm charts.'),
26
+    url='https://github.com/openstack/airship-promenade',
27
+    author='The Airship Authors',
28
+    license='Apache 2.0',
24 29
     package_data={
25 30
         'schemas': 'schemas/*',
26 31
         'templates': 'templates/*',

+ 1
- 1
tests/unit/builder_data/simple/armada-resources.yaml View File

@@ -86,7 +86,7 @@ metadata:
86 86
     layer: site
87 87
   storagePolicy: cleartext
88 88
 data:
89
-  description: UCP platform components
89
+  description: Airship platform components
90 90
   sequenced: true
91 91
   chart_group:
92 92
     - promenade

+ 1
- 1
tools/gate/config-templates/bootstrap-armada-config.yaml View File

@@ -67,7 +67,7 @@ metadata:
67 67
     layer: site
68 68
   storagePolicy: cleartext
69 69
 data:
70
-  description: UCP Services
70
+  description: Airship Services
71 71
   chart_group:
72 72
     - promenade
73 73
 ---

Loading…
Cancel
Save