Remove mention to wr-openstack

Change “wr-openstack” instances to “|prefix|-openstack”.

PS2: Use |prefix| substitution instead of "stx"
PS3, 4, 5, 6, 7: Fix table alignment
PS8: Replace table with text for |prefix| usage

Closes-Bug: 1948045

Change-Id: I41f804dd83d480e99a9c8ebfc252def3de0215ea
Signed-off-by: MCamp859 <maryx.camp@intel.com>
This commit is contained in:
MCamp859 2021-10-26 11:25:46 -04:00
parent e7690205f0
commit f89156f38e
5 changed files with 106 additions and 87 deletions

View File

@ -47,6 +47,6 @@ of restoring the underlying platform.
After export, copy the data off-box for safekeeping. After export, copy the data off-box for safekeeping.
For details on performing a |prod| back-up, see :ref:` For details on performing a |prod| back-up, see
System Backup and Restore <backing-up-starlingx-system-data>`. :ref:`System Backup and Restore <backing-up-starlingx-system-data>`.

View File

@ -25,96 +25,115 @@ You can restore |prod-os| from a backup with or without Ceph.
Images and volumes will remain in Ceph. Images and volumes will remain in Ceph.
.. code-block:: none .. parsed-literal::
~(keystone_admin)$ system application-remove wr-openstack ~(keystone_admin)$ system application-remove |prefix|-openstack
~(keystone_admin)$ system application-delete wr-openstack ~(keystone_admin)$ system application-delete |prefix|-openstack
~(keystone_admin)$ system application-upload wr-openstack.tgz ~(keystone_admin)$ system application-upload |prefix|-openstack.tgz
#. Restore |prod-os|. #. Restore |prod-os|.
You can choose either of the following options: You can choose either of the following options:
- Restore only |prod-os| system. This option will not restore the Ceph - Restore only |prod-os| system data. This option will not restore the
data \(that is, it will not run comands like :command:`rbd import`\). Ceph data \(that is, it will not run commands like :command:`rbd
This procedure will preserve any existing Ceph data at restore-time. import`\). This procedure will preserve any existing Ceph data at
restore-time.
- Restore |prod-os| system data, Cinder volumes and Glance images. You'll - Restore |prod-os| system data, Cinder volumes and Glance images. You'll
want to run this step if your Ceph data will be wiped after the backup. want to run this step if your Ceph data will be wiped after the backup.
------------------------------------
Restore only application system data
------------------------------------
.. table:: Run the following command:
:widths: 200, 668
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. parsed-literal::
| **Restore only OpenStack application system data:** | #. Run the following command: |
| | | ~(keystone_admin)$ ansible-playbook /usr/share/ansible/|prefix|-ansible/playbooks/ \
| | .. code-block:: none | restore_openstack.yml \
| | | -e 'initial_backup_dir=<location_of_backup_filename> \
| | ~(keystone_admin)$ ansible-playbook /usr/share/ansible/stx-ansible/playbooks/ \ | ansible_become_pass=<admin_password> \
| | restore_openstack.yml \ | admin_password=<admin_password> \
| | -e 'initial_backup_dir=<location_of_backup_filename> \ | backup_filename=<nnn>-openstack_backup.tgz'
| | ansible_become_pass=<admin_password> \ |
| | admin_password=<admin_password> \ | Where ``<nnn>`` is a user-defined value, such as |prefix| or the backup
| | backup_filename=wr-openstack_backup.tgz' | date.
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Restore OpenStack application system data, cinder volumes and glance images:** | #. Run the following command: |
| | | -----------------------------------------------------------------
| | .. code-block:: none | Restore application system data, cinder volumes and glance images
| | | -----------------------------------------------------------------
| | ~(keystone_admin)$ ansible-playbook /usr/share/ansible/stx-ansible/playbooks/ \ |
| | restore_openstack.yml \ | #. Run the following command:
| | -e 'restore_cinder_glance_data=true \ |
| | initial_backup_dir=<location_of_backup_filename> \ | .. parsed-literal::
| | ansible_become_pass=<admin_password> \ |
| | admin_password=<admin_password> \ | ~(keystone_admin)$ ansible-playbook /usr/share/ansible/|prefix|-ansible/playbooks/ \
| | backup_filename=wr-openstack_backup.tgz' | restore_openstack.yml \
| | | -e 'restore_cinder_glance_data=true \
| | When this step has completed, the Cinder, Glance and MariaDB services will be up, and Mariadb data restored. | initial_backup_dir=<location_of_backup_filename> \
| | | ansible_become_pass=<admin_password> \
| | #. Restore Ceph data. | admin_password=<admin_password> \
| | | backup_filename=<nnn>-openstack_backup.tgz'
| | |
| | #. Restore Cinder volumes using :command:`rbd import` command. | Where ``<nnn>`` is a user-defined value, such as |prefix| or the backup
| | | date.
| | For example: |
| | | When this step has completed, the Cinder, Glance and MariaDB services will
| | .. code-block:: none | be up, and Mariadb data restored.
| | |
| | ~(keystone_admin)$ rbd import -p cinder-volumes /tmp/611157b9-78a4-4a26-af16-f9ff75a85e1b | #. Restore Ceph data.
| | |
| | Where tmp/611157b9-78a4-4a26-af16-f9ff75a85e1b is a file saved earlier at the backup procedure as described in [#]_ . | #. Restore Cinder volumes using the :command:`rbd import` command.
| | |
| | #. Restore Glance images using the :command:`image-backup` script. | For example:
| | |
| | For example if we have an archive named image\_3f30adc2-3e7c-45bf-9d4b-a4c1e191d879.tgz in the/opt/backups directory we can use restore it using the following command: | .. code-block:: none
| | |
| | .. code-block:: none | ~(keystone_admin)$ rbd import -p cinder-volumes /tmp/611157b9-78a4-4a26-af16-f9ff75a85e1b
| | |
| | ~(keystone_admin)$ sudo image-backup.sh import image_3f30adc2-3e7c-45bf-9d4b-a4c1e191d879.tgz | Where ``tmp/611157b9-78a4-4a26-af16-f9ff75a85e1b`` is a file saved
| | | earlier at the backup procedure as described in [#]_ .
| | #. Use the :command:`tidy\_storage\_post\_restore` utilitary to detect any discrepancy between Cinder/Glance DB and rbd pools: |
| | | #. Restore Glance images using the :command:`image-backup` script.
| | .. code-block:: none |
| | | For example, if we have an archive named
| | ~(keystone_admin)$ tidy_storage_post_restore <log_file> | ``image_3f30adc2-3e7c-45bf-9d4b-a4c1e191d879.tgz`` in the ``/opt/backups``
| | | directory, we can use restore it using the following command:
| | |
| | After the script finishes, some command output will be written to the log file. They will help reconcile discrepancies between the |prod-os| database and CEPH data. | .. code-block:: none
| | |
| | #. Run the playbook again with the restore\_openstack\_continue flag set to true to bring up the remaining Openstack services. | ~(keystone_admin)$ sudo image-backup.sh import image_3f30adc2-3e7c-45bf-9d4b-a4c1e191d879.tgz
| | |
| | .. code-block:: none | #. Use the :command:`tidy_storage_post_restore` utility to detect any
| | | discrepancy between Cinder/Glance DB and rbd pools:
| | ~(keystone_admin)$ ansible-playbook /usr/share/ansible/stx-ansible/playbooks/ \ |
| | restore_openstack.yml \ | .. code-block:: none
| | -e 'restore_openstack_continue=true \ |
| | initial_backup_dir=<location_of_backup_filename> | ~(keystone_admin)$ tidy_storage_post_restore <log_file>
| | ansible_become_pass=<admin_password> \ |
| | admin_password=<admin_password> \ | After the script finishes, some command output will be written to the
| | backup_filename=wr-openstack_backup.tgz' | log file. They will help reconcile discrepancies between the |prod-os|
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ database and CEPH data.
#. Run the playbook again with the ``restore_openstack_continue`` flag set to
``true`` to bring up the remaining OpenStack services.
.. parsed-literal::
~(keystone_admin)$ ansible-playbook /usr/share/ansible/|prefix|-ansible/playbooks/ \
restore_openstack.yml \
-e 'restore_openstack_continue=true \
initial_backup_dir=<location_of_backup_filename>
ansible_become_pass=<admin_password> \
admin_password=<admin_password> \
backup_filename=<nnn>-openstack_backup.tgz'
Where ``<nnn>`` is a user-defined value, such as |prefix| or the backup
date.
.. include:: /_includes/restore-openstack-from-a-backup.rest .. include:: /_includes/restore-openstack-from-a-backup.rest

View File

@ -30,6 +30,6 @@ service REST API endpoints.
#. Apply the updated Helm chart overrides containing the certificate changes: #. Apply the updated Helm chart overrides containing the certificate changes:
.. code-block:: none .. parsed-literal::
~(keystone_admin)$ system application-apply wr-openstack ~(keystone_admin)$ system application-apply |prefix|-openstack

View File

@ -41,7 +41,7 @@ wildcard SAN, for example:
#. Apply the Helm chart overrides containing the certificate changes. #. Apply the Helm chart overrides containing the certificate changes.
.. code-block:: none .. parsed-literal::
~(keystone_admin)$ system application-apply wr-openstack ~(keystone_admin)$ system application-apply |prefix|-openstack

View File

@ -24,14 +24,14 @@ this section.
* The recommended size for the file system must be at least twice as large as * The recommended size for the file system must be at least twice as large as
the largest converted image from qcow2 to raw. the largest converted image from qcow2 to raw.
* The conversion file system can be added before or after wr-openstack is * The conversion file system can be added before or after |prefix|-openstack
applied. is applied.
* The conversion file system must be added on both controllers. Otherwise, * The conversion file system must be added on both controllers. Otherwise,
|prefix|-openstack will not use the new file system. |prefix|-openstack will not use the new file system.
* If the conversion file system is added after wr-openstack is applied, * If the conversion file system is added after |prefix|-openstack is applied,
changes to wr-openstack will only take effect once the application is changes to |prefix|-openstack will only take effect once the application is
reapplied. reapplied.
* The **image-conversion** file system can only be added on the controllers, and * The **image-conversion** file system can only be added on the controllers, and