openstack-manuals/doc/common/tables/cinder-backups_nfs.xml
Gauvain Pocentek 3c3362b947 Recategorize cinder NFS backup options
The new table will be integrated in
https://review.openstack.org/#/c/182817/

Change-Id: Ie2cc7c652f06064075cc68623438c45998b10701
2015-05-14 17:29:27 +02:00

51 lines
2.3 KiB
XML

<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_backups_nfs">
<caption>Description of NFS backup driver configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>backup_container</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Custom container to use for backups.</td>
</tr>
<tr>
<td><option>backup_enable_progress_timer</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) 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.</td>
</tr>
<tr>
<td><option>backup_file_size</option> = <replaceable>1999994880</replaceable></td>
<td>(IntOpt) 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.</td>
</tr>
<tr>
<td><option>backup_mount_options</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Mount options passed to the NFS client. See NFS man page for details.</td>
</tr>
<tr>
<td><option>backup_mount_point_base</option> = <replaceable>$state_path/backup_mount</replaceable></td>
<td>(StrOpt) Base dir containing mount point for NFS share.</td>
</tr>
<tr>
<td><option>backup_sha_block_size_bytes</option> = <replaceable>32768</replaceable></td>
<td>(IntOpt) The size in bytes that changes are tracked for incremental backups. backup_swift_object_size has to be multiple of backup_swift_block_size.</td>
</tr>
<tr>
<td><option>backup_share</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) NFS share in fqdn:path, ipv4addr:path, or "[ipv6addr]:path" format.</td>
</tr>
</tbody>
</table>
</para>