openstack/openstack-manuals
Code Issues Proposed changes

Update the config tables and reference for trove

Browse Source 
Change-Id: Ie7e20a2a5552f7fdd2b5a0c713a0a4f7fbed9ec2
This commit is contained in:
Gauvain Pocentek 2014-09-06 08:55:36 +02:00
parent 659e8f8913
commit f61a65e8e5
12 changed files with 162 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -42,8 +42,8 @@
<td>(StrOpt) No help text available for this option.</td>
</tr>
<tr>
<td>hostname_require_ipv4 = True</td>
<td>(BoolOpt) Require user hostnames to be IPv4 addresses.</td>
<td>hostname_require_valid_ip = True</td>
<td>(BoolOpt) Require user hostnames to be valid IP addresses.</td>
</tr>
<tr>
<td>http_delete_rate = 200</td>

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

@ -25,10 +25,6 @@
<td>backup_chunk_size = 65536</td>
<td>(IntOpt) Chunk size to stream to swift container. This should be in multiples of 128 bytes, since this is the size of an md5 digest block allowing the process to update the file checksum during streaming. See: http://stackoverflow.com/questions/1131220/</td>
</tr>
<tr>
<td>backup_incremental_strategy = {'InnoBackupEx': 'InnoBackupExIncremental'}</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 = trove.guestagent.strategies.backup.mysql_impl</td>
<td>(StrOpt) Namespace to load backup strategies from.</td>

34
doc/common/tables/trove-cluster.xml Normal file
View File

@ -0,0 +1,34 @@
<?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_cluster">
<caption>Description of cluster 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">[DEFAULT]</th>
</tr>
<tr>
<td>cluster_delete_time_out = 180</td>
<td>(IntOpt) No help text available for this option.</td>
</tr>
<tr>
<td>cluster_usage_timeout = 675</td>
<td>(IntOpt) Timeout to wait for a cluster to become active.</td>
</tr>
<tr>
<td>clusters_page_size = 20</td>
<td>(IntOpt) No help text available for this option.</td>
</tr>
</tbody>
</table>
</para>

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

@ -17,22 +17,46 @@
<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_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) No help text available for this option.</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>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>

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

@ -17,6 +17,10 @@
<tr>
<th colspan="2">[mysql]</th>
</tr>
<tr>
<td>backup_incremental_strategy = {'InnoBackupEx': 'InnoBackupExIncremental'}</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 = trove.guestagent.strategies.backup.mysql_impl</td>
<td>(StrOpt) No help text available for this option.</td>

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

@ -17,6 +17,10 @@
<tr>
<th colspan="2">[percona]</th>
</tr>
<tr>
<td>backup_incremental_strategy = {'InnoBackupEx': 'InnoBackupExIncremental'}</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 = trove.guestagent.strategies.backup.mysql_impl</td>
<td>(StrOpt) No help text available for this option.</td>

66
doc/common/tables/trove-db_postgresql.xml Normal file
View File

@ -0,0 +1,66 @@
<?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_postgresql">
<caption>Description of PostgreSQL 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">[postgresql]</th>
</tr>
<tr>
<td>backup_namespace = trove.guestagent.strategies.backup.postgresql_impl</td>
<td>(StrOpt) No help text available for this option.</td>
</tr>
<tr>
<td>backup_strategy = PgDump</td>
<td>(StrOpt) Default strategy to perform backups.</td>
</tr>
<tr>
<td>device_path = /dev/vdb</td>
<td>(StrOpt) No help text available for this option.</td>
</tr>
<tr>
<td>ignore_dbs = postgres</td>
<td>(ListOpt) No help text available for this option.</td>
</tr>
<tr>
<td>ignore_users = os_admin, postgres, root</td>
<td>(ListOpt) No help text available for this option.</td>
</tr>
<tr>
<td>mount_point = /var/lib/postgresql</td>
<td>(StrOpt) Filesystem path for mounting volumes if volume support is enabled.</td>
</tr>
<tr>
<td>restore_namespace = trove.guestagent.strategies.restore.postgresql_impl</td>
<td>(StrOpt) No help text available for this option.</td>
</tr>
<tr>
<td>root_on_create = False</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>tcp_ports = 5432</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>

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

@ -18,7 +18,7 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>agent_call_high_timeout = 60</td>
<td>agent_call_high_timeout = 1000</td>
<td>(IntOpt) No help text available for this option.</td>
</tr>
<tr>

1
doc/config-reference/ch_databaseserviceconfigure.xml
View File

@ -17,6 +17,7 @@
<xi:include href="../common/tables/trove-backup.xml"/>
<xi:include href="../common/tables/trove-ca.xml"/>
<xi:include href="../common/tables/trove-clients.xml"/>
<xi:include href="../common/tables/trove-cluster.xml"/>
<xi:include href="../common/tables/trove-common.xml"/>
<xi:include href="../common/tables/trove-compute.xml"/>
<xi:include href="../common/tables/trove-debug.xml"/>

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

@ -14,5 +14,6 @@
<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_percona.xml"/>
<xi:include href="../../common/tables/trove-db_postgresql.xml"/>
<xi:include href="../../common/tables/trove-db_redis.xml"/>
</section>

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

@ -10,7 +10,6 @@ backdoor_port debug
backlog debug
backup_aes_cbc_key backup
backup_chunk_size backup
backup_incremental_strategy backup
backup_namespace backup
backup_runner backup
backup_runner_options backup
@ -29,6 +28,9 @@ cinder_service_type volume
cinder_url volume
cinder_volume_type volume
cloudinit_location taskmanager
cluster_delete_time_out cluster
cluster_usage_timeout cluster
clusters_page_size cluster
conductor_manager amqp
conductor_queue amqp
configurations_page_size common
@ -73,7 +75,7 @@ heat_service_type heat
heat_time_out heat
heat_url heat
host common
hostname_require_ipv4 api
hostname_require_valid_ip api
http_delete_rate api
http_get_rate api
http_mgmt_post_rate api
@ -264,13 +266,20 @@ matchmaker_redis/host redis
matchmaker_redis/password redis
matchmaker_redis/port redis
matchmaker_ring/ringfile redis
mongodb/api_strategy db_mongodb
mongodb/backup_strategy db_mongodb
mongodb/cluster_support db_mongodb
mongodb/device_path db_mongodb
mongodb/guestagent_strategy db_mongodb
mongodb/mount_point db_mongodb
mongodb/num_config_servers_per_cluster db_mongodb
mongodb/num_query_routers_per_cluster db_mongodb
mongodb/replication_strategy db_mongodb
mongodb/taskmanager_strategy db_mongodb
mongodb/tcp_ports db_mongodb
mongodb/udp_ports db_mongodb
mongodb/volume_support db_mongodb
mysql/backup_incremental_strategy db_mysql
mysql/backup_namespace db_mysql
mysql/backup_strategy db_mysql
mysql/device_path db_mysql
@ -285,6 +294,7 @@ mysql/tcp_ports db_mysql
mysql/udp_ports db_mysql
mysql/usage_timeout db_mysql
mysql/volume_support db_mysql
percona/backup_incremental_strategy db_percona
percona/backup_namespace db_percona
percona/backup_strategy db_percona
percona/device_path db_percona
@ -299,6 +309,17 @@ percona/tcp_ports db_percona
percona/udp_ports db_percona
percona/usage_timeout db_percona
percona/volume_support db_percona
postgresql/backup_namespace db_postgresql
postgresql/backup_strategy db_postgresql
postgresql/device_path db_postgresql
postgresql/ignore_dbs db_postgresql
postgresql/ignore_users db_postgresql
postgresql/mount_point db_postgresql
postgresql/restore_namespace db_postgresql
postgresql/root_on_create db_postgresql
postgresql/tcp_ports db_postgresql
postgresql/udp_ports db_postgresql
postgresql/volume_support db_postgresql
redis/backup_strategy db_redis
redis/device_path db_redis
redis/mount_point db_redis

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

@ -1,9 +1,11 @@
backup backup
cluster cluster
db_cassandra Cassandra database
db_couchbase Couchbase database
db_mongodb MongoDB database
db_mysql MySQL database
db_percona Percona database
db_postgresql PostgreSQL database
db_redis Redis database
dns DNS
guestagent guest agent