From d41e5a44ca53f29b0fd8125fde71de64a9113bc7 Mon Sep 17 00:00:00 2001 From: Roman Gorshunov Date: Mon, 24 Sep 2018 12:56:24 +0200 Subject: [PATCH] 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: I12b2fa8fbec37a483a0ad50382e08f51ed97533a --- Makefile | 2 +- README.rst | 4 ++-- charts/deckhand/Chart.yaml | 6 +++--- charts/deckhand/values.yaml | 4 ++-- deckhand/common/validation_message.py | 4 ++-- deckhand/control/health.py | 2 +- deckhand/engine/document_validation.py | 3 ++- deckhand/errors.py | 3 ++- .../schema-validation-success-ucp-sample.yaml | 4 ++-- doc/source/developer-overview.rst | 8 ++++---- doc/source/getting-started.rst | 8 ++++---- doc/source/replacement.rst | 2 +- doc/source/testing.rst | 4 ++-- setup.cfg | 8 ++++---- 14 files changed, 32 insertions(+), 30 deletions(-) diff --git a/Makefile b/Makefile index 8d6e29fa..5c7c0966 100644 --- a/Makefile +++ b/Makefile @@ -14,7 +14,7 @@ DOCKER_REGISTRY ?= quay.io IMAGE_NAME ?= deckhand -IMAGE_PREFIX ?= attcomdev +IMAGE_PREFIX ?= airshipit IMAGE_TAG ?= latest HELM ?= helm PROXY ?= http://proxy.foo.com:8000 diff --git a/README.rst b/README.rst index 6a1e3d82..4101559a 100644 --- a/README.rst +++ b/README.rst @@ -87,7 +87,7 @@ Deckhand has the following integration points: Currently, other database back-ends are not supported. -Though, being a low-level service, has many other UCP services that integrate +Though, being a low-level service, has many other Airship services that integrate with it, including: * `Drydock `_ is orchestrated by @@ -102,5 +102,5 @@ Further Reading `Airship `_. -.. |Doc Status| image:: https://readthedocs.org/projects/airship-deckhand/badge/?version=latest +.. |Doc Status| image:: https://readthedocs.io/projects/airship-deckhand/badge/?version=latest :target: https://airship-deckhand.readthedocs.io/ diff --git a/charts/deckhand/Chart.yaml b/charts/deckhand/Chart.yaml index a7c98ae9..87223af6 100644 --- a/charts/deckhand/Chart.yaml +++ b/charts/deckhand/Chart.yaml @@ -18,10 +18,10 @@ name: deckhand version: 0.1.0 keywords: - deckhand -home: https://github.com/att-comdev/deckhand +home: https://github.com/openstack/airship-deckhand sources: -- https://github.com/att-comdev/aic-helm +- https://github.com/openstack/airship-deckhand/tree/master/charts/deckhand - https://git.openstack.org/cgit/openstack/openstack-helm maintainers: -- name: att-comdev +- name: airship engine: gotpl diff --git a/charts/deckhand/values.yaml b/charts/deckhand/values.yaml index ff131cfc..fe866533 100644 --- a/charts/deckhand/values.yaml +++ b/charts/deckhand/values.yaml @@ -27,10 +27,10 @@ labels: images: tags: - deckhand: quay.io/attcomdev/deckhand:latest + deckhand: quay.io/airshipit/deckhand:latest dep_check: "quay.io/stackanetes/kubernetes-entrypoint:v0.3.1" db_init: docker.io/postgres:9.5 - db_sync: quay.io/attcomdev/deckhand:latest + db_sync: quay.io/airshipit/deckhand:latest image_repo_sync: docker.io/docker:17.07.0 ks_endpoints: docker.io/openstackhelm/heat:newton ks_service: docker.io/openstackhelm/heat:newton diff --git a/deckhand/common/validation_message.py b/deckhand/common/validation_message.py index e8e94102..750f8ad6 100644 --- a/deckhand/common/validation_message.py +++ b/deckhand/common/validation_message.py @@ -19,8 +19,8 @@ DOCUMENT_POST_RENDERING_FAILURE = 'D002' class ValidationMessage(object): - """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: diff --git a/deckhand/control/health.py b/deckhand/control/health.py index 7e92f1e9..965231a6 100644 --- a/deckhand/control/health.py +++ b/deckhand/control/health.py @@ -20,7 +20,7 @@ from deckhand.control.base import BaseResource class HealthResource(BaseResource): """Basic health check for Deckhand - A resource that allows other UCP components to access and validate + A resource that allows other Airship components to access and validate Deckhand's health status. The response must be returned within 30 seconds for Deckhand to be deemed "healthy". Unauthenticated GET. diff --git a/deckhand/engine/document_validation.py b/deckhand/engine/document_validation.py index f7f664fb..19fa6598 100644 --- a/deckhand/engine/document_validation.py +++ b/deckhand/engine/document_validation.py @@ -103,7 +103,8 @@ class GenericValidator(BaseValidator): _diagnostic = ( 'Ensure that each document has a metadata, schema and data section. ' 'Each document must pass the schema defined under: ' - 'http://deckhand.readthedocs.io/en/latest/validation.html#base-schema') + 'https://airship-deckhand.readthedocs.io/en/latest/' + 'validation.html#base-schema') def __init__(self): super(GenericValidator, self).__init__() diff --git a/deckhand/errors.py b/deckhand/errors.py index 8d4d3a37..54a30cf1 100644 --- a/deckhand/errors.py +++ b/deckhand/errors.py @@ -139,7 +139,8 @@ def default_exception_handler(ex, req, resp, params): def default_exception_serializer(req, resp, exception): """Serializes instances of :class:`falcon.HTTPError` into YAML format and - formats the error body so it adheres to the UCP error formatting standard. + formats the error body so it adheres to the Airship error formatting + standard. """ format_error_resp( req, diff --git a/deckhand/tests/functional/gabbits/schema-validation/schema-validation-success-ucp-sample.yaml b/deckhand/tests/functional/gabbits/schema-validation/schema-validation-success-ucp-sample.yaml index 6757dc05..88a09d99 100644 --- a/deckhand/tests/functional/gabbits/schema-validation/schema-validation-success-ucp-sample.yaml +++ b/deckhand/tests/functional/gabbits/schema-validation/schema-validation-success-ucp-sample.yaml @@ -1,7 +1,7 @@ -# Test success path for sample UCP documents +# Test success path for sample Airship documents # # 1. Purges existing data to ensure test isolation -# 2. Creates sample UCP documents and schemas +# 2. Creates sample Airship documents and schemas # 3. Checks that the documents pass schema validation defaults: diff --git a/doc/source/developer-overview.rst b/doc/source/developer-overview.rst index 083bfadc..079d813c 100644 --- a/doc/source/developer-overview.rst +++ b/doc/source/developer-overview.rst @@ -38,7 +38,7 @@ components. Deckhand uses Barbican to securely storage sensitive document data. -`Pegleg `_ in effect provides +`Pegleg `_ in effect provides Deckhand with a CLI, which facilitates communication with Deckhand. .. image:: images/architecture-pegleg.png @@ -54,7 +54,7 @@ The ``control`` module is simply the RESTful API. It is based on the `Falcon Framework `_ and utilizes `oslo.policy `_ for RBAC enforcement of the API endpoints. The normal deployment of Deckhand -uses `uWSGI `_ and PasteDeploy +uses `uWSGI `_ and PasteDeploy to build a pipeline that includes Keystone Middleware for authentication and role decoration of the request. @@ -96,7 +96,7 @@ the Docker image and the Helm chart. The code is published via the Docker image artifact. Deckhand strives to conform to the -`Airship coding conventions `_. +`Airship coding conventions `_. Python ------ @@ -135,7 +135,7 @@ Testing All Deckhand tests are nested under ``/deckhand/tests``. Deckhand comes equipped with a number of -`tox `_ targets for running unit and +`tox `_ targets for running unit and functional tests. See :ref:`development-utilities` for a list of commands. See :ref:`testing` for more information on testing guidelines. diff --git a/doc/source/getting-started.rst b/doc/source/getting-started.rst index 05775224..e3c83d03 100644 --- a/doc/source/getting-started.rst +++ b/doc/source/getting-started.rst @@ -57,7 +57,7 @@ Finally, run Deckhand via Docker:: --net=host \ -p 9000:9000 \ -v $CONF_DIR:/etc/deckhand \ - quay.io/attcomdev/deckhand:latest + quay.io/airshipit/deckhand:latest PostgreSQL ^^^^^^^^^^ @@ -101,7 +101,7 @@ Run an update to the Database to bring it to the current code level:: $ [sudo] docker run --rm \ --net=host \ -v $CONF_DIR:/etc/deckhand \ - quay.io/attcomdev/deckhand:latest \ + quay.io/airshipit/deckhand:latest \ alembic upgrade head Finally, run Deckhand via Docker:: @@ -110,7 +110,7 @@ Finally, run Deckhand via Docker:: --net=host \ -p 9000:9000 \ -v $CONF_DIR:/etc/deckhand \ - quay.io/attcomdev/deckhand:latest + quay.io/airshipit/deckhand:latest To kill the ephemeral DB afterward:: @@ -204,7 +204,7 @@ After, from the command line, execute: --net=host \ -p 9000:9000 \ -v $CONF_DIR:/etc/deckhand \ - quay.io/attcomdev/deckhand:latest server + quay.io/airshipit/deckhand:latest server .. _development-utilities: diff --git a/doc/source/replacement.rst b/doc/source/replacement.rst index bfd7fa8a..8f863603 100644 --- a/doc/source/replacement.rst +++ b/doc/source/replacement.rst @@ -232,7 +232,7 @@ separate file and Pegleg can either reference *only* the parent document if log debugging needs to be enabled or *both* documents if log debugging needs to be disabled. This pattern allows data duplication to be lessened. -.. _Pegleg: https://airship-pegleg.readthedocs.io/en/latest/ +.. _Pegleg: https://airship-pegleg.readthedocs.io/ How It Works ------------ diff --git a/doc/source/testing.rst b/doc/source/testing.rst index 32e9c5c3..e154191b 100644 --- a/doc/source/testing.rst +++ b/doc/source/testing.rst @@ -143,7 +143,7 @@ testing. To test Deckhand against a containerized image, run, for example: :: - export DECKHAND_IMAGE=quay.io/attcomdev/deckhand:latest + export DECKHAND_IMAGE=quay.io/airshipit/deckhand:latest tox -e functional-dev Which will result in the following script output: @@ -152,7 +152,7 @@ Which will result in the following script output: Running Deckhand via Docker + sleep 5 - + sudo docker run --rm --net=host -p 9000:9000 -v /opt/stack/deckhand/tmp.oBJ6XScFgC:/etc/deckhand quay.io/attcomdev/deckhand:latest + + sudo docker run --rm --net=host -p 9000:9000 -v /opt/stack/deckhand/tmp.oBJ6XScFgC:/etc/deckhand quay.io/airshipit/deckhand:latest .. warning:: diff --git a/setup.cfg b/setup.cfg index 298c057a..b429c608 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,10 +1,10 @@ [metadata] -name = deckhand -summary = Airship document management and persistence tool. +name = Deckhand +summary = Storage service for YAML-based configuration documents, which are managed through version control and automatically validated. description-file = README.rst +author = The Airship Authors +home-page = https://airship-deckhand.readthedocs.io/ -author = Deckhand team -home-page = http://airship-deckhand.readthedocs.io/en/latest/ classifier = Intended Audience :: Information Technology Intended Audience :: System Administrators