Skip to content

Commit

Permalink
Trove (DBaaS) configuration reference
Browse files Browse the repository at this point in the history 
This patch imports initial flagmappings and tables for Trove.

Change-Id: I466ae553ad5b9342b8649859d9d650c38ed9a076
  • Loading branch information
Gauvain Pocentek committed Mar 9, 2014
1 parent 9d5249a commit 99b95c3
Show file tree
Hide file tree
Showing 29 changed files with 1,879 additions and 0 deletions.
75 changes: 75 additions & 0 deletions doc/common/tables/trove-amqp.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for amqp</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>amqp_auto_delete = False</td>
<td>(BoolOpt) Auto-delete queues in amqp.</td>
</tr>
<tr>
<td>amqp_durable_queues = False</td>
<td>(BoolOpt) Use durable queues in amqp.</td>
</tr>
<tr>
<td>conductor_queue = trove-conductor</td>
<td>(StrOpt) No help text available for this option.</td>
</tr>
<tr>
<td>control_exchange = openstack</td>
<td>(StrOpt) AMQP exchange to connect to if using RabbitMQ or Qpid</td>
</tr>
<tr>
<td>fake_rabbit = False</td>
<td>(BoolOpt) If passed, use a fake RabbitMQ provider</td>
</tr>
<tr>
<td>kombu_ssl_ca_certs = </td>
<td>(StrOpt) SSL certification authority file (valid only if SSL enabled)</td>
</tr>
<tr>
<td>kombu_ssl_certfile = </td>
<td>(StrOpt) SSL cert file (valid only if SSL enabled)</td>
</tr>
<tr>
<td>kombu_ssl_keyfile = </td>
<td>(StrOpt) SSL key file (valid only if SSL enabled)</td>
</tr>
<tr>
<td>kombu_ssl_version = </td>
<td>(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions</td>
</tr>
<tr>
<td>notification_driver = []</td>
<td>(MultiStrOpt) Driver or drivers to handle sending notifications</td>
</tr>
<tr>
<td>notification_service_id = {'couchbase': 'fa62fe68-74d9-4779-a24e-36f19602c415', 'mongodb': 'c8c907af-7375-456f-b929-b637ff9209ee', 'cassandra': '459a230d-4e97-4344-9067-2a54a310b0ed', 'redis': 'b216ffc5-1947-456c-a4cf-70f94c05f7d0', 'mysql': '2f3ff068-2bfb-4f70-9a9d-a6bb65bc084b'}</td>
<td>(DictOpt) Unique ID to tag notification events.</td>
</tr>
<tr>
<td>notification_topics = notifications</td>
<td>(ListOpt) AMQP topic used for openstack notifications</td>
</tr>
<tr>
<td>transport_url = None</td>
<td>(StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration.</td>
</tr>
</tbody>
</table>
</para>
107 changes: 107 additions & 0 deletions doc/common/tables/trove-api.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for api</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>admin_roles = admin</td>
<td>(ListOpt) No help text available for this option.</td>
</tr>
<tr>
<td>api_extensions_path = trove/extensions/routes</td>
<td>(StrOpt) Path to extensions.</td>
</tr>
<tr>
<td>api_paste_config = api-paste.ini</td>
<td>(StrOpt) File name for the paste.deploy config for trove-api.</td>
</tr>
<tr>
<td>bind_port = 8779</td>
<td>(IntOpt) No help text available for this option.</td>
</tr>
<tr>
<td>db_api_implementation = trove.db.sqlalchemy.api</td>
<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>
</tr>
<tr>
<td>http_delete_rate = 200</td>
<td>(IntOpt) No help text available for this option.</td>
</tr>
<tr>
<td>http_get_rate = 200</td>
<td>(IntOpt) No help text available for this option.</td>
</tr>
<tr>
<td>http_post_rate = 200</td>
<td>(IntOpt) No help text available for this option.</td>
</tr>
<tr>
<td>http_put_rate = 200</td>
<td>(IntOpt) No help text available for this option.</td>
</tr>
<tr>
<td>instances_page_size = 20</td>
<td>(IntOpt) No help text available for this option.</td>
</tr>
<tr>
<td>max_header_line = 16384</td>
<td>(IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs</td>
</tr>
<tr>
<td>region = LOCAL_DEV</td>
<td>(StrOpt) The region this service is located.</td>
</tr>
<tr>
<td>tcp_keepidle = 600</td>
<td>(IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X.</td>
</tr>
<tr>
<td>trove_api_workers = None</td>
<td>(IntOpt) No help text available for this option.</td>
</tr>
<tr>
<td>trove_auth_url = http://0.0.0.0:5000/v2.0</td>
<td>(StrOpt) No help text available for this option.</td>
</tr>
<tr>
<td>trove_conductor_workers = 1</td>
<td>(IntOpt) No help text available for this option.</td>
</tr>
<tr>
<td>trove_security_group_name_prefix = SecGroup</td>
<td>(StrOpt) No help text available for this option.</td>
</tr>
<tr>
<td>trove_security_group_rule_cidr = 0.0.0.0/0</td>
<td>(StrOpt) No help text available for this option.</td>
</tr>
<tr>
<td>trove_security_groups_support = True</td>
<td>(BoolOpt) No help text available for this option.</td>
</tr>
<tr>
<td>users_page_size = 20</td>
<td>(IntOpt) No help text available for this option.</td>
</tr>
</tbody>
</table>
</para>
75 changes: 75 additions & 0 deletions doc/common/tables/trove-backup.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for backup</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>backup_aes_cbc_key = default_aes_cbc_key</td>
<td>(StrOpt) Default OpenSSL aes_cbc key.</td>
</tr>
<tr>
<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 off of 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>
</tr>
<tr>
<td>backup_runner = trove.guestagent.backup.backup_types.InnoBackupEx</td>
<td>(StrOpt) No help text available for this option.</td>
</tr>
<tr>
<td>backup_runner_options = {}</td>
<td>(DictOpt) Additional options to be passed to the backup runner.</td>
</tr>
<tr>
<td>backup_segment_max_size = 2147483648</td>
<td>(IntOpt) Maximum size of each segment of the backup file.</td>
</tr>
<tr>
<td>backup_strategy = InnoBackupEx</td>
<td>(StrOpt) Default strategy to perform backups.</td>
</tr>
<tr>
<td>backup_swift_container = database_backups</td>
<td>(StrOpt) No help text available for this option.</td>
</tr>
<tr>
<td>backup_use_gzip_compression = True</td>
<td>(BoolOpt) Compress backups using gzip.</td>
</tr>
<tr>
<td>backup_use_openssl_encryption = True</td>
<td>(BoolOpt) Encrypt backups using OpenSSL.</td>
</tr>
<tr>
<td>backup_use_snet = False</td>
<td>(BoolOpt) Send backup files over snet.</td>
</tr>
<tr>
<td>backups_page_size = 20</td>
<td>(IntOpt) No help text available for this option.</td>
</tr>
</tbody>
</table>
</para>
79 changes: 79 additions & 0 deletions doc/common/tables/trove-common.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for common</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>configurations_page_size = 20</td>
<td>(IntOpt) No help text available for this option.</td>
</tr>
<tr>
<td>databases_page_size = 20</td>
<td>(IntOpt) No help text available for this option.</td>
</tr>
<tr>
<td>default_datastore = None</td>
<td>(StrOpt) The default datastore id or name to use if one is not provided by the user. If the default value is None, the field becomes required in the instance-create request.</td>
</tr>
<tr>
<td>default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, iso8601=WARN</td>
<td>(ListOpt) list of logger=LEVEL pairs</td>
</tr>
<tr>
<td>default_neutron_networks = </td>
<td>(ListOpt) List of network IDs which should be attached to instance when networks are not specified in API call.</td>
</tr>
<tr>
<td>default_notification_level = INFO</td>
<td>(StrOpt) Default notification level for outgoing notifications</td>
</tr>
<tr>
<td>default_password_length = 36</td>
<td>(IntOpt) No help text available for this option.</td>
</tr>
<tr>
<td>default_publisher_id = $host</td>
<td>(StrOpt) Default publisher_id for outgoing notifications</td>
</tr>
<tr>
<td>expected_filetype_suffixes = atom, json, xml</td>
<td>(ListOpt) Filetype endings not to be reattached to an id by the utils method correct_id_with_req.</td>
</tr>
<tr>
<td>lock_path = None</td>
<td>(StrOpt) Directory to use for lock files.</td>
</tr>
<tr>
<td>pybasedir = /usr/lib/python/site-packages/trove</td>
<td>(StrOpt) Directory where the trove python module is installed.</td>
</tr>
<tr>
<td>pydev_path = None</td>
<td>(StrOpt) Set path to pydevd library, used if pydevd is not found in python sys.path.</td>
</tr>
<tr>
<td>taskmanager_queue = taskmanager</td>
<td>(StrOpt) No help text available for this option.</td>
</tr>
<tr>
<td>template_path = /etc/trove/templates/</td>
<td>(StrOpt) Path which leads to datastore templates.</td>
</tr>
</tbody>
</table>
</para>
43 changes: 43 additions & 0 deletions doc/common/tables/trove-compute.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for compute</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>ip_regex = None</td>
<td>(StrOpt) No help text available for this option.</td>
</tr>
<tr>
<td>nova_compute_url = http://localhost:8774/v2</td>
<td>(StrOpt) No help text available for this option.</td>
</tr>
<tr>
<td>root_grant = ALL</td>
<td>(ListOpt) No help text available for this option.</td>
</tr>
<tr>
<td>root_grant_option = True</td>
<td>(BoolOpt) 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>
</tbody>
</table>
</para>
Loading

0 comments on commit 99b95c3

Please sign in to comment.