Run Restore Playbook Locally on the ControllerΒΆ

To run restore on the controller, you need to download the backup to the active controller.

You can use an external storage device, for example, a USB drive. Use the following command to run the Ansible Restore playbook:

~(keystone_admin)]$ 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> wipe_ceph_osds=<true/false>" -e "restore_registry_filesystem=true"

Other -e command line options:

-e restore_mode=optimized

Enable optimized restore mode

-e "initial_backup_dir=/home/sysadmin"

Where the backup tgz files are located on box.

-e backup_filename=localhost_platform_backup.tgz

The basename of the platform backup tgz. The full path will be a combination {initial_backup_dir}/{backup_filename}

-e restore_registry_filesystem=true

Restores the registry images created during backup when backup_registry_filesystem was true. If the registry filesystem is not restored the images must be pulled from upstream or registry.central.

-e registry_backup_filename=custom_name_registry_filesystem_backup.tgz

By default this override is not required. When restore_registry_filesystem is true and a custom name was used during backup, registry_backup_filename needs to be set to match. The full path will be a combination {initial_backup_dir}/{registry_backup_filename}

  • Optional: You can select one of the following restore modes:

    • To keep the Ceph cluster data intact (false - default option), use the following parameter:


    • To wipe the Ceph cluster entirely (true), where the Ceph cluster will need to be recreated, 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 sysadmin, or /tmp, or even a mounted USB device), use the following parameter:


      If this parameter is set to true, Ansible Restore playbook will look for the backup file provided on the target server. The parameter initial_backup_dir can be ommited from the command line. In this 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 case, both the initial_backup_dir and backup_filename must be specified in the command.

      Example of a backup file in /home/sysadmin

      ~(keystone_admin)]$ ansible-playbook /usr/share/ansible/stx-ansible/playbooks/restore_platform.yml -e "initial_backup_dir=/home/sysadmin ansible_become_pass=St8rlingX* admin_password=St8rlingX* backup_filename=localhost_platform_backup_2020_07_27_07_48_48.tgz wipe_ceph_osds=true"


      If the backup contains patches, Ansible Restore playbook will apply the patches and prompt you to reboot the system. Then you will need to re-run Ansible Restore playbook.

      The flag wipe_ceph_osds=true is required for a restore in a new hardware, for more details see AIO-SX - Restore on new hardware.

    • 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/<software-version>/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:

      ssl_ca_certificate_file=<complete path>/<ssl_ca certificates file>
      -e "ssl_ca_certificate_file=/home/sysadmin/new_ca-cert.pem"

      This parameter depends on on_box_data value.

      When on_box_data=true or not defined, the ssl_ca_certificate_file will be the location of ssl_ca certificate file in the target host. This is the default case.

      When on_box_data=false, the ssl_ca_certificate_file will be the location of ssl_ca certificate file where the Ansible controller is running. This is useful for remote play.


      To use this option on local restore mode, you need to download the ssl_ca certificate file to the active controller.


After restore is completed it is not possible to restart (or rerun) the restore playbook.


After running restore_platform.yml playbook, you can restore the local registry images.


The backup file of the local registry images may be large. Restore the backed up file on the controller, where there is sufficient space.

For example:

~(keystone_admin)]$ ansible-playbook /usr/share/ansible/stx-ansible/playbooks/restore_user_images.yml -e "initial_backup_dir=/home/sysadmin backup_filename=localhost_docker_local_registry_backup_2020_07_15_21_24_22.tgz ansible_become_pass=St8rlingX*"