From 0c5950a87d3e5ba8c37fa96310695e10838ddd43 Mon Sep 17 00:00:00 2001 From: Elisamara Aoki Goncalves Date: Thu, 10 Aug 2023 18:20:00 +0000 Subject: [PATCH] Improve steps in backup and restore (r8,r6,dsR8,dsR6) Remove step 9 from Restore Platform System Data and Storage Split example in Run Ansible Backup Playbook Locally on the Controller Remove Postrequisites from Run Restore Playbook Locally on the Controller Closes-bug: 2031318 Change-Id: Id3bfde9b7747bdbe17b4b541a915ccc2494d9602 Signed-off-by: Elisamara Aoki Goncalves --- ...storing-starlingx-system-data-and-storage.rst | 16 +++++----------- ...backup-playbook-locally-on-the-controller.rst | 10 +++++++--- ...estore-playbook-locally-on-the-controller.rst | 16 ---------------- 3 files changed, 12 insertions(+), 30 deletions(-) diff --git a/doc/source/backup/kubernetes/restoring-starlingx-system-data-and-storage.rst b/doc/source/backup/kubernetes/restoring-starlingx-system-data-and-storage.rst index 4cf50b92c..0bb0c1b0f 100644 --- a/doc/source/backup/kubernetes/restoring-starlingx-system-data-and-storage.rst +++ b/doc/source/backup/kubernetes/restoring-starlingx-system-data-and-storage.rst @@ -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 `; ``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: diff --git a/doc/source/backup/kubernetes/running-ansible-backup-playbook-locally-on-the-controller.rst b/doc/source/backup/kubernetes/running-ansible-backup-playbook-locally-on-the-controller.rst index f39689031..df1a9fb7e 100644 --- a/doc/source/backup/kubernetes/running-ansible-backup-playbook-locally-on-the-controller.rst +++ b/doc/source/backup/kubernetes/running-ansible-backup-playbook-locally-on-the-controller.rst @@ -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= admin_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. 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 f013b5cd4..8eb483092 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 @@ -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*"