Chapter 2. Block Storage backup service deployment

The Block Storage backup service is optional. It is not installed by default so you must add it to your overcloud deployment


  • An existing Red Hat OpenStack Platform (RHOSP) installation.
  • An available storage source with a compatible backup driver: Object Storage (swift; default), Ceph, NFS, or Google Cloud storage.

Google Cloud Storage requires additional configuration. For more information, see Appendix A, Google Cloud Storage configuration.

2.1. Configuring back end storage options for the backup service

To enable the backup service, complete the following steps.


  1. Create a copy of the cinder-backup.yaml file, which is located in the /usr/share/openstack-tripleo-heat-templates/environments/ directory, and store it in the same location as your other custom templates.

    cp /usr/share/openstack-tripleo-heat-templates/environments/cinder-backup.yaml /home/stack/templates/cinder-backup-settings.yaml
  2. Your copy of the cinder-backup.yaml file contains default settings that configure an OpenStack Object Storage (swift) back end for the Block Storage backup service with Pacemaker. If this is the back end you are using for your backup then you do not need to make changes to this file. If you are using an alternative back end, configure parameter_defaults depending on the backup back end:

    • If you are using Red Hat Ceph Storage, configure parameter_defaults in the following way:

      • CinderBackupBackend: (Required) ceph
      • CinderBackupRbdPoolName: (Optional) Set to a custom RBD pool name. Default: backups
    • If you are using NFS, configure parameter_defaults in the following way:

      • CinderBackupBackend: (Required) nfs
      • CinderBackupNfsShare: (Required) Set to the NFS share that you want to mount. The default value is empty.
      • CinderBackupNfsMountOptions: (Optional) Set to your required mount option.
  3. Save the changes to the file.
  4. To enable the backup service and apply this configuration, add your backup settings environment file to the stack with your other environment files and deploy the overcloud:

    (undercloud) [stack@undercloud ~]$ openstack overcloud deploy --templates \
      -e [your environment files]
      -e /home/stack/templates/cinder-backup-settings.yaml

For more information and additional configuration options, see Appendix A, Google Cloud Storage configuration.

2.2. Deploying the overcloud with your Google Cloud configuration

After you create the environment file in `/home/stack/templates/, deploy the overcloud then restart the cinder-backup service.


  1. Log in as the stack user.
  2. Deploy the configuration:

    $ openstack overcloud deploy --templates \
    -e /home/stack/templates/cinder-backup-settings.yaml

    If you passed any extra environment files when you created the overcloud, pass them again here using the -e option to avoid making undesired changes to the overcloud.

  3. Restart the cinder-backup service after the deployment finishes.

For more information, see the Including environment files in an overcloud deployment in the Director Installation and Usage guide and Environment Files in the Advanced Overcloud Customization guide.