starlingx/docs
Code Issues Proposed changes

AIO-DX:[BnR] Ansible platform restore fails in TASK (dsMR2, dsRM3)

Browse Source 
Add clarifications on Ceph parameter usages
Patchset 1 review comments
Some generic clean-up of unclear language and punctuation
Formatting updates

Closes-bug: 2062014

Change-Id: I5bac66b3860a6f1473474bb64c7db4c71ca9273b
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
This commit is contained in:
Ron Stone 2024-04-17 11:14:51 +00:00
parent 960eb282f0
commit 5c4a152b2c
3 changed files with 44 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/source/backup/kubernetes/restoring-starlingx-system-data-and-storage.rst
View File

@ -48,9 +48,10 @@ The |prod| restore supports the following optional modes:
wipe_ceph_osds=false
- To wipe the Ceph cluster entirely (true), where the Ceph cluster will
need to be recreated, or if the Ceph partition was wiped somehow before or
during reinstall, use the following parameter:
- To wipe the Ceph cluster entirely (true), where the Ceph cluster will need
to be recreated, or if the Ceph partition was previously wiped, such as
during a fresh install between backup and restore or during reinstall, use
the following parameter:
.. code-block:: none

18
doc/source/backup/kubernetes/running-restore-playbook-locally-on-the-controller.rst
View File

@ -49,10 +49,22 @@ Below you can find other ``-e`` command line options:
(Optional): You can select one of the following restore modes:
- To keep the Ceph cluster data intact (false - default option), use the
``wipe_ceph_osds=false`` parameter.
following parameter, when passing the extra arguments to the Ansible
Restore playbook command:
- To wipe the Ceph cluster entirely (true), where the Ceph cluster will
need to be recreated, use the ``wipe_ceph_osds=true`` parameter.
.. code-block:: none
wipe_ceph_osds=false
To wipe the Ceph cluster entirely (true), where the Ceph cluster will need
to be recreated, or if the Ceph partition was previously wiped, such as
during a fresh install between backup and restore or during reinstall, use
the following parameter:
.. code-block:: none
wipe_ceph_osds=true
- To define a convinient place to store the backup files, defined by
``initial-backup_dir``, on the system (such as the home folder for

42
doc/source/backup/kubernetes/system-backup-running-ansible-restore-playbook-remotely.rst
View File

@ -54,22 +54,31 @@ In this method you can run Ansible Restore playbook and point to controller-0.
where ``optional-extra-vars`` can be:
- To keep Ceph data intact (false - default option), use the
following parameter:
- To keep the Ceph cluster data intact (false - default option), use the
following parameter when passing the extra arguments to the Ansible
Restore playbook command:
:command:`wipe_ceph_osds=false`
.. code-block::
- To start with an empty Ceph cluster (true), where the Ceph
cluster will need to be recreated, use the following parameter:
wipe_ceph_osds=false
:command:`wipe_ceph_osds=true`
To wipe the Ceph cluster entirely (true), where the Ceph cluster will
need to be recreated, or if the Ceph partition was previously wiped
(for example, during a fresh install between backup and restore), or
during a reinstall, use the following parameter:
- To define a convinient place to store the backup files, defined by
``initial-backup_dir``, on the system (such as the home folder for
.. code-block::
wipe_ceph_osds=true
- To set a convinient place to store the backup files defined by
``initial-backup_dir`` on the system (such as the home folder for
sysadmin, or /tmp, or even a mounted USB device), use the following
parameter:
:command:`on_box_data=true/false`
.. code-block::
on_box_data=true/false
If this parameter is set to true, Ansible Restore playbook will look
for the backup file provided on the target server. The parameter
@ -77,11 +86,11 @@ In this method you can run Ansible Restore playbook and point to controller-0.
case, the backup file will be under ``/opt/platform-backup`` directory.
If this parameter is set to false, the Ansible Restore playbook will
look for backup file provided where is the Ansible controller. In this
look for a backup file provided on the Ansible controller. In this
case, both the ``initial_backup_dir`` and ``backup_filename`` must be
specified in the command.
- The ``backup_filename`` is the platform backup tar file. It must be
- ``backup_filename`` is the platform backup tar file. It must be
provided using the ``-e`` option on the command line, for example:
.. code-block:: none
@ -102,10 +111,9 @@ In this method you can run Ansible Restore playbook and point to controller-0.
:command:`ansible_ssh_pass` is the password to the sysadmin user
on controller-0.
- The :command:`ansible_remote_tmp` should be set to a new
directory (not required to create it ahead of time) under
/home/sysadmin on controller-0 using the ``-e`` option on the command
line.
- The :command:`ansible_remote_tmp` should be set to a new directory (not
required to create it ahead of time) under ``/home/sysadmin`` on
controller-0 using the ``-e`` option on the command line.
For example:
@ -118,7 +126,7 @@ In this method you can run Ansible Restore playbook and point to controller-0.
If ``ansible_remote_tmp`` is not set, ``/tmp`` will be used. ``/tmp``
can only hold 1GB.
An example of what happens when ``ansible_remote_tmp`` is not used:
Below is sample output without ``ansible_remote_tmp``:
.. code-block:: none
@ -130,7 +138,7 @@ In this method you can run Ansible Restore playbook and point to controller-0.
scp: /tmp/.ansible-sysadmin/tmp/ansible-tmp-1687355968.13-696694507261/source: No space left on device
- The ``ssl_ca_certificate_file`` defines a single certificate that
- ``ssl_ca_certificate_file`` defines a single certificate that
contains all the ssl_ca certificates that will be installed during the
restore. It will replace the
``/opt/platform/config/<software-version>/ca-cert.pem``, which is a