diff --git a/doc/source/cli.rst b/doc/source/cli.rst index dc05741d..bcab3898 100644 --- a/doc/source/cli.rst +++ b/doc/source/cli.rst @@ -19,7 +19,15 @@ Pegleg CLI ========== The Pegleg CLI is used in conjunction with the script located in pegleg/tools -called pegleg.sh. +called ``pegleg.sh``. + +.. note:: + + The default workspace for the ``pegleg.sh`` script is ``/workspace``. The + examples below require that this workspace be used. + +Environment Variables +===================== :: @@ -33,6 +41,9 @@ called pegleg.sh. Example: $IMAGE=quay.io/attcomdev/pegleg:latest +Usage +===== + To run: .. code-block:: console @@ -41,6 +52,25 @@ To run: export IMAGE= ./pegleg.sh +For example: + +.. code-block:: console + + cd /opt/airship-pegleg + export WORKSPACE=/opt/airship-treasuremap + ./tools/pegleg.sh site -r /workspace --help + +.. note:: + + If ``sudo`` permissions are required to execute ``pegleg.sh``, then it is + necessary to use the ``-E`` flag with ``sudo`` in order for the current + environment to be used. For example: + + .. code-block:: console + + cd /opt/airship-pegleg + export WORKSPACE=/opt/airship-treasuremap + sudo -E ./tools/pegleg.sh site -r /workspace --help CLI Options =========== diff --git a/doc/source/getting_started.rst b/doc/source/getting_started.rst index 2e822741..bd54cbbd 100644 --- a/doc/source/getting_started.rst +++ b/doc/source/getting_started.rst @@ -40,11 +40,7 @@ Before using Pegleg, you must: git clone https://git.airshipit.org/airship-pegleg -2. Install the required packages in airship-pegleg/src/bin/pegleg: - -.. code-block:: console - - pip3 install -r airship-pegleg/src/bin/pegleg/requirements.txt -r airship-pegleg/src/bin/pegleg/test-requirements.txt +2. Install `Docker CE`_, as Pegleg relies on it for CLI execution. 3. Clone the repos containing your `site definition libraries`_ into the local filesystem where Pegleg is running, as Pegleg can only work with files @@ -54,6 +50,6 @@ You will then be able to use all of Pegleg's features through the CLI. See CLI_ information. .. _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/ +.. _Docker CE: https://docs.docker.com/install/ .. _site definition libraries: https://airship-pegleg.readthedocs.io/en/latest/artifacts.html#definition-library-layout +.. _CLI: https://airship-pegleg.readthedocs.io/en/latest/cli.html