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
This commit is contained in:
Roman Gorshunov 2018-09-24 12:53:27 +02:00
parent 13d6831aa5
commit f44b3cc384
12 changed files with 25 additions and 20 deletions

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -86,7 +86,7 @@ metadata:
layer: site
storagePolicy: cleartext
data:
description: UCP platform components
description: Airship platform components
sequenced: true
chart_group:
- promenade

View File

@ -101,7 +101,7 @@ metadata:
layer: site
storagePolicy: cleartext
data:
description: UCP Infrastructure
description: Airship Infrastructure
sequenced: false
chart_group:
- ucp-mariadb
@ -123,7 +123,7 @@ metadata:
layer: site
storagePolicy: cleartext
data:
description: UCP platform components
description: Airship platform components
chart_group:
- armada
- deckhand

View File

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

View File

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

View File

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

View File

@ -86,7 +86,7 @@ metadata:
layer: site
storagePolicy: cleartext
data:
description: UCP platform components
description: Airship platform components
sequenced: true
chart_group:
- promenade

View File

@ -67,7 +67,7 @@ metadata:
layer: site
storagePolicy: cleartext
data:
description: UCP Services
description: Airship Services
chart_group:
- promenade
---