openstack-manuals/doc/common/tables/cinder-backups_swift.xml
Gauvain Pocentek 45dc683e91 Update config-ref tables against stable/kilo
Also update the swift tables.

Change-Id: I756c4323bd16b43b8df2bd31d77a42ac10a6e2e2
2015-04-28 17:14:33 +02:00

75 lines
3.4 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_swift">
<caption>Description of Swift 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_swift_auth</option> = <replaceable>per_user</replaceable></td>
<td>(StrOpt) Swift authentication mechanism</td>
</tr>
<tr>
<td><option>backup_swift_auth_version</option> = <replaceable>1</replaceable></td>
<td>(StrOpt) Swift authentication version. Specify "1" for auth 1.0, or "2" for auth 2.0</td>
</tr>
<tr>
<td><option>backup_swift_block_size</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_swift_container</option> = <replaceable>volumebackups</replaceable></td>
<td>(StrOpt) The default Swift container to use</td>
</tr>
<tr>
<td><option>backup_swift_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 Swift backend storage. The default value is True to enable the timer.</td>
</tr>
<tr>
<td><option>backup_swift_key</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Swift key for authentication</td>
</tr>
<tr>
<td><option>backup_swift_object_size</option> = <replaceable>52428800</replaceable></td>
<td>(IntOpt) The size in bytes of Swift backup objects</td>
</tr>
<tr>
<td><option>backup_swift_retry_attempts</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) The number of retries to make for Swift operations</td>
</tr>
<tr>
<td><option>backup_swift_retry_backoff</option> = <replaceable>2</replaceable></td>
<td>(IntOpt) The backoff time in seconds between Swift retries</td>
</tr>
<tr>
<td><option>backup_swift_tenant</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Swift tenant/account name. Required when connecting to an auth 2.0 system</td>
</tr>
<tr>
<td><option>backup_swift_url</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The URL of the Swift endpoint</td>
</tr>
<tr>
<td><option>backup_swift_user</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Swift user name</td>
</tr>
<tr>
<td><option>swift_catalog_info</option> = <replaceable>object-store:swift:publicURL</replaceable></td>
<td>(StrOpt) Info to match when looking for swift in the service catalog. Format is: separated values of the form: &lt;service_type&gt;:&lt;service_name&gt;:&lt;endpoint_type&gt; - Only used if backup_swift_url is unset</td>
</tr>
</tbody>
</table>
</para>