Merge "Fix: various documentation and URL fixes"

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 <https://github.com/openstack/airship-drydock>`_ is orchestrated by
@@ -102,5 +102,5 @@ Further Reading
 
 `Airship <https://www.airshipit.org/>`_.
 
-.. |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/

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

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

deckhand/common/validation_message.py

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

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.

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__()

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,

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:

doc/source/developer-overview.rst

@@ -38,7 +38,7 @@ components.
 
 Deckhand uses Barbican to securely storage sensitive document data.
 
-`Pegleg <http://airship-pegleg.readthedocs.io/en/latest/>`_ in effect provides
+`Pegleg <https://airship-pegleg.readthedocs.io/>`_ 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 <https://falconframework.org/>`_ and utilizes
 `oslo.policy <https://docs.openstack.org/oslo.policy/latest/>`_
 for RBAC enforcement of the API endpoints. The normal deployment of Deckhand
-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 @@ 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 <http://airshipit.readthedocs.io/en/latest/conventions.html>`_.
+`Airship coding conventions <https://airshipit.readthedocs.io/en/latest/conventions.html>`_.
 
 Python
 ------
@@ -135,7 +135,7 @@ Testing
 All Deckhand tests are nested under ``/deckhand/tests``.
 
 Deckhand comes equipped with a number of
-`tox <https://tox.readthedocs.io/en/latest/>`_ targets for running unit and
+`tox <https://tox.readthedocs.io/>`_ 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.

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:
 

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

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::
 

setup.cfg

@@ -1,10 +1,10 @@
 [metadata]
-name = deckhand
+name = Deckhand
-summary = Airship document management and persistence tool.
+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