Merge "Refresh docs for Airship"

This commit is contained in:
Zuul 2018-08-08 21:22:26 +00:00 committed by Gerrit Code Review
commit 518e9d901f
4 changed files with 20 additions and 22 deletions

View File

@ -19,7 +19,7 @@ Definition Artifact Layout
The definition artifacts are stored in the below directory structure. This
structure is used only to assist humans in maintaining the data. When the
documents are consumed by the UCP services, they are viewed as a flat set
documents are consumed by the Airship services, they are viewed as a flat set
of all documents.::
deployment_files/deployment_files
@ -45,7 +45,7 @@ of all documents.::
The root-level listings of ``global``, ``type`` and ``site``
are the layers as listed in the Deckhand
_LayeringPolicy http://deckhand.readthedocs.io/en/latest/layering.html
_LayeringPolicy https://airship-deckhand.readthedocs.io/en/latest/layering.html
document. The process of choosing the definition libraries
to compose the actual design for a site is described below.
@ -140,7 +140,7 @@ site definition contains a set of documents.::
|- rack1.yaml
|- rack2.yaml
* Schemas - The schemas should all be sourced from the UCP
* Schemas - The schemas should all be sourced from the Airship
service repositories. Care should be taken that the schemas
included in the site definition are taken from the version of
the service being deployed in the site.

View File

@ -39,8 +39,7 @@ Shared Documents
Secrets
-------
Several generic document types_ exist to support storing sensitive data
encrypted.
Several generic document types_ exist to support encryption of sensitive data.
These must be utilized for all data considered sensitive.
@ -81,10 +80,10 @@ to ensure you understand all the requirements for it.
This catalogue pattern can also be utilized for the ``type`` layer
if needed.
.. _Deckhand: https://deckhand.readthedocs.io
.. _layering: http://deckhand.readthedocs.io/en/latest/layering.html
.. _substitution: http://deckhand.readthedocs.io/en/latest/substitution.html
.. _types: http://deckhand.readthedocs.io/en/latest/document_types.html#provided-utility-document-kinds
.. _Deckhand: https://airship-deckhand.readthedocs.io
.. _layering: https://airship-deckhand.readthedocs.io/en/latest/layering.html
.. _substitution: https://airship-deckhand.readthedocs.io/en/latest/substitution.html
.. _types: https://airship-deckhand.readthedocs.io/en/latest/document-types.html#provided-utility-document-kinds
Global Layer

View File

@ -225,4 +225,4 @@ Will warn of lint failures from the specified lint options.
P003 - All repos contain expected directories.
.. _`Deckhand Validations`: http://deckhand.readthedocs.io/en/latest/validation.html
.. _`Deckhand Validations`: https://airship-deckhand.readthedocs.io/en/latest/validation.html

View File

@ -34,27 +34,26 @@ Basic Usage
Before using Pegleg, you must:
Clone the Pegleg repository
1. Clone the Pegleg repository:
.. code-block:: console
git clone https://github.com/att-comdev/pegleg
git clone https://git.airshipit.org/airship-pegleg
and install the required packages in pegleg/src/bin/pegleg
2. Install the required packages in airship-pegleg/src/bin/pegleg:
.. code-block:: console
pip3 install -r pegleg/src/bin/pegleg/requirements.txt -r pegleg/src/bin/pegleg/test-requirements.txt
pip3 install -r airship-pegleg/src/bin/pegleg/requirements.txt -r airship-pegleg/src/bin/pegleg/test-requirements.txt
Next, add your repos containing your `site definition libraries`_ into your
local system where Pegleg is running, as Pegleg can only work on files available
in the local directory.
3. Clone the repos containing your `site definition libraries`_ into the
local filesystem where Pegleg is running, as Pegleg can only work with files
available in the local directory.
You will then be able to use all of Pegleg's features through the CLI. See CLI_ for more
information.
.. _Document Fundamentals: https://pegleg.readthedocs.io/en/latest/authoring_strategy.html
.. _CLI: https://pegleg.readthedocs.io/en/latest/cli.html
.. _Deckhand: http://deckhand.readthedocs.io/en/latest/
.. _UCP: https://github.com/att-comdev/ucp-integration
.. _site definition libraries: https://pegleg.readthedocs.io/en/latest/artifacts.html#definition-library-layout
.. _Document Fundamentals: https://airship-pegleg.readthedocs.io/en/latest/authoring_strategy.html
.. _CLI: https://airship-pegleg.readthedocs.io/en/latest/cli.html
.. _Deckhand: https://airship-deckhand.readthedocs.io/en/latest/
.. _site definition libraries: https://airship-pegleg.readthedocs.io/en/latest/artifacts.html#definition-library-layout