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

125 lines
6.0 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_pxc">
<caption>Description of Percona XtraDB Cluster 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">[pxc]</th>
</tr>
<tr>
<td><option>api_strategy</option> = <replaceable>trove.common.strategies.cluster.experimental.pxc.api.PXCAPIStrategy</replaceable></td>
<td>(StrOpt) Class that implements datastore-specific API logic.</td>
</tr>
<tr>
<td><option>backup_incremental_strategy</option> = <replaceable>{'InnoBackupEx': 'InnoBackupExIncremental'}</replaceable></td>
<td>(DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental backup, the runner will use the default full backup.</td>
</tr>
<tr>
<td><option>backup_namespace</option> = <replaceable>trove.guestagent.strategies.backup.mysql_impl</replaceable></td>
<td>(StrOpt) Namespace to load backup strategies from.</td>
</tr>
<tr>
<td><option>backup_strategy</option> = <replaceable>InnoBackupEx</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>/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.pxc.guestagent.PXCGuestAgentStrategy</replaceable></td>
<td>(StrOpt) Class that implements datastore-specific Guest Agent API logic.</td>
</tr>
<tr>
<td><option>ignore_users</option> = <replaceable>os_admin, root, clusterrepuser</replaceable></td>
<td>(ListOpt) Users to exclude when listing users.</td>
</tr>
<tr>
<td><option>min_cluster_member_count</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) Minimum number of members in PXC cluster.</td>
</tr>
<tr>
<td><option>mount_point</option> = <replaceable>/var/lib/mysql</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.mysql_gtid</replaceable></td>
<td>(StrOpt) Namespace to load replication strategies from.</td>
</tr>
<tr>
<td><option>replication_strategy</option> = <replaceable>MysqlGTIDReplication</replaceable></td>
<td>(StrOpt) Default strategy for replication.</td>
</tr>
<tr>
<td><option>replication_user</option> = <replaceable>slave_user</replaceable></td>
<td>(StrOpt) Userid for replication slave.</td>
</tr>
<tr>
<td><option>restore_namespace</option> = <replaceable>trove.guestagent.strategies.restore.mysql_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 pxc.</td>
</tr>
<tr>
<td><option>root_on_create</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the 'password' field.</td>
</tr>
<tr>
<td><option>taskmanager_strategy</option> = <replaceable>trove.common.strategies.cluster.experimental.pxc.taskmanager.PXCTaskManagerStrategy</replaceable></td>
<td>(StrOpt) Class that implements datastore-specific task manager logic.</td>
</tr>
<tr>
<td><option>tcp_ports</option> = <replaceable>3306, 4444, 4567, 4568</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>usage_timeout</option> = <replaceable>450</replaceable></td>
<td>(IntOpt) Maximum time (in seconds) to wait for a Guest to become active.</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>