From fb9e1fe6fd29879a654adf6084d61c7a343086ff Mon Sep 17 00:00:00 2001 From: Elisamara Aoki Goncalves Date: Wed, 21 Dec 2022 19:44:07 -0300 Subject: [PATCH] Update B&R docs Addressing comments in https://review.opendev.org/c/starlingx/docs/+/854255 Signed-off-by: Elisamara Aoki Goncalves Change-Id: Iaed99bf1801f788df877edb50a2b78556d66c9fb --- ...tore-playbook-locally-on-the-controller.rst | 18 ++++++++++++++---- ...nning-ansible-restore-playbook-remotely.rst | 18 ++++++++++++++---- 2 files changed, 28 insertions(+), 8 deletions(-) diff --git a/doc/source/backup/kubernetes/running-restore-playbook-locally-on-the-controller.rst b/doc/source/backup/kubernetes/running-restore-playbook-locally-on-the-controller.rst index e4677abec..d6a8311b0 100644 --- a/doc/source/backup/kubernetes/running-restore-playbook-locally-on-the-controller.rst +++ b/doc/source/backup/kubernetes/running-restore-playbook-locally-on-the-controller.rst @@ -93,13 +93,23 @@ Other ``-e`` command line options: `. - - The ``ssl_ca_certificate_file`` defines the ssl_ca certificate that will be - installed during the restore. It will replace the ``ssl_ca`` certificate - from the backup tar file. + - The ``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//ca-cert.pem``, which is a + single certificate containing all the ssl_ca certificates installed in + the host when backup was done. So, the certificate assigned to this + parameter must follow this same pattern. + + For example: .. code-block:: none - ssl_ca_certificate_file=/ + ssl_ca_certificate_file=/ + + E.g.: + + -e "ssl_ca_certificate_file=/home/sysadmin/new_ca-cert.pem" This parameter depends on ``on_box_data`` value. diff --git a/doc/source/backup/kubernetes/system-backup-running-ansible-restore-playbook-remotely.rst b/doc/source/backup/kubernetes/system-backup-running-ansible-restore-playbook-remotely.rst index e750bc7d7..dce10f62b 100644 --- a/doc/source/backup/kubernetes/system-backup-running-ansible-restore-playbook-remotely.rst +++ b/doc/source/backup/kubernetes/system-backup-running-ansible-restore-playbook-remotely.rst @@ -113,13 +113,23 @@ In this method you can run Ansible Restore playbook and point to controller-0. ~(keystone_admin)]$ ansible-playbook /localdisk/designer/jenkins/tis-stx-dev/cgcs-root/stx/ansible-playbooks/playbookconfig/src/playbooks/restore_platform.yml --limit |prefix|\_Cluster -i $HOME/br_test/hosts -e "ansible_become_pass=St0rlingX* admin_password=St0rlingX* ansible_ssh_pass=St0rlingX* initial_backup_dir=$HOME/br_test backup_filename= |prefix|\_Cluster_system_backup_2019_08_08_15_25_36.tgz ansible_remote_tmp=/home/sysadmin/ansible-restore" - - The :command:`ssl_ca_certificate_file` indicates that a ``ssl_ca`` - certificate defined will replace the ``ssl_ca`` certificate from the - platform backup tar file. + - The ``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//ca-cert.pem``, which is a + single certificate containing all the ssl_ca certificates installed in + the host when backup was done. So, the certificate assigned to this + parameter must follow this same pattern. + + For example: .. code-block:: none - -e "ssl_ca_certificate_file=/" + ssl_ca_certificate_file=/ + + E.g.: + + -e "ssl_ca_certificate_file=/home/sysadmin/new_ca-cert.pem" .. note::