Rename some instances of ucp to airship

This renames some instances of ucp to airship in the documentation
and makes some trivial documentation fixes.

Change-Id: I9a4a81d15bfc13b4fe089b7d65f0df43eeade9fb
This commit is contained in:
Felipe Monteiro 2018-06-22 02:47:28 +01:00
parent 1981eaeb99
commit c95ec45307
7 changed files with 20 additions and 21 deletions

View File

@ -99,7 +99,7 @@ with it, including:
Further Reading Further Reading
=============== ===============
`Undercloud Platform (UCP) <https://github.com/att-comdev/ucp-integration>`_. `Airship <http://www.airshipit.org/>`_.
.. |Doc Status| image:: https://readthedocs.org/projects/deckhand/badge/?version=latest .. |Doc Status| image:: https://readthedocs.org/projects/deckhand/badge/?version=latest
:target: http://deckhand.readthedocs.io/ :target: http://deckhand.readthedocs.io/

View File

@ -30,7 +30,7 @@ in the document.
Note that encryption of document data incurs **runtime overhead** as the Note that encryption of document data incurs **runtime overhead** as the
price of encryption is performance. As a general rule, the more documents price of encryption is performance. As a general rule, the more documents
with ``storagePolicy: encrypted``, the longer it will take to render the with ``storagePolicy: encrypted``, the longer it will take to render the
documents, particularly because Barbican has a built-in `restriction`_ documents, particularly because `Barbican`_ has a built-in `restriction`_
around retrieving only one encrypted payload a time. This means that around retrieving only one encrypted payload a time. This means that
if 50 documents have ``storagePolicy: encrypted`` within a revision, then if 50 documents have ``storagePolicy: encrypted`` within a revision, then
Deckhand must perform 50 API calls to Barbican when rendering the documents Deckhand must perform 50 API calls to Barbican when rendering the documents
@ -40,13 +40,10 @@ Encrypted documents, like cleartext documents, are stored in Deckhand's
database, except the ``data`` section of each encrypted document is replaced database, except the ``data`` section of each encrypted document is replaced
with a reference to Barbican. with a reference to Barbican.
.. _Barbican: https://docs.openstack.org/barbican/latest/api/
.. _restriction: https://docs.openstack.org/barbican/latest/api/reference/secrets.html#get-v1-secrets
Supported Data Types Supported Data Types
-------------------- --------------------
Barbican supports encrypting `any`_ data type via its "opaque" secret type. `Barbican`_ supports encrypting `any`_ data type via its "opaque" secret type.
Thus, Deckhand supports encryption of any data type by utilizing this Thus, Deckhand supports encryption of any data type by utilizing this
secret type. secret type.
@ -54,5 +51,7 @@ However, Deckhand will attempt to use Barbican's `other`_ secret types where
possible. For example, Deckhand will use "public" for document types with kind possible. For example, Deckhand will use "public" for document types with kind
``PublicKey``. ``PublicKey``.
.. _Barbican: https://docs.openstack.org/barbican/latest/api/
.. _restriction: https://docs.openstack.org/barbican/latest/api/reference/secrets.html#get-v1-secrets
.. _any: https://github.com/openstack/barbican/blob/7991f8b4850d76d97c3482428638f788f5798a56/barbican/plugin/interface/secret_store.py#L272 .. _any: https://github.com/openstack/barbican/blob/7991f8b4850d76d97c3482428638f788f5798a56/barbican/plugin/interface/secret_store.py#L272
.. _other: https://docs.openstack.org/barbican/latest/api/reference/secret_types.html .. _other: https://docs.openstack.org/barbican/latest/api/reference/secret_types.html

View File

@ -274,7 +274,7 @@ database using the pre-updated data model and following the following steps::
Update the connection string to the deckhand db instance e.g.:: Update the connection string to the deckhand db instance e.g.::
[Database] [Database]
connection = postgresql+psycopg2://deckhand:password@postgresql.ucp.svc.cluster.local:5432/deckhand connection = postgresql+psycopg2://deckhand:password@postgresql.airship.svc.cluster.local:5432/deckhand
$ export DECKHAND_CONFIG_DIR=${DH_ROOT}/alembic_tmp $ export DECKHAND_CONFIG_DIR=${DH_ROOT}/alembic_tmp
$ alembic revision --autogenerate -m "The short description for this change" $ alembic revision --autogenerate -m "The short description for this change"

View File

@ -22,6 +22,12 @@ A
.. glossary:: .. glossary::
Airship
Airship is a collection of interoperable and loosely coupled open source
tools, among which is Deckhand, that provide automated cloud
provisioning and management in a declarative way.
Alembic Alembic
Database migration software for Python and SQLAlchemy based databases. Database migration software for Python and SQLAlchemy based databases.
@ -39,7 +45,8 @@ B
bucket bucket
A bucket manages collections of documents together, providing write A bucket manages collections of documents together, providing write
protections around them. protections around them. Any bucket can read documents from any other
bucket.
D D
~ ~
@ -82,12 +89,3 @@ S
SQLAlchemy SQLAlchemy
Databse toolkit for Python. Databse toolkit for Python.
U
~
.. glossary::
UCP
Acronym for the Undercloud Platform.

View File

@ -20,7 +20,7 @@ Welcome to Deckhand's documentation!
Deckhand is a document-based configuration storage service built with Deckhand is a document-based configuration storage service built with
auditability and validation in mind. It serves as the back-end storage service auditability and validation in mind. It serves as the back-end storage service
for UCP. for Airship.
Deckhand's primary responsibilities include validating and storing YAML Deckhand's primary responsibilities include validating and storing YAML
documents that are layered together to produce finalized documents, containing documents that are layered together to produce finalized documents, containing
@ -30,7 +30,7 @@ substituted into finalized or "rendered" documents.
The service understands a variety of document formats, the combination of which The service understands a variety of document formats, the combination of which
describe the manner in which Deckhand renders finalized documents for describe the manner in which Deckhand renders finalized documents for
consumption by other UCP services. consumption by other Airship services.
User's Guide User's Guide
============ ============

View File

@ -20,7 +20,7 @@ Document Rendering
================== ==================
Document rendering involves extracting all raw revision documents from Document rendering involves extracting all raw revision documents from
Deckhand's database, retrieving encrypted information from Barbican, Deckhand's database, retrieving encrypted information from `Barbican`_,
and applying substitution, layering and replacement algorithms on the and applying substitution, layering and replacement algorithms on the
data. data.
@ -43,3 +43,5 @@ reduce duplication in configuration.
Replacement builds on top of layering to provide yet another mechanism Replacement builds on top of layering to provide yet another mechanism
for reducing data duplication. for reducing data duplication.
.. _Barbican: https://docs.openstack.org/barbican/latest/api/

View File

@ -46,7 +46,7 @@ Overview
-------- --------
Unit testing currently uses an in-memory SQLite database. Since Deckhand's Unit testing currently uses an in-memory SQLite database. Since Deckhand's
primary function is to serve as the back-end storage for UCP, the majority primary function is to serve as the back-end storage for Airship, the majority
of unit tests perform actual database operations. Mocking is used sparingly of unit tests perform actual database operations. Mocking is used sparingly
because Deckhand is a fairly insular application that lives at the bottom because Deckhand is a fairly insular application that lives at the bottom
of a very deep stack; Deckhand only communicates with Keystone and Barbican. of a very deep stack; Deckhand only communicates with Keystone and Barbican.