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 34ab6ba70..711e8c02d 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 @@ -17,7 +17,7 @@ This procedure takes a snapshot of the etcd database at the time of backup, stores it in the system data backup, and then uses it to initialize the Kubernetes cluster during a restore. Kubernetes configuration will be restored and pods that are started from repositories accessible from the -internet or from external repositories will start immediately. StarlingX +internet or from external repositories will start immediately. |prod| specific applications must be re-applied once a storage cluster is configured. .. warning:: @@ -92,7 +92,7 @@ conditions are in place: $ source /etc/platform/openrc ~(keystone_admin)]$ dcmanager subcloud unmanage - where is the name of the subcloud to be unmanaged. + where ```` is the name of the subcloud to be unmanaged. .. rubric:: |proc| @@ -126,11 +126,11 @@ conditions are in place: `. .. note:: - The backup files contains the system data and updates. + The backup files contain the system data and updates. #. If the backup file contains patches, Ansible Restore playbook restore\_platform.yml will apply the patches and prompt you to reboot the - system, you will need to re-run Ansible Restore playbook + system, you will need to re-run Ansible Restore playbook. The current software version on the controller is compared against the version available in the backup file. If the backed-up version includes @@ -156,6 +156,8 @@ conditions are in place: This must be done before unlocking controller-0. +#. Unlock Controller-0. + .. code-block:: none ~(keystone_admin)]$ system host-unlock controller-0 @@ -163,6 +165,17 @@ conditions are in place: After you unlock controller-0, storage nodes become available and Ceph becomes operational. +#. 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: + + .. code-block:: none + + $ ansible-playbook /usr/share/ansible/stx-ansible/playbooks/restore_dc_vault.yml -e "initial_backup_dir=/home/sysadmin backup_filename=localhost_dc_vault_backup_2020_07_15_21_24_22.tgz ansible_become_pass=St0rlingX*" + + .. note:: + The dc-vault backup archive is created by the backup.yml playbook. + #. Authenticate the system as Keystone user **admin**. Source the **admin** user environment as follows: @@ -328,8 +341,7 @@ conditions are in place: ~(keystone_admin)]$ system restore-complete -#. Alarms 750.006 alarms disappear one at a time, as the apps are auto -applied. +#. Alarms 750.006 alarms disappear one at a time, as the apps are auto applied. .. rubric:: |postreq| @@ -347,7 +359,7 @@ applied. $ source /etc/platform/openrc ~(keystone_admin)]$ dcmanager subcloud manage - where is the name of the subcloud to be managed. + where ```` is the name of the subcloud to be managed. .. comments in steps seem to throw numbering off. 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 c01d508bf..9a6118173 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 @@ -29,6 +29,8 @@ The output files will be named: - inventory\_hostname\_docker\_local\_registry\_backup\_timestamp.tgz +- inventory\_hostname\_dc\_vault\_backup\_timestamp.tgz + The variables prefix can be overridden using the ``-e`` option on the command line or by using an override file. @@ -40,6 +42,8 @@ line or by using an override file. - docker\_local\_registry\_backup\_filename\_prefix +- dc\_vault\_backup\_filename\_prefix + The generated backup tar files will be displayed in the following format, for example: @@ -51,6 +55,8 @@ for example: - localhost\_openstack\_backup\_2020\_07\_15\_21\_24\_22.tgz +- localhost\_dc\_vault\_backup\_2020\_07\_15\_21\_24\_22.tgz + These files are located by default in the /opt/backups directory on controller-0, and contains the complete system backup.