starlingx/docs
Code Issues Proposed changes

Incorrect procedure for using ansible vault for automated platform backup (dsr8mr3, dsr8mr2+)

Browse Source 
Fixed the instruction to use override_files_dir

Change-Id: I1bd59fb1f0e83cf2b3279087d884c87547e9611f
Signed-off-by: Ngairangbam Mili <ngairangbam.mili@windriver.com>
This commit is contained in:
Ngairangbam Mili 2024-10-14 08:09:52 +00:00
parent 7dc8f326fe
commit b30cbe2821
1 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/source/backup/kubernetes/running-ansible-backup-playbook-locally-on-the-controller.rst
View File

@ -120,11 +120,21 @@ The <admin_password> and <ansible_become_pass> need to be set correctly
using the ``-e`` option on the command line, with an override file secured with
ansible-vault (recommended).
For example, create your override file with the :command:`ansible-vault create $HOME/override_dir/localhost-backup.yaml`
For example, create your override file with the :command:`ansible-vault create $HOME/override_dir/secrets.yml`
command and copy the following lines into the file. You will be prompted for a
password to protect/encrypt the file. Use the :command:`ansible-vault edit $HOME/override_dir/localhost-backup.yaml`
password to protect/encrypt the file. Use the :command:`ansible-vault edit $HOME/override_dir/secrets.yml`
command if the file needs to be edited after it is created.
The following yaml names are allowed:
- ``{{ override_files_dir }}/secrets.yml``
- ``{{ override_files_dir }}/{{ inventory_hostname }}_secrets.yml``
- ``{{ override_files_dir }}/site.yml``
- ``{{ override_files_dir }}/{{ inventory_hostname }}.yml``
.. code-block:: none
ansible_become_pass: "<admin_password>"