Update docs for /var/lib/mistral/<plan name>

Instead of using the workflow execution uuid, the plan name is now used
under /var/lib/mistral.

Change-Id: I4358d304745b1601ec5ec74cf68cb3d5a65b65fa
Depends-On: Id639d0a99aa1103f6f9cc54de676ea8ba6111332
This commit is contained in:
James Slagle 2018-07-19 11:47:29 -04:00
parent cd809637e0
commit 27eca552f5
2 changed files with 14 additions and 29 deletions

View File

@ -124,36 +124,25 @@ Mistral workflow
The Mistral workflow that runs config-download and ``ansible-playbook`` is
``tripleo.deployment.v1.config_download_deploy``.
The workflow will create a working directory under ``/var/lib/mistral`` where
all of the ansible related files are stored.
The workflow will create a working directory with the plan name under
``/var/lib/mistral`` where all of the ansible related files are stored.
Ansible working directory
_________________________
The workflow uses a working directory under ``/var/lib/mistral`` to store the generated
files needed to run ``ansible-playbook``.
The workflow uses a working directory with the plan name under
``/var/lib/mistral`` to store the generated files needed to run
``ansible-playbook``.
The directory for a given execution of the workflow is
``/var/lib/mistral/<execution-id>``.
All of the files under ``/var/lib/mistral`` are owned by the mistral user and
readable by the mistral group. The interactive user account on the undercloud
can be granted read-only access to these files by adding the user to the
``mistral`` group::
All of the files under ``/var/lib/mistral/<plan name>`` are owned by the
mistral user and readable by the mistral group. The interactive user account on
the undercloud can be granted read-only access to these files by adding the
user to the ``mistral`` group::
sudo usermod -a -G mistral $USER
Once a member of the ``mistral`` group, the contents of ``/var/lib/mistral``
can be browsed, examined, and ``ansible-playbook`` rerun if needed for
debugging purposes.
For example, to see the latest execution of
``tripleo.deployment.v1.config_download_deploy``, run::
ls -ltr /var/lib/mistral
Change to the latest directory shown (example)::
cd /var/lib/mistral/de35fb93-aa73-4535-9b71-c50011952969
Once a member of the ``mistral`` group, the contents of
``/var/lib/mistral/<plan name>`` can be browsed, examined, and
``ansible-playbook`` rerun if needed for debugging purposes.
Within this directory, all the files are present to rerun
``ansible-playbook``:

View File

@ -1,9 +1,5 @@
Deployment Log
--------------
The ansible part of the deployment creates a log file that is saved on the
undercloud. The log file is available ``/var/lib/mistral/<execution
id>/ansible.log``. The ``<execution id>`` is a UUID that corresponds to the Mistral
execution that executed ``ansible-playbook``.
Looking for the most recently modified directory under ``/var/lib/mistral`` is
an easy way to quickly find the log for the most recent deployment.
undercloud. The log file is available ``/var/lib/mistral/<plan
name>/ansible.log``.