openstack-manuals/doc/common/tables/trove-db_mongodb.xml
Gauvain Pocentek 923f00d123 [config-ref] Trove option tables update
Change-Id: Id7b596cd5ada75e2de8d70ee7c54dab4dd5eef3c
2015-07-19 17:22:57 +02:00

95 lines
4.5 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_trove_db_mongodb">
<caption>Description of MongoDB 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">[mongodb]</th>
</tr>
<tr>
<td><option>api_strategy</option> = <replaceable>trove.common.strategies.cluster.experimental.mongodb.api.MongoDbAPIStrategy</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.mongo_impl</replaceable></td>
<td>(StrOpt) Namespace to load backup strategies from.</td>
</tr>
<tr>
<td><option>backup_strategy</option> = <replaceable>MongoDump</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>configsvr_port</option> = <replaceable>27019</replaceable></td>
<td>(IntOpt) Port for instances running as config servers.</td>
</tr>
<tr>
<td><option>device_path</option> = <replaceable>/dev/vdb</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.mongodb.guestagent.MongoDbGuestAgentStrategy</replaceable></td>
<td>(StrOpt) Class that implements datastore-specific Guest Agent API logic.</td>
</tr>
<tr>
<td><option>mongodb_port</option> = <replaceable>27017</replaceable></td>
<td>(IntOpt) Port for mongod and mongos instances.</td>
</tr>
<tr>
<td><option>mount_point</option> = <replaceable>/var/lib/mongodb</replaceable></td>
<td>(StrOpt) Filesystem path for mounting volumes if volume support is enabled.</td>
</tr>
<tr>
<td><option>num_config_servers_per_cluster</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) The number of config servers to create per cluster.</td>
</tr>
<tr>
<td><option>num_query_routers_per_cluster</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) The number of query routers (mongos) to create per cluster.</td>
</tr>
<tr>
<td><option>replication_strategy</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Default strategy for replication.</td>
</tr>
<tr>
<td><option>restore_namespace</option> = <replaceable>trove.guestagent.strategies.restore.experimental.mongo_impl</replaceable></td>
<td>(StrOpt) Namespace to load restore strategies from.</td>
</tr>
<tr>
<td><option>taskmanager_strategy</option> = <replaceable>trove.common.strategies.cluster.experimental.mongodb.taskmanager.MongoDbTaskManagerStrategy</replaceable></td>
<td>(StrOpt) Class that implements datastore-specific task manager logic.</td>
</tr>
<tr>
<td><option>tcp_ports</option> = <replaceable>2500, 27017</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 UPD 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>