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
changes/28/604428/6
Roman Gorshunov 3 years ago
parent
commit
ec17405606
  1. 14
      README.md
  2. 6
      charts/drydock/Chart.yaml
  3. 4
      docs/source/development.rst
  4. 8
      docs/source/getting_started.rst
  5. 2
      docs/source/task.rst
  6. 2
      python/drydock_provisioner/statemgmt/design/resolver.py
  7. 8
      python/setup.py

14
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

6
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

4
docs/source/development.rst

@ -48,7 +48,7 @@ Control
The ``control`` module is simply the RESTful API. It is based on the
`Falcon Framework <https://falconframework.org/>`_ and utilizes oslo_policy
for RBAC enforcement of the API endpoints. The normal deployment of Drydock
uses `uWSGI <http://uwsgi-docs.readthedocs.io/en/latest/>`_ and PasteDeploy
uses `uWSGI <http://uwsgi-docs.readthedocs.io/>`_ 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 <http://airshipit.readthedocs.io/en/latest/conventions.html>`_.
Drydock strives to conform to the `Airship coding conventions <https://airshipit.readthedocs.io/en/latest/conventions.html>`_.
Python
------

8
docs/source/getting_started.rst

@ -23,7 +23,7 @@ Bootstrap Kubernetes
You can bootstrap your Helm-enabled Kubernetes cluster via the Openstack-Helm
`AIO <https://docs.openstack.org/openstack-helm/latest/install/developer/index.html>`_
or the `Promenade <https://airshipit.readthedocs.io/projects/promenade/en/latest/>`_ tools.
or the `Promenade <https://airship-promenade.readthedocs.io/>`_ tools.
Deploy Drydock and Dependencies
-------------------------------
@ -35,9 +35,9 @@ the deployments of the `MaaS <https://git.openstack.org/cgit/openstack/airship-m
chart and the `Keystone <https://git.openstack.org/cgit/openstack/openstack-helm/>`_ chart.
A integrated deployment of these charts can be accomplished using the
`Armada <https://airshipit.readthedocs.io/projects/armada/en/latest/>`_ tool. An example integration
`Armada <https://airship-armada.readthedocs.io/>`_ tool. An example integration
chart can be found in the
`Airship in a Bottle <http://git.openstack.org/cgit/openstack/airship-in-a-bottle/>`_ repo in the
`Airship in a Bottle <https://git.openstack.org/cgit/openstack/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 <https://airshipit.readthedocs.io/projects/deckhand/en/latests/>`_
method of using `Deckhand <https://airship-deckhand.readthedocs.io/>`_
or through a simple HTTP server like Nginx or Apache.
Use the CLI to create tasks to deploy your site

2
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",

2
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.

8
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={

Loading…
Cancel
Save