openstack-manuals/doc/common/tables/trove-db_mongodb.xml

87 lines
3.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_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>api_strategy = trove.common.strategies.mongodb.api.MongoDbAPIStrategy</td>
<td>(StrOpt) Class that implements datastore-specific API logic.</td>
</tr>
<tr>
<td>backup_incremental_strategy = {}</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>backup_namespace = None</td>
<td>(StrOpt) Namespace to load backup strategies from.</td>
</tr>
<tr>
<td>backup_strategy = None</td>
<td>(StrOpt) Default strategy to perform backups.</td>
</tr>
<tr>
<td>cluster_support = True</td>
<td>(BoolOpt) Enable clusters to be created and managed.</td>
</tr>
<tr>
<td>device_path = /dev/vdb</td>
<td>(StrOpt) Device path for volume if volume support is enabled.</td>
</tr>
<tr>
<td>guestagent_strategy = trove.common.strategies.mongodb.guestagent.MongoDbGuestAgentStrategy</td>
<td>(StrOpt) Class that implements datastore-specific Guest Agent API logic.</td>
</tr>
<tr>
<td>mount_point = /var/lib/mongodb</td>
<td>(StrOpt) Filesystem path for mounting volumes if volume support is enabled.</td>
</tr>
<tr>
<td>num_config_servers_per_cluster = 3</td>
<td>(IntOpt) The number of config servers to create per cluster.</td>
</tr>
<tr>
<td>num_query_routers_per_cluster = 1</td>
<td>(IntOpt) The number of query routers (mongos) to create per cluster.</td>
</tr>
<tr>
<td>replication_strategy = None</td>
<td>(StrOpt) Default strategy for replication.</td>
</tr>
<tr>
<td>restore_namespace = None</td>
<td>(StrOpt) Namespace to load restore strategies from.</td>
</tr>
<tr>
<td>taskmanager_strategy = trove.common.strategies.mongodb.taskmanager.MongoDbTaskManagerStrategy</td>
<td>(StrOpt) Class that implements datastore-specific task manager logic.</td>
</tr>
<tr>
<td>tcp_ports = 2500, 27017</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>udp_ports = </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>volume_support = True</td>
<td>(BoolOpt) Whether to provision a Cinder volume for datadir.</td>
</tr>
</tbody>
</table>
</para>