Chapter 2. Backing up the control plane nodes

Procedure

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

   [stack@undercloud-0 ~]$ 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. In the bar-vars.yaml environment file, add the tripleo_controller_group_name parameter:

   tripleo_controller_group_name: <group_names_list>

2. Set the <group_names_list> value to the list of names of the groups of nodes that you want to back up.

Procedure

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

   [stack@undercloud-0 ~]$ source stackrc

2. If you have not done so before, extract the static ansible inventory file from the location in which it was saved during installation:

   (undercloud) [stack@undercloud ~]$ cp ~/overcloud-deploy/<stack>/tripleo-ansible-inventory.yaml ~/tripleo-inventory.yaml

   • Replace <stack> with the name of your stack. By default, the name of the stack is overcloud.

3. In the bar-vars.yaml file, configure the backup storage location:

   1. If you installed and configured your own NFS server, add the tripleo_backup_and_restore_server parameter and set the value to the IP address of your NFS server:

      tripleo_backup_and_restore_server: <ip_address>

      By default, the tripleo_backup_and_restore_server parameter value is 192.168.24.1.

   2. If you use an SFTP server, add the tripleo_backup_and_restore_output_url parameter and set the values of the URL and credentials of the SFTP server:

      tripleo_backup_and_restore_output_url: sftp://<user>:<password>@<backup_node>/
      tripleo_backup_and_restore_backup_url: iso:///backup/

      Replace <user>, <password>, and <backup_node> with the backup node URL and credentials.

4. Install ReaR on the control plane nodes:

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

5. If your system uses the UEFI boot loader, perform the following steps on the control plane nodes:

   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. Locate the config-drive partition on each control plane node:

   [stack@undercloud-0 ~]$ lsblk
   NAME   MAJ:MIN RM  SIZE RO TYPE MOUNTPOINT
   vda    253:0    0   55G  0 disk
   ├─vda1 253:1    0    1M  0 part            1
   ├─vda2 253:2    0  100M  0 part /boot/efi
   └─vda3 253:3    0 54.9G  0 part /

   1

   The config-drive partition is the 1M partition that is not mounted.

2. On each control plane node, back up the config-drive partition of each node as the root user:

   [root@controller-x ~]# dd if=<config_drive_partition> of=/mnt/config-drive

   Replace <config_drive_partition> with the name of the config-drive partition that you located in step 1.

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

   [stack@undercloud-0 ~]$ source stackrc

4. If you have not done so before, 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 tripleo-admin \
   --static-yaml-inventory /home/stack/tripleo-inventory.yaml

5. Create a backup of the control plane nodes:

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

   The backup process runs sequentially on each control plane node without disrupting the service to your environment.

Procedure

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

   openstack overcloud 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 overcloud 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 overcloud 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 overcloud backup --cron --extra-vars '{"tripleo_backup_and_restore_cron_user": "root"}