openstack/openstack-manuals
Code Issues Proposed changes

Merge "Update Config Reference for trove"

Browse Source
This commit is contained in:
Jenkins 2015-10-14 08:54:41 +00:00 committed by Gerrit Code Review
commit c868f7889c
23 changed files with 402 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/common/tables/trove-amqp.xml
View File

@ -34,7 +34,7 @@
<td>(MultiStrOpt) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop</td>
</tr>
<tr>
<td><option>notification_service_id</option> = <replaceable>{'vertica': 'a8d805ae-a3b2-c4fd-gb23-b62cee5201ae', 'db2': 'e040cd37-263d-4869-aaa6-c62aa97523b5', 'percona': 'fd1723f5-68d2-409c-994f-a4a197892a17', 'postgresql': 'ac277e0d-4f21-40aa-b347-1ea31e571720', 'mysql': '2f3ff068-2bfb-4f70-9a9d-a6bb65bc084b', 'couchbase': 'fa62fe68-74d9-4779-a24e-36f19602c415', 'mongodb': 'c8c907af-7375-456f-b929-b637ff9209ee', 'couchdb': 'f0a9ab7b-66f7-4352-93d7-071521d44c7c', 'redis': 'b216ffc5-1947-456c-a4cf-70f94c05f7d0', 'cassandra': '459a230d-4e97-4344-9067-2a54a310b0ed'}</replaceable></td>
<td><option>notification_service_id</option> = <replaceable>{'mongodb': 'c8c907af-7375-456f-b929-b637ff9209ee', 'percona': 'fd1723f5-68d2-409c-994f-a4a197892a17', 'mysql': '2f3ff068-2bfb-4f70-9a9d-a6bb65bc084b', 'pxc': '75a628c3-f81b-4ffb-b10a-4087c26bc854', 'db2': 'e040cd37-263d-4869-aaa6-c62aa97523b5', 'cassandra': '459a230d-4e97-4344-9067-2a54a310b0ed', 'mariadb': '7a4f82cc-10d2-4bc6-aadc-d9aacc2a3cb5', 'postgresql': 'ac277e0d-4f21-40aa-b347-1ea31e571720', 'couchbase': 'fa62fe68-74d9-4779-a24e-36f19602c415', 'couchdb': 'f0a9ab7b-66f7-4352-93d7-071521d44c7c', 'redis': 'b216ffc5-1947-456c-a4cf-70f94c05f7d0', 'vertica': 'a8d805ae-a3b2-c4fd-gb23-b62cee5201ae'}</replaceable></td>
<td>(DictOpt) Unique ID to tag notification events.</td>
</tr>
<tr>

4
doc/common/tables/trove-auth_token.xml
View File

@ -149,6 +149,10 @@
<td><option>memcache_use_advanced_pool</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x.</td>
</tr>
<tr>
<td><option>region_name</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The region in which the identity server can be found.</td>
</tr>
<tr>
<td><option>revocation_cache_time</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.</td>

2
doc/common/tables/trove-cluster.xml
View File

@ -22,7 +22,7 @@
<td>(IntOpt) Maximum time (in seconds) to wait for a cluster delete.</td>
</tr>
<tr>
<td><option>cluster_usage_timeout</option> = <replaceable>675</replaceable></td>
<td><option>cluster_usage_timeout</option> = <replaceable>36000</replaceable></td>
<td>(IntOpt) Maximum time (in seconds) to wait for a cluster to become active.</td>
</tr>
<tr>

6
doc/common/tables/trove-common.xml
View File

@ -70,7 +70,11 @@
<td>(StrOpt) Path which leads to datastore templates.</td>
</tr>
<tr>
<td><option>usage_timeout</option> = <replaceable>600</replaceable></td>
<td><option>timeout_wait_for_service</option> = <replaceable>120</replaceable></td>
<td>(IntOpt) Maximum time (in seconds) to wait for a service to become alive.</td>
</tr>
<tr>
<td><option>usage_timeout</option> = <replaceable>900</replaceable></td>
<td>(IntOpt) Maximum time (in seconds) to wait for a Guest to become active.</td>
</tr>
<tr>

8
doc/common/tables/trove-db_couchbase.xml
View File

@ -45,6 +45,10 @@
<td><option>restore_namespace</option> = <replaceable>trove.guestagent.strategies.restore.experimental.couchbase_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 couchbase.</td>
</tr>
<tr>
<td><option>root_on_create</option> = <replaceable>True</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>
@ -92,6 +96,10 @@
<td><option>restore_namespace</option> = <replaceable>None</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 couchdb.</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>

4
doc/common/tables/trove-db_db2.xml
View File

@ -49,6 +49,10 @@
<td><option>restore_namespace</option> = <replaceable>None</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 db2.</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>

78
doc/common/tables/trove-db_mariadb.xml Normal file
View File

@ -0,0 +1,78 @@
<?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_mariadb">
<caption>Description of MariaDB 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">[mariadb]</th>
</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>device_path</option> = <replaceable>/dev/vdb</replaceable></td>
<td>(StrOpt) Device path for volume if volume support is enabled.</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_binlog</replaceable></td>
<td>(StrOpt) Namespace to load replication strategies from.</td>
</tr>
<tr>
<td><option>replication_strategy</option> = <replaceable>MysqlBinlogReplication</replaceable></td>
<td>(StrOpt) Default strategy for replication.</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 mysql.</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>tcp_ports</option> = <replaceable>3306</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>400</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>

10
doc/common/tables/trove-db_mongodb.xml
View File

@ -17,6 +17,10 @@
<tr>
<th colspan="2">[mongodb]</th>
</tr>
<tr>
<td><option>add_members_timeout</option> = <replaceable>300</replaceable></td>
<td>(IntOpt) Maximum time to wait (in seconds) for a replica set initialization process to complete.</td>
</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>
@ -81,6 +85,10 @@
<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>root_controller</option> = <replaceable>trove.extensions.common.service.DefaultRootController</replaceable></td>
<td>(StrOpt) Root controller implementation for mongodb.</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>
@ -91,7 +99,7 @@
</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>
<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>

4
doc/common/tables/trove-db_mysql.xml
View File

@ -49,6 +49,10 @@
<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 mysql.</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>

4
doc/common/tables/trove-db_percona.xml
View File

@ -57,6 +57,10 @@
<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 percona.</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>

6
doc/common/tables/trove-db_postgresql.xml
View File

@ -49,6 +49,10 @@
<td><option>restore_namespace</option> = <replaceable>trove.guestagent.strategies.restore.experimental.postgresql_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 postgresql.</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>
@ -59,7 +63,7 @@
</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>
<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>

106
doc/common/tables/trove-db_pxc.xml Normal file
View File

@ -0,0 +1,106 @@
<?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_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>

36
doc/common/tables/trove-db_redis.xml
View File

@ -17,36 +17,60 @@
<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>None</replaceable></td>
<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>None</replaceable></td>
<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_strategy</option> = <replaceable>None</replaceable></td>
<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>None</replaceable></td>
<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>tcp_ports</option> = <replaceable>6379</replaceable></td>
<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>
@ -54,7 +78,7 @@
<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>False</replaceable></td>
<td><option>volume_support</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Whether to provision a Cinder volume for datadir.</td>
</tr>
</tbody>

4
doc/common/tables/trove-db_vertica.xml
View File

@ -65,6 +65,10 @@
<td><option>restore_namespace</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Namespace to load restore strategies from.</td>
</tr>
<tr>
<td><option>root_controller</option> = <replaceable>trove.extensions.vertica.service.VerticaRootController</replaceable></td>
<td>(StrOpt) Root controller implementation for Vertica.</td>
</tr>
<tr>
<td><option>taskmanager_strategy</option> = <replaceable>trove.common.strategies.cluster.experimental.vertica.taskmanager.VerticaTaskManagerStrategy</replaceable></td>
<td>(StrOpt) Class that implements datastore-specific task manager logic.</td>

2
doc/common/tables/trove-guestagent.xml
View File

@ -50,7 +50,7 @@
<td>(StrOpt) The guest info filename found in the injected config location. If a full path is specified then it will be used as the path to the guest info file</td>
</tr>
<tr>
<td><option>ignore_dbs</option> = <replaceable>lost+found, #mysql50#lost+found, mysql, information_schema</replaceable></td>
<td><option>ignore_dbs</option> = <replaceable>mysql, information_schema, performance_schema</replaceable></td>
<td>(ListOpt) Databases to exclude when listing databases.</td>
</tr>
<tr>

24
doc/common/tables/trove-logging.xml
View File

@ -23,7 +23,7 @@
</tr>
<tr>
<td><option>default_log_levels</option> = <replaceable>amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN, taskflow=WARN</replaceable></td>
<td>(ListOpt) List of logger=LEVEL pairs.</td>
<td>(ListOpt) List of logger=LEVEL pairs. This option is ignored if log_config_append is set.</td>
</tr>
<tr>
<td><option>fatal_deprecations</option> = <replaceable>False</replaceable></td>
@ -43,23 +43,23 @@
</tr>
<tr>
<td><option>log_config_append</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation.</td>
<td>(StrOpt) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log_format).</td>
</tr>
<tr>
<td><option>log_date_format</option> = <replaceable>%Y-%m-%d %H:%M:%S</replaceable></td>
<td>(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s .</td>
<td>(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set.</td>
</tr>
<tr>
<td><option>log_dir</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) (Optional) The base directory used for relative --log-file paths.</td>
<td>(StrOpt) (Optional) The base directory used for relative --log-file paths. This option is ignored if log_config_append is set.</td>
</tr>
<tr>
<td><option>log_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.</td>
<td>(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. This option is ignored if log_config_append is set.</td>
</tr>
<tr>
<td><option>log_format</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.</td>
<td>(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. This option is ignored if log_config_append is set.</td>
</tr>
<tr>
<td><option>logging_context_format_string</option> = <replaceable>%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s</replaceable></td>
@ -87,24 +87,28 @@
</tr>
<tr>
<td><option>syslog_log_facility</option> = <replaceable>LOG_USER</replaceable></td>
<td>(StrOpt) Syslog facility to receive log lines.</td>
<td>(StrOpt) Syslog facility to receive log lines. This option is ignored if log_config_append is set.</td>
</tr>
<tr>
<td><option>use_stderr</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Log output to standard error.</td>
<td>(BoolOpt) Log output to standard error. This option is ignored if log_config_append is set.</td>
</tr>
<tr>
<td><option>use_syslog</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424.</td>
<td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set.</td>
</tr>
<tr>
<td><option>use_syslog_rfc_format</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in Kilo, and will be removed in Mitaka, along with this option.</td>
<td>(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in Kilo, and will be removed in Mitaka, along with this option. This option is ignored if log_config_append is set.</td>
</tr>
<tr>
<td><option>verbose</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) If set to false, will disable INFO logging level, making WARNING the default.</td>
</tr>
<tr>
<td><option>watch_log_file</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) (Optional) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log-file option is specified and Linux platform is used. This option is ignored if log_config_append is set.</td>
</tr>
</tbody>
</table>
</para>

4
doc/common/tables/trove-nova.xml
View File

@ -25,6 +25,10 @@
<td><option>nova_proxy_admin_tenant_id</option> = <replaceable></replaceable></td>
<td>(StrOpt) Admin tenant ID used to connect to Nova.</td>
</tr>
<tr>
<td><option>nova_proxy_admin_tenant_name</option> = <replaceable></replaceable></td>
<td>(StrOpt) Admin tenant name used to connect to Nova.</td>
</tr>
<tr>
<td><option>nova_proxy_admin_user</option> = <replaceable></replaceable></td>
<td>(StrOpt) Admin username used to connect to Nova.</td>

22
doc/common/tables/trove-redis.xml
View File

@ -15,14 +15,10 @@
</thead>
<tbody>
<tr>
<th colspan="2">[matchmaker_redis]</th>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>host</option> = <replaceable>127.0.0.1</replaceable></td>
<td>(StrOpt) Host to locate redis.</td>
</tr>
<tr>
<td><option>password</option> = <replaceable>None</replaceable></td>
<td><option>password</option> = <replaceable></replaceable></td>
<td>(StrOpt) Password for Redis server (optional).</td>
</tr>
<tr>
@ -30,11 +26,19 @@
<td>(IntOpt) Use this port to connect to redis host.</td>
</tr>
<tr>
<th colspan="2">[matchmaker_ring]</th>
<th colspan="2">[matchmaker_redis]</th>
</tr>
<tr>
<td><option>ringfile</option> = <replaceable>/etc/oslo/matchmaker_ring.json</replaceable></td>
<td>(StrOpt) Matchmaker ring file (JSON).</td>
<td><option>host</option> = <replaceable>127.0.0.1</replaceable></td>
<td>(StrOpt) Host to locate redis.</td>
</tr>
<tr>
<td><option>password</option> = <replaceable></replaceable></td>
<td>(StrOpt) Password for Redis server (optional).</td>
</tr>
<tr>
<td><option>port</option> = <replaceable>6379</replaceable></td>
<td>(IntOpt) Use this port to connect to redis host.</td>
</tr>
</tbody>
</table>

32
doc/common/tables/trove-rpc.xml
View File

@ -17,14 +17,6 @@
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>matchmaker_heartbeat_freq</option> = <replaceable>300</replaceable></td>
<td>(IntOpt) Heartbeat frequency.</td>
</tr>
<tr>
<td><option>matchmaker_heartbeat_ttl</option> = <replaceable>600</replaceable></td>
<td>(IntOpt) Heartbeat time-to-live.</td>
</tr>
<tr>
<td><option>num_tries</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) Number of times to check if a volume exists.</td>
@ -45,6 +37,10 @@
<td><option>rpc_conn_pool_size</option> = <replaceable>30</replaceable></td>
<td>(IntOpt) Size of RPC connection pool.</td>
</tr>
<tr>
<td><option>rpc_poll_timeout</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired.</td>
</tr>
<tr>
<td><option>rpc_response_timeout</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Seconds to wait for a response from a call.</td>
@ -83,6 +79,22 @@
<td><option>idle_timeout</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) Timeout for inactive connections (in seconds)</td>
</tr>
<tr>
<td><option>password</option> = <replaceable></replaceable></td>
<td>(StrOpt) Password for message broker authentication</td>
</tr>
<tr>
<td><option>sasl_config_dir</option> = <replaceable></replaceable></td>
<td>(StrOpt) Path to directory that contains the SASL configuration</td>
</tr>
<tr>
<td><option>sasl_config_name</option> = <replaceable></replaceable></td>
<td>(StrOpt) Name of configuration file (without .conf suffix)</td>
</tr>
<tr>
<td><option>sasl_mechanisms</option> = <replaceable></replaceable></td>
<td>(StrOpt) Space separated list of acceptable SASL mechanisms</td>
</tr>
<tr>
<td><option>server_request_prefix</option> = <replaceable>exclusive</replaceable></td>
<td>(StrOpt) address prefix used when sending to a specific server</td>
@ -107,6 +119,10 @@
<td><option>trace</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Debug: dump AMQP frames to stdout</td>
</tr>
<tr>
<td><option>username</option> = <replaceable></replaceable></td>
<td>(StrOpt) User name for message broker authentication</td>
</tr>
</tbody>
</table>
</para>

18
doc/common/tables/trove-zeromq.xml
View File

@ -17,10 +17,18 @@
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>rpc_zmq_all_req_rep</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT.</td>
</tr>
<tr>
<td><option>rpc_zmq_bind_address</option> = <replaceable>*</replaceable></td>
<td>(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address.</td>
</tr>
<tr>
<td><option>rpc_zmq_concurrency</option> = <replaceable>eventlet</replaceable></td>
<td>(StrOpt) Type of concurrency used. Either "native" or "eventlet"</td>
</tr>
<tr>
<td><option>rpc_zmq_contexts</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Number of ZeroMQ contexts, defaults to 1.</td>
@ -34,17 +42,17 @@
<td>(StrOpt) Directory for holding IPC sockets.</td>
</tr>
<tr>
<td><option>rpc_zmq_matchmaker</option> = <replaceable>local</replaceable></td>
<td><option>rpc_zmq_matchmaker</option> = <replaceable>redis</replaceable></td>
<td>(StrOpt) MatchMaker driver.</td>
</tr>
<tr>
<td><option>rpc_zmq_port</option> = <replaceable>9501</replaceable></td>
<td>(IntOpt) ZeroMQ receiver listening port.</td>
</tr>
<tr>
<td><option>rpc_zmq_topic_backlog</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited.</td>
</tr>
<tr>
<td><option>zmq_use_broker</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Shows whether zmq-messaging uses broker or not.</td>
</tr>
</tbody>
</table>
</para>

2
doc/config-reference/database-service/section-databaseservice-db.xml
View File

@ -12,8 +12,10 @@
<xi:include href="../../common/tables/trove-db_cassandra.xml"/>
<xi:include href="../../common/tables/trove-db_couchbase.xml"/>
<xi:include href="../../common/tables/trove-db_db2.xml"/>
<xi:include href="../../common/tables/trove-db_mariadb.xml"/>
<xi:include href="../../common/tables/trove-db_mongodb.xml"/>
<xi:include href="../../common/tables/trove-db_mysql.xml"/>
<xi:include href="../../common/tables/trove-db_pxc.xml"/>
<xi:include href="../../common/tables/trove-db_percona.xml"/>
<xi:include href="../../common/tables/trove-db_postgresql.xml"/>
<xi:include href="../../common/tables/trove-db_redis.xml"/>

70
tools/autogenerate-config-flagmappings/trove.flagmappings
View File

@ -93,8 +93,6 @@ logging_context_format_string logging
logging_debug_format_suffix logging
logging_default_format_string logging
logging_exception_prefix logging
matchmaker_heartbeat_freq rpc
matchmaker_heartbeat_ttl rpc
max_accepted_volume_size quota
max_backups_per_user quota
max_header_line api
@ -115,9 +113,12 @@ nova_compute_service_type compute
nova_compute_url compute
nova_proxy_admin_pass nova
nova_proxy_admin_tenant_id nova
nova_proxy_admin_tenant_name nova
nova_proxy_admin_user nova
num_tries rpc
os_region_name api
password redis
port redis
publish_errors logging
pybasedir common
pydev_debug debug
@ -143,13 +144,15 @@ root_grant_option compute
rpc_backend rpc
rpc_cast_timeout rpc
rpc_conn_pool_size rpc
rpc_poll_timeout rpc
rpc_response_timeout rpc
rpc_zmq_all_req_rep zeromq
rpc_zmq_bind_address zeromq
rpc_zmq_concurrency zeromq
rpc_zmq_contexts zeromq
rpc_zmq_host zeromq
rpc_zmq_ipc_dir zeromq
rpc_zmq_matchmaker zeromq
rpc_zmq_port zeromq
rpc_zmq_topic_backlog zeromq
server_delete_time_out taskmanager
sql_query_logging database
@ -163,6 +166,7 @@ syslog_log_facility logging
taskmanager_queue common
tcp_keepidle api
template_path common
timeout_wait_for_service common
transport_url amqp
trove_api_workers api
trove_auth_url api
@ -187,6 +191,8 @@ verify_swift_checksum_on_restore taskmanager
volume_format_timeout volume
volume_fstype volume
volume_time_out volume
watch_log_file logging
zmq_use_broker zeromq
cassandra/backup_incremental_strategy db_cassandra
cassandra/backup_namespace db_cassandra
cassandra/backup_strategy db_cassandra
@ -194,6 +200,7 @@ cassandra/device_path db_cassandra
cassandra/mount_point db_cassandra
cassandra/replication_strategy db_cassandra
cassandra/restore_namespace db_cassandra
cassandra/root_controller cassandra
cassandra/tcp_ports db_cassandra
cassandra/udp_ports db_cassandra
cassandra/volume_support db_cassandra
@ -204,6 +211,7 @@ couchbase/device_path db_couchbase
couchbase/mount_point db_couchbase
couchbase/replication_strategy db_couchbase
couchbase/restore_namespace db_couchbase
couchbase/root_controller db_couchbase
couchbase/root_on_create db_couchbase
couchbase/tcp_ports db_couchbase
couchbase/udp_ports db_couchbase
@ -215,6 +223,7 @@ couchdb/device_path db_couchbase
couchdb/mount_point db_couchbase
couchdb/replication_strategy db_couchbase
couchdb/restore_namespace db_couchbase
couchdb/root_controller db_couchbase
couchdb/root_on_create db_couchbase
couchdb/tcp_ports db_couchbase
couchdb/udp_ports db_couchbase
@ -230,6 +239,7 @@ db2/ignore_users db_db2
db2/mount_point db_db2
db2/replication_strategy db_db2
db2/restore_namespace db_db2
db2/root_controller db_db2
db2/root_on_create db_db2
db2/tcp_ports db_db2
db2/udp_ports db_db2
@ -268,13 +278,28 @@ keystone_authtoken/memcache_secret_key auth_token
keystone_authtoken/memcache_security_strategy auth_token
keystone_authtoken/memcache_use_advanced_pool auth_token
keystone_authtoken/memcached_servers common
keystone_authtoken/region_name auth_token
keystone_authtoken/revocation_cache_time auth_token
keystone_authtoken/signing_dir auth_token
keystone_authtoken/token_cache_time auth_token
mariadb/backup_incremental_strategy db_mariadb
mariadb/backup_namespace db_mariadb
mariadb/backup_strategy db_mariadb
mariadb/device_path db_mariadb
mariadb/mount_point db_mariadb
mariadb/replication_namespace db_mariadb
mariadb/replication_strategy db_mariadb
mariadb/restore_namespace db_mariadb
mariadb/root_controller db_mariadb
mariadb/root_on_create db_mariadb
mariadb/tcp_ports db_mariadb
mariadb/udp_ports db_mariadb
mariadb/usage_timeout db_mariadb
mariadb/volume_support db_mariadb
matchmaker_redis/host redis
matchmaker_redis/password redis
matchmaker_redis/port redis
matchmaker_ring/ringfile redis
mongodb/add_members_timeout db_mongodb
mongodb/api_strategy db_mongodb
mongodb/backup_incremental_strategy db_mongodb
mongodb/backup_namespace db_mongodb
@ -291,6 +316,7 @@ mongodb/num_config_servers_per_cluster db_mongodb
mongodb/num_query_routers_per_cluster db_mongodb
mongodb/replication_strategy db_mongodb
mongodb/restore_namespace db_mongodb
mongodb/root_controller db_mongodb
mongodb/taskmanager_strategy db_mongodb
mongodb/tcp_ports db_mongodb
mongodb/udp_ports db_mongodb
@ -303,6 +329,7 @@ mysql/mount_point db_mysql
mysql/replication_namespace db_mysql
mysql/replication_strategy db_mysql
mysql/restore_namespace db_mysql
mysql/root_controller db_mysql
mysql/root_on_create db_mysql
mysql/tcp_ports db_mysql
mysql/udp_ports db_mysql
@ -315,12 +342,17 @@ oslo_messaging_amqp/broadcast_prefix rpc
oslo_messaging_amqp/container_name rpc
oslo_messaging_amqp/group_request_prefix rpc
oslo_messaging_amqp/idle_timeout rpc
oslo_messaging_amqp/password rpc
oslo_messaging_amqp/sasl_config_dir rpc
oslo_messaging_amqp/sasl_config_name rpc
oslo_messaging_amqp/sasl_mechanisms rpc
oslo_messaging_amqp/server_request_prefix rpc
oslo_messaging_amqp/ssl_ca_file rpc
oslo_messaging_amqp/ssl_cert_file rpc
oslo_messaging_amqp/ssl_key_file rpc
oslo_messaging_amqp/ssl_key_password rpc
oslo_messaging_amqp/trace rpc
oslo_messaging_amqp/username rpc
oslo_messaging_qpid/amqp_auto_delete qpid
oslo_messaging_qpid/amqp_durable_queues qpid
oslo_messaging_qpid/qpid_heartbeat qpid
@ -369,6 +401,7 @@ percona/replication_password db_percona
percona/replication_strategy db_percona
percona/replication_user db_percona
percona/restore_namespace db_percona
percona/root_controller db_percona
percona/root_on_create db_percona
percona/tcp_ports db_percona
percona/udp_ports db_percona
@ -382,19 +415,47 @@ postgresql/ignore_dbs db_postgresql
postgresql/ignore_users db_postgresql
postgresql/mount_point db_postgresql
postgresql/restore_namespace db_postgresql
postgresql/root_controller db_postgresql
postgresql/root_on_create db_postgresql
postgresql/tcp_ports db_postgresql
postgresql/udp_ports db_postgresql
postgresql/volume_support db_postgresql
profiler/enabled debug
profiler/trace_sqlalchemy debug
pxc/api_strategy db_pxc
pxc/backup_incremental_strategy db_pxc
pxc/backup_namespace db_pxc
pxc/backup_strategy db_pxc
pxc/cluster_support db_pxc
pxc/device_path db_pxc
pxc/guestagent_strategy db_pxc
pxc/ignore_users db_pxc
pxc/min_cluster_member_count db_pxc
pxc/mount_point db_pxc
pxc/replication_namespace db_pxc
pxc/replication_strategy db_pxc
pxc/replication_user db_pxc
pxc/restore_namespace db_pxc
pxc/root_controller db_pxc
pxc/root_on_create db_pxc
pxc/taskmanager_strategy db_pxc
pxc/tcp_ports db_pxc
pxc/udp_ports db_pxc
pxc/usage_timeout db_pxc
pxc/volume_support db_pxc
redis/api_strategy db_redis
redis/backup_incremental_strategy db_redis
redis/backup_namespace db_redis
redis/backup_strategy db_redis
redis/cluster_support db_redis
redis/device_path db_redis
redis/guestagent_strategy db_redis
redis/mount_point db_redis
redis/replication_namespace db_redis
redis/replication_strategy db_redis
redis/restore_namespace db_redis
redis/root_controller db_redis
redis/taskmanager_strategy db_redis
redis/tcp_ports db_redis
redis/udp_ports db_redis
redis/volume_support db_redis
@ -413,6 +474,7 @@ vertica/mount_point db_vertica
vertica/readahead_size db_vertica
vertica/replication_strategy db_vertica
vertica/restore_namespace db_vertica
vertica/root_controller db_vertica
vertica/taskmanager_strategy db_vertica
vertica/tcp_ports db_vertica
vertica/udp_ports db_vertica

2
tools/autogenerate-config-flagmappings/trove.headers
View File

@ -3,10 +3,12 @@ cluster cluster
db_cassandra Cassandra database
db_couchbase Couchbase database
db_db2 DB2 database
db_mariadb MariaDB database
db_mongodb MongoDB database
db_mysql MySQL database
db_percona Percona database
db_postgresql PostgreSQL database
db_pxc Percona XtraDB Cluster database
db_redis Redis database
db_vertica Vertica database
dns DNS