openstack/openstack-manuals
Code Issues Proposed changes

Trove (DBaaS) configuration reference

Browse Source 
This patch imports initial flagmappings and tables for Trove.

Change-Id: I466ae553ad5b9342b8649859d9d650c38ed9a076
This commit is contained in:
Gauvain Pocentek 2014-03-09 09:16:26 +01:00
parent 9d5249a867
commit 99b95c3a20
29 changed files with 1879 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

75
doc/common/tables/trove-amqp.xml Normal file
View File

@ -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
doc/common/tables/trove-api.xml Normal file
View File

@ -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
doc/common/tables/trove-backup.xml Normal file
View File

@ -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
doc/common/tables/trove-common.xml Normal file
View File

@ -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
doc/common/tables/trove-compute.xml Normal file
View File

@ -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>

39
doc/common/tables/trove-database.xml Normal file
View File

@ -0,0 +1,39 @@
<?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 database</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>sql_connection = sqlite:///trove_test.sqlite</td>
<td>(StrOpt) SQL Connection.</td>
</tr>
<tr>
<td>sql_idle_timeout = 3600</td>
<td>(IntOpt) No help text available for this option.</td>
</tr>
<tr>
<td>sql_query_log = False</td>
<td>(BoolOpt) No help text available for this option.</td>
</tr>
<tr>
<td>sql_query_logging = False</td>
<td>(BoolOpt) Allow insecure logging while executing queries through SQLAlchemy.</td>
</tr>
</tbody>
</table>
</para>

39
doc/common/tables/trove-db_cassandra.xml Normal file
View File

@ -0,0 +1,39 @@
<?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 db_cassandra</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">[cassandra]</th>
</tr>
<tr>
<td>backup_strategy = None</td>
<td>(StrOpt) Default strategy to perform backups.</td>
</tr>
<tr>
<td>mount_point = /var/lib/cassandra</td>
<td>(StrOpt) Filesystem path for mounting volumes if volume support is enabled</td>
</tr>
<tr>
<td>tcp_ports = 7000, 7001, 9042, 9160</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 UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True)</td>
</tr>
</tbody>
</table>
</para>

39
doc/common/tables/trove-db_couchbase.xml Normal file
View File

@ -0,0 +1,39 @@
<?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 db_couchbase</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">[couchbase]</th>
</tr>
<tr>
<td>backup_strategy = None</td>
<td>(StrOpt) Default strategy to perform backups.</td>
</tr>
<tr>
<td>mount_point = /var/lib/couchbase</td>
<td>(StrOpt) Filesystem path for mounting volumes if volume support is enabled</td>
</tr>
<tr>
<td>tcp_ports = 8091, 8092, 4369, 11209-11211, 21100-21199</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 UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True)</td>
</tr>
</tbody>
</table>
</para>

39
doc/common/tables/trove-db_mongodb.xml Normal file
View File

@ -0,0 +1,39 @@
<?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 db_mongodb</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>backup_strategy = None</td>
<td>(StrOpt) Default strategy to perform backups.</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>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>
</tbody>
</table>
</para>

39
doc/common/tables/trove-db_mysql.xml Normal file
View File

@ -0,0 +1,39 @@
<?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 db_mysql</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">[mysql]</th>
</tr>
<tr>
<td>backup_strategy = InnoBackupEx</td>
<td>(StrOpt) Default strategy to perform backups.</td>
</tr>
<tr>
<td>mount_point = /var/lib/mysql</td>
<td>(StrOpt) Filesystem path for mounting volumes if volume support is enabled</td>
</tr>
<tr>
<td>tcp_ports = 3306</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 UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True)</td>
</tr>
</tbody>
</table>
</para>

39
doc/common/tables/trove-db_percona.xml Normal file
View File

@ -0,0 +1,39 @@
<?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 db_percona</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">[percona]</th>
</tr>
<tr>
<td>backup_strategy = InnoBackupEx</td>
<td>(StrOpt) Default strategy to perform backups.</td>
</tr>
<tr>
<td>mount_point = /var/lib/mysql</td>
<td>(StrOpt) Filesystem path for mounting volumes if volume support is enabled</td>
</tr>
<tr>
<td>tcp_ports = 3306</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 UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True)</td>
</tr>
</tbody>
</table>
</para>

39
doc/common/tables/trove-db_redis.xml Normal file
View File

@ -0,0 +1,39 @@
<?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 db_redis</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">[redis]</th>
</tr>
<tr>
<td>backup_strategy = None</td>
<td>(StrOpt) Default strategy to perform backups.</td>
</tr>
<tr>
<td>mount_point = /var/lib/redis</td>
<td>(StrOpt) Filesystem path for mounting volumes if volume support is enabled</td>
</tr>
<tr>
<td>tcp_ports = 6379</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 UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True)</td>
</tr>
</tbody>
</table>
</para>

83
doc/common/tables/trove-debug.xml Normal file
View File

@ -0,0 +1,83 @@
<?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 debug</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>backdoor_port = None</td>
<td>(StrOpt) Enable eventlet backdoor. Acceptable values are 0, &lt;port&gt;, and &lt;start&gt;:&lt;end&gt;, where 0 results in listening on a random tcp port number; &lt;port&gt; results in listening on the specified port number (and not enabling backdoor if that port is in use); and &lt;start&gt;:&lt;end&gt; results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.</td>
</tr>
<tr>
<td>backlog = 4096</td>
<td>(IntOpt) Number of backlog requests to configure the socket with</td>
</tr>
<tr>
<td>debug = False</td>
<td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).</td>
</tr>
<tr>
<td>disable_process_locking = False</td>
<td>(BoolOpt) Whether to disable inter-process locks</td>
</tr>
<tr>
<td>fatal_deprecations = False</td>
<td>(BoolOpt) make deprecations fatal</td>
</tr>
<tr>
<td>pydev_debug = disabled</td>
<td>(StrOpt) Enable or disable pydev remote debugging. If value is 'auto' tries to connect to remote debugger server, but in case of error continues running with debugging disabled.</td>
</tr>
<tr>
<td>pydev_debug_host = None</td>
<td>(StrOpt) Pydev debug server host (localhost by default).</td>
</tr>
<tr>
<td>pydev_debug_port = None</td>
<td>(IntOpt) Pydev debug server port (5678 by default).</td>
</tr>
<tr>
<td>remote_cinder_client = trove.common.remote.cinder_client</td>
<td>(StrOpt) No help text available for this option.</td>
</tr>
<tr>
<td>remote_dns_client = trove.common.remote.dns_client</td>
<td>(StrOpt) No help text available for this option.</td>
</tr>
<tr>
<td>remote_guest_client = trove.common.remote.guest_client</td>
<td>(StrOpt) No help text available for this option.</td>
</tr>
<tr>
<td>remote_heat_client = trove.common.remote.heat_client</td>
<td>(StrOpt) No help text available for this option.</td>
</tr>
<tr>
<td>remote_nova_client = trove.common.remote.nova_client</td>
<td>(StrOpt) No help text available for this option.</td>
</tr>
<tr>
<td>remote_swift_client = trove.common.remote.swift_client</td>
<td>(StrOpt) No help text available for this option.</td>
</tr>
<tr>
<td>verbose = False</td>
<td>(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).</td>
</tr>
</tbody>
</table>
</para>

87
doc/common/tables/trove-dns.xml Normal file
View File

@ -0,0 +1,87 @@
<?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 dns</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>dns_account_id = </td>
<td>(StrOpt) No help text available for this option.</td>
</tr>
<tr>
<td>dns_auth_url = </td>
<td>(StrOpt) No help text available for this option.</td>
</tr>
<tr>
<td>dns_domain_id = </td>
<td>(StrOpt) No help text available for this option.</td>
</tr>
<tr>
<td>dns_domain_name = </td>
<td>(StrOpt) No help text available for this option.</td>
</tr>
<tr>
<td>dns_driver = trove.dns.driver.DnsDriver</td>
<td>(StrOpt) No help text available for this option.</td>
</tr>
<tr>
<td>dns_endpoint_url = 0.0.0.0</td>
<td>(StrOpt) No help text available for this option.</td>
</tr>
<tr>
<td>dns_hostname = </td>
<td>(StrOpt) No help text available for this option.</td>
</tr>
<tr>
<td>dns_instance_entry_factory = trove.dns.driver.DnsInstanceEntryFactory</td>
<td>(StrOpt) No help text available for this option.</td>
</tr>
<tr>
<td>dns_management_base_url = </td>
<td>(StrOpt) No help text available for this option.</td>
</tr>
<tr>
<td>dns_passkey = </td>
<td>(StrOpt) No help text available for this option.</td>
</tr>
<tr>
<td>dns_region = </td>
<td>(StrOpt) No help text available for this option.</td>
</tr>
<tr>
<td>dns_service_type = </td>
<td>(StrOpt) No help text available for this option.</td>
</tr>
<tr>
<td>dns_time_out = 120</td>
<td>(IntOpt) No help text available for this option.</td>
</tr>
<tr>
<td>dns_ttl = 300</td>
<td>(IntOpt) No help text available for this option.</td>
</tr>
<tr>
<td>dns_username = </td>
<td>(StrOpt) No help text available for this option.</td>
</tr>
<tr>
<td>trove_dns_support = False</td>
<td>(BoolOpt) No help text available for this option.</td>
</tr>
</tbody>
</table>
</para>

75
doc/common/tables/trove-guestagent.xml Normal file
View File

@ -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 guestagent</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>agent_call_high_timeout = 60</td>
<td>(IntOpt) No help text available for this option.</td>
</tr>
<tr>
<td>agent_call_low_timeout = 5</td>
<td>(IntOpt) No help text available for this option.</td>
</tr>
<tr>
<td>agent_heartbeat_time = 10</td>
<td>(IntOpt) No help text available for this option.</td>
</tr>
<tr>
<td>guest_config = $pybasedir/etc/trove/trove-guestagent.conf.sample</td>
<td>(StrOpt) Path to guestagent config file.</td>
</tr>
<tr>
<td>guest_id = None</td>
<td>(StrOpt) No help text available for this option.</td>
</tr>
<tr>
<td>ignore_dbs = lost+found, mysql, information_schema</td>
<td>(ListOpt) No help text available for this option.</td>
</tr>
<tr>
<td>ignore_users = os_admin, root</td>
<td>(ListOpt) No help text available for this option.</td>
</tr>
<tr>
<td>mount_options = defaults,noatime</td>
<td>(StrOpt) No help text available for this option.</td>
</tr>
<tr>
<td>restore_namespace = trove.guestagent.strategies.restore.mysql_impl</td>
<td>(StrOpt) Namespace to load restore strategies from.</td>
</tr>
<tr>
<td>storage_namespace = trove.guestagent.strategies.storage.swift</td>
<td>(StrOpt) Namespace to load the default storage strategy from.</td>
</tr>
<tr>
<td>storage_strategy = SwiftStorage</td>
<td>(StrOpt) Default strategy to store backups.</td>
</tr>
<tr>
<td>usage_sleep_time = 1</td>
<td>(IntOpt) Time to sleep during the check active guest.</td>
</tr>
<tr>
<td>usage_timeout = 300</td>
<td>(IntOpt) Timeout to wait for a guest to become active.</td>
</tr>
</tbody>
</table>
</para>

31
doc/common/tables/trove-heat.xml Normal file
View File

@ -0,0 +1,31 @@
<?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 heat</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>heat_time_out = 60</td>
<td>(IntOpt) No help text available for this option.</td>
</tr>
<tr>
<td>heat_url = http://localhost:8004/v1</td>
<td>(StrOpt) No help text available for this option.</td>
</tr>
</tbody>
</table>
</para>

91
doc/common/tables/trove-logging.xml Normal file
View File

@ -0,0 +1,91 @@
<?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 logging</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>format_options = -m 5</td>
<td>(StrOpt) No help text available for this option.</td>
</tr>
<tr>
<td>instance_format = "[instance: %(uuid)s] "</td>
<td>(StrOpt) If an instance is passed with the log message, format it like this</td>
</tr>
<tr>
<td>instance_uuid_format = "[instance: %(uuid)s] "</td>
<td>(StrOpt) If an instance UUID is passed with the log message, format it like this</td>
</tr>
<tr>
<td>log-config-append = None</td>
<td>(StrOpt) The name of logging configuration file. It does not disable existing loggers, but just appends specified logging configuration to any other existing logging options. Please see the Python logging module documentation for details on logging configuration files.</td>
</tr>
<tr>
<td>log-date-format = %Y-%m-%d %H:%M:%S</td>
<td>(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s</td>
</tr>
<tr>
<td>log-dir = None</td>
<td>(StrOpt) (Optional) The base directory used for relative --log-file paths</td>
</tr>
<tr>
<td>log-file = None</td>
<td>(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.</td>
</tr>
<tr>
<td>log-format = None</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>
</tr>
<tr>
<td>logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s</td>
<td>(StrOpt) format string to use for log messages with context</td>
</tr>
<tr>
<td>logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d</td>
<td>(StrOpt) data to append to log format when level is DEBUG</td>
</tr>
<tr>
<td>logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s</td>
<td>(StrOpt) format string to use for log messages without context</td>
</tr>
<tr>
<td>logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s</td>
<td>(StrOpt) prefix each line of exception output with this format</td>
</tr>
<tr>
<td>network_label_regex = ^private$</td>
<td>(StrOpt) No help text available for this option.</td>
</tr>
<tr>
<td>publish_errors = False</td>
<td>(BoolOpt) publish error events</td>
</tr>
<tr>
<td>syslog-log-facility = LOG_USER</td>
<td>(StrOpt) syslog facility to receive log lines</td>
</tr>
<tr>
<td>use_stderr = True</td>
<td>(BoolOpt) Log output to standard error</td>
</tr>
<tr>
<td>use-syslog = False</td>
<td>(BoolOpt) Use syslog for logging.</td>
</tr>
</tbody>
</table>
</para>

35
doc/common/tables/trove-nova.xml Normal file
View File

@ -0,0 +1,35 @@
<?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 nova</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>nova_proxy_admin_pass = </td>
<td>(StrOpt) Admin password used to connect to nova,</td>
</tr>
<tr>
<td>nova_proxy_admin_tenant_name = </td>
<td>(StrOpt) Admin tenant used to connect to nova.</td>
</tr>
<tr>
<td>nova_proxy_admin_user = </td>
<td>(StrOpt) Admin username used to connect to nova.</td>
</tr>
</tbody>
</table>
</para>

63
doc/common/tables/trove-qpid.xml Normal file
View File

@ -0,0 +1,63 @@
<?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 qpid</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>qpid_heartbeat = 60</td>
<td>(IntOpt) Seconds between connection keepalive heartbeats</td>
</tr>
<tr>
<td>qpid_hostname = oslo</td>
<td>(StrOpt) Qpid broker hostname</td>
</tr>
<tr>
<td>qpid_hosts = $qpid_hostname:$qpid_port</td>
<td>(ListOpt) Qpid HA cluster host:port pairs</td>
</tr>
<tr>
<td>qpid_password = </td>
<td>(StrOpt) Password for qpid connection</td>
</tr>
<tr>
<td>qpid_port = 5672</td>
<td>(IntOpt) Qpid broker port</td>
</tr>
<tr>
<td>qpid_protocol = tcp</td>
<td>(StrOpt) Transport to use, either 'tcp' or 'ssl'</td>
</tr>
<tr>
<td>qpid_sasl_mechanisms = </td>
<td>(StrOpt) Space separated list of SASL mechanisms to use for auth</td>
</tr>
<tr>
<td>qpid_tcp_nodelay = True</td>
<td>(BoolOpt) Disable Nagle algorithm</td>
</tr>
<tr>
<td>qpid_username = </td>
<td>(StrOpt) Username for qpid connection</td>
</tr>
<tr>
<td>qpid_topology_version = 1</td>
<td>(IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.</td>
</tr>
</tbody>
</table>
</para>

43
doc/common/tables/trove-quota.xml Normal file
View File

@ -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 quota</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>max_accepted_volume_size = 5</td>
<td>(IntOpt) Default maximum volume size for an instance.</td>
</tr>
<tr>
<td>max_backups_per_user = 50</td>
<td>(IntOpt) Default maximum number of backups created by a tenant.</td>
</tr>
<tr>
<td>max_instances_per_user = 5</td>
<td>(IntOpt) Default maximum number of instances per tenant.</td>
</tr>
<tr>
<td>max_volumes_per_user = 20</td>
<td>(IntOpt) Default maximum volume capacity (in GB) spanning across all trove volumes per tenant</td>
</tr>
<tr>
<td>quota_driver = trove.quota.quota.DbQuotaDriver</td>
<td>(StrOpt) Default driver to use for quota checks.</td>
</tr>
</tbody>
</table>
</para>

67
doc/common/tables/trove-rabbitmq.xml Normal file
View File

@ -0,0 +1,67 @@
<?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 rabbitmq</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>rabbit_ha_queues = False</td>
<td>(BoolOpt) use H/A queues in RabbitMQ (x-ha-policy: all).You need to wipe RabbitMQ database when changing this option.</td>
</tr>
<tr>
<td>rabbit_host = oslo</td>
<td>(StrOpt) The RabbitMQ broker address where a single node is used</td>
</tr>
<tr>
<td>rabbit_hosts = $rabbit_host:$rabbit_port</td>
<td>(ListOpt) RabbitMQ HA cluster host:port pairs</td>
</tr>
<tr>
<td>rabbit_max_retries = 0</td>
<td>(IntOpt) maximum retries with trying to connect to RabbitMQ (the default of 0 implies an infinite retry count)</td>
</tr>
<tr>
<td>rabbit_password = guest</td>
<td>(StrOpt) the RabbitMQ password</td>
</tr>
<tr>
<td>rabbit_port = 5672</td>
<td>(IntOpt) The RabbitMQ broker port where a single node is used</td>
</tr>
<tr>
<td>rabbit_retry_backoff = 2</td>
<td>(IntOpt) how long to backoff for between retries when connecting to RabbitMQ</td>
</tr>
<tr>
<td>rabbit_retry_interval = 1</td>
<td>(IntOpt) how frequently to retry connecting with RabbitMQ</td>
</tr>
<tr>
<td>rabbit_use_ssl = False</td>
<td>(BoolOpt) connect over SSL for RabbitMQ</td>
</tr>
<tr>
<td>rabbit_userid = guest</td>
<td>(StrOpt) the RabbitMQ userid</td>
</tr>
<tr>
<td>rabbit_virtual_host = /</td>
<td>(StrOpt) the RabbitMQ virtual host</td>
</tr>
</tbody>
</table>
</para>

53
doc/common/tables/trove-redis.xml Normal file
View File

@ -0,0 +1,53 @@
<?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 redis</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">[matchmaker_redis]</th>
</tr>
<tr>
<td>host = 127.0.0.1</td>
<td>(StrOpt) Host to locate redis</td>
</tr>
<tr>
<td>password = None</td>
<td>(StrOpt) Password for Redis server. (optional)</td>
</tr>
<tr>
<td>port = 6379</td>
<td>(IntOpt) Use this port to connect to redis host.</td>
</tr>
<tr>
<th colspan="2">[matchmaker_ring]</th>
</tr>
<tr>
<td>ringfile = /etc/oslo/matchmaker_ring.json</td>
<td>(StrOpt) Matchmaker ring file (JSON)</td>
</tr>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>port = 6379</td>
<td>(IntOpt) Use this port to connect to redis host.</td>
</tr>
<tr>
<td>password = None</td>
<td>(StrOpt) Password for Redis server. (optional)</td>
</tr>
</tbody>
</table>
</para>

105
doc/common/tables/trove-rpc.xml Normal file
View File

@ -0,0 +1,105 @@
<?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 rpc</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>allowed_rpc_exception_modules = nova.exception, cinder.exception, exceptions</td>
<td>(ListOpt) Modules of exceptions that are permitted to be recreatedupon receiving exception data from an rpc call.</td>
</tr>
<tr>
<td>host = 0.0.0.0</td>
<td>(StrOpt) No help text available for this option.</td>
</tr>
<tr>
<td>matchmaker_heartbeat_freq = 300</td>
<td>(IntOpt) Heartbeat frequency</td>
</tr>
<tr>
<td>matchmaker_heartbeat_ttl = 600</td>
<td>(IntOpt) Heartbeat time-to-live.</td>
</tr>
<tr>
<td>num_tries = 3</td>
<td>(IntOpt) No help text available for this option.</td>
</tr>
<tr>
<td>periodic_interval = 60</td>
<td>(IntOpt) No help text available for this option.</td>
</tr>
<tr>
<td>report_interval = 10</td>
<td>(IntOpt) The interval in seconds which periodic tasks are run.</td>
</tr>
<tr>
<td>rpc_backend = trove.openstack.common.rpc.impl_kombu</td>
<td>(StrOpt) The messaging module to use, defaults to kombu.</td>
</tr>
<tr>
<td>rpc_cast_timeout = 30</td>
<td>(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq.</td>
</tr>
<tr>
<td>rpc_conn_pool_size = 30</td>
<td>(IntOpt) Size of RPC connection pool</td>
</tr>
<tr>
<td>rpc_response_timeout = 60</td>
<td>(IntOpt) Seconds to wait for a response from call or multicall</td>
</tr>
<tr>
<td>rpc_thread_pool_size = 64</td>
<td>(IntOpt) Size of RPC thread pool</td>
</tr>
<tr>
<th colspan="2">[rpc_notifier2]</th>
</tr>
<tr>
<td>topics = notifications</td>
<td>(ListOpt) AMQP topic(s) used for openstack notifications</td>
</tr>
<tr>
<th colspan="2">[secure_messages]</th>
</tr>
<tr>
<td>enabled = True</td>
<td>(BoolOpt) Whether Secure Messaging (Signing) is enabled, defaults to enabled</td>
</tr>
<tr>
<td>encrypt = False</td>
<td>(BoolOpt) Whether Secure Messaging (Encryption) is enabled, defaults to not enabled</td>
</tr>
<tr>
<td>enforced = False</td>
<td>(BoolOpt) Whether Secure Messaging (Signing) is enforced, defaults to not enforced</td>
</tr>
<tr>
<td>kds_endpoint = None</td>
<td>(StrOpt) KDS endpoint (ex: http://kds.example.com:35357/v3)</td>
</tr>
<tr>
<td>secret_key = None</td>
<td>(MultiStrOpt) A list of keys: (ex: name:&lt;base64 encoded key&gt;), ignored if secret_keys_file is set</td>
</tr>
<tr>
<td>secret_keys_file = None</td>
<td>(StrOpt) Path to the file containing the keys, takes precedence over secret_key</td>
</tr>
</tbody>
</table>
</para>

35
doc/common/tables/trove-ssl.xml Normal file
View File

@ -0,0 +1,35 @@
<?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 ssl</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">[ssl]</th>
</tr>
<tr>
<td>ca_file = None</td>
<td>(StrOpt) CA certificate file to use to verify connecting clients</td>
</tr>
<tr>
<td>cert_file = None</td>
<td>(StrOpt) Certificate file to use when starting the server securely</td>
</tr>
<tr>
<td>key_file = None</td>
<td>(StrOpt) Private key file to use when starting the server securely</td>
</tr>
</tbody>
</table>
</para>

27
doc/common/tables/trove-swift.xml Normal file
View File

@ -0,0 +1,27 @@
<?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 swift</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>swift_url = http://localhost:8080/v1/AUTH_</td>
<td>(StrOpt) No help text available for this option.</td>
</tr>
</tbody>
</table>
</para>

87
doc/common/tables/trove-taskmanager.xml Normal file
View File

@ -0,0 +1,87 @@
<?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 taskmanager</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>cloudinit_location = /etc/trove/cloudinit</td>
<td>(StrOpt) Path to folder with cloudinit scripts.</td>
</tr>
<tr>
<td>datastore_manager = None</td>
<td>(StrOpt) Manager class in guestagent, setup by taskmanager on instance provision.</td>
</tr>
<tr>
<td>datastore_registry_ext = {}</td>
<td>(DictOpt) Extension for default datastore managers. Allows to use custom managers for each of datastore supported in trove.</td>
</tr>
<tr>
<td>exists_notification_ticks = 360</td>
<td>(IntOpt) Number of report_intervals to wait between pushing events (see report_interval).</td>
</tr>
<tr>
<td>exists_notification_transformer = None</td>
<td>(StrOpt) Transformer for exists notifications.</td>
</tr>
<tr>
<td>reboot_time_out = 120</td>
<td>(IntOpt) No help text available for this option.</td>
</tr>
<tr>
<td>resize_time_out = 600</td>
<td>(IntOpt) No help text available for this option.</td>
</tr>
<tr>
<td>revert_time_out = 600</td>
<td>(IntOpt) No help text available for this option.</td>
</tr>
<tr>
<td>server_delete_time_out = 60</td>
<td>(IntOpt) No help text available for this option.</td>
</tr>
<tr>
<td>state_change_wait_time = 180</td>
<td>(IntOpt) No help text available for this option.</td>
</tr>
<tr>
<td>update_status_on_fail = False</td>
<td>(BoolOpt) If instance fails to become active, taskmanager updates statuses, service status = FAILED_TIMEOUT_GUESTAGENT, instance task status = BUILDING_ERROR_TIMEOUT_GA.</td>
</tr>
<tr>
<td>usage_sleep_time = 1</td>
<td>(IntOpt) Time to sleep during the check active guest.</td>
</tr>
<tr>
<td>usage_timeout = 300</td>
<td>(IntOpt) Timeout to wait for a guest to become active.</td>
</tr>
<tr>
<td>use_heat = False</td>
<td>(BoolOpt) No help text available for this option.</td>
</tr>
<tr>
<td>use_nova_server_volume = False</td>
<td>(BoolOpt) No help text available for this option.</td>
</tr>
<tr>
<td>verify_swift_checksum_on_restore = True</td>
<td>(BoolOpt) Enable verification of swift checksum before starting restore; makes sure the checksum of original backup matches checksum of the swift backup file.</td>
</tr>
</tbody>
</table>
</para>

51
doc/common/tables/trove-volume.xml Normal file
View File

@ -0,0 +1,51 @@
<?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 volume</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>block_device_mapping = vdb</td>
<td>(StrOpt) No help text available for this option.</td>
</tr>
<tr>
<td>cinder_url = http://localhost:8776/v2</td>
<td>(StrOpt) No help text available for this option.</td>
</tr>
<tr>
<td>device_path = /dev/vdb</td>
<td>(StrOpt) No help text available for this option.</td>
</tr>
<tr>
<td>trove_volume_support = True</td>
<td>(BoolOpt) Whether to provision a cinder volume for datadir.</td>
</tr>
<tr>
<td>volume_format_timeout = 120</td>
<td>(IntOpt) No help text available for this option.</td>
</tr>
<tr>
<td>volume_fstype = ext3</td>
<td>(StrOpt) No help text available for this option.</td>
</tr>
<tr>
<td>volume_time_out = 60</td>
<td>(IntOpt) No help text available for this option.</td>
</tr>
</tbody>
</table>
</para>

51
doc/common/tables/trove-zeromq.xml Normal file
View File

@ -0,0 +1,51 @@
<?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 zeromq</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>rpc_zmq_bind_address = *</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>rpc_zmq_contexts = 1</td>
<td>(IntOpt) Number of ZeroMQ contexts, defaults to 1</td>
</tr>
<tr>
<td>rpc_zmq_host = oslo</td>
<td>(StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova.</td>
</tr>
<tr>
<td>rpc_zmq_ipc_dir = /var/run/openstack</td>
<td>(StrOpt) Directory for holding IPC sockets</td>
</tr>
<tr>
<td>rpc_zmq_matchmaker = trove.openstack.common.rpc.matchmaker.MatchMakerLocalhost</td>
<td>(StrOpt) MatchMaker driver</td>
</tr>
<tr>
<td>rpc_zmq_port = 9501</td>
<td>(IntOpt) ZeroMQ receiver listening port</td>
</tr>
<tr>
<td>rpc_zmq_topic_backlog = None</td>
<td>(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited.</td>
</tr>
</tbody>
</table>
</para>

243
tools/autogenerate-config-flagmappings/trove.flagmappings Normal file
View File

@ -0,0 +1,243 @@
admin_roles api
agent_call_high_timeout guestagent
agent_call_low_timeout guestagent
agent_heartbeat_time guestagent
allowed_rpc_exception_modules rpc
amqp_auto_delete amqp
amqp_durable_queues amqp
api_extensions_path api
api_paste_config api
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
backup_segment_max_size backup
backup_strategy backup
backup_swift_container backup
backup_use_gzip_compression backup
backup_use_openssl_encryption backup
backup_use_snet backup
backups_page_size backup
bind_port api
block_device_mapping volume
cinder_url volume
cloudinit_location taskmanager
conductor_queue amqp
configurations_page_size common
control_exchange amqp
databases_page_size common
datastore_manager taskmanager
datastore_registry_ext taskmanager
db_api_implementation api
debug debug
default_datastore common
default_log_levels common
default_neutron_networks common
default_notification_level common
default_password_length common
default_publisher_id common
device_path volume
disable_process_locking debug
dns_account_id dns
dns_auth_url dns
dns_domain_id dns
dns_domain_name dns
dns_driver dns
dns_endpoint_url dns
dns_hostname dns
dns_instance_entry_factory dns
dns_management_base_url dns
dns_passkey dns
dns_region dns
dns_service_type dns
dns_time_out dns
dns_ttl dns
dns_username dns
exists_notification_ticks taskmanager
exists_notification_transformer taskmanager
expected_filetype_suffixes common
fake_rabbit amqp
fatal_deprecations debug
format_options logging
guest_config guestagent
guest_id guestagent
heat_time_out heat
heat_url heat
host rpc
hostname_require_ipv4 api
http_delete_rate api
http_get_rate api
http_post_rate api
http_put_rate api
ignore_dbs guestagent
ignore_users guestagent
instance_format logging
instance_uuid_format logging
instances_page_size api
ip_regex compute
kombu_ssl_ca_certs amqp
kombu_ssl_certfile amqp
kombu_ssl_keyfile amqp
kombu_ssl_version amqp
lock_path common
log_config_append logging
log_date_format logging
log_dir logging
log_file logging
log_format logging
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
max_instances_per_user quota
max_volumes_per_user quota
mount_options guestagent
network_label_regex logging
notification_driver amqp
notification_service_id amqp
notification_topics amqp
nova_compute_url compute
nova_proxy_admin_pass nova
nova_proxy_admin_tenant_name nova
nova_proxy_admin_user nova
num_tries rpc
periodic_interval rpc
publish_errors logging
pybasedir common
pydev_debug debug
pydev_debug_host debug
pydev_debug_port debug
pydev_path common
qpid_heartbeat qpid
qpid_hostname qpid
qpid_hosts qpid
qpid_password qpid
qpid_port qpid
qpid_protocol qpid
qpid_sasl_mechanisms qpid
qpid_tcp_nodelay qpid
qpid_username qpid
quota_driver quota
rabbit_ha_queues rabbitmq
rabbit_host rabbitmq
rabbit_hosts rabbitmq
rabbit_max_retries rabbitmq
rabbit_password rabbitmq
rabbit_port rabbitmq
rabbit_retry_backoff rabbitmq
rabbit_retry_interval rabbitmq
rabbit_use_ssl rabbitmq
rabbit_userid rabbitmq
rabbit_virtual_host rabbitmq
reboot_time_out taskmanager
region api
remote_cinder_client debug
remote_dns_client debug
remote_guest_client debug
remote_heat_client debug
remote_nova_client debug
remote_swift_client debug
report_interval rpc
resize_time_out taskmanager
restore_namespace guestagent
revert_time_out taskmanager
root_grant compute
root_grant_option compute
root_on_create compute
rpc_backend rpc
rpc_cast_timeout rpc
rpc_conn_pool_size rpc
rpc_response_timeout rpc
rpc_thread_pool_size rpc
rpc_zmq_bind_address 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_connection database
sql_idle_timeout database
sql_query_log database
sql_query_logging database
state_change_wait_time taskmanager
storage_namespace guestagent
storage_strategy guestagent
swift_url swift
syslog_log_facility logging
taskmanager_queue common
tcp_keepidle api
template_path common
trove_api_workers api
trove_auth_url api
trove_conductor_workers api
trove_dns_support dns
trove_security_group_name_prefix api
trove_security_group_rule_cidr api
trove_security_groups_support api
trove_volume_support volume
update_status_on_fail taskmanager
usage_sleep_time guestagent taskmanager
usage_timeout guestagent taskmanager
use_heat taskmanager
use_nova_server_volume taskmanager
use_stderr logging
use_syslog logging
users_page_size api
verbose debug
verify_swift_checksum_on_restore taskmanager
volume_format_timeout volume
volume_fstype volume
volume_time_out volume
cassandra/backup_strategy db_cassandra
cassandra/mount_point db_cassandra
cassandra/tcp_ports db_cassandra
cassandra/udp_ports db_cassandra
couchbase/backup_strategy db_couchbase
couchbase/mount_point db_couchbase
couchbase/tcp_ports db_couchbase
couchbase/udp_ports db_couchbase
matchmaker_redis/host redis
matchmaker_redis/password redis
matchmaker_redis/port redis
matchmaker_ring/ringfile redis
mongodb/backup_strategy db_mongodb
mongodb/mount_point db_mongodb
mongodb/tcp_ports db_mongodb
mongodb/udp_ports db_mongodb
mysql/backup_strategy db_mysql
mysql/mount_point db_mysql
mysql/tcp_ports db_mysql
mysql/udp_ports db_mysql
percona/backup_strategy db_percona
percona/mount_point db_percona
percona/tcp_ports db_percona
percona/udp_ports db_percona
redis/backup_strategy db_redis
redis/mount_point db_redis
redis/tcp_ports db_redis
redis/udp_ports db_redis
rpc_notifier2/topics rpc
secure_messages/enabled rpc
secure_messages/encrypt rpc
secure_messages/enforced rpc
secure_messages/kds_endpoint rpc
secure_messages/secret_key rpc
secure_messages/secret_keys_file rpc
ssl/ca_file ssl
ssl/cert_file ssl
ssl/key_file ssl
qpid_topology_version qpid
port redis
password redis
transport_url amqp