Merge "Change patching to USM for B&R"

This commit is contained in:
Zuul 2024-11-25 15:33:19 +00:00 committed by Gerrit Code Review
commit 323aa39fc7
3 changed files with 31 additions and 20 deletions

View File

@ -142,15 +142,15 @@ conditions are in place:
.. note::
This is mandatory for |AIO-SX| optimized restore deployments. For legacy
restore deployments it is only mandatory if either the exclude_patches
(backup) or skip_patches_restore (restore) flags are used.
Restoring patches is done automatically if ``exclude_sw_deployments=false``
is used during backup and restore. By default, ``exclude_sw_deployments``
will be true for |AIO-SX| and subclouds and false for |AIO-DX| systems.
It is recommended to restore subclouds only when there is an existing
backup taken at the same patch level as the system controller.
For steps on how to install patches using the :command:`sw-patch install-local`
command, see :ref:`aio_simplex_install_kubernetes_r7`; ``Install Software on Controller-0``.
For steps on how to install patches manually, see
:ref:`patch-release-deployment-before-bootstrap-and-commissioning-of-7d0a97144db8`.
After the reboot, you can verify that the updates were applied.
@ -163,8 +163,7 @@ conditions are in place:
.. note::
On the systems that are not |AIO-SX|, you can skip this step if
``skip_patching=true`` is not used. Patches are automatically
reinstalled from the backup by default.
``exclude_sw_deployments=true`` is not used.
#. Ensure that the backup files are available on the controller. Run both
Ansible Restore playbooks, restore_platform.yml and restore_user_images.yml.

View File

@ -64,6 +64,14 @@ Following are the ``-e`` command line options:
When set to true, the backup playbook is allowed to be run on an unhealthy
system. This is needed in some extreme cases.
``-e exclude_sw_deployments={true,false}``
To exclude software deployment data from being included. When set to true,
software deployments are not included in the backup. By default, this is
true for |AIO-SX| and subclouds and false for |AIO-DX| systems (except subclouds).
The backup will always include software deployment
metadata.
.. warning::
Restoring a backup from an unhealthy system will lead to undefined behavior
@ -106,11 +114,8 @@ the optional parameter ``-e "exclude_dirs=/var/home/**,/var/home"``.
To exclude multiple files and directories, separate them with a comma.
Excluding patch data can save a significant amount of storage space,
transfer time, and compress/decompress computation.
To exclude patch data from being included in the backup, you can use the parameter:
``-e exclude_dirs=/opt/patching/**/*``.
Excluding software deployment data can save a significant amount of storage
space, transfer time, and compress/decompress computation.
.. warning::

View File

@ -52,6 +52,17 @@ Below you can find other ``-e`` command line options:
``backup_encryption_passphrase`` option is also required. Consider using
ansible-vault to store and specify passwords.
``-e exclude_sw_deployments={true,false}``
Setting this to true causes the restore to skip any restoring of software
deployments. By default, this is true for |AIO-SX| and subclouds and false
for |AIO-DX| systems (except subclouds). Software deployments can only be
restored using ``exclude_sw_deployments=false`` during backup.
``-e verify_base_commit={true,false}``
When restoring software deployments, the base commit will be checked to ensure
that the restore is being done with the original ISO. Set this to false
to ignore the base commit.
.. _running-restore-playbook-locally-on-the-controller-steps-usl-2c3-pmb:
(Optional): You can select one of the following restore modes:
@ -97,9 +108,10 @@ Below you can find other ``-e`` command line options:
.. note::
If the backup contains patches, Ansible Restore playbook will apply
the patches and prompt you to reboot the system. Then you will need
to re-run Ansible Restore playbook.
If the backup contains patches and ``exclude_sw_deployments=false`` is
used, Ansible Restore playbook will apply the patches and automatically
reboot the system if required. Then you will need to re-run Ansible
Restore playbook.
The flag ``wipe_ceph_osds=true`` is required for a restore in a new
hardware. For more details, see :ref:`node-replacement-for-aiominussx-using-optimized-backup-and-restore-6603c650c80d`.
@ -246,11 +258,6 @@ Below you can find other ``-e`` command line options:
**Legacy**
``-e skip_patching=true``
Patching will not be restored from the backup. With this option, you
will need to manually restore any patching before running the restore
playbook.
``-e restore_user_images=true``
Restores the user images created during backup when ``backup_user_images`` was
true. If the user images are not restored, the images must be pulled from