Red Hat Summit Red Hat SummitSupportConsoleDéveloppeursCommencer un essaiContact

Ce contenu n'est pas disponible dans la langue sélectionnée.

Chapter 3. Using the Block Storage backup service

You can use the Block Storage backup service to perform full or incremental backups, to protect your backups, and to restore a backup to a volume.

3.1. Creating backups
Copier lien

Create a backup of your Block Storage volume to protect your data from being lost if the volume fails. For more information, see Creating a full volume backup. You can also create a backup directly from a snapshot of a volume. For more information, see Creating a full snapshot backup. In addition to the volume data, a backup also stores the volume metadata, such as the name and description.

If you have enabled data compression for your backup repository then your backups will be compressed, which can reduce their performance.

Full backups are easier to manage but they can become resource intensive when the size of the volume increases over time. With incremental backups, you can capture periodic changes to volumes and minimize resource usage. For more information, see Incremental backups.

You can create backups of volumes that you have access to. Project administrators can back up any volume belonging to the project. These backups are hidden from the volume owners unless the administrator provides additional arguments when creating the backup. For more information, see Backup arguments to authenticate volume owners.

Each project (tenant) limits the maximum number of backups and the maximum total size of all backups that can be created for it. As a project administrator, you can view and change these quotas. For more information, see Viewing and modifying project backup quotas.

Normally you can only backup a volume that has an available status but, if you need to, you can backup a volume with an in-use status. For more information, see Creating a backup of an in-use volume.

When you create a backup of a Block Storage volume, the metadata for this backup is stored in the Block Storage service database, which is used when restoring this volume. To ensure that a backup survives a catastrophic loss of the Block Storage service database, a project administrator can manually export and store the metadata of this backup. For more information, see Protecting your backups.

3.1.1. Creating a full volume backup
Copier lien

You can create one or more full backups of a volume.

Prerequisites

  • Only volume owners and project administrators can backup volumes.
  • Your backup repository must have the necessary space.
  • The backup quotas specified for your project have not been exceeded. For more information, see Viewing and modifying project backup quotas.

Procedure

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

  2. Source the stackrc undercloud credentials file: 

    $ source ~/stackrc
    Copy to Clipboard Toggle word wrap

  3. List the volumes to obtain the ID or name of the volume you want to back up: 

    $ openstack volume list
    Copy to Clipboard Toggle word wrap
    Note

    Usually you can only backup a volume that has an available status but, if you need to, you can backup a volume with an in-use status. For more information, see Creating a backup of an in-use volume.

  4. Back up the volume:

    Note

    If you are the project administrator and not the volume owner, then to make this backup accessible by the volume owner, you need to provide additional parameters when creating this backup. For more information, see Backup arguments to authenticate volume owners. 

    $ openstack volume backup create [--name <backup_name>] <volume>
    Copy to Clipboard Toggle word wrap
    • Replace <volume> with the ID or name of the volume you want to back up.

    • Optional: replace <backup_name> with the name of this backup.

      This command immediately provides the ID of this backup but the volume is backed up asynchronously, in the background. For example: 

      $ openstack volume backup create --name vol1bu2 vol_1
+-------+--------------------------------------+
| Field | Value                                |
+-------+--------------------------------------+
| id    | 83dadc43-2aa9-4c0b-bc05-a12203a8f4cb |
| name  | vol1bu2                              |
+-------+--------------------------------------+
      Copy to Clipboard Toggle word wrap

Verification

  • List the backups: 

    $ openstack volume backup list
    Copy to Clipboard Toggle word wrap

    The volume backup is created when this backup has an available status. For example: 

    +--------------------------------------+---------+-------------+-----------+------+
| ID                                   | Name    | Description | Status    | Size |
+--------------------------------------+---------+-------------+-----------+------+
| 83dadc43-2aa9-4c0b-bc05-a12203a8f4cb | vol1bu2 | None        | available |    1 |
| b604a932-94a5-468e-bf6b-841ac16f69a8 | None    | None        | available |    1 |
+--------------------------------------+---------+-------------+-----------+------+
    Copy to Clipboard Toggle word wrap

Additional resources

3.1.2. Creating a full snapshot backup
Copier lien

You can create a full backup from a snapshot by using the ID of the volume associated with the snapshot.

The backup is created by directly attaching to the snapshot, which is faster than cloning the snapshot into a volume and then backing up this volume. But this feature can affect the backup performance because of the extra step of creating the volume from a snapshot.

Prerequisites:

Procedure

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

  2. Source the stackrc undercloud credentials file: 

    $ source ~/stackrc
    Copy to Clipboard Toggle word wrap

  3. List the snapshots to obtain the name or ID of the snapshot you want to backup: 

    $ openstack volume snapshot list
    Copy to Clipboard Toggle word wrap

  4. List the details of this snapshot to obtain the ID of the volume associated with this snapshot: 

    $ openstack volume snapshot show <snapshot>
    Copy to Clipboard Toggle word wrap

    • Replace <snapshot> with the name or ID of the snapshot you want to backup.

      The value of the volume_id field is the ID of the volume associated with this snapshot. For example: 

      $ openstack volume snapshot show snap_1
+--------------------------------------------+--------------------------------------+
| Field                                      | Value                                |
+--------------------------------------------+--------------------------------------+
| created_at                                 | 2023-07-18T08:14:16.000000           |
| description                                | None                                 |
| id                                         | 2d95b707-6657-49af-ac8f-f9a7417d4650 |
| name                                       | snap_1                               |
| os-extended-snapshot-attributes:progress   | 100%                                 |
| os-extended-snapshot-attributes:project_id | c2c1da89ed1648fc8b4f35a045f8d34c     |
| properties                                 |                                      |
| size                                       | 1                                    |
| status                                     | available                            |
| updated_at                                 | 2023-07-18T08:14:17.000000           |
| volume_id                                  | 6841e3d1-8a1a-4496-bc51-f7c04b787e8f |
+--------------------------------------------+--------------------------------------+
      Copy to Clipboard Toggle word wrap

  5. Backup the snapshot: 

    $ openstack volume backup create [--name <backup_name>] --snapshot <snapshot> <volume_id>
    Copy to Clipboard Toggle word wrap
    • Replace <volume_id> with the ID of the volume associated with this snapshot.

    • Optional: replace <backup_name> with the name of this backup.

      This command immediately provides the ID of this backup but the snapshot is backed up asynchronously, in the background. For example: 

      $ openstack volume backup create --name snap1bu1 --snapshot snap_1 6841e3d1-8a1a-4496-bc51-f7c04b787e8f
+-------+--------------------------------------+
| Field | Value                                |
+-------+--------------------------------------+
| id    | 867e6cfb-9be7-47fa-8a79-221b0e80c757 |
| name  | snap1bu1                             |
+-------+--------------------------------------+
      Copy to Clipboard Toggle word wrap

Verification

  • List the backups: 

    $ openstack volume backup list
    Copy to Clipboard Toggle word wrap

    The snapshot backup is created when this backup has an available status. For example: 

    +--------------------------------------+------------+-------------+-----------+------+
| ID                                   | Name       | Description | Status    | Size |
+--------------------------------------+------------+-------------+-----------+------+
| 867e6cfb-9be7-47fa-8a79-221b0e80c757 | snap1bu1    | None        | available |    1 |
+--------------------------------------+------------+-------------+-----------+------+
    Copy to Clipboard Toggle word wrap

3.1.3. Creating a backup of an in-use volume
Copier lien

Usually you can only backup a volume that has an available status. But you can use the --force option when creating a backup, to back up a volume that has an in-use status.

When you use the --force volume backup option, you create a crash-consistent, but not an application-consistent, backup because the volume is not quiesced before performing the backup. Therefore, the data is intact but the backup does not have an awareness of which applications were running when the backup was performed.

Prerequisites

  • Only volume owners and project administrators can backup volumes.
  • Your backup repository must have the necessary space.
  • The backup quotas specified for your project have not been exceeded. For more information, see Viewing and modifying project backup quotas.

Procedure

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

  2. Source the stackrc undercloud credentials file: 

    $ source ~/stackrc
    Copy to Clipboard Toggle word wrap

  3. List the volumes to obtain the ID or name of the volume you want to back up: 

    $ openstack volume list
    Copy to Clipboard Toggle word wrap

    For example: 

    +--------------------------------------+----------------+-----------+------+--------------------------------+
| ID                                   | Name           | Status    | Size | Attached to                    |
+--------------------------------------+----------------+-----------+------+--------------------------------+
| 6841e3d1-8a1a-4496-bc51-f7c04b787e8f | vol_1          | available |    1 |                                |
| 92800cf6-82ae-448a-a2bb-872fa4d98099 | Pansible_vol_2 | in-use    |    1 | Attached to inst1 on /dev/vdc  |
+--------------------------------------+----------------+-----------+------+--------------------------------+
    Copy to Clipboard Toggle word wrap

  4. Force the back up, if the volume that you want to backup has an in-use status: 

    $ openstack volume backup create [--name <backup_name>] --force <volume>
    Copy to Clipboard Toggle word wrap
    • Replace <volume> with the ID or name of the volume you want to back up.

    • Optional: replace <backup_name> with the name of this backup.

      This command immediately provides the ID of this backup but the volume is backed up asynchronously, in the background. For example: 

      $ openstack volume backup create --name panvol2bu1 --force Pansible_vol_2
+-------+--------------------------------------+
| Field | Value                                |
+-------+--------------------------------------+
| id    | 8c72bbf3-eb8e-4459-83e9-c7654ebe6343 |
| name  | panvol2bu1                           |
+-------+--------------------------------------+
      Copy to Clipboard Toggle word wrap

Verification

  • List the backups: 

    $ openstack volume backup list
    Copy to Clipboard Toggle word wrap

    The volume backup is created when this backup has an available status. For example: 

    +--------------------------------------+------------+-------------+-----------+------+
| ID                                   | Name       | Description | Status    | Size |
+--------------------------------------+------------+-------------+-----------+------+
| 8c72bbf3-eb8e-4459-83e9-c7654ebe6343 | panvol2bu1    | None        | available |    1 |
+--------------------------------------+------------+-------------+-----------+------+
    Copy to Clipboard Toggle word wrap

Additional resources

3.1.4. Incremental backups
Copier lien

If a volume has at least one full backup, you can use the Block Storage backup service to create an incremental backup. For more information, see Creating an incremental backup.

Full backups are easier to manage but they can become resource intensive when the size of the volume increases over time. With incremental backups, you can capture periodic changes to volumes and minimize your resource usage.

An incremental backup only stores the changes made to the volume since the last full or incremental backup.

Incremental backups increase the administrative overhead required for managing your backups. For instance, you cannot delete a full backup if it already has one or more incremental backups, you can only delete the latest incremental backup.

Incremental backups have a lower performance than full backups: When you create an incremental backup, all of the data in the volume must first be read and compared with the data in both the full backup and each subsequent incremental backup.

3.1.4.1. Creating an incremental backup
Copier lien

You can create an incremental backup to only store the changes made to the volume since the last full or incremental backup.

Prerequisites:

Procedure

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

  2. Source the stackrc undercloud credentials file: 

    $ source ~/stackrc
    Copy to Clipboard Toggle word wrap

  3. List the volumes to obtain the ID or name of the volume you want to back up: 

    $ openstack volume list
    Copy to Clipboard Toggle word wrap

  4. Back up the volume and use the --incremental option: 

    $ openstack volume backup create --incremental [--name <backup_name>] <volume>
    Copy to Clipboard Toggle word wrap
    • Replace <volume> with the ID or name of the volume you want to back up.

    • Optional: replace <backup_name> with the name of this backup.

      This command immediately provides the ID of this backup but the volume is backed up asynchronously, in the background. For example: 

      $ openstack volume backup create --name vol3incbu1 --incremental vol_3
+-------+--------------------------------------+
| Field | Value                                |
+-------+--------------------------------------+
| id    | f1681313-b5ed-4520-9b63-5b533f7cdc11 |
| name  | vol3incbu1                           |
+-------+--------------------------------------+
      Copy to Clipboard Toggle word wrap

Verification

  • List the backups: 

    $ openstack volume backup list
    Copy to Clipboard Toggle word wrap

    The volume backup is created when this backup has an available status. For example: 

    +--------------------------------------+---------+-------------+-----------+------+
| ID                                   | Name    | Description | Status    | Size |
+--------------------------------------+---------+-------------+-----------+------+
| f1681313-b5ed-4520-9b63-5b533f7cdc11 | vol3incbu1 | None        | available |    1 |
| f0e9ba67-67e1-4c2c-96ce-221df75bf2c2 | vol3bu1    | None        | available |    1 |
+--------------------------------------+---------+-------------+-----------+------+
    Copy to Clipboard Toggle word wrap

Additional resources

3.1.5. Backup performance considerations
Copier lien

Some features of the Block Storage backup service like incremental backups and data compression can reduce the performance of the backups.

By only capturing the periodic changes to volumes, incremental backups can minimize your resource usage. For more information, see Incremental backups. But incremental backups have a lower performance than full backups: When you create an incremental backup, all of the data in the volume must first be read and compared with the data in both the full backup and each subsequent incremental backup.

You can also create a backup from a snapshot by directly attaching to it, which is faster than cloning the snapshot into a volume. For more information, see Creating a full snapshot backup. But this feature can affect the backup performance because of the extra step of creating the volume from a snapshot.

Enabling data compression of your backup repository requires additional CPU power but uses less network bandwidth and storage space overall. You can configure the Block Storage backup service to enable or disable data compression of your backup repository. For more information, see Block Storage backup service configuration.

Note

You cannot use data compression with the Red Hat Ceph Storage back end.

3.1.6. Backup arguments to authenticate volume owners
Copier lien

Project administrators can back up any volume belonging to the project, but these backups are hidden from the volume owners.

To ensure that the volume owner can also access the volume backup, the project administrator must provide the following additional arguments to authenticate as the volume owner when backing up the volume: 

$ openstack --os-auth-url <keystoneurl> --os-project-name <projectname> --os-username <username> --os-password <password> volume backup create [--name <backup_name>] <volume>
Copy to Clipboard Toggle word wrap
  • Replace <keystoneurl> with the URL endpoint of the Identity service, which is typically http://IP:5000/v3, where IP is the IP address of the Identity service host.
  • Replace <projectname> with the name of the project (tenant) of the owner of the volume.
  • Replace <username> and <password> with the username and password credentials of the user that is the owner of the volume within this project.
Note

[--name <backup_name>] <volume> are the typical arguments when creating a volume backup.

3.1.7. Viewing and modifying project backup quotas
Copier lien

A project administrator can change or view the maximum number of backups and the maximum total size of all backups, in gigabytes, that can be created for a specific project (tenant) and see the usage of these backup quotas for this project.

Prerequisites

  • You must be a project administrator to view or modify the backup quotas of a project.

Procedure

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

  2. Source the stackrc undercloud credentials file: 

    $ source ~/stackrc
    Copy to Clipboard Toggle word wrap

  3. List the projects to obtain the ID or name of the required project: 

    $ openstack project list
    Copy to Clipboard Toggle word wrap

  4. View the backup quotas for a specific project: 

    $ openstack quota show <project>
    Copy to Clipboard Toggle word wrap
    • Replace <project> with the ID or name of the required project.

    The value of the backup-gigabytes field in the table is the maximum total size of all backups that can be created in this project. The value of the backups field in the table is the maximum number of backups that can be created in this project. For example:

    + 

    $ openstack quota show c2c1da89ed1648fc8b4f35a045f8d34c
+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Field                 | Value                                                                                                                                                                                               |
+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| backup-gigabytes      | 1000                                                                                                                                                                                                |
| backups               | 10
    Copy to Clipboard Toggle word wrap

  5. Modify the maximum total size of all backups created for a project: 

    $ openstack quota set --backup-gigabytes <maxgb> <project>
    Copy to Clipboard Toggle word wrap
    • Replace <maxgb> with the maximum total size, in gigabytes, of the backups that can be created for this project.

  6. Modify the maximum number of backups that can be created for a project: 

    $ openstack quota set --backups <maxnum> <project>
    Copy to Clipboard Toggle word wrap
    • Replace <maxnum> with the maximum number of backups that can be created for this project.

  7. View the usage of these backup quotas for a specific project: 

    $ cinder quota-usage <project_id>
    Copy to Clipboard Toggle word wrap

    • Replace <project_id> with the ID of the project.

      For example: 

      $ cinder quota-usage c2c1da89ed1648fc8b4f35a045f8d34c
+-----------------------+--------+----------+-------+-----------+
| Type                  | In_use | Reserved | Limit | Allocated |
+-----------------------+--------+----------+-------+-----------+
| backup_gigabytes      | 7      | 0        | 1000   |           |
| backups               | 7      | 0        | 10    |           |
| gigabytes             | 6      | 0        | 1000  |           |
| gigabytes_multiattach | 0      | 0        | -1    |           |
| gigabytes_tripleo     | 6      | 0        | -1    |           |
| groups                | 0      | 0        | 10    |           |
| per_volume_gigabytes  | 0      | 0        | -1    |           |
| snapshots             | 1      | 0        | 10    |           |
| snapshots_multiattach | 0      | 0        | -1    |           |
| snapshots_tripleo     | 1      | 0        | -1    |           |
| volumes               | 5      | 0        | 10    |           |
| volumes_multiattach   | 0      | 0        | -1    |           |
| volumes_tripleo       | 5      | 0        | -1    |           |
+-----------------------+--------+----------+-------+-----------+
      Copy to Clipboard Toggle word wrap

Verification

  • If you have changed either of these quotas then review these changes: 

    $ openstack quota show <project>
    Copy to Clipboard Toggle word wrap

    Ensure that the modified values are specified by the backup-gigabytes and backups fields in the table. For example: 

    +-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Field                 | Value                                                                                                                                                                                               |
+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| backup-gigabytes      | 500                                                                                                                                                                                                 |
| backups               | 12
    Copy to Clipboard Toggle word wrap

3.1.8. Canceling a backup
Copier lien

You must request a force delete on the backup to cancel it.

Important

You cannot cancel backups if you use the Red Hat Ceph Storage back end for your backup repository.

Procedure

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

  2. Source the stackrc undercloud credentials file: 

    $ source ~/stackrc
    Copy to Clipboard Toggle word wrap

  3. List the backups to obtain the ID or name of the backup you want to cancel: 

    $ openstack volume backup list
    Copy to Clipboard Toggle word wrap

  4. Cancel the backup: 

    # openstack volume backup delete --force <backup>
    Copy to Clipboard Toggle word wrap

    • Replace <backup> with the ID or name of the volume backup that you want to cancel.

      There can be a slight delay for the backup to be successfully canceled.

Verification

  • The backup is canceled when the backup record is not listed by this command: 

    $ openstack volume backup show <backup>
    Copy to Clipboard Toggle word wrap

3.2. Backing up and restoring across edge sites
Copier lien

You can back up and restore Block Storage service (cinder) volumes across distributed compute node (DCN) architectures in edge site and availability zones. The cinder-backup service runs in the central availability zone (AZ), and backups are stored in the central AZ. The Block Storage service does not store backups at DCN sites.

Prerequisites

  • Deploy the optional Block Storage backup service. For more information, see Block Storage backup service deployment in Backing up Block Storage volumes.
  • Block Storage (cinder) REST API microversion 3.51 or later.
  • All sites must use a common openstack cephx client name. For more information, see Creating a Ceph key for external access in Deploying a Distributed Compute Node (DCN) architecture.

Procedure

  1. Create a backup of a volume in the first DCN site: 

    $ cinder --os-volume-api-version 3.51 backup-create --name <volume_backup> --availability-zone <az_central> <edge_volume>
    Copy to Clipboard Toggle word wrap
    • Replace <volume_backup> with a name for the volume backup.
    • Replace <az_central> with the name of the central availability zone that hosts the cinder-backup service.

    • Replace <edge_volume> with the name of the volume that you want to back up.

      Note

      If you experience issues with Ceph keyrings, you might need to restart the cinder-backup container so that the keyrings copy from the host to the container successfully.

  2. Restore the backup to a new volume in the second DCN site: 

    $ cinder --os-volume-api-version 3.51 create --availability-zone <az_2> --name <new_volume> --backup-id <volume_backup> <volume_size>
    Copy to Clipboard Toggle word wrap
    • Replace <az_2> with the name of the availability zone where you want to restore the backup.
    • Replace <new_volume> with a name for the new volume.
    • Replace <volume_backup> with the name of the volume backup that you created in the previous step.
    • Replace <volume_size> with a value in GB equal to or greater than the size of the original volume.

3.3. Protecting your backups
Copier lien

When you create a backup of a Block Storage volume, the metadata for this backup is stored in the Block Storage service database, which is used to restore this volume. To ensure that a backup survives a catastrophic loss of the Block Storage service database, a project administrator can manually export and store the metadata of this backup in a safe location, such as an offsite backup. For more information, see Exporting backup metadata.

When the Block Storage service database experiences a catastrophic loss you cannot restore any of your backups because this database contains the backup metadata used when restoring backups. But if a project administrator manually exported and saved the metadata of a backup, then the project administrator can import this metadata into the new Block Storage database, so that you can use this backup to restore the volume. For more information see Importing backup metadata.

Note

For incremental backups, you must import the metadata of all the preceding backups before you can use it to restore the volume.

3.3.1. Exporting backup metadata
Copier lien

A project administrator can export the metadata of a backup and store it in a file so that you can restore the volume backup even if the Block Storage database suffers a catastrophic loss. For more information, see Protecting your backups.

Note

For an incremental backup, you must export the metadata of all the preceding backups.

Prerequisites

  • You must be a project administrator to export the backup metadata.

Procedure

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

  2. Source the stackrc undercloud credentials file: 

    $ source ~/stackrc
    Copy to Clipboard Toggle word wrap

  3. List the backups to obtain the ID or name of the backup: 

    $ openstack volume backup list
    Copy to Clipboard Toggle word wrap

  4. Export the metadata of the backup and store it in an appropriately named YAML file: 

    $ openstack volume backup record export -f yaml <backup> > <filename>.yaml
    Copy to Clipboard Toggle word wrap
    • Replace <backup> with the ID or name of the volume backup.

    • Replace <filename> with the name of the YAML file to save the exported backup_service and backup_url values for this backup.

      For example: 

      $ openstack volume backup record export -f yaml vol1bu2 > vol1bu2.yaml
      Copy to Clipboard Toggle word wrap
  5. Copy the file to a safe location, such as an offsite backup.

Verification

  • Edit the file to see that the values of the backup_service and backup_url, match the values provided by this command: 

    $ openstack volume backup record export -f yaml <backup>
    Copy to Clipboard Toggle word wrap

    For example: 

    $ openstack volume backup record export -f yaml vol1bu2
backup_service: cinder.backup.drivers.ceph.CephBackupDriver
backup_url: eyJkcml2 … YWxzZX0=
    Copy to Clipboard Toggle word wrap

3.3.2. Importing backup metadata
Copier lien

If a project administrator has exported and saved the metadata of a volume backup, then after a catastrophic loss of the Block Storage service database, the project administrator can import this metadata, so that you can use this backup.

You can also use this procedure to recreate a backup that was deleted.

Note

For incremental backups, you must also import the metadata of all the preceding backups.

Prerequisites

  • You must be a project administrator to import the volume backup metadata to a Block Storage database.
  • You must provide the backup_service and backup_url metadata values of this backup. For more information see Exporting backup metadata.
  • A Block Storage database that does not already contain this backup.

Procedure

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

  2. Source the stackrc undercloud credentials file: 

    $ source ~/stackrc
    Copy to Clipboard Toggle word wrap
  3. Locate the file in which you stored the exported backup_service and backup_url metadata values of this backup.

  4. Import the metadata values of this volume backup to the Block Storage database: 

    $ openstack volume backup record import <backup_service> <backup_url>
    Copy to Clipboard Toggle word wrap
    • Replace <backup_service> with the backup_service metadata value of this volume backup.

    • Replace <backup_url> with the backup_url metadata value of this volume backup.

      This command provides the name and the ID of this backup. For example: 

      $ openstack volume backup record import cinder.backup.drivers.ceph.CephBackupDriver eyJkcml2 … YWxzZX0=
+-------+--------------------------------------+
| Field | Value                                |
+-------+--------------------------------------+
| id    | 83dadc43-2aa9-4c0b-bc05-a12203a8f4cb |
| name  | vol1bu2                              |
+-------+--------------------------------------+
      Copy to Clipboard Toggle word wrap

Next steps

3.4. Restoring backups
Copier lien

After you create a Block Storage volume backup, you can restore this backed up data if needed.

You can use one of the following methods to restore your backups:

Important

When the Block Storage service database experiences a catastrophic loss you cannot restore any of your backups, unless you have exported and saved their metadata. For more information see Protecting your backups.

Only project administrators can cancel restoring a volume backup. For more information, see Canceling restoring a backup.

3.4.1. Restoring a backup to a specific volume
Copier lien

You can restore a volume backup to an available volume that you have already created.

If you restore a volume from an encrypted backup, then the destination volume type must also be encrypted.

Procedure

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

  2. Source the stackrc undercloud credentials file: 

    $ source ~/stackrc
    Copy to Clipboard Toggle word wrap

  3. List the backups to obtain the name or ID of the backup you want to restore: 

    $ openstack volume backup list
    Copy to Clipboard Toggle word wrap

    For example: 

    +--------------------------------------+---------+-------------+-----------+------+
| ID                                   | Name    | Description | Status    | Size |
+--------------------------------------+---------+-------------+-----------+------+
| 83dadc43-2aa9-4c0b-bc05-a12203a8f4cb | vol1bu2 | None        | available |    1 |
    Copy to Clipboard Toggle word wrap

  4. List the volumes: 

    $ openstack volume list
    Copy to Clipboard Toggle word wrap

    Ensure that the status of the required volume is available and then obtain the name or ID of this volume. For example: 

    +--------------------------------------+----------------+-----------+------+--------------------------------+
| ID                                   | Name           | Status    | Size | Attached to                    |
+--------------------------------------+----------------+-----------+------+--------------------------------+
| 654e2be8-bc79-4528-96a7-5f773d31c201 | vol_3          | available |    1 |                                |
    Copy to Clipboard Toggle word wrap

  5. Restore the backup to the volume: 

    $ openstack volume backup restore <backup> <volume>
    Copy to Clipboard Toggle word wrap
    • Replace <backup> with the name or ID of the Block Storage volume backup.

    • Replace <volume> with the name or ID of the available Block Storage volume.

      For example: 

      $ openstack volume backup restore vol1bu2 vol_3
+-------------+--------------------------------------+
| Field       | Value                                |
+-------------+--------------------------------------+
| backup_id   | 83dadc43-2aa9-4c0b-bc05-a12203a8f4cb |
| volume_id   | 654e2be8-bc79-4528-96a7-5f773d31c201 |
| volume_name | vol_3                                |
+-------------+--------------------------------------+
      Copy to Clipboard Toggle word wrap
  6. Verify that the backup_id provided by this command corresponds to the ID of the backup that was restored and that the volume_name and volume_id values correspond to the name and ID of the specified volume.

  7. Delete the backup if you no longer need it: 

    $ openstack volume backup delete <backup>
    Copy to Clipboard Toggle word wrap

3.4.2. Restoring a backup to a new volume
Copier lien

You can create a new volume when you restore a backup of a Block Storage volume.

Procedure

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

  2. Source the stackrc undercloud credentials file: 

    $ source ~/stackrc
    Copy to Clipboard Toggle word wrap

  3. List the backups to obtain the name or ID of the backup you want to restore: 

    $ openstack volume backup list
    Copy to Clipboard Toggle word wrap

    For example: 

    +--------------------------------------+---------+-------------+-----------+------+
| ID                                   | Name    | Description | Status    | Size |
+--------------------------------------+---------+-------------+-----------+------+
| 83dadc43-2aa9-4c0b-bc05-a12203a8f4cb | vol1bu2 | None        | available |    1 |
    Copy to Clipboard Toggle word wrap

  4. Restore the backup to a new volume: 

    $ cinder backup-restore <backup>
    Copy to Clipboard Toggle word wrap

    • Replace <backup> with the name or ID of the Block Storage volume backup.

      For example: 

      $ cinder backup-restore vol1bu2
+-------------+-----------------------------------------------------+
| Property    | Value                                               |
+-------------+-----------------------------------------------------+
| backup_id   | 83dadc43-2aa9-4c0b-bc05-a12203a8f4cb                |
| volume_id   | 296c853c-c749-4eb6-857a-57ec182232a6                |
| volume_name | restore_backup_83dadc43-2aa9-4c0b-bc05-a12203a8f4cb |
+-------------+-----------------------------------------------------+
      Copy to Clipboard Toggle word wrap

  5. Verify that the backup_id provided by this command corresponds to the ID of the backup that was restored.

    The volume_id value is the ID of the created volume. But the volume_name can be a temporary name that is replaced with the name of the backed up volume.

  6. List the volumes to verify that the volume with an ID of volume_id has been created and to obtain this volume name: 

    $ openstack volume list
    Copy to Clipboard Toggle word wrap

    For example: 

    +--------------------------------------+----------------+-----------+------+--------------------------------+
| ID                                   | Name           | Status    | Size | Attached to                    |
+--------------------------------------+----------------+-----------+------+--------------------------------+
| 296c853c-c749-4eb6-857a-57ec182232a6 | vol_1          | available |    1 |                                |
    Copy to Clipboard Toggle word wrap

  7. Delete the backup if you no longer need it: 

    $ openstack volume backup delete <backup>
    Copy to Clipboard Toggle word wrap

3.4.3. Canceling restoring a backup
Copier lien

A project administrator can cancel restoring a volume backup by changing the status of the backup to error. But you cannot cancel restoring a backup when Red Hat Ceph Storage is the back end of the backup repository.

Warning

If you cancel restoring a backup after it starts, the destination volume is useless, because there is no way of knowing how much data, if any, was actually restored.

Prerequisites

  • You must be a project administrator to cancel restoring a volume backup.
  • Ensure that the back end of your backup repository is not Red Hat Ceph Storage.

Procedure

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

  2. Source the stackrc undercloud credentials file: 

    $ source ~/stackrc
    Copy to Clipboard Toggle word wrap

  3. List the backups to obtain the name or ID of the backup that you want to stop restoring: 

    $ openstack volume backup list
    Copy to Clipboard Toggle word wrap

  4. Change the status of this backup to error to cancel its restore operation: 

    $ openstack volume backup set --state error <backup>
    Copy to Clipboard Toggle word wrap
    • Replace <backup> with the name or ID of the volume backup that you do not want to restore.

    Canceling a restore is an asynchronous action, because the back end of the backup repository must detect the change in the backup status before it cancels the restore.

Verification

  • List the volume backups to verify that the restore is canceled: 

    $ openstack volume backup list
    Copy to Clipboard Toggle word wrap

    When the status of the backup changes to available, then the restore is canceled.

Retour au début
Red Hat logoGithubredditYoutubeTwitter

Apprendre

Essayez, achetez et vendez

Communautés

À propos de la documentation Red Hat

Nous aidons les utilisateurs de Red Hat à innover et à atteindre leurs objectifs grâce à nos produits et services avec un contenu auquel ils peuvent faire confiance. Découvrez nos récentes mises à jour.

Rendre l’open source plus inclusif

Red Hat s'engage à remplacer le langage problématique dans notre code, notre documentation et nos propriétés Web. Pour plus de détails, consultez le Blog Red Hat.

À propos de Red Hat

Nous proposons des solutions renforcées qui facilitent le travail des entreprises sur plusieurs plates-formes et environnements, du centre de données central à la périphérie du réseau.

Theme

© 2025 Red Hat