airship
/
pegleg
Code Issues Proposed changes

Refresh docs for Airship 

Now that Pegleg is a proud member of the OpenStack Airship family,
this PS makes a few updates to reflect this change, in terms
of project name (s/pegleg/airship-pegleg/), doc links, and
old-skool UCP vs Airship terminology.
Http URLs have also been updated to https.

Change-Id: I27bc725b3cf3c1ccee20221722733807af51cd44
This commit is contained in:
Matt McEuen 2018-08-02 21:23:33 -05:00
parent 843d1a5010
commit 15b5062f84
4 changed files with 20 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/artifacts.rst
View File

@ -19,7 +19,7 @@ Definition Artifact Layout
The definition artifacts are stored in the below directory structure. This The definition artifacts are stored in the below directory structure. This
structure is used only to assist humans in maintaining the data. When the 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.:: of all documents.::
deployment_files/deployment_files deployment_files/deployment_files
@ -45,7 +45,7 @@ of all documents.::
The root-level listings of ``global``, ``type`` and ``site`` The root-level listings of ``global``, ``type`` and ``site``
are the layers as listed in the Deckhand 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 document. The process of choosing the definition libraries
to compose the actual design for a site is described below. to compose the actual design for a site is described below.
@ -140,7 +140,7 @@ site definition contains a set of documents.::
|- rack1.yaml |- rack1.yaml
|- rack2.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 service repositories. Care should be taken that the schemas
included in the site definition are taken from the version of included in the site definition are taken from the version of
the service being deployed in the site. the service being deployed in the site.

11
doc/source/authoring_strategy.rst
View File

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

2
doc/source/cli.rst
View File

@ -225,4 +225,4 @@ Will warn of lint failures from the specified lint options.
P003 - All repos contain expected directories. 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

23
doc/source/getting_started.rst
View File

@ -34,27 +34,26 @@ Basic Usage
Before using Pegleg, you must: Before using Pegleg, you must:
Clone the Pegleg repository 1. Clone the Pegleg repository:
.. code-block:: console .. 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 .. 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 3. Clone the repos containing your `site definition libraries`_ into the
local system where Pegleg is running, as Pegleg can only work on files available local filesystem where Pegleg is running, as Pegleg can only work with files
in the local directory. available in the local directory.
You will then be able to use all of Pegleg's features through the CLI. See CLI_ for more You will then be able to use all of Pegleg's features through the CLI. See CLI_ for more
information. information.
.. _Document Fundamentals: https://pegleg.readthedocs.io/en/latest/authoring_strategy.html .. _Document Fundamentals: https://airship-pegleg.readthedocs.io/en/latest/authoring_strategy.html
.. _CLI: https://pegleg.readthedocs.io/en/latest/cli.html .. _CLI: https://airship-pegleg.readthedocs.io/en/latest/cli.html
.. _Deckhand: http://deckhand.readthedocs.io/en/latest/ .. _Deckhand: https://airship-deckhand.readthedocs.io/en/latest/
.. _UCP: https://github.com/att-comdev/ucp-integration .. _site definition libraries: https://airship-pegleg.readthedocs.io/en/latest/artifacts.html#definition-library-layout
.. _site definition libraries: https://pegleg.readthedocs.io/en/latest/artifacts.html#definition-library-layout