openstack-manuals/doc/common/tables/trove-backup.xml
Gauvain Pocentek e7cbc675ce update the config reference tables for liberty
Change-Id: I959cc6884633ada1deb55f44ca1fc6f230bdebd9
2015-10-29 07:45:04 +01:00

81 lines
3.3 KiB
XML

<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
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.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_trove_backup">
<caption>Description of backup 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_aes_cbc_key</option> = <replaceable>default_aes_cbc_key</replaceable></td>
<td>(StrOpt) Default OpenSSL aes_cbc key.</td>
</tr>
<tr>
<td><option>backup_chunk_size</option> = <replaceable>65536</replaceable></td>
<td>(IntOpt) Chunk size (in bytes) to stream to the Swift container. This should be in multiples of 128 bytes, since this is the size of an md5 digest block allowing the process to update the file checksum during streaming. See: http://stackoverflow.com/questions/1131220/</td>
</tr>
<tr>
<td><option>backup_runner</option> = <replaceable>trove.guestagent.backup.backup_types.InnoBackupEx</replaceable></td>
<td>(StrOpt) Runner to use for backups.</td>
</tr>
<tr>
<td><option>backup_runner_options</option> = <replaceable>{}</replaceable></td>
<td>(DictOpt) Additional options to be passed to the backup runner.</td>
</tr>
<tr>
<td><option>backup_segment_max_size</option> = <replaceable>2147483648</replaceable></td>
<td>(IntOpt) Maximum size (in bytes) of each segment of the backup file.</td>
</tr>
<tr>
<td><option>backup_swift_container</option> = <replaceable>database_backups</replaceable></td>
<td>(StrOpt) Swift container to put backups in.</td>
</tr>
<tr>
<td><option>backup_use_gzip_compression</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Compress backups using gzip.</td>
</tr>
<tr>
<td><option>backup_use_openssl_encryption</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Encrypt backups using OpenSSL.</td>
</tr>
<tr>
<td><option>backup_use_snet</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Send backup files over snet.</td>
</tr>
<tr>
<td><option>backups_page_size</option> = <replaceable>20</replaceable></td>
<td>(IntOpt) Page size for listing backups.</td>
</tr>
</tbody>
</table>
</para>