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

105 lines
4.9 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_db_redis">
<caption>Description of Redis database 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">[redis]</th>
</tr>
<tr>
<td><option>api_strategy</option> = <replaceable>trove.common.strategies.cluster.experimental.redis.api.RedisAPIStrategy</replaceable></td>
<td>(StrOpt) Class that implements datastore-specific API logic.</td>
</tr>
<tr>
<td><option>backup_incremental_strategy</option> = <replaceable>{}</replaceable></td>
<td>(DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup.</td>
</tr>
<tr>
<td><option>backup_namespace</option> = <replaceable>trove.guestagent.strategies.backup.experimental.redis_impl</replaceable></td>
<td>(StrOpt) Namespace to load backup strategies from.</td>
</tr>
<tr>
<td><option>backup_strategy</option> = <replaceable>RedisBackup</replaceable></td>
<td>(StrOpt) Default strategy to perform backups.</td>
</tr>
<tr>
<td><option>cluster_support</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Enable clusters to be created and managed.</td>
</tr>
<tr>
<td><option>device_path</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Device path for volume if volume support is enabled.</td>
</tr>
<tr>
<td><option>guestagent_strategy</option> = <replaceable>trove.common.strategies.cluster.experimental.redis.guestagent.RedisGuestAgentStrategy</replaceable></td>
<td>(StrOpt) Class that implements datastore-specific Guest Agent API logic.</td>
</tr>
<tr>
<td><option>mount_point</option> = <replaceable>/var/lib/redis</replaceable></td>
<td>(StrOpt) Filesystem path for mounting volumes if volume support is enabled.</td>
</tr>
<tr>
<td><option>replication_namespace</option> = <replaceable>trove.guestagent.strategies.replication.experimental.redis_sync</replaceable></td>
<td>(StrOpt) Namespace to load replication strategies from.</td>
</tr>
<tr>
<td><option>replication_strategy</option> = <replaceable>RedisSyncReplication</replaceable></td>
<td>(StrOpt) Default strategy for replication.</td>
</tr>
<tr>
<td><option>restore_namespace</option> = <replaceable>trove.guestagent.strategies.restore.experimental.redis_impl</replaceable></td>
<td>(StrOpt) Namespace to load restore strategies from.</td>
</tr>
<tr>
<td><option>root_controller</option> = <replaceable>trove.extensions.common.service.DefaultRootController</replaceable></td>
<td>(StrOpt) Root controller implementation for redis.</td>
</tr>
<tr>
<td><option>taskmanager_strategy</option> = <replaceable>trove.common.strategies.cluster.experimental.redis.taskmanager.RedisTaskManagerStrategy</replaceable></td>
<td>(StrOpt) Class that implements datastore-specific task manager logic.</td>
</tr>
<tr>
<td><option>tcp_ports</option> = <replaceable>6379, 16379</replaceable></td>
<td>(ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).</td>
</tr>
<tr>
<td><option>udp_ports</option> = <replaceable></replaceable></td>
<td>(ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).</td>
</tr>
<tr>
<td><option>volume_support</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Whether to provision a Cinder volume for datadir.</td>
</tr>
</tbody>
</table>
</para>