From f89156f38eb1f9f5cf15eec95c1727d3834d44a2 Mon Sep 17 00:00:00 2001 From: MCamp859 Date: Tue, 26 Oct 2021 11:25:46 -0400 Subject: [PATCH] Remove mention to wr-openstack MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- .../backup/openstack/back-up-openstack.rst | 4 +- .../restore-openstack-from-a-backup.rst | 173 ++++++++++-------- .../install-a-trusted-ca-certificate.rst | 4 +- ...stall-rest-api-and-horizon-certificate.rst | 4 +- ...nfigure-an-optional-cinder-file-system.rst | 8 +- 5 files changed, 106 insertions(+), 87 deletions(-) diff --git a/doc/source/backup/openstack/back-up-openstack.rst b/doc/source/backup/openstack/back-up-openstack.rst index 5f3b4d151..29f207867 100644 --- a/doc/source/backup/openstack/back-up-openstack.rst +++ b/doc/source/backup/openstack/back-up-openstack.rst @@ -47,6 +47,6 @@ of restoring the underlying platform. After export, copy the data off-box for safekeeping. -For details on performing a |prod| back-up, see :ref:` -System Backup and Restore `. +For details on performing a |prod| back-up, see +:ref:`System Backup and Restore `. diff --git a/doc/source/backup/openstack/restore-openstack-from-a-backup.rst b/doc/source/backup/openstack/restore-openstack-from-a-backup.rst index 368da1da2..d997a6983 100644 --- a/doc/source/backup/openstack/restore-openstack-from-a-backup.rst +++ b/doc/source/backup/openstack/restore-openstack-from-a-backup.rst @@ -25,96 +25,115 @@ You can restore |prod-os| from a backup with or without Ceph. Images and volumes will remain in Ceph. - .. code-block:: none + .. parsed-literal:: - ~(keystone_admin)$ system application-remove wr-openstack - ~(keystone_admin)$ system application-delete wr-openstack - ~(keystone_admin)$ system application-upload wr-openstack.tgz + ~(keystone_admin)$ system application-remove |prefix|-openstack + ~(keystone_admin)$ system application-delete |prefix|-openstack + ~(keystone_admin)$ system application-upload |prefix|-openstack.tgz #. Restore |prod-os|. You can choose either of the following options: - - Restore only |prod-os| system. This option will not restore the Ceph - data \(that is, it will not run comands like :command:`rbd import`\). - This procedure will preserve any existing Ceph data at restore-time. + - Restore only |prod-os| system data. This option will not restore the + Ceph data \(that is, it will not run commands like :command:`rbd + import`\). This procedure will preserve any existing Ceph data at + restore-time. - 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. +------------------------------------ +Restore only application system data +------------------------------------ - .. table:: - :widths: 200, 668 +Run the following command: - +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **Restore only OpenStack application system data:** | #. Run the following command: | - | | | - | | .. code-block:: none | - | | | - | | ~(keystone_admin)$ ansible-playbook /usr/share/ansible/stx-ansible/playbooks/ \ | - | | restore_openstack.yml \ | - | | -e 'initial_backup_dir= \ | - | | ansible_become_pass= \ | - | | admin_password= \ | - | | backup_filename=wr-openstack_backup.tgz' | - +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **Restore OpenStack application system data, cinder volumes and glance images:** | #. Run the following command: | - | | | - | | .. code-block:: none | - | | | - | | ~(keystone_admin)$ ansible-playbook /usr/share/ansible/stx-ansible/playbooks/ \ | - | | restore_openstack.yml \ | - | | -e 'restore_cinder_glance_data=true \ | - | | initial_backup_dir= \ | - | | ansible_become_pass= \ | - | | admin_password= \ | - | | backup_filename=wr-openstack_backup.tgz' | - | | | - | | When this step has completed, the Cinder, Glance and MariaDB services will be up, and Mariadb data restored. | - | | | - | | #. Restore Ceph data. | - | | | - | | | - | | #. Restore Cinder volumes using :command:`rbd import` command. | - | | | - | | For example: | - | | | - | | .. code-block:: none | - | | | - | | ~(keystone_admin)$ rbd import -p cinder-volumes /tmp/611157b9-78a4-4a26-af16-f9ff75a85e1b | - | | | - | | Where tmp/611157b9-78a4-4a26-af16-f9ff75a85e1b is a file saved earlier at the backup procedure as described in [#]_ . | - | | | - | | #. Restore Glance images using the :command:`image-backup` script. | - | | | - | | 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 | - | | | - | | ~(keystone_admin)$ sudo image-backup.sh import image_3f30adc2-3e7c-45bf-9d4b-a4c1e191d879.tgz | - | | | - | | #. Use the :command:`tidy\_storage\_post\_restore` utilitary to detect any discrepancy between Cinder/Glance DB and rbd pools: | - | | | - | | .. code-block:: none | - | | | - | | ~(keystone_admin)$ tidy_storage_post_restore | - | | | - | | | - | | 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. | - | | | - | | #. Run the playbook again with the restore\_openstack\_continue flag set to true to bring up the remaining Openstack services. | - | | | - | | .. code-block:: none | - | | | - | | ~(keystone_admin)$ ansible-playbook /usr/share/ansible/stx-ansible/playbooks/ \ | - | | restore_openstack.yml \ | - | | -e 'restore_openstack_continue=true \ | - | | initial_backup_dir= | - | | ansible_become_pass= \ | - | | admin_password= \ | - | | backup_filename=wr-openstack_backup.tgz' | - +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +.. parsed-literal:: + + ~(keystone_admin)$ ansible-playbook /usr/share/ansible/|prefix|-ansible/playbooks/ \ + restore_openstack.yml \ + -e 'initial_backup_dir= \ + ansible_become_pass= \ + admin_password= \ + backup_filename=-openstack_backup.tgz' + +Where ```` is a user-defined value, such as |prefix| or the backup +date. + + +----------------------------------------------------------------- +Restore application system data, cinder volumes and glance images +----------------------------------------------------------------- + +#. Run the following command: + + .. parsed-literal:: + + ~(keystone_admin)$ ansible-playbook /usr/share/ansible/|prefix|-ansible/playbooks/ \ + restore_openstack.yml \ + -e 'restore_cinder_glance_data=true \ + initial_backup_dir= \ + ansible_become_pass= \ + admin_password= \ + backup_filename=-openstack_backup.tgz' + + Where ```` is a user-defined value, such as |prefix| or the backup + date. + + When this step has completed, the Cinder, Glance and MariaDB services will + be up, and Mariadb data restored. + +#. Restore Ceph data. + + #. Restore Cinder volumes using the :command:`rbd import` command. + + For example: + + .. code-block:: none + + ~(keystone_admin)$ rbd import -p cinder-volumes /tmp/611157b9-78a4-4a26-af16-f9ff75a85e1b + + Where ``tmp/611157b9-78a4-4a26-af16-f9ff75a85e1b`` is a file saved + earlier at the backup procedure as described in [#]_ . + + #. Restore Glance images using the :command:`image-backup` script. + + 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 + + ~(keystone_admin)$ sudo image-backup.sh import image_3f30adc2-3e7c-45bf-9d4b-a4c1e191d879.tgz + + #. Use the :command:`tidy_storage_post_restore` utility to detect any + discrepancy between Cinder/Glance DB and rbd pools: + + .. code-block:: none + + ~(keystone_admin)$ tidy_storage_post_restore + + 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. + +#. 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= + ansible_become_pass= \ + admin_password= \ + backup_filename=-openstack_backup.tgz' + + Where ```` is a user-defined value, such as |prefix| or the backup + date. .. include:: /_includes/restore-openstack-from-a-backup.rest diff --git a/doc/source/security/openstack/install-a-trusted-ca-certificate.rst b/doc/source/security/openstack/install-a-trusted-ca-certificate.rst index 8a02cda39..3f43b7e3e 100644 --- a/doc/source/security/openstack/install-a-trusted-ca-certificate.rst +++ b/doc/source/security/openstack/install-a-trusted-ca-certificate.rst @@ -30,6 +30,6 @@ service REST API endpoints. #. 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 diff --git a/doc/source/security/openstack/install-rest-api-and-horizon-certificate.rst b/doc/source/security/openstack/install-rest-api-and-horizon-certificate.rst index 49f8822bd..325ab9355 100644 --- a/doc/source/security/openstack/install-rest-api-and-horizon-certificate.rst +++ b/doc/source/security/openstack/install-rest-api-and-horizon-certificate.rst @@ -41,7 +41,7 @@ wildcard SAN, for example: #. 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 diff --git a/doc/source/storage/openstack/configure-an-optional-cinder-file-system.rst b/doc/source/storage/openstack/configure-an-optional-cinder-file-system.rst index 74d4b7dc7..2ff54925c 100644 --- a/doc/source/storage/openstack/configure-an-optional-cinder-file-system.rst +++ b/doc/source/storage/openstack/configure-an-optional-cinder-file-system.rst @@ -24,14 +24,14 @@ this section. * The recommended size for the file system must be at least twice as large as the largest converted image from qcow2 to raw. -* The conversion file system can be added before or after wr-openstack is - applied. +* The conversion file system can be added before or after |prefix|-openstack + is applied. * The conversion file system must be added on both controllers. Otherwise, |prefix|-openstack will not use the new file system. -* If the conversion file system is added after wr-openstack is applied, - changes to wr-openstack will only take effect once the application is +* If the conversion file system is added after |prefix|-openstack is applied, + changes to |prefix|-openstack will only take effect once the application is reapplied. * The **image-conversion** file system can only be added on the controllers, and