Chapter 1. Backing up the undercloud node

Procedure

1. On the undercloud node, source the undercloud credentials:

   [stack@undercloud ~]$ source stackrc
   (undercloud) [stack@undercloud ~]$

2. On the undercloud node, create an inventory file for the backup node:

   (undercloud) [stack@undercloud ~]$ cat <<'EOF'> ~/nfs-inventory.yaml
   [BackupNode]
   <backup_node> ansible_host=<ip_address> ansible_user=<user>
   EOF

   Replace <ip_address> and <user> with the values that apply to your environment.

3. Copy the public SSH key from the undercloud node to the backup node.

   (undercloud) [stack@undercloud ~]$ ssh-copy-id -i ~/.ssh/id_rsa.pub <backup_node>

   Replace <backup_node> with the path and name of the backup node.

4. Configure the NFS server on the backup node:

   (undercloud) [stack@undercloud ~]$ openstack undercloud backup --setup-nfs --extra-vars /home/stack/bar-vars.yaml --inventory /home/stack/nfs-inventory.yaml

Procedure

1. On the undercloud node, source the undercloud credentials:

   [stack@undercloud ~]$ source stackrc

   If you use a custom stack name, add the --stack <stack_name> option to the tripleo-ansible-inventory command.

2. If you have not done so before, create an inventory file and use the tripleo-ansible-inventory command to generate a static inventory file that contains hosts and variables for all the overcloud nodes:

   (undercloud) [stack@undercloud ~]$ tripleo-ansible-inventory \
   --ansible_ssh_user heat-admin \
   --static-yaml-inventory /home/stack/tripleo-inventory.yaml

3. Install ReaR on the undercloud node:

   (undercloud) [stack@undercloud ~]$ openstack undercloud backup --setup-rear --extra-vars /home/stack/bar-vars.yaml --inventory /home/stack/tripleo-inventory.yaml

4. If your system uses the UEFI boot loader, perform the following steps on the undercloud node:

   1. Install the following tools:

      $ sudo dnf install dosfstools efibootmgr

   2. Enable UEFI backup in the ReaR configuration file located in /etc/rear/local.conf by replacing the USING_UEFI_BOOTLOADER parameter value 0 with the value 1.

Procedure

1. Log in to the undercloud as the stack user.

2. Retrieve the MySQL root password:

   [stack@undercloud ~]$ PASSWORD=$(sudo /bin/hiera -c /etc/puppet/hiera.yaml mysql::server::root_password)

3. Create a database backup of the undercloud node:

   [stack@undercloud ~]$ sudo podman exec mysql bash -c "mysqldump -uroot -p$PASSWORD --opt --all-databases" | sudo tee /root/undercloud-all-databases.sql

4. Source the undercloud credentials:

   [stack@undercloud ~]$ source stackrc

5. If you have not done so before, create an inventory file and use the tripleo-ansible-inventory command to generate a static inventory file that contains hosts and variables for all the overcloud nodes:

   (undercloud) [stack@undercloud ~]$ tripleo-ansible-inventory \
   --ansible_ssh_user heat-admin \
   --static-yaml-inventory /home/stack/tripleo-inventory.yaml

6. Create a backup of the undercloud node:

   (undercloud) [stack@undercloud ~]$ openstack undercloud backup --inventory /home/stack/tripleo-inventory.yaml

Procedure

1. To schedule a backup of your control plane nodes, run the following command. The default schedule is Sundays at midnight:

   openstack undercloud backup --cron

2. Optional: Customize the scheduled backup according to your deployment:

   • To change the default backup schedule, pass a different cron schedule on the tripleo_backup_and_restore_cron parameter:

     openstack undercloud backup --cron --extra-vars
     '{"tripleo_backup_and_restore_cron": "0 0 * * 0"}'

   • To define additional parameters that are added to the backup command when cron runs the scheduled backup, pass the tripleo_backup_and_restore_cron_extra parameter to the backup command, as shown in the following example:

     openstack undercloud backup --cron --extra-vars '{"tripleo_backup_and_restore_cron_extra":"--extra-vars bar-vars.yaml --inventory /home/stack/tripleo-inventory.yaml"}'

   • To change the default user that executes the backup, pass the tripleo_backup_and_restore_cron_user parameter to the backup command, as shown in the following example:

     openstack undercloud backup --cron --extra-vars '{"tripleo_backup_and_restore_cron_user": "root"}