starlingx/docs
Code Issues Proposed changes
docs/doc/source/backup/running-ansible-backup-playbook-locally-on-the-controller.rst
Stone e1180949ca Backup and Restore 
Patch 2 review edits.

Stripped spaces at EOLs. Deleted vscode hidden directory.

Initial review and resolved supporting additions to source/shared/strings.txt

Signed-off-by: Stone <ronald.stone@windriver.com>
Change-Id: I21895e0f451d1a11b8f9813034c31a049d4f9ad8
Signed-off-by: Stone <ronald.stone@windriver.com>
2020-12-08 15:44:08 -05:00

2.1 KiB
Raw Blame History

Run Ansible Backup Playbook Locally on the Controller

In this method the Ansible Backup playbook is run on the active controller.

Use the following command to run the Ansible Backup playbook and back up the configuration, data, and optionally the user container images in registry.local data:

~(keystone_admin)$ ansible-playbook /usr/share/ansible/stx-ansible/playbooks/backup.yml -e "ansible_become_pass=<sysadmin password> admin_password=<sysadmin password>" [ -e "backup_user_local_registry=true" ]

The <admin_password> and <ansible_become_pass> need to be set correctly using the -e option on the command line, or an override file, or in the Ansible secret file.

The output files will be named:

  • inventory_hostname_platform_backup_timestamp.tgz
  • inventory_hostname_openstack_backup_timestamp.tgz
  • inventory_hostname_docker_local_registry_backup_timestamp.tgz

The variables prefix can be overridden using the -e option on the command line or by using an override file.

  • platform_backup_filename_prefix
  • openstack_backup_filename_prefix
  • docker_local_registry_backup_filename_prefix

The generated backup tar files will be displayed in the following format, for example:

  • localhost_docker_local_registry_backup_2020_07_15_21_24_22.tgz
  • localhost_platform_backup_2020_07_15_21_24_22.tgz
  • localhost_openstack_backup_2020_07_15_21_24_22.tgz

These files are located by default in the /opt/backups directory on controller-0, and contains the complete system backup.

If the default location needs to be modified, the variable backup_dir can be overridden using the -e option on the command line or by using an override file.