Chapter 2. Backing up the control plane nodes

Procedure

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

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

   Copy to Clipboard Toggle word wrap

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

   Copy to Clipboard Toggle word wrap

   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>

   Copy to Clipboard Toggle word wrap

   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

   Copy to Clipboard Toggle word wrap

Procedure

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

   [stack@undercloud ~]$ source stackrc

   Copy to Clipboard Toggle word wrap

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

   Copy to Clipboard Toggle word wrap

3. In the bar-vars.yaml file, configure the backup storage location. Follow the appropriate steps for your NFS server or SFTP server.

   1. If you use an NFS server, add the following parameters to the bar-vars.yaml file:

      tripleo_backup_and_restore_server: <ip_address>
      tripleo_backup_and_restore_shared_storage_folder: <backup_server_dir_path>
      tripleo_backup_and_restore_output_url: "nfs://{{ tripleo_backup_and_restore_server }}{{ tripleo_backup_and_restore_shared_storage_folder }}"
      tripleo_backup_and_restore_backup_url: "nfs://{{ tripleo_backup_and_restore_server }}{{ tripleo_backup_and_restore_shared_storage_folder }}"

      Copy to Clipboard Toggle word wrap

      Replace <ip_address>`and `<backup_server_dir_path>. The default value for 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/

      Copy to Clipboard Toggle word wrap

      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

   Copy to Clipboard Toggle word wrap

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

      Copy to Clipboard Toggle word wrap
   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 ~]$ 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 /

   Copy to Clipboard Toggle word wrap

   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

   Copy to Clipboard Toggle word wrap

   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 ~]$ source stackrc

   Copy to Clipboard Toggle word wrap

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 heat-admin \
   --static-yaml-inventory /home/stack/tripleo-inventory.yaml

   Copy to Clipboard Toggle word wrap

5. Create a backup of the control plane nodes:

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

   Copy to Clipboard Toggle word wrap

   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

   Copy to Clipboard Toggle word wrap

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"}'

     Copy to Clipboard Toggle word wrap

   • 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"}'

     Copy to Clipboard Toggle word wrap

   • 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"}

     Copy to Clipboard Toggle word wrap