openstack/openstack-manuals
Code Issues Proposed changes

Update the config-ref tables

Browse Source 
This change brings new files that need to be included in the config
reference documentation. See bug #1407581.

Change-Id: Id8adfbc5dc46ceeec22bc1cfd332d5f85af40f22
Closes-Bug: #1386462
Closes-Bug: #1385916
Closes-Bug: #1411178
This commit is contained in:
Gauvain Pocentek 2015-01-21 18:40:17 +01:00
parent e48baa8fe6
commit 45fa1c95f0
111 changed files with 1836 additions and 1109 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -37,6 +37,10 @@
<td><option>policy_file</option> = <replaceable>policy.json</replaceable></td>
<td>(StrOpt) The JSON file that defines policies.</td>
</tr>
<tr>
<td><option>reserved_metadata_keys</option> = <replaceable></replaceable></td>
<td>(ListOpt) List of metadata keys reserved for metering use. And these keys are additional to the ones included in the namespace.</td>
</tr>
<tr>
<td><option>reserved_metadata_length</option> = <replaceable>256</replaceable></td>
<td>(IntOpt) Limit on length of reserved metadata values.</td>

30
doc/common/tables/ceilometer-auth_token.xml
View File

@ -19,11 +19,11 @@
</tr>
<tr>
<td><option>admin_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Keystone account password</td>
<td>(StrOpt) Service user password.</td>
</tr>
<tr>
<td><option>admin_tenant_name</option> = <replaceable>admin</replaceable></td>
<td>(StrOpt) Keystone service account tenant name to validate user tokens</td>
<td>(StrOpt) Service tenant name.</td>
</tr>
<tr>
<td><option>admin_token</option> = <replaceable>None</replaceable></td>
@ -31,7 +31,7 @@
</tr>
<tr>
<td><option>admin_user</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Keystone account username</td>
<td>(StrOpt) Service username.</td>
</tr>
<tr>
<td><option>auth_admin_prefix</option> = <replaceable></replaceable></td>
@ -51,15 +51,15 @@
</tr>
<tr>
<td><option>auth_uri</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Complete public Identity API endpoint</td>
<td>(StrOpt) Complete public Identity API endpoint.</td>
</tr>
<tr>
<td><option>auth_version</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) API version of the admin Identity API endpoint</td>
<td>(StrOpt) API version of the admin Identity API endpoint.</td>
</tr>
<tr>
<td><option>cache</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Env key for the swift cache</td>
<td>(StrOpt) Env key for the swift cache.</td>
</tr>
<tr>
<td><option>cafile</option> = <replaceable>None</replaceable></td>
@ -67,15 +67,15 @@
</tr>
<tr>
<td><option>certfile</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Required if Keystone server requires client certificate</td>
<td>(StrOpt) Required if identity server requires client certificate</td>
</tr>
<tr>
<td><option>check_revocations_for_cached</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the Keystone server.</td>
<td>(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server.</td>
</tr>
<tr>
<td><option>delay_auth_decision</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components</td>
<td>(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components.</td>
</tr>
<tr>
<td><option>enforce_token_bind</option> = <replaceable>permissive</replaceable></td>
@ -87,7 +87,7 @@
</tr>
<tr>
<td><option>http_connect_timeout</option> = <replaceable>None</replaceable></td>
<td>(BoolOpt) Request timeout value for communicating with Identity API server.</td>
<td>(IntOpt) Request timeout value for communicating with Identity API server.</td>
</tr>
<tr>
<td><option>http_request_max_retries</option> = <replaceable>3</replaceable></td>
@ -99,7 +99,7 @@
</tr>
<tr>
<td><option>include_service_catalog</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.</td>
<td>(BoolOpt) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.</td>
</tr>
<tr>
<td><option>insecure</option> = <replaceable>False</replaceable></td>
@ -107,15 +107,15 @@
</tr>
<tr>
<td><option>keyfile</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Required if Keystone server requires client certificate</td>
<td>(StrOpt) Required if identity server requires client certificate</td>
</tr>
<tr>
<td><option>memcache_secret_key</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation.</td>
<td>(StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.</td>
</tr>
<tr>
<td><option>memcache_security_strategy</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) (optional) if defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.</td>
<td>(StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.</td>
</tr>
<tr>
<td><option>revocation_cache_time</option> = <replaceable>10</replaceable></td>
@ -123,7 +123,7 @@
</tr>
<tr>
<td><option>signing_dir</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Directory used to cache files related to PKI tokens</td>
<td>(StrOpt) Directory used to cache files related to PKI tokens.</td>
</tr>
<tr>
<td><option>token_cache_time</option> = <replaceable>300</replaceable></td>

2
doc/common/tables/ceilometer-cells.xml
View File

@ -4,7 +4,7 @@
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_ceilometer_cells">
<caption>Description of Nova-cells configuration options</caption>
<caption>Description of cells configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>

26
doc/common/tables/ceilometer-magnetodb.xml Normal file
View File

@ -0,0 +1,26 @@
<?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_ceilometer_magnetodb">
<caption>Description of MagnetoDB 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><option>magnetodb_control_exchange</option> = <replaceable>magnetodb</replaceable></td>
<td>(StrOpt) Exchange name for Magnetodb notifications.</td>
</tr>
</tbody>
</table>
</para>

26
doc/common/tables/ceilometer-zaqar.xml Normal file
View File

@ -0,0 +1,26 @@
<?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_ceilometer_zaqar">
<caption>Description of Zaqar 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><option>zaqar_control_exchange</option> = <replaceable>zaqar</replaceable></td>
<td>(StrOpt) Exchange name for Messaging service notifications.</td>
</tr>
</tbody>
</table>
</para>

30
doc/common/tables/cinder-auth_token.xml
View File

@ -19,11 +19,11 @@
</tr>
<tr>
<td><option>admin_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Keystone account password</td>
<td>(StrOpt) Service user password.</td>
</tr>
<tr>
<td><option>admin_tenant_name</option> = <replaceable>admin</replaceable></td>
<td>(StrOpt) Keystone service account tenant name to validate user tokens</td>
<td>(StrOpt) Service tenant name.</td>
</tr>
<tr>
<td><option>admin_token</option> = <replaceable>None</replaceable></td>
@ -31,7 +31,7 @@
</tr>
<tr>
<td><option>admin_user</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Keystone account username</td>
<td>(StrOpt) Service username.</td>
</tr>
<tr>
<td><option>auth_admin_prefix</option> = <replaceable></replaceable></td>
@ -51,15 +51,15 @@
</tr>
<tr>
<td><option>auth_uri</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Complete public Identity API endpoint</td>
<td>(StrOpt) Complete public Identity API endpoint.</td>
</tr>
<tr>
<td><option>auth_version</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) API version of the admin Identity API endpoint</td>
<td>(StrOpt) API version of the admin Identity API endpoint.</td>
</tr>
<tr>
<td><option>cache</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Env key for the swift cache</td>
<td>(StrOpt) Env key for the swift cache.</td>
</tr>
<tr>
<td><option>cafile</option> = <replaceable>None</replaceable></td>
@ -67,15 +67,15 @@
</tr>
<tr>
<td><option>certfile</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Required if Keystone server requires client certificate</td>
<td>(StrOpt) Required if identity server requires client certificate</td>
</tr>
<tr>
<td><option>check_revocations_for_cached</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the Keystone server.</td>
<td>(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server.</td>
</tr>
<tr>
<td><option>delay_auth_decision</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components</td>
<td>(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components.</td>
</tr>
<tr>
<td><option>enforce_token_bind</option> = <replaceable>permissive</replaceable></td>
@ -87,7 +87,7 @@
</tr>
<tr>
<td><option>http_connect_timeout</option> = <replaceable>None</replaceable></td>
<td>(BoolOpt) Request timeout value for communicating with Identity API server.</td>
<td>(IntOpt) Request timeout value for communicating with Identity API server.</td>
</tr>
<tr>
<td><option>http_request_max_retries</option> = <replaceable>3</replaceable></td>
@ -99,7 +99,7 @@
</tr>
<tr>
<td><option>include_service_catalog</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.</td>
<td>(BoolOpt) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.</td>
</tr>
<tr>
<td><option>insecure</option> = <replaceable>False</replaceable></td>
@ -107,15 +107,15 @@
</tr>
<tr>
<td><option>keyfile</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Required if Keystone server requires client certificate</td>
<td>(StrOpt) Required if identity server requires client certificate</td>
</tr>
<tr>
<td><option>memcache_secret_key</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation.</td>
<td>(StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.</td>
</tr>
<tr>
<td><option>memcache_security_strategy</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) (optional) if defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.</td>
<td>(StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.</td>
</tr>
<tr>
<td><option>revocation_cache_time</option> = <replaceable>10</replaceable></td>
@ -123,7 +123,7 @@
</tr>
<tr>
<td><option>signing_dir</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Directory used to cache files related to PKI tokens</td>
<td>(StrOpt) Directory used to cache files related to PKI tokens.</td>
</tr>
<tr>
<td><option>token_cache_time</option> = <replaceable>300</replaceable></td>

50
doc/common/tables/cinder-cloudbyte.xml Normal file
View File

@ -0,0 +1,50 @@
<?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_cinder_cloudbyte">
<caption>Description of CloudByte volume driver 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><option>cb_account_name</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) CloudByte storage specific account name. This maps to a project name in OpenStack.</td>
</tr>
<tr>
<td><option>cb_add_qosgroup</option> = <replaceable>{'latency': '15', 'iops': '10', 'graceallowed': 'false', 'iopscontrol': 'true', 'memlimit': '0', 'throughput': '0', 'tpcontrol': 'false', 'networkspeed': '0'}</replaceable></td>
<td>(DictOpt) These values will be used for CloudByte storage's addQos API call.</td>
</tr>
<tr>
<td><option>cb_apikey</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Driver will use this API key to authenticate against the CloudByte storage's management interface.</td>
</tr>
<tr>
<td><option>cb_confirm_volume_create_retries</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) Will confirm a successful volume creation in CloudByte storage by making this many number of attempts.</td>
</tr>
<tr>
<td><option>cb_confirm_volume_create_retry_interval</option> = <replaceable>5</replaceable></td>
<td>(IntOpt) A retry value in seconds. Will be used by the driver to check if volume creation was successful in CloudByte storage.</td>
</tr>
<tr>
<td><option>cb_create_volume</option> = <replaceable>{'compression': 'off', 'deduplication': 'off', 'blocklength': '512B', 'sync': 'always', 'protocoltype': 'ISCSI', 'recordsize': '16k'}</replaceable></td>
<td>(DictOpt) These values will be used for CloudByte storage's createVolume API call.</td>
</tr>
<tr>
<td><option>cb_tsm_name</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) This corresponds to the name of Tenant Storage Machine (TSM) in CloudByte storage. A volume will be created in this TSM.</td>
</tr>
</tbody>
</table>
</para>

26
doc/common/tables/cinder-drbd.xml Normal file
View File

@ -0,0 +1,26 @@
<?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_cinder_drbd">
<caption>Description of DRBD 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><option>drbdmanage_redundancy</option> = <replaceable>1</replaceable></td>
<td>(StrOpt) Number of nodes that should replicate the data.</td>
</tr>
</tbody>
</table>
</para>

8
doc/common/tables/cinder-solidfire.xml
View File

@ -21,6 +21,10 @@
<td><option>sf_account_prefix</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Create SolidFire accounts with this prefix. Any string can be used here, but the string "hostname" is special and will create a prefix using the cinder node hostsname (previous default behavior). The default is NO prefix.</td>
</tr>
<tr>
<td><option>sf_allow_template_caching</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Create an internal cache of copy of images when a bootable volume is created to eliminate fetch from glance and qemu-conversion on subsequent calls.</td>
</tr>
<tr>
<td><option>sf_allow_tenant_qos</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Allow tenants to specify QOS on create</td>
@ -33,6 +37,10 @@
<td><option>sf_emulate_512</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Set 512 byte emulation on volume creation;</td>
</tr>
<tr>
<td><option>sf_template_account_name</option> = <replaceable>openstack-vtemplate</replaceable></td>
<td>(StrOpt) Account name on the SolidFire Cluster to use as owner of template/cache volumes (created if doesnt exist).</td>
</tr>
</tbody>
</table>
</para>

2
doc/common/tables/cinder-storage.xml
View File

@ -74,7 +74,7 @@
<td>(IntOpt) The port that the iSER daemon is listening on</td>
</tr>
<tr>
<td><option>iser_target_prefix</option> = <replaceable>iqn.2010-10.org.iser.openstack:</replaceable></td>
<td><option>iser_target_prefix</option> = <replaceable>iqn.2010-10.org.openstack:</replaceable></td>
<td>(StrOpt) Prefix for iSER volumes</td>
</tr>
<tr>

2
doc/common/tables/cinder-storpool.xml
View File

@ -4,7 +4,7 @@
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_cinder_storpool">
<caption>Description of storpool configuration options</caption>
<caption>Description of StorPool volume driver configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>

2
doc/common/tables/cinder-xio.xml
View File

@ -4,7 +4,7 @@
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_cinder_xio">
<caption>Description of xio configuration options</caption>
<caption>Description of X-IO volume driver configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>

30
doc/common/tables/glance-auth_token.xml
View File

@ -19,11 +19,11 @@
</tr>
<tr>
<td><option>admin_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Keystone account password</td>
<td>(StrOpt) Service user password.</td>
</tr>
<tr>
<td><option>admin_tenant_name</option> = <replaceable>admin</replaceable></td>
<td>(StrOpt) Keystone service account tenant name to validate user tokens</td>
<td>(StrOpt) Service tenant name.</td>
</tr>
<tr>
<td><option>admin_token</option> = <replaceable>None</replaceable></td>
@ -31,7 +31,7 @@
</tr>
<tr>
<td><option>admin_user</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Keystone account username</td>
<td>(StrOpt) Service username.</td>
</tr>
<tr>
<td><option>auth_admin_prefix</option> = <replaceable></replaceable></td>
@ -51,15 +51,15 @@
</tr>
<tr>
<td><option>auth_uri</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Complete public Identity API endpoint</td>
<td>(StrOpt) Complete public Identity API endpoint.</td>
</tr>
<tr>
<td><option>auth_version</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) API version of the admin Identity API endpoint</td>
<td>(StrOpt) API version of the admin Identity API endpoint.</td>
</tr>
<tr>
<td><option>cache</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Env key for the swift cache</td>
<td>(StrOpt) Env key for the swift cache.</td>
</tr>
<tr>
<td><option>cafile</option> = <replaceable>None</replaceable></td>
@ -67,15 +67,15 @@
</tr>
<tr>
<td><option>certfile</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Required if Keystone server requires client certificate</td>
<td>(StrOpt) Required if identity server requires client certificate</td>
</tr>
<tr>
<td><option>check_revocations_for_cached</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the Keystone server.</td>
<td>(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server.</td>
</tr>
<tr>
<td><option>delay_auth_decision</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components</td>
<td>(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components.</td>
</tr>
<tr>
<td><option>enforce_token_bind</option> = <replaceable>permissive</replaceable></td>
@ -87,7 +87,7 @@
</tr>
<tr>
<td><option>http_connect_timeout</option> = <replaceable>None</replaceable></td>
<td>(BoolOpt) Request timeout value for communicating with Identity API server.</td>
<td>(IntOpt) Request timeout value for communicating with Identity API server.</td>
</tr>
<tr>
<td><option>http_request_max_retries</option> = <replaceable>3</replaceable></td>
@ -99,7 +99,7 @@
</tr>
<tr>
<td><option>include_service_catalog</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.</td>
<td>(BoolOpt) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.</td>
</tr>
<tr>
<td><option>insecure</option> = <replaceable>False</replaceable></td>
@ -107,15 +107,15 @@
</tr>
<tr>
<td><option>keyfile</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Required if Keystone server requires client certificate</td>
<td>(StrOpt) Required if identity server requires client certificate</td>
</tr>
<tr>
<td><option>memcache_secret_key</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation.</td>
<td>(StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.</td>
</tr>
<tr>
<td><option>memcache_security_strategy</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) (optional) if defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.</td>
<td>(StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.</td>
</tr>
<tr>
<td><option>revocation_cache_time</option> = <replaceable>10</replaceable></td>
@ -123,7 +123,7 @@
</tr>
<tr>
<td><option>signing_dir</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Directory used to cache files related to PKI tokens</td>
<td>(StrOpt) Directory used to cache files related to PKI tokens.</td>
</tr>
<tr>
<td><option>token_cache_time</option> = <replaceable>300</replaceable></td>

2
doc/common/tables/glance-common.xml
View File

@ -90,7 +90,7 @@
<td>(StrOpt) Set a system wide quota for every user. This value is the total capacity that a user can use across all storage systems. A value of 0 means unlimited.Optional unit can be specified for the value. Accepted units are B, KB, MB, GB and TB representing Bytes, KiloBytes, MegaBytes, GigaBytes and TeraBytes respectively. If no unit is specified then Bytes is assumed. Note that there should not be any space between value and unit and units are case sensitive.</td>
</tr>
<tr>
<td><option>workers</option> = <replaceable>8</replaceable></td>
<td><option>workers</option> = <replaceable>4</replaceable></td>
<td>(IntOpt) The number of child process workers that will be created to service requests. The default will be equal to the number of CPUs available.</td>
</tr>
<tr>

30
doc/common/tables/heat-auth_token.xml
View File

@ -19,11 +19,11 @@
</tr>
<tr>
<td><option>admin_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Keystone account password</td>
<td>(StrOpt) Service user password.</td>
</tr>
<tr>
<td><option>admin_tenant_name</option> = <replaceable>admin</replaceable></td>
<td>(StrOpt) Keystone service account tenant name to validate user tokens</td>
<td>(StrOpt) Service tenant name.</td>
</tr>
<tr>
<td><option>admin_token</option> = <replaceable>None</replaceable></td>
@ -31,7 +31,7 @@
</tr>
<tr>
<td><option>admin_user</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Keystone account username</td>
<td>(StrOpt) Service username.</td>
</tr>
<tr>
<td><option>auth_admin_prefix</option> = <replaceable></replaceable></td>
@ -51,15 +51,15 @@
</tr>
<tr>
<td><option>auth_uri</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Complete public Identity API endpoint</td>
<td>(StrOpt) Complete public Identity API endpoint.</td>
</tr>
<tr>
<td><option>auth_version</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) API version of the admin Identity API endpoint</td>
<td>(StrOpt) API version of the admin Identity API endpoint.</td>
</tr>
<tr>
<td><option>cache</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Env key for the swift cache</td>
<td>(StrOpt) Env key for the swift cache.</td>
</tr>
<tr>
<td><option>cafile</option> = <replaceable>None</replaceable></td>
@ -67,15 +67,15 @@
</tr>
<tr>
<td><option>certfile</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Required if Keystone server requires client certificate</td>
<td>(StrOpt) Required if identity server requires client certificate</td>
</tr>
<tr>
<td><option>check_revocations_for_cached</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the Keystone server.</td>
<td>(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server.</td>
</tr>
<tr>
<td><option>delay_auth_decision</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components</td>
<td>(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components.</td>
</tr>
<tr>
<td><option>enforce_token_bind</option> = <replaceable>permissive</replaceable></td>
@ -87,7 +87,7 @@
</tr>
<tr>
<td><option>http_connect_timeout</option> = <replaceable>None</replaceable></td>
<td>(BoolOpt) Request timeout value for communicating with Identity API server.</td>
<td>(IntOpt) Request timeout value for communicating with Identity API server.</td>
</tr>
<tr>
<td><option>http_request_max_retries</option> = <replaceable>3</replaceable></td>
@ -99,7 +99,7 @@
</tr>
<tr>
<td><option>include_service_catalog</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.</td>
<td>(BoolOpt) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.</td>
</tr>
<tr>
<td><option>insecure</option> = <replaceable>False</replaceable></td>
@ -107,15 +107,15 @@
</tr>
<tr>
<td><option>keyfile</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Required if Keystone server requires client certificate</td>
<td>(StrOpt) Required if identity server requires client certificate</td>
</tr>
<tr>
<td><option>memcache_secret_key</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation.</td>
<td>(StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.</td>
</tr>
<tr>
<td><option>memcache_security_strategy</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) (optional) if defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.</td>
<td>(StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.</td>
</tr>
<tr>
<td><option>revocation_cache_time</option> = <replaceable>10</replaceable></td>
@ -123,7 +123,7 @@
</tr>
<tr>
<td><option>signing_dir</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Directory used to cache files related to PKI tokens</td>
<td>(StrOpt) Directory used to cache files related to PKI tokens.</td>
</tr>
<tr>
<td><option>token_cache_time</option> = <replaceable>300</replaceable></td>

26
doc/common/tables/ironic-amqp.xml
View File

@ -18,58 +18,58 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>amqp_auto_delete = False</td>
<td><option>amqp_auto_delete</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Auto-delete queues in AMQP.</td>
</tr>
<tr>
<td>amqp_durable_queues = False</td>
<td><option>amqp_durable_queues</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Use durable queues in AMQP.</td>
</tr>
<tr>
<td>control_exchange = openstack</td>
<td><option>control_exchange</option> = <replaceable>openstack</replaceable></td>
<td>(StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.</td>
</tr>
<tr>
<td>notification_driver = []</td>
<td><option>notification_driver</option> = <replaceable>[]</replaceable></td>
<td>(MultiStrOpt) Driver or drivers to handle sending notifications.</td>
</tr>
<tr>
<td>notification_topics = notifications</td>
<td><option>notification_topics</option> = <replaceable>notifications</replaceable></td>
<td>(ListOpt) AMQP topic used for OpenStack notifications.</td>
</tr>
<tr>
<td>transport_url = None</td>
<td><option>transport_url</option> = <replaceable>None</replaceable></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>
<tr>
<th colspan="2">[oslo_messaging_amqp]</th>
</tr>
<tr>
<td>allow_insecure_clients = False</td>
<td><option>allow_insecure_clients</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Accept clients using either SSL or plain TCP</td>
</tr>
<tr>
<td>broadcast_prefix = broadcast</td>
<td><option>broadcast_prefix</option> = <replaceable>broadcast</replaceable></td>
<td>(StrOpt) address prefix used when broadcasting to all servers</td>
</tr>
<tr>
<td>container_name = None</td>
<td><option>container_name</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Name for the AMQP container</td>
</tr>
<tr>
<td>group_request_prefix = unicast</td>
<td><option>group_request_prefix</option> = <replaceable>unicast</replaceable></td>
<td>(StrOpt) address prefix when sending to any server in group</td>
</tr>
<tr>
<td>idle_timeout = 0</td>
<td><option>idle_timeout</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) Timeout for inactive connections (in seconds)</td>
</tr>
<tr>
<td>server_request_prefix = exclusive</td>
<td><option>server_request_prefix</option> = <replaceable>exclusive</replaceable></td>
<td>(StrOpt) address prefix used when sending to a specific server</td>
</tr>
<tr>
<td>trace = False</td>
<td><option>trace</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Debug: dump AMQP frames to stdout</td>
</tr>
</tbody>

25
doc/common/tables/ironic-api.xml
View File

@ -14,19 +14,38 @@
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>api_paste_config</option> = <replaceable>api-paste.ini</replaceable></td>
<td>(StrOpt) File name for the paste.deploy config for nova-api</td>
</tr>
<tr>
<td><option>api_rate_limit</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Whether to use per-user rate limiting for the api. This option is only used by v2 api. Rate limiting is removed from v3 api.</td>
</tr>
<tr>
<td><option>client_socket_timeout</option> = <replaceable>900</replaceable></td>
<td>(IntOpt) Timeout for client connections' socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of '0' means wait forever.</td>
</tr>
<tr>
<td><option>use_forwarded_for</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Treat X-Forwarded-For as the canonical remote address. Only enable this if you have a sanitizing proxy.</td>
</tr>
<tr>
<th colspan="2">[api]</th>
</tr>
<tr>
<td>host_ip = 0.0.0.0</td>
<td><option>host_ip</option> = <replaceable>0.0.0.0</replaceable></td>
<td>(StrOpt) The listen IP for the Ironic API server.</td>
</tr>
<tr>
<td>max_limit = 1000</td>
<td><option>max_limit</option> = <replaceable>1000</replaceable></td>
<td>(IntOpt) The maximum number of items returned in a single response from a collection resource.</td>
</tr>
<tr>
<td>port = 6385</td>
<td><option>port</option> = <replaceable>6385</replaceable></td>
<td>(IntOpt) The port for the Ironic API server.</td>
</tr>
</tbody>

4
doc/common/tables/ironic-auth.xml
View File

@ -18,8 +18,8 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>auth_strategy = keystone</td>
<td>(StrOpt) Method to use for authentication: noauth or keystone.</td>
<td><option>auth_strategy</option> = <replaceable>keystone</replaceable></td>
<td>(StrOpt) The strategy to use for auth: noauth or keystone.</td>
</tr>
</tbody>
</table>

120
doc/common/tables/ironic-auth_token.xml
View File

@ -18,143 +18,151 @@
<th colspan="2">[keystone_authtoken]</th>
</tr>
<tr>
<td>admin_password = None</td>
<td>(StrOpt) Keystone account password</td>
<td><option>admin_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Service user password.</td>
</tr>
<tr>
<td>admin_tenant_name = admin</td>
<td>(StrOpt) Keystone service account tenant name to validate user tokens</td>
<td><option>admin_tenant_name</option> = <replaceable>admin</replaceable></td>
<td>(StrOpt) Service tenant name.</td>
</tr>
<tr>
<td>admin_token = None</td>
<td><option>admin_token</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead.</td>
</tr>
<tr>
<td>admin_user = None</td>
<td>(StrOpt) Keystone account username</td>
<td><option>admin_user</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Service username.</td>
</tr>
<tr>
<td>auth_admin_prefix = </td>
<td><option>auth_admin_prefix</option> = <replaceable></replaceable></td>
<td>(StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri.</td>
</tr>
<tr>
<td>auth_host = 127.0.0.1</td>
<td><option>auth_host</option> = <replaceable>127.0.0.1</replaceable></td>
<td>(StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri.</td>
</tr>
<tr>
<td>auth_port = 35357</td>
<td><option>auth_plugin</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Name of the plugin to load</td>
</tr>
<tr>
<td><option>auth_port</option> = <replaceable>35357</replaceable></td>
<td>(IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri.</td>
</tr>
<tr>
<td>auth_protocol = https</td>
<td><option>auth_protocol</option> = <replaceable>https</replaceable></td>
<td>(StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri.</td>
</tr>
<tr>
<td>auth_uri = None</td>
<td>(StrOpt) Complete public Identity API endpoint</td>
<td><option>auth_section</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Config Section from which to load plugin specific options</td>
</tr>
<tr>
<td>auth_version = None</td>
<td>(StrOpt) API version of the admin Identity API endpoint</td>
<td><option>auth_uri</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Complete public Identity API endpoint.</td>
</tr>
<tr>
<td>cache = None</td>
<td>(StrOpt) Env key for the swift cache</td>
<td><option>auth_version</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) API version of the admin Identity API endpoint.</td>
</tr>
<tr>
<td>cafile = None</td>
<td><option>cache</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Env key for the swift cache.</td>
</tr>
<tr>
<td><option>cafile</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.</td>
</tr>
<tr>
<td>certfile = None</td>
<td>(StrOpt) Required if Keystone server requires client certificate</td>
<td><option>certfile</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Required if identity server requires client certificate</td>
</tr>
<tr>
<td>check_revocations_for_cached = False</td>
<td>(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the Keystone server.</td>
<td><option>check_revocations_for_cached</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server.</td>
</tr>
<tr>
<td>delay_auth_decision = False</td>
<td>(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components</td>
<td><option>delay_auth_decision</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components.</td>
</tr>
<tr>
<td>enforce_token_bind = permissive</td>
<td><option>enforce_token_bind</option> = <replaceable>permissive</replaceable></td>
<td>(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens.</td>
</tr>
<tr>
<td>hash_algorithms = md5</td>
<td><option>hash_algorithms</option> = <replaceable>md5</replaceable></td>
<td>(ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance.</td>
</tr>
<tr>
<td>http_connect_timeout = None</td>
<td>(BoolOpt) Request timeout value for communicating with Identity API server.</td>
<td><option>http_connect_timeout</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) Request timeout value for communicating with Identity API server.</td>
</tr>
<tr>
<td>http_request_max_retries = 3</td>
<td><option>http_request_max_retries</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server.</td>
</tr>
<tr>
<td>identity_uri = None</td>
<td><option>identity_uri</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/</td>
</tr>
<tr>
<td>include_service_catalog = True</td>
<td>(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.</td>
<td><option>include_service_catalog</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.</td>
</tr>
<tr>
<td>insecure = False</td>
<td><option>insecure</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Verify HTTPS connections.</td>
</tr>
<tr>
<td>keyfile = None</td>
<td>(StrOpt) Required if Keystone server requires client certificate</td>
<td><option>keyfile</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Required if identity server requires client certificate</td>
</tr>
<tr>
<td>memcache_pool_conn_get_timeout = 10</td>
<td>(IntOpt) (optional) number of seconds that an operation will wait to get a memcache client connection from the pool.</td>
<td><option>memcache_pool_conn_get_timeout</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) (Optional) Number of seconds that an operation will wait to get a memcache client connection from the pool.</td>
</tr>
<tr>
<td>memcache_pool_dead_retry = 300</td>
<td>(IntOpt) (optional) number of seconds memcached server is considered dead before it is tried again.</td>
<td><option>memcache_pool_dead_retry</option> = <replaceable>300</replaceable></td>
<td>(IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again.</td>
</tr>
<tr>
<td>memcache_pool_maxsize = 10</td>
<td>(IntOpt) (optional) max total number of open connections to every memcached server.</td>
<td><option>memcache_pool_maxsize</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) (Optional) Maximum total number of open connections to every memcached server.</td>
</tr>
<tr>
<td>memcache_pool_socket_timeout = 3</td>
<td>(IntOpt) (optional) socket timeout in seconds for communicating with a memcache server.</td>
<td><option>memcache_pool_socket_timeout</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) (Optional) Socket timeout in seconds for communicating with a memcache server.</td>
</tr>
<tr>
<td>memcache_pool_unused_timeout = 60</td>
<td>(IntOpt) (optional) number of seconds a connection to memcached is held unused in the pool before it is closed.</td>
<td><option>memcache_pool_unused_timeout</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed.</td>
</tr>
<tr>
<td>memcache_secret_key = None</td>
<td>(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation.</td>
<td><option>memcache_secret_key</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.</td>
</tr>
<tr>
<td>memcache_security_strategy = None</td>
<td>(StrOpt) (optional) if defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.</td>
<td><option>memcache_security_strategy</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.</td>
</tr>
<tr>
<td>memcache_use_advanced_pool = False</td>
<td>(BoolOpt) (optional) use the advanced (eventlet safe) memcache client pool. The advanced pool will only work under python 2.x.</td>
<td><option>memcache_use_advanced_pool</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) (Optional) Use the advanced (eventlet safe) memcache client pool. The advanced pool will only work under python 2.x.</td>
</tr>
<tr>
<td>memcached_servers = None</td>
<td><option>memcached_servers</option> = <replaceable>None</replaceable></td>
<td>(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.</td>
</tr>
<tr>
<td>revocation_cache_time = 10</td>
<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>
</tr>
<tr>
<td>signing_dir = None</td>
<td>(StrOpt) Directory used to cache files related to PKI tokens</td>
<td><option>signing_dir</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Directory used to cache files related to PKI tokens.</td>
</tr>
<tr>
<td>token_cache_time = 300</td>
<td><option>token_cache_time</option> = <replaceable>300</replaceable></td>
<td>(IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely.</td>
</tr>
</tbody>

8
doc/common/tables/ironic-ca.xml
View File

@ -18,19 +18,19 @@
<th colspan="2">[oslo_messaging_amqp]</th>
</tr>
<tr>
<td>ssl_ca_file = </td>
<td><option>ssl_ca_file</option> = <replaceable></replaceable></td>
<td>(StrOpt) CA certificate PEM file for verifing server certificate</td>
</tr>
<tr>
<td>ssl_cert_file = </td>
<td><option>ssl_cert_file</option> = <replaceable></replaceable></td>
<td>(StrOpt) Identifying certificate PEM file to present to clients</td>
</tr>
<tr>
<td>ssl_key_file = </td>
<td><option>ssl_key_file</option> = <replaceable></replaceable></td>
<td>(StrOpt) Private key PEM file used to sign cert_file certificate</td>
</tr>
<tr>
<td>ssl_key_password = None</td>
<td><option>ssl_key_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Password for decrypting ssl_key_file (if encrypted)</td>
</tr>
</tbody>

78
doc/common/tables/ironic-common.xml
View File

@ -18,76 +18,64 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>bindir = /usr/local/bin</td>
<td><option>bindir</option> = <replaceable>/usr/local/bin</replaceable></td>
<td>(StrOpt) Directory where ironic binaries are installed.</td>
</tr>
<tr>
<td>enabled_drivers = pxe_ipmitool</td>
<td>(ListOpt) Specify the list of drivers to load during service initialization. Missing drivers, or drivers which fail to initialize, will prevent the conductor service from starting. The option default is a recommended set of production-oriented drivers. A complete list of drivers present on your system may be found by enumerating the "ironic.drivers" entrypoint. An example may be found in the developer documentation online.</td>
</tr>
<tr>
<td>fatal_deprecations = False</td>
<td><option>fatal_deprecations</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enables or disables fatal status of deprecations.</td>
</tr>
<tr>
<td>force_raw_images = True</td>
<td>(BoolOpt) Force backing images to raw format.</td>
<td><option>max_header_line</option> = <replaceable>16384</replaceable></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>hash_distribution_replicas = 1</td>
<td>(IntOpt) [Experimental Feature] Number of hosts to map onto each hash partition. Setting this to more than one will cause additional conductor services to prepare deployment environments and potentially allow the Ironic cluster to recover more quickly if a conductor instance is terminated.</td>
</tr>
<tr>
<td>hash_partition_exponent = 5</td>
<td>(IntOpt) Exponent to determine number of hash partitions to use when distributing load across conductors. Larger values will result in more even distribution of load and less load when rebalancing the ring, but more memory usage. Number of partitions per conductor is (2^hash_partition_exponent). This determines the granularity of rebalancing: given 10 hosts, and an exponent of the 2, there are 40 partitions in the ring.A few thousand partitions should make rebalancing smooth in most cases. The default is suitable for up to a few hundred conductors. Too many partitions has a CPU impact.</td>
</tr>
<tr>
<td>host = localhost</td>
<td>(StrOpt) Name of this node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address. However, the node name must be valid within an AMQP key, and if using ZeroMQ, a valid hostname, FQDN, or IP address.</td>
</tr>
<tr>
<td>isolinux_bin = /usr/lib/syslinux/isolinux.bin</td>
<td>(StrOpt) Path to isolinux binary file.</td>
</tr>
<tr>
<td>isolinux_config_template = $pybasedir/common/isolinux_config.template</td>
<td>(StrOpt) Template file for isolinux configuration file.</td>
</tr>
<tr>
<td>memcached_servers = None</td>
<td><option>memcached_servers</option> = <replaceable>None</replaceable></td>
<td>(ListOpt) Memcached servers or None for in process cache.</td>
</tr>
<tr>
<td>my_ip = 10.0.0.1</td>
<td><option>monkey_patch</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Whether to log monkey patching</td>
</tr>
<tr>
<td><option>monkey_patch_modules</option> = <replaceable>nova.api.ec2.cloud:nova.notifications.notify_decorator, nova.compute.api:nova.notifications.notify_decorator</replaceable></td>
<td>(ListOpt) List of modules/decorators to monkey patch</td>
</tr>
<tr>
<td><option>my_ip</option> = <replaceable>10.0.0.1</replaceable></td>
<td>(StrOpt) IP address of this host.</td>
</tr>
<tr>
<td>parallel_image_downloads = False</td>
<td>(BoolOpt) Run image downloads and raw format conversions in parallel.</td>
</tr>
<tr>
<td>periodic_interval = 60</td>
<td>(IntOpt) Seconds between running periodic tasks.</td>
</tr>
<tr>
<td>pybasedir = /usr/lib/python/site-packages/ironic/ironic</td>
<td><option>pybasedir</option> = <replaceable>/usr/lib/python/site-packages/ironic/ironic</replaceable></td>
<td>(StrOpt) Directory where the ironic python module is installed.</td>
</tr>
<tr>
<td>rootwrap_config = /etc/ironic/rootwrap.conf</td>
<td>(StrOpt) Path to the rootwrap configuration file to use for running commands as root.</td>
<td><option>rootwrap_config</option> = <replaceable>/etc/nova/rootwrap.conf</replaceable></td>
<td>(StrOpt) Path to the rootwrap configuration file to use for running commands as root</td>
</tr>
<tr>
<td>run_external_periodic_tasks = True</td>
<td><option>run_external_periodic_tasks</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Some periodic tasks can be run in a separate process. Should we run them here?</td>
</tr>
<tr>
<td>state_path = $pybasedir</td>
<td><option>state_path</option> = <replaceable>$pybasedir</replaceable></td>
<td>(StrOpt) Top-level directory for maintaining ironic's state.</td>
</tr>
<tr>
<td>tempdir = None</td>
<td>(StrOpt) Explicitly specify the temporary working directory.</td>
<td><option>tcp_keepidle</option> = <replaceable>600</replaceable></td>
<td>(IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X.</td>
</tr>
<tr>
<td><option>tempdir</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Explicitly specify the temporary working directory</td>
</tr>
<tr>
<td><option>wsgi_default_pool_size</option> = <replaceable>1000</replaceable></td>
<td>(IntOpt) Size of the pool of greenthreads used by wsgi</td>
</tr>
<tr>
<td><option>wsgi_keep_alive</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) If False, closes the client socket connection explicitly.</td>
</tr>
</tbody>
</table>

26
doc/common/tables/ironic-compute.xml Normal file
View File

@ -0,0 +1,26 @@
<?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_ironic_compute">
<caption>Description of Compute 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><option>compute_driver</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Driver to use for controlling virtualization. Options include: libvirt.LibvirtDriver, xenapi.XenAPIDriver, fake.FakeDriver, baremetal.BareMetalDriver, vmwareapi.VMwareVCDriver, hyperv.HyperVDriver</td>
</tr>
</tbody>
</table>
</para>

46
doc/common/tables/ironic-database.xml
View File

@ -18,89 +18,93 @@
<th colspan="2">[database]</th>
</tr>
<tr>
<td>backend = sqlalchemy</td>
<td><option>backend</option> = <replaceable>sqlalchemy</replaceable></td>
<td>(StrOpt) The back end to use for the database.</td>
</tr>
<tr>
<td>connection = None</td>
<td><option>connection</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The SQLAlchemy connection string to use to connect to the database.</td>
</tr>
<tr>
<td>connection_debug = 0</td>
<td><option>connection_debug</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything.</td>
</tr>
<tr>
<td>connection_trace = False</td>
<td><option>connection_trace</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Add Python stack traces to SQL as comment strings.</td>
</tr>
<tr>
<td>db_inc_retry_interval = True</td>
<td><option>db_inc_retry_interval</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) If True, increases the interval between database connection retries up to db_max_retry_interval.</td>
</tr>
<tr>
<td>db_max_retries = 20</td>
<td><option>db_max_retries</option> = <replaceable>20</replaceable></td>
<td>(IntOpt) Maximum database connection retries before error is raised. Set to -1 to specify an infinite retry count.</td>
</tr>
<tr>
<td>db_max_retry_interval = 10</td>
<td><option>db_max_retry_interval</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) If db_inc_retry_interval is set, the maximum seconds between database connection retries.</td>
</tr>
<tr>
<td>db_retry_interval = 1</td>
<td><option>db_retry_interval</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Seconds between database connection retries.</td>
</tr>
<tr>
<td>idle_timeout = 3600</td>
<td><option>idle_timeout</option> = <replaceable>3600</replaceable></td>
<td>(IntOpt) Timeout before idle SQL connections are reaped.</td>
</tr>
<tr>
<td>max_overflow = None</td>
<td><option>max_overflow</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) If set, use this value for max_overflow with SQLAlchemy.</td>
</tr>
<tr>
<td>max_pool_size = None</td>
<td><option>max_pool_size</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) Maximum number of SQL connections to keep open in a pool.</td>
</tr>
<tr>
<td>max_retries = 10</td>
<td><option>max_retries</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.</td>
</tr>
<tr>
<td>min_pool_size = 1</td>
<td><option>min_pool_size</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Minimum number of SQL connections to keep open in a pool.</td>
</tr>
<tr>
<td>mysql_engine = InnoDB</td>
<td><option>mysql_engine</option> = <replaceable>InnoDB</replaceable></td>
<td>(StrOpt) MySQL engine to use.</td>
</tr>
<tr>
<td>mysql_sql_mode = TRADITIONAL</td>
<td><option>mysql_sql_mode</option> = <replaceable>TRADITIONAL</replaceable></td>
<td>(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=</td>
</tr>
<tr>
<td>pool_timeout = None</td>
<td><option>pool_timeout</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) If set, use this value for pool_timeout with SQLAlchemy.</td>
</tr>
<tr>
<td>retry_interval = 10</td>
<td><option>retry_interval</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Interval between retries of opening a SQL connection.</td>
</tr>
<tr>
<td>slave_connection = None</td>
<td><option>slave_connection</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The SQLAlchemy connection string to use to connect to the slave database.</td>
</tr>
<tr>
<td>sqlite_db = oslo.sqlite</td>
<td><option>sqlite_db</option> = <replaceable>oslo.sqlite</replaceable></td>
<td>(StrOpt) The file name to use with SQLite.</td>
</tr>
<tr>
<td>sqlite_synchronous = True</td>
<td><option>sqlite_synchronous</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) If True, SQLite uses synchronous mode.</td>
</tr>
<tr>
<td>use_db_reconnect = False</td>
<td><option>use_db_reconnect</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enable the experimental use of database reconnect on connection lost.</td>
</tr>
<tr>
<td><option>use_tpool</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enable the experimental use of thread pooling for all DB API calls</td>
</tr>
</tbody>
</table>
</para>

2
doc/common/tables/ironic-debug.xml
View File

@ -18,7 +18,7 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>backdoor_port = None</td>
<td><option>backdoor_port</option> = <replaceable>None</replaceable></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>
</tbody>

50
doc/common/tables/ironic-glance.xml
View File

@ -18,60 +18,60 @@
<th colspan="2">[glance]</th>
</tr>
<tr>
<td>allowed_direct_url_schemes = </td>
<td>(ListOpt) A list of URL schemes that can be downloaded directly via the direct_url. Currently supported schemes: [file].</td>
<td><option>allowed_direct_url_schemes</option> = <replaceable></replaceable></td>
<td>(ListOpt) A list of url scheme that can be downloaded directly via the direct_url. Currently supported schemes: [file].</td>
</tr>
<tr>
<td>auth_strategy = keystone</td>
<td><option>api_insecure</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Allow to perform insecure SSL (https) requests to glance</td>
</tr>
<tr>
<td><option>api_servers</option> = <replaceable>None</replaceable></td>
<td>(ListOpt) A list of the glance api servers available to nova. Prefix with https:// for ssl-based glance api servers. ([hostname|ip]:port)</td>
</tr>
<tr>
<td><option>auth_strategy</option> = <replaceable>keystone</replaceable></td>
<td>(StrOpt) Default protocol to use when connecting to glance. Set to https for SSL.</td>
</tr>
<tr>
<td>glance_api_insecure = False</td>
<td><option>glance_api_insecure</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Allow to perform insecure SSL (https) requests to glance.</td>
</tr>
<tr>
<td>glance_api_servers = None</td>
<td><option>glance_api_servers</option> = <replaceable>None</replaceable></td>
<td>(ListOpt) A list of the glance api servers available to ironic. Prefix with https:// for SSL-based glance API servers. Format is [hostname|IP]:port.</td>
</tr>
<tr>
<td>glance_host = $my_ip</td>
<td><option>glance_host</option> = <replaceable>$my_ip</replaceable></td>
<td>(StrOpt) Default glance hostname or IP address.</td>
</tr>
<tr>
<td>glance_num_retries = 0</td>
<td><option>glance_num_retries</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) Number of retries when downloading an image from glance.</td>
</tr>
<tr>
<td>glance_port = 9292</td>
<td><option>glance_port</option> = <replaceable>9292</replaceable></td>
<td>(IntOpt) Default glance port.</td>
</tr>
<tr>
<td>glance_protocol = http</td>
<td><option>glance_protocol</option> = <replaceable>http</replaceable></td>
<td>(StrOpt) Default protocol to use when connecting to glance. Set to https for SSL.</td>
</tr>
<tr>
<td>swift_account = None</td>
<td>(StrOpt) The account that Glance uses to communicate with Swift. The format is "AUTH_uuid". "uuid" is the UUID for the account configured in the glance-api.conf. Required for temporary URLs. For example: "AUTH_a422b2-91f3-2f46-74b7-d7c9e8958f5d30". Swift temporary URL format: "endpoint_url/api_version/account/container/object_id"</td>
<td><option>host</option> = <replaceable>$my_ip</replaceable></td>
<td>(StrOpt) Default glance hostname or IP address</td>
</tr>
<tr>
<td>swift_api_version = v1</td>
<td>(StrOpt) The Swift API version to create a temporary URL for. Defaults to "v1". Swift temporary URL format: "endpoint_url/api_version/account/container/object_id"</td>
<td><option>num_retries</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) Number of retries when uploading / downloading an image to / from glance.</td>
</tr>
<tr>
<td>swift_container = glance</td>
<td>(StrOpt) The Swift container Glance is configured to store its images in. Defaults to "glance", which is the default in glance-api.conf. Swift temporary URL format: "endpoint_url/api_version/account/container/object_id"</td>
<td><option>port</option> = <replaceable>9292</replaceable></td>
<td>(IntOpt) Default glance port</td>
</tr>
<tr>
<td>swift_endpoint_url = None</td>
<td>(StrOpt) The "endpoint" (scheme, hostname, optional port) for the Swift URL of the form "endpoint_url/api_version/account/container/object_id". Do not include trailing "/". For example, use "https://swift.example.com". Required for temporary URLs.</td>
</tr>
<tr>
<td>swift_temp_url_duration = 1200</td>
<td>(IntOpt) The length of time in seconds that the temporary URL will be valid for. Defaults to 20 minutes. If some deploys get a 401 response code when trying to download from the temporary URL, try raising this duration.</td>
</tr>
<tr>
<td>swift_temp_url_key = None</td>
<td>(StrOpt) The secret token given to Swift to allow temporary URL downloads. Required for temporary URLs.</td>
<td><option>protocol</option> = <replaceable>http</replaceable></td>
<td>(StrOpt) Default protocol to use when connecting to glance. Set to https for SSL.</td>
</tr>
</tbody>
</table>

50
doc/common/tables/ironic-logging.xml
View File

@ -18,83 +18,91 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>debug = False</td>
<td><option>debug</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).</td>
</tr>
<tr>
<td>default_log_levels = 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</td>
<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, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN</replaceable></td>
<td>(ListOpt) List of logger=LEVEL pairs.</td>
</tr>
<tr>
<td>fatal_exception_format_errors = False</td>
<td>(BoolOpt) Make exception message format errors fatal.</td>
<td><option>fatal_exception_format_errors</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Make exception message format errors fatal</td>
</tr>
<tr>
<td>instance_format = "[instance: %(uuid)s] "</td>
<td><option>instance_format</option> = <replaceable>"[instance: %(uuid)s] "</replaceable></td>
<td>(StrOpt) The format for an instance that is passed with the log message.</td>
</tr>
<tr>
<td>instance_uuid_format = "[instance: %(uuid)s] "</td>
<td><option>instance_name_template</option> = <replaceable>instance-%08x</replaceable></td>
<td>(StrOpt) Template string to be used to generate instance names</td>
</tr>
<tr>
<td><option>instance_usage_audit_period</option> = <replaceable>month</replaceable></td>
<td>(StrOpt) Time period to generate instance usages for. Time period must be hour, day, month or year</td>
</tr>
<tr>
<td><option>instance_uuid_format</option> = <replaceable>"[instance: %(uuid)s] "</replaceable></td>
<td>(StrOpt) The format for an instance UUID that is passed with the log message.</td>
</tr>
<tr>
<td>log_config_append = None</td>
<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>
</tr>
<tr>
<td>log_date_format = %Y-%m-%d %H:%M:%S</td>
<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>
</tr>
<tr>
<td>log_dir = None</td>
<td><option>log_dir</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) (Optional) The base directory used for relative --log-file paths.</td>
</tr>
<tr>
<td>log_file = None</td>
<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>
</tr>
<tr>
<td>log_format = None</td>
<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>
</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><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>
<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><option>logging_debug_format_suffix</option> = <replaceable>%(funcName)s %(pathname)s:%(lineno)d</replaceable></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><option>logging_default_format_string</option> = <replaceable>%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s</replaceable></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><option>logging_exception_prefix</option> = <replaceable>%(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s</replaceable></td>
<td>(StrOpt) Prefix each line of exception output with this format.</td>
</tr>
<tr>
<td>publish_errors = False</td>
<td><option>publish_errors</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enables or disables publication of error events.</td>
</tr>
<tr>
<td>syslog_log_facility = LOG_USER</td>
<td><option>syslog_log_facility</option> = <replaceable>LOG_USER</replaceable></td>
<td>(StrOpt) Syslog facility to receive log lines.</td>
</tr>
<tr>
<td>use_stderr = True</td>
<td><option>use_stderr</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Log output to standard error.</td>
</tr>
<tr>
<td>use_syslog = False</td>
<td><option>use_syslog</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424.</td>
</tr>
<tr>
<td>use_syslog_rfc_format = False</td>
<td><option>use_syslog_rfc_format</option> = <replaceable>False</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 I, and will be removed in J.</td>
</tr>
<tr>
<td>verbose = False</td>
<td><option>verbose</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).</td>
</tr>
</tbody>

12
doc/common/tables/ironic-policy.xml
View File

@ -18,12 +18,16 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>policy_default_rule = default</td>
<td>(StrOpt) Rule checked when requested rule is not found.</td>
<td><option>policy_default_rule</option> = <replaceable>default</replaceable></td>
<td>(StrOpt) Default rule. Enforced when a requested rule is not found.</td>
</tr>
<tr>
<td>policy_file = policy.json</td>
<td>(StrOpt) JSON file representing policy.</td>
<td><option>policy_dirs</option> = <replaceable>['policy.d']</replaceable></td>
<td>(MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched.</td>
</tr>
<tr>
<td><option>policy_file</option> = <replaceable>policy.json</replaceable></td>
<td>(StrOpt) The JSON file that defines policies.</td>
</tr>
</tbody>
</table>

22
doc/common/tables/ironic-qpid.xml
View File

@ -18,47 +18,47 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>qpid_heartbeat = 60</td>
<td><option>qpid_heartbeat</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Seconds between connection keepalive heartbeats.</td>
</tr>
<tr>
<td>qpid_hostname = localhost</td>
<td><option>qpid_hostname</option> = <replaceable>localhost</replaceable></td>
<td>(StrOpt) Qpid broker hostname.</td>
</tr>
<tr>
<td>qpid_hosts = $qpid_hostname:$qpid_port</td>
<td><option>qpid_hosts</option> = <replaceable>$qpid_hostname:$qpid_port</replaceable></td>
<td>(ListOpt) Qpid HA cluster host:port pairs.</td>
</tr>
<tr>
<td>qpid_password = </td>
<td><option>qpid_password</option> = <replaceable></replaceable></td>
<td>(StrOpt) Password for Qpid connection.</td>
</tr>
<tr>
<td>qpid_port = 5672</td>
<td><option>qpid_port</option> = <replaceable>5672</replaceable></td>
<td>(IntOpt) Qpid broker port.</td>
</tr>
<tr>
<td>qpid_protocol = tcp</td>
<td><option>qpid_protocol</option> = <replaceable>tcp</replaceable></td>
<td>(StrOpt) Transport to use, either 'tcp' or 'ssl'.</td>
</tr>
<tr>
<td>qpid_receiver_capacity = 1</td>
<td><option>qpid_receiver_capacity</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) The number of prefetched messages held by receiver.</td>
</tr>
<tr>
<td>qpid_sasl_mechanisms = </td>
<td><option>qpid_sasl_mechanisms</option> = <replaceable></replaceable></td>
<td>(StrOpt) Space separated list of SASL mechanisms to use for auth.</td>
</tr>
<tr>
<td>qpid_tcp_nodelay = True</td>
<td><option>qpid_tcp_nodelay</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Whether to disable the Nagle algorithm.</td>
</tr>
<tr>
<td>qpid_topology_version = 1</td>
<td><option>qpid_topology_version</option> = <replaceable>1</replaceable></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>
<tr>
<td>qpid_username = </td>
<td><option>qpid_username</option> = <replaceable></replaceable></td>
<td>(StrOpt) Username for Qpid connection.</td>
</tr>
</tbody>

34
doc/common/tables/ironic-rabbitmq.xml
View File

@ -18,71 +18,71 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>kombu_reconnect_delay = 1.0</td>
<td><option>kombu_reconnect_delay</option> = <replaceable>1.0</replaceable></td>
<td>(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.</td>
</tr>
<tr>
<td>kombu_ssl_ca_certs = </td>
<td><option>kombu_ssl_ca_certs</option> = <replaceable></replaceable></td>
<td>(StrOpt) SSL certification authority file (valid only if SSL enabled).</td>
</tr>
<tr>
<td>kombu_ssl_certfile = </td>
<td><option>kombu_ssl_certfile</option> = <replaceable></replaceable></td>
<td>(StrOpt) SSL cert file (valid only if SSL enabled).</td>
</tr>
<tr>
<td>kombu_ssl_keyfile = </td>
<td><option>kombu_ssl_keyfile</option> = <replaceable></replaceable></td>
<td>(StrOpt) SSL key file (valid only if SSL enabled).</td>
</tr>
<tr>
<td>kombu_ssl_version = </td>
<td><option>kombu_ssl_version</option> = <replaceable></replaceable></td>
<td>(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1 and SSLv23. SSLv2 and SSLv3 may be available on some distributions.</td>
</tr>
<tr>
<td>rabbit_ha_queues = False</td>
<td><option>rabbit_ha_queues</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database.</td>
</tr>
<tr>
<td>rabbit_host = localhost</td>
<td><option>rabbit_host</option> = <replaceable>localhost</replaceable></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><option>rabbit_hosts</option> = <replaceable>$rabbit_host:$rabbit_port</replaceable></td>
<td>(ListOpt) RabbitMQ HA cluster host:port pairs.</td>
</tr>
<tr>
<td>rabbit_login_method = AMQPLAIN</td>
<td><option>rabbit_login_method</option> = <replaceable>AMQPLAIN</replaceable></td>
<td>(StrOpt) The RabbitMQ login method.</td>
</tr>
<tr>
<td>rabbit_max_retries = 0</td>
<td><option>rabbit_max_retries</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).</td>
</tr>
<tr>
<td>rabbit_password = guest</td>
<td><option>rabbit_password</option> = <replaceable>guest</replaceable></td>
<td>(StrOpt) The RabbitMQ password.</td>
</tr>
<tr>
<td>rabbit_port = 5672</td>
<td><option>rabbit_port</option> = <replaceable>5672</replaceable></td>
<td>(IntOpt) The RabbitMQ broker port where a single node is used.</td>
</tr>
<tr>
<td>rabbit_retry_backoff = 2</td>
<td><option>rabbit_retry_backoff</option> = <replaceable>2</replaceable></td>
<td>(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.</td>
</tr>
<tr>
<td>rabbit_retry_interval = 1</td>
<td><option>rabbit_retry_interval</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) How frequently to retry connecting with RabbitMQ.</td>
</tr>
<tr>
<td>rabbit_use_ssl = False</td>
<td><option>rabbit_use_ssl</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Connect over SSL for RabbitMQ.</td>
</tr>
<tr>
<td>rabbit_userid = guest</td>
<td><option>rabbit_userid</option> = <replaceable>guest</replaceable></td>
<td>(StrOpt) The RabbitMQ userid.</td>
</tr>
<tr>
<td>rabbit_virtual_host = /</td>
<td><option>rabbit_virtual_host</option> = <replaceable>/</replaceable></td>
<td>(StrOpt) The RabbitMQ virtual host.</td>
</tr>
</tbody>

8
doc/common/tables/ironic-redis.xml
View File

@ -18,22 +18,22 @@
<th colspan="2">[matchmaker_redis]</th>
</tr>
<tr>
<td>host = 127.0.0.1</td>
<td><option>host</option> = <replaceable>127.0.0.1</replaceable></td>
<td>(StrOpt) Host to locate redis.</td>
</tr>
<tr>
<td>password = None</td>
<td><option>password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Password for Redis server (optional).</td>
</tr>
<tr>
<td>port = 6379</td>
<td><option>port</option> = <replaceable>6379</replaceable></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><option>ringfile</option> = <replaceable>/etc/oslo/matchmaker_ring.json</replaceable></td>
<td>(StrOpt) Matchmaker ring file (JSON).</td>
</tr>
</tbody>

10
doc/common/tables/ironic-rootwrap.xml
View File

@ -18,23 +18,23 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>filters_path = /etc/ironic/rootwrap.d,/usr/share/ironic/rootwrap</td>
<td><option>filters_path</option> = <replaceable>/etc/ironic/rootwrap.d,/usr/share/ironic/rootwrap</replaceable></td>
<td>List of directories to load filter definitions from (separated by ','). These directories MUST all be only writeable by root !</td>
</tr>
<tr>
<td>exec_dirs = /sbin,/usr/sbin,/bin,/usr/bin</td>
<td><option>exec_dirs</option> = <replaceable>/sbin,/usr/sbin,/bin,/usr/bin</replaceable></td>
<td>List of directories to search executables in, in case filters do not explicitely specify a full path (separated by ',') If not specified, defaults to system PATH environment variable. These directories MUST all be only writeable by root !</td>
</tr>
<tr>
<td>use_syslog = False</td>
<td><option>use_syslog</option> = <replaceable>False</replaceable></td>
<td>Enable logging to syslog Default value is False</td>
</tr>
<tr>
<td>syslog_log_facility = syslog</td>
<td><option>syslog_log_facility</option> = <replaceable>syslog</replaceable></td>
<td>Which syslog facility to use. Valid values include auth, authpriv, syslog, user0, user1... Default value is 'syslog'</td>
</tr>
<tr>
<td>syslog_log_level = ERROR</td>
<td><option>syslog_log_level</option> = <replaceable>ERROR</replaceable></td>
<td>Which messages to log. INFO means log all usage ERROR means only log unsuccessful attempts</td>
</tr>
</tbody>

14
doc/common/tables/ironic-rpc.xml
View File

@ -18,31 +18,31 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>matchmaker_heartbeat_freq = 300</td>
<td><option>matchmaker_heartbeat_freq</option> = <replaceable>300</replaceable></td>
<td>(IntOpt) Heartbeat frequency.</td>
</tr>
<tr>
<td>matchmaker_heartbeat_ttl = 600</td>
<td><option>matchmaker_heartbeat_ttl</option> = <replaceable>600</replaceable></td>
<td>(IntOpt) Heartbeat time-to-live.</td>
</tr>
<tr>
<td>rpc_backend = rabbit</td>
<td><option>rpc_backend</option> = <replaceable>rabbit</replaceable></td>
<td>(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq.</td>
</tr>
<tr>
<td>rpc_cast_timeout = 30</td>
<td><option>rpc_cast_timeout</option> = <replaceable>30</replaceable></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><option>rpc_conn_pool_size</option> = <replaceable>30</replaceable></td>
<td>(IntOpt) Size of RPC connection pool.</td>
</tr>
<tr>
<td>rpc_response_timeout = 60</td>
<td><option>rpc_response_timeout</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Seconds to wait for a response from a call.</td>
</tr>
<tr>
<td>rpc_thread_pool_size = 64</td>
<td><option>rpc_thread_pool_size</option> = <replaceable>64</replaceable></td>
<td>(IntOpt) Size of RPC greenthread pool.</td>
</tr>
</tbody>

42
doc/common/tables/ironic-scheduler.xml Normal file
View File

@ -0,0 +1,42 @@
<?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_ironic_scheduler">
<caption>Description of scheduler 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><option>baremetal_scheduler_default_filters</option> = <replaceable>RetryFilter, AvailabilityZoneFilter, ComputeFilter, ComputeCapabilitiesFilter, ImagePropertiesFilter, ExactRamFilter, ExactDiskFilter, ExactCoreFilter</replaceable></td>
<td>(ListOpt) Which filter class names to use for filtering baremetal hosts when not specified in the request.</td>
</tr>
<tr>
<td><option>scheduler_available_filters</option> = <replaceable>['nova.scheduler.filters.all_filters']</replaceable></td>
<td>(MultiStrOpt) Filter classes available to the scheduler which may be specified more than once. An entry of "nova.scheduler.filters.all_filters" maps to all filters included with nova.</td>
</tr>
<tr>
<td><option>scheduler_default_filters</option> = <replaceable>RetryFilter, AvailabilityZoneFilter, RamFilter, ComputeFilter, ComputeCapabilitiesFilter, ImagePropertiesFilter, ServerGroupAntiAffinityFilter, ServerGroupAffinityFilter</replaceable></td>
<td>(ListOpt) Which filter class names to use for filtering hosts when not specified in the request.</td>
</tr>
<tr>
<td><option>scheduler_use_baremetal_filters</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Flag to decide whether to use baremetal_scheduler_default_filters or not.</td>
</tr>
<tr>
<td><option>scheduler_weight_classes</option> = <replaceable>nova.scheduler.weights.all_weighers</replaceable></td>
<td>(ListOpt) Which weight class names to use for weighing hosts</td>
</tr>
</tbody>
</table>
</para>

34
doc/common/tables/ironic-ssl.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_ironic_ssl">
<caption>Description of ssl 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><option>ssl_ca_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) CA certificate file to use to verify connecting clients</td>
</tr>
<tr>
<td><option>ssl_cert_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) SSL certificate of API server</td>
</tr>
<tr>
<td><option>ssl_key_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) SSL private key of API server</td>
</tr>
</tbody>
</table>
</para>

26
doc/common/tables/ironic-testing.xml Normal file
View File

@ -0,0 +1,26 @@
<?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_ironic_testing">
<caption>Description of testing 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><option>fake_rabbit</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake</td>
</tr>
</tbody>
</table>
</para>

26
doc/common/tables/ironic-upgrades.xml Normal file
View File

@ -0,0 +1,26 @@
<?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_ironic_upgrades">
<caption>Description of upgrades 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">[upgrade_levels]</th>
</tr>
<tr>
<td><option>cells</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Set a version cap for messages sent to local cells services</td>
</tr>
</tbody>
</table>
</para>

14
doc/common/tables/ironic-zeromq.xml
View File

@ -18,31 +18,31 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>rpc_zmq_bind_address = *</td>
<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>rpc_zmq_contexts = 1</td>
<td><option>rpc_zmq_contexts</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Number of ZeroMQ contexts, defaults to 1.</td>
</tr>
<tr>
<td>rpc_zmq_host = localhost</td>
<td><option>rpc_zmq_host</option> = <replaceable>localhost</replaceable></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><option>rpc_zmq_ipc_dir</option> = <replaceable>/var/run/openstack</replaceable></td>
<td>(StrOpt) Directory for holding IPC sockets.</td>
</tr>
<tr>
<td>rpc_zmq_matchmaker = oslo.messaging._drivers.matchmaker.MatchMakerLocalhost</td>
<td><option>rpc_zmq_matchmaker</option> = <replaceable>oslo.messaging._drivers.matchmaker.MatchMakerLocalhost</replaceable></td>
<td>(StrOpt) MatchMaker driver.</td>
</tr>
<tr>
<td>rpc_zmq_port = 9501</td>
<td><option>rpc_zmq_port</option> = <replaceable>9501</replaceable></td>
<td>(IntOpt) ZeroMQ receiver listening port.</td>
</tr>
<tr>
<td>rpc_zmq_topic_backlog = None</td>
<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>
</tbody>

30
doc/common/tables/keystone-auth_token.xml
View File

@ -19,11 +19,11 @@
</tr>
<tr>
<td><option>admin_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Keystone account password</td>
<td>(StrOpt) Service user password.</td>
</tr>
<tr>
<td><option>admin_tenant_name</option> = <replaceable>admin</replaceable></td>
<td>(StrOpt) Keystone service account tenant name to validate user tokens</td>
<td>(StrOpt) Service tenant name.</td>
</tr>
<tr>
<td><option>admin_token</option> = <replaceable>None</replaceable></td>
@ -31,7 +31,7 @@
</tr>
<tr>
<td><option>admin_user</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Keystone account username</td>
<td>(StrOpt) Service username.</td>
</tr>
<tr>
<td><option>auth_admin_prefix</option> = <replaceable></replaceable></td>
@ -51,15 +51,15 @@
</tr>
<tr>
<td><option>auth_uri</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Complete public Identity API endpoint</td>
<td>(StrOpt) Complete public Identity API endpoint.</td>
</tr>
<tr>
<td><option>auth_version</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) API version of the admin Identity API endpoint</td>
<td>(StrOpt) API version of the admin Identity API endpoint.</td>
</tr>
<tr>
<td><option>cache</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Env key for the swift cache</td>
<td>(StrOpt) Env key for the swift cache.</td>
</tr>
<tr>
<td><option>cafile</option> = <replaceable>None</replaceable></td>
@ -67,15 +67,15 @@
</tr>
<tr>
<td><option>certfile</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Required if Keystone server requires client certificate</td>
<td>(StrOpt) Required if identity server requires client certificate</td>
</tr>
<tr>
<td><option>check_revocations_for_cached</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the Keystone server.</td>
<td>(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server.</td>
</tr>
<tr>
<td><option>delay_auth_decision</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components</td>
<td>(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components.</td>
</tr>
<tr>
<td><option>enforce_token_bind</option> = <replaceable>permissive</replaceable></td>
@ -87,7 +87,7 @@
</tr>
<tr>
<td><option>http_connect_timeout</option> = <replaceable>None</replaceable></td>
<td>(BoolOpt) Request timeout value for communicating with Identity API server.</td>
<td>(IntOpt) Request timeout value for communicating with Identity API server.</td>
</tr>
<tr>
<td><option>http_request_max_retries</option> = <replaceable>3</replaceable></td>
@ -99,7 +99,7 @@
</tr>
<tr>
<td><option>include_service_catalog</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.</td>
<td>(BoolOpt) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.</td>
</tr>
<tr>
<td><option>insecure</option> = <replaceable>False</replaceable></td>
@ -107,15 +107,15 @@
</tr>
<tr>
<td><option>keyfile</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Required if Keystone server requires client certificate</td>
<td>(StrOpt) Required if identity server requires client certificate</td>
</tr>
<tr>
<td><option>memcache_secret_key</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation.</td>
<td>(StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.</td>
</tr>
<tr>
<td><option>memcache_security_strategy</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) (optional) if defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.</td>
<td>(StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.</td>
</tr>
<tr>
<td><option>revocation_cache_time</option> = <replaceable>10</replaceable></td>
@ -123,7 +123,7 @@
</tr>
<tr>
<td><option>signing_dir</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Directory used to cache files related to PKI tokens</td>
<td>(StrOpt) Directory used to cache files related to PKI tokens.</td>
</tr>
<tr>
<td><option>token_cache_time</option> = <replaceable>300</replaceable></td>

2
doc/common/tables/keystone-os_inherit.xml
View File

@ -19,7 +19,7 @@
</tr>
<tr>
<td><option>enabled</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) role-assignment inheritance to projects from owning domain can be optionally enabled.</td>
<td>(BoolOpt) role-assignment inheritance to projects from owning domain or from projects higher in the hierarchy can be optionally enabled.</td>
</tr>
</tbody>
</table>

38
doc/common/tables/keystone-role.xml Normal file
View File

@ -0,0 +1,38 @@
<?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_keystone_role">
<caption>Description of role 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">[role]</th>
</tr>
<tr>
<td><option>cache_time</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) TTL (in seconds) to cache role data. This has no effect unless global caching is enabled.</td>
</tr>
<tr>
<td><option>caching</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Toggle for role caching. This has no effect unless global caching is enabled.</td>
</tr>
<tr>
<td><option>driver</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Role backend driver.</td>
</tr>
<tr>
<td><option>list_limit</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) Maximum number of entities that will be returned in a role collection.</td>
</tr>
</tbody>
</table>
</para>

8
doc/common/tables/keystone-trust.xml
View File

@ -17,6 +17,10 @@
<tr>
<th colspan="2">[trust]</th>
</tr>
<tr>
<td><option>allow_redelegation</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enable redelegation feature.</td>
</tr>
<tr>
<td><option>driver</option> = <replaceable>keystone.trust.backends.sql.Trust</replaceable></td>
<td>(StrOpt) Trust backend driver.</td>
@ -25,6 +29,10 @@
<td><option>enabled</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Delegation and impersonation features can be optionally disabled.</td>
</tr>
<tr>
<td><option>max_redelegation_count</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) Maximum depth of trust redelegation.</td>
</tr>
</tbody>
</table>
</para>

30
doc/common/tables/neutron-auth_token.xml
View File

@ -19,11 +19,11 @@
</tr>
<tr>
<td><option>admin_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Keystone account password</td>
<td>(StrOpt) Service user password.</td>
</tr>
<tr>
<td><option>admin_tenant_name</option> = <replaceable>admin</replaceable></td>
<td>(StrOpt) Keystone service account tenant name to validate user tokens</td>
<td>(StrOpt) Service tenant name.</td>
</tr>
<tr>
<td><option>admin_token</option> = <replaceable>None</replaceable></td>
@ -31,7 +31,7 @@
</tr>
<tr>
<td><option>admin_user</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Keystone account username</td>
<td>(StrOpt) Service username.</td>
</tr>
<tr>
<td><option>auth_admin_prefix</option> = <replaceable></replaceable></td>
@ -51,15 +51,15 @@
</tr>
<tr>
<td><option>auth_uri</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Complete public Identity API endpoint</td>
<td>(StrOpt) Complete public Identity API endpoint.</td>
</tr>
<tr>
<td><option>auth_version</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) API version of the admin Identity API endpoint</td>
<td>(StrOpt) API version of the admin Identity API endpoint.</td>
</tr>
<tr>
<td><option>cache</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Env key for the swift cache</td>
<td>(StrOpt) Env key for the swift cache.</td>
</tr>
<tr>
<td><option>cafile</option> = <replaceable>None</replaceable></td>
@ -67,15 +67,15 @@
</tr>
<tr>
<td><option>certfile</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Required if Keystone server requires client certificate</td>
<td>(StrOpt) Required if identity server requires client certificate</td>
</tr>
<tr>
<td><option>check_revocations_for_cached</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the Keystone server.</td>
<td>(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server.</td>
</tr>
<tr>
<td><option>delay_auth_decision</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components</td>
<td>(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components.</td>
</tr>
<tr>
<td><option>enforce_token_bind</option> = <replaceable>permissive</replaceable></td>
@ -87,7 +87,7 @@
</tr>
<tr>
<td><option>http_connect_timeout</option> = <replaceable>None</replaceable></td>
<td>(BoolOpt) Request timeout value for communicating with Identity API server.</td>
<td>(IntOpt) Request timeout value for communicating with Identity API server.</td>
</tr>
<tr>
<td><option>http_request_max_retries</option> = <replaceable>3</replaceable></td>
@ -99,7 +99,7 @@
</tr>
<tr>
<td><option>include_service_catalog</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.</td>
<td>(BoolOpt) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.</td>
</tr>
<tr>
<td><option>insecure</option> = <replaceable>False</replaceable></td>
@ -107,15 +107,15 @@
</tr>
<tr>
<td><option>keyfile</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Required if Keystone server requires client certificate</td>
<td>(StrOpt) Required if identity server requires client certificate</td>
</tr>
<tr>
<td><option>memcache_secret_key</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation.</td>
<td>(StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.</td>
</tr>
<tr>
<td><option>memcache_security_strategy</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) (optional) if defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.</td>
<td>(StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.</td>
</tr>
<tr>
<td><option>revocation_cache_time</option> = <replaceable>10</replaceable></td>
@ -123,7 +123,7 @@
</tr>
<tr>
<td><option>signing_dir</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Directory used to cache files related to PKI tokens</td>
<td>(StrOpt) Directory used to cache files related to PKI tokens.</td>
</tr>
<tr>
<td><option>token_cache_time</option> = <replaceable>300</replaceable></td>

2
doc/common/tables/neutron-bigswitch.xml
View File

@ -109,7 +109,7 @@
<td>(IntOpt) Time between verifications that the backend controller database is consistent with Neutron. (0 to disable)</td>
</tr>
<tr>
<td><option>neutron_id</option> = <replaceable>neutron-usagi</replaceable></td>
<td><option>neutron_id</option> = <replaceable>neutron-shock</replaceable></td>
<td>(StrOpt) User defined identifier for this Neutron deployment</td>
</tr>
<tr>

2
doc/common/tables/neutron-brocade.xml
View File

@ -19,7 +19,7 @@
</tr>
<tr>
<td><option>physical_interface</option> = <replaceable>eth0</replaceable></td>
<td>(StrOpt) The network interface to use when creatinga port</td>
<td>(StrOpt) The network interface to use when creating a port</td>
</tr>
<tr>
<th colspan="2">[SWITCH]</th>

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

@ -135,7 +135,7 @@
</tr>
<tr>
<td><option>host</option> = <replaceable>localhost</replaceable></td>
<td>(StrOpt) The hostname Neutron is running on</td>
<td>(StrOpt) Hostname to be used by the neutron server, agents andservices running on this machine. All the agents and services running on this machine must use the same host value.</td>
</tr>
<tr>
<td><option>interface_driver</option> = <replaceable>None</replaceable></td>
@ -145,10 +145,6 @@
<td><option>ip_lib_force_root</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Force ip_lib calls to use the root helper</td>
</tr>
<tr>
<td><option>lock_path</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Directory to use for lock files.</td>
</tr>
<tr>
<td><option>mac_generation_retries</option> = <replaceable>16</replaceable></td>
<td>(IntOpt) How many times Neutron will retry MAC generation</td>

4
doc/common/tables/neutron-debug.xml
View File

@ -21,10 +21,6 @@
<td><option>backdoor_port</option> = <replaceable>None</replaceable></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><option>disable_process_locking</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enables or disables inter-process locks.</td>
</tr>
</tbody>
</table>
</para>

4
doc/common/tables/neutron-linuxbridge_agent.xml
View File

@ -44,8 +44,8 @@
<td>(BoolOpt) Extension to use alongside ml2 plugin's l2population mechanism driver. It enables the plugin to populate VXLAN forwarding table.</td>
</tr>
<tr>
<td><option>local_ip</option> = <replaceable></replaceable></td>
<td>(StrOpt) Local IP address of the VXLAN endpoints.</td>
<td><option>local_ip</option> = <replaceable>None</replaceable></td>
<td>(IPOpt) Local IP address of the VXLAN endpoints.</td>
</tr>
<tr>
<td><option>tos</option> = <replaceable>None</replaceable></td>

12
doc/common/tables/neutron-metadata.xml
View File

@ -29,16 +29,24 @@
<td><option>metadata_port</option> = <replaceable>9697</replaceable></td>
<td>(IntOpt) TCP Port used by Neutron metadata namespace proxy.</td>
</tr>
<tr>
<td><option>metadata_proxy_group</option> = <replaceable></replaceable></td>
<td>(StrOpt) Group (gid or name) running metadata proxy after its initialization (if empty: L3 agent effective group)</td>
</tr>
<tr>
<td><option>metadata_proxy_shared_secret</option> = <replaceable></replaceable></td>
<td>(StrOpt) Shared secret to sign instance-id request</td>
</tr>
<tr>
<td><option>metadata_proxy_socket</option> = <replaceable>$state_path/metadata_proxy</replaceable></td>
<td>(StrOpt) Location of Metadata Proxy UNIX domain socket</td>
<td>(StrOpt) Location for Metadata Proxy UNIX domain socket</td>
</tr>
<tr>
<td><option>metadata_workers</option> = <replaceable>4</replaceable></td>
<td><option>metadata_proxy_user</option> = <replaceable></replaceable></td>
<td>(StrOpt) User (uid or name) running metadata proxy after its initialization (if empty: L3 agent effective user)</td>
</tr>
<tr>
<td><option>metadata_workers</option> = <replaceable>2</replaceable></td>
<td>(IntOpt) Number of separate worker processes for metadata server</td>
</tr>
<tr>

2
doc/common/tables/neutron-ml2_bigswitch.xml
View File

@ -109,7 +109,7 @@
<td>(IntOpt) Time between verifications that the backend controller database is consistent with Neutron. (0 to disable)</td>
</tr>
<tr>
<td><option>neutron_id</option> = <replaceable>neutron-usagi</replaceable></td>
<td><option>neutron_id</option> = <replaceable>neutron-shock</replaceable></td>
<td>(StrOpt) User defined identifier for this Neutron deployment</td>
</tr>
<tr>

2
doc/common/tables/neutron-quotas.xml
View File

@ -74,7 +74,7 @@
</tr>
<tr>
<td><option>quota_network</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Number of networks allowed per tenant.A negative value means unlimited.</td>
<td>(IntOpt) Number of networks allowed per tenant. A negative value means unlimited.</td>
</tr>
<tr>
<td><option>quota_network_gateway</option> = <replaceable>5</replaceable></td>

30
doc/common/tables/nova-auth_token.xml
View File

@ -19,11 +19,11 @@
</tr>
<tr>
<td><option>admin_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Keystone account password</td>
<td>(StrOpt) Service user password.</td>
</tr>
<tr>
<td><option>admin_tenant_name</option> = <replaceable>admin</replaceable></td>
<td>(StrOpt) Keystone service account tenant name to validate user tokens</td>
<td>(StrOpt) Service tenant name.</td>
</tr>
<tr>
<td><option>admin_token</option> = <replaceable>None</replaceable></td>
@ -31,7 +31,7 @@
</tr>
<tr>
<td><option>admin_user</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Keystone account username</td>
<td>(StrOpt) Service username.</td>
</tr>
<tr>
<td><option>auth_admin_prefix</option> = <replaceable></replaceable></td>
@ -51,15 +51,15 @@
</tr>
<tr>
<td><option>auth_uri</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Complete public Identity API endpoint</td>
<td>(StrOpt) Complete public Identity API endpoint.</td>
</tr>
<tr>
<td><option>auth_version</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) API version of the admin Identity API endpoint</td>
<td>(StrOpt) API version of the admin Identity API endpoint.</td>
</tr>
<tr>
<td><option>cache</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Env key for the swift cache</td>
<td>(StrOpt) Env key for the swift cache.</td>
</tr>
<tr>
<td><option>cafile</option> = <replaceable>None</replaceable></td>
@ -67,15 +67,15 @@
</tr>
<tr>
<td><option>certfile</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Required if Keystone server requires client certificate</td>
<td>(StrOpt) Required if identity server requires client certificate</td>
</tr>
<tr>
<td><option>check_revocations_for_cached</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the Keystone server.</td>
<td>(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server.</td>
</tr>
<tr>
<td><option>delay_auth_decision</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components</td>
<td>(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components.</td>
</tr>
<tr>
<td><option>enforce_token_bind</option> = <replaceable>permissive</replaceable></td>
@ -87,7 +87,7 @@
</tr>
<tr>
<td><option>http_connect_timeout</option> = <replaceable>None</replaceable></td>
<td>(BoolOpt) Request timeout value for communicating with Identity API server.</td>
<td>(IntOpt) Request timeout value for communicating with Identity API server.</td>
</tr>
<tr>
<td><option>http_request_max_retries</option> = <replaceable>3</replaceable></td>
@ -99,7 +99,7 @@
</tr>
<tr>
<td><option>include_service_catalog</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.</td>
<td>(BoolOpt) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.</td>
</tr>
<tr>
<td><option>insecure</option> = <replaceable>False</replaceable></td>
@ -107,15 +107,15 @@
</tr>
<tr>
<td><option>keyfile</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Required if Keystone server requires client certificate</td>
<td>(StrOpt) Required if identity server requires client certificate</td>
</tr>
<tr>
<td><option>memcache_secret_key</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation.</td>
<td>(StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.</td>
</tr>
<tr>
<td><option>memcache_security_strategy</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) (optional) if defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.</td>
<td>(StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.</td>
</tr>
<tr>
<td><option>revocation_cache_time</option> = <replaceable>10</replaceable></td>
@ -123,7 +123,7 @@
</tr>
<tr>
<td><option>signing_dir</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Directory used to cache files related to PKI tokens</td>
<td>(StrOpt) Directory used to cache files related to PKI tokens.</td>
</tr>
<tr>
<td><option>token_cache_time</option> = <replaceable>300</replaceable></td>

20
doc/common/tables/sahara-amqp.xml
View File

@ -18,35 +18,35 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>amqp_auto_delete = False</td>
<td>(BoolOpt) Auto-delete queues in amqp.</td>
<td><option>amqp_auto_delete</option> = <replaceable>False</replaceable></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>
<td><option>amqp_durable_queues</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Use durable queues in AMQP.</td>
</tr>
<tr>
<td>control_exchange = openstack</td>
<td><option>control_exchange</option> = <replaceable>openstack</replaceable></td>
<td>(StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.</td>
</tr>
<tr>
<td>notification_driver = []</td>
<td><option>notification_driver</option> = <replaceable>[]</replaceable></td>
<td>(MultiStrOpt) Driver or drivers to handle sending notifications.</td>
</tr>
<tr>
<td>notification_level = INFO</td>
<td><option>notification_level</option> = <replaceable>INFO</replaceable></td>
<td>(StrOpt) Notification level for outgoing notifications</td>
</tr>
<tr>
<td>notification_publisher_id = None</td>
<td><option>notification_publisher_id</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Notification publisher_id for outgoing notifications</td>
</tr>
<tr>
<td>notification_topics = notifications</td>
<td><option>notification_topics</option> = <replaceable>notifications</replaceable></td>
<td>(ListOpt) AMQP topic used for OpenStack notifications.</td>
</tr>
<tr>
<td>transport_url = None</td>
<td><option>transport_url</option> = <replaceable>None</replaceable></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>

118
doc/common/tables/sahara-auth_token.xml
View File

@ -18,115 +18,147 @@
<th colspan="2">[keystone_authtoken]</th>
</tr>
<tr>
<td>admin_password = None</td>
<td>(StrOpt) Keystone account password</td>
<td><option>admin_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Service user password.</td>
</tr>
<tr>
<td>admin_tenant_name = admin</td>
<td>(StrOpt) Keystone service account tenant name to validate user tokens</td>
<td><option>admin_tenant_name</option> = <replaceable>admin</replaceable></td>
<td>(StrOpt) Service tenant name.</td>
</tr>
<tr>
<td>admin_token = None</td>
<td><option>admin_token</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead.</td>
</tr>
<tr>
<td>admin_user = None</td>
<td>(StrOpt) Keystone account username</td>
<td><option>admin_user</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Service username.</td>
</tr>
<tr>
<td>auth_admin_prefix = </td>
<td><option>auth_admin_prefix</option> = <replaceable></replaceable></td>
<td>(StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri.</td>
</tr>
<tr>
<td>auth_host = 127.0.0.1</td>
<td><option>auth_host</option> = <replaceable>127.0.0.1</replaceable></td>
<td>(StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri.</td>
</tr>
<tr>
<td>auth_port = 35357</td>
<td><option>auth_plugin</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Name of the plugin to load</td>
</tr>
<tr>
<td><option>auth_port</option> = <replaceable>35357</replaceable></td>
<td>(IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri.</td>
</tr>
<tr>
<td>auth_protocol = https</td>
<td><option>auth_protocol</option> = <replaceable>https</replaceable></td>
<td>(StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri.</td>
</tr>
<tr>
<td>auth_uri = None</td>
<td>(StrOpt) Complete public Identity API endpoint</td>
<td><option>auth_section</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Config Section from which to load plugin specific options</td>
</tr>
<tr>
<td>auth_version = None</td>
<td>(StrOpt) API version of the admin Identity API endpoint</td>
<td><option>auth_uri</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Complete public Identity API endpoint.</td>
</tr>
<tr>
<td>cache = None</td>
<td>(StrOpt) Env key for the swift cache</td>
<td><option>auth_version</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) API version of the admin Identity API endpoint.</td>
</tr>
<tr>
<td>cafile = None</td>
<td><option>cache</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Env key for the swift cache.</td>
</tr>
<tr>
<td><option>cafile</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.</td>
</tr>
<tr>
<td>certfile = None</td>
<td>(StrOpt) Required if Keystone server requires client certificate</td>
<td><option>certfile</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Required if identity server requires client certificate</td>
</tr>
<tr>
<td>check_revocations_for_cached = False</td>
<td>(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the Keystone server.</td>
<td><option>check_revocations_for_cached</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server.</td>
</tr>
<tr>
<td>delay_auth_decision = False</td>
<td>(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components</td>
<td><option>delay_auth_decision</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components.</td>
</tr>
<tr>
<td>enforce_token_bind = permissive</td>
<td><option>enforce_token_bind</option> = <replaceable>permissive</replaceable></td>
<td>(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens.</td>
</tr>
<tr>
<td>hash_algorithms = md5</td>
<td><option>hash_algorithms</option> = <replaceable>md5</replaceable></td>
<td>(ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance.</td>
</tr>
<tr>
<td>http_connect_timeout = None</td>
<td>(BoolOpt) Request timeout value for communicating with Identity API server.</td>
<td><option>http_connect_timeout</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) Request timeout value for communicating with Identity API server.</td>
</tr>
<tr>
<td>http_request_max_retries = 3</td>
<td><option>http_request_max_retries</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server.</td>
</tr>
<tr>
<td>identity_uri = None</td>
<td><option>identity_uri</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/</td>
</tr>
<tr>
<td>include_service_catalog = True</td>
<td>(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.</td>
<td><option>include_service_catalog</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.</td>
</tr>
<tr>
<td>insecure = False</td>
<td><option>insecure</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Verify HTTPS connections.</td>
</tr>
<tr>
<td>keyfile = None</td>
<td>(StrOpt) Required if Keystone server requires client certificate</td>
<td><option>keyfile</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Required if identity server requires client certificate</td>
</tr>
<tr>
<td>memcache_secret_key = None</td>
<td>(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation.</td>
<td><option>memcache_pool_conn_get_timeout</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) (Optional) Number of seconds that an operation will wait to get a memcache client connection from the pool.</td>
</tr>
<tr>
<td>memcache_security_strategy = None</td>
<td>(StrOpt) (optional) if defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.</td>
<td><option>memcache_pool_dead_retry</option> = <replaceable>300</replaceable></td>
<td>(IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again.</td>
</tr>
<tr>
<td>revocation_cache_time = 10</td>
<td><option>memcache_pool_maxsize</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) (Optional) Maximum total number of open connections to every memcached server.</td>
</tr>
<tr>
<td><option>memcache_pool_socket_timeout</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) (Optional) Socket timeout in seconds for communicating with a memcache server.</td>
</tr>
<tr>
<td><option>memcache_pool_unused_timeout</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed.</td>
</tr>
<tr>
<td><option>memcache_secret_key</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.</td>
</tr>
<tr>
<td><option>memcache_security_strategy</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.</td>
</tr>
<tr>
<td><option>memcache_use_advanced_pool</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) (Optional) Use the advanced (eventlet safe) memcache client pool. The advanced pool will only work under python 2.x.</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>
</tr>
<tr>
<td>signing_dir = None</td>
<td>(StrOpt) Directory used to cache files related to PKI tokens</td>
<td><option>signing_dir</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Directory used to cache files related to PKI tokens.</td>
</tr>
<tr>
<td>token_cache_time = 300</td>
<td><option>token_cache_time</option> = <replaceable>300</replaceable></td>
<td>(IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely.</td>
</tr>
</tbody>

34
doc/common/tables/sahara-ca.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_sahara_ca">
<caption>Description of CA and SSL 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">[ssl]</th>
</tr>
<tr>
<td><option>ca_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) CA certificate file to use to verify connecting clients.</td>
</tr>
<tr>
<td><option>cert_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Certificate file to use when starting the server securely.</td>
</tr>
<tr>
<td><option>key_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Private key file to use when starting the server securely.</td>
</tr>
</tbody>
</table>
</para>

89
doc/common/tables/sahara-clients.xml Normal file
View File

@ -0,0 +1,89 @@
<?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_sahara_clients">
<caption>Description of clients 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">[cinder]</th>
</tr>
<tr>
<td><option>api_insecure</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Allow to perform insecure SSL requests to cinder.</td>
</tr>
<tr>
<td><option>api_version</option> = <replaceable>2</replaceable></td>
<td>(IntOpt) Version of the Cinder API to use.</td>
</tr>
<tr>
<td><option>ca_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Location of ca certificates file to use for cinder client requests.</td>
</tr>
<tr>
<th colspan="2">[heat]</th>
</tr>
<tr>
<td><option>api_insecure</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Allow to perform insecure SSL requests to heat.</td>
</tr>
<tr>
<td><option>ca_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Location of ca certificates file to use for heat client requests.</td>
</tr>
<tr>
<th colspan="2">[keystone]</th>
</tr>
<tr>
<td><option>api_insecure</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Allow to perform insecure SSL requests to keystone.</td>
</tr>
<tr>
<td><option>ca_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Location of ca certificates file to use for keystone client requests.</td>
</tr>
<tr>
<th colspan="2">[neutron]</th>
</tr>
<tr>
<td><option>api_insecure</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Allow to perform insecure SSL requests to neutron.</td>
</tr>
<tr>
<td><option>ca_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Location of ca certificates file to use for neutron client requests.</td>
</tr>
<tr>
<th colspan="2">[nova]</th>
</tr>
<tr>
<td><option>api_insecure</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Allow to perform insecure SSL requests to nova.</td>
</tr>
<tr>
<td><option>ca_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Location of ca certificates file to use for nova client requests.</td>
</tr>
<tr>
<th colspan="2">[swift]</th>
</tr>
<tr>
<td><option>api_insecure</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Allow to perform insecure SSL requests to swift.</td>
</tr>
<tr>
<td><option>ca_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Location of ca certificates file to use for swift client requests.</td>
</tr>
</tbody>
</table>
</para>

113
doc/common/tables/sahara-common.xml
View File

@ -18,144 +18,153 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>cluster_remote_threshold = 70</td>
<td><option>cluster_remote_threshold</option> = <replaceable>70</replaceable></td>
<td>(IntOpt) The same as global_remote_threshold, but for a single cluster.</td>
</tr>
<tr>
<td>compute_topology_file = etc/sahara/compute.topology</td>
<td>(StrOpt) File with nova compute topology.
It should contain mapping between nova computes and racks.
File format:
compute1 /rack1
compute2 /rack2
compute3 /rack2</td>
<td><option>compute_topology_file</option> = <replaceable>etc/sahara/compute.topology</replaceable></td>
<td>(StrOpt) File with nova compute topology. It should contain mapping between nova computes and racks.</td>
</tr>
<tr>
<td>detach_volume_timeout = 300</td>
<td><option>detach_volume_timeout</option> = <replaceable>300</replaceable></td>
<td>(IntOpt) Timeout for detaching volumes from instance (in seconds).</td>
</tr>
<tr>
<td>enable_data_locality = False</td>
<td>(BoolOpt) Enables data locality for hadoop cluster.
Also enables data locality for Swift used by hadoop.
If enabled, 'compute_topology' and 'swift_topology'
configuration parameters should point to OpenStack and Swift
topology correspondingly.</td>
<td><option>enable_data_locality</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enables data locality for hadoop cluster. Also enables data locality for Swift used by hadoop. If enabled, 'compute_topology' and 'swift_topology' configuration parameters should point to OpenStack and Swift topology correspondingly.</td>
</tr>
<tr>
<td>enable_hypervisor_awareness = True</td>
<td>(BoolOpt) Enables four-level topology for data locality.
Works only if corresponding plugin supports such mode.</td>
<td><option>enable_hypervisor_awareness</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Enables four-level topology for data locality. Works only if corresponding plugin supports such mode.</td>
</tr>
<tr>
<td>enable_notifications = False</td>
<td><option>enable_notifications</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enables sending notifications to Ceilometer</td>
</tr>
<tr>
<td>global_remote_threshold = 100</td>
<td><option>global_remote_threshold</option> = <replaceable>100</replaceable></td>
<td>(IntOpt) Maximum number of remote operations that will be running at the same time. Note that each remote operation requires its own process to run.</td>
</tr>
<tr>
<td>host = </td>
<td><option>host</option> = <replaceable></replaceable></td>
<td>(StrOpt) Hostname or IP address that will be used to listen on.</td>
</tr>
<tr>
<td>infrastructure_engine = direct</td>
<td><option>infrastructure_engine</option> = <replaceable>direct</replaceable></td>
<td>(StrOpt) An engine which will be used to provision infrastructure for Hadoop cluster.</td>
</tr>
<tr>
<td>job_binary_max_KB = 5120</td>
<td><option>job_binary_max_KB</option> = <replaceable>5120</replaceable></td>
<td>(IntOpt) Maximum length of job binary data in kilobytes that may be stored or retrieved in a single operation.</td>
</tr>
<tr>
<td>job_workflow_postfix = </td>
<td><option>job_canceling_timeout</option> = <replaceable>300</replaceable></td>
<td>(IntOpt) Timeout for canceling job execution (in seconds). Sahara will try to cancel job execution during this time.</td>
</tr>
<tr>
<td><option>job_workflow_postfix</option> = <replaceable></replaceable></td>
<td>(StrOpt) Postfix for storing jobs in hdfs. Will be added to '/user/&lt;hdfs user&gt;/' path.</td>
</tr>
<tr>
<td>lock_path = None</td>
<td>(StrOpt) Directory to use for lock files.</td>
</tr>
<tr>
<td>memcached_servers = None</td>
<td><option>memcached_servers</option> = <replaceable>None</replaceable></td>
<td>(ListOpt) Memcached servers or None for in process cache.</td>
</tr>
<tr>
<td>min_transient_cluster_active_time = 30</td>
<td><option>min_transient_cluster_active_time</option> = <replaceable>30</replaceable></td>
<td>(IntOpt) Minimal "lifetime" in seconds for a transient cluster. Cluster is guaranteed to be "alive" within this time period.</td>
</tr>
<tr>
<td>node_domain = novalocal</td>
<td><option>node_domain</option> = <replaceable>novalocal</replaceable></td>
<td>(StrOpt) The suffix of the node's FQDN. In nova-network that is the dhcp_domain config parameter.</td>
</tr>
<tr>
<td>os_region_name = None</td>
<td><option>os_region_name</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Region name used to get services endpoints.</td>
</tr>
<tr>
<td>periodic_enable = True</td>
<td><option>periodic_enable</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Enable periodic tasks.</td>
</tr>
<tr>
<td>periodic_fuzzy_delay = 60</td>
<td><option>periodic_fuzzy_delay</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Range in seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0).</td>
</tr>
<tr>
<td>periodic_interval_max = 60</td>
<td><option>periodic_interval_max</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Max interval size between periodic tasks execution in seconds.</td>
</tr>
<tr>
<td>plugins = vanilla, hdp, spark</td>
<td><option>plugins</option> = <replaceable>vanilla, hdp, spark</replaceable></td>
<td>(ListOpt) List of plugins to be loaded. Sahara preserves the order of the list when returning it.</td>
</tr>
<tr>
<td>port = 8386</td>
<td><option>policy_default_rule</option> = <replaceable>default</replaceable></td>
<td>(StrOpt) Default rule. Enforced when a requested rule is not found.</td>
</tr>
<tr>
<td><option>policy_dirs</option> = <replaceable>['policy.d']</replaceable></td>
<td>(MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched.</td>
</tr>
<tr>
<td><option>policy_file</option> = <replaceable>policy.json</replaceable></td>
<td>(StrOpt) The JSON file that defines policies.</td>
</tr>
<tr>
<td><option>port</option> = <replaceable>8386</replaceable></td>
<td>(IntOpt) Port that will be used to listen on.</td>
</tr>
<tr>
<td>remote = ssh</td>
<td><option>proxy_command</option> = <replaceable></replaceable></td>
<td>(StrOpt) Proxy command used to connect to instances. If set, this command should open a netcat socket, that Sahara will use for SSH and HTTP connections. Use {host} and {port} to describe the destination. Other available keywords: {tenant_id}, {network_id}, {router_id}.</td>
</tr>
<tr>
<td><option>remote</option> = <replaceable>ssh</replaceable></td>
<td>(StrOpt) A method for Sahara to execute commands on VMs.</td>
</tr>
<tr>
<td>run_external_periodic_tasks = True</td>
<td><option>rootwrap_command</option> = <replaceable>sudo sahara-rootwrap /etc/sahara/rootwrap.conf</replaceable></td>
<td>(StrOpt) Rootwrap command to leverage. Use in conjunction with use_rootwrap=True</td>
</tr>
<tr>
<td><option>run_external_periodic_tasks</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Some periodic tasks can be run in a separate process. Should we run them here?</td>
</tr>
<tr>
<td>swift_topology_file = etc/sahara/swift.topology</td>
<td>(StrOpt) File with Swift topology.
It should contain mapping between Swift nodes and racks.
File format:
node1 /rack1
node2 /rack2
node3 /rack2</td>
<td><option>swift_topology_file</option> = <replaceable>etc/sahara/swift.topology</replaceable></td>
<td>(StrOpt) File with Swift topology.It should contain mapping between Swift nodes and racks.</td>
</tr>
<tr>
<td>use_floating_ips = True</td>
<td><option>use_floating_ips</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) If set to True, Sahara will use floating IPs to communicate with instances. To make sure that all instances have floating IPs assigned in Nova Network set "auto_assign_floating_ip=True" in nova.conf. If Neutron is used for networking, make sure that all Node Groups have "floating_ip_pool" parameter defined.</td>
</tr>
<tr>
<td>use_identity_api_v3 = True</td>
<td><option>use_identity_api_v3</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Enables Sahara to use Keystone API v3. If that flag is disabled, per-job clusters will not be terminated automatically.</td>
</tr>
<tr>
<td>use_namespaces = False</td>
<td><option>use_namespaces</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Use network namespaces for communication (only valid to use in conjunction with use_neutron=True).</td>
</tr>
<tr>
<td>use_neutron = False</td>
<td><option>use_neutron</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Use Neutron Networking (False indicates the use of Nova networking).</td>
</tr>
<tr>
<td><option>use_rootwrap</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Use rootwrap facility to allow non-root users to run the sahara-all server instance and access private network IPs (only valid to use in conjunction with use_namespaces=True)</td>
</tr>
<tr>
<th colspan="2">[conductor]</th>
</tr>
<tr>
<td>use_local = True</td>
<td><option>use_local</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Perform sahara-conductor operations locally.</td>
</tr>
<tr>
<th colspan="2">[keystone_authtoken]</th>
</tr>
<tr>
<td>memcached_servers = None</td>
<td><option>memcached_servers</option> = <replaceable>None</replaceable></td>
<td>(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.</td>
</tr>
</tbody>

44
doc/common/tables/sahara-database.xml
View File

@ -18,90 +18,90 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>db_driver = sahara.db</td>
<td><option>db_driver</option> = <replaceable>sahara.db</replaceable></td>
<td>(StrOpt) Driver to use for database access.</td>
</tr>
<tr>
<th colspan="2">[database]</th>
</tr>
<tr>
<td>backend = sqlalchemy</td>
<td><option>backend</option> = <replaceable>sqlalchemy</replaceable></td>
<td>(StrOpt) The back end to use for the database.</td>
</tr>
<tr>
<td>connection = None</td>
<td><option>connection</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The SQLAlchemy connection string to use to connect to the database.</td>
</tr>
<tr>
<td>connection_debug = 0</td>
<td><option>connection_debug</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything.</td>
</tr>
<tr>
<td>connection_trace = False</td>
<td><option>connection_trace</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Add Python stack traces to SQL as comment strings.</td>
</tr>
<tr>
<td>db_inc_retry_interval = True</td>
<td><option>db_inc_retry_interval</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) If True, increases the interval between database connection retries up to db_max_retry_interval.</td>
</tr>
<tr>
<td>db_max_retries = 20</td>
<td><option>db_max_retries</option> = <replaceable>20</replaceable></td>
<td>(IntOpt) Maximum database connection retries before error is raised. Set to -1 to specify an infinite retry count.</td>
</tr>
<tr>
<td>db_max_retry_interval = 10</td>
<td><option>db_max_retry_interval</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) If db_inc_retry_interval is set, the maximum seconds between database connection retries.</td>
</tr>
<tr>
<td>db_retry_interval = 1</td>
<td><option>db_retry_interval</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Seconds between database connection retries.</td>
</tr>
<tr>
<td>idle_timeout = 3600</td>
<td><option>idle_timeout</option> = <replaceable>3600</replaceable></td>
<td>(IntOpt) Timeout before idle SQL connections are reaped.</td>
</tr>
<tr>
<td>max_overflow = None</td>
<td><option>max_overflow</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) If set, use this value for max_overflow with SQLAlchemy.</td>
</tr>
<tr>
<td>max_pool_size = None</td>
<td><option>max_pool_size</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) Maximum number of SQL connections to keep open in a pool.</td>
</tr>
<tr>
<td>max_retries = 10</td>
<td>(IntOpt) Maximum db connection retries during startup. Set to -1 to specify an infinite retry count.</td>
<td><option>max_retries</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.</td>
</tr>
<tr>
<td>min_pool_size = 1</td>
<td><option>min_pool_size</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Minimum number of SQL connections to keep open in a pool.</td>
</tr>
<tr>
<td>mysql_sql_mode = TRADITIONAL</td>
<td><option>mysql_sql_mode</option> = <replaceable>TRADITIONAL</replaceable></td>
<td>(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=</td>
</tr>
<tr>
<td>pool_timeout = None</td>
<td><option>pool_timeout</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) If set, use this value for pool_timeout with SQLAlchemy.</td>
</tr>
<tr>
<td>retry_interval = 10</td>
<td><option>retry_interval</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Interval between retries of opening a SQL connection.</td>
</tr>
<tr>
<td>slave_connection = None</td>
<td><option>slave_connection</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The SQLAlchemy connection string to use to connect to the slave database.</td>
</tr>
<tr>
<td>sqlite_db = oslo.sqlite</td>
<td><option>sqlite_db</option> = <replaceable>oslo.sqlite</replaceable></td>
<td>(StrOpt) The file name to use with SQLite.</td>
</tr>
<tr>
<td>sqlite_synchronous = True</td>
<td><option>sqlite_synchronous</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) If True, SQLite uses synchronous mode.</td>
</tr>
<tr>
<td>use_db_reconnect = False</td>
<td><option>use_db_reconnect</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enable the experimental use of database reconnect on connection lost.</td>
</tr>
</tbody>

6
doc/common/tables/sahara-domain.xml
View File

@ -18,15 +18,15 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>proxy_user_domain_name = None</td>
<td><option>proxy_user_domain_name</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The domain Sahara will use to create new proxy users for Swift object access.</td>
</tr>
<tr>
<td>proxy_user_role_names = Member</td>
<td><option>proxy_user_role_names</option> = <replaceable>Member</replaceable></td>
<td>(ListOpt) A list of the role names that the proxy user should assume through trust for Swift object access.</td>
</tr>
<tr>
<td>use_domain_for_proxy_users = False</td>
<td><option>use_domain_for_proxy_users</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enables Sahara to use a domain for creating temporary proxy users to access Swift. If this is enabled a domain must be created for Sahara to use.</td>
</tr>
</tbody>

42
doc/common/tables/sahara-logging.xml
View File

@ -18,87 +18,87 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>debug = False</td>
<td><option>debug</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).</td>
</tr>
<tr>
<td>default_log_levels = amqplib=WARN, qpid.messaging=INFO, stevedore=INFO, eventlet.wsgi.server=WARN, sqlalchemy=WARN, boto=WARN, suds=INFO, keystone=INFO, paramiko=WARN, requests=WARN, iso8601=WARN</td>
<td><option>default_log_levels</option> = <replaceable>amqplib=WARN, qpid.messaging=INFO, stevedore=INFO, eventlet.wsgi.server=WARN, sqlalchemy=WARN, boto=WARN, suds=INFO, keystone=INFO, paramiko=WARN, requests=WARN, iso8601=WARN, oslo.messaging=INFO</replaceable></td>
<td>(ListOpt) List of logger=LEVEL pairs.</td>
</tr>
<tr>
<td>fatal_deprecations = False</td>
<td><option>fatal_deprecations</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enables or disables fatal status of deprecations.</td>
</tr>
<tr>
<td>instance_format = "[instance: %(uuid)s] "</td>
<td><option>instance_format</option> = <replaceable>"[instance: %(uuid)s] "</replaceable></td>
<td>(StrOpt) The format for an instance that is passed with the log message.</td>
</tr>
<tr>
<td>instance_uuid_format = "[instance: %(uuid)s] "</td>
<td><option>instance_uuid_format</option> = <replaceable>"[instance: %(uuid)s] "</replaceable></td>
<td>(StrOpt) The format for an instance UUID that is passed with the log message.</td>
</tr>
<tr>
<td>log_config_append = None</td>
<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>
</tr>
<tr>
<td>log_date_format = %Y-%m-%d %H:%M:%S</td>
<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>
</tr>
<tr>
<td>log_dir = None</td>
<td><option>log_dir</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) (Optional) The base directory used for relative --log-file paths.</td>
</tr>
<tr>
<td>log_exchange = False</td>
<td><option>log_exchange</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Log request/response exchange details: environ, headers and bodies.</td>
</tr>
<tr>
<td>log_file = None</td>
<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>
</tr>
<tr>
<td>log_format = None</td>
<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>
</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><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>
<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><option>logging_debug_format_suffix</option> = <replaceable>%(funcName)s %(pathname)s:%(lineno)d</replaceable></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><option>logging_default_format_string</option> = <replaceable>%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s</replaceable></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><option>logging_exception_prefix</option> = <replaceable>%(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s</replaceable></td>
<td>(StrOpt) Prefix each line of exception output with this format.</td>
</tr>
<tr>
<td>publish_errors = False</td>
<td><option>publish_errors</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enables or disables publication of error events.</td>
</tr>
<tr>
<td>syslog_log_facility = LOG_USER</td>
<td><option>syslog_log_facility</option> = <replaceable>LOG_USER</replaceable></td>
<td>(StrOpt) Syslog facility to receive log lines.</td>
</tr>
<tr>
<td>use_stderr = True</td>
<td><option>use_stderr</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Log output to standard error.</td>
</tr>
<tr>
<td>use_syslog = False</td>
<td><option>use_syslog</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424.</td>
</tr>
<tr>
<td>use_syslog_rfc_format = False</td>
<td><option>use_syslog_rfc_format</option> = <replaceable>False</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 I, and will be removed in J.</td>
</tr>
<tr>
<td>verbose = False</td>
<td><option>verbose</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).</td>
</tr>
</tbody>

22
doc/common/tables/sahara-qpid.xml
View File

@ -18,47 +18,47 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>qpid_heartbeat = 60</td>
<td><option>qpid_heartbeat</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Seconds between connection keepalive heartbeats.</td>
</tr>
<tr>
<td>qpid_hostname = localhost</td>
<td><option>qpid_hostname</option> = <replaceable>localhost</replaceable></td>
<td>(StrOpt) Qpid broker hostname.</td>
</tr>
<tr>
<td>qpid_hosts = $qpid_hostname:$qpid_port</td>
<td><option>qpid_hosts</option> = <replaceable>$qpid_hostname:$qpid_port</replaceable></td>
<td>(ListOpt) Qpid HA cluster host:port pairs.</td>
</tr>
<tr>
<td>qpid_password = </td>
<td><option>qpid_password</option> = <replaceable></replaceable></td>
<td>(StrOpt) Password for Qpid connection.</td>
</tr>
<tr>
<td>qpid_port = 5672</td>
<td><option>qpid_port</option> = <replaceable>5672</replaceable></td>
<td>(IntOpt) Qpid broker port.</td>
</tr>
<tr>
<td>qpid_protocol = tcp</td>
<td><option>qpid_protocol</option> = <replaceable>tcp</replaceable></td>
<td>(StrOpt) Transport to use, either 'tcp' or 'ssl'.</td>
</tr>
<tr>
<td>qpid_receiver_capacity = 1</td>
<td><option>qpid_receiver_capacity</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) The number of prefetched messages held by receiver.</td>
</tr>
<tr>
<td>qpid_sasl_mechanisms = </td>
<td><option>qpid_sasl_mechanisms</option> = <replaceable></replaceable></td>
<td>(StrOpt) Space separated list of SASL mechanisms to use for auth.</td>
</tr>
<tr>
<td>qpid_tcp_nodelay = True</td>
<td><option>qpid_tcp_nodelay</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Whether to disable the Nagle algorithm.</td>
</tr>
<tr>
<td>qpid_topology_version = 1</td>
<td><option>qpid_topology_version</option> = <replaceable>1</replaceable></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>
<tr>
<td>qpid_username = </td>
<td><option>qpid_username</option> = <replaceable></replaceable></td>
<td>(StrOpt) Username for Qpid connection.</td>
</tr>
</tbody>

38
doc/common/tables/sahara-rabbitmq.xml
View File

@ -18,71 +18,71 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>kombu_reconnect_delay = 1.0</td>
<td><option>kombu_reconnect_delay</option> = <replaceable>1.0</replaceable></td>
<td>(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.</td>
</tr>
<tr>
<td>kombu_ssl_ca_certs = </td>
<td><option>kombu_ssl_ca_certs</option> = <replaceable></replaceable></td>
<td>(StrOpt) SSL certification authority file (valid only if SSL enabled).</td>
</tr>
<tr>
<td>kombu_ssl_certfile = </td>
<td><option>kombu_ssl_certfile</option> = <replaceable></replaceable></td>
<td>(StrOpt) SSL cert file (valid only if SSL enabled).</td>
</tr>
<tr>
<td>kombu_ssl_keyfile = </td>
<td><option>kombu_ssl_keyfile</option> = <replaceable></replaceable></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>
<td><option>kombu_ssl_version</option> = <replaceable></replaceable></td>
<td>(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1 and SSLv23. SSLv2 and SSLv3 may be available on some distributions.</td>
</tr>
<tr>
<td>rabbit_ha_queues = False</td>
<td><option>rabbit_ha_queues</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database.</td>
</tr>
<tr>
<td>rabbit_host = localhost</td>
<td><option>rabbit_host</option> = <replaceable>localhost</replaceable></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><option>rabbit_hosts</option> = <replaceable>$rabbit_host:$rabbit_port</replaceable></td>
<td>(ListOpt) RabbitMQ HA cluster host:port pairs.</td>
</tr>
<tr>
<td>rabbit_login_method = AMQPLAIN</td>
<td>(StrOpt) the RabbitMQ login method</td>
<td><option>rabbit_login_method</option> = <replaceable>AMQPLAIN</replaceable></td>
<td>(StrOpt) The RabbitMQ login method.</td>
</tr>
<tr>
<td>rabbit_max_retries = 0</td>
<td><option>rabbit_max_retries</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).</td>
</tr>
<tr>
<td>rabbit_password = guest</td>
<td><option>rabbit_password</option> = <replaceable>guest</replaceable></td>
<td>(StrOpt) The RabbitMQ password.</td>
</tr>
<tr>
<td>rabbit_port = 5672</td>
<td><option>rabbit_port</option> = <replaceable>5672</replaceable></td>
<td>(IntOpt) The RabbitMQ broker port where a single node is used.</td>
</tr>
<tr>
<td>rabbit_retry_backoff = 2</td>
<td><option>rabbit_retry_backoff</option> = <replaceable>2</replaceable></td>
<td>(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.</td>
</tr>
<tr>
<td>rabbit_retry_interval = 1</td>
<td><option>rabbit_retry_interval</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) How frequently to retry connecting with RabbitMQ.</td>
</tr>
<tr>
<td>rabbit_use_ssl = False</td>
<td><option>rabbit_use_ssl</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Connect over SSL for RabbitMQ.</td>
</tr>
<tr>
<td>rabbit_userid = guest</td>
<td><option>rabbit_userid</option> = <replaceable>guest</replaceable></td>
<td>(StrOpt) The RabbitMQ userid.</td>
</tr>
<tr>
<td>rabbit_virtual_host = /</td>
<td><option>rabbit_virtual_host</option> = <replaceable>/</replaceable></td>
<td>(StrOpt) The RabbitMQ virtual host.</td>
</tr>
</tbody>

8
doc/common/tables/sahara-redis.xml
View File

@ -18,22 +18,22 @@
<th colspan="2">[matchmaker_redis]</th>
</tr>
<tr>
<td>host = 127.0.0.1</td>
<td><option>host</option> = <replaceable>127.0.0.1</replaceable></td>
<td>(StrOpt) Host to locate redis.</td>
</tr>
<tr>
<td>password = None</td>
<td><option>password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Password for Redis server (optional).</td>
</tr>
<tr>
<td>port = 6379</td>
<td><option>port</option> = <replaceable>6379</replaceable></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><option>ringfile</option> = <replaceable>/etc/oslo/matchmaker_ring.json</replaceable></td>
<td>(StrOpt) Matchmaker ring file (JSON).</td>
</tr>
</tbody>

57
doc/common/tables/sahara-rootwrap.xml Normal file
View File

@ -0,0 +1,57 @@
<?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_sahara_rootwrap">
<caption>Description of rootwrap 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><option>filters_path</option> = <replaceable>/etc/sahara/rootwrap.d</replaceable></td>
<td>List of directories to load filter definitions from (separated by ','). These directories MUST all be only writeable by root !</td>
</tr>
<tr>
<td><option>exec_dirs</option> = <replaceable>/sbin,/usr/sbin,/bin,/usr/bin</replaceable></td>
<td>List of directories to search executables in, in case filters do not explicitely specify a full path (separated by ',') If not specified, defaults to system PATH environment variable. These directories MUST all be only writeable by root !</td>
</tr>
<tr>
<td><option>use_syslog</option> = <replaceable>False</replaceable></td>
<td>Enable logging to syslog Default value is False</td>
</tr>
<tr>
<td><option>syslog_log_facility</option> = <replaceable>syslog</replaceable></td>
<td>Which syslog facility to use. Valid values include auth, authpriv, syslog, local0, local1... Default value is 'syslog'</td>
</tr>
<tr>
<td><option>syslog_log_level</option> = <replaceable>ERROR</replaceable></td>
<td>Which messages to log. INFO means log all usage ERROR means only log unsuccessful attempts</td>
</tr>
<tr>
<th colspan="2">[xenapi]</th>
</tr>
<tr>
<td><option>xenapi_connection_url</option> = <replaceable>&lt;None&gt;</replaceable></td>
<td>XenAPI configuration is only required by the L2 agent if it is to target a XenServer/XCP compute host's dom0.</td>
</tr>
<tr>
<td><option>xenapi_connection_username</option> = <replaceable>root</replaceable></td>
<td>No help text available for this option.</td>
</tr>
<tr>
<td><option>xenapi_connection_password</option> = <replaceable>&lt;None&gt;</replaceable></td>
<td>No help text available for this option.</td>
</tr>
</tbody>
</table>
</para>

61
doc/common/tables/sahara-rpc.xml
View File

@ -18,33 +18,80 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>matchmaker_heartbeat_freq = 300</td>
<td><option>matchmaker_heartbeat_freq</option> = <replaceable>300</replaceable></td>
<td>(IntOpt) Heartbeat frequency.</td>
</tr>
<tr>
<td>matchmaker_heartbeat_ttl = 600</td>
<td><option>matchmaker_heartbeat_ttl</option> = <replaceable>600</replaceable></td>
<td>(IntOpt) Heartbeat time-to-live.</td>
</tr>
<tr>
<td>rpc_backend = rabbit</td>
<td><option>rpc_backend</option> = <replaceable>rabbit</replaceable></td>
<td>(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq.</td>
</tr>
<tr>
<td>rpc_cast_timeout = 30</td>
<td><option>rpc_cast_timeout</option> = <replaceable>30</replaceable></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><option>rpc_conn_pool_size</option> = <replaceable>30</replaceable></td>
<td>(IntOpt) Size of RPC connection pool.</td>
</tr>
<tr>
<td>rpc_response_timeout = 60</td>
<td><option>rpc_response_timeout</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Seconds to wait for a response from a call.</td>
</tr>
<tr>
<td>rpc_thread_pool_size = 64</td>
<td><option>rpc_thread_pool_size</option> = <replaceable>64</replaceable></td>
<td>(IntOpt) Size of RPC greenthread pool.</td>
</tr>
<tr>
<th colspan="2">[oslo_messaging_amqp]</th>
</tr>
<tr>
<td><option>allow_insecure_clients</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Accept clients using either SSL or plain TCP</td>
</tr>
<tr>
<td><option>broadcast_prefix</option> = <replaceable>broadcast</replaceable></td>
<td>(StrOpt) address prefix used when broadcasting to all servers</td>
</tr>
<tr>
<td><option>container_name</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Name for the AMQP container</td>
</tr>
<tr>
<td><option>group_request_prefix</option> = <replaceable>unicast</replaceable></td>
<td>(StrOpt) address prefix when sending to any server in group</td>
</tr>
<tr>
<td><option>idle_timeout</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) Timeout for inactive connections (in seconds)</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>
</tr>
<tr>
<td><option>ssl_ca_file</option> = <replaceable></replaceable></td>
<td>(StrOpt) CA certificate PEM file for verifing server certificate</td>
</tr>
<tr>
<td><option>ssl_cert_file</option> = <replaceable></replaceable></td>
<td>(StrOpt) Identifying certificate PEM file to present to clients</td>
</tr>
<tr>
<td><option>ssl_key_file</option> = <replaceable></replaceable></td>
<td>(StrOpt) Private key PEM file used to sign cert_file certificate</td>
</tr>
<tr>
<td><option>ssl_key_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Password for decrypting ssl_key_file (if encrypted)</td>
</tr>
<tr>
<td><option>trace</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Debug: dump AMQP frames to stdout</td>
</tr>
</tbody>
</table>
</para>

4
doc/common/tables/sahara-testing.xml
View File

@ -18,8 +18,8 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>fake_rabbit = False</td>
<td>(BoolOpt) If passed, use a fake RabbitMQ provider.</td>
<td><option>fake_rabbit</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake</td>
</tr>
</tbody>
</table>

14
doc/common/tables/sahara-zeromq.xml
View File

@ -18,31 +18,31 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>rpc_zmq_bind_address = *</td>
<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>rpc_zmq_contexts = 1</td>
<td><option>rpc_zmq_contexts</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Number of ZeroMQ contexts, defaults to 1.</td>
</tr>
<tr>
<td>rpc_zmq_host = localhost</td>
<td><option>rpc_zmq_host</option> = <replaceable>localhost</replaceable></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><option>rpc_zmq_ipc_dir</option> = <replaceable>/var/run/openstack</replaceable></td>
<td>(StrOpt) Directory for holding IPC sockets.</td>
</tr>
<tr>
<td>rpc_zmq_matchmaker = oslo.messaging._drivers.matchmaker.MatchMakerLocalhost</td>
<td><option>rpc_zmq_matchmaker</option> = <replaceable>oslo.messaging._drivers.matchmaker.MatchMakerLocalhost</replaceable></td>
<td>(StrOpt) MatchMaker driver.</td>
</tr>
<tr>
<td>rpc_zmq_port = 9501</td>
<td><option>rpc_zmq_port</option> = <replaceable>9501</replaceable></td>
<td>(IntOpt) ZeroMQ receiver listening port.</td>
</tr>
<tr>
<td>rpc_zmq_topic_backlog = None</td>
<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>
</tbody>

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

@ -18,40 +18,40 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>amqp_auto_delete = False</td>
<td>(BoolOpt) Auto-delete queues in amqp.</td>
<td><option>amqp_auto_delete</option> = <replaceable>False</replaceable></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>
<td><option>amqp_durable_queues</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Use durable queues in AMQP.</td>
</tr>
<tr>
<td>conductor_manager = trove.conductor.manager.Manager</td>
<td><option>conductor_manager</option> = <replaceable>trove.conductor.manager.Manager</replaceable></td>
<td>(StrOpt) Qualified class name to use for conductor manager.</td>
</tr>
<tr>
<td>conductor_queue = trove-conductor</td>
<td><option>conductor_queue</option> = <replaceable>trove-conductor</replaceable></td>
<td>(StrOpt) Message queue name the Conductor will listen on.</td>
</tr>
<tr>
<td>control_exchange = openstack</td>
<td>(StrOpt) AMQP exchange to connect to if using RabbitMQ or Qpid</td>
<td><option>control_exchange</option> = <replaceable>openstack</replaceable></td>
<td>(StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.</td>
</tr>
<tr>
<td>default_publisher_id = $host</td>
<td>(StrOpt) Default publisher_id for outgoing notifications</td>
<td><option>notification_driver</option> = <replaceable>[]</replaceable></td>
<td>(MultiStrOpt) Driver or drivers to handle sending notifications.</td>
</tr>
<tr>
<td>notification_driver = []</td>
<td>(MultiStrOpt) Driver or drivers to handle sending notifications</td>
</tr>
<tr>
<td>notification_service_id = {'postgresql': 'ac277e0d-4f21-40aa-b347-1ea31e571720', 'couchbase': 'fa62fe68-74d9-4779-a24e-36f19602c415', 'mongodb': 'c8c907af-7375-456f-b929-b637ff9209ee', 'redis': 'b216ffc5-1947-456c-a4cf-70f94c05f7d0', 'mysql': '2f3ff068-2bfb-4f70-9a9d-a6bb65bc084b', 'cassandra': '459a230d-4e97-4344-9067-2a54a310b0ed'}</td>
<td><option>notification_service_id</option> = <replaceable>{'postgresql': 'ac277e0d-4f21-40aa-b347-1ea31e571720', 'couchbase': 'fa62fe68-74d9-4779-a24e-36f19602c415', 'mongodb': 'c8c907af-7375-456f-b929-b637ff9209ee', 'redis': 'b216ffc5-1947-456c-a4cf-70f94c05f7d0', 'mysql': '2f3ff068-2bfb-4f70-9a9d-a6bb65bc084b', 'cassandra': '459a230d-4e97-4344-9067-2a54a310b0ed'}</replaceable></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>
<td><option>notification_topics</option> = <replaceable>notifications</replaceable></td>
<td>(ListOpt) AMQP topic used for OpenStack notifications.</td>
</tr>
<tr>
<td><option>transport_url</option> = <replaceable>None</replaceable></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>

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

@ -18,99 +18,99 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>admin_roles = admin</td>
<td><option>admin_roles</option> = <replaceable>admin</replaceable></td>
<td>(ListOpt) Roles to add to an admin user.</td>
</tr>
<tr>
<td>api_paste_config = api-paste.ini</td>
<td><option>api_paste_config</option> = <replaceable>api-paste.ini</replaceable></td>
<td>(StrOpt) File name for the paste.deploy config for trove-api.</td>
</tr>
<tr>
<td>bind_host = 0.0.0.0</td>
<td><option>bind_host</option> = <replaceable>0.0.0.0</replaceable></td>
<td>(StrOpt) IP address the API server will listen on.</td>
</tr>
<tr>
<td>bind_port = 8779</td>
<td><option>bind_port</option> = <replaceable>8779</replaceable></td>
<td>(IntOpt) Port the API server will listen on.</td>
</tr>
<tr>
<td>black_list_regex = None</td>
<td><option>black_list_regex</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Exclude IP addresses that match this regular expression.</td>
</tr>
<tr>
<td>db_api_implementation = trove.db.sqlalchemy.api</td>
<td><option>db_api_implementation</option> = <replaceable>trove.db.sqlalchemy.api</replaceable></td>
<td>(StrOpt) API Implementation for Trove database access.</td>
</tr>
<tr>
<td>hostname_require_valid_ip = True</td>
<td><option>hostname_require_valid_ip</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Require user hostnames to be valid IP addresses.</td>
</tr>
<tr>
<td>http_delete_rate = 200</td>
<td><option>http_delete_rate</option> = <replaceable>200</replaceable></td>
<td>(IntOpt) Maximum number of HTTP 'DELETE' requests (per minute).</td>
</tr>
<tr>
<td>http_get_rate = 200</td>
<td><option>http_get_rate</option> = <replaceable>200</replaceable></td>
<td>(IntOpt) Maximum number of HTTP 'GET' requests (per minute).</td>
</tr>
<tr>
<td>http_mgmt_post_rate = 200</td>
<td><option>http_mgmt_post_rate</option> = <replaceable>200</replaceable></td>
<td>(IntOpt) Maximum number of management HTTP 'POST' requests (per minute).</td>
</tr>
<tr>
<td>http_post_rate = 200</td>
<td><option>http_post_rate</option> = <replaceable>200</replaceable></td>
<td>(IntOpt) Maximum number of HTTP 'POST' requests (per minute).</td>
</tr>
<tr>
<td>http_put_rate = 200</td>
<td><option>http_put_rate</option> = <replaceable>200</replaceable></td>
<td>(IntOpt) Maximum number of HTTP 'PUT' requests (per minute).</td>
</tr>
<tr>
<td>instances_page_size = 20</td>
<td><option>instances_page_size</option> = <replaceable>20</replaceable></td>
<td>(IntOpt) Page size for listing instances.</td>
</tr>
<tr>
<td>max_header_line = 16384</td>
<td><option>max_header_line</option> = <replaceable>16384</replaceable></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>os_region_name = None</td>
<td><option>os_region_name</option> = <replaceable>RegionOne</replaceable></td>
<td>(StrOpt) Region name of this node. Used when searching catalog.</td>
</tr>
<tr>
<td>region = LOCAL_DEV</td>
<td><option>region</option> = <replaceable>LOCAL_DEV</replaceable></td>
<td>(StrOpt) The region this service is located.</td>
</tr>
<tr>
<td>tcp_keepidle = 600</td>
<td><option>tcp_keepidle</option> = <replaceable>600</replaceable></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><option>trove_api_workers</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) Number of workers for the API service. The default will be the number of CPUs available.</td>
</tr>
<tr>
<td>trove_auth_url = http://0.0.0.0:5000/v2.0</td>
<td><option>trove_auth_url</option> = <replaceable>http://0.0.0.0:5000/v2.0</replaceable></td>
<td>(StrOpt) Trove authentication URL.</td>
</tr>
<tr>
<td>trove_conductor_workers = None</td>
<td><option>trove_conductor_workers</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) Number of workers for the Conductor service. The default will be the number of CPUs available.</td>
</tr>
<tr>
<td>trove_security_group_name_prefix = SecGroup</td>
<td><option>trove_security_group_name_prefix</option> = <replaceable>SecGroup</replaceable></td>
<td>(StrOpt) Prefix to use when creating Security Groups.</td>
</tr>
<tr>
<td>trove_security_group_rule_cidr = 0.0.0.0/0</td>
<td><option>trove_security_group_rule_cidr</option> = <replaceable>0.0.0.0/0</replaceable></td>
<td>(StrOpt) CIDR to use when creating Security Group Rules.</td>
</tr>
<tr>
<td>trove_security_groups_support = True</td>
<td><option>trove_security_groups_support</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Whether Trove should add Security Groups on create.</td>
</tr>
<tr>
<td>users_page_size = 20</td>
<td><option>users_page_size</option> = <replaceable>20</replaceable></td>
<td>(IntOpt) Page size for listing users.</td>
</tr>
</tbody>

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

@ -18,115 +18,115 @@
<th colspan="2">[keystone_authtoken]</th>
</tr>
<tr>
<td>admin_password = None</td>
<td>(StrOpt) Keystone account password</td>
<td><option>admin_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Service user password.</td>
</tr>
<tr>
<td>admin_tenant_name = admin</td>
<td>(StrOpt) Keystone service account tenant name to validate user tokens</td>
<td><option>admin_tenant_name</option> = <replaceable>admin</replaceable></td>
<td>(StrOpt) Service tenant name.</td>
</tr>
<tr>
<td>admin_token = None</td>
<td><option>admin_token</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead.</td>
</tr>
<tr>
<td>admin_user = None</td>
<td>(StrOpt) Keystone account username</td>
<td><option>admin_user</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Service username.</td>
</tr>
<tr>
<td>auth_admin_prefix = </td>
<td><option>auth_admin_prefix</option> = <replaceable></replaceable></td>
<td>(StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri.</td>
</tr>
<tr>
<td>auth_host = 127.0.0.1</td>
<td><option>auth_host</option> = <replaceable>127.0.0.1</replaceable></td>
<td>(StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri.</td>
</tr>
<tr>
<td>auth_port = 35357</td>
<td><option>auth_port</option> = <replaceable>35357</replaceable></td>
<td>(IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri.</td>
</tr>
<tr>
<td>auth_protocol = https</td>
<td><option>auth_protocol</option> = <replaceable>https</replaceable></td>
<td>(StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri.</td>
</tr>
<tr>
<td>auth_uri = None</td>
<td>(StrOpt) Complete public Identity API endpoint</td>
<td><option>auth_uri</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Complete public Identity API endpoint.</td>
</tr>
<tr>
<td>auth_version = None</td>
<td>(StrOpt) API version of the admin Identity API endpoint</td>
<td><option>auth_version</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) API version of the admin Identity API endpoint.</td>
</tr>
<tr>
<td>cache = None</td>
<td>(StrOpt) Env key for the swift cache</td>
<td><option>cache</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Env key for the swift cache.</td>
</tr>
<tr>
<td>cafile = None</td>
<td><option>cafile</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.</td>
</tr>
<tr>
<td>certfile = None</td>
<td>(StrOpt) Required if Keystone server requires client certificate</td>
<td><option>certfile</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Required if identity server requires client certificate</td>
</tr>
<tr>
<td>check_revocations_for_cached = False</td>
<td>(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the Keystone server.</td>
<td><option>check_revocations_for_cached</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server.</td>
</tr>
<tr>
<td>delay_auth_decision = False</td>
<td>(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components</td>
<td><option>delay_auth_decision</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components.</td>
</tr>
<tr>
<td>enforce_token_bind = permissive</td>
<td><option>enforce_token_bind</option> = <replaceable>permissive</replaceable></td>
<td>(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens.</td>
</tr>
<tr>
<td>hash_algorithms = md5</td>
<td><option>hash_algorithms</option> = <replaceable>md5</replaceable></td>
<td>(ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance.</td>
</tr>
<tr>
<td>http_connect_timeout = None</td>
<td>(BoolOpt) Request timeout value for communicating with Identity API server.</td>
<td><option>http_connect_timeout</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) Request timeout value for communicating with Identity API server.</td>
</tr>
<tr>
<td>http_request_max_retries = 3</td>
<td><option>http_request_max_retries</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server.</td>
</tr>
<tr>
<td>identity_uri = None</td>
<td><option>identity_uri</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/</td>
</tr>
<tr>
<td>include_service_catalog = True</td>
<td>(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.</td>
<td><option>include_service_catalog</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.</td>
</tr>
<tr>
<td>insecure = False</td>
<td><option>insecure</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Verify HTTPS connections.</td>
</tr>
<tr>
<td>keyfile = None</td>
<td>(StrOpt) Required if Keystone server requires client certificate</td>
<td><option>keyfile</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Required if identity server requires client certificate</td>
</tr>
<tr>
<td>memcache_secret_key = None</td>
<td>(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation.</td>
<td><option>memcache_secret_key</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.</td>
</tr>
<tr>
<td>memcache_security_strategy = None</td>
<td>(StrOpt) (optional) if defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.</td>
<td><option>memcache_security_strategy</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.</td>
</tr>
<tr>
<td>revocation_cache_time = 10</td>
<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>
</tr>
<tr>
<td>signing_dir = None</td>
<td>(StrOpt) Directory used to cache files related to PKI tokens</td>
<td><option>signing_dir</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Directory used to cache files related to PKI tokens.</td>
</tr>
<tr>
<td>token_cache_time = 300</td>
<td><option>token_cache_time</option> = <replaceable>300</replaceable></td>
<td>(IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely.</td>
</tr>
</tbody>

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

@ -18,43 +18,43 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>backup_aes_cbc_key = default_aes_cbc_key</td>
<td><option>backup_aes_cbc_key</option> = <replaceable>default_aes_cbc_key</replaceable></td>
<td>(StrOpt) Default OpenSSL aes_cbc key.</td>
</tr>
<tr>
<td>backup_chunk_size = 65536</td>
<td><option>backup_chunk_size</option> = <replaceable>65536</replaceable></td>
<td>(IntOpt) Chunk size (in bytes) to stream to the 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_runner = trove.guestagent.backup.backup_types.InnoBackupEx</td>
<td><option>backup_runner</option> = <replaceable>trove.guestagent.backup.backup_types.InnoBackupEx</replaceable></td>
<td>(StrOpt) Runner to use for backups.</td>
</tr>
<tr>
<td>backup_runner_options = {}</td>
<td><option>backup_runner_options</option> = <replaceable>{}</replaceable></td>
<td>(DictOpt) Additional options to be passed to the backup runner.</td>
</tr>
<tr>
<td>backup_segment_max_size = 2147483648</td>
<td><option>backup_segment_max_size</option> = <replaceable>2147483648</replaceable></td>
<td>(IntOpt) Maximum size (in bytes) of each segment of the backup file.</td>
</tr>
<tr>
<td>backup_swift_container = database_backups</td>
<td><option>backup_swift_container</option> = <replaceable>database_backups</replaceable></td>
<td>(StrOpt) Swift container to put backups in.</td>
</tr>
<tr>
<td>backup_use_gzip_compression = True</td>
<td><option>backup_use_gzip_compression</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Compress backups using gzip.</td>
</tr>
<tr>
<td>backup_use_openssl_encryption = True</td>
<td><option>backup_use_openssl_encryption</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Encrypt backups using OpenSSL.</td>
</tr>
<tr>
<td>backup_use_snet = False</td>
<td><option>backup_use_snet</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Send backup files over snet.</td>
</tr>
<tr>
<td>backups_page_size = 20</td>
<td><option>backups_page_size</option> = <replaceable>20</replaceable></td>
<td>(IntOpt) Page size for listing backups.</td>
</tr>
</tbody>

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

@ -18,15 +18,15 @@
<th colspan="2">[ssl]</th>
</tr>
<tr>
<td>ca_file = None</td>
<td><option>ca_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) CA certificate file to use to verify connecting clients</td>
</tr>
<tr>
<td>cert_file = None</td>
<td><option>cert_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Certificate file to use when starting the server securely</td>
</tr>
<tr>
<td>key_file = None</td>
<td><option>key_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Private key file to use when starting the server securely</td>
</tr>
</tbody>

14
doc/common/tables/trove-clients.xml
View File

@ -18,31 +18,31 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>remote_cinder_client = trove.common.remote.cinder_client</td>
<td><option>remote_cinder_client</option> = <replaceable>trove.common.remote.cinder_client</replaceable></td>
<td>(StrOpt) Client to send Cinder calls to.</td>
</tr>
<tr>
<td>remote_dns_client = trove.common.remote.dns_client</td>
<td><option>remote_dns_client</option> = <replaceable>trove.common.remote.dns_client</replaceable></td>
<td>(StrOpt) Client to send DNS calls to.</td>
</tr>
<tr>
<td>remote_guest_client = trove.common.remote.guest_client</td>
<td><option>remote_guest_client</option> = <replaceable>trove.common.remote.guest_client</replaceable></td>
<td>(StrOpt) Client to send Guest Agent calls to.</td>
</tr>
<tr>
<td>remote_heat_client = trove.common.remote.heat_client</td>
<td><option>remote_heat_client</option> = <replaceable>trove.common.remote.heat_client</replaceable></td>
<td>(StrOpt) Client to send Heat calls to.</td>
</tr>
<tr>
<td>remote_neutron_client = trove.common.remote.neutron_client</td>
<td><option>remote_neutron_client</option> = <replaceable>trove.common.remote.neutron_client</replaceable></td>
<td>(StrOpt) Client to send Neutron calls to.</td>
</tr>
<tr>
<td>remote_nova_client = trove.common.remote.nova_client</td>
<td><option>remote_nova_client</option> = <replaceable>trove.common.remote.nova_client</replaceable></td>
<td>(StrOpt) Client to send Nova calls to.</td>
</tr>
<tr>
<td>remote_swift_client = trove.common.remote.swift_client</td>
<td><option>remote_swift_client</option> = <replaceable>trove.common.remote.swift_client</replaceable></td>
<td>(StrOpt) Client to send Swift calls to.</td>
</tr>
</tbody>

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

@ -18,15 +18,15 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>cluster_delete_time_out = 180</td>
<td><option>cluster_delete_time_out</option> = <replaceable>180</replaceable></td>
<td>(IntOpt) Maximum time (in seconds) to wait for a cluster delete.</td>
</tr>
<tr>
<td>cluster_usage_timeout = 675</td>
<td><option>cluster_usage_timeout</option> = <replaceable>675</replaceable></td>
<td>(IntOpt) Maximum time (in seconds) to wait for a cluster to become active.</td>
</tr>
<tr>
<td>clusters_page_size = 20</td>
<td><option>clusters_page_size</option> = <replaceable>20</replaceable></td>
<td>(IntOpt) Page size for listing clusters.</td>
</tr>
</tbody>

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

@ -18,70 +18,62 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>configurations_page_size = 20</td>
<td><option>configurations_page_size</option> = <replaceable>20</replaceable></td>
<td>(IntOpt) Page size for listing configurations.</td>
</tr>
<tr>
<td>databases_page_size = 20</td>
<td><option>databases_page_size</option> = <replaceable>20</replaceable></td>
<td>(IntOpt) Page size for listing databases.</td>
</tr>
<tr>
<td>default_datastore = None</td>
<td><option>default_datastore</option> = <replaceable>None</replaceable></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_neutron_networks = </td>
<td><option>default_neutron_networks</option> = <replaceable></replaceable></td>
<td>(ListOpt) List of IDs for management networks which should be attached to the instance regardless of what NICs are specified in the create 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><option>default_password_length</option> = <replaceable>36</replaceable></td>
<td>(IntOpt) Character length of generated passwords.</td>
</tr>
<tr>
<td>expected_filetype_suffixes = json</td>
<td><option>expected_filetype_suffixes</option> = <replaceable>json</replaceable></td>
<td>(ListOpt) Filetype endings not to be reattached to an ID by the utils method correct_id_with_req.</td>
</tr>
<tr>
<td>host = 0.0.0.0</td>
<td><option>host</option> = <replaceable>0.0.0.0</replaceable></td>
<td>(StrOpt) Host to listen for RPC messages.</td>
</tr>
<tr>
<td>lock_path = None</td>
<td>(StrOpt) Directory to use for lock files.</td>
</tr>
<tr>
<td>memcached_servers = None</td>
<td><option>memcached_servers</option> = <replaceable>None</replaceable></td>
<td>(ListOpt) Memcached servers or None for in process cache.</td>
</tr>
<tr>
<td>pybasedir = /usr/lib/python/site-packages/trove/trove</td>
<td><option>pybasedir</option> = <replaceable>/usr/lib/python/site-packages/trove/trove</replaceable></td>
<td>(StrOpt) Directory where the Trove python module is installed.</td>
</tr>
<tr>
<td>pydev_path = None</td>
<td><option>pydev_path</option> = <replaceable>None</replaceable></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><option>taskmanager_queue</option> = <replaceable>taskmanager</replaceable></td>
<td>(StrOpt) Message queue name the Taskmanager will listen to.</td>
</tr>
<tr>
<td>template_path = /etc/trove/templates/</td>
<td><option>template_path</option> = <replaceable>/etc/trove/templates/</replaceable></td>
<td>(StrOpt) Path which leads to datastore templates.</td>
</tr>
<tr>
<td>usage_timeout = 600</td>
<td><option>usage_timeout</option> = <replaceable>600</replaceable></td>
<td>(IntOpt) Maximum time (in seconds) to wait for a Guest to become active.</td>
</tr>
<tr>
<th colspan="2">[keystone_authtoken]</th>
</tr>
<tr>
<td>memcached_servers = None</td>
<td><option>memcached_servers</option> = <replaceable>None</replaceable></td>
<td>(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.</td>
</tr>
</tbody>

14
doc/common/tables/trove-compute.xml
View File

@ -18,23 +18,27 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>ip_regex = None</td>
<td><option>ip_regex</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) List IP addresses that match this regular expression.</td>
</tr>
<tr>
<td>nova_compute_service_type = compute</td>
<td><option>nova_compute_endpoint_type</option> = <replaceable>publicURL</replaceable></td>
<td>(StrOpt) Service endpoint type to use when searching catalog.</td>
</tr>
<tr>
<td><option>nova_compute_service_type</option> = <replaceable>compute</replaceable></td>
<td>(StrOpt) Service type to use when searching catalog.</td>
</tr>
<tr>
<td>nova_compute_url = None</td>
<td><option>nova_compute_url</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) URL without the tenant segment.</td>
</tr>
<tr>
<td>root_grant = ALL</td>
<td><option>root_grant</option> = <replaceable>ALL</replaceable></td>
<td>(ListOpt) Permissions to grant to the 'root' user.</td>
</tr>
<tr>
<td>root_grant_option = True</td>
<td><option>root_grant_option</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Assign the 'root' user GRANT permissions.</td>
</tr>
</tbody>

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

@ -18,19 +18,19 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>sql_connection = sqlite:///trove_test.sqlite</td>
<td><option>sql_connection</option> = <replaceable>sqlite:///trove_test.sqlite</replaceable></td>
<td>(StrOpt) SQL Connection.</td>
</tr>
<tr>
<td>sql_idle_timeout = 3600</td>
<td><option>sql_idle_timeout</option> = <replaceable>3600</replaceable></td>
<td>(IntOpt) Idle time (in seconds) after which the connection to the database is reestablished. Some databases will drop connections after a specific amount of idle time. Setting sql_idle_timeout to a lower value than this will ensure that a reconnect occurs before the database can drop the connection.</td>
</tr>
<tr>
<td>sql_query_log = False</td>
<td><option>sql_query_log</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Write all SQL queries to a log.</td>
</tr>
<tr>
<td>sql_query_logging = False</td>
<td><option>sql_query_logging</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Allow insecure logging while executing queries through SQLAlchemy.</td>
</tr>
</tbody>

20
doc/common/tables/trove-db_cassandra.xml
View File

@ -18,43 +18,43 @@
<th colspan="2">[cassandra]</th>
</tr>
<tr>
<td>backup_incremental_strategy = {}</td>
<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>backup_namespace = None</td>
<td><option>backup_namespace</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Namespace to load backup strategies from.</td>
</tr>
<tr>
<td>backup_strategy = None</td>
<td><option>backup_strategy</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Default strategy to perform backups.</td>
</tr>
<tr>
<td>device_path = /dev/vdb</td>
<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>mount_point = /var/lib/cassandra</td>
<td><option>mount_point</option> = <replaceable>/var/lib/cassandra</replaceable></td>
<td>(StrOpt) Filesystem path for mounting volumes if volume support is enabled.</td>
</tr>
<tr>
<td>replication_strategy = None</td>
<td><option>replication_strategy</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Default strategy for replication.</td>
</tr>
<tr>
<td>restore_namespace = None</td>
<td><option>restore_namespace</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Namespace to load restore strategies from.</td>
</tr>
<tr>
<td>tcp_ports = 7000, 7001, 9042, 9160</td>
<td><option>tcp_ports</option> = <replaceable>7000, 7001, 9042, 9160</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>udp_ports = </td>
<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>volume_support = True</td>
<td><option>volume_support</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Whether to provision a Cinder volume for datadir.</td>
</tr>
</tbody>

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

@ -18,47 +18,47 @@
<th colspan="2">[couchbase]</th>
</tr>
<tr>
<td>backup_incremental_strategy = {}</td>
<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>backup_namespace = trove.guestagent.strategies.backup.couchbase_impl</td>
<td><option>backup_namespace</option> = <replaceable>trove.guestagent.strategies.backup.couchbase_impl</replaceable></td>
<td>(StrOpt) Namespace to load backup strategies from.</td>
</tr>
<tr>
<td>backup_strategy = CbBackup</td>
<td><option>backup_strategy</option> = <replaceable>CbBackup</replaceable></td>
<td>(StrOpt) Default strategy to perform backups.</td>
</tr>
<tr>
<td>device_path = /dev/vdb</td>
<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>mount_point = /var/lib/couchbase</td>
<td><option>mount_point</option> = <replaceable>/var/lib/couchbase</replaceable></td>
<td>(StrOpt) Filesystem path for mounting volumes if volume support is enabled.</td>
</tr>
<tr>
<td>replication_strategy = None</td>
<td><option>replication_strategy</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Default strategy for replication.</td>
</tr>
<tr>
<td>restore_namespace = trove.guestagent.strategies.restore.couchbase_impl</td>
<td><option>restore_namespace</option> = <replaceable>trove.guestagent.strategies.restore.couchbase_impl</replaceable></td>
<td>(StrOpt) Namespace to load restore strategies from.</td>
</tr>
<tr>
<td>root_on_create = True</td>
<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>
</tr>
<tr>
<td>tcp_ports = 8091, 8092, 4369, 11209-11211, 21100-21199</td>
<td><option>tcp_ports</option> = <replaceable>8091, 8092, 4369, 11209-11211, 21100-21199</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>udp_ports = </td>
<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>volume_support = True</td>
<td><option>volume_support</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Whether to provision a Cinder volume for datadir.</td>
</tr>
</tbody>

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

@ -18,67 +18,67 @@
<th colspan="2">[mongodb]</th>
</tr>
<tr>
<td>api_strategy = trove.common.strategies.mongodb.api.MongoDbAPIStrategy</td>
<td><option>api_strategy</option> = <replaceable>trove.common.strategies.mongodb.api.MongoDbAPIStrategy</replaceable></td>
<td>(StrOpt) Class that implements datastore-specific API logic.</td>
</tr>
<tr>
<td>backup_incremental_strategy = {}</td>
<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>backup_namespace = None</td>
<td><option>backup_namespace</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Namespace to load backup strategies from.</td>
</tr>
<tr>
<td>backup_strategy = None</td>
<td><option>backup_strategy</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Default strategy to perform backups.</td>
</tr>
<tr>
<td>cluster_support = True</td>
<td><option>cluster_support</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Enable clusters to be created and managed.</td>
</tr>
<tr>
<td>device_path = /dev/vdb</td>
<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>guestagent_strategy = trove.common.strategies.mongodb.guestagent.MongoDbGuestAgentStrategy</td>
<td><option>guestagent_strategy</option> = <replaceable>trove.common.strategies.mongodb.guestagent.MongoDbGuestAgentStrategy</replaceable></td>
<td>(StrOpt) Class that implements datastore-specific Guest Agent API logic.</td>
</tr>
<tr>
<td>mount_point = /var/lib/mongodb</td>
<td><option>mount_point</option> = <replaceable>/var/lib/mongodb</replaceable></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><option>num_config_servers_per_cluster</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) The number of config servers to create per cluster.</td>
</tr>
<tr>
<td>num_query_routers_per_cluster = 1</td>
<td><option>num_query_routers_per_cluster</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) The number of query routers (mongos) to create per cluster.</td>
</tr>
<tr>
<td>replication_strategy = None</td>
<td><option>replication_strategy</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Default strategy for replication.</td>
</tr>
<tr>
<td>restore_namespace = None</td>
<td><option>restore_namespace</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Namespace to load restore strategies from.</td>
</tr>
<tr>
<td>taskmanager_strategy = trove.common.strategies.mongodb.taskmanager.MongoDbTaskManagerStrategy</td>
<td><option>taskmanager_strategy</option> = <replaceable>trove.common.strategies.mongodb.taskmanager.MongoDbTaskManagerStrategy</replaceable></td>
<td>(StrOpt) Class that implements datastore-specific task manager logic.</td>
</tr>
<tr>
<td>tcp_ports = 2500, 27017</td>
<td><option>tcp_ports</option> = <replaceable>2500, 27017</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>udp_ports = </td>
<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>
</tr>
<tr>
<td>volume_support = True</td>
<td><option>volume_support</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Whether to provision a Cinder volume for datadir.</td>
</tr>
</tbody>

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

@ -18,55 +18,55 @@
<th colspan="2">[mysql]</th>
</tr>
<tr>
<td>backup_incremental_strategy = {'InnoBackupEx': 'InnoBackupExIncremental'}</td>
<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>backup_namespace = trove.guestagent.strategies.backup.mysql_impl</td>
<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>backup_strategy = InnoBackupEx</td>
<td><option>backup_strategy</option> = <replaceable>InnoBackupEx</replaceable></td>
<td>(StrOpt) Default strategy to perform backups.</td>
</tr>
<tr>
<td>device_path = /dev/vdb</td>
<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>mount_point = /var/lib/mysql</td>
<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>replication_namespace = trove.guestagent.strategies.replication.mysql_binlog</td>
<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>replication_strategy = MysqlBinlogReplication</td>
<td><option>replication_strategy</option> = <replaceable>MysqlBinlogReplication</replaceable></td>
<td>(StrOpt) Default strategy for replication.</td>
</tr>
<tr>
<td>restore_namespace = trove.guestagent.strategies.restore.mysql_impl</td>
<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>root_on_create = False</td>
<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>tcp_ports = 3306</td>
<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>udp_ports = </td>
<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>usage_timeout = 400</td>
<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>volume_support = True</td>
<td><option>volume_support</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Whether to provision a Cinder volume for datadir.</td>
</tr>
</tbody>

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

@ -18,63 +18,63 @@
<th colspan="2">[percona]</th>
</tr>
<tr>
<td>backup_incremental_strategy = {'InnoBackupEx': 'InnoBackupExIncremental'}</td>
<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>backup_namespace = trove.guestagent.strategies.backup.mysql_impl</td>
<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>backup_strategy = InnoBackupEx</td>
<td><option>backup_strategy</option> = <replaceable>InnoBackupEx</replaceable></td>
<td>(StrOpt) Default strategy to perform backups.</td>
</tr>
<tr>
<td>device_path = /dev/vdb</td>
<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>mount_point = /var/lib/mysql</td>
<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>replication_namespace = trove.guestagent.strategies.replication.mysql_binlog</td>
<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>replication_password = NETOU7897NNLOU</td>
<td><option>replication_password</option> = <replaceable>NETOU7897NNLOU</replaceable></td>
<td>(StrOpt) Password for replication slave user.</td>
</tr>
<tr>
<td>replication_strategy = MysqlBinlogReplication</td>
<td><option>replication_strategy</option> = <replaceable>MysqlBinlogReplication</replaceable></td>
<td>(StrOpt) Default strategy for replication.</td>
</tr>
<tr>
<td>replication_user = slave_user</td>
<td><option>replication_user</option> = <replaceable>slave_user</replaceable></td>
<td>(StrOpt) Userid for replication slave.</td>
</tr>
<tr>
<td>restore_namespace = trove.guestagent.strategies.restore.mysql_impl</td>
<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>root_on_create = False</td>
<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>tcp_ports = 3306</td>
<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>udp_ports = </td>
<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>usage_timeout = 450</td>
<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>volume_support = True</td>
<td><option>volume_support</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Whether to provision a Cinder volume for datadir.</td>
</tr>
</tbody>

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

@ -18,51 +18,51 @@
<th colspan="2">[postgresql]</th>
</tr>
<tr>
<td>backup_incremental_strategy = {}</td>
<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>backup_namespace = trove.guestagent.strategies.backup.postgresql_impl</td>
<td><option>backup_namespace</option> = <replaceable>trove.guestagent.strategies.backup.postgresql_impl</replaceable></td>
<td>(StrOpt) Namespace to load backup strategies from.</td>
</tr>
<tr>
<td>backup_strategy = PgDump</td>
<td><option>backup_strategy</option> = <replaceable>PgDump</replaceable></td>
<td>(StrOpt) Default strategy to perform backups.</td>
</tr>
<tr>
<td>device_path = /dev/vdb</td>
<td><option>device_path</option> = <replaceable>/dev/vdb</replaceable></td>
<td>(StrOpt) No help text available for this option.</td>
</tr>
<tr>
<td>ignore_dbs = postgres</td>
<td><option>ignore_dbs</option> = <replaceable>postgres</replaceable></td>
<td>(ListOpt) No help text available for this option.</td>
</tr>
<tr>
<td>ignore_users = os_admin, postgres, root</td>
<td><option>ignore_users</option> = <replaceable>os_admin, postgres, root</replaceable></td>
<td>(ListOpt) No help text available for this option.</td>
</tr>
<tr>
<td>mount_point = /var/lib/postgresql</td>
<td><option>mount_point</option> = <replaceable>/var/lib/postgresql</replaceable></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><option>restore_namespace</option> = <replaceable>trove.guestagent.strategies.restore.postgresql_impl</replaceable></td>
<td>(StrOpt) Namespace to load restore strategies from.</td>
</tr>
<tr>
<td>root_on_create = False</td>
<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>tcp_ports = 5432</td>
<td><option>tcp_ports</option> = <replaceable>5432</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>udp_ports = </td>
<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>
</tr>
<tr>
<td>volume_support = True</td>
<td><option>volume_support</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Whether to provision a Cinder volume for datadir.</td>
</tr>
</tbody>

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

@ -18,43 +18,43 @@
<th colspan="2">[redis]</th>
</tr>
<tr>
<td>backup_incremental_strategy = {}</td>
<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>backup_namespace = None</td>
<td><option>backup_namespace</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Namespace to load backup strategies from.</td>
</tr>
<tr>
<td>backup_strategy = None</td>
<td><option>backup_strategy</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Default strategy to perform backups.</td>
</tr>
<tr>
<td>device_path = None</td>
<td><option>device_path</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Device path for volume if volume support is enabled.</td>
</tr>
<tr>
<td>mount_point = /var/lib/redis</td>
<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>replication_strategy = None</td>
<td><option>replication_strategy</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Default strategy for replication.</td>
</tr>
<tr>
<td>restore_namespace = None</td>
<td><option>restore_namespace</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Namespace to load restore strategies from.</td>
</tr>
<tr>
<td>tcp_ports = 6379</td>
<td><option>tcp_ports</option> = <replaceable>6379</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>udp_ports = </td>
<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>volume_support = False</td>
<td><option>volume_support</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Whether to provision a Cinder volume for datadir.</td>
</tr>
</tbody>

14
doc/common/tables/trove-debug.xml
View File

@ -18,27 +18,23 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>backdoor_port = None</td>
<td><option>backdoor_port</option> = <replaceable>None</replaceable></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><option>backlog</option> = <replaceable>4096</replaceable></td>
<td>(IntOpt) Number of backlog requests to configure the socket with</td>
</tr>
<tr>
<td>disable_process_locking = False</td>
<td>(BoolOpt) Whether to disable inter-process locks</td>
</tr>
<tr>
<td>pydev_debug = disabled</td>
<td><option>pydev_debug</option> = <replaceable>disabled</replaceable></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><option>pydev_debug_host</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Pydev debug server host (localhost by default).</td>
</tr>
<tr>
<td>pydev_debug_port = None</td>
<td><option>pydev_debug_port</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) Pydev debug server port (5678 by default).</td>
</tr>
</tbody>

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

@ -18,67 +18,67 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>dns_account_id = </td>
<td><option>dns_account_id</option> = <replaceable></replaceable></td>
<td>(StrOpt) Tenant ID for DNSaaS.</td>
</tr>
<tr>
<td>dns_auth_url = </td>
<td><option>dns_auth_url</option> = <replaceable></replaceable></td>
<td>(StrOpt) Authentication URL for DNSaaS.</td>
</tr>
<tr>
<td>dns_domain_id = </td>
<td><option>dns_domain_id</option> = <replaceable></replaceable></td>
<td>(StrOpt) Domain ID used for adding DNS entries.</td>
</tr>
<tr>
<td>dns_domain_name = </td>
<td><option>dns_domain_name</option> = <replaceable></replaceable></td>
<td>(StrOpt) Domain name used for adding DNS entries.</td>
</tr>
<tr>
<td>dns_driver = trove.dns.driver.DnsDriver</td>
<td><option>dns_driver</option> = <replaceable>trove.dns.driver.DnsDriver</replaceable></td>
<td>(StrOpt) Driver for DNSaaS.</td>
</tr>
<tr>
<td>dns_endpoint_url = 0.0.0.0</td>
<td><option>dns_endpoint_url</option> = <replaceable>0.0.0.0</replaceable></td>
<td>(StrOpt) Endpoint URL for DNSaaS.</td>
</tr>
<tr>
<td>dns_hostname = </td>
<td><option>dns_hostname</option> = <replaceable></replaceable></td>
<td>(StrOpt) Hostname used for adding DNS entries.</td>
</tr>
<tr>
<td>dns_instance_entry_factory = trove.dns.driver.DnsInstanceEntryFactory</td>
<td><option>dns_instance_entry_factory</option> = <replaceable>trove.dns.driver.DnsInstanceEntryFactory</replaceable></td>
<td>(StrOpt) Factory for adding DNS entries.</td>
</tr>
<tr>
<td>dns_management_base_url = </td>
<td><option>dns_management_base_url</option> = <replaceable></replaceable></td>
<td>(StrOpt) Management URL for DNSaaS.</td>
</tr>
<tr>
<td>dns_passkey = </td>
<td><option>dns_passkey</option> = <replaceable></replaceable></td>
<td>(StrOpt) Passkey for DNSaaS.</td>
</tr>
<tr>
<td>dns_region = </td>
<td><option>dns_region</option> = <replaceable></replaceable></td>
<td>(StrOpt) Region name for DNSaaS.</td>
</tr>
<tr>
<td>dns_service_type = </td>
<td><option>dns_service_type</option> = <replaceable></replaceable></td>
<td>(StrOpt) Service Type for DNSaaS.</td>
</tr>
<tr>
<td>dns_time_out = 120</td>
<td><option>dns_time_out</option> = <replaceable>120</replaceable></td>
<td>(IntOpt) Maximum time (in seconds) to wait for a DNS entry add.</td>
</tr>
<tr>
<td>dns_ttl = 300</td>
<td><option>dns_ttl</option> = <replaceable>300</replaceable></td>
<td>(IntOpt) Time (in seconds) before a refresh of DNS information occurs.</td>
</tr>
<tr>
<td>dns_username = </td>
<td><option>dns_username</option> = <replaceable></replaceable></td>
<td>(StrOpt) Username for DNSaaS.</td>
</tr>
<tr>
<td>trove_dns_support = False</td>
<td><option>trove_dns_support</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Whether Trove should add DNS entries on create (using Designate DNSaaS).</td>
</tr>
</tbody>

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

@ -18,51 +18,51 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>agent_call_high_timeout = 60</td>
<td><option>agent_call_high_timeout</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Maximum time (in seconds) to wait for Guest Agent 'slow' requests (such as restarting the database).</td>
</tr>
<tr>
<td>agent_call_low_timeout = 5</td>
<td><option>agent_call_low_timeout</option> = <replaceable>5</replaceable></td>
<td>(IntOpt) Maximum time (in seconds) to wait for Guest Agent 'quick'requests (such as retrieving a list of users or databases).</td>
</tr>
<tr>
<td>agent_heartbeat_time = 10</td>
<td><option>agent_heartbeat_time</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Maximum time (in seconds) for the Guest Agent to reply to a heartbeat request.</td>
</tr>
<tr>
<td>agent_replication_snapshot_timeout = 36000</td>
<td><option>agent_replication_snapshot_timeout</option> = <replaceable>36000</replaceable></td>
<td>(IntOpt) Maximum time (in seconds) to wait for taking a Guest Agent replication snapshot.</td>
</tr>
<tr>
<td>guest_config = $pybasedir/etc/trove/trove-guestagent.conf.sample</td>
<td><option>guest_config</option> = <replaceable>$pybasedir/etc/trove/trove-guestagent.conf.sample</replaceable></td>
<td>(StrOpt) Path to the Guest Agent config file.</td>
</tr>
<tr>
<td>guest_id = None</td>
<td><option>guest_id</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) ID of the Guest Instance.</td>
</tr>
<tr>
<td>ignore_dbs = lost+found, mysql, information_schema</td>
<td><option>ignore_dbs</option> = <replaceable>lost+found, mysql, information_schema</replaceable></td>
<td>(ListOpt) Databases to exclude when listing databases.</td>
</tr>
<tr>
<td>ignore_users = os_admin, root</td>
<td><option>ignore_users</option> = <replaceable>os_admin, root</replaceable></td>
<td>(ListOpt) Users to exclude when listing users.</td>
</tr>
<tr>
<td>mount_options = defaults,noatime</td>
<td><option>mount_options</option> = <replaceable>defaults,noatime</replaceable></td>
<td>(StrOpt) Options to use when mounting a volume.</td>
</tr>
<tr>
<td>storage_namespace = trove.guestagent.strategies.storage.swift</td>
<td><option>storage_namespace</option> = <replaceable>trove.guestagent.strategies.storage.swift</replaceable></td>
<td>(StrOpt) Namespace to load the default storage strategy from.</td>
</tr>
<tr>
<td>storage_strategy = SwiftStorage</td>
<td><option>storage_strategy</option> = <replaceable>SwiftStorage</replaceable></td>
<td>(StrOpt) Default strategy to store backups.</td>
</tr>
<tr>
<td>usage_sleep_time = 5</td>
<td><option>usage_sleep_time</option> = <replaceable>5</replaceable></td>
<td>(IntOpt) Time to sleep during the check for an active Guest.</td>
</tr>
</tbody>

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

@ -18,15 +18,19 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>heat_service_type = orchestration</td>
<td><option>heat_endpoint_type</option> = <replaceable>publicURL</replaceable></td>
<td>(StrOpt) Service endpoint type to use when searching catalog.</td>
</tr>
<tr>
<td><option>heat_service_type</option> = <replaceable>orchestration</replaceable></td>
<td>(StrOpt) Service type to use when searching catalog.</td>
</tr>
<tr>
<td>heat_time_out = 60</td>
<td><option>heat_time_out</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Maximum time (in seconds) to wait for a Heat request to complete.</td>
</tr>
<tr>
<td>heat_url = None</td>
<td><option>heat_url</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) URL without the tenant segment.</td>
</tr>
</tbody>

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

@ -18,91 +18,91 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>debug = False</td>
<td><option>debug</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).</td>
</tr>
<tr>
<td>default_log_levels = 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</td>
<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</replaceable></td>
<td>(ListOpt) List of logger=LEVEL pairs.</td>
</tr>
<tr>
<td>fatal_deprecations = False</td>
<td><option>fatal_deprecations</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enables or disables fatal status of deprecations.</td>
</tr>
<tr>
<td>format_options = -m 5</td>
<td><option>format_options</option> = <replaceable>-m 5</replaceable></td>
<td>(StrOpt) Options to use when formatting a volume.</td>
</tr>
<tr>
<td>instance_format = "[instance: %(uuid)s] "</td>
<td><option>instance_format</option> = <replaceable>"[instance: %(uuid)s] "</replaceable></td>
<td>(StrOpt) The format for an instance that is passed with the log message.</td>
</tr>
<tr>
<td>instance_uuid_format = "[instance: %(uuid)s] "</td>
<td><option>instance_uuid_format</option> = <replaceable>"[instance: %(uuid)s] "</replaceable></td>
<td>(StrOpt) The format for an instance UUID that is passed with the log message.</td>
</tr>
<tr>
<td>log_config_append = None</td>
<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>
</tr>
<tr>
<td>log_date_format = %Y-%m-%d %H:%M:%S</td>
<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>
</tr>
<tr>
<td>log_dir = None</td>
<td><option>log_dir</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) (Optional) The base directory used for relative --log-file paths.</td>
</tr>
<tr>
<td>log_file = None</td>
<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>
</tr>
<tr>
<td>log_format = None</td>
<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>
</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><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>
<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><option>logging_debug_format_suffix</option> = <replaceable>%(funcName)s %(pathname)s:%(lineno)d</replaceable></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><option>logging_default_format_string</option> = <replaceable>%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s</replaceable></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><option>logging_exception_prefix</option> = <replaceable>%(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s</replaceable></td>
<td>(StrOpt) Prefix each line of exception output with this format.</td>
</tr>
<tr>
<td>network_label_regex = ^private$</td>
<td><option>network_label_regex</option> = <replaceable>^private$</replaceable></td>
<td>(StrOpt) Regular expression to match Trove network labels.</td>
</tr>
<tr>
<td>publish_errors = False</td>
<td><option>publish_errors</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enables or disables publication of error events.</td>
</tr>
<tr>
<td>syslog_log_facility = LOG_USER</td>
<td><option>syslog_log_facility</option> = <replaceable>LOG_USER</replaceable></td>
<td>(StrOpt) Syslog facility to receive log lines.</td>
</tr>
<tr>
<td>use_stderr = True</td>
<td><option>use_stderr</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Log output to standard error.</td>
</tr>
<tr>
<td>use_syslog = False</td>
<td><option>use_syslog</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424.</td>
</tr>
<tr>
<td>use_syslog_rfc_format = False</td>
<td><option>use_syslog_rfc_format</option> = <replaceable>False</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 I, and will be removed in J.</td>
</tr>
<tr>
<td>verbose = False</td>
<td><option>verbose</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).</td>
</tr>
</tbody>

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

@ -18,15 +18,19 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>network_driver = trove.network.nova.NovaNetwork</td>
<td><option>network_driver</option> = <replaceable>trove.network.nova.NovaNetwork</replaceable></td>
<td>(StrOpt) Describes the actual network manager used for the management of network attributes (security groups, floating IPs, etc.).</td>
</tr>
<tr>
<td>neutron_service_type = network</td>
<td><option>neutron_endpoint_type</option> = <replaceable>publicURL</replaceable></td>
<td>(StrOpt) Service endpoint type to use when searching catalog.</td>
</tr>
<tr>
<td><option>neutron_service_type</option> = <replaceable>network</replaceable></td>
<td>(StrOpt) Service type to use when searching catalog.</td>
</tr>
<tr>
<td>neutron_url = None</td>
<td><option>neutron_url</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) URL without the tenant segment.</td>
</tr>
</tbody>

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

@ -18,15 +18,15 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>nova_proxy_admin_pass = </td>
<td><option>nova_proxy_admin_pass</option> = <replaceable></replaceable></td>
<td>(StrOpt) Admin password used to connect to Nova.</td>
</tr>
<tr>
<td>nova_proxy_admin_tenant_name = </td>
<td><option>nova_proxy_admin_tenant_name</option> = <replaceable></replaceable></td>
<td>(StrOpt) Admin tenant used to connect to Nova.</td>
</tr>
<tr>
<td>nova_proxy_admin_user = </td>
<td><option>nova_proxy_admin_user</option> = <replaceable></replaceable></td>
<td>(StrOpt) Admin username used to connect to Nova.</td>
</tr>
</tbody>

44
doc/common/tables/trove-qpid.xml
View File

@ -18,40 +18,48 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>qpid_heartbeat = 60</td>
<td>(IntOpt) Seconds between connection keepalive heartbeats</td>
<td><option>qpid_heartbeat</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Seconds between connection keepalive heartbeats.</td>
</tr>
<tr>
<td>qpid_hostname = localhost</td>
<td>(StrOpt) Qpid broker hostname</td>
<td><option>qpid_hostname</option> = <replaceable>localhost</replaceable></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>
<td><option>qpid_hosts</option> = <replaceable>$qpid_hostname:$qpid_port</replaceable></td>
<td>(ListOpt) Qpid HA cluster host:port pairs.</td>
</tr>
<tr>
<td>qpid_password = </td>
<td>(StrOpt) Password for qpid connection</td>
<td><option>qpid_password</option> = <replaceable></replaceable></td>
<td>(StrOpt) Password for Qpid connection.</td>
</tr>
<tr>
<td>qpid_port = 5672</td>
<td>(IntOpt) Qpid broker port</td>
<td><option>qpid_port</option> = <replaceable>5672</replaceable></td>
<td>(IntOpt) Qpid broker port.</td>
</tr>
<tr>
<td>qpid_protocol = tcp</td>
<td>(StrOpt) Transport to use, either 'tcp' or 'ssl'</td>
<td><option>qpid_protocol</option> = <replaceable>tcp</replaceable></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>
<td><option>qpid_receiver_capacity</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) The number of prefetched messages held by receiver.</td>
</tr>
<tr>
<td>qpid_tcp_nodelay = True</td>
<td>(BoolOpt) Disable Nagle algorithm</td>
<td><option>qpid_sasl_mechanisms</option> = <replaceable></replaceable></td>
<td>(StrOpt) Space separated list of SASL mechanisms to use for auth.</td>
</tr>
<tr>
<td>qpid_username = </td>
<td>(StrOpt) Username for qpid connection</td>
<td><option>qpid_tcp_nodelay</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Whether to disable the Nagle algorithm.</td>
</tr>
<tr>
<td><option>qpid_topology_version</option> = <replaceable>1</replaceable></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>
<tr>
<td><option>qpid_username</option> = <replaceable></replaceable></td>
<td>(StrOpt) Username for Qpid connection.</td>
</tr>
</tbody>
</table>

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

@ -18,23 +18,23 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>max_accepted_volume_size = 5</td>
<td><option>max_accepted_volume_size</option> = <replaceable>5</replaceable></td>
<td>(IntOpt) Default maximum volume size (in GB) for an instance.</td>
</tr>
<tr>
<td>max_backups_per_user = 50</td>
<td><option>max_backups_per_user</option> = <replaceable>50</replaceable></td>
<td>(IntOpt) Default maximum number of backups created by a tenant.</td>
</tr>
<tr>
<td>max_instances_per_user = 5</td>
<td><option>max_instances_per_user</option> = <replaceable>5</replaceable></td>
<td>(IntOpt) Default maximum number of instances per tenant.</td>
</tr>
<tr>
<td>max_volumes_per_user = 20</td>
<td><option>max_volumes_per_user</option> = <replaceable>20</replaceable></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><option>quota_driver</option> = <replaceable>trove.quota.quota.DbQuotaDriver</replaceable></td>
<td>(StrOpt) Default driver to use for quota checks.</td>
</tr>
</tbody>

68
doc/common/tables/trove-rabbitmq.xml
View File

@ -18,64 +18,72 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>kombu_ssl_ca_certs = </td>
<td>(StrOpt) SSL certification authority file (valid only if SSL enabled)</td>
<td><option>kombu_reconnect_delay</option> = <replaceable>1.0</replaceable></td>
<td>(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.</td>
</tr>
<tr>
<td>kombu_ssl_certfile = </td>
<td>(StrOpt) SSL cert file (valid only if SSL enabled)</td>
<td><option>kombu_ssl_ca_certs</option> = <replaceable></replaceable></td>
<td>(StrOpt) SSL certification authority 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>
<td><option>kombu_ssl_certfile</option> = <replaceable></replaceable></td>
<td>(StrOpt) SSL cert 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>
<td><option>kombu_ssl_keyfile</option> = <replaceable></replaceable></td>
<td>(StrOpt) SSL key file (valid only if SSL enabled).</td>
</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>
<td><option>kombu_ssl_version</option> = <replaceable></replaceable></td>
<td>(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1 and SSLv23. SSLv2 and SSLv3 may be available on some distributions.</td>
</tr>
<tr>
<td>rabbit_host = localhost</td>
<td>(StrOpt) The RabbitMQ broker address where a single node is used</td>
<td><option>rabbit_ha_queues</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database.</td>
</tr>
<tr>
<td>rabbit_hosts = $rabbit_host:$rabbit_port</td>
<td>(ListOpt) RabbitMQ HA cluster host:port pairs</td>
<td><option>rabbit_host</option> = <replaceable>localhost</replaceable></td>
<td>(StrOpt) The RabbitMQ broker address where a single node is used.</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>
<td><option>rabbit_hosts</option> = <replaceable>$rabbit_host:$rabbit_port</replaceable></td>
<td>(ListOpt) RabbitMQ HA cluster host:port pairs.</td>
</tr>
<tr>
<td>rabbit_password = guest</td>
<td>(StrOpt) the RabbitMQ password</td>
<td><option>rabbit_login_method</option> = <replaceable>AMQPLAIN</replaceable></td>
<td>(StrOpt) The RabbitMQ login method.</td>
</tr>
<tr>
<td>rabbit_port = 5672</td>
<td>(IntOpt) The RabbitMQ broker port where a single node is used</td>
<td><option>rabbit_max_retries</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).</td>
</tr>
<tr>
<td>rabbit_retry_backoff = 2</td>
<td>(IntOpt) how long to backoff for between retries when connecting to RabbitMQ</td>
<td><option>rabbit_password</option> = <replaceable>guest</replaceable></td>
<td>(StrOpt) The RabbitMQ password.</td>
</tr>
<tr>
<td>rabbit_retry_interval = 1</td>
<td>(IntOpt) how frequently to retry connecting with RabbitMQ</td>
<td><option>rabbit_port</option> = <replaceable>5672</replaceable></td>
<td>(IntOpt) The RabbitMQ broker port where a single node is used.</td>
</tr>
<tr>
<td>rabbit_use_ssl = False</td>
<td>(BoolOpt) connect over SSL for RabbitMQ</td>
<td><option>rabbit_retry_backoff</option> = <replaceable>2</replaceable></td>
<td>(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.</td>
</tr>
<tr>
<td>rabbit_userid = guest</td>
<td>(StrOpt) the RabbitMQ userid</td>
<td><option>rabbit_retry_interval</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) How frequently to retry connecting with RabbitMQ.</td>
</tr>
<tr>
<td>rabbit_virtual_host = /</td>
<td>(StrOpt) the RabbitMQ virtual host</td>
<td><option>rabbit_use_ssl</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Connect over SSL for RabbitMQ.</td>
</tr>
<tr>
<td><option>rabbit_userid</option> = <replaceable>guest</replaceable></td>
<td>(StrOpt) The RabbitMQ userid.</td>
</tr>
<tr>
<td><option>rabbit_virtual_host</option> = <replaceable>/</replaceable></td>
<td>(StrOpt) The RabbitMQ virtual host.</td>
</tr>
</tbody>
</table>

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

@ -18,23 +18,23 @@
<th colspan="2">[matchmaker_redis]</th>
</tr>
<tr>
<td>host = 127.0.0.1</td>
<td>(StrOpt) Host to locate redis</td>
<td><option>host</option> = <replaceable>127.0.0.1</replaceable></td>
<td>(StrOpt) Host to locate redis.</td>
</tr>
<tr>
<td>password = None</td>
<td>(StrOpt) Password for Redis server. (optional)</td>
<td><option>password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Password for Redis server (optional).</td>
</tr>
<tr>
<td>port = 6379</td>
<td><option>port</option> = <replaceable>6379</replaceable></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>
<td><option>ringfile</option> = <replaceable>/etc/oslo/matchmaker_ring.json</replaceable></td>
<td>(StrOpt) Matchmaker ring file (JSON).</td>
</tr>
</tbody>
</table>

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

@ -18,78 +18,87 @@
<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>
<td><option>matchmaker_heartbeat_freq</option> = <replaceable>300</replaceable></td>
<td>(IntOpt) Heartbeat frequency.</td>
</tr>
<tr>
<td>matchmaker_heartbeat_freq = 300</td>
<td>(IntOpt) Heartbeat frequency</td>
</tr>
<tr>
<td>matchmaker_heartbeat_ttl = 600</td>
<td><option>matchmaker_heartbeat_ttl</option> = <replaceable>600</replaceable></td>
<td>(IntOpt) Heartbeat time-to-live.</td>
</tr>
<tr>
<td>num_tries = 3</td>
<td><option>num_tries</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) Number of times to check if a volume exists.</td>
</tr>
<tr>
<td>report_interval = 10</td>
<td><option>report_interval</option> = <replaceable>10</replaceable></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>
<td><option>rpc_backend</option> = <replaceable>rabbit</replaceable></td>
<td>(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq.</td>
</tr>
<tr>
<td>rpc_cast_timeout = 30</td>
<td><option>rpc_cast_timeout</option> = <replaceable>30</replaceable></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>
<td><option>rpc_conn_pool_size</option> = <replaceable>30</replaceable></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>
<td><option>rpc_response_timeout</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Seconds to wait for a response from a call.</td>
</tr>
<tr>
<td>rpc_thread_pool_size = 64</td>
<td>(IntOpt) Size of RPC thread pool</td>
<td><option>rpc_thread_pool_size</option> = <replaceable>64</replaceable></td>
<td>(IntOpt) Size of RPC greenthread pool.</td>
</tr>
<tr>
<th colspan="2">[rpc_notifier2]</th>
<th colspan="2">[oslo_messaging_amqp]</th>
</tr>
<tr>
<td>topics = notifications</td>
<td>(ListOpt) AMQP topic(s) used for openstack notifications</td>
<td><option>allow_insecure_clients</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Accept clients using either SSL or plain TCP</td>
</tr>
<tr>
<th colspan="2">[secure_messages]</th>
<td><option>broadcast_prefix</option> = <replaceable>broadcast</replaceable></td>
<td>(StrOpt) address prefix used when broadcasting to all servers</td>
</tr>
<tr>
<td>enabled = True</td>
<td>(BoolOpt) Whether Secure Messaging (Signing) is enabled, defaults to enabled</td>
<td><option>container_name</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Name for the AMQP container</td>
</tr>
<tr>
<td>encrypt = False</td>
<td>(BoolOpt) Whether Secure Messaging (Encryption) is enabled, defaults to not enabled</td>
<td><option>group_request_prefix</option> = <replaceable>unicast</replaceable></td>
<td>(StrOpt) address prefix when sending to any server in group</td>
</tr>
<tr>
<td>enforced = False</td>
<td>(BoolOpt) Whether Secure Messaging (Signing) is enforced, defaults to not enforced</td>
<td><option>idle_timeout</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) Timeout for inactive connections (in seconds)</td>
</tr>
<tr>
<td>kds_endpoint = None</td>
<td>(StrOpt) KDS endpoint (ex: http://kds.example.com:35357/v3)</td>
<td><option>server_request_prefix</option> = <replaceable>exclusive</replaceable></td>
<td>(StrOpt) address prefix used when sending to a specific server</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>
<td><option>ssl_ca_file</option> = <replaceable></replaceable></td>
<td>(StrOpt) CA certificate PEM file for verifing server certificate</td>
</tr>
<tr>
<td>secret_keys_file = None</td>
<td>(StrOpt) Path to the file containing the keys, takes precedence over secret_key</td>
<td><option>ssl_cert_file</option> = <replaceable></replaceable></td>
<td>(StrOpt) Identifying certificate PEM file to present to clients</td>
</tr>
<tr>
<td><option>ssl_key_file</option> = <replaceable></replaceable></td>
<td>(StrOpt) Private key PEM file used to sign cert_file certificate</td>
</tr>
<tr>
<td><option>ssl_key_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Password for decrypting ssl_key_file (if encrypted)</td>
</tr>
<tr>
<td><option>trace</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Debug: dump AMQP frames to stdout</td>
</tr>
</tbody>
</table>

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

@ -18,11 +18,15 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>swift_service_type = object-store</td>
<td><option>swift_endpoint_type</option> = <replaceable>publicURL</replaceable></td>
<td>(StrOpt) Service endpoint type to use when searching catalog.</td>
</tr>
<tr>
<td><option>swift_service_type</option> = <replaceable>object-store</replaceable></td>
<td>(StrOpt) Service type to use when searching catalog.</td>
</tr>
<tr>
<td>swift_url = None</td>
<td><option>swift_url</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) URL ending in AUTH_.</td>
</tr>
</tbody>

34
doc/common/tables/trove-taskmanager.xml
View File

@ -18,71 +18,71 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>cloudinit_location = /etc/trove/cloudinit</td>
<td><option>cloudinit_location</option> = <replaceable>/etc/trove/cloudinit</replaceable></td>
<td>(StrOpt) Path to folder with cloudinit scripts.</td>
</tr>
<tr>
<td>datastore_manager = None</td>
<td><option>datastore_manager</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Manager class in the Guest Agent, set up by the Taskmanager on instance provision.</td>
</tr>
<tr>
<td>datastore_registry_ext = {}</td>
<td><option>datastore_registry_ext</option> = <replaceable>{}</replaceable></td>
<td>(DictOpt) Extension for default datastore managers. Allows the use of custom managers for each of the datastores supported by Trove.</td>
</tr>
<tr>
<td>exists_notification_ticks = 360</td>
<td><option>exists_notification_ticks</option> = <replaceable>360</replaceable></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><option>exists_notification_transformer</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Transformer for exists notifications.</td>
</tr>
<tr>
<td>reboot_time_out = 120</td>
<td><option>reboot_time_out</option> = <replaceable>120</replaceable></td>
<td>(IntOpt) Maximum time (in seconds) to wait for a server reboot.</td>
</tr>
<tr>
<td>resize_time_out = 600</td>
<td><option>resize_time_out</option> = <replaceable>600</replaceable></td>
<td>(IntOpt) Maximum time (in seconds) to wait for a server resize.</td>
</tr>
<tr>
<td>restore_usage_timeout = 36000</td>
<td><option>restore_usage_timeout</option> = <replaceable>36000</replaceable></td>
<td>(IntOpt) Maximum time (in seconds) to wait for a Guest instance restored from a backup to become active.</td>
</tr>
<tr>
<td>revert_time_out = 600</td>
<td><option>revert_time_out</option> = <replaceable>600</replaceable></td>
<td>(IntOpt) Maximum time (in seconds) to wait for a server resize revert.</td>
</tr>
<tr>
<td>server_delete_time_out = 60</td>
<td><option>server_delete_time_out</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Maximum time (in seconds) to wait for a server delete.</td>
</tr>
<tr>
<td>state_change_wait_time = 180</td>
<td><option>state_change_wait_time</option> = <replaceable>180</replaceable></td>
<td>(IntOpt) Maximum time (in seconds) to wait for a state change.</td>
</tr>
<tr>
<td>update_status_on_fail = True</td>
<td><option>update_status_on_fail</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Set the service and instance task statuses to ERROR when an instance fails to become active within the configured usage_timeout.</td>
</tr>
<tr>
<td>usage_sleep_time = 5</td>
<td><option>usage_sleep_time</option> = <replaceable>5</replaceable></td>
<td>(IntOpt) Time to sleep during the check for an active Guest.</td>
</tr>
<tr>
<td>use_heat = False</td>
<td><option>use_heat</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Use Heat for provisioning.</td>
</tr>
<tr>
<td>use_nova_server_config_drive = False</td>
<td><option>use_nova_server_config_drive</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Use config drive for file injection when booting instance.</td>
</tr>
<tr>
<td>use_nova_server_volume = False</td>
<td><option>use_nova_server_volume</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Whether to provision a Cinder volume for the Nova instance.</td>
</tr>
<tr>
<td>verify_swift_checksum_on_restore = True</td>
<td><option>verify_swift_checksum_on_restore</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Enable verification of Swift checksum before starting restore. Makes sure the checksum of original backup matches the checksum of the Swift backup file.</td>
</tr>
</tbody>

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

@ -18,8 +18,8 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>fake_rabbit = False</td>
<td>(BoolOpt) If passed, use a fake RabbitMQ provider</td>
<td><option>fake_rabbit</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake</td>
</tr>
</tbody>
</table>

34
doc/common/tables/trove-upgrades.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_upgrades">
<caption>Description of upgrades 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">[upgrade_levels]</th>
</tr>
<tr>
<td><option>conductor</option> = <replaceable>icehouse</replaceable></td>
<td>(StrOpt) Set a version cap for messages sent to conductor services</td>
</tr>
<tr>
<td><option>guestagent</option> = <replaceable>icehouse</replaceable></td>
<td>(StrOpt) Set a version cap for messages sent to guestagent services</td>
</tr>
<tr>
<td><option>taskmanager</option> = <replaceable>icehouse</replaceable></td>
<td>(StrOpt) Set a version cap for messages sent to taskmanager services</td>
</tr>
</tbody>
</table>
</para>

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

@ -18,39 +18,43 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>block_device_mapping = vdb</td>
<td><option>block_device_mapping</option> = <replaceable>vdb</replaceable></td>
<td>(StrOpt) Block device to map onto the created instance.</td>
</tr>
<tr>
<td>cinder_service_type = volumev2</td>
<td><option>cinder_endpoint_type</option> = <replaceable>publicURL</replaceable></td>
<td>(StrOpt) Service endpoint type to use when searching catalog.</td>
</tr>
<tr>
<td><option>cinder_service_type</option> = <replaceable>volumev2</replaceable></td>
<td>(StrOpt) Service type to use when searching catalog.</td>
</tr>
<tr>
<td>cinder_url = None</td>
<td><option>cinder_url</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) URL without the tenant segment.</td>
</tr>
<tr>
<td>cinder_volume_type = None</td>
<td><option>cinder_volume_type</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Volume type to use when provisioning a Cinder volume.</td>
</tr>
<tr>
<td>device_path = /dev/vdb</td>
<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>trove_volume_support = True</td>
<td><option>trove_volume_support</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Whether to provision a Cinder volume for datadir.</td>
</tr>
<tr>
<td>volume_format_timeout = 120</td>
<td><option>volume_format_timeout</option> = <replaceable>120</replaceable></td>
<td>(IntOpt) Maximum time (in seconds) to wait for a volume format.</td>
</tr>
<tr>
<td>volume_fstype = ext3</td>
<td><option>volume_fstype</option> = <replaceable>ext3</replaceable></td>
<td>(StrOpt) File system type used to format a volume.</td>
</tr>
<tr>
<td>volume_time_out = 60</td>
<td><option>volume_time_out</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Maximum time (in seconds) to wait for a volume attach.</td>
</tr>
</tbody>

Some files were not shown because too many files have changed in this diff Show More