openstack-manuals/doc/config-ref-rst/source/tables/cinder-backups.rst
KATO Tomoyuki ce094c144b [config-ref] Add table labels
Change-Id: If4e4b6fccb77092ef5939100960ebf278f0e5bf9
2015-11-23 10:57:54 +09:00

47 lines
2.3 KiB
ReStructuredText

..
Warning: Do not edit this file. It is automatically generated from the
software project's code and your changes will be overwritten.
The tool to generate this file lives in openstack-doc-tools repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools repository, or
ask for help on the documentation mailing list, IRC channel or meeting.
.. _cinder-backups:
.. list-table:: Description of backups configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[DEFAULT]**
-
* - ``backup_api_class`` = ``cinder.backup.api.API``
- (StrOpt) The full class name of the volume backup API class
* - ``backup_compression_algorithm`` = ``zlib``
- (StrOpt) Compression algorithm (None to disable)
* - ``backup_driver`` = ``cinder.backup.drivers.swift``
- (StrOpt) Driver to use for backups.
* - ``backup_manager`` = ``cinder.backup.manager.BackupManager``
- (StrOpt) Full class name for the Manager for volume backup
* - ``backup_metadata_version`` = ``2``
- (IntOpt) Backup metadata version to be used when backing up volume metadata. If this number is bumped, make sure the service doing the restore supports the new version.
* - ``backup_name_template`` = ``backup-%s``
- (StrOpt) Template string to be used to generate backup names
* - ``backup_object_number_per_notification`` = ``10``
- (IntOpt) The number of chunks or objects, for which one Ceilometer notification will be sent
* - ``backup_posix_path`` = ``$state_path/backup``
- (StrOpt) Path specifying where to store backups.
* - ``backup_service_inithost_offload`` = ``False``
- (BoolOpt) Offload pending backup delete during backup service startup.
* - ``backup_timer_interval`` = ``120``
- (IntOpt) Interval, in seconds, between two progress notifications reporting the backup status
* - ``backup_topic`` = ``cinder-backup``
- (StrOpt) The topic that volume backup nodes listen on
* - ``snapshot_name_template`` = ``snapshot-%s``
- (StrOpt) Template string to be used to generate snapshot names
* - ``snapshot_same_host`` = ``True``
- (BoolOpt) Create volume from snapshot at the host where snapshot resides