Chapter 2. Deploying the Block Storage backup service

Procedure

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

2. Source the stackrc undercloud credentials file:

   $ source ~/stackrc

3. Add this environment file to the stack with your other environment files: /usr/share/openstack-tripleo-heat-templates/environments/cinder-backup-active-active.yaml

   This file deploys the Block Storage backup service in active-active mode and sets all the heat template parameters of this service to their default settings. The default settings configure your backup repository to use the Object Storage (swift) back end and the zlib data compression algorithm.

   If the default configuration meets your deployment requirements, then you do not need to do anything further and you can deploy the overcloud.

4. If you need to use another back end for your backup repository or to change other default values:

   1. Add these parameters and their new values to the parameter_defaults section of either a new or existing environment file. For more information about the parameters that you can change, see Changing the default Block Storage backup service parameter values.

      For example, a new environment file /home/stack/templates/custom_backup_environment_file.yaml specifies an NFS back end and changes the data compression algorithm to zstd:

      parameter_defaults:
        CinderBackupBackend: nfs
        CinderBackupNfsShare: 192.168.1.1:/var/export/cinder-backup
        CinderBackupCompressionAlgorithm: zstd

   2. Add the environment file that contains your specific parameter values to the stack with your other environment files, after the /usr/share/openstack-tripleo-heat-templates/environments/cinder-backup-active-active.yaml file and deploy the overcloud. In this example:

      $ openstack overcloud deploy --templates
      -e [your other environment files]
      -e /usr/share/openstack-tripleo-heat-templates/environments/cinder-backup-active-active.yaml
      -e /home/stack/templates/custom_backup_environment_file.yaml

Procedure

1. Select and configure the back end for your backup repository. For more information, see Backup repository back-end configuration.
2. Implement the Block Storage backup service configuration supported by your selected back end. For more information, see Block Storage backup service configuration.