Swift backup driver¶
The backup driver for the swift back end performs a volume backup to an object storage system.
To enable the swift backup driver, include the following option in the
cinder.conf file:
backup_driver = cinder.backup.drivers.swift
The following configuration options are available for the Swift back-end backup driver.
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
backup_swift_auth = per_user |
(String) Swift authentication mechanism |
backup_swift_auth_version = 1 |
(String) Swift authentication version. Specify “1” for auth 1.0, or “2” for auth 2.0 or “3” for auth 3.0 |
backup_swift_block_size = 32768 |
(Integer) The size in bytes that changes are tracked for incremental backups. backup_swift_object_size has to be multiple of backup_swift_block_size. |
backup_swift_ca_cert_file = None |
(String) Location of the CA certificate file to use for swift client requests. |
backup_swift_container = volumebackups |
(String) The default Swift container to use |
backup_swift_enable_progress_timer = True |
(Boolean) Enable or Disable the timer to send the periodic progress notifications to Ceilometer when backing up the volume to the Swift backend storage. The default value is True to enable the timer. |
backup_swift_key = None |
(String) Swift key for authentication |
backup_swift_object_size = 52428800 |
(Integer) The size in bytes of Swift backup objects |
backup_swift_project = None |
(String) Swift project/account name. Required when connecting to an auth 3.0 system |
backup_swift_project_domain = None |
(String) Swift project domain name. Required when connecting to an auth 3.0 system |
backup_swift_retry_attempts = 3 |
(Integer) The number of retries to make for Swift operations |
backup_swift_retry_backoff = 2 |
(Integer) The backoff time in seconds between Swift retries |
backup_swift_tenant = None |
(String) Swift tenant/account name. Required when connecting to an auth 2.0 system |
backup_swift_url = None |
(URI) The URL of the Swift endpoint |
backup_swift_user = None |
(String) Swift user name |
backup_swift_user_domain = None |
(String) Swift user domain name. Required when connecting to an auth 3.0 system |
keystone_catalog_info = identity:Identity Service:publicURL |
(String) Info to match when looking for keystone in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:<endpoint_type> - Only used if backup_swift_auth_url is unset |
swift_catalog_info = object-store:swift:publicURL |
(String) Info to match when looking for swift in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:<endpoint_type> - Only used if backup_swift_url is unset |
To enable the swift backup driver for 1.0, 2.0, or 3.0 authentication version,
specify 1, 2, or 3 correspondingly. For example:
backup_swift_auth_version = 2
In addition, the 2.0 authentication system requires the definition of the
backup_swift_tenant setting:
backup_swift_tenant = <None>
This example shows the default options for the Swift back-end backup driver.
backup_swift_url = http://localhost:8080/v1/AUTH_
backup_swift_auth_url = http://localhost:5000/v3
backup_swift_auth = per_user
backup_swift_auth_version = 1
backup_swift_user = <None>
backup_swift_user_domain = <None>
backup_swift_key = <None>
backup_swift_container = volumebackups
backup_swift_object_size = 52428800
backup_swift_project = <None>
backup_swift_project_domain = <None>
backup_swift_retry_attempts = 3
backup_swift_retry_backoff = 2
backup_compression_algorithm = zlib
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.