openstack
/
openstack-manuals
Code Issues Proposed changes

[config-ref] Publish the RST version 

Change-Id: Ia9dc15869ab201a787eecd479252282f0ae9113b
Implements: blueprint config-ref-rst
This commit is contained in:
Gauvain Pocentek 2015-12-21 09:27:36 +01:00
parent ceca643178
commit 26510e84dd
1539 changed files with 9 additions and 96796 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
RELEASENOTES.rst
View File

@ -20,6 +20,11 @@ Next release: Mitaka
* Tracking of release notes in RELEASENOTES.rst file.
Configuration Reference
-----------------------
* RST conversion completed
HA Guide
--------

2
doc-tools-check-languages.conf
View File

@ -28,6 +28,7 @@ DOC_DIR="doc/"
declare -A SPECIAL_BOOKS=(
["admin-guide-cloud"]="RST"
["arch-design"]="RST"
["config-reference"]="RST"
["image-guide"]="RST"
["install-guide"]="RST"
["networking-guide"]="RST"
@ -35,7 +36,6 @@ declare -A SPECIAL_BOOKS=(
["user-guide-admin"]="RST"
# Skip in-progress guides
["contributor-guide"]="skip"
["config-ref-rst"]="skip"
# Do not translate
["cli-reference"]="skip"
# Skip arch design while its being revised

38
doc/common/tables/aodh-amqp.xml
View File

@ -1,38 +0,0 @@
<?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_aodh_amqp">
<caption>Description of AMQP 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>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><option>notification_driver</option> = <replaceable>[]</replaceable></td>
<td>(MultiStrOpt) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop</td>
</tr>
<tr>
<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>
</para>

53
doc/common/tables/aodh-api.xml
View File

@ -1,53 +0,0 @@
<?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_aodh_api">
<caption>Description of API 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">[api]</th>
</tr>
<tr>
<td><option>host</option> = <replaceable>0.0.0.0</replaceable></td>
<td>(StrOpt) The listen IP for the aodh API server.</td>
</tr>
<tr>
<td><option>paste_config</option> = <replaceable>api_paste.ini</replaceable></td>
<td>(StrOpt) Configuration file for WSGI definition of API.</td>
</tr>
<tr>
<td><option>pecan_debug</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Toggle Pecan Debug Middleware.</td>
</tr>
<tr>
<td><option>port</option> = <replaceable>8042</replaceable></td>
<td>(IntOpt) The port for the aodh API server.</td>
</tr>
<tr>
<td><option>workers</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Number of workers for aodh API server.</td>
</tr>
<tr>
<th colspan="2">[oslo_middleware]</th>
</tr>
<tr>
<td><option>max_request_body_size</option> = <replaceable>114688</replaceable></td>
<td>(IntOpt) The maximum body size for each request, in bytes.</td>
</tr>
<tr>
<td><option>secure_proxy_ssl_header</option> = <replaceable>X-Forwarded-Proto</replaceable></td>
<td>(StrOpt) The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by an SSL termination proxy.</td>
</tr>
</tbody>
</table>
</para>

70
doc/common/tables/aodh-auth.xml
View File

@ -1,70 +0,0 @@
<?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_aodh_auth">
<caption>Description of authorization 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">[service_credentials]</th>
</tr>
<tr>
<td><option>insecure</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Disables X.509 certificate validation when an SSL connection to Identity Service is established.</td>
</tr>
<tr>
<td><option>os_auth_url</option> = <replaceable>http://localhost:5000/v2.0</replaceable></td>
<td>(StrOpt) Auth URL to use for OpenStack service access.</td>
</tr>
<tr>
<td><option>os_cacert</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Certificate chain for SSL validation.</td>
</tr>
<tr>
<td><option>os_endpoint_type</option> = <replaceable>publicURL</replaceable></td>
<td>(StrOpt) Type of endpoint in Identity service catalog to use for communication with OpenStack services.</td>
</tr>
<tr>
<td><option>os_password</option> = <replaceable>admin</replaceable></td>
<td>(StrOpt) Password to use for OpenStack service access.</td>
</tr>
<tr>
<td><option>os_project_domain_id</option> = <replaceable>default</replaceable></td>
<td>(StrOpt) The domain id of the user project</td>
</tr>
<tr>
<td><option>os_project_name</option> = <replaceable>admin</replaceable></td>
<td>(StrOpt) The user project name</td>
</tr>
<tr>
<td><option>os_region_name</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Region name to use for OpenStack service endpoints.</td>
</tr>
<tr>
<td><option>os_tenant_id</option> = <replaceable></replaceable></td>
<td>(StrOpt) Tenant ID to use for OpenStack service access.</td>
</tr>
<tr>
<td><option>os_tenant_name</option> = <replaceable>admin</replaceable></td>
<td>(StrOpt) Tenant name to use for OpenStack service access.</td>
</tr>
<tr>
<td><option>os_user_domain_id</option> = <replaceable>default</replaceable></td>
<td>(StrOpt) The domain id of the user</td>
</tr>
<tr>
<td><option>os_username</option> = <replaceable>aodh</replaceable></td>
<td>(StrOpt) User name to use for OpenStack service access.</td>
</tr>
</tbody>
</table>
</para>

174
doc/common/tables/aodh-auth_token.xml
View File

@ -1,174 +0,0 @@
<?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_aodh_auth_token">
<caption>Description of authorization token 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">[keystone_authtoken]</th>
</tr>
<tr>
<td><option>admin_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Service user password.</td>
</tr>
<tr>
<td><option>admin_tenant_name</option> = <replaceable>admin</replaceable></td>
<td>(StrOpt) Service tenant name.</td>
</tr>
<tr>
<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><option>admin_user</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Service username.</td>
</tr>
<tr>
<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><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><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><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><option>auth_section</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Config Section from which to load plugin specific options</td>
</tr>
<tr>
<td><option>auth_uri</option> = <replaceable>None</replaceable></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>
</tr>
<tr>
<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><option>certfile</option> = <replaceable>None</replaceable></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 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>
</tr>
<tr>
<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><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><option>http_connect_timeout</option> = <replaceable>None</replaceable></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>
<td>(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server.</td>
</tr>
<tr>
<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><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><option>insecure</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Verify HTTPS connections.</td>
</tr>
<tr>
<td><option>keyfile</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Required if identity server requires client certificate</td>
</tr>
<tr>
<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 memcached client connection from the pool.</td>
</tr>
<tr>
<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><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 memcached 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) memcached client pool. The advanced pool will only work under python 2.x.</td>
</tr>
<tr>
<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><option>region_name</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The region in which the identity server can be found.</td>
</tr>
<tr>
<td><option>revocation_cache_time</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.</td>
</tr>
<tr>
<td><option>signing_dir</option> = <replaceable>None</replaceable></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>
<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>
</table>
</para>

94
doc/common/tables/aodh-common.xml
View File

@ -1,94 +0,0 @@
<?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_aodh_common">
<caption>Description of common 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>alarm_max_actions</option> = <replaceable>-1</replaceable></td>
<td>(IntOpt) Maximum count of actions for each state of an alarm, non-positive number means no limit.</td>
</tr>
<tr>
<td><option>evaluation_interval</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Period of evaluation cycle, should be &gt;= than configured pipeline interval for collection of underlying meters.</td>
</tr>
<tr>
<td><option>event_alarm_cache_ttl</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) TTL of event alarm caches, in seconds. Set to 0 to disable caching.</td>
</tr>
<tr>
<td><option>event_alarm_topic</option> = <replaceable>alarm.all</replaceable></td>
<td>(StrOpt) The topic that aodh uses for event alarm evaluation.</td>
</tr>
<tr>
<td><option>executor_thread_pool_size</option> = <replaceable>64</replaceable></td>
<td>(IntOpt) Size of executor thread pool.</td>
</tr>
<tr>
<td><option>gnocchi_url</option> = <replaceable>http://localhost:8041</replaceable></td>
<td>(StrOpt) URL to Gnocchi.</td>
</tr>
<tr>
<td><option>host</option> = <replaceable>localhost</replaceable></td>
<td>(StrOpt) Name of this node, which must be valid in an AMQP key. Can be an opaque identifier. For ZeroMQ only, must be a valid host name, FQDN, or IP address.</td>
</tr>
<tr>
<td><option>http_timeout</option> = <replaceable>600</replaceable></td>
<td>(IntOpt) Timeout seconds for HTTP requests. Set it to None to disable timeout.</td>
</tr>
<tr>
<td><option>memcached_servers</option> = <replaceable>None</replaceable></td>
<td>(ListOpt) Memcached servers or None for in process cache.</td>
</tr>
<tr>
<td><option>notification_workers</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Number of workers for notification service. A single notification agent is enabled by default.</td>
</tr>
<tr>
<td><option>notifier_rpc_topic</option> = <replaceable>alarm_notifier</replaceable></td>
<td>(StrOpt) The topic that aodh uses for alarm notifier messages.</td>
</tr>
<tr>
<td><option>project_alarm_quota</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) Maximum number of alarms defined for a project.</td>
</tr>
<tr>
<td><option>record_history</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Record alarm change events.</td>
</tr>
<tr>
<td><option>rest_notifier_certificate_file</option> = <replaceable></replaceable></td>
<td>(StrOpt) SSL Client certificate for REST notifier.</td>
</tr>
<tr>
<td><option>rest_notifier_certificate_key</option> = <replaceable></replaceable></td>
<td>(StrOpt) SSL Client private key for REST notifier.</td>
</tr>
<tr>
<td><option>rest_notifier_max_retries</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) Number of retries for REST notifier</td>
</tr>
<tr>
<td><option>rest_notifier_ssl_verify</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Whether to verify the SSL Server certificate when calling alarm action.</td>
</tr>
<tr>
<td><option>user_alarm_quota</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) Maximum number of alarms defined for a user.</td>
</tr>
</tbody>
</table>
</para>

34
doc/common/tables/aodh-coordination.xml
View File

@ -1,34 +0,0 @@
<?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_aodh_coordination">
<caption>Description of Coordination 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">[coordination]</th>
</tr>
<tr>
<td><option>backend_url</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The backend URL to use for distributed coordination. If left empty, per-deployment central agent and per-host compute agent won't do workload partitioning and will only function correctly if a single instance of that service is running.</td>
</tr>
<tr>
<td><option>check_watchers</option> = <replaceable>10.0</replaceable></td>
<td>(FloatOpt) Number of seconds between checks to see if group membership has changed</td>
</tr>
<tr>
<td><option>heartbeat</option> = <replaceable>1.0</replaceable></td>
<td>(FloatOpt) Number of seconds between heartbeats for distributed coordination.</td>
</tr>
</tbody>
</table>
</para>

73
doc/common/tables/aodh-cors.xml
View File

@ -1,73 +0,0 @@
<?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_aodh_cors">
<caption>Description of CORS 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">[cors]</th>
</tr>
<tr>
<td><option>allow_credentials</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Indicate that the actual request can include user credentials</td>
</tr>
<tr>
<td><option>allow_headers</option> = <replaceable>Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma</replaceable></td>
<td>(ListOpt) Indicate which header field names may be used during the actual request.</td>
</tr>
<tr>
<td><option>allow_methods</option> = <replaceable>GET, POST, PUT, DELETE, OPTIONS</replaceable></td>
<td>(ListOpt) Indicate which methods can be used during the actual request.</td>
</tr>
<tr>
<td><option>allowed_origin</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header.</td>
</tr>
<tr>
<td><option>expose_headers</option> = <replaceable>Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma</replaceable></td>
<td>(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.</td>
</tr>
<tr>
<td><option>max_age</option> = <replaceable>3600</replaceable></td>
<td>(IntOpt) Maximum cache age of CORS preflight requests.</td>
</tr>
<tr>
<th colspan="2">[cors.subdomain]</th>
</tr>
<tr>
<td><option>allow_credentials</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Indicate that the actual request can include user credentials</td>
</tr>
<tr>
<td><option>allow_headers</option> = <replaceable>Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma</replaceable></td>
<td>(ListOpt) Indicate which header field names may be used during the actual request.</td>
</tr>
<tr>
<td><option>allow_methods</option> = <replaceable>GET, POST, PUT, DELETE, OPTIONS</replaceable></td>
<td>(ListOpt) Indicate which methods can be used during the actual request.</td>
</tr>
<tr>
<td><option>allowed_origin</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header.</td>
</tr>
<tr>
<td><option>expose_headers</option> = <replaceable>Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma</replaceable></td>
<td>(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.</td>
</tr>
<tr>
<td><option>max_age</option> = <replaceable>3600</replaceable></td>
<td>(IntOpt) Maximum cache age of CORS preflight requests.</td>
</tr>
</tbody>
</table>
</para>

110
doc/common/tables/aodh-database.xml
View File

@ -1,110 +0,0 @@
<?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_aodh_database">
<caption>Description of database configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[database]</th>
</tr>
<tr>
<td><option>alarm_connection</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The connection string used to connect to the alarm database - rather use ${database.connection}</td>
</tr>
<tr>
<td><option>alarm_history_time_to_live</option> = <replaceable>-1</replaceable></td>
<td>(IntOpt) Number of seconds that alarm histories are kept in the database for (&lt;= 0 means forever).</td>
</tr>
<tr>
<td><option>backend</option> = <replaceable>sqlalchemy</replaceable></td>
<td>(StrOpt) The back end to use for the database.</td>
</tr>
<tr>
<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><option>connection_debug</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything.</td>
</tr>
<tr>
<td><option>connection_trace</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Add Python stack traces to SQL as comment strings.</td>
</tr>
<tr>
<td><option>db_inc_retry_interval</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) If True, increases the interval between retries of a database operation up to db_max_retry_interval.</td>
</tr>
<tr>
<td><option>db_max_retries</option> = <replaceable>20</replaceable></td>
<td>(IntOpt) Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count.</td>
</tr>
<tr>
<td><option>db_max_retry_interval</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation.</td>
</tr>
<tr>
<td><option>db_retry_interval</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Seconds between retries of a database transaction.</td>
</tr>
<tr>
<td><option>idle_timeout</option> = <replaceable>3600</replaceable></td>
<td>(IntOpt) Timeout before idle SQL connections are reaped.</td>
</tr>
<tr>
<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><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><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><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><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><option>pool_timeout</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) If set, use this value for pool_timeout with SQLAlchemy.</td>
</tr>
<tr>
<td><option>retry_interval</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Interval between retries of opening a SQL connection.</td>
</tr>
<tr>
<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><option>sqlite_db</option> = <replaceable>oslo.sqlite</replaceable></td>
<td>(StrOpt) The file name to use with SQLite.</td>
</tr>
<tr>
<td><option>sqlite_synchronous</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) If True, SQLite uses synchronous mode.</td>
</tr>
<tr>
<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>
</table>
</para>

102
doc/common/tables/aodh-logging.xml
View File

@ -1,102 +0,0 @@
<?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_aodh_logging">
<caption>Description of logging 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>debug</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default INFO level).</td>
</tr>
<tr>
<td><option>default_log_levels</option> = <replaceable>amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN, taskflow=WARN</replaceable></td>
<td>(ListOpt) List of logger=LEVEL pairs.</td>
</tr>
<tr>
<td><option>fatal_deprecations</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enables or disables fatal status of deprecations.</td>
</tr>
<tr>
<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><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><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><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><option>log_dir</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) (Optional) The base directory used for relative --log-file paths.</td>
</tr>
<tr>
<td><option>log_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.</td>
</tr>
<tr>
<td><option>log_format</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.</td>
</tr>
<tr>
<td><option>logging_context_format_string</option> = <replaceable>%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s</replaceable></td>
<td>(StrOpt) Format string to use for log messages with context.</td>
</tr>
<tr>
<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><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><option>logging_exception_prefix</option> = <replaceable>%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s</replaceable></td>
<td>(StrOpt) Prefix each line of exception output with this format.</td>
</tr>
<tr>
<td><option>publish_errors</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enables or disables publication of error events.</td>
</tr>
<tr>
<td><option>syslog_log_facility</option> = <replaceable>LOG_USER</replaceable></td>
<td>(StrOpt) Syslog facility to receive log lines.</td>
</tr>
<tr>
<td><option>use_stderr</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Log output to standard error.</td>
</tr>
<tr>
<td><option>use_syslog</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424.</td>
</tr>
<tr>
<td><option>use_syslog_rfc_format</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in Kilo, and will be removed in Mitaka, along with this option.</td>
</tr>
<tr>
<td><option>verbose</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) If set to false, will disable INFO logging level, making WARNING the default.</td>
</tr>
</tbody>
</table>
</para>

34
doc/common/tables/aodh-policy.xml
View File

@ -1,34 +0,0 @@
<?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_aodh_policy">
<caption>Description of policy 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">[oslo_policy]</th>
</tr>
<tr>
<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. Missing or empty directories are ignored.</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>
</para>

78
doc/common/tables/aodh-qpid.xml
View File

@ -1,78 +0,0 @@
<?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_aodh_qpid">
<caption>Description of Qpid 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">[oslo_messaging_qpid]</th>
</tr>
<tr>
<td><option>amqp_auto_delete</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Auto-delete queues in AMQP.</td>
</tr>
<tr>
<td><option>amqp_durable_queues</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Use durable queues in AMQP.</td>
</tr>
<tr>
<td><option>qpid_heartbeat</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Seconds between connection keepalive heartbeats.</td>
</tr>
<tr>
<td><option>qpid_hostname</option> = <replaceable>localhost</replaceable></td>
<td>(StrOpt) Qpid broker hostname.</td>
</tr>
<tr>
<td><option>qpid_hosts</option> = <replaceable>$qpid_hostname:$qpid_port</replaceable></td>
<td>(ListOpt) Qpid HA cluster host:port pairs.</td>
</tr>
<tr>
<td><option>qpid_password</option> = <replaceable></replaceable></td>
<td>(StrOpt) Password for Qpid connection.</td>
</tr>
<tr>
<td><option>qpid_port</option> = <replaceable>5672</replaceable></td>
<td>(IntOpt) Qpid broker port.</td>
</tr>
<tr>
<td><option>qpid_protocol</option> = <replaceable>tcp</replaceable></td>
<td>(StrOpt) Transport to use, either 'tcp' or 'ssl'.</td>
</tr>
<tr>
<td><option>qpid_receiver_capacity</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) The number of prefetched messages held by receiver.</td>
</tr>
<tr>
<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><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>
<tr>
<td><option>send_single_reply</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release.</td>
</tr>
</tbody>
</table>
</para>

118
doc/common/tables/aodh-rabbitmq.xml
View File

@ -1,118 +0,0 @@
<?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_aodh_rabbitmq">
<caption>Description of RabbitMQ 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">[oslo_messaging_rabbit]</th>
</tr>
<tr>
<td><option>amqp_auto_delete</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Auto-delete queues in AMQP.</td>
</tr>
<tr>
<td><option>amqp_durable_queues</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Use durable queues in AMQP.</td>
</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>
<tr>
<td><option>heartbeat_rate</option> = <replaceable>2</replaceable></td>
<td>(IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat.</td>
</tr>
<tr>
<td><option>heartbeat_timeout_threshold</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disable the heartbeat). EXPERIMENTAL</td>
</tr>
<tr>
<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><option>kombu_reconnect_timeout</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) How long to wait before considering a reconnect attempt to have failed. This value should not be longer than rpc_response_timeout.</td>
</tr>
<tr>
<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><option>kombu_ssl_certfile</option> = <replaceable></replaceable></td>
<td>(StrOpt) SSL cert file (valid only if SSL enabled).</td>
</tr>
<tr>
<td><option>kombu_ssl_keyfile</option> = <replaceable></replaceable></td>
<td>(StrOpt) SSL key file (valid only if SSL enabled).</td>
</tr>
<tr>
<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, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions.</td>
</tr>
<tr>
<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><option>rabbit_host</option> = <replaceable>localhost</replaceable></td>
<td>(StrOpt) The RabbitMQ broker address where a single node is used.</td>
</tr>
<tr>
<td><option>rabbit_hosts</option> = <replaceable>$rabbit_host:$rabbit_port</replaceable></td>
<td>(ListOpt) RabbitMQ HA cluster host:port pairs.</td>
</tr>
<tr>
<td><option>rabbit_login_method</option> = <replaceable>AMQPLAIN</replaceable></td>
<td>(StrOpt) The RabbitMQ login method.</td>
</tr>
<tr>
<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><option>rabbit_password</option> = <replaceable>guest</replaceable></td>
<td>(StrOpt) The RabbitMQ password.</td>
</tr>
<tr>
<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><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><option>rabbit_retry_interval</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) How frequently to retry connecting with RabbitMQ.</td>
</tr>
<tr>
<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>
<tr>
<td><option>send_single_reply</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release.</td>
</tr>
</tbody>
</table>
</para>

41
doc/common/tables/aodh-redis.xml
View File

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

93
doc/common/tables/aodh-rpc.xml
View File

@ -1,93 +0,0 @@
<?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_aodh_rpc">
<caption>Description of RPC 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>matchmaker_heartbeat_freq</option> = <replaceable>300</replaceable></td>
<td>(IntOpt) Heartbeat frequency.</td>
</tr>
<tr>
<td><option>matchmaker_heartbeat_ttl</option> = <replaceable>600</replaceable></td>
<td>(IntOpt) Heartbeat time-to-live.</td>
</tr>
<tr>
<td><option>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><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><option>rpc_conn_pool_size</option> = <replaceable>30</replaceable></td>
<td>(IntOpt) Size of RPC connection pool.</td>
</tr>
<tr>
<td><option>rpc_response_timeout</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Seconds to wait for a response from a call.</td>
</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 to verify 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>

50
doc/common/tables/aodh-zeromq.xml
View File

@ -1,50 +0,0 @@
<?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_aodh_zeromq">
<caption>Description of ZeroMQ 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>rpc_zmq_bind_address</option> = <replaceable>*</replaceable></td>
<td>(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address.</td>
</tr>
<tr>
<td><option>rpc_zmq_contexts</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Number of ZeroMQ contexts, defaults to 1.</td>
</tr>
<tr>
<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><option>rpc_zmq_ipc_dir</option> = <replaceable>/var/run/openstack</replaceable></td>
<td>(StrOpt) Directory for holding IPC sockets.</td>
</tr>
<tr>
<td><option>rpc_zmq_matchmaker</option> = <replaceable>local</replaceable></td>
<td>(StrOpt) MatchMaker driver.</td>
</tr>
<tr>
<td><option>rpc_zmq_port</option> = <replaceable>9501</replaceable></td>
<td>(IntOpt) ZeroMQ receiver listening port.</td>
</tr>
<tr>
<td><option>rpc_zmq_topic_backlog</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited.</td>
</tr>
</tbody>
</table>
</para>

60
doc/common/tables/ceilometer-amqp.xml
View File

@ -1,60 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_ceilometer_amqp">
<caption>Description of AMQP 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>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><option>notification_driver</option> = <replaceable>[]</replaceable></td>
<td>(MultiStrOpt) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop</td>
</tr>
<tr>
<td><option>notification_topics</option> = <replaceable>notifications</replaceable></td>
<td>(ListOpt) AMQP topic used for OpenStack notifications.</td>
</tr>
<tr>
<td><option>notification_transport_url</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC.</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>
</para>

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

@ -1,122 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_ceilometer_api">
<caption>Description of API 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>api_paste_config</option> = <replaceable>api_paste.ini</replaceable></td>
<td>(StrOpt) Configuration file for WSGI definition of API.</td>
</tr>
<tr>
<td><option>event_pipeline_cfg_file</option> = <replaceable>event_pipeline.yaml</replaceable></td>
<td>(StrOpt) Configuration file for event pipeline definition.</td>
</tr>
<tr>
<td><option>pipeline_cfg_file</option> = <replaceable>pipeline.yaml</replaceable></td>
<td>(StrOpt) Configuration file for pipeline definition.</td>
</tr>
<tr>
<td><option>pipeline_polling_interval</option> = <replaceable>20</replaceable></td>
<td>(IntOpt) Polling interval for pipeline file configuration in seconds.</td>
</tr>
<tr>
<td><option>refresh_event_pipeline_cfg</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Refresh Event Pipeline configuration on-the-fly.</td>
</tr>
<tr>
<td><option>refresh_pipeline_cfg</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Refresh Pipeline configuration on-the-fly.</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>
</tr>
<tr>
<td><option>reserved_metadata_namespace</option> = <replaceable>metering.</replaceable></td>
<td>(ListOpt) List of metadata prefixes reserved for metering use.</td>
</tr>
<tr>
<th colspan="2">[api]</th>
</tr>
<tr>
<td><option>aodh_is_enabled</option> = <replaceable>None</replaceable></td>
<td>(BoolOpt) Set True to redirect alarms URLs to aodh. Default autodetection by querying keystone.</td>
</tr>
<tr>
<td><option>aodh_url</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The endpoint of Aodh to redirect alarms URLs to Aodh API. Default autodetection by querying keystone.</td>
</tr>
<tr>
<td><option>default_api_return_limit</option> = <replaceable>100</replaceable></td>
<td>(IntOpt) Default maximum number of items returned by API request.</td>
</tr>
<tr>
<td><option>gnocchi_is_enabled</option> = <replaceable>None</replaceable></td>
<td>(BoolOpt) Set True to disable resource/meter/sample URLs. Default autodetection by querying keystone.</td>
</tr>
<tr>
<td><option>host</option> = <replaceable>0.0.0.0</replaceable></td>
<td>(StrOpt) The listen IP for the ceilometer API server.</td>
</tr>
<tr>
<td><option>pecan_debug</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Toggle Pecan Debug Middleware.</td>
</tr>
<tr>
<td><option>port</option> = <replaceable>8777</replaceable></td>
<td>(PortOpt) The port for the ceilometer API server.</td>
</tr>
<tr>
<td><option>workers</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Number of workers for api, default value is 1.</td>
</tr>
<tr>
<th colspan="2">[oslo_middleware]</th>
</tr>
<tr>
<td><option>max_request_body_size</option> = <replaceable>114688</replaceable></td>
<td>(IntOpt) The maximum body size for each request, in bytes.</td>
</tr>
<tr>
<td><option>secure_proxy_ssl_header</option> = <replaceable>X-Forwarded-Proto</replaceable></td>
<td>(StrOpt) The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by an SSL termination proxy.</td>
</tr>
</tbody>
</table>
</para>

76
doc/common/tables/ceilometer-auth.xml
View File

@ -1,76 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_ceilometer_auth">
<caption>Description of authorization 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">[service_credentials]</th>
</tr>
<tr>
<td><option>auth_section</option> = <replaceable>None</replaceable></td>
<td>(Opt) Config Section from which to load plugin specific options</td>
</tr>
<tr>
<td><option>auth_type</option> = <replaceable>None</replaceable></td>
<td>(Opt) Authentication type to load</td>
</tr>
<tr>
<td><option>cafile</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) PEM encoded Certificate Authority to use when verifying HTTPs connections.</td>
</tr>
<tr>
<td><option>certfile</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) PEM encoded client certificate cert file</td>
</tr>
<tr>
<td><option>insecure</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Verify HTTPS connections.</td>
</tr>
<tr>
<td><option>interface</option> = <replaceable>public</replaceable></td>
<td>(StrOpt) Type of endpoint in Identity service catalog to use for communication with OpenStack services.</td>
</tr>
<tr>
<td><option>keyfile</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) PEM encoded client certificate key file</td>
</tr>
<tr>
<td><option>region_name</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Region name to use for OpenStack service endpoints.</td>
</tr>
<tr>
<td><option>timeout</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) Timeout value for http requests</td>
</tr>
</tbody>
</table>
</para>

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

@ -1,188 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_ceilometer_auth_token">
<caption>Description of authorization token 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">[keystone_authtoken]</th>
</tr>
<tr>
<td><option>admin_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Service user password.</td>
</tr>
<tr>
<td><option>admin_tenant_name</option> = <replaceable>admin</replaceable></td>
<td>(StrOpt) Service tenant name.</td>
</tr>
<tr>
<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><option>admin_user</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Service username.</td>
</tr>
<tr>
<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><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><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><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><option>auth_section</option> = <replaceable>None</replaceable></td>
<td>(Opt) Config Section from which to load plugin specific options</td>
</tr>
<tr>
<td><option>auth_type</option> = <replaceable>None</replaceable></td>
<td>(Opt) Authentication type to load</td>
</tr>
<tr>
<td><option>auth_uri</option> = <replaceable>None</replaceable></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>
</tr>
<tr>
<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><option>certfile</option> = <replaceable>None</replaceable></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 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>
</tr>
<tr>
<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><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><option>http_connect_timeout</option> = <replaceable>None</replaceable></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>
<td>(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server.</td>
</tr>
<tr>
<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><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><option>insecure</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Verify HTTPS connections.</td>
</tr>
<tr>
<td><option>keyfile</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Required if identity server requires client certificate</td>
</tr>
<tr>
<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 memcached client connection from the pool.</td>
</tr>
<tr>
<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><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 memcached 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) memcached client pool. The advanced pool will only work under python 2.x.</td>
</tr>
<tr>
<td><option>region_name</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The region in which the identity server can be found.</td>
</tr>
<tr>
<td><option>revocation_cache_time</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.</td>
</tr>
<tr>
<td><option>signing_dir</option> = <replaceable>None</replaceable></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>
<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>
</table>
</para>

75
doc/common/tables/ceilometer-collector.xml
View File

@ -1,75 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_ceilometer_collector">
<caption>Description of collector 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">[collector]</th>
</tr>
<tr>
<td><option>requeue_event_on_dispatcher_error</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Requeue the event on the collector event queue when the collector fails to dispatch it.</td>
</tr>
<tr>
<td><option>requeue_sample_on_dispatcher_error</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Requeue the sample on the collector sample queue when the collector fails to dispatch it. This is only valid if the sample come from the notifier publisher.</td>
</tr>
<tr>
<td><option>udp_address</option> = <replaceable>0.0.0.0</replaceable></td>
<td>(StrOpt) Address to which the UDP socket is bound. Set to an empty string to disable.</td>
</tr>
<tr>
<td><option>udp_port</option> = <replaceable>4952</replaceable></td>
<td>(PortOpt) Port to which the UDP socket is bound.</td>
</tr>
<tr>
<td><option>workers</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Number of workers for collector service. default value is 1.</td>
</tr>
<tr>
<th colspan="2">[dispatcher_file]</th>
</tr>
<tr>
<td><option>backup_count</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) The max number of the files to keep.</td>
</tr>
<tr>
<td><option>file_path</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Name and the location of the file to record meters.</td>
</tr>
<tr>
<td><option>max_bytes</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) The max size of the file.</td>
</tr>
</tbody>
</table>
</para>

123
doc/common/tables/ceilometer-common.xml
View File

@ -1,123 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_ceilometer_common">
<caption>Description of common 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>batch_polled_samples</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) To reduce polling agent load, samples are sent to the notification agent in a batch. To gain higher throughput at the cost of load set this to False.</td>
</tr>
<tr>
<td><option>executor_thread_pool_size</option> = <replaceable>64</replaceable></td>
<td>(IntOpt) Size of executor thread pool.</td>
</tr>
<tr>
<td><option>host</option> = <replaceable>localhost</replaceable></td>
<td>(StrOpt) Name of this node, which must be valid in an AMQP key. Can be an opaque identifier. For ZeroMQ only, must be a valid host name, FQDN, or IP address.</td>
</tr>
<tr>
<td><option>http_timeout</option> = <replaceable>600</replaceable></td>
<td>(IntOpt) Timeout seconds for HTTP requests. Set it to None to disable timeout.</td>
</tr>
<tr>
<td><option>memcached_servers</option> = <replaceable>None</replaceable></td>
<td>(ListOpt) Memcached servers or None for in process cache.</td>
</tr>
<tr>
<td><option>polling_namespaces</option> = <replaceable>['compute', 'central']</replaceable></td>
<td>(MultiChoicesOpt) Polling namespace(s) to be used while resource polling</td>
</tr>
<tr>
<td><option>pollster_list</option> = <replaceable>[]</replaceable></td>
<td>(MultiChoicesOpt) List of pollsters (or wildcard templates) to be used while polling</td>
</tr>
<tr>
<td><option>rootwrap_config</option> = <replaceable>/etc/ceilometer/rootwrap.conf</replaceable></td>
<td>(StrOpt) Path to the rootwrap configuration file touse for running commands as root</td>
</tr>
<tr>
<td><option>shuffle_time_before_polling_task</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) To reduce large requests at same time to Nova or other components from different compute agents, shuffle start time of polling task.</td>
</tr>
<tr>
<td><option>sql_expire_samples_only</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Indicates if expirer expires only samples. If set true, expired samples will be deleted, but residual resource and meter definition data will remain.</td>
</tr>
<tr>
<th colspan="2">[compute]</th>
</tr>
<tr>
<td><option>workload_partitioning</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enable work-load partitioning, allowing multiple compute agents to be run simultaneously.</td>
</tr>
<tr>
<th colspan="2">[coordination]</th>
</tr>
<tr>
<td><option>backend_url</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The backend URL to use for distributed coordination. If left empty, per-deployment central agent and per-host compute agent won't do workload partitioning and will only function correctly if a single instance of that service is running.</td>
</tr>
<tr>
<td><option>check_watchers</option> = <replaceable>10.0</replaceable></td>
<td>(FloatOpt) Number of seconds between checks to see if group membership has changed</td>
</tr>
<tr>
<td><option>heartbeat</option> = <replaceable>1.0</replaceable></td>
<td>(FloatOpt) Number of seconds between heartbeats for distributed coordination.</td>
</tr>
<tr>
<th colspan="2">[keystone_authtoken]</th>
</tr>
<tr>
<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>
<th colspan="2">[meter]</th>
</tr>
<tr>
<td><option>meter_definitions_cfg_file</option> = <replaceable>meters.yaml</replaceable></td>
<td>(StrOpt) Configuration file for defining meter notifications.</td>
</tr>
<tr>
<th colspan="2">[polling]</th>
</tr>
<tr>
<td><option>partitioning_group_prefix</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Work-load partitioning group prefix. Use only if you want to run multiple polling agents with different config files. For each sub-group of the agent pool with the same partitioning_group_prefix a disjoint subset of pollsters should be loaded.</td>
</tr>
</tbody>
</table>
</para>

91
doc/common/tables/ceilometer-cors.xml
View File

@ -1,91 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_ceilometer_cors">
<caption>Description of CORS 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">[cors]</th>
</tr>
<tr>
<td><option>allow_credentials</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Indicate that the actual request can include user credentials</td>
</tr>
<tr>
<td><option>allow_headers</option> = <replaceable>Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma</replaceable></td>
<td>(ListOpt) Indicate which header field names may be used during the actual request.</td>
</tr>
<tr>
<td><option>allow_methods</option> = <replaceable>GET, POST, PUT, DELETE, OPTIONS</replaceable></td>
<td>(ListOpt) Indicate which methods can be used during the actual request.</td>
</tr>
<tr>
<td><option>allowed_origin</option> = <replaceable>None</replaceable></td>
<td>(ListOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header.</td>
</tr>
<tr>
<td><option>expose_headers</option> = <replaceable>Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma</replaceable></td>
<td>(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.</td>
</tr>
<tr>
<td><option>max_age</option> = <replaceable>3600</replaceable></td>
<td>(IntOpt) Maximum cache age of CORS preflight requests.</td>
</tr>
<tr>
<th colspan="2">[cors.subdomain]</th>
</tr>
<tr>
<td><option>allow_credentials</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Indicate that the actual request can include user credentials</td>
</tr>
<tr>
<td><option>allow_headers</option> = <replaceable>Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma</replaceable></td>
<td>(ListOpt) Indicate which header field names may be used during the actual request.</td>
</tr>
<tr>
<td><option>allow_methods</option> = <replaceable>GET, POST, PUT, DELETE, OPTIONS</replaceable></td>
<td>(ListOpt) Indicate which methods can be used during the actual request.</td>
</tr>
<tr>
<td><option>allowed_origin</option> = <replaceable>None</replaceable></td>
<td>(ListOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header.</td>
</tr>
<tr>
<td><option>expose_headers</option> = <replaceable>Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma</replaceable></td>
<td>(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.</td>
</tr>
<tr>
<td><option>max_age</option> = <replaceable>3600</replaceable></td>
<td>(IntOpt) Maximum cache age of CORS preflight requests.</td>
</tr>
</tbody>
</table>
</para>

147
doc/common/tables/ceilometer-database.xml
View File

@ -1,147 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_ceilometer_database">
<caption>Description of database configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>database_connection</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) DEPRECATED - Database connection string.</td>
</tr>
<tr>
<th colspan="2">[database]</th>
</tr>
<tr>
<td><option>backend</option> = <replaceable>sqlalchemy</replaceable></td>
<td>(StrOpt) The back end to use for the database.</td>
</tr>
<tr>
<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><option>connection_debug</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything.</td>
</tr>
<tr>
<td><option>connection_trace</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Add Python stack traces to SQL as comment strings.</td>
</tr>
<tr>
<td><option>db2nosql_resource_id_maxlen</option> = <replaceable>512</replaceable></td>
<td>(IntOpt) The max length of resources id in DB2 nosql, the value should be larger than len(hostname) * 2 as compute node's resource id is &lt;hostname&gt;_&lt;nodename&gt;.</td>
</tr>
<tr>
<td><option>db_inc_retry_interval</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) If True, increases the interval between retries of a database operation up to db_max_retry_interval.</td>
</tr>
<tr>
<td><option>db_max_retries</option> = <replaceable>20</replaceable></td>
<td>(IntOpt) Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count.</td>
</tr>
<tr>
<td><option>db_max_retry_interval</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation.</td>
</tr>
<tr>
<td><option>db_retry_interval</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Seconds between retries of a database transaction.</td>
</tr>
<tr>
<td><option>event_connection</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The connection string used to connect to the event database. (if unset, connection is used)</td>
</tr>
<tr>
<td><option>event_time_to_live</option> = <replaceable>-1</replaceable></td>
<td>(IntOpt) Number of seconds that events are kept in the database for (&lt;= 0 means forever).</td>
</tr>
<tr>
<td><option>idle_timeout</option> = <replaceable>3600</replaceable></td>
<td>(IntOpt) Timeout before idle SQL connections are reaped.</td>
</tr>
<tr>
<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><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><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><option>metering_connection</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The connection string used to connect to the metering database. (if unset, connection is used)</td>
</tr>
<tr>
<td><option>metering_time_to_live</option> = <replaceable>-1</replaceable></td>
<td>(IntOpt) Number of seconds that samples are kept in the database for (&lt;= 0 means forever).</td>
</tr>
<tr>
<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><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><option>pool_timeout</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) If set, use this value for pool_timeout with SQLAlchemy.</td>
</tr>
<tr>
<td><option>retry_interval</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Interval between retries of opening a SQL connection.</td>
</tr>
<tr>
<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><option>sqlite_db</option> = <replaceable>oslo.sqlite</replaceable></td>
<td>(StrOpt) The file name to use with SQLite.</td>
</tr>
<tr>
<td><option>sqlite_synchronous</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) If True, SQLite uses synchronous mode.</td>
</tr>
<tr>
<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>
</table>
</para>

44
doc/common/tables/ceilometer-debug.xml
View File

@ -1,44 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_ceilometer_debug">
<caption>Description of logging 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>nova_http_log_debug</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Allow novaclient's debug log output. (Use default_log_levels instead)</td>
</tr>
</tbody>
</table>
</para>

60
doc/common/tables/ceilometer-dispatcher_gnocchi.xml
View File

@ -1,60 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_ceilometer_dispatcher_gnocchi">
<caption>Description of Gnocchi dispatcher 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">[dispatcher_gnocchi]</th>
</tr>
<tr>
<td><option>archive_policy</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The archive policy to use when the dispatcher create a new metric.</td>
</tr>
<tr>
<td><option>filter_project</option> = <replaceable>gnocchi</replaceable></td>
<td>(StrOpt) Gnocchi project used to filter out samples generated by Gnocchi service activity</td>
</tr>
<tr>
<td><option>filter_service_activity</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Filter out samples generated by Gnocchi service activity</td>
</tr>
<tr>
<td><option>resources_definition_file</option> = <replaceable>gnocchi_resources.yaml</replaceable></td>
<td>(StrOpt) The Yaml file that defines mapping between samples and gnocchi resources/metrics</td>
</tr>
<tr>
<td><option>url</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) URL to Gnocchi. default: autodetection</td>
</tr>
</tbody>
</table>
</para>

52
doc/common/tables/ceilometer-dispatcher_http.xml
View File

@ -1,52 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_ceilometer_dispatcher_http">
<caption>Description of HTTP dispatcher 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">[dispatcher_http]</th>
</tr>
<tr>
<td><option>event_target</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The target for event data where the http request will be sent to. If this is not set, it will default to same as Sample target.</td>
</tr>
<tr>
<td><option>target</option> = <replaceable></replaceable></td>
<td>(StrOpt) The target where the http request will be sent. If this is not set, no data will be posted. For example: target = http://hostname:1234/path</td>
</tr>
<tr>
<td><option>timeout</option> = <replaceable>5</replaceable></td>
<td>(IntOpt) The max time in seconds to wait for a request to timeout.</td>
</tr>
</tbody>
</table>
</para>

48
doc/common/tables/ceilometer-dispatchers.xml
View File

@ -1,48 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_ceilometer_dispatchers">
<caption>Description of dispatchers 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>event_dispatchers</option> = <replaceable>['database']</replaceable></td>
<td>(MultiStrOpt) Dispatchers to process event data.</td>
</tr>
<tr>
<td><option>meter_dispatchers</option> = <replaceable>['database']</replaceable></td>
<td>(MultiStrOpt) Dispatchers to process metering data.</td>
</tr>
</tbody>
</table>
</para>

71
doc/common/tables/ceilometer-events.xml
View File

@ -1,71 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_ceilometer_events">
<caption>Description of events 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">[event]</th>
</tr>
<tr>
<td><option>definitions_cfg_file</option> = <replaceable>event_definitions.yaml</replaceable></td>
<td>(StrOpt) Configuration file for event definitions.</td>
</tr>
<tr>
<td><option>drop_unmatched_notifications</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Drop notifications if no event definition matches. (Otherwise, we convert them with just the default traits)</td>
</tr>
<tr>
<td><option>store_raw</option> = <replaceable>[]</replaceable></td>
<td>(MultiStrOpt) Store the raw notification for select priority levels (info and/or error). By default, raw details are not captured.</td>
</tr>
<tr>
<th colspan="2">[notification]</th>
</tr>
<tr>
<td><option>ack_on_event_error</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Acknowledge message when event persistence fails.</td>
</tr>
<tr>
<td><option>store_events</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Save event details.</td>
</tr>
<tr>
<td><option>workers</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Number of workers for notification service, default value is 1.</td>
</tr>
<tr>
<td><option>workload_partitioning</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enable workload partitioning, allowing multiple notification agents to be run simultaneously.</td>
</tr>
</tbody>
</table>
</para>

100
doc/common/tables/ceilometer-exchange.xml
View File

@ -1,100 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_ceilometer_exchange">
<caption>Description of exchange 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>ceilometer_control_exchange</option> = <replaceable>ceilometer</replaceable></td>
<td>(StrOpt) Exchange name for ceilometer notifications.</td>
</tr>
<tr>
<td><option>cinder_control_exchange</option> = <replaceable>cinder</replaceable></td>
<td>(StrOpt) Exchange name for Cinder notifications.</td>
</tr>
<tr>
<td><option>dns_control_exchange</option> = <replaceable>central</replaceable></td>
<td>(StrOpt) Exchange name for DNS notifications.</td>
</tr>
<tr>
<td><option>glance_control_exchange</option> = <replaceable>glance</replaceable></td>
<td>(StrOpt) Exchange name for Glance notifications.</td>
</tr>
<tr>
<td><option>heat_control_exchange</option> = <replaceable>heat</replaceable></td>
<td>(StrOpt) Exchange name for Heat notifications</td>
</tr>
<tr>
<td><option>http_control_exchanges</option> = <replaceable>['nova', 'glance', 'neutron', 'cinder']</replaceable></td>
<td>(MultiStrOpt) Exchanges name to listen for notifications.</td>
</tr>
<tr>
<td><option>ironic_exchange</option> = <replaceable>ironic</replaceable></td>
<td>(StrOpt) Exchange name for Ironic notifications.</td>
</tr>
<tr>
<td><option>keystone_control_exchange</option> = <replaceable>keystone</replaceable></td>
<td>(StrOpt) Exchange name for Keystone notifications.</td>
</tr>
<tr>
<td><option>magnum_control_exchange</option> = <replaceable>magnum</replaceable></td>
<td>(StrOpt) Exchange name for Magnum notifications.</td>
</tr>
<tr>
<td><option>neutron_control_exchange</option> = <replaceable>neutron</replaceable></td>
<td>(StrOpt) Exchange name for Neutron notifications.</td>
</tr>
<tr>
<td><option>nova_control_exchange</option> = <replaceable>nova</replaceable></td>
<td>(StrOpt) Exchange name for Nova notifications.</td>
</tr>
<tr>
<td><option>sahara_control_exchange</option> = <replaceable>sahara</replaceable></td>
<td>(StrOpt) Exchange name for Data Processing notifications.</td>
</tr>
<tr>
<td><option>sample_source</option> = <replaceable>openstack</replaceable></td>
<td>(StrOpt) Source for samples emitted on this instance.</td>
</tr>
<tr>
<td><option>swift_control_exchange</option> = <replaceable>swift</replaceable></td>
<td>(StrOpt) Exchange name for Swift notifications.</td>
</tr>
<tr>
<td><option>trove_control_exchange</option> = <replaceable>trove</replaceable></td>
<td>(StrOpt) Exchange name for DBaaS notifications.</td>
</tr>
</tbody>
</table>
</para>

44
doc/common/tables/ceilometer-glance.xml
View File

@ -1,44 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_ceilometer_glance">
<caption>Description of glance 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>glance_page_size</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) Number of items to request in each paginated Glance API request (parameter used by glancecelient). If this is less than or equal to 0, page size is not specified (default value in glanceclient is used).</td>
</tr>
</tbody>
</table>
</para>

52
doc/common/tables/ceilometer-inspector.xml
View File

@ -1,52 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_ceilometer_inspector">
<caption>Description of inspector 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>hypervisor_inspector</option> = <replaceable>libvirt</replaceable></td>
<td>(StrOpt) Inspector to use for inspecting the hypervisor layer. Known inspectors are libvirt, hyperv, vmware, xenapi and powervm.</td>
</tr>
<tr>
<td><option>libvirt_type</option> = <replaceable>kvm</replaceable></td>
<td>(StrOpt) Libvirt domain type.</td>
</tr>
<tr>
<td><option>libvirt_uri</option> = <replaceable></replaceable></td>
<td>(StrOpt) Override the default libvirt URI (which is dependent on libvirt_type).</td>
</tr>
</tbody>
</table>
</para>

48
doc/common/tables/ceilometer-ipmi.xml
View File

@ -1,48 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_ceilometer_ipmi">
<caption>Description of IPMI 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">[ipmi]</th>
</tr>
<tr>
<td><option>node_manager_init_retry</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) Number of retries upon Intel Node Manager initialization failure</td>
</tr>
<tr>
<td><option>polling_retry</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) Tolerance of IPMI/NM polling failures before disable this pollster. Negative indicates retrying forever.</td>
</tr>
</tbody>
</table>
</para>

128
doc/common/tables/ceilometer-logging.xml
View File

@ -1,128 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_ceilometer_logging">
<caption>Description of logging 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>debug</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default INFO level).</td>
</tr>
<tr>
<td><option>default_log_levels</option> = <replaceable>amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN, taskflow=WARN</replaceable></td>
<td>(ListOpt) List of logger=LEVEL pairs. This option is ignored if log_config_append is set.</td>
</tr>
<tr>
<td><option>fatal_deprecations</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enables or disables fatal status of deprecations.</td>
</tr>
<tr>
<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><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><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. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log_format).</td>
</tr>
<tr>
<td><option>log_date_format</option> = <replaceable>%Y-%m-%d %H:%M:%S</replaceable></td>
<td>(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set.</td>
</tr>
<tr>
<td><option>log_dir</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) (Optional) The base directory used for relative --log-file paths. This option is ignored if log_config_append is set.</td>
</tr>
<tr>
<td><option>log_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. This option is ignored if log_config_append is set.</td>
</tr>
<tr>
<td><option>log_format</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. This option is ignored if log_config_append is set.</td>
</tr>
<tr>
<td><option>logging_context_format_string</option> = <replaceable>%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s</replaceable></td>
<td>(StrOpt) Format string to use for log messages with context.</td>
</tr>
<tr>
<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><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><option>logging_exception_prefix</option> = <replaceable>%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s</replaceable></td>
<td>(StrOpt) Prefix each line of exception output with this format.</td>
</tr>
<tr>
<td><option>logging_user_identity_format</option> = <replaceable>%(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s</replaceable></td>
<td>(StrOpt) Format string for user_identity field of the logging_context_format_string</td>
</tr>
<tr>
<td><option>publish_errors</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enables or disables publication of error events.</td>
</tr>
<tr>
<td><option>syslog_log_facility</option> = <replaceable>LOG_USER</replaceable></td>
<td>(StrOpt) Syslog facility to receive log lines. This option is ignored if log_config_append is set.</td>
</tr>
<tr>
<td><option>use_stderr</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Log output to standard error. This option is ignored if log_config_append is set.</td>
</tr>
<tr>
<td><option>use_syslog</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set.</td>
</tr>
<tr>
<td><option>use_syslog_rfc_format</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in Kilo, and will be removed in Mitaka, along with this option. This option is ignored if log_config_append is set.</td>
</tr>
<tr>
<td><option>verbose</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) If set to false, will disable INFO logging level, making WARNING the default.</td>
</tr>
<tr>
<td><option>watch_log_file</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) (Optional) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log-file option is specified and Linux platform is used. This option is ignored if log_config_append is set.</td>
</tr>
</tbody>
</table>
</para>

44
doc/common/tables/ceilometer-magnetodb.xml
View File

@ -1,44 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<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>

48
doc/common/tables/ceilometer-notification.xml
View File

@ -1,48 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_ceilometer_notification">
<caption>Description of notification 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">[notification]</th>
</tr>
<tr>
<td><option>disable_non_metric_meters</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) WARNING: Ceilometer historically offered the ability to store events as meters. This usage is NOT advised as it can flood the metering database and cause performance degradation.</td>
</tr>
<tr>
<td><option>pipeline_processing_queues</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Number of queues to parallelize workload across. This value should be larger than the number of active notification agents for optimal results.</td>
</tr>
</tbody>
</table>
</para>

52
doc/common/tables/ceilometer-policy.xml
View File

@ -1,52 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_ceilometer_policy">
<caption>Description of policy 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">[oslo_policy]</th>
</tr>
<tr>
<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. Missing or empty directories are ignored.</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>
</para>

96
doc/common/tables/ceilometer-qpid.xml
View File

@ -1,96 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_ceilometer_qpid">
<caption>Description of Qpid 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">[oslo_messaging_qpid]</th>
</tr>
<tr>
<td><option>amqp_auto_delete</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Auto-delete queues in AMQP.</td>
</tr>
<tr>
<td><option>amqp_durable_queues</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Use durable queues in AMQP.</td>
</tr>
<tr>
<td><option>qpid_heartbeat</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Seconds between connection keepalive heartbeats.</td>
</tr>
<tr>
<td><option>qpid_hostname</option> = <replaceable>localhost</replaceable></td>
<td>(StrOpt) Qpid broker hostname.</td>
</tr>
<tr>
<td><option>qpid_hosts</option> = <replaceable>$qpid_hostname:$qpid_port</replaceable></td>
<td>(ListOpt) Qpid HA cluster host:port pairs.</td>
</tr>
<tr>
<td><option>qpid_password</option> = <replaceable></replaceable></td>
<td>(StrOpt) Password for Qpid connection.</td>
</tr>
<tr>
<td><option>qpid_port</option> = <replaceable>5672</replaceable></td>
<td>(IntOpt) Qpid broker port.</td>
</tr>
<tr>
<td><option>qpid_protocol</option> = <replaceable>tcp</replaceable></td>
<td>(StrOpt) Transport to use, either 'tcp' or 'ssl'.</td>
</tr>
<tr>
<td><option>qpid_receiver_capacity</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) The number of prefetched messages held by receiver.</td>
</tr>
<tr>
<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><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>
<tr>
<td><option>send_single_reply</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release.</td>
</tr>
</tbody>
</table>
</para>

136
doc/common/tables/ceilometer-rabbitmq.xml
View File

@ -1,136 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_ceilometer_rabbitmq">
<caption>Description of RabbitMQ 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">[oslo_messaging_rabbit]</th>
</tr>
<tr>
<td><option>amqp_auto_delete</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Auto-delete queues in AMQP.</td>
</tr>
<tr>
<td><option>amqp_durable_queues</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Use durable queues in AMQP.</td>
</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>
<tr>
<td><option>heartbeat_rate</option> = <replaceable>2</replaceable></td>
<td>(IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat.</td>
</tr>
<tr>
<td><option>heartbeat_timeout_threshold</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disable the heartbeat). EXPERIMENTAL</td>
</tr>
<tr>
<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><option>kombu_reconnect_timeout</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) How long to wait before considering a reconnect attempt to have failed. This value should not be longer than rpc_response_timeout.</td>
</tr>
<tr>
<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><option>kombu_ssl_certfile</option> = <replaceable></replaceable></td>
<td>(StrOpt) SSL cert file (valid only if SSL enabled).</td>
</tr>
<tr>
<td><option>kombu_ssl_keyfile</option> = <replaceable></replaceable></td>
<td>(StrOpt) SSL key file (valid only if SSL enabled).</td>
</tr>
<tr>
<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, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions.</td>
</tr>
<tr>
<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><option>rabbit_host</option> = <replaceable>localhost</replaceable></td>
<td>(StrOpt) The RabbitMQ broker address where a single node is used.</td>
</tr>
<tr>
<td><option>rabbit_hosts</option> = <replaceable>$rabbit_host:$rabbit_port</replaceable></td>
<td>(ListOpt) RabbitMQ HA cluster host:port pairs.</td>
</tr>
<tr>
<td><option>rabbit_login_method</option> = <replaceable>AMQPLAIN</replaceable></td>
<td>(StrOpt) The RabbitMQ login method.</td>
</tr>
<tr>
<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><option>rabbit_password</option> = <replaceable>guest</replaceable></td>
<td>(StrOpt) The RabbitMQ password.</td>
</tr>
<tr>
<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><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><option>rabbit_retry_interval</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) How frequently to retry connecting with RabbitMQ.</td>
</tr>
<tr>
<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>
<tr>
<td><option>send_single_reply</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release.</td>
</tr>
</tbody>
</table>
</para>

63
doc/common/tables/ceilometer-redis.xml
View File

@ -1,63 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_ceilometer_redis">
<caption>Description of Redis 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>password</option> = <replaceable></replaceable></td>
<td>(StrOpt) Password for Redis server (optional).</td>
</tr>
<tr>
<td><option>port</option> = <replaceable>6379</replaceable></td>
<td>(IntOpt) Use this port to connect to redis host.</td>
</tr>
<tr>
<th colspan="2">[matchmaker_redis]</th>
</tr>
<tr>
<td><option>host</option> = <replaceable>127.0.0.1</replaceable></td>
<td>(StrOpt) Host to locate redis.</td>
</tr>
<tr>
<td><option>password</option> = <replaceable></replaceable></td>
<td>(StrOpt) Password for Redis server (optional).</td>
</tr>
<tr>
<td><option>port</option> = <replaceable>6379</replaceable></td>
<td>(IntOpt) Use this port to connect to redis host.</td>
</tr>
</tbody>
</table>
</para>

48
doc/common/tables/ceilometer-rgw.xml
View File

@ -1,48 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_ceilometer_rgw">
<caption>Description of Rados gateway 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">[rgw_admin_credentials]</th>
</tr>
<tr>
<td><option>access_key</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Access key for Radosgw Admin.</td>
</tr>
<tr>
<td><option>secret_key</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Secret key for Radosgw Admin.</td>
</tr>
</tbody>
</table>
</para>

167
doc/common/tables/ceilometer-rpc.xml
View File

@ -1,167 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_ceilometer_rpc">
<caption>Description of RPC 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>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><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><option>rpc_conn_pool_size</option> = <replaceable>30</replaceable></td>
<td>(IntOpt) Size of RPC connection pool.</td>
</tr>
<tr>
<td><option>rpc_poll_timeout</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired.</td>
</tr>
<tr>
<td><option>rpc_response_timeout</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Seconds to wait for a response from a call.</td>
</tr>
<tr>
<th colspan="2">[notification]</th>
</tr>
<tr>
<td><option>messaging_urls</option> = <replaceable>[]</replaceable></td>
<td>(MultiStrOpt) Messaging URLs to listen for notifications. Example: transport://user:pass@host1:port[,hostN:portN]/virtual_host (DEFAULT/transport_url is used if empty)</td>
</tr>
<tr>
<th colspan="2">[oslo_concurrency]</th>
</tr>
<tr>
<td><option>disable_process_locking</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enables or disables inter-process locks.</td>
</tr>
<tr>
<td><option>lock_path</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If external locks are used, a lock path must be set.</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>password</option> = <replaceable></replaceable></td>
<td>(StrOpt) Password for message broker authentication</td>
</tr>
<tr>
<td><option>sasl_config_dir</option> = <replaceable></replaceable></td>
<td>(StrOpt) Path to directory that contains the SASL configuration</td>
</tr>
<tr>
<td><option>sasl_config_name</option> = <replaceable></replaceable></td>
<td>(StrOpt) Name of configuration file (without .conf suffix)</td>
</tr>
<tr>
<td><option>sasl_mechanisms</option> = <replaceable></replaceable></td>
<td>(StrOpt) Space separated list of acceptable SASL mechanisms</td>
</tr>
<tr>
<td><option>server_request_prefix</option> = <replaceable>exclusive</replaceable></td>
<td>(StrOpt) address prefix used when sending to a specific server</td>
</tr>
<tr>
<td><option>ssl_ca_file</option> = <replaceable></replaceable></td>
<td>(StrOpt) CA certificate PEM file to verify 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>
<tr>
<td><option>username</option> = <replaceable></replaceable></td>
<td>(StrOpt) User name for message broker authentication</td>
</tr>
<tr>
<th colspan="2">[publisher]</th>
</tr>
<tr>
<td><option>telemetry_secret</option> = <replaceable>change this for valid signing</replaceable></td>
<td>(StrOpt) Secret value for signing messages. Set value empty if signing is not required to avoid computational overhead.</td>
</tr>
<tr>
<th colspan="2">[publisher_notifier]</th>
</tr>
<tr>
<td><option>event_topic</option> = <replaceable>event</replaceable></td>
<td>(StrOpt) The topic that ceilometer uses for event notifications.</td>
</tr>
<tr>
<td><option>metering_topic</option> = <replaceable>metering</replaceable></td>
<td>(StrOpt) The topic that ceilometer uses for metering notifications.</td>
</tr>
<tr>
<td><option>telemetry_driver</option> = <replaceable>messagingv2</replaceable></td>
<td>(StrOpt) The driver that ceilometer uses for metering notifications.</td>
</tr>
</tbody>
</table>
</para>

64
doc/common/tables/ceilometer-service_types.xml
View File

@ -1,64 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_ceilometer_service_types">
<caption>Description of service types 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">[service_types]</th>
</tr>
<tr>
<td><option>glance</option> = <replaceable>image</replaceable></td>
<td>(StrOpt) Glance service type.</td>
</tr>
<tr>
<td><option>kwapi</option> = <replaceable>energy</replaceable></td>
<td>(StrOpt) Kwapi service type.</td>
</tr>
<tr>
<td><option>neutron</option> = <replaceable>network</replaceable></td>
<td>(StrOpt) Neutron service type.</td>
</tr>
<tr>
<td><option>nova</option> = <replaceable>compute</replaceable></td>
<td>(StrOpt) Nova service type.</td>
</tr>
<tr>
<td><option>radosgw</option> = <replaceable>object-store</replaceable></td>
<td>(StrOpt) Radosgw service type.</td>
</tr>
<tr>
<td><option>swift</option> = <replaceable>object-store</replaceable></td>
<td>(StrOpt) Swift service type.</td>
</tr>
</tbody>
</table>
</para>

48
doc/common/tables/ceilometer-storage.xml
View File

@ -1,48 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_ceilometer_storage">
<caption>Description of storage 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">[storage]</th>
</tr>
<tr>
<td><option>max_retries</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Maximum number of connection retries during startup. Set to -1 to specify an infinite retry count.</td>
</tr>
<tr>
<td><option>retry_interval</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Interval (in seconds) between retries of connection.</td>
</tr>
</tbody>
</table>
</para>

44
doc/common/tables/ceilometer-swift.xml
View File

@ -1,44 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_ceilometer_swift">
<caption>Description of swift 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>reseller_prefix</option> = <replaceable>AUTH_</replaceable></td>
<td>(StrOpt) Swift reseller prefix. Must be on par with reseller_prefix in proxy-server.conf.</td>
</tr>
</tbody>
</table>
</para>

56
doc/common/tables/ceilometer-tripleo.xml
View File

@ -1,56 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_ceilometer_tripleo">
<caption>Description of TripleO 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">[hardware]</th>
</tr>
<tr>
<td><option>meter_definitions_file</option> = <replaceable>snmp.yaml</replaceable></td>
<td>(StrOpt) Configuration file for defining hardware snmp meters.</td>
</tr>
<tr>
<td><option>readonly_user_name</option> = <replaceable>ro_snmp_user</replaceable></td>
<td>(StrOpt) SNMPd user name of all nodes running in the cloud.</td>
</tr>
<tr>
<td><option>readonly_user_password</option> = <replaceable>password</replaceable></td>
<td>(StrOpt) SNMPd password of all the nodes running in the cloud.</td>
</tr>
<tr>
<td><option>url_scheme</option> = <replaceable>snmp://</replaceable></td>
<td>(StrOpt) URL scheme to use for hardware nodes.</td>
</tr>
</tbody>
</table>
</para>

76
doc/common/tables/ceilometer-vmware.xml
View File

@ -1,76 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_ceilometer_vmware">
<caption>Description of VMware 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">[vmware]</th>
</tr>
<tr>
<td><option>api_retry_count</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Number of times a VMware vSphere API may be retried.</td>
</tr>
<tr>
<td><option>ca_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) CA bundle file to use in verifying the vCenter server certificate.</td>
</tr>
<tr>
<td><option>host_ip</option> = <replaceable></replaceable></td>
<td>(StrOpt) IP address of the VMware vSphere host.</td>
</tr>
<tr>
<td><option>host_password</option> = <replaceable></replaceable></td>
<td>(StrOpt) Password of VMware vSphere.</td>
</tr>
<tr>
<td><option>host_port</option> = <replaceable>443</replaceable></td>
<td>(PortOpt) Port of the VMware vSphere host.</td>
</tr>
<tr>
<td><option>host_username</option> = <replaceable></replaceable></td>
<td>(StrOpt) Username of VMware vSphere.</td>
</tr>
<tr>
<td><option>insecure</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) If true, the vCenter server certificate is not verified. If false, then the default CA truststore is used for verification. This option is ignored if "ca_file" is set.</td>
</tr>
<tr>
<td><option>task_poll_interval</option> = <replaceable>0.5</replaceable></td>
<td>(FloatOpt) Sleep time in seconds for polling an ongoing async task.</td>
</tr>
<tr>
<td><option>wsdl_location</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Optional vim service WSDL location e.g http://&lt;server&gt;/vimService.wsdl. Optional over-ride to default location for bug work-arounds.</td>
</tr>
</tbody>
</table>
</para>

52
doc/common/tables/ceilometer-xenapi.xml
View File

@ -1,52 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_ceilometer_xenapi">
<caption>Description of XenAPI 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">[xenapi]</th>
</tr>
<tr>
<td><option>connection_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Password for connection to XenServer/Xen Cloud Platform.</td>
</tr>
<tr>
<td><option>connection_url</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) URL for connection to XenServer/Xen Cloud Platform.</td>
</tr>
<tr>
<td><option>connection_username</option> = <replaceable>root</replaceable></td>
<td>(StrOpt) Username for connection to XenServer/Xen Cloud Platform.</td>
</tr>
</tbody>
</table>
</para>

44
doc/common/tables/ceilometer-zaqar.xml
View File

@ -1,44 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<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>

88
doc/common/tables/ceilometer-zeromq.xml
View File

@ -1,88 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_ceilometer_zeromq">
<caption>Description of ZeroMQ 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>rpc_zmq_all_req_rep</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT.</td>
</tr>
<tr>
<td><option>rpc_zmq_bind_address</option> = <replaceable>*</replaceable></td>
<td>(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address.</td>
</tr>
<tr>
<td><option>rpc_zmq_bind_port_retries</option> = <replaceable>100</replaceable></td>
<td>(IntOpt) Number of retries to find free port number before fail with ZMQBindError.</td>
</tr>
<tr>
<td><option>rpc_zmq_concurrency</option> = <replaceable>eventlet</replaceable></td>
<td>(StrOpt) Type of concurrency used. Either "native" or "eventlet"</td>
</tr>
<tr>
<td><option>rpc_zmq_contexts</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Number of ZeroMQ contexts, defaults to 1.</td>
</tr>
<tr>
<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><option>rpc_zmq_ipc_dir</option> = <replaceable>/var/run/openstack</replaceable></td>
<td>(StrOpt) Directory for holding IPC sockets.</td>
</tr>
<tr>
<td><option>rpc_zmq_matchmaker</option> = <replaceable>redis</replaceable></td>
<td>(StrOpt) MatchMaker driver.</td>
</tr>
<tr>
<td><option>rpc_zmq_max_port</option> = <replaceable>65536</replaceable></td>
<td>(IntOpt) Maximal port number for random ports range.</td>
</tr>
<tr>
<td><option>rpc_zmq_min_port</option> = <replaceable>49152</replaceable></td>
<td>(IntOpt) Minimal port number for random ports range.</td>
</tr>
<tr>
<td><option>rpc_zmq_topic_backlog</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited.</td>
</tr>
<tr>
<td><option>zmq_use_broker</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Shows whether zmq-messaging uses broker or not.</td>
</tr>
</tbody>
</table>
</para>

56
doc/common/tables/cinder-amqp.xml
View File

@ -1,56 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_amqp">
<caption>Description of AMQP 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>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><option>notification_driver</option> = <replaceable>[]</replaceable></td>
<td>(MultiStrOpt) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop</td>
</tr>
<tr>
<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>
</para>

193
doc/common/tables/cinder-api.xml
View File

@ -1,193 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_api">
<caption>Description of API 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>api_paste_config</option> = <replaceable>api-paste.ini</replaceable></td>
<td>(StrOpt) File name for the paste.deploy config for cinder-api</td>
</tr>
<tr>
<td><option>api_rate_limit</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Enables or disables rate limit of the API.</td>
</tr>
<tr>
<td><option>az_cache_duration</option> = <replaceable>3600</replaceable></td>
<td>(IntOpt) Cache volume availability zones in memory for the provided duration in seconds</td>
</tr>
<tr>
<td><option>backend_host</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Backend override of host value.</td>
</tr>
<tr>
<td><option>default_timeout</option> = <replaceable>525600</replaceable></td>
<td>(IntOpt) Default timeout for CLI operations in minutes. For example, LUN migration is a typical long running operation, which depends on the LUN size and the load of the array. An upper bound in the specific deployment can be set to avoid unnecessary long wait. By default, it is 365 days long.</td>
</tr>
<tr>
<td><option>enable_v1_api</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) DEPRECATED: Deploy v1 of the Cinder API.</td>
</tr>
<tr>
<td><option>enable_v2_api</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Deploy v2 of the Cinder API.</td>
</tr>
<tr>
<td><option>extra_capabilities</option> = <replaceable>{}</replaceable></td>
<td>(StrOpt) User defined capabilities, a JSON formatted string specifying key/value pairs. The key/value pairs can be used by the CapabilitiesFilter to select between backends when requests specify volume types. For example, specifying a service level or the geographical location of a backend, then creating a volume type to allow the user to select by these different properties.</td>
</tr>
<tr>
<td><option>ignore_pool_full_threshold</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Force LUN creation even if the full threshold of pool is reached.</td>
</tr>
<tr>
<td><option>management_ips</option> = <replaceable></replaceable></td>
<td>(StrOpt) List of Management IP addresses (separated by commas)</td>
</tr>
<tr>
<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><option>osapi_max_limit</option> = <replaceable>1000</replaceable></td>
<td>(IntOpt) The maximum number of items that a collection resource returns in a single response</td>
</tr>
<tr>
<td><option>osapi_max_request_body_size</option> = <replaceable>114688</replaceable></td>
<td>(IntOpt) Max size for body of a request</td>
</tr>
<tr>
<td><option>osapi_volume_base_URL</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Base URL that will be presented to users in links to the OpenStack Volume API</td>
</tr>
<tr>
<td><option>osapi_volume_ext_list</option> = <replaceable></replaceable></td>
<td>(ListOpt) Specify list of extensions to load when using osapi_volume_extension option with cinder.api.contrib.select_extensions</td>
</tr>
<tr>
<td><option>osapi_volume_extension</option> = <replaceable>['cinder.api.contrib.standard_extensions']</replaceable></td>
<td>(MultiStrOpt) osapi volume extension to load</td>
</tr>
<tr>
<td><option>osapi_volume_listen</option> = <replaceable>0.0.0.0</replaceable></td>
<td>(StrOpt) IP address on which OpenStack Volume API listens</td>
</tr>
<tr>
<td><option>osapi_volume_listen_port</option> = <replaceable>8776</replaceable></td>
<td>(IntOpt) Port on which OpenStack Volume API listens</td>
</tr>
<tr>
<td><option>osapi_volume_workers</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) Number of workers for OpenStack Volume API service. The default is equal to the number of CPUs available.</td>
</tr>
<tr>
<td><option>password</option> = <replaceable></replaceable></td>
<td>(StrOpt) Password for Redis server (optional).</td>
</tr>
<tr>
<td><option>per_volume_size_limit</option> = <replaceable>-1</replaceable></td>
<td>(IntOpt) Max size allowed per volume, in gigabytes</td>
</tr>
<tr>
<td><option>port</option> = <replaceable>6379</replaceable></td>
<td>(IntOpt) Use this port to connect to redis host.</td>
</tr>
<tr>
<td><option>public_endpoint</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Public url to use for versions endpoint. The default is None, which will use the request's host_url attribute to populate the URL base. If Cinder is operating behind a proxy, you will want to change this to represent the proxy's URL.</td>
</tr>
<tr>
<td><option>query_volume_filters</option> = <replaceable>name, status, metadata, availability_zone</replaceable></td>
<td>(ListOpt) Volume filter options which non-admin user could use to query volumes. Default values are: ['name', 'status', 'metadata', 'availability_zone']</td>
</tr>
<tr>
<td><option>transfer_api_class</option> = <replaceable>cinder.transfer.api.API</replaceable></td>
<td>(StrOpt) The full class name of the volume transfer API class</td>
</tr>
<tr>
<td><option>volume_api_class</option> = <replaceable>cinder.volume.api.API</replaceable></td>
<td>(StrOpt) The full class name of the volume API class to use</td>
</tr>
<tr>
<td><option>volume_name_template</option> = <replaceable>volume-%s</replaceable></td>
<td>(StrOpt) Template string to be used to generate volume names</td>
</tr>
<tr>
<td><option>volume_number_multiplier</option> = <replaceable>-1.0</replaceable></td>
<td>(FloatOpt) Multiplier used for weighing volume number. Negative numbers mean to spread vs stack.</td>
</tr>
<tr>
<td><option>volume_transfer_key_length</option> = <replaceable>16</replaceable></td>
<td>(IntOpt) The number of characters in the autogenerated auth key.</td>
</tr>
<tr>
<td><option>volume_transfer_salt_length</option> = <replaceable>8</replaceable></td>
<td>(IntOpt) The number of characters in the salt.</td>
</tr>
<tr>
<th colspan="2">[oslo_middleware]</th>
</tr>
<tr>
<td><option>max_request_body_size</option> = <replaceable>114688</replaceable></td>
<td>(IntOpt) The maximum body size for each request, in bytes.</td>
</tr>
<tr>
<td><option>secure_proxy_ssl_header</option> = <replaceable>X-Forwarded-Proto</replaceable></td>
<td>(StrOpt) The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by an SSL termination proxy.</td>
</tr>
<tr>
<th colspan="2">[oslo_policy]</th>
</tr>
<tr>
<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. Missing or empty directories are ignored.</td>
</tr>
<tr>
<td><option>policy_file</option> = <replaceable>policy.json</replaceable></td>
<td>(StrOpt) The JSON file that defines policies.</td>
</tr>
<tr>
<th colspan="2">[oslo_versionedobjects]</th>
</tr>
<tr>
<td><option>fatal_exception_format_errors</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Make exception message format errors fatal</td>
</tr>
</tbody>
</table>
</para>

44
doc/common/tables/cinder-auth.xml
View File

@ -1,44 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_auth">
<caption>Description of authorization 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>auth_strategy</option> = <replaceable>keystone</replaceable></td>
<td>(StrOpt) The strategy to use for auth. Supports noauth, keystone, and deprecated.</td>
</tr>
</tbody>
</table>
</para>

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

@ -1,188 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_auth_token">
<caption>Description of authorization token 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">[keystone_authtoken]</th>
</tr>
<tr>
<td><option>admin_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Service user password.</td>
</tr>
<tr>
<td><option>admin_tenant_name</option> = <replaceable>admin</replaceable></td>
<td>(StrOpt) Service tenant name.</td>
</tr>
<tr>
<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><option>admin_user</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Service username.</td>
</tr>
<tr>
<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><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><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><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><option>auth_section</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Config Section from which to load plugin specific options</td>
</tr>
<tr>
<td><option>auth_uri</option> = <replaceable>None</replaceable></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>
</tr>
<tr>
<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><option>certfile</option> = <replaceable>None</replaceable></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 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>
</tr>
<tr>
<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><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><option>http_connect_timeout</option> = <replaceable>None</replaceable></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>
<td>(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server.</td>
</tr>
<tr>
<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><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><option>insecure</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Verify HTTPS connections.</td>
</tr>
<tr>
<td><option>keyfile</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Required if identity server requires client certificate</td>
</tr>
<tr>
<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 memcached client connection from the pool.</td>
</tr>
<tr>
<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><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 memcached 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) memcached client pool. The advanced pool will only work under python 2.x.</td>
</tr>
<tr>
<td><option>region_name</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The region in which the identity server can be found.</td>
</tr>
<tr>
<td><option>revocation_cache_time</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.</td>
</tr>
<tr>
<td><option>signing_dir</option> = <replaceable>None</replaceable></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>
<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>
</table>
</para>

92
doc/common/tables/cinder-backups.xml
View File

@ -1,92 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_backups">
<caption>Description of backups 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>backup_api_class</option> = <replaceable>cinder.backup.api.API</replaceable></td>
<td>(StrOpt) The full class name of the volume backup API class</td>
</tr>
<tr>
<td><option>backup_compression_algorithm</option> = <replaceable>zlib</replaceable></td>
<td>(StrOpt) Compression algorithm (None to disable)</td>
</tr>
<tr>
<td><option>backup_driver</option> = <replaceable>cinder.backup.drivers.swift</replaceable></td>
<td>(StrOpt) Driver to use for backups.</td>
</tr>
<tr>
<td><option>backup_manager</option> = <replaceable>cinder.backup.manager.BackupManager</replaceable></td>
<td>(StrOpt) Full class name for the Manager for volume backup</td>
</tr>
<tr>
<td><option>backup_metadata_version</option> = <replaceable>2</replaceable></td>
<td>(IntOpt) Backup metadata version to be used when backing up volume metadata. If this number is bumped, make sure the service doing the restore supports the new version.</td>
</tr>
<tr>
<td><option>backup_name_template</option> = <replaceable>backup-%s</replaceable></td>
<td>(StrOpt) Template string to be used to generate backup names</td>
</tr>
<tr>
<td><option>backup_object_number_per_notification</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) The number of chunks or objects, for which one Ceilometer notification will be sent</td>
</tr>
<tr>
<td><option>backup_posix_path</option> = <replaceable>$state_path/backup</replaceable></td>
<td>(StrOpt) Path specifying where to store backups.</td>
</tr>
<tr>
<td><option>backup_service_inithost_offload</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Offload pending backup delete during backup service startup.</td>
</tr>
<tr>
<td><option>backup_timer_interval</option> = <replaceable>120</replaceable></td>
<td>(IntOpt) Interval, in seconds, between two progress notifications reporting the backup status</td>
</tr>
<tr>
<td><option>backup_topic</option> = <replaceable>cinder-backup</replaceable></td>
<td>(StrOpt) The topic that volume backup nodes listen on</td>
</tr>
<tr>
<td><option>snapshot_name_template</option> = <replaceable>snapshot-%s</replaceable></td>
<td>(StrOpt) Template string to be used to generate snapshot names</td>
</tr>
<tr>
<td><option>snapshot_same_host</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Create volume from snapshot at the host where snapshot resides</td>
</tr>
</tbody>
</table>
</para>

68
doc/common/tables/cinder-backups_ceph.xml
View File

@ -1,68 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_backups_ceph">
<caption>Description of Ceph backup 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>backup_ceph_chunk_size</option> = <replaceable>134217728</replaceable></td>
<td>(IntOpt) The chunk size, in bytes, that a backup is broken into before transfer to the Ceph object store.</td>
</tr>
<tr>
<td><option>backup_ceph_conf</option> = <replaceable>/etc/ceph/ceph.conf</replaceable></td>
<td>(StrOpt) Ceph configuration file to use.</td>
</tr>
<tr>
<td><option>backup_ceph_pool</option> = <replaceable>backups</replaceable></td>
<td>(StrOpt) The Ceph pool where volume backups are stored.</td>
</tr>
<tr>
<td><option>backup_ceph_stripe_count</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) RBD stripe count to use when creating a backup image.</td>
</tr>
<tr>
<td><option>backup_ceph_stripe_unit</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) RBD stripe unit to use when creating a backup image.</td>
</tr>
<tr>
<td><option>backup_ceph_user</option> = <replaceable>cinder</replaceable></td>
<td>(StrOpt) The Ceph user to connect with. Default here is to use the same user as for Cinder volumes. If not using cephx this should be set to None.</td>
</tr>
<tr>
<td><option>restore_discard_excess_bytes</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) If True, always discard excess bytes when restoring volumes i.e. pad with zeroes.</td>
</tr>
</tbody>
</table>
</para>

68
doc/common/tables/cinder-backups_nfs.xml
View File

@ -1,68 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_backups_nfs">
<caption>Description of NFS backup 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>backup_container</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Custom directory to use for backups.</td>
</tr>
<tr>
<td><option>backup_enable_progress_timer</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Enable or Disable the timer to send the periodic progress notifications to Ceilometer when backing up the volume to the backend storage. The default value is True to enable the timer.</td>
</tr>
<tr>
<td><option>backup_file_size</option> = <replaceable>1999994880</replaceable></td>
<td>(IntOpt) The maximum size in bytes of the files used to hold backups. If the volume being backed up exceeds this size, then it will be backed up into multiple files.backup_file_size must be a multiple of backup_sha_block_size_bytes.</td>
</tr>
<tr>
<td><option>backup_mount_options</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Mount options passed to the NFS client. See NFS man page for details.</td>
</tr>
<tr>
<td><option>backup_mount_point_base</option> = <replaceable>$state_path/backup_mount</replaceable></td>
<td>(StrOpt) Base dir containing mount point for NFS share.</td>
</tr>
<tr>
<td><option>backup_sha_block_size_bytes</option> = <replaceable>32768</replaceable></td>
<td>(IntOpt) The size in bytes that changes are tracked for incremental backups. backup_file_size has to be multiple of backup_sha_block_size_bytes.</td>
</tr>
<tr>
<td><option>backup_share</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) NFS share in hostname:path, ipv4addr:path, or "[ipv6addr]:path" format.</td>
</tr>
</tbody>
</table>
</para>

96
doc/common/tables/cinder-backups_swift.xml
View File

@ -1,96 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_backups_swift">
<caption>Description of Swift backup 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>backup_swift_auth</option> = <replaceable>per_user</replaceable></td>
<td>(StrOpt) Swift authentication mechanism</td>
</tr>
<tr>
<td><option>backup_swift_auth_version</option> = <replaceable>1</replaceable></td>
<td>(StrOpt) Swift authentication version. Specify "1" for auth 1.0, or "2" for auth 2.0</td>
</tr>
<tr>
<td><option>backup_swift_block_size</option> = <replaceable>32768</replaceable></td>
<td>(IntOpt) The size in bytes that changes are tracked for incremental backups. backup_swift_object_size has to be multiple of backup_swift_block_size.</td>
</tr>
<tr>
<td><option>backup_swift_ca_cert_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Location of the CA certificate file to use for swift client requests.</td>
</tr>
<tr>
<td><option>backup_swift_container</option> = <replaceable>volumebackups</replaceable></td>
<td>(StrOpt) The default Swift container to use</td>
</tr>
<tr>
<td><option>backup_swift_enable_progress_timer</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Enable or Disable the timer to send the periodic progress notifications to Ceilometer when backing up the volume to the Swift backend storage. The default value is True to enable the timer.</td>
</tr>
<tr>
<td><option>backup_swift_key</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Swift key for authentication</td>
</tr>
<tr>
<td><option>backup_swift_object_size</option> = <replaceable>52428800</replaceable></td>
<td>(IntOpt) The size in bytes of Swift backup objects</td>
</tr>
<tr>
<td><option>backup_swift_retry_attempts</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) The number of retries to make for Swift operations</td>
</tr>
<tr>
<td><option>backup_swift_retry_backoff</option> = <replaceable>2</replaceable></td>
<td>(IntOpt) The backoff time in seconds between Swift retries</td>
</tr>
<tr>
<td><option>backup_swift_tenant</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Swift tenant/account name. Required when connecting to an auth 2.0 system</td>
</tr>
<tr>
<td><option>backup_swift_url</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The URL of the Swift endpoint</td>
</tr>
<tr>
<td><option>backup_swift_user</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Swift user name</td>
</tr>
<tr>
<td><option>swift_catalog_info</option> = <replaceable>object-store:swift:publicURL</replaceable></td>
<td>(StrOpt) Info to match when looking for swift in the service catalog. Format is: separated values of the form: &lt;service_type&gt;:&lt;service_name&gt;:&lt;endpoint_type&gt; - Only used if backup_swift_url is unset</td>
</tr>
</tbody>
</table>
</para>

52
doc/common/tables/cinder-backups_tsm.xml
View File

@ -1,52 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_backups_tsm">
<caption>Description of IBM Tivoli Storage Manager backup 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>backup_tsm_compression</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Enable or Disable compression for backups</td>
</tr>
<tr>
<td><option>backup_tsm_password</option> = <replaceable>password</replaceable></td>
<td>(StrOpt) TSM password for the running username</td>
</tr>
<tr>
<td><option>backup_tsm_volume_prefix</option> = <replaceable>backup</replaceable></td>
<td>(StrOpt) Volume prefix for the backup id when backing up to TSM</td>
</tr>
</tbody>
</table>
</para>

44
doc/common/tables/cinder-block-device.xml
View File

@ -1,44 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_block-device">
<caption>Description of block device 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>available_devices</option> = <replaceable></replaceable></td>
<td>(ListOpt) List of all available devices</td>
</tr>
</tbody>
</table>
</para>

72
doc/common/tables/cinder-blockbridge.xml
View File

@ -1,72 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_blockbridge">
<caption>Description of BlockBridge EPS 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>blockbridge_api_host</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) IP address/hostname of Blockbridge API.</td>
</tr>
<tr>
<td><option>blockbridge_api_port</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) Override HTTPS port to connect to Blockbridge API server.</td>
</tr>
<tr>
<td><option>blockbridge_auth_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Blockbridge API password (for auth scheme 'password')</td>
</tr>
<tr>
<td><option>blockbridge_auth_scheme</option> = <replaceable>token</replaceable></td>
<td>(StrOpt) Blockbridge API authentication scheme (token or password)</td>
</tr>
<tr>
<td><option>blockbridge_auth_token</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Blockbridge API token (for auth scheme 'token')</td>
</tr>
<tr>
<td><option>blockbridge_auth_user</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Blockbridge API user (for auth scheme 'password')</td>
</tr>
<tr>
<td><option>blockbridge_default_pool</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Default pool name if unspecified.</td>
</tr>
<tr>
<td><option>blockbridge_pools</option> = <replaceable>{'OpenStack': '+openstack'}</replaceable></td>
<td>(DictOpt) Defines the set of exposed pools and their associated backend query strings</td>
</tr>
</tbody>
</table>
</para>

52
doc/common/tables/cinder-ca.xml
View File

@ -1,52 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_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">[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) Certificate file to use when starting the server securely</td>
</tr>
<tr>
<td><option>ssl_key_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Private key file to use when starting the server securely</td>
</tr>
</tbody>
</table>
</para>

80
doc/common/tables/cinder-cloudbyte.xml
View File

@ -1,80 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<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_auth_group</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) This corresponds to the discovery authentication group in CloudByte storage. Chap users are added to this group. Driver uses the first user found for this group. Default value is None.</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_confirm_volume_delete_retries</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) Will confirm a successful volume deletion in CloudByte storage by making this many number of attempts.</td>
</tr>
<tr>
<td><option>cb_confirm_volume_delete_retry_interval</option> = <replaceable>5</replaceable></td>
<td>(IntOpt) A retry value in seconds. Will be used by the driver to check if volume deletion 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>

279
doc/common/tables/cinder-common.xml
View File

@ -1,279 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_common">
<caption>Description of common 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>allow_availability_zone_fallback</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) If the requested Cinder availability zone is unavailable, fall back to the value of default_availability_zone, then storage_availability_zone, instead of failing.</td>
</tr>
<tr>
<td><option>chap_password</option> = <replaceable></replaceable></td>
<td>(StrOpt) Password for specified CHAP account name.</td>
</tr>
<tr>
<td><option>chap_username</option> = <replaceable></replaceable></td>
<td>(StrOpt) CHAP user name.</td>
</tr>
<tr>
<td><option>chiscsi_conf</option> = <replaceable>/etc/chelsio-iscsi/chiscsi.conf</replaceable></td>
<td>(StrOpt) Chiscsi (CXT) global defaults configuration file</td>
</tr>
<tr>
<td><option>cinder_internal_tenant_project_id</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) ID of the project which will be used as the Cinder internal tenant.</td>
</tr>
<tr>
<td><option>cinder_internal_tenant_user_id</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) ID of the user to be used in volume operations as the Cinder internal tenant.</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>compute_api_class</option> = <replaceable>cinder.compute.nova.API</replaceable></td>
<td>(StrOpt) The full class name of the compute API class to use</td>
</tr>
<tr>
<td><option>consistencygroup_api_class</option> = <replaceable>cinder.consistencygroup.api.API</replaceable></td>
<td>(StrOpt) The full class name of the consistencygroup API class</td>
</tr>
<tr>
<td><option>default_availability_zone</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Default availability zone for new volumes. If not set, the storage_availability_zone option value is used as the default for new volumes.</td>
</tr>
<tr>
<td><option>default_volume_type</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Default volume type to use</td>
</tr>
<tr>
<td><option>driver_data_namespace</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Namespace for driver private data values to be saved in.</td>
</tr>
<tr>
<td><option>driver_ssl_cert_verify</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) If set to True the http client will validate the SSL certificate of the backend endpoint.</td>
</tr>
<tr>
<td><option>enable_force_upload</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enables the Force option on upload_to_image. This enables running upload_volume on in-use volumes for backends that support it.</td>
</tr>
<tr>
<td><option>enable_new_services</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Services to be added to the available pool on create</td>
</tr>
<tr>
<td><option>end_time</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) If this option is specified then the end time specified is used instead of the end time of the last completed audit period.</td>
</tr>
<tr>
<td><option>enforce_multipath_for_image_xfer</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) If this is set to True, attachment of volumes for image transfer will be aborted when multipathd is not running. Otherwise, it will fallback to single path.</td>
</tr>
<tr>
<td><option>executor_thread_pool_size</option> = <replaceable>64</replaceable></td>
<td>(IntOpt) Size of executor thread pool.</td>
</tr>
<tr>
<td><option>host</option> = <replaceable>localhost</replaceable></td>
<td>(StrOpt) Name of this node. This can be an opaque identifier. It is not necessarily a host name, FQDN, or IP address.</td>
</tr>
<tr>
<td><option>iet_conf</option> = <replaceable>/etc/iet/ietd.conf</replaceable></td>
<td>(StrOpt) IET configuration file</td>
</tr>
<tr>
<td><option>iscsi_secondary_ip_addresses</option> = <replaceable></replaceable></td>
<td>(ListOpt) The list of secondary IP addresses of the iSCSI daemon</td>
</tr>
<tr>
<td><option>managed_replication_target</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) There are two types of target configurations managed (replicate to another configured backend) or unmanaged (replicate to a device not managed by Cinder).</td>
</tr>
<tr>
<td><option>max_over_subscription_ratio</option> = <replaceable>20.0</replaceable></td>
<td>(FloatOpt) Float representation of the over subscription ratio when thin provisioning is involved. Default ratio is 20.0, meaning provisioned capacity can be 20 times of the total physical capacity. If the ratio is 10.5, it means provisioned capacity can be 10.5 times of the total physical capacity. A ratio of 1.0 means provisioned capacity cannot exceed the total physical capacity. A ratio lower than 1.0 will be ignored and the default value will be used instead.</td>
</tr>
<tr>
<td><option>memcached_servers</option> = <replaceable>None</replaceable></td>
<td>(ListOpt) Memcached servers or None for in process cache.</td>
</tr>
<tr>
<td><option>monkey_patch</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enable monkey patching</td>
</tr>
<tr>
<td><option>monkey_patch_modules</option> = <replaceable></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><option>no_snapshot_gb_quota</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Whether snapshots count against gigabyte quota</td>
</tr>
<tr>
<td><option>num_shell_tries</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) Number of times to attempt to run flakey shell commands</td>
</tr>
<tr>
<td><option>os_privileged_user_auth_url</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Auth URL associated with the OpenStack privileged account.</td>
</tr>
<tr>
<td><option>os_privileged_user_name</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) OpenStack privileged account username. Used for requests to other services (such as Nova) that require an account with special rights.</td>
</tr>
<tr>
<td><option>os_privileged_user_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Password associated with the OpenStack privileged account.</td>
</tr>
<tr>
<td><option>os_privileged_user_tenant</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Tenant name associated with the OpenStack privileged account.</td>
</tr>
<tr>
<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><option>periodic_interval</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Interval, in seconds, between running periodic tasks</td>
</tr>
<tr>
<td><option>replication_api_class</option> = <replaceable>cinder.replication.api.API</replaceable></td>
<td>(StrOpt) The full class name of the volume replication API class</td>
</tr>
<tr>
<td><option>replication_devices</option> = <replaceable>None</replaceable></td>
<td>(ListOpt) List of k/v pairs representing a replication target for this backend device. For unmanaged the format is: {'key-1'='val1' 'key-2'='val2'...},{...} and for managed devices its simply a list of valid configured backend_names that the driver supports replicating to: backend-a,bakcend-b...</td>
</tr>
<tr>
<td><option>report_interval</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Interval, in seconds, between nodes reporting state to datastore</td>
</tr>
<tr>
<td><option>request_timeout</option> = <replaceable>300</replaceable></td>
<td>(IntOpt) Global backend request timeout, in seconds</td>
</tr>
<tr>
<td><option>reserved_percentage</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) The percentage of backend capacity is reserved</td>
</tr>
<tr>
<td><option>rootwrap_config</option> = <replaceable>/etc/cinder/rootwrap.conf</replaceable></td>
<td>(StrOpt) Path to the rootwrap configuration file to use for running commands as root</td>
</tr>
<tr>
<td><option>send_actions</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Send the volume and snapshot create and delete notifications generated in the specified period.</td>
</tr>
<tr>
<td><option>service_down_time</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Maximum time since last check-in for a service to be considered up</td>
</tr>
<tr>
<td><option>sqlite_clean_db</option> = <replaceable>clean.sqlite</replaceable></td>
<td>(StrOpt) File name of clean sqlite db</td>
</tr>
<tr>
<td><option>ssh_hosts_key_file</option> = <replaceable>$state_path/ssh_known_hosts</replaceable></td>
<td>(StrOpt) File containing SSH host keys for the systems with which Cinder needs to communicate. OPTIONAL: Default=$state_path/ssh_known_hosts</td>
</tr>
<tr>
<td><option>start_time</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) If this option is specified then the start time specified is used instead of the start time of the last completed audit period.</td>
</tr>
<tr>
<td><option>state_path</option> = <replaceable>/var/lib/cinder</replaceable></td>
<td>(StrOpt) Top-level directory for maintaining cinder's state</td>
</tr>
<tr>
<td><option>storage_availability_zone</option> = <replaceable>nova</replaceable></td>
<td>(StrOpt) Availability zone of this node</td>
</tr>
<tr>
<td><option>strict_ssh_host_key_policy</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Option to enable strict host key checking. When set to "True" Cinder will only connect to systems with a host key present in the configured "ssh_hosts_key_file". When set to "False" the host key will be saved upon first connection and used for subsequent connections. Default=False</td>
</tr>
<tr>
<td><option>tcp_keepalive</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Sets the value of TCP_KEEPALIVE (True/False) for each server socket.</td>
</tr>
<tr>
<td><option>tcp_keepalive_count</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) Sets the value of TCP_KEEPCNT for each server socket. Not supported on OS X.</td>
</tr>
<tr>
<td><option>tcp_keepalive_interval</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) Sets the value of TCP_KEEPINTVL in seconds for each server socket. Not supported on OS X.</td>
</tr>
<tr>
<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>until_refresh</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) Count of reservations until usage is refreshed</td>
</tr>
<tr>
<td><option>use_chap_auth</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Option to enable/disable CHAP authentication for targets.</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>
<td><option>watch_log_file</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) (Optional) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log-file option is specified and Linux platform is used. This option is ignored if log_config_append is set.</td>
</tr>
<tr>
<td><option>wsgi_keep_alive</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) If False, closes the client socket connection explicitly. Setting it to True to maintain backward compatibility. Recommended setting is set it to False.</td>
</tr>
<tr>
<th colspan="2">[keystone_authtoken]</th>
</tr>
<tr>
<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>
</table>
</para>

68
doc/common/tables/cinder-compute.xml
View File

@ -1,68 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_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>nova_api_insecure</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Allow to perform insecure SSL requests to nova</td>
</tr>
<tr>
<td><option>nova_ca_certificates_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Location of ca certificates file to use for nova client requests.</td>
</tr>
<tr>
<td><option>nova_catalog_admin_info</option> = <replaceable>compute:Compute Service:adminURL</replaceable></td>
<td>(StrOpt) Same as nova_catalog_info, but for admin endpoint.</td>
</tr>
<tr>
<td><option>nova_catalog_info</option> = <replaceable>compute:Compute Service:publicURL</replaceable></td>
<td>(StrOpt) Match this value when searching for nova in the service catalog. Format is: separated values of the form: &lt;service_type&gt;:&lt;service_name&gt;:&lt;endpoint_type&gt;</td>
</tr>
<tr>
<td><option>nova_endpoint_admin_template</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Same as nova_endpoint_template, but for admin endpoint.</td>
</tr>
<tr>
<td><option>nova_endpoint_template</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Override service catalog lookup with template for nova endpoint e.g. http://localhost:8774/v2/%(project_id)s</td>
</tr>
<tr>
<td><option>os_region_name</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Region name of this node</td>
</tr>
</tbody>
</table>
</para>

91
doc/common/tables/cinder-cors.xml
View File

@ -1,91 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_cors">
<caption>Description of CORS 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">[cors]</th>
</tr>
<tr>
<td><option>allow_credentials</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Indicate that the actual request can include user credentials</td>
</tr>
<tr>
<td><option>allow_headers</option> = <replaceable>Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma</replaceable></td>
<td>(ListOpt) Indicate which header field names may be used during the actual request.</td>
</tr>
<tr>
<td><option>allow_methods</option> = <replaceable>GET, POST, PUT, DELETE, OPTIONS</replaceable></td>
<td>(ListOpt) Indicate which methods can be used during the actual request.</td>
</tr>
<tr>
<td><option>allowed_origin</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header.</td>
</tr>
<tr>
<td><option>expose_headers</option> = <replaceable>Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma</replaceable></td>
<td>(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.</td>
</tr>
<tr>
<td><option>max_age</option> = <replaceable>3600</replaceable></td>
<td>(IntOpt) Maximum cache age of CORS preflight requests.</td>
</tr>
<tr>
<th colspan="2">[cors.subdomain]</th>
</tr>
<tr>
<td><option>allow_credentials</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Indicate that the actual request can include user credentials</td>
</tr>
<tr>
<td><option>allow_headers</option> = <replaceable>Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma</replaceable></td>
<td>(ListOpt) Indicate which header field names may be used during the actual request.</td>
</tr>
<tr>
<td><option>allow_methods</option> = <replaceable>GET, POST, PUT, DELETE, OPTIONS</replaceable></td>
<td>(ListOpt) Indicate which methods can be used during the actual request.</td>
</tr>
<tr>
<td><option>allowed_origin</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header.</td>
</tr>
<tr>
<td><option>expose_headers</option> = <replaceable>Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma</replaceable></td>
<td>(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.</td>
</tr>
<tr>
<td><option>max_age</option> = <replaceable>3600</replaceable></td>
<td>(IntOpt) Maximum cache age of CORS preflight requests.</td>
</tr>
</tbody>
</table>
</para>

131
doc/common/tables/cinder-database.xml
View File

@ -1,131 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_database">
<caption>Description of database configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>db_driver</option> = <replaceable>cinder.db</replaceable></td>
<td>(StrOpt) Driver to use for database access</td>
</tr>
<tr>
<th colspan="2">[database]</th>
</tr>
<tr>
<td><option>backend</option> = <replaceable>sqlalchemy</replaceable></td>
<td>(StrOpt) The back end to use for the database.</td>
</tr>
<tr>
<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><option>connection_debug</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything.</td>
</tr>
<tr>
<td><option>connection_trace</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Add Python stack traces to SQL as comment strings.</td>
</tr>
<tr>
<td><option>db_inc_retry_interval</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) If True, increases the interval between retries of a database operation up to db_max_retry_interval.</td>
</tr>
<tr>
<td><option>db_max_retries</option> = <replaceable>20</replaceable></td>
<td>(IntOpt) Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count.</td>
</tr>
<tr>
<td><option>db_max_retry_interval</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation.</td>
</tr>
<tr>
<td><option>db_retry_interval</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Seconds between retries of a database transaction.</td>
</tr>
<tr>
<td><option>idle_timeout</option> = <replaceable>3600</replaceable></td>
<td>(IntOpt) Timeout before idle SQL connections are reaped.</td>
</tr>
<tr>
<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><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><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><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><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><option>pool_timeout</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) If set, use this value for pool_timeout with SQLAlchemy.</td>
</tr>
<tr>
<td><option>retry_interval</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Interval between retries of opening a SQL connection.</td>
</tr>
<tr>
<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><option>sqlite_db</option> = <replaceable>oslo.sqlite</replaceable></td>
<td>(StrOpt) The file name to use with SQLite.</td>
</tr>
<tr>
<td><option>sqlite_synchronous</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) If True, SQLite uses synchronous mode.</td>
</tr>
<tr>
<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>

64
doc/common/tables/cinder-datera.xml
View File

@ -1,64 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_datera">
<caption>Description of Datera 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>datera_api_port</option> = <replaceable>7717</replaceable></td>
<td>(StrOpt) Datera API port.</td>
</tr>
<tr>
<td><option>datera_api_token</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) DEPRECATED: This will be removed in the Liberty release. Use san_login and san_password instead. This directly sets the Datera API token.</td>
</tr>
<tr>
<td><option>datera_api_version</option> = <replaceable>1</replaceable></td>
<td>(StrOpt) Datera API version.</td>
</tr>
<tr>
<td><option>datera_num_replicas</option> = <replaceable>3</replaceable></td>
<td>(StrOpt) Number of replicas to create of an inode.</td>
</tr>
<tr>
<td><option>driver_client_cert</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The path to the client certificate for verification, if the driver supports it.</td>
</tr>
<tr>
<td><option>driver_client_cert_key</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The path to the client certificate key for verification, if the driver supports it.</td>
</tr>
</tbody>
</table>
</para>

44
doc/common/tables/cinder-debug.xml
View File

@ -1,44 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_debug">
<caption>Description of logging 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>trace_flags</option> = <replaceable>None</replaceable></td>
<td>(ListOpt) List of options that control which trace info is written to the DEBUG log level to assist developers. Valid values are method and api.</td>
</tr>
</tbody>
</table>
</para>

60
doc/common/tables/cinder-dellsc.xml
View File

@ -1,60 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_dellsc">
<caption>Description of Dell Storage Center 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>dell_sc_api_port</option> = <replaceable>3033</replaceable></td>
<td>(IntOpt) Dell API port</td>
</tr>
<tr>
<td><option>dell_sc_server_folder</option> = <replaceable>openstack</replaceable></td>
<td>(StrOpt) Name of the server folder to use on the Storage Center</td>
</tr>
<tr>
<td><option>dell_sc_ssn</option> = <replaceable>64702</replaceable></td>
<td>(IntOpt) Storage Center System Serial Number</td>
</tr>
<tr>
<td><option>dell_sc_verify_cert</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enable HTTPS SC certificate verification.</td>
</tr>
<tr>
<td><option>dell_sc_volume_folder</option> = <replaceable>openstack</replaceable></td>
<td>(StrOpt) Name of the volume folder to use on the Storage Center</td>
</tr>
</tbody>
</table>
</para>

64
doc/common/tables/cinder-dothill.xml
View File

@ -1,64 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_dothill">
<caption>Description of Dot Hill 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>dothill_api_protocol</option> = <replaceable>https</replaceable></td>
<td>(StrOpt) DotHill API interface protocol.</td>
</tr>
<tr>
<td><option>dothill_backend_name</option> = <replaceable>A</replaceable></td>
<td>(StrOpt) Pool or Vdisk name to use for volume creation.</td>
</tr>
<tr>
<td><option>dothill_backend_type</option> = <replaceable>virtual</replaceable></td>
<td>(StrOpt) linear (for Vdisk) or virtual (for Pool).</td>
</tr>
<tr>
<td><option>dothill_iscsi_ips</option> = <replaceable></replaceable></td>
<td>(ListOpt) List of comma-separated target iSCSI IP addresses.</td>
</tr>
<tr>
<td><option>dothill_verify_certificate</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Whether to verify DotHill array SSL certificate.</td>
</tr>
<tr>
<td><option>dothill_verify_certificate_path</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) DotHill array SSL certificate path.</td>
</tr>
</tbody>
</table>
</para>

44
doc/common/tables/cinder-drbd.xml
View File

@ -1,44 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<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>

104
doc/common/tables/cinder-emc.xml
View File

@ -1,104 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_emc">
<caption>Description of EMC 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>check_max_pool_luns_threshold</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Report free_capacity_gb as 0 when the limit to maximum number of pool LUNs is reached. By default, the value is False.</td>
</tr>
<tr>
<td><option>cinder_emc_config_file</option> = <replaceable>/etc/cinder/cinder_emc_config.xml</replaceable></td>
<td>(StrOpt) use this file for cinder emc plugin config data</td>
</tr>
<tr>
<td><option>destroy_empty_storage_group</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) To destroy storage group when the last LUN is removed from it. By default, the value is False.</td>
</tr>
<tr>
<td><option>force_delete_lun_in_storagegroup</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Delete a LUN even if it is in Storage Groups.</td>
</tr>
<tr>
<td><option>initiator_auto_deregistration</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Automatically deregister initiators after the related storage group is destroyed. By default, the value is False.</td>
</tr>
<tr>
<td><option>initiator_auto_registration</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Automatically register initiators. By default, the value is False.</td>
</tr>
<tr>
<td><option>io_port_list</option> = <replaceable>*</replaceable></td>
<td>(StrOpt) Comma separated iSCSI or FC ports to be used in Nova or Cinder.</td>
</tr>
<tr>
<td><option>iscsi_initiators</option> = <replaceable></replaceable></td>
<td>(StrOpt) Mapping between hostname and its iSCSI initiator IP addresses.</td>
</tr>
<tr>
<td><option>max_luns_per_storage_group</option> = <replaceable>255</replaceable></td>
<td>(IntOpt) Default max number of LUNs in a storage group. By default, the value is 255.</td>
</tr>
<tr>
<td><option>naviseccli_path</option> = <replaceable></replaceable></td>
<td>(StrOpt) Naviseccli Path.</td>
</tr>
<tr>
<td><option>storage_vnx_authentication_type</option> = <replaceable>global</replaceable></td>
<td>(StrOpt) VNX authentication scope type.</td>
</tr>
<tr>
<td><option>storage_vnx_pool_names</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Comma-separated list of storage pool names to be used.</td>
</tr>
<tr>
<td><option>storage_vnx_security_file_dir</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Directory path that contains the VNX security file. Make sure the security file is generated first.</td>
</tr>
<tr>
<td><option>xtremio_array_busy_retry_count</option> = <replaceable>5</replaceable></td>
<td>(IntOpt) Number of retries in case array is busy</td>
</tr>
<tr>
<td><option>xtremio_array_busy_retry_interval</option> = <replaceable>5</replaceable></td>
<td>(IntOpt) Interval between retries in case array is busy</td>
</tr>
<tr>
<td><option>xtremio_cluster_name</option> = <replaceable></replaceable></td>
<td>(StrOpt) XMS cluster id in multi-cluster environment</td>
</tr>
</tbody>
</table>
</para>

84
doc/common/tables/cinder-emc_sio.xml
View File

@ -1,84 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_emc_sio">
<caption>Description of EMC SIO 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>sio_force_delete</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Whether to allow force delete.</td>
</tr>
<tr>
<td><option>sio_protection_domain_id</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Protection domain id.</td>
</tr>
<tr>
<td><option>sio_protection_domain_name</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Protection domain name.</td>
</tr>
<tr>
<td><option>sio_rest_server_port</option> = <replaceable>443</replaceable></td>
<td>(StrOpt) REST server port.</td>
</tr>
<tr>
<td><option>sio_round_volume_capacity</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Whether to round volume capacity.</td>
</tr>
<tr>
<td><option>sio_server_certificate_path</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Server certificate path.</td>
</tr>
<tr>
<td><option>sio_storage_pool_id</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Storage pool id.</td>
</tr>
<tr>
<td><option>sio_storage_pool_name</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Storage pool name.</td>
</tr>
<tr>
<td><option>sio_storage_pools</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Storage pools.</td>
</tr>
<tr>
<td><option>sio_unmap_volume_before_deletion</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Whether to unmap volume before deletion.</td>
</tr>
<tr>
<td><option>sio_verify_server_certificate</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Whether to verify server certificate.</td>
</tr>
</tbody>
</table>
</para>

68
doc/common/tables/cinder-eqlx.xml
View File

@ -1,68 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_eqlx">
<caption>Description of Dell EqualLogic 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>eqlx_chap_login</option> = <replaceable>admin</replaceable></td>
<td>(StrOpt) Existing CHAP account name. Note that this option is deprecated in favour of "chap_username" as specified in cinder/volume/driver.py and will be removed in next release.</td>
</tr>
<tr>
<td><option>eqlx_chap_password</option> = <replaceable>password</replaceable></td>
<td>(StrOpt) Password for specified CHAP account name. Note that this option is deprecated in favour of "chap_password" as specified in cinder/volume/driver.py and will be removed in the next release</td>
</tr>
<tr>
<td><option>eqlx_cli_max_retries</option> = <replaceable>5</replaceable></td>
<td>(IntOpt) Maximum retry count for reconnection. Default is 5.</td>
</tr>
<tr>
<td><option>eqlx_cli_timeout</option> = <replaceable>30</replaceable></td>
<td>(IntOpt) Timeout for the Group Manager cli command execution. Default is 30. Note that this option is deprecated in favour of "ssh_conn_timeout" as specified in cinder/volume/drivers/san/san.py and will be removed in M release.</td>
</tr>
<tr>
<td><option>eqlx_group_name</option> = <replaceable>group-0</replaceable></td>
<td>(StrOpt) Group name to use for creating volumes. Defaults to "group-0".</td>
</tr>
<tr>
<td><option>eqlx_pool</option> = <replaceable>default</replaceable></td>
<td>(StrOpt) Pool in which volumes will be created. Defaults to "default".</td>
</tr>
<tr>
<td><option>eqlx_use_chap</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Use CHAP authentication for targets. Note that this option is deprecated in favour of "use_chap_auth" as specified in cinder/volume/driver.py and will be removed in next release.</td>
</tr>
</tbody>
</table>
</para>

56
doc/common/tables/cinder-flashsystem.xml
View File

@ -1,56 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_flashsystem">
<caption>Description of IBM FlashSystem 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>flashsystem_connection_protocol</option> = <replaceable>FC</replaceable></td>
<td>(StrOpt) Connection protocol should be FC. (Default is FC.)</td>
</tr>
<tr>
<td><option>flashsystem_iscsi_portid</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) Default iSCSI Port ID of FlashSystem. (Default port is 0.)</td>
</tr>
<tr>
<td><option>flashsystem_multihostmap_enabled</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Allows vdisk to multi host mapping. (Default is True)</td>
</tr>
<tr>
<td><option>flashsystem_multipath_enabled</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Connect with multipath (FC only).(Default is false.)</td>
</tr>
</tbody>
</table>
</para>

48
doc/common/tables/cinder-hds-hnas.xml
View File

@ -1,48 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_hds-hnas">
<caption>Description of HDS HNAS iSCSI and NFS 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>hds_hnas_iscsi_config_file</option> = <replaceable>/opt/hds/hnas/cinder_iscsi_conf.xml</replaceable></td>
<td>(StrOpt) Configuration file for HDS iSCSI cinder plugin</td>
</tr>
<tr>
<td><option>hds_hnas_nfs_config_file</option> = <replaceable>/opt/hds/hnas/cinder_nfs_conf.xml</replaceable></td>
<td>(StrOpt) Configuration file for HDS NFS cinder plugin</td>
</tr>
</tbody>
</table>
</para>

64
doc/common/tables/cinder-hgst.xml
View File

@ -1,64 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_hgst">
<caption>Description of HGST 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>hgst_net</option> = <replaceable>Net 1 (IPv4)</replaceable></td>
<td>(StrOpt) Space network name to use for data transfer</td>
</tr>
<tr>
<td><option>hgst_redundancy</option> = <replaceable>0</replaceable></td>
<td>(StrOpt) Should spaces be redundantly stored (1/0)</td>
</tr>
<tr>
<td><option>hgst_space_group</option> = <replaceable>disk</replaceable></td>
<td>(StrOpt) Group to own created spaces</td>
</tr>
<tr>
<td><option>hgst_space_mode</option> = <replaceable>0600</replaceable></td>
<td>(StrOpt) UNIX mode for created spaces</td>
</tr>
<tr>
<td><option>hgst_space_user</option> = <replaceable>root</replaceable></td>
<td>(StrOpt) User to own created spaces</td>
</tr>
<tr>
<td><option>hgst_storage_servers</option> = <replaceable>os:gbd0</replaceable></td>
<td>(StrOpt) Comma separated list of Space storage servers:devices. ex: os1_stor:gbd0,os2_stor:gbd0</td>
</tr>
</tbody>
</table>
</para>

128
doc/common/tables/cinder-hitachi-hbsd.xml
View File

@ -1,128 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_hitachi-hbsd">
<caption>Description of Hitachi storage 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>hitachi_add_chap_user</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Add CHAP user</td>
</tr>
<tr>
<td><option>hitachi_async_copy_check_interval</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Interval to check copy asynchronously</td>
</tr>
<tr>
<td><option>hitachi_auth_method</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) iSCSI authentication method</td>
</tr>
<tr>
<td><option>hitachi_auth_password</option> = <replaceable>HBSD-CHAP-password</replaceable></td>
<td>(StrOpt) iSCSI authentication password</td>
</tr>
<tr>
<td><option>hitachi_auth_user</option> = <replaceable>HBSD-CHAP-user</replaceable></td>
<td>(StrOpt) iSCSI authentication username</td>
</tr>
<tr>
<td><option>hitachi_copy_check_interval</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) Interval to check copy</td>
</tr>
<tr>
<td><option>hitachi_copy_speed</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) Copy speed of storage system</td>
</tr>
<tr>
<td><option>hitachi_default_copy_method</option> = <replaceable>FULL</replaceable></td>
<td>(StrOpt) Default copy method of storage system</td>
</tr>
<tr>
<td><option>hitachi_group_range</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Range of group number</td>
</tr>
<tr>
<td><option>hitachi_group_request</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Request for creating HostGroup or iSCSI Target</td>
</tr>
<tr>
<td><option>hitachi_horcm_add_conf</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Add to HORCM configuration</td>
</tr>
<tr>
<td><option>hitachi_horcm_numbers</option> = <replaceable>200,201</replaceable></td>
<td>(StrOpt) Instance numbers for HORCM</td>
</tr>
<tr>
<td><option>hitachi_horcm_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Password of storage system for HORCM</td>
</tr>
<tr>
<td><option>hitachi_horcm_resource_lock_timeout</option> = <replaceable>600</replaceable></td>
<td>(IntOpt) Timeout until a resource lock is released, in seconds. The value must be between 0 and 7200.</td>
</tr>
<tr>
<td><option>hitachi_horcm_user</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Username of storage system for HORCM</td>
</tr>
<tr>
<td><option>hitachi_ldev_range</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Range of logical device of storage system</td>
</tr>
<tr>
<td><option>hitachi_pool_id</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) Pool ID of storage system</td>
</tr>
<tr>
<td><option>hitachi_serial_number</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Serial number of storage system</td>
</tr>
<tr>
<td><option>hitachi_target_ports</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Control port names for HostGroup or iSCSI Target</td>
</tr>
<tr>
<td><option>hitachi_thin_pool_id</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) Thin pool ID of storage system</td>
</tr>
<tr>
<td><option>hitachi_unit_name</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Name of an array unit</td>
</tr>
<tr>
<td><option>hitachi_zoning_request</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Request for FC Zone creating HostGroup</td>
</tr>
</tbody>
</table>
</para>

80
doc/common/tables/cinder-hpe3par.xml
View File

@ -1,80 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_hpe3par">
<caption>Description of HPE 3PAR Fibre Channel and iSCSI drivers 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>hpe3par_api_url</option> = <replaceable></replaceable></td>
<td>(StrOpt) 3PAR WSAPI Server Url like https://&lt;3par ip&gt;:8080/api/v1</td>
</tr>
<tr>
<td><option>hpe3par_cpg</option> = <replaceable>OpenStack</replaceable></td>
<td>(ListOpt) List of the CPG(s) to use for volume creation</td>
</tr>
<tr>
<td><option>hpe3par_cpg_snap</option> = <replaceable></replaceable></td>
<td>(StrOpt) The CPG to use for Snapshots for volumes. If empty the userCPG will be used.</td>
</tr>
<tr>
<td><option>hpe3par_debug</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enable HTTP debugging to 3PAR</td>
</tr>
<tr>
<td><option>hpe3par_iscsi_chap_enabled</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enable CHAP authentication for iSCSI connections.</td>
</tr>
<tr>
<td><option>hpe3par_iscsi_ips</option> = <replaceable></replaceable></td>
<td>(ListOpt) List of target iSCSI addresses to use.</td>
</tr>
<tr>
<td><option>hpe3par_password</option> = <replaceable></replaceable></td>
<td>(StrOpt) 3PAR password for the user specified in hpe3par_username</td>
</tr>
<tr>
<td><option>hpe3par_snapshot_expiration</option> = <replaceable></replaceable></td>
<td>(StrOpt) The time in hours when a snapshot expires and is deleted. This must be larger than expiration</td>
</tr>
<tr>
<td><option>hpe3par_snapshot_retention</option> = <replaceable></replaceable></td>
<td>(StrOpt) The time in hours to retain a snapshot. You can't delete it before this expires.</td>
</tr>
<tr>
<td><option>hpe3par_username</option> = <replaceable></replaceable></td>
<td>(StrOpt) 3PAR username with the 'edit' role</td>
</tr>
</tbody>
</table>
</para>

64
doc/common/tables/cinder-hpelefthand.xml
View File

@ -1,64 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_hpelefthand">
<caption>Description of HPE LeftHand/StoreVirtual 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>hpelefthand_api_url</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) HPE LeftHand WSAPI Server Url like https://&lt;LeftHand ip&gt;:8081/lhos</td>
</tr>
<tr>
<td><option>hpelefthand_clustername</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) HPE LeftHand cluster name</td>
</tr>
<tr>
<td><option>hpelefthand_debug</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enable HTTP debugging to LeftHand</td>
</tr>
<tr>
<td><option>hpelefthand_iscsi_chap_enabled</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Configure CHAP authentication for iSCSI connections (Default: Disabled)</td>
</tr>
<tr>
<td><option>hpelefthand_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) HPE LeftHand Super user password</td>
</tr>
<tr>
<td><option>hpelefthand_username</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) HPE LeftHand Super user username</td>
</tr>
</tbody>
</table>
</para>

64
doc/common/tables/cinder-hpmsa.xml
View File

@ -1,64 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_hpmsa">
<caption>Description of HP MSA 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>hpmsa_api_protocol</option> = <replaceable>https</replaceable></td>
<td>(StrOpt) HPMSA API interface protocol.</td>
</tr>
<tr>
<td><option>hpmsa_backend_name</option> = <replaceable>A</replaceable></td>
<td>(StrOpt) Pool or Vdisk name to use for volume creation.</td>
</tr>
<tr>
<td><option>hpmsa_backend_type</option> = <replaceable>virtual</replaceable></td>
<td>(StrOpt) linear (for Vdisk) or virtual (for Pool).</td>
</tr>
<tr>
<td><option>hpmsa_iscsi_ips</option> = <replaceable></replaceable></td>
<td>(ListOpt) List of comma-separated target iSCSI IP addresses.</td>
</tr>
<tr>
<td><option>hpmsa_verify_certificate</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Whether to verify HPMSA array SSL certificate.</td>
</tr>
<tr>
<td><option>hpmsa_verify_certificate_path</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) HPMSA array SSL certificate path.</td>
</tr>
</tbody>
</table>
</para>

112
doc/common/tables/cinder-hpxp.xml
View File

@ -1,112 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_hpxp">
<caption>Description of HP XP 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>hpxp_async_copy_check_interval</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Interval to check copy asynchronously</td>
</tr>
<tr>
<td><option>hpxp_compute_target_ports</option> = <replaceable>None</replaceable></td>
<td>(ListOpt) Target port names of compute node for host group or iSCSI target</td>
</tr>
<tr>
<td><option>hpxp_copy_check_interval</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) Interval to check copy</td>
</tr>
<tr>
<td><option>hpxp_copy_speed</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) Copy speed of storage system</td>
</tr>
<tr>
<td><option>hpxp_default_copy_method</option> = <replaceable>FULL</replaceable></td>
<td>(StrOpt) Default copy method of storage system. There are two valid values: "FULL" specifies that a full copy; "THIN" specifies that a thin copy. Default value is "FULL"</td>
</tr>
<tr>
<td><option>hpxp_group_request</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Request for creating host group or iSCSI target</td>
</tr>
<tr>
<td><option>hpxp_horcm_add_conf</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Add to HORCM configuration</td>
</tr>
<tr>
<td><option>hpxp_horcm_name_only_discovery</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Only discover a specific name of host group or iSCSI target</td>
</tr>
<tr>
<td><option>hpxp_horcm_numbers</option> = <replaceable>200, 201</replaceable></td>
<td>(ListOpt) Instance numbers for HORCM</td>
</tr>
<tr>
<td><option>hpxp_horcm_resource_name</option> = <replaceable>meta_resource</replaceable></td>
<td>(StrOpt) Resource group name of storage system for HORCM</td>
</tr>
<tr>
<td><option>hpxp_horcm_user</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Username of storage system for HORCM</td>
</tr>
<tr>
<td><option>hpxp_ldev_range</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Logical device range of storage system</td>
</tr>
<tr>
<td><option>hpxp_pool</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Pool of storage system</td>
</tr>
<tr>
<td><option>hpxp_storage_cli</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Type of storage command line interface</td>
</tr>
<tr>
<td><option>hpxp_storage_id</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) ID of storage system</td>
</tr>
<tr>
<td><option>hpxp_target_ports</option> = <replaceable>None</replaceable></td>
<td>(ListOpt) Target port names for host group or iSCSI target</td>
</tr>
<tr>
<td><option>hpxp_thin_pool</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Thin pool of storage system</td>
</tr>
<tr>
<td><option>hpxp_zoning_request</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Request for FC Zone creating host group</td>
</tr>
</tbody>
</table>
</para>

44
doc/common/tables/cinder-huawei.xml
View File

@ -1,44 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_huawei">
<caption>Description of Huawei storage 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>cinder_huawei_conf_file</option> = <replaceable>/etc/cinder/cinder_huawei_conf.xml</replaceable></td>
<td>(StrOpt) The configuration file for the Cinder Huawei driver.</td>
</tr>
</tbody>
</table>
</para>

80
doc/common/tables/cinder-ibmnas.xml
View File

@ -1,80 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_ibmnas">
<caption>Description of IBM SONAS and Storwise V7000 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>ibmnas_platform_type</option> = <replaceable>v7ku</replaceable></td>
<td>(StrOpt) IBMNAS platform type to be used as backend storage; valid values are - v7ku : for using IBM Storwize V7000 Unified, sonas : for using IBM Scale Out NAS, gpfs-nas : for using NFS based IBM GPFS deployments.</td>
</tr>
<tr>
<td><option>nas_ip</option> = <replaceable></replaceable></td>
<td>(StrOpt) IP address or Hostname of NAS system.</td>
</tr>
<tr>
<td><option>nas_login</option> = <replaceable>admin</replaceable></td>
<td>(StrOpt) User name to connect to NAS system.</td>
</tr>
<tr>
<td><option>nas_mount_options</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Options used to mount the storage backend file system where Cinder volumes are stored.</td>
</tr>
<tr>
<td><option>nas_password</option> = <replaceable></replaceable></td>
<td>(StrOpt) Password to connect to NAS system.</td>
</tr>
<tr>
<td><option>nas_private_key</option> = <replaceable></replaceable></td>
<td>(StrOpt) Filename of private key to use for SSH authentication.</td>
</tr>
<tr>
<td><option>nas_secure_file_operations</option> = <replaceable>auto</replaceable></td>
<td>(StrOpt) Allow network-attached storage systems to operate in a secure environment where root level access is not permitted. If set to False, access is as the root user and insecure. If set to True, access is not as root. If set to auto, a check is done to determine if this is a new installation: True is used if so, otherwise False. Default is auto.</td>
</tr>
<tr>
<td><option>nas_secure_file_permissions</option> = <replaceable>auto</replaceable></td>
<td>(StrOpt) Set more secure file permissions on network-attached storage volume files to restrict broad other/world access. If set to False, volumes are created with open permissions. If set to True, volumes are created with permissions for the cinder user and group (660). If set to auto, a check is done to determine if this is a new installation: True is used if so, otherwise False. Default is auto.</td>
</tr>
<tr>
<td><option>nas_share_path</option> = <replaceable></replaceable></td>
<td>(StrOpt) Path to the share to use for storing Cinder volumes. For example: "/srv/export1" for an NFS server export available at 10.0.5.10:/srv/export1 .</td>
</tr>
<tr>
<td><option>nas_ssh_port</option> = <replaceable>22</replaceable></td>
<td>(IntOpt) SSH port to use to connect to NAS system.</td>
</tr>
</tbody>
</table>
</para>

112
doc/common/tables/cinder-images.xml
View File

@ -1,112 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_images">
<caption>Description of images 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>allowed_direct_url_schemes</option> = <replaceable></replaceable></td>
<td>(ListOpt) A list of url schemes that can be downloaded directly via the direct_url. Currently supported schemes: [file].</td>
</tr>
<tr>
<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><option>glance_api_servers</option> = <replaceable>$glance_host:$glance_port</replaceable></td>
<td>(ListOpt) A list of the glance API servers available to cinder ([hostname|ip]:port)</td>
</tr>
<tr>
<td><option>glance_api_ssl_compression</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enables or disables negotiation of SSL layer compression. In some cases disabling compression can improve data throughput, such as when high network bandwidth is available and you use compressed image formats like qcow2.</td>
</tr>
<tr>
<td><option>glance_api_version</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Version of the glance API to use</td>
</tr>
<tr>
<td><option>glance_ca_certificates_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Location of ca certificates file to use for glance client requests.</td>
</tr>
<tr>
<td><option>glance_core_properties</option> = <replaceable>checksum, container_format, disk_format, image_name, image_id, min_disk, min_ram, name, size</replaceable></td>
<td>(ListOpt) Default core properties of image</td>
</tr>
<tr>
<td><option>glance_host</option> = <replaceable>$my_ip</replaceable></td>
<td>(StrOpt) Default glance host name or IP</td>
</tr>
<tr>
<td><option>glance_num_retries</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) Number retries when downloading an image from glance</td>
</tr>
<tr>
<td><option>glance_port</option> = <replaceable>9292</replaceable></td>
<td>(IntOpt) Default glance port</td>
</tr>
<tr>
<td><option>glance_request_timeout</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) http/https timeout value for glance operations. If no value (None) is supplied here, the glanceclient default value is used.</td>
</tr>
<tr>
<td><option>image_conversion_dir</option> = <replaceable>$state_path/conversion</replaceable></td>
<td>(StrOpt) Directory used for temporary storage during image conversion</td>
</tr>
<tr>
<td><option>image_upload_use_cinder_backend</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) If set to True, upload-to-image in raw format will create a cloned volume and register its location to the image service, instead of uploading the volume content. The cinder backend and locations support must be enabled in the image service, and glance_api_version must be set to 2.</td>
</tr>
<tr>
<td><option>image_upload_use_internal_tenant</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) If set to True, the image volume created by upload-to-image will be placed in the internal tenant. Otherwise, the image volume is created in the current context's tenant.</td>
</tr>
<tr>
<td><option>image_volume_cache_enabled</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enable the image volume cache for this backend.</td>
</tr>
<tr>
<td><option>image_volume_cache_max_count</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) Max number of entries allowed in the image volume cache. 0 =&gt; unlimited.</td>
</tr>
<tr>
<td><option>image_volume_cache_max_size_gb</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) Max size of the image volume cache for this backend in GB. 0 =&gt; unlimited.</td>
</tr>
<tr>
<td><option>use_multipath_for_image_xfer</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Do we attach/detach volumes in cinder using multipath for volume to image and image to volume transfers?</td>
</tr>
</tbody>
</table>
</para>

72
doc/common/tables/cinder-infortrend.xml
View File

@ -1,72 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_infortrend">
<caption>Description of Infortrend 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>infortrend_cli_max_retries</option> = <replaceable>5</replaceable></td>
<td>(IntOpt) Maximum retry time for cli. Default is 5.</td>
</tr>
<tr>
<td><option>infortrend_cli_path</option> = <replaceable>/opt/bin/Infortrend/raidcmd_ESDS10.jar</replaceable></td>
<td>(StrOpt) The Infortrend CLI absolute path. By default, it is at /opt/bin/Infortrend/raidcmd_ESDS10.jar</td>
</tr>
<tr>
<td><option>infortrend_cli_timeout</option> = <replaceable>30</replaceable></td>
<td>(IntOpt) Default timeout for CLI copy operations in minutes. Support: migrate volume, create cloned volume and create volume from snapshot. By Default, it is 30 minutes.</td>
</tr>
<tr>
<td><option>infortrend_pools_name</option> = <replaceable></replaceable></td>
<td>(StrOpt) Infortrend raid pool name list. It is separated with comma.</td>
</tr>
<tr>
<td><option>infortrend_provisioning</option> = <replaceable>full</replaceable></td>
<td>(StrOpt) Let the volume use specific provisioning. By default, it is the full provisioning. The supported options are full or thin.</td>
</tr>
<tr>
<td><option>infortrend_slots_a_channels_id</option> = <replaceable>0,1,2,3,4,5,6,7</replaceable></td>
<td>(StrOpt) Infortrend raid channel ID list on Slot A for OpenStack usage. It is separated with comma. By default, it is the channel 0~7.</td>
</tr>
<tr>
<td><option>infortrend_slots_b_channels_id</option> = <replaceable>0,1,2,3,4,5,6,7</replaceable></td>
<td>(StrOpt) Infortrend raid channel ID list on Slot B for OpenStack usage. It is separated with comma. By default, it is the channel 0~7.</td>
</tr>
<tr>
<td><option>infortrend_tiering</option> = <replaceable>0</replaceable></td>
<td>(StrOpt) Let the volume use specific tiering level. By default, it is the level 0. The supported levels are 0,2,3,4.</td>
</tr>
</tbody>
</table>
</para>

56
doc/common/tables/cinder-keymgr.xml
View File

@ -1,56 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_keymgr">
<caption>Description of key manager 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">[keymgr]</th>
</tr>
<tr>
<td><option>api_class</option> = <replaceable>cinder.keymgr.conf_key_mgr.ConfKeyManager</replaceable></td>
<td>(StrOpt) The full class name of the key manager API class</td>
</tr>
<tr>
<td><option>encryption_api_url</option> = <replaceable>http://localhost:9311/v1</replaceable></td>
<td>(StrOpt) Url for encryption service.</td>
</tr>
<tr>
<td><option>encryption_auth_url</option> = <replaceable>http://localhost:5000/v3</replaceable></td>
<td>(StrOpt) Authentication url for encryption service.</td>
</tr>
<tr>
<td><option>fixed_key</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Fixed key returned by key manager, specified in hex</td>
</tr>
</tbody>
</table>
</para>

64
doc/common/tables/cinder-lenovo.xml
View File

@ -1,64 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_lenovo">
<caption>Description of Lenovo 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>lenovo_api_protocol</option> = <replaceable>https</replaceable></td>
<td>(StrOpt) Lenovo api interface protocol.</td>
</tr>
<tr>
<td><option>lenovo_backend_name</option> = <replaceable>A</replaceable></td>
<td>(StrOpt) Pool or Vdisk name to use for volume creation.</td>
</tr>
<tr>
<td><option>lenovo_backend_type</option> = <replaceable>virtual</replaceable></td>
<td>(StrOpt) linear (for VDisk) or virtual (for Pool).</td>
</tr>
<tr>
<td><option>lenovo_iscsi_ips</option> = <replaceable></replaceable></td>
<td>(ListOpt) List of comma-separated target iSCSI IP addresses.</td>
</tr>
<tr>
<td><option>lenovo_verify_certificate</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Whether to verify Lenovo array SSL certificate.</td>
</tr>
<tr>
<td><option>lenovo_verify_certificate_path</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Lenovo array SSL certificate path.</td>
</tr>
</tbody>
</table>
</para>

124
doc/common/tables/cinder-logging.xml
View File

@ -1,124 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_logging">
<caption>Description of logging 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>debug</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default INFO level).</td>
</tr>
<tr>
<td><option>default_log_levels</option> = <replaceable>amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN, taskflow=WARN</replaceable></td>
<td>(ListOpt) List of logger=LEVEL pairs. This option is ignored if log_config_append is set.</td>
</tr>
<tr>
<td><option>fatal_deprecations</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enables or disables fatal status of deprecations.</td>
</tr>
<tr>
<td><option>fatal_exception_format_errors</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Make exception message format errors fatal.</td>
</tr>
<tr>
<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><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><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. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log_format).</td>
</tr>
<tr>
<td><option>log_date_format</option> = <replaceable>%Y-%m-%d %H:%M:%S</replaceable></td>
<td>(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set.</td>
</tr>
<tr>
<td><option>log_dir</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) (Optional) The base directory used for relative --log-file paths. This option is ignored if log_config_append is set.</td>
</tr>
<tr>
<td><option>log_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. This option is ignored if log_config_append is set.</td>
</tr>
<tr>
<td><option>log_format</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. This option is ignored if log_config_append is set.</td>
</tr>
<tr>
<td><option>logging_context_format_string</option> = <replaceable>%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s</replaceable></td>
<td>(StrOpt) Format string to use for log messages with context.</td>
</tr>
<tr>
<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><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><option>logging_exception_prefix</option> = <replaceable>%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s</replaceable></td>
<td>(StrOpt) Prefix each line of exception output with this format.</td>
</tr>
<tr>
<td><option>publish_errors</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enables or disables publication of error events.</td>
</tr>
<tr>
<td><option>syslog_log_facility</option> = <replaceable>LOG_USER</replaceable></td>
<td>(StrOpt) Syslog facility to receive log lines. This option is ignored if log_config_append is set.</td>
</tr>
<tr>
<td><option>use_stderr</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Log output to standard error. This option is ignored if log_config_append is set.</td>
</tr>
<tr>
<td><option>use_syslog</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set.</td>
</tr>
<tr>
<td><option>use_syslog_rfc_format</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in Kilo, and will be removed in Mitaka, along with this option. This option is ignored if log_config_append is set.</td>
</tr>
<tr>
<td><option>verbose</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) If set to false, will disable INFO logging level, making WARNING the default.</td>
</tr>
</tbody>
</table>
</para>

56
doc/common/tables/cinder-lvm.xml
View File

@ -1,56 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_lvm">
<caption>Description of LVM 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>lvm_conf_file</option> = <replaceable>/etc/cinder/lvm.conf</replaceable></td>
<td>(StrOpt) LVM conf file to use for the LVM driver in Cinder; this setting is ignored if the specified file does not exist (You can also specify 'None' to not use a conf file even if one exists).</td>
</tr>
<tr>
<td><option>lvm_mirrors</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) If &gt;0, create LVs with multiple mirrors. Note that this requires lvm_mirrors + 2 PVs with available space</td>
</tr>
<tr>
<td><option>lvm_type</option> = <replaceable>default</replaceable></td>
<td>(StrOpt) Type of LVM volumes to deploy; (default, thin, or auto). Auto defaults to thin if thin is supported.</td>
</tr>
<tr>
<td><option>volume_group</option> = <replaceable>cinder-volumes</replaceable></td>
<td>(StrOpt) Name for the VG that will contain exported volumes</td>
</tr>
</tbody>
</table>
</para>

84
doc/common/tables/cinder-netapp_7mode_iscsi.xml
View File

@ -1,84 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_netapp_7mode_iscsi">
<caption>Description of NetApp 7-Mode iSCSI 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>netapp_login</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Administrative user account name used to access the storage system or proxy server.</td>
</tr>
<tr>
<td><option>netapp_partner_backend_name</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The name of the config.conf stanza for a Data ONTAP (7-mode) HA partner. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode, and it is required if the storage protocol selected is FC.</td>
</tr>
<tr>
<td><option>netapp_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Password for the administrative user account specified in the netapp_login option.</td>
</tr>
<tr>
<td><option>netapp_pool_name_search_pattern</option> = <replaceable>(.+)</replaceable></td>
<td>(StrOpt) This option is used to restrict provisioning to the specified pools. Specify the value of this option to be a regular expression which will be applied to the names of objects from the storage backend which represent pools in Cinder. This option is only utilized when the storage protocol is configured to use iSCSI or FC.</td>
</tr>
<tr>
<td><option>netapp_server_hostname</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The hostname (or IP address) for the storage system or proxy server.</td>
</tr>
<tr>
<td><option>netapp_server_port</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) The TCP port to use for communication with the storage system or proxy server. If not specified, Data ONTAP drivers will use 80 for HTTP and 443 for HTTPS; E-Series will use 8080 for HTTP and 8443 for HTTPS.</td>
</tr>
<tr>
<td><option>netapp_size_multiplier</option> = <replaceable>1.2</replaceable></td>
<td>(FloatOpt) The quantity to be multiplied by the requested volume size to ensure enough space is available on the virtual storage server (Vserver) to fulfill the volume creation request. Note: this option is deprecated and will be removed in favor of "reserved_percentage" in the Mitaka release.</td>
</tr>
<tr>
<td><option>netapp_storage_family</option> = <replaceable>ontap_cluster</replaceable></td>
<td>(StrOpt) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series.</td>
</tr>
<tr>
<td><option>netapp_storage_protocol</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The storage protocol to be used on the data path with the storage system.</td>
</tr>
<tr>
<td><option>netapp_transport_type</option> = <replaceable>http</replaceable></td>
<td>(StrOpt) The transport protocol used when communicating with the storage system or proxy server.</td>
</tr>
<tr>
<td><option>netapp_vfiler</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The vFiler unit on which provisioning of block storage volumes will be done. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode. Only use this option when utilizing the MultiStore feature on the NetApp storage system.</td>
</tr>
</tbody>
</table>
</para>

92
doc/common/tables/cinder-netapp_7mode_nfs.xml
View File

@ -1,92 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_netapp_7mode_nfs">
<caption>Description of NetApp 7-Mode NFS 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>expiry_thres_minutes</option> = <replaceable>720</replaceable></td>
<td>(IntOpt) This option specifies the threshold for last access time for images in the NFS image cache. When a cache cleaning cycle begins, images in the cache that have not been accessed in the last M minutes, where M is the value of this parameter, will be deleted from the cache to create free space on the NFS share.</td>
</tr>
<tr>
<td><option>netapp_login</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Administrative user account name used to access the storage system or proxy server.</td>
</tr>
<tr>
<td><option>netapp_partner_backend_name</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The name of the config.conf stanza for a Data ONTAP (7-mode) HA partner. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode, and it is required if the storage protocol selected is FC.</td>
</tr>
<tr>
<td><option>netapp_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Password for the administrative user account specified in the netapp_login option.</td>
</tr>
<tr>
<td><option>netapp_pool_name_search_pattern</option> = <replaceable>(.+)</replaceable></td>
<td>(StrOpt) This option is used to restrict provisioning to the specified pools. Specify the value of this option to be a regular expression which will be applied to the names of objects from the storage backend which represent pools in Cinder. This option is only utilized when the storage protocol is configured to use iSCSI or FC.</td>
</tr>
<tr>
<td><option>netapp_server_hostname</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The hostname (or IP address) for the storage system or proxy server.</td>
</tr>
<tr>
<td><option>netapp_server_port</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) The TCP port to use for communication with the storage system or proxy server. If not specified, Data ONTAP drivers will use 80 for HTTP and 443 for HTTPS; E-Series will use 8080 for HTTP and 8443 for HTTPS.</td>
</tr>
<tr>
<td><option>netapp_storage_family</option> = <replaceable>ontap_cluster</replaceable></td>
<td>(StrOpt) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series.</td>
</tr>
<tr>
<td><option>netapp_storage_protocol</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The storage protocol to be used on the data path with the storage system.</td>
</tr>
<tr>
<td><option>netapp_transport_type</option> = <replaceable>http</replaceable></td>
<td>(StrOpt) The transport protocol used when communicating with the storage system or proxy server.</td>
</tr>
<tr>
<td><option>netapp_vfiler</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The vFiler unit on which provisioning of block storage volumes will be done. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode. Only use this option when utilizing the MultiStore feature on the NetApp storage system.</td>
</tr>
<tr>
<td><option>thres_avl_size_perc_start</option> = <replaceable>20</replaceable></td>
<td>(IntOpt) If the percentage of available space for an NFS share has dropped below the value specified by this option, the NFS image cache will be cleaned.</td>
</tr>
<tr>
<td><option>thres_avl_size_perc_stop</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) When the percentage of available space on an NFS share has reached the percentage specified by this option, the driver will stop clearing files from the NFS image cache that have not been accessed in the last M minutes, where M is the value of the expiry_thres_minutes configuration option.</td>
</tr>
</tbody>
</table>
</para>

92
doc/common/tables/cinder-netapp_cdot_iscsi.xml
View File

@ -1,92 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_netapp_cdot_iscsi">
<caption>Description of NetApp cDOT iSCSI 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>netapp_login</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Administrative user account name used to access the storage system or proxy server.</td>
</tr>
<tr>
<td><option>netapp_lun_ostype</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) This option defines the type of operating system that will access a LUN exported from Data ONTAP; it is assigned to the LUN at the time it is created.</td>
</tr>
<tr>
<td><option>netapp_lun_space_reservation</option> = <replaceable>enabled</replaceable></td>
<td>(StrOpt) This option determines if storage space is reserved for LUN allocation. If enabled, LUNs are thick provisioned. If space reservation is disabled, storage space is allocated on demand.</td>
</tr>
<tr>
<td><option>netapp_partner_backend_name</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The name of the config.conf stanza for a Data ONTAP (7-mode) HA partner. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode, and it is required if the storage protocol selected is FC.</td>
</tr>
<tr>
<td><option>netapp_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Password for the administrative user account specified in the netapp_login option.</td>
</tr>
<tr>
<td><option>netapp_pool_name_search_pattern</option> = <replaceable>(.+)</replaceable></td>
<td>(StrOpt) This option is used to restrict provisioning to the specified pools. Specify the value of this option to be a regular expression which will be applied to the names of objects from the storage backend which represent pools in Cinder. This option is only utilized when the storage protocol is configured to use iSCSI or FC.</td>
</tr>
<tr>
<td><option>netapp_server_hostname</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The hostname (or IP address) for the storage system or proxy server.</td>
</tr>
<tr>
<td><option>netapp_server_port</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) The TCP port to use for communication with the storage system or proxy server. If not specified, Data ONTAP drivers will use 80 for HTTP and 443 for HTTPS; E-Series will use 8080 for HTTP and 8443 for HTTPS.</td>
</tr>
<tr>
<td><option>netapp_size_multiplier</option> = <replaceable>1.2</replaceable></td>
<td>(FloatOpt) The quantity to be multiplied by the requested volume size to ensure enough space is available on the virtual storage server (Vserver) to fulfill the volume creation request. Note: this option is deprecated and will be removed in favor of "reserved_percentage" in the Mitaka release.</td>
</tr>
<tr>
<td><option>netapp_storage_family</option> = <replaceable>ontap_cluster</replaceable></td>
<td>(StrOpt) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series.</td>
</tr>
<tr>
<td><option>netapp_storage_protocol</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The storage protocol to be used on the data path with the storage system.</td>
</tr>
<tr>
<td><option>netapp_transport_type</option> = <replaceable>http</replaceable></td>
<td>(StrOpt) The transport protocol used when communicating with the storage system or proxy server.</td>
</tr>
<tr>
<td><option>netapp_vserver</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) This option specifies the virtual storage server (Vserver) name on the storage cluster on which provisioning of block storage volumes should occur.</td>
</tr>
</tbody>
</table>
</para>

108
doc/common/tables/cinder-netapp_cdot_nfs.xml
View File

@ -1,108 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_netapp_cdot_nfs">
<caption>Description of NetApp cDOT NFS 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>expiry_thres_minutes</option> = <replaceable>720</replaceable></td>
<td>(IntOpt) This option specifies the threshold for last access time for images in the NFS image cache. When a cache cleaning cycle begins, images in the cache that have not been accessed in the last M minutes, where M is the value of this parameter, will be deleted from the cache to create free space on the NFS share.</td>
</tr>
<tr>
<td><option>netapp_copyoffload_tool_path</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) This option specifies the path of the NetApp copy offload tool binary. Ensure that the binary has execute permissions set which allow the effective user of the cinder-volume process to execute the file.</td>
</tr>
<tr>
<td><option>netapp_host_type</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) This option defines the type of operating system for all initiators that can access a LUN. This information is used when mapping LUNs to individual hosts or groups of hosts.</td>
</tr>
<tr>
<td><option>netapp_host_type</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) This option defines the type of operating system for all initiators that can access a LUN. This information is used when mapping LUNs to individual hosts or groups of hosts.</td>
</tr>
<tr>
<td><option>netapp_login</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Administrative user account name used to access the storage system or proxy server.</td>
</tr>
<tr>
<td><option>netapp_lun_ostype</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) This option defines the type of operating system that will access a LUN exported from Data ONTAP; it is assigned to the LUN at the time it is created.</td>
</tr>
<tr>
<td><option>netapp_partner_backend_name</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The name of the config.conf stanza for a Data ONTAP (7-mode) HA partner. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode, and it is required if the storage protocol selected is FC.</td>
</tr>
<tr>
<td><option>netapp_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Password for the administrative user account specified in the netapp_login option.</td>
</tr>
<tr>
<td><option>netapp_pool_name_search_pattern</option> = <replaceable>(.+)</replaceable></td>
<td>(StrOpt) This option is used to restrict provisioning to the specified pools. Specify the value of this option to be a regular expression which will be applied to the names of objects from the storage backend which represent pools in Cinder. This option is only utilized when the storage protocol is configured to use iSCSI or FC.</td>
</tr>
<tr>
<td><option>netapp_server_hostname</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The hostname (or IP address) for the storage system or proxy server.</td>
</tr>
<tr>
<td><option>netapp_server_port</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) The TCP port to use for communication with the storage system or proxy server. If not specified, Data ONTAP drivers will use 80 for HTTP and 443 for HTTPS; E-Series will use 8080 for HTTP and 8443 for HTTPS.</td>
</tr>
<tr>
<td><option>netapp_storage_family</option> = <replaceable>ontap_cluster</replaceable></td>
<td>(StrOpt) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series.</td>
</tr>
<tr>
<td><option>netapp_storage_protocol</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The storage protocol to be used on the data path with the storage system.</td>
</tr>
<tr>
<td><option>netapp_transport_type</option> = <replaceable>http</replaceable></td>
<td>(StrOpt) The transport protocol used when communicating with the storage system or proxy server.</td>
</tr>
<tr>
<td><option>netapp_vserver</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) This option specifies the virtual storage server (Vserver) name on the storage cluster on which provisioning of block storage volumes should occur.</td>
</tr>
<tr>
<td><option>thres_avl_size_perc_start</option> = <replaceable>20</replaceable></td>
<td>(IntOpt) If the percentage of available space for an NFS share has dropped below the value specified by this option, the NFS image cache will be cleaned.</td>
</tr>
<tr>
<td><option>thres_avl_size_perc_stop</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) When the percentage of available space on an NFS share has reached the percentage specified by this option, the driver will stop clearing files from the NFS image cache that have not been accessed in the last M minutes, where M is the value of the expiry_thres_minutes configuration option.</td>
</tr>
</tbody>
</table>
</para>

92
doc/common/tables/cinder-netapp_eseries_iscsi.xml
View File

@ -1,92 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_netapp_eseries_iscsi">
<caption>Description of NetApp E-Series 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>netapp_controller_ips</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) This option is only utilized when the storage family is configured to eseries. This option is used to restrict provisioning to the specified controllers. Specify the value of this option to be a comma separated list of controller hostnames or IP addresses to be used for provisioning.</td>
</tr>
<tr>
<td><option>netapp_enable_multiattach</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) This option specifies whether the driver should allow operations that require multiple attachments to a volume. An example would be live migration of servers that have volumes attached. When enabled, this backend is limited to 256 total volumes in order to guarantee volumes can be accessed by more than one host.</td>
</tr>
<tr>
<td><option>netapp_host_type</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) This option defines the type of operating system for all initiators that can access a LUN. This information is used when mapping LUNs to individual hosts or groups of hosts.</td>
</tr>
<tr>
<td><option>netapp_login</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Administrative user account name used to access the storage system or proxy server.</td>
</tr>
<tr>
<td><option>netapp_partner_backend_name</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The name of the config.conf stanza for a Data ONTAP (7-mode) HA partner. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode, and it is required if the storage protocol selected is FC.</td>
</tr>
<tr>
<td><option>netapp_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Password for the administrative user account specified in the netapp_login option.</td>
</tr>
<tr>
<td><option>netapp_pool_name_search_pattern</option> = <replaceable>(.+)</replaceable></td>
<td>(StrOpt) This option is used to restrict provisioning to the specified pools. Specify the value of this option to be a regular expression which will be applied to the names of objects from the storage backend which represent pools in Cinder. This option is only utilized when the storage protocol is configured to use iSCSI or FC.</td>
</tr>
<tr>
<td><option>netapp_sa_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Password for the NetApp E-Series storage array.</td>
</tr>
<tr>
<td><option>netapp_server_hostname</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The hostname (or IP address) for the storage system or proxy server.</td>
</tr>
<tr>
<td><option>netapp_server_port</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) The TCP port to use for communication with the storage system or proxy server. If not specified, Data ONTAP drivers will use 80 for HTTP and 443 for HTTPS; E-Series will use 8080 for HTTP and 8443 for HTTPS.</td>
</tr>
<tr>
<td><option>netapp_storage_family</option> = <replaceable>ontap_cluster</replaceable></td>
<td>(StrOpt) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series.</td>
</tr>
<tr>
<td><option>netapp_transport_type</option> = <replaceable>http</replaceable></td>
<td>(StrOpt) The transport protocol used when communicating with the storage system or proxy server.</td>
</tr>
<tr>
<td><option>netapp_webservice_path</option> = <replaceable>/devmgr/v2</replaceable></td>
<td>(StrOpt) This option is used to specify the path to the E-Series proxy application on a proxy server. The value is combined with the value of the netapp_transport_type, netapp_server_hostname, and netapp_server_port options to create the URL used by the driver to connect to the proxy application.</td>
</tr>
</tbody>
</table>
</para>

48
doc/common/tables/cinder-nimble.xml
View File

@ -1,48 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_nimble">
<caption>Description of Nimble 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>nimble_pool_name</option> = <replaceable>default</replaceable></td>
<td>(StrOpt) Nimble Controller pool name</td>
</tr>
<tr>
<td><option>nimble_subnet_label</option> = <replaceable>*</replaceable></td>
<td>(StrOpt) Nimble Subnet Label</td>
</tr>
</tbody>
</table>
</para>

26
doc/common/tables/cinder-openvstorage.xml
View File

@ -1,26 +0,0 @@
<?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_openvstorage">
<caption>Description of Open vStorage 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>vpool_name</option> = <replaceable></replaceable></td>
<td>(StrOpt) Vpool to use for volumes - backend is defined by vpool not by us.</td>
</tr>
</tbody>
</table>
</para>

48
doc/common/tables/cinder-profiler.xml
View File

@ -1,48 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_profiler">
<caption>Description of profiler 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">[profiler]</th>
</tr>
<tr>
<td><option>profiler_enabled</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) If False fully disable profiling feature.</td>
</tr>
<tr>
<td><option>trace_sqlalchemy</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) If False doesn't trace SQL requests.</td>
</tr>
</tbody>
</table>
</para>

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