cinder/doc/source/config-reference/tables/cinder-backups_nfs.rst
Jay S. Bryant 1c0dac0199 Migrate configuration-reference to Cinder repo
The next patch in the documentation migration process brings over
the very popular configuration reference guide.  This required
moving the 'block-storage' section from config-reference in
openstack-manuals.  It also brings with it a number of supporting
tables.

With this patch in place it becomes imperative that we make sure
that any changes that touch config options also come with a patch
to this part of Cinder.

As with the other changes, this is intended to just make the
content accessible on the web again.  There are definitely
changes/improvements needed to make this integrate better
with out index page and to ensure the content is accurate.
Later patches will address those needs.

Change-Id: I05c243001e17f18c8b8e9aba91b4f3e2811bf023
2017-07-17 13:18:20 -05:00

1.8 KiB

Description of NFS backup driver configuration options
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_mount_options = None (String) Mount options passed to the NFS client. See NFS man page for details.
backup_mount_point_base = $state_path/backup_mount (String) Base dir containing mount point for NFS share.
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.
backup_share = None (String) NFS share in hostname:path, ipv4addr:path, or "[ipv6addr]:path" format.