From 33f2c22f23d397c0d682b16557ae9b57f0464e8d Mon Sep 17 00:00:00 2001 From: Ngairangbam Mili Date: Wed, 11 Sep 2024 09:13:31 +0000 Subject: [PATCH] Add new restore_extra_items option to restore Story: 2011180 Task: 51000 Change-Id: Iba38eff9d6b0bcf3d3f3e0c5c0c3bec8f9ea911d Signed-off-by: Ngairangbam Mili --- ...ore-playbook-locally-on-the-controller.rst | 21 +++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/doc/source/backup/kubernetes/running-restore-playbook-locally-on-the-controller.rst b/doc/source/backup/kubernetes/running-restore-playbook-locally-on-the-controller.rst index 961204a10..e8e05fdd5 100644 --- a/doc/source/backup/kubernetes/running-restore-playbook-locally-on-the-controller.rst +++ b/doc/source/backup/kubernetes/running-restore-playbook-locally-on-the-controller.rst @@ -215,6 +215,27 @@ Below you can find other ``-e`` command line options: -e restore_mode=optimized \ -e "@/path/to/restore_overrides.yaml" +``-e restore_extra_items`` + Enables the restore playbook to extract additional items from the backup + during its execution. This is useful when the user has unmanaged files that + are not included in a normal restore operation. + + The following is an example of restoring some files that had been manually + modified on the system pre-backup: + + .. code-block:: + + ansible-playbook /usr/share/ansible/stx-ansible/playbooks/restore_platform.yml \ + -e "initial_backup_dir=/home/sysadmin" \ + -e "backup_filename=localhost_platform_backup_2024_08_12_22_58_21.tgz" + -e '{"restore_extra_items": ["etc/pam.d/common-auth", "etc/security/group.conf"]}' + + .. note:: + + The ``restore_extra_items`` option will restore files only on + controller-0. The user must restore files on other nodes after they + are reinstalled, if required. + **Legacy** ``-e skip_patching=true``