cinder/doc/source/configuration/tables/cinder-backups_posix.rst
Jay S. Bryant 0395353c4b Move config-reference to configuration
It was discovered today that the 'config-reference' directory
was supposed to have been renamed to 'configuration'.  The doc
team was expecting it to be at that location so that they could
automatically link to it from contributor/index.html .

This patch just moves the directory.  I am going to be submitting
a subsequent patch that properly sets out the framework for the
additional directories so that we don't have addition problems
in the future.

Change-Id: I6729aaf4593a0b089277f6d7d0aa50fee3ca340f
2017-07-18 13:10:25 -05:00

31 lines
1.6 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_posix:
.. list-table:: Description of POSIX backup driver configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[DEFAULT]**
-
* - ``backup_container`` = ``None``
- (String) Custom directory to use for backups.
* - ``backup_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 backend storage. The default value is True to enable the timer.
* - ``backup_file_size`` = ``1999994880``
- (Integer) The maximum size in bytes of the files used to hold backups. If the volume being backed up exceeds this size, then it will be backed up into multiple files.backup_file_size must be a multiple of backup_sha_block_size_bytes.
* - ``backup_posix_path`` = ``$state_path/backup``
- (String) Path specifying where to store backups.
* - ``backup_sha_block_size_bytes`` = ``32768``
- (Integer) The size in bytes that changes are tracked for incremental backups. backup_file_size has to be multiple of backup_sha_block_size_bytes.