starlingx/docs
Code Issues Proposed changes

Merge "Improve steps in backup and restore (r8,r6,dsR8,dsR6)"

Browse Source
This commit is contained in:
Zuul 2023-08-14 17:41:05 +00:00 committed by Gerrit Code Review
commit edcc747523
3 changed files with 12 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/source/backup/kubernetes/restoring-starlingx-system-data-and-storage.rst
View File

@ -29,7 +29,7 @@ details on the backup.
The system backup file can only be used to restore the system from which
the backup was made. You cannot use this backup file to restore the system
to different hardware.
To restore the backup, use the same version of the boot image (ISO) and
patches that were installed at the time of the backup.
@ -135,11 +135,11 @@ conditions are in place:
See :ref:`Install Kubernetes Platform on All-in-one Simplex <aio_simplex_install_kubernetes_r7>`;
``Install Software on Controller-0`` for steps on how to install patches
using the :command:`sw-patch install-local` command.
After the reboot, you can verify that the updates were applied.
.. only:: partner
.. include:: /_includes/restore-platform-system-data-and-storage-b92b8bdaf16d.rest
:start-after: sw-patch-query-begin
:end-before: sw-patch-query-end
@ -163,7 +163,7 @@ conditions are in place:
#. Restore the local registry using the file restore_user_images.yml.
.. note::
This step applies only if it was created during the backup operation.
This must be done before unlocking controller-0.
@ -177,12 +177,6 @@ conditions are in place:
After you unlock controller-0, storage nodes become available and Ceph
becomes operational.
#. For an |AIO-SX| system, run the following command:
.. code-block:: none
$ system service-parameter-apply kubernetes
#. If the system is a Distributed Cloud system controller, restore the **dc-vault**
using the restore_dc_vault.yml playbook. Perform this step after unlocking
controller-0:

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

@ -10,12 +10,16 @@ Run Ansible Backup Playbook Locally on the Controller
In this method the Ansible Backup playbook is run on the active controller.
Use the following command to run the Ansible Backup playbook and back up the
|prod| configuration, data, and user container images in registry.local:
Use one of the following commands to run the Ansible Backup playbook and back
up the |prod| configuration, data, and user container images in registry.local:
.. code-block:: none
~(keystone_admin)]$ ansible-playbook /usr/share/ansible/stx-ansible/playbooks/backup.yml -e "ansible_become_pass=<sysadmin password> admin_password=<sysadmin password>" -e "backup_registry_filesystem=true"
.. code-block:: none
~(keystone_admin)]$ ansible-playbook /usr/share/ansible/stx-ansible/playbooks/backup.yml --ask-vault-pass -e "override_files_dir=$HOME/override_dir"
@ -41,7 +45,7 @@ To exclude patch data from being included in the backup, you can use the paramet
``-e exclude_dirs=/opt/patching/**/*``.
.. warning::
Patch data should only be excluded for |AIO-SX| deployments when optimized
Restore is used.

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

@ -130,19 +130,3 @@ Other ``-e`` command line options:
After restore is completed it is not possible to restart (or rerun) the
restore playbook.
.. rubric:: |postreq|
After running restore_platform.yml playbook, you can restore the local
registry images.
.. note::
The backup file of the local registry images may be large. Restore the
backed up file on the controller, where there is sufficient space.
For example:
.. code-block:: none
~(keystone_admin)]$ ansible-playbook /usr/share/ansible/stx-ansible/playbooks/restore_user_images.yml -e "initial_backup_dir=/home/sysadmin backup_filename=localhost_docker_local_registry_backup_2020_07_15_21_24_22.tgz ansible_become_pass=St8rlingX*"