Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 2. Block Storage backup service deployment

The Block Storage backup service is optional. It is not installed by default and must be added to the overcloud deployment.

To deploy the backup service, you need:

  • A new or existing OpenStack installation
  • An available storage source with a compatible backup driver: Object Storage (swift), Red Hat Ceph Storage, or NFS.

The examples in this section assume that you are deploying the back end service in a standard OpenStack environment that uses the default Pacemaker installation.

2.1. Configuring backend options
Copy link

The backup service is enabled by including the cinder-backup.yaml environment file in the /usr/share/openstack-tripleo-heat-templates/environments/ directory.

The default settings in this file configure a swift back end for the Block Storage backup service with Pacemaker.

Procedure

Create a custom environment file, for example cinder-backup-settings.yaml, that contains the parameter settings for the backup service and configuration options for the driver:

  1. Create a copy of the cinder-backup.yaml file and store it in the same location as other custom templates. 

    cp /usr/share/openstack-tripleo-heat-templates/environments/cinder-backup.yaml /home/stack/templates/cinder-backup-settings.yaml
    Copy to Clipboard Toggle word wrap
  2. Modify the appropriate options for the backup back end that you are using (see instructions in the sections below).
  3. Save the changes to the file.

2.1.1. Object storage (swift)
Copy link

Swift is the default value for the CinderBackupBackend option. If you are using swift, no additional changes are required.

Example

resource_registry:
  OS::TripleO::Services::CinderBackup: /usr/share/openstack-tripleo-heat-templates/docker/services/pacemaker/cinder-backup.yaml
  # For non-pcmk managed implementation
  # OS::TripleO::Services::CinderBackup: /usr/share/openstack-tripleo-heat-templates/docker/services/cinder-backup.yaml

parameter_defaults:
  CinderBackupBackend: swift
Copy to Clipboard Toggle word wrap

Expand
SettingOptionsValues

CinderBackupBackend

swift (default)

Swift is the default selection in the cinder-backup.yaml template.

2.1.2. Red Hat Ceph Storage
Copy link

If you are using Red Hat Ceph Storage as a backup back end, then you may change the RBD pool name used for the backup. The default value is backups.

Example

resource_registry:
  OS::TripleO::Services::CinderBackup: /usr/share/openstack-tripleo-heat-templates/docker/services/pacemaker/cinder-backup.yaml
  # For non-pcmk managed implementation
  # OS::TripleO::Services::CinderBackup: /usr/share/openstack-tripleo-heat-templates/docker/services/cinder-backup.yaml

parameter_defaults:
  CinderBackupBackend: ceph
  CinderBackupRbdPoolName: backups
Copy to Clipboard Toggle word wrap

Expand
SettingOptionsValues

CinderBackupBackend

ceph

Required. Change the value to ceph.

CinderBackupRbdPoolName

backups (default name)

Optional. No other settings must be updated unless you are using a custom RBD pool name.

2.1.3. NFS
Copy link

To use NFS as a back end for the backup service, you must provide the NFS share to be mounted.

Example

resource_registry:
  OS::TripleO::Services::CinderBackup: /usr/share/openstack-tripleo-heat-templates/docker/services/pacemaker/cinder-backup.yaml
  # For non-pcmk managed implementation
  # OS::TripleO::Services::CinderBackup: /usr/share/openstack-tripleo-heat-templates/docker/services/cinder-backup.yaml

parameter_defaults:
  CinderBackupBackend: nfs
  CinderBackupNfsShare: '192.168.122.1:/export/cinder/backups'
  CinderBackupNfsMountOptions: ''
Copy to Clipboard Toggle word wrap

Expand
SettingOptionsValues

CinderBackupBackend

nfs

Required. Set nfs as the value.

CinderBackupNfsShare

 

Required. Enter the NFS share to be mounted. Default value is empty.

CinderBackupNfsMountOptions

 

Optional. Backup NFS mount options can be left blank. If you must specify mount options, include them here.

2.2. Deploying the Block Storage backup service
Copy link

After you create the environment file in /home/stack/templates/, log in as the stack user and deploy the configuration by running: 

$ openstack overcloud deploy --templates \
-e /home/stack/templates/cinder-backup-settings.yaml
Copy to Clipboard Toggle word wrap
Important

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.

For more information, see the Including Environment Files in Overcloud Creation in the Director Installation and Usage Guide and the Environment Files section of the Advanced Overcloud Customization Guide.

Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2026 Red HatBack to top