starlingx/docs
Code Issues Proposed changes

Remove reference to a nonexistent flag on BnR doc

Browse Source 
Remove nonexistent flag "rook_enabled"

Change-Id: Iadbbeba73d0411f6c13b1aae49438684e00d2362
Signed-off-by: Elisamara Aoki Gonçalves <elisamaraaoki.goncalves@windriver.com>
This commit is contained in:
Elisamara Aoki Gonçalves
2025-09-16 18:21:32 +00:00
parent 322772a9d5
commit 9919c366ea
2 changed files with 2 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
doc/source/backup/openstack/back-up-openstack.rst
View File

@@ -18,21 +18,12 @@ The backup playbook will produce a OpenStack backup tarball in addition to the
platform tarball. This can be used to perform |prod-os| restores independently
of restoring the underlying platform.
Based on the Ceph deployment, the |prefix|-openstack backup can be performed using
one of the following commands:
- Host Ceph deployments:
The |prefix|-openstack backup can be performed using the following command:
.. code-block:: none
$ ansible-playbook /usr/share/ansible/stx-ansible/playbooks/backup.yml -e "ansible_become_pass=<sysadmin password> admin_password=<sysadmin password> openstack_app_name=|prefix|-openstack skip_os_dbs=['Database','information_schema','performance_schema','mysql','horizon','panko','gnocchi','sys']"
- Rook Ceph deployments:
.. code-block:: none
$ ansible-playbook /usr/share/ansible/stx-ansible/playbooks/backup.yml -e "ansible_become_pass=<sysadmin password> admin_password=<sysadmin password> openstack_app_name=|prefix|-openstack skip_os_dbs=['Database','information_schema','performance_schema','mysql','horizon','panko','gnocchi','sys'] rook_enabled=true"
.. note::
Data stored in Ceph such as Glance images, Cinder volumes or volume backups

20
doc/source/developer_resources/backup_restore.rst
View File

@@ -70,12 +70,6 @@ one of the following methods:
* An override file
* In the Ansible secret file
If you deploy the system with rook instead of ceph backend, you must add the ``rook_enabled=true`` variable.
::
ansible-playbook /usr/share/ansible/stx-ansible/playbooks/backup.yml -e "ansible_become_pass=<sysadmin password> admin_password=<sysadmin password> [ rook_enabled=true ]"
The output of the command is a file named in this format:
``<inventory_hostname>_platform_backup_<timestamp>.tgz``
@@ -129,7 +123,6 @@ Example:
ansible-playbook /localdisk/designer/repo/cgcs-root/stx/stx-ansible-playbooks/playbookconfig/src/playbooks/backup-restore/backup.yml --limit my_vbox -i $HOME/br_test/hosts -e "host_backup_dir=$HOME/br_test ansible_become_pass=St8rlingXCloud* admin_password=St8rlingXCloud* ansible_ssh_pass=St8rlingXCloud* ansible_ssh_pass=St8rlingXCloud*"
#. If you deploy the system with rook instead of ceph backend, you must add the ``rook_enabled=true`` variable.
~~~~~~~~~~~~~~~~~~~~~~
Backup content details
@@ -285,7 +278,6 @@ Steps:
ansible-playbook /usr/share/ansible/stx-ansible/playbooks/restore_platform.yml -e "initial_backup_dir=<location_of_tarball> ansible_become_pass=<admin_password> admin_password=<admin_password> backup_filename=<backup_filename>"
#. If you deploy the system with rook instead of ceph backend, you must add the ``rook_enabled=true`` variable in above command.
**Remote play**
@@ -346,8 +338,6 @@ Steps:
ansible-playbook /localdisk/designer/jenkins/tis-stx-dev/cgcs-root/stx/ansible-playbooks/playbookconfig/src/playbooks/restore_platform.yml --limit my_vbox -i $HOME/br_test/hosts -e "ansible_become_pass=St8rlingXCloud* admin_password=St8rlingXCloud* ansible_ssh_pass=St8rlingXCloud* initial_backup_dir=$HOME/br_test backup_filename=my_vbox_system_backup_2019_08_08_15_25_36.tgz ansible_remote_tmp=/home/sysadmin/ansible-restore"
#. If you deploy the system with rook instead of ceph backend, you must add the ``rook_enabled=true`` variable in above command.
#. After Ansible is executed, perform the following steps based on your
deployment mode:
@@ -437,20 +427,12 @@ In this procedure, only the OpenStack application will be restored.
Steps:
#. Based on the Ceph deployment, the |prefix|-openstack backup can be performed using one of the following commands:
For Ceph (host based) storage backend:
#. The |prefix|-openstack backup can be performed using the following command:
.. code-block:: none
$ ansible-playbook /usr/share/ansible/stx-ansible/playbooks/backup.yml -e "ansible_become_pass=<sysadmin password> admin_password=<sysadmin password> openstack_app_name=|prefix|-openstack skip_os_dbs=['Database','information_schema','performance_schema','mysql','horizon','panko','gnocchi','sys']"
For Rook Ceph storage backend:
.. code-block:: none
$ ansible-playbook /usr/share/ansible/stx-ansible/playbooks/backup.yml -e "ansible_become_pass=<sysadmin password> admin_password=<sysadmin password> openstack_app_name=|prefix|-openstack skip_os_dbs=['Database','information_schema','performance_schema','mysql','horizon','panko','gnocchi','sys'] rook_enabled=true"
.. note::
When OpenStack is running, the backup.yml playbook generates two