diff --git a/doc/common/section_rpc-for-networking.xml b/doc/common/section_rpc-for-networking.xml
index ca073981e0..988d4e28a7 100644
--- a/doc/common/section_rpc-for-networking.xml
+++ b/doc/common/section_rpc-for-networking.xml
@@ -40,7 +40,6 @@ rpc_backend=neutron.openstack.common.rpc.impl_kombu
<literal>neutron.notifier.rabbit_notifier</literal> in the
<filename>neutron.conf</filename> file:</para>
<xi:include href="tables/neutron-rabbitmq.xml"/>
- <xi:include href="tables/neutron-kombu.xml"/>
</section>
<section xml:id="networking-configuration-qpid">
<title>Configure Qpid</title>
diff --git a/doc/common/tables/ceilometer-alarm.xml b/doc/common/tables/ceilometer-alarm.xml
index d1a4e966b7..d19badece5 100644
--- a/doc/common/tables/ceilometer-alarm.xml
+++ b/doc/common/tables/ceilometer-alarm.xml
@@ -1,55 +1,54 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_ceilometer_alarm">
- <caption>Description of configuration options for alarm</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">[alarm]</th>
- </tr>
- <tr>
- <td>evaluation_interval = 60</td>
- <td>(IntOpt) Period of evaluation cycle, should be >= than configured pipeline interval for collection of underlying metrics.</td>
- </tr>
- <tr>
- <td>evaluation_service = ceilometer.alarm.service.SingletonAlarmService</td>
- <td>(StrOpt) Class to launch as alarm evaluation service.</td>
- </tr>
- <tr>
- <td>notifier_rpc_topic = alarm_notifier</td>
- <td>(StrOpt) The topic that ceilometer uses for alarm notifier messages.</td>
- </tr>
- <tr>
- <td>partition_rpc_topic = alarm_partition_coordination</td>
- <td>(StrOpt) The topic that ceilometer uses for alarm partition coordination messages.</td>
- </tr>
- <tr>
- <td>record_history = True</td>
- <td>(BoolOpt) Record alarm change events.</td>
- </tr>
- <tr>
- <td>rest_notifier_certificate_file = </td>
- <td>(StrOpt) SSL Client certificate for REST notifier.</td>
- </tr>
- <tr>
- <td>rest_notifier_certificate_key = </td>
- <td>(StrOpt) SSL Client private key for REST notifier.</td>
- </tr>
- <tr>
- <td>rest_notifier_ssl_verify = True</td>
- <td>(BoolOpt) Whether to verify the SSL Server certificate when calling alarm action.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_ceilometer_alarm">
+ <caption>Description of configuration options for alarm</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">[alarm]</th>
+ </tr>
+ <tr>
+ <td>evaluation_interval = 60</td>
+ <td>(IntOpt) Period of evaluation cycle, should be >= than configured pipeline interval for collection of underlying metrics.</td>
+ </tr>
+ <tr>
+ <td>evaluation_service = ceilometer.alarm.service.SingletonAlarmService</td>
+ <td>(StrOpt) Class to launch as alarm evaluation service.</td>
+ </tr>
+ <tr>
+ <td>notifier_rpc_topic = alarm_notifier</td>
+ <td>(StrOpt) The topic that ceilometer uses for alarm notifier messages.</td>
+ </tr>
+ <tr>
+ <td>partition_rpc_topic = alarm_partition_coordination</td>
+ <td>(StrOpt) The topic that ceilometer uses for alarm partition coordination messages.</td>
+ </tr>
+ <tr>
+ <td>record_history = True</td>
+ <td>(BoolOpt) Record alarm change events.</td>
+ </tr>
+ <tr>
+ <td>rest_notifier_certificate_file = </td>
+ <td>(StrOpt) SSL Client certificate for REST notifier.</td>
+ </tr>
+ <tr>
+ <td>rest_notifier_certificate_key = </td>
+ <td>(StrOpt) SSL Client private key for REST notifier.</td>
+ </tr>
+ <tr>
+ <td>rest_notifier_ssl_verify = True</td>
+ <td>(BoolOpt) Whether to verify the SSL Server certificate when calling alarm action.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/ceilometer-amqp.xml b/doc/common/tables/ceilometer-amqp.xml
index d32640d5a6..556e21611e 100644
--- a/doc/common/tables/ceilometer-amqp.xml
+++ b/doc/common/tables/ceilometer-amqp.xml
@@ -1,39 +1,38 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_ceilometer_amqp">
- <caption>Description of configuration options for amqp</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>amqp_auto_delete = False</td>
- <td>(BoolOpt) Auto-delete queues in amqp.</td>
- </tr>
- <tr>
- <td>amqp_durable_queues = False</td>
- <td>(BoolOpt) Use durable queues in amqp.</td>
- </tr>
- <tr>
- <td>notification_driver = []</td>
- <td>(MultiStrOpt) Driver or drivers to handle sending notifications</td>
- </tr>
- <tr>
- <td>notification_topics = notifications</td>
- <td>(ListOpt) AMQP topic used for OpenStack notifications</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_ceilometer_amqp">
+ <caption>Description of configuration options for amqp</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>amqp_auto_delete = False</td>
+ <td>(BoolOpt) Auto-delete queues in amqp.</td>
+ </tr>
+ <tr>
+ <td>amqp_durable_queues = False</td>
+ <td>(BoolOpt) Use durable queues in amqp.</td>
+ </tr>
+ <tr>
+ <td>notification_driver = []</td>
+ <td>(MultiStrOpt) Driver or drivers to handle sending notifications.</td>
+ </tr>
+ <tr>
+ <td>notification_topics = notifications</td>
+ <td>(ListOpt) AMQP topic used for OpenStack notifications.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/ceilometer-api.xml b/doc/common/tables/ceilometer-api.xml
index 777a33b55e..71fad5762c 100644
--- a/doc/common/tables/ceilometer-api.xml
+++ b/doc/common/tables/ceilometer-api.xml
@@ -1,62 +1,65 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_ceilometer_api">
- <caption>Description of configuration options for api</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>enable_v1_api = True</td>
- <td>(BoolOpt) Deploy the deprecated v1 API.</td>
- </tr>
- <tr>
- <td>max_request_body_size = 114688</td>
- <td>(IntOpt) The maximum body size per request, in bytes</td>
- </tr>
- <tr>
- <td>pipeline_cfg_file = pipeline.yaml</td>
- <td>(StrOpt) Configuration file for pipeline definition.</td>
- </tr>
- <tr>
- <td>policy_default_rule = default</td>
- <td>(StrOpt) Rule enforced when requested rule is not found</td>
- </tr>
- <tr>
- <td>policy_file = policy.json</td>
- <td>(StrOpt) JSON file containing policy</td>
- </tr>
- <tr>
- <td>reserved_metadata_length = 256</td>
- <td>(IntOpt) Limit on length of reserved metadata values.</td>
- </tr>
- <tr>
- <td>reserved_metadata_namespace = metering.</td>
- <td>(ListOpt) List of metadata prefixes reserved for metering use.</td>
- </tr>
- <tr>
- <th colspan="2">[api]</th>
- </tr>
- <tr>
- <td>host = 0.0.0.0</td>
- <td>(StrOpt) The listen IP for the ceilometer API server.</td>
- </tr>
- <tr>
- <td>port = 8777</td>
- <td>(IntOpt) The port for the ceilometer API server.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_ceilometer_api">
+ <caption>Description of configuration options for api</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>api_paste_config = api_paste.ini</td>
+ <td>(StrOpt) Configuration file for WSGI definition of API.</td>
+ </tr>
+ <tr>
+ <td>max_request_body_size = 114688</td>
+ <td>(IntOpt) The maximum body size for each request, in bytes.</td>
+ </tr>
+ <tr>
+ <td>pipeline_cfg_file = pipeline.yaml</td>
+ <td>(StrOpt) Configuration file for pipeline definition.</td>
+ </tr>
+ <tr>
+ <td>policy_default_rule = default</td>
+ <td>(StrOpt) Default rule. Enforced when a requested rule is not found.</td>
+ </tr>
+ <tr>
+ <td>policy_file = policy.json</td>
+ <td>(StrOpt) The JSON file that defines policies.</td>
+ </tr>
+ <tr>
+ <td>reserved_metadata_length = 256</td>
+ <td>(IntOpt) Limit on length of reserved metadata values.</td>
+ </tr>
+ <tr>
+ <td>reserved_metadata_namespace = metering.</td>
+ <td>(ListOpt) List of metadata prefixes reserved for metering use.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[api]</th>
+ </tr>
+ <tr>
+ <td>enable_reverse_dns_lookup = False</td>
+ <td>(BoolOpt) Set it to False if your environment does not need or have dns server, otherwise it will delay the response from api.</td>
+ </tr>
+ <tr>
+ <td>host = 0.0.0.0</td>
+ <td>(StrOpt) The listen IP for the ceilometer API server.</td>
+ </tr>
+ <tr>
+ <td>port = 8777</td>
+ <td>(IntOpt) The port for the ceilometer API server.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/ceilometer-auth.xml b/doc/common/tables/ceilometer-auth.xml
index 2bfeb4930b..8878e2c72c 100644
--- a/doc/common/tables/ceilometer-auth.xml
+++ b/doc/common/tables/ceilometer-auth.xml
@@ -1,173 +1,58 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_ceilometer_auth">
- <caption>Description of configuration options for auth</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>auth_strategy = keystone</td>
- <td>(StrOpt) The strategy to use for auth: noauth or keystone.</td>
- </tr>
- <tr>
- <th colspan="2">[keystone_authtoken]</th>
- </tr>
- <tr>
- <td>admin_password = None</td>
- <td>(StrOpt) Keystone account password</td>
- </tr>
- <tr>
- <td>admin_tenant_name = admin</td>
- <td>(StrOpt) Keystone service account tenant name to validate user tokens</td>
- </tr>
- <tr>
- <td>admin_token = None</td>
- <td>(StrOpt) Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process.</td>
- </tr>
- <tr>
- <td>admin_user = None</td>
- <td>(StrOpt) Keystone account username</td>
- </tr>
- <tr>
- <td>auth_admin_prefix = </td>
- <td>(StrOpt) Prefix to prepend at the beginning of the path</td>
- </tr>
- <tr>
- <td>auth_host = 127.0.0.1</td>
- <td>(StrOpt) Host providing the admin Identity API endpoint</td>
- </tr>
- <tr>
- <td>auth_port = 35357</td>
- <td>(IntOpt) Port of the admin Identity API endpoint</td>
- </tr>
- <tr>
- <td>auth_protocol = https</td>
- <td>(StrOpt) Protocol of the admin Identity API endpoint(http or https)</td>
- </tr>
- <tr>
- <td>auth_uri = None</td>
- <td>(StrOpt) Complete public Identity API endpoint</td>
- </tr>
- <tr>
- <td>auth_version = None</td>
- <td>(StrOpt) API version of the admin Identity API endpoint</td>
- </tr>
- <tr>
- <td>cache = None</td>
- <td>(StrOpt) Env key for the swift cache</td>
- </tr>
- <tr>
- <td>cafile = None</td>
- <td>(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.</td>
- </tr>
- <tr>
- <td>certfile = None</td>
- <td>(StrOpt) Required if Keystone server requires client certificate</td>
- </tr>
- <tr>
- <td>delay_auth_decision = False</td>
- <td>(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components</td>
- </tr>
- <tr>
- <td>enforce_token_bind = permissive</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>http_connect_timeout = None</td>
- <td>(BoolOpt) Request timeout value for communicating with Identity API server.</td>
- </tr>
- <tr>
- <td>http_request_max_retries = 3</td>
- <td>(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server.</td>
- </tr>
- <tr>
- <td>include_service_catalog = True</td>
- <td>(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.</td>
- </tr>
- <tr>
- <td>insecure = False</td>
- <td>(BoolOpt) Verify HTTPS connections.</td>
- </tr>
- <tr>
- <td>keyfile = None</td>
- <td>(StrOpt) Required if Keystone server requires client certificate</td>
- </tr>
- <tr>
- <td>memcache_secret_key = None</td>
- <td>(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation.</td>
- </tr>
- <tr>
- <td>memcache_security_strategy = None</td>
- <td>(StrOpt) (optional) if defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.</td>
- </tr>
- <tr>
- <td>memcached_servers = None</td>
- <td>(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.</td>
- </tr>
- <tr>
- <td>revocation_cache_time = 300</td>
- <td>(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.</td>
- </tr>
- <tr>
- <td>signing_dir = None</td>
- <td>(StrOpt) Directory used to cache files related to PKI tokens</td>
- </tr>
- <tr>
- <td>token_cache_time = 300</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>
- <tr>
- <th colspan="2">[service_credentials]</th>
- </tr>
- <tr>
- <td>insecure = False</td>
- <td>(BoolOpt) Disables X.509 certificate validation when an SSL connection to Identity Service is established.</td>
- </tr>
- <tr>
- <td>os_auth_url = http://localhost:5000/v2.0</td>
- <td>(StrOpt) Auth URL to use for OpenStack service access.</td>
- </tr>
- <tr>
- <td>os_cacert = None</td>
- <td>(StrOpt) Certificate chain for SSL validation.</td>
- </tr>
- <tr>
- <td>os_endpoint_type = publicURL</td>
- <td>(StrOpt) Type of endpoint in Identity service catalog to use for communication with OpenStack services.</td>
- </tr>
- <tr>
- <td>os_password = admin</td>
- <td>(StrOpt) Password to use for OpenStack service access.</td>
- </tr>
- <tr>
- <td>os_region_name = None</td>
- <td>(StrOpt) Region name to use for OpenStack service endpoints.</td>
- </tr>
- <tr>
- <td>os_tenant_id = </td>
- <td>(StrOpt) Tenant ID to use for OpenStack service access.</td>
- </tr>
- <tr>
- <td>os_tenant_name = admin</td>
- <td>(StrOpt) Tenant name to use for OpenStack service access.</td>
- </tr>
- <tr>
- <td>os_username = ceilometer</td>
- <td>(StrOpt) User name to use for OpenStack service access.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_ceilometer_auth">
+ <caption>Description of configuration options for auth</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>insecure = False</td>
+ <td>(BoolOpt) Disables X.509 certificate validation when an SSL connection to Identity Service is established.</td>
+ </tr>
+ <tr>
+ <td>os_auth_url = http://localhost:5000/v2.0</td>
+ <td>(StrOpt) Auth URL to use for OpenStack service access.</td>
+ </tr>
+ <tr>
+ <td>os_cacert = None</td>
+ <td>(StrOpt) Certificate chain for SSL validation.</td>
+ </tr>
+ <tr>
+ <td>os_endpoint_type = publicURL</td>
+ <td>(StrOpt) Type of endpoint in Identity service catalog to use for communication with OpenStack services.</td>
+ </tr>
+ <tr>
+ <td>os_password = admin</td>
+ <td>(StrOpt) Password to use for OpenStack service access.</td>
+ </tr>
+ <tr>
+ <td>os_region_name = None</td>
+ <td>(StrOpt) Region name to use for OpenStack service endpoints.</td>
+ </tr>
+ <tr>
+ <td>os_tenant_id = </td>
+ <td>(StrOpt) Tenant ID to use for OpenStack service access.</td>
+ </tr>
+ <tr>
+ <td>os_tenant_name = admin</td>
+ <td>(StrOpt) Tenant name to use for OpenStack service access.</td>
+ </tr>
+ <tr>
+ <td>os_username = ceilometer</td>
+ <td>(StrOpt) User name to use for OpenStack service access.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/ceilometer-auth_token.xml b/doc/common/tables/ceilometer-auth_token.xml
new file mode 100644
index 0000000000..b815385c5f
--- /dev/null
+++ b/doc/common/tables/ceilometer-auth_token.xml
@@ -0,0 +1,138 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_ceilometer_auth_token">
+ <caption>Description of configuration options for auth_token</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>admin_password = None</td>
+ <td>(StrOpt) Keystone account password</td>
+ </tr>
+ <tr>
+ <td>admin_tenant_name = admin</td>
+ <td>(StrOpt) Keystone service account tenant name to validate user tokens</td>
+ </tr>
+ <tr>
+ <td>admin_token = None</td>
+ <td>(StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead.</td>
+ </tr>
+ <tr>
+ <td>admin_user = None</td>
+ <td>(StrOpt) Keystone account username</td>
+ </tr>
+ <tr>
+ <td>auth_admin_prefix = </td>
+ <td>(StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri.</td>
+ </tr>
+ <tr>
+ <td>auth_host = 127.0.0.1</td>
+ <td>(StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri.</td>
+ </tr>
+ <tr>
+ <td>auth_port = 35357</td>
+ <td>(IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri.</td>
+ </tr>
+ <tr>
+ <td>auth_protocol = https</td>
+ <td>(StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri.</td>
+ </tr>
+ <tr>
+ <td>auth_uri = None</td>
+ <td>(StrOpt) Complete public Identity API endpoint</td>
+ </tr>
+ <tr>
+ <td>auth_version = None</td>
+ <td>(StrOpt) API version of the admin Identity API endpoint</td>
+ </tr>
+ <tr>
+ <td>cache = None</td>
+ <td>(StrOpt) Env key for the swift cache</td>
+ </tr>
+ <tr>
+ <td>cafile = None</td>
+ <td>(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.</td>
+ </tr>
+ <tr>
+ <td>certfile = None</td>
+ <td>(StrOpt) Required if Keystone server requires client certificate</td>
+ </tr>
+ <tr>
+ <td>check_revocations_for_cached = False</td>
+ <td>(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the Keystone server.</td>
+ </tr>
+ <tr>
+ <td>delay_auth_decision = False</td>
+ <td>(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components</td>
+ </tr>
+ <tr>
+ <td>enforce_token_bind = permissive</td>
+ <td>(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens.</td>
+ </tr>
+ <tr>
+ <td>hash_algorithms = md5</td>
+ <td>(ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance.</td>
+ </tr>
+ <tr>
+ <td>http_connect_timeout = None</td>
+ <td>(BoolOpt) Request timeout value for communicating with Identity API server.</td>
+ </tr>
+ <tr>
+ <td>http_request_max_retries = 3</td>
+ <td>(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server.</td>
+ </tr>
+ <tr>
+ <td>identity_uri = None</td>
+ <td>(StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/</td>
+ </tr>
+ <tr>
+ <td>include_service_catalog = True</td>
+ <td>(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.</td>
+ </tr>
+ <tr>
+ <td>insecure = False</td>
+ <td>(BoolOpt) Verify HTTPS connections.</td>
+ </tr>
+ <tr>
+ <td>keyfile = None</td>
+ <td>(StrOpt) Required if Keystone server requires client certificate</td>
+ </tr>
+ <tr>
+ <td>memcache_secret_key = None</td>
+ <td>(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation.</td>
+ </tr>
+ <tr>
+ <td>memcache_security_strategy = None</td>
+ <td>(StrOpt) (optional) if defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.</td>
+ </tr>
+ <tr>
+ <td>memcached_servers = None</td>
+ <td>(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.</td>
+ </tr>
+ <tr>
+ <td>revocation_cache_time = 10</td>
+ <td>(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.</td>
+ </tr>
+ <tr>
+ <td>signing_dir = None</td>
+ <td>(StrOpt) Directory used to cache files related to PKI tokens</td>
+ </tr>
+ <tr>
+ <td>token_cache_time = 300</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>
diff --git a/doc/common/tables/ceilometer-cells.xml b/doc/common/tables/ceilometer-cells.xml
deleted file mode 100644
index a45a33573e..0000000000
--- a/doc/common/tables/ceilometer-cells.xml
+++ /dev/null
@@ -1,63 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_ceilometer_cells">
- <caption>Description of configuration options for cells</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">[cells]</th>
- </tr>
- <tr>
- <td>bandwidth_update_interval = 600</td>
- <td>(IntOpt) Seconds between bandwidth updates for cells.</td>
- </tr>
- <tr>
- <td>call_timeout = 60</td>
- <td>(IntOpt) Seconds to wait for response from a call to a cell.</td>
- </tr>
- <tr>
- <td>capabilities = hypervisor=xenserver;kvm, os=linux;windows</td>
- <td>(ListOpt) Key/Multi-value list with the capabilities of the cell</td>
- </tr>
- <tr>
- <td>cell_type = compute</td>
- <td>(StrOpt) Type of cell: api or compute</td>
- </tr>
- <tr>
- <td>enable = False</td>
- <td>(BoolOpt) Enable cell functionality</td>
- </tr>
- <tr>
- <td>manager = nova.cells.manager.CellsManager</td>
- <td>(StrOpt) Manager for cells</td>
- </tr>
- <tr>
- <td>mute_child_interval = 300</td>
- <td>(IntOpt) Number of seconds after which a lack of capability and capacity updates signals the child cell is to be treated as a mute.</td>
- </tr>
- <tr>
- <td>name = nova</td>
- <td>(StrOpt) Name of this cell</td>
- </tr>
- <tr>
- <td>reserve_percent = 10.0</td>
- <td>(FloatOpt) Percentage of cell capacity to hold in reserve. Affects both memory and disk utilization</td>
- </tr>
- <tr>
- <td>topic = cells</td>
- <td>(StrOpt) The topic cells nodes listen on</td>
- </tr>
- </tbody>
- </table>
- </para>
diff --git a/doc/common/tables/ceilometer-collector.xml b/doc/common/tables/ceilometer-collector.xml
index 2cc654d757..5a942f4fe2 100644
--- a/doc/common/tables/ceilometer-collector.xml
+++ b/doc/common/tables/ceilometer-collector.xml
@@ -1,53 +1,41 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_ceilometer_collector">
- <caption>Description of configuration options for collector</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>collector_workers = 1</td>
- <td>(IntOpt) Number of workers for collector service. A single collector is enabled by default.</td>
- </tr>
- <tr>
- <th colspan="2">[collector]</th>
- </tr>
- <tr>
- <td>udp_address = 0.0.0.0</td>
- <td>(StrOpt) Address to which the UDP socket is bound. Set to an empty string to disable.</td>
- </tr>
- <tr>
- <td>udp_port = 4952</td>
- <td>(IntOpt) Port to which the UDP socket is bound.</td>
- </tr>
- <tr>
- <th colspan="2">[dispatcher_file]</th>
- </tr>
- <tr>
- <td>backup_count = 0</td>
- <td>(IntOpt) The max number of the files to keep.</td>
- </tr>
- <tr>
- <td>file_path = None</td>
- <td>(StrOpt) Name and the location of the file to record meters.</td>
- </tr>
- <tr>
- <td>max_bytes = 0</td>
- <td>(IntOpt) The max size of the file.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_ceilometer_collector">
+ <caption>Description of configuration options for collector</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>collector_workers = 1</td>
+ <td>(IntOpt) Number of workers for collector service. A single collector is enabled by default.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[dispatcher_file]</th>
+ </tr>
+ <tr>
+ <td>backup_count = 0</td>
+ <td>(IntOpt) The max number of the files to keep.</td>
+ </tr>
+ <tr>
+ <td>file_path = None</td>
+ <td>(StrOpt) Name and the location of the file to record meters.</td>
+ </tr>
+ <tr>
+ <td>max_bytes = 0</td>
+ <td>(IntOpt) The max size of the file.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/ceilometer-common.xml b/doc/common/tables/ceilometer-common.xml
index ffb546a726..ae397d2b1a 100644
--- a/doc/common/tables/ceilometer-common.xml
+++ b/doc/common/tables/ceilometer-common.xml
@@ -1,47 +1,50 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_ceilometer_common">
- <caption>Description of configuration options for common</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>backdoor_port = None</td>
- <td>(StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.</td>
- </tr>
- <tr>
- <td>disable_process_locking = False</td>
- <td>(BoolOpt) Whether to disable inter-process locks.</td>
- </tr>
- <tr>
- <td>fatal_deprecations = False</td>
- <td>(BoolOpt) Make deprecations fatal</td>
- </tr>
- <tr>
- <td>lock_path = None</td>
- <td>(StrOpt) Directory to use for lock files.</td>
- </tr>
- <tr>
- <td>memcached_servers = None</td>
- <td>(ListOpt) Memcached servers or None for in process cache.</td>
- </tr>
- <tr>
- <td>notification_workers = 1</td>
- <td>(IntOpt) Number of workers for notification service. A single notification agent is enabled by default.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_ceilometer_common">
+ <caption>Description of configuration options for common</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>backdoor_port = None</td>
+ <td>(StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.</td>
+ </tr>
+ <tr>
+ <td>disable_process_locking = False</td>
+ <td>(BoolOpt) Enables or disables inter-process locks.</td>
+ </tr>
+ <tr>
+ <td>fatal_deprecations = False</td>
+ <td>(BoolOpt) Enables or disables fatal status of deprecations.</td>
+ </tr>
+ <tr>
+ <td>fatal_exception_format_errors = False</td>
+ <td>(BoolOpt) Make exception message format errors fatal</td>
+ </tr>
+ <tr>
+ <td>lock_path = None</td>
+ <td>(StrOpt) Directory to use for lock files.</td>
+ </tr>
+ <tr>
+ <td>memcached_servers = None</td>
+ <td>(ListOpt) Memcached servers or None for in process cache.</td>
+ </tr>
+ <tr>
+ <td>notification_workers = 1</td>
+ <td>(IntOpt) Number of workers for notification service. A single notification agent is enabled by default.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/ceilometer-database.xml b/doc/common/tables/ceilometer-database.xml
index 58d9684b1b..c1f338b2c1 100644
--- a/doc/common/tables/ceilometer-database.xml
+++ b/doc/common/tables/ceilometer-database.xml
@@ -1,94 +1,113 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_ceilometer_database">
- <caption>Description of configuration options for database</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>database_connection = None</td>
- <td>(StrOpt) DEPRECATED - Database connection string.</td>
- </tr>
- <tr>
- <td>mysql_engine = InnoDB</td>
- <td>(StrOpt) MySQL engine to use.</td>
- </tr>
- <tr>
- <td>sqlite_db = ceilometer.sqlite</td>
- <td>(StrOpt) The file name to use with SQLite</td>
- </tr>
- <tr>
- <td>sqlite_synchronous = True</td>
- <td>(BoolOpt) If True, SQLite uses synchronous mode</td>
- </tr>
- <tr>
- <th colspan="2">[database]</th>
- </tr>
- <tr>
- <td>backend = sqlalchemy</td>
- <td>(StrOpt) The backend to use for db</td>
- </tr>
- <tr>
- <td>connection = sqlite:////usr/lib/python/site-packages/ceilometer/openstack/common/db/$sqlite_db</td>
- <td>(StrOpt) The SQLAlchemy connection string used to connect to the database</td>
- </tr>
- <tr>
- <td>connection_debug = 0</td>
- <td>(IntOpt) Verbosity of SQL debugging information. 0=None, 100=Everything</td>
- </tr>
- <tr>
- <td>connection_trace = False</td>
- <td>(BoolOpt) Add python stack traces to SQL as comment strings</td>
- </tr>
- <tr>
- <td>idle_timeout = 3600</td>
- <td>(IntOpt) Timeout before idle sql connections are reaped</td>
- </tr>
- <tr>
- <td>max_overflow = None</td>
- <td>(IntOpt) If set, use this value for max_overflow with sqlalchemy</td>
- </tr>
- <tr>
- <td>max_pool_size = None</td>
- <td>(IntOpt) Maximum number of SQL connections to keep open in a pool</td>
- </tr>
- <tr>
- <td>max_retries = 10</td>
- <td>(IntOpt) Maximum db connection retries during startup. (setting -1 implies an infinite retry count)</td>
- </tr>
- <tr>
- <td>min_pool_size = 1</td>
- <td>(IntOpt) Minimum number of SQL connections to keep open in a pool</td>
- </tr>
- <tr>
- <td>pool_timeout = None</td>
- <td>(IntOpt) If set, use this value for pool_timeout with sqlalchemy</td>
- </tr>
- <tr>
- <td>retry_interval = 10</td>
- <td>(IntOpt) Interval between retries of opening a sql connection</td>
- </tr>
- <tr>
- <td>slave_connection = </td>
- <td>(StrOpt) The SQLAlchemy connection string used to connect to the slave database</td>
- </tr>
- <tr>
- <td>time_to_live = -1</td>
- <td>(IntOpt) Number of seconds that samples are kept in the database for (<= 0 means forever).</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_ceilometer_database">
+ <caption>Description of configuration options for database</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>database_connection = None</td>
+ <td>(StrOpt) DEPRECATED - Database connection string.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[database]</th>
+ </tr>
+ <tr>
+ <td>backend = sqlalchemy</td>
+ <td>(StrOpt) The backend to use for db</td>
+ </tr>
+ <tr>
+ <td>connection = None</td>
+ <td>(StrOpt) The SQLAlchemy connection string used to connect to the database</td>
+ </tr>
+ <tr>
+ <td>connection_debug = 0</td>
+ <td>(IntOpt) Verbosity of SQL debugging information. 0=None, 100=Everything</td>
+ </tr>
+ <tr>
+ <td>connection_trace = False</td>
+ <td>(BoolOpt) Add python stack traces to SQL as comment strings</td>
+ </tr>
+ <tr>
+ <td>db_inc_retry_interval = True</td>
+ <td>(BoolOpt) Whether to increase interval between db connection retries, up to db_max_retry_interval</td>
+ </tr>
+ <tr>
+ <td>db_max_retries = 20</td>
+ <td>(IntOpt) maximum db connection retries before error is raised. (setting -1 implies an infinite retry count)</td>
+ </tr>
+ <tr>
+ <td>db_max_retry_interval = 10</td>
+ <td>(IntOpt) max seconds between db connection retries, if db_inc_retry_interval is enabled</td>
+ </tr>
+ <tr>
+ <td>db_retry_interval = 1</td>
+ <td>(IntOpt) seconds between db connection retries</td>
+ </tr>
+ <tr>
+ <td>idle_timeout = 3600</td>
+ <td>(IntOpt) Timeout before idle sql connections are reaped</td>
+ </tr>
+ <tr>
+ <td>max_overflow = None</td>
+ <td>(IntOpt) If set, use this value for max_overflow with sqlalchemy</td>
+ </tr>
+ <tr>
+ <td>max_pool_size = None</td>
+ <td>(IntOpt) Maximum number of SQL connections to keep open in a pool</td>
+ </tr>
+ <tr>
+ <td>max_retries = 10</td>
+ <td>(IntOpt) Maximum db connection retries during startup. (setting -1 implies an infinite retry count)</td>
+ </tr>
+ <tr>
+ <td>min_pool_size = 1</td>
+ <td>(IntOpt) Minimum number of SQL connections to keep open in a pool</td>
+ </tr>
+ <tr>
+ <td>mysql_sql_mode = TRADITIONAL</td>
+ <td>(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=</td>
+ </tr>
+ <tr>
+ <td>pool_timeout = None</td>
+ <td>(IntOpt) If set, use this value for pool_timeout with sqlalchemy</td>
+ </tr>
+ <tr>
+ <td>retry_interval = 10</td>
+ <td>(IntOpt) Interval between retries of opening a sql connection</td>
+ </tr>
+ <tr>
+ <td>sqlite_db = ceilometer.sqlite</td>
+ <td>(StrOpt) The file name to use with SQLite</td>
+ </tr>
+ <tr>
+ <td>sqlite_synchronous = True</td>
+ <td>(BoolOpt) If True, SQLite uses synchronous mode</td>
+ </tr>
+ <tr>
+ <td>time_to_live = -1</td>
+ <td>(IntOpt) Number of seconds that samples are kept in the database for (<= 0 means forever).</td>
+ </tr>
+ <tr>
+ <td>use_db_reconnect = False</td>
+ <td>(BoolOpt) Enable the experimental use of database reconnect on connection lost</td>
+ </tr>
+ <tr>
+ <td>use_tpool = False</td>
+ <td>(BoolOpt) Enable the experimental use of thread pooling for all DB API calls</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/ceilometer-events.xml b/doc/common/tables/ceilometer-events.xml
index 756f8fbc51..1da6c96f56 100644
--- a/doc/common/tables/ceilometer-events.xml
+++ b/doc/common/tables/ceilometer-events.xml
@@ -1,42 +1,41 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_ceilometer_events">
- <caption>Description of configuration options for events</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>definitions_cfg_file = event_definitions.yaml</td>
- <td>(StrOpt) Configuration file for event definitions.</td>
- </tr>
- <tr>
- <td>drop_unmatched_notifications = False</td>
- <td>(BoolOpt) Drop notifications if no event definition matches. (Otherwise, we convert them with just the default traits)</td>
- </tr>
- <tr>
- <th colspan="2">[notification]</th>
- </tr>
- <tr>
- <td>ack_on_event_error = True</td>
- <td>(BoolOpt) Acknowledge message when event persistence fails.</td>
- </tr>
- <tr>
- <td>store_events = False</td>
- <td>(BoolOpt) Save event details.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_ceilometer_events">
+ <caption>Description of configuration options for events</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>definitions_cfg_file = event_definitions.yaml</td>
+ <td>(StrOpt) Configuration file for event definitions.</td>
+ </tr>
+ <tr>
+ <td>drop_unmatched_notifications = False</td>
+ <td>(BoolOpt) Drop notifications if no event definition matches. (Otherwise, we convert them with just the default traits)</td>
+ </tr>
+ <tr>
+ <th colspan="2">[notification]</th>
+ </tr>
+ <tr>
+ <td>ack_on_event_error = True</td>
+ <td>(BoolOpt) Acknowledge message when event persistence fails.</td>
+ </tr>
+ <tr>
+ <td>store_events = False</td>
+ <td>(BoolOpt) Save event details.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/ceilometer-exchange.xml b/doc/common/tables/ceilometer-exchange.xml
index ff250f0f4d..fb0a685806 100644
--- a/doc/common/tables/ceilometer-exchange.xml
+++ b/doc/common/tables/ceilometer-exchange.xml
@@ -1,59 +1,54 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_ceilometer_exchange">
- <caption>Description of configuration options for exchange</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>cinder_control_exchange = cinder</td>
- <td>(StrOpt) Exchange name for Cinder notifications.</td>
- </tr>
- <tr>
- <td>control_exchange = openstack</td>
- <td>(StrOpt) AMQP exchange to connect to if using RabbitMQ or Qpid</td>
- </tr>
- <tr>
- <td>default_publisher_id = None</td>
- <td>(StrOpt) Default publisher_id for outgoing notifications</td>
- </tr>
- <tr>
- <td>glance_control_exchange = glance</td>
- <td>(StrOpt) Exchange name for Glance notifications.</td>
- </tr>
- <tr>
- <td>heat_control_exchange = heat</td>
- <td>(StrOpt) Exchange name for Heat notifications</td>
- </tr>
- <tr>
- <td>http_control_exchanges = ['nova', 'glance', 'neutron', 'cinder']</td>
- <td>(MultiStrOpt) Exchanges name to listen for notifications.</td>
- </tr>
- <tr>
- <td>neutron_control_exchange = neutron</td>
- <td>(StrOpt) Exchange name for Neutron notifications.</td>
- </tr>
- <tr>
- <td>nova_control_exchange = nova</td>
- <td>(StrOpt) Exchange name for Nova notifications.</td>
- </tr>
- <tr>
- <td>sample_source = openstack</td>
- <td>(StrOpt) Source for samples emitted on this instance.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_ceilometer_exchange">
+ <caption>Description of configuration options for exchange</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>cinder_control_exchange = cinder</td>
+ <td>(StrOpt) Exchange name for Cinder notifications.</td>
+ </tr>
+ <tr>
+ <td>control_exchange = openstack</td>
+ <td>(StrOpt) AMQP exchange to connect to if using RabbitMQ or Qpid</td>
+ </tr>
+ <tr>
+ <td>glance_control_exchange = glance</td>
+ <td>(StrOpt) Exchange name for Glance notifications.</td>
+ </tr>
+ <tr>
+ <td>heat_control_exchange = heat</td>
+ <td>(StrOpt) Exchange name for Heat notifications</td>
+ </tr>
+ <tr>
+ <td>http_control_exchanges = ['nova', 'glance', 'neutron', 'cinder']</td>
+ <td>(MultiStrOpt) Exchanges name to listen for notifications.</td>
+ </tr>
+ <tr>
+ <td>neutron_control_exchange = neutron</td>
+ <td>(StrOpt) Exchange name for Neutron notifications.</td>
+ </tr>
+ <tr>
+ <td>nova_control_exchange = nova</td>
+ <td>(StrOpt) Exchange name for Nova notifications.</td>
+ </tr>
+ <tr>
+ <td>sample_source = openstack</td>
+ <td>(StrOpt) Source for samples emitted on this instance.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/ceilometer-inspector.xml b/doc/common/tables/ceilometer-inspector.xml
index 0183d71d94..7da8c480d9 100644
--- a/doc/common/tables/ceilometer-inspector.xml
+++ b/doc/common/tables/ceilometer-inspector.xml
@@ -1,35 +1,34 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_ceilometer_inspector">
- <caption>Description of configuration options for inspector</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>hypervisor_inspector = libvirt</td>
- <td>(StrOpt) Inspector to use for inspecting the hypervisor layer.</td>
- </tr>
- <tr>
- <td>libvirt_type = kvm</td>
- <td>(StrOpt) Libvirt domain type (valid options are: kvm, lxc, qemu, uml, xen).</td>
- </tr>
- <tr>
- <td>libvirt_uri = </td>
- <td>(StrOpt) Override the default libvirt URI (which is dependent on libvirt_type).</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_ceilometer_inspector">
+ <caption>Description of configuration options for inspector</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>hypervisor_inspector = libvirt</td>
+ <td>(StrOpt) Inspector to use for inspecting the hypervisor layer.</td>
+ </tr>
+ <tr>
+ <td>libvirt_type = kvm</td>
+ <td>(StrOpt) Libvirt domain type (valid options are: kvm, lxc, qemu, uml, xen).</td>
+ </tr>
+ <tr>
+ <td>libvirt_uri = </td>
+ <td>(StrOpt) Override the default libvirt URI (which is dependent on libvirt_type).</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/ceilometer-logging.xml b/doc/common/tables/ceilometer-logging.xml
index 982d05185c..2d5a2b1666 100644
--- a/doc/common/tables/ceilometer-logging.xml
+++ b/doc/common/tables/ceilometer-logging.xml
@@ -1,114 +1,98 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_ceilometer_logging">
- <caption>Description of configuration options for logging</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>debug = False</td>
- <td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).</td>
- </tr>
- <tr>
- <td>default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN</td>
- <td>(ListOpt) List of logger=LEVEL pairs</td>
- </tr>
- <tr>
- <td>default_notification_level = INFO</td>
- <td>(StrOpt) Default notification level for outgoing notifications</td>
- </tr>
- <tr>
- <td>instance_format = "[instance: %(uuid)s] "</td>
- <td>(StrOpt) If an instance is passed with the log message, format it like this</td>
- </tr>
- <tr>
- <td>instance_uuid_format = "[instance: %(uuid)s] "</td>
- <td>(StrOpt) If an instance UUID is passed with the log message, format it like this</td>
- </tr>
- <tr>
- <td>log_config_append = None</td>
- <td>(StrOpt) The name of logging configuration file. It does not disable existing loggers, but just appends specified logging configuration to any other existing logging options. Please see the Python logging module documentation for details on logging configuration files.</td>
- </tr>
- <tr>
- <td>log_date_format = %Y-%m-%d %H:%M:%S</td>
- <td>(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s</td>
- </tr>
- <tr>
- <td>log_dir = None</td>
- <td>(StrOpt) (Optional) The base directory used for relative --log-file paths</td>
- </tr>
- <tr>
- <td>log_file = None</td>
- <td>(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.</td>
- </tr>
- <tr>
- <td>log_format = None</td>
- <td>(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.</td>
- </tr>
- <tr>
- <td>logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s</td>
- <td>(StrOpt) Format string to use for log messages with context</td>
- </tr>
- <tr>
- <td>logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d</td>
- <td>(StrOpt) Data to append to log format when level is DEBUG</td>
- </tr>
- <tr>
- <td>logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s</td>
- <td>(StrOpt) Format string to use for log messages without context</td>
- </tr>
- <tr>
- <td>logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s</td>
- <td>(StrOpt) Prefix each line of exception output with this format</td>
- </tr>
- <tr>
- <td>publish_errors = False</td>
- <td>(BoolOpt) Publish error events</td>
- </tr>
- <tr>
- <td>syslog_log_facility = LOG_USER</td>
- <td>(StrOpt) Syslog facility to receive log lines</td>
- </tr>
- <tr>
- <td>use_stderr = True</td>
- <td>(BoolOpt) Log output to standard error</td>
- </tr>
- <tr>
- <td>use_syslog = False</td>
- <td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and then will be changed in J to honor RFC5424</td>
- </tr>
- <tr>
- <td>use_syslog_rfc_format = False</td>
- <td>(BoolOpt) (Optional) Use syslog rfc5424 format for logging. If enabled, will add APP-NAME (RFC5424) before the MSG part of the syslog message. The old format without APP-NAME is deprecated in I, and will be removed in J.</td>
- </tr>
- <tr>
- <td>verbose = False</td>
- <td>(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).</td>
- </tr>
- <tr>
- <th colspan="2">[audit]</th>
- </tr>
- <tr>
- <td>api_audit_map = api_audit_map.conf</td>
- <td>(StrOpt) File containing mapping for api paths and service endpoints</td>
- </tr>
- <tr>
- <td>namespace = openstack</td>
- <td>(StrOpt) namespace prefix for generated id</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_ceilometer_logging">
+ <caption>Description of configuration options for logging</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>debug = False</td>
+ <td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).</td>
+ </tr>
+ <tr>
+ <td>default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN</td>
+ <td>(ListOpt) List of logger=LEVEL pairs.</td>
+ </tr>
+ <tr>
+ <td>instance_format = "[instance: %(uuid)s] "</td>
+ <td>(StrOpt) The format for an instance that is passed with the log message. </td>
+ </tr>
+ <tr>
+ <td>instance_uuid_format = "[instance: %(uuid)s] "</td>
+ <td>(StrOpt) The format for an instance UUID that is passed with the log message. </td>
+ </tr>
+ <tr>
+ <td>log_config_append = None</td>
+ <td>(StrOpt) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation.</td>
+ </tr>
+ <tr>
+ <td>log_date_format = %Y-%m-%d %H:%M:%S</td>
+ <td>(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s .</td>
+ </tr>
+ <tr>
+ <td>log_dir = None</td>
+ <td>(StrOpt) (Optional) The base directory used for relative --log-file paths.</td>
+ </tr>
+ <tr>
+ <td>log_file = None</td>
+ <td>(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.</td>
+ </tr>
+ <tr>
+ <td>log_format = None</td>
+ <td>(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.</td>
+ </tr>
+ <tr>
+ <td>logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s</td>
+ <td>(StrOpt) Format string to use for log messages with context.</td>
+ </tr>
+ <tr>
+ <td>logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d</td>
+ <td>(StrOpt) Data to append to log format when level is DEBUG.</td>
+ </tr>
+ <tr>
+ <td>logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s</td>
+ <td>(StrOpt) Format string to use for log messages without context.</td>
+ </tr>
+ <tr>
+ <td>logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s</td>
+ <td>(StrOpt) Prefix each line of exception output with this format.</td>
+ </tr>
+ <tr>
+ <td>publish_errors = False</td>
+ <td>(BoolOpt) Enables or disables publication of error events.</td>
+ </tr>
+ <tr>
+ <td>syslog_log_facility = LOG_USER</td>
+ <td>(StrOpt) Syslog facility to receive log lines.</td>
+ </tr>
+ <tr>
+ <td>use_stderr = True</td>
+ <td>(BoolOpt) Log output to standard error.</td>
+ </tr>
+ <tr>
+ <td>use_syslog = False</td>
+ <td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424.</td>
+ </tr>
+ <tr>
+ <td>use_syslog_rfc_format = False</td>
+ <td>(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in I, and will be removed in J.</td>
+ </tr>
+ <tr>
+ <td>verbose = False</td>
+ <td>(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/ceilometer-nova_cells.xml b/doc/common/tables/ceilometer-nova_cells.xml
new file mode 100644
index 0000000000..871fdaff59
--- /dev/null
+++ b/doc/common/tables/ceilometer-nova_cells.xml
@@ -0,0 +1,69 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_ceilometer_nova_cells">
+ <caption>Description of configuration options for nova_cells</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">[cells]</th>
+ </tr>
+ <tr>
+ <td>bandwidth_update_interval = 600</td>
+ <td>(IntOpt) Seconds between bandwidth updates for cells.</td>
+ </tr>
+ <tr>
+ <td>call_timeout = 60</td>
+ <td>(IntOpt) Seconds to wait for response from a call to a cell.</td>
+ </tr>
+ <tr>
+ <td>capabilities = hypervisor=xenserver;kvm, os=linux;windows</td>
+ <td>(ListOpt) Key/Multi-value list with the capabilities of the cell</td>
+ </tr>
+ <tr>
+ <td>cell_type = compute</td>
+ <td>(StrOpt) Type of cell: api or compute</td>
+ </tr>
+ <tr>
+ <td>enable = False</td>
+ <td>(BoolOpt) Enable cell functionality</td>
+ </tr>
+ <tr>
+ <td>manager = nova.cells.manager.CellsManager</td>
+ <td>(StrOpt) Manager for cells</td>
+ </tr>
+ <tr>
+ <td>mute_child_interval = 300</td>
+ <td>(IntOpt) Number of seconds after which a lack of capability and capacity updates signals the child cell is to be treated as a mute.</td>
+ </tr>
+ <tr>
+ <td>name = nova</td>
+ <td>(StrOpt) Name of this cell</td>
+ </tr>
+ <tr>
+ <td>reserve_percent = 10.0</td>
+ <td>(FloatOpt) Percentage of cell capacity to hold in reserve. Affects both memory and disk utilization</td>
+ </tr>
+ <tr>
+ <td>topic = cells</td>
+ <td>(StrOpt) The topic cells nodes listen on</td>
+ </tr>
+ <tr>
+ <th colspan="2">[upgrade_levels]</th>
+ </tr>
+ <tr>
+ <td>cells = None</td>
+ <td>(StrOpt) Set a version cap for messages sent to local cells services</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/ceilometer-nova_import.xml b/doc/common/tables/ceilometer-nova_import.xml
new file mode 100644
index 0000000000..41fe5c7e88
--- /dev/null
+++ b/doc/common/tables/ceilometer-nova_import.xml
@@ -0,0 +1,38 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_ceilometer_nova_import">
+ <caption>Description of configuration options for nova_import</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>enable_new_services = True</td>
+ <td>(BoolOpt) Services to be added to the available pool on create</td>
+ </tr>
+ <tr>
+ <td>instance_name_template = instance-%08x</td>
+ <td>(StrOpt) Template string to be used to generate instance names</td>
+ </tr>
+ <tr>
+ <td>network_api_class = nova.network.api.API</td>
+ <td>(StrOpt) The full class name of the network API class to use</td>
+ </tr>
+ <tr>
+ <td>snapshot_name_template = snapshot-%s</td>
+ <td>(StrOpt) Template string to be used to generate snapshot names</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/ceilometer-qpid.xml b/doc/common/tables/ceilometer-qpid.xml
index 18f55b7d68..4be8cf37a8 100644
--- a/doc/common/tables/ceilometer-qpid.xml
+++ b/doc/common/tables/ceilometer-qpid.xml
@@ -1,63 +1,62 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_ceilometer_qpid">
- <caption>Description of configuration options for qpid</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>qpid_heartbeat = 60</td>
- <td>(IntOpt) Seconds between connection keepalive heartbeats</td>
- </tr>
- <tr>
- <td>qpid_hostname = localhost</td>
- <td>(StrOpt) Qpid broker hostname</td>
- </tr>
- <tr>
- <td>qpid_hosts = $qpid_hostname:$qpid_port</td>
- <td>(ListOpt) Qpid HA cluster host:port pairs</td>
- </tr>
- <tr>
- <td>qpid_password = </td>
- <td>(StrOpt) Password for qpid connection</td>
- </tr>
- <tr>
- <td>qpid_port = 5672</td>
- <td>(IntOpt) Qpid broker port</td>
- </tr>
- <tr>
- <td>qpid_protocol = tcp</td>
- <td>(StrOpt) Transport to use, either 'tcp' or 'ssl'</td>
- </tr>
- <tr>
- <td>qpid_sasl_mechanisms = </td>
- <td>(StrOpt) Space separated list of SASL mechanisms to use for auth</td>
- </tr>
- <tr>
- <td>qpid_tcp_nodelay = True</td>
- <td>(BoolOpt) Disable Nagle algorithm</td>
- </tr>
- <tr>
- <td>qpid_topology_version = 1</td>
- <td>(IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.</td>
- </tr>
- <tr>
- <td>qpid_username = </td>
- <td>(StrOpt) Username for qpid connection</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_ceilometer_qpid">
+ <caption>Description of configuration options for qpid</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>qpid_heartbeat = 60</td>
+ <td>(IntOpt) Seconds between connection keepalive heartbeats.</td>
+ </tr>
+ <tr>
+ <td>qpid_hostname = localhost</td>
+ <td>(StrOpt) Qpid broker hostname.</td>
+ </tr>
+ <tr>
+ <td>qpid_hosts = $qpid_hostname:$qpid_port</td>
+ <td>(ListOpt) Qpid HA cluster host:port pairs.</td>
+ </tr>
+ <tr>
+ <td>qpid_password = </td>
+ <td>(StrOpt) Password for Qpid connection.</td>
+ </tr>
+ <tr>
+ <td>qpid_port = 5672</td>
+ <td>(IntOpt) Qpid broker port.</td>
+ </tr>
+ <tr>
+ <td>qpid_protocol = tcp</td>
+ <td>(StrOpt) Transport to use, either 'tcp' or 'ssl'.</td>
+ </tr>
+ <tr>
+ <td>qpid_sasl_mechanisms = </td>
+ <td>(StrOpt) Space separated list of SASL mechanisms to use for auth.</td>
+ </tr>
+ <tr>
+ <td>qpid_tcp_nodelay = True</td>
+ <td>(BoolOpt) Whether to disable the Nagle algorithm.</td>
+ </tr>
+ <tr>
+ <td>qpid_topology_version = 1</td>
+ <td>(IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.</td>
+ </tr>
+ <tr>
+ <td>qpid_username = </td>
+ <td>(StrOpt) Username for Qpid connection.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/ceilometer-rabbitmq.xml b/doc/common/tables/ceilometer-rabbitmq.xml
index f870b3f819..e21860fbc0 100644
--- a/doc/common/tables/ceilometer-rabbitmq.xml
+++ b/doc/common/tables/ceilometer-rabbitmq.xml
@@ -1,87 +1,94 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_ceilometer_rabbitmq">
- <caption>Description of configuration options for rabbitmq</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>fake_rabbit = False</td>
- <td>(BoolOpt) If passed, use a fake RabbitMQ provider</td>
- </tr>
- <tr>
- <td>kombu_ssl_ca_certs = </td>
- <td>(StrOpt) SSL certification authority file (valid only if SSL enabled)</td>
- </tr>
- <tr>
- <td>kombu_ssl_certfile = </td>
- <td>(StrOpt) SSL cert file (valid only if SSL enabled)</td>
- </tr>
- <tr>
- <td>kombu_ssl_keyfile = </td>
- <td>(StrOpt) SSL key file (valid only if SSL enabled)</td>
- </tr>
- <tr>
- <td>kombu_ssl_version = </td>
- <td>(StrOpt) If SSL is enabled, the SSL version to use. Valid values are TLSv1, SSLv23 and SSLv3. SSLv2 might be available on some distributions.</td>
- </tr>
- <tr>
- <td>rabbit_ha_queues = False</td>
- <td>(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database.</td>
- </tr>
- <tr>
- <td>rabbit_host = localhost</td>
- <td>(StrOpt) The RabbitMQ broker address where a single node is used</td>
- </tr>
- <tr>
- <td>rabbit_hosts = $rabbit_host:$rabbit_port</td>
- <td>(ListOpt) RabbitMQ HA cluster host:port pairs</td>
- </tr>
- <tr>
- <td>rabbit_max_retries = 0</td>
- <td>(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count)</td>
- </tr>
- <tr>
- <td>rabbit_password = guest</td>
- <td>(StrOpt) The RabbitMQ password</td>
- </tr>
- <tr>
- <td>rabbit_port = 5672</td>
- <td>(IntOpt) The RabbitMQ broker port where a single node is used</td>
- </tr>
- <tr>
- <td>rabbit_retry_backoff = 2</td>
- <td>(IntOpt) How long to backoff for between retries when connecting to RabbitMQ</td>
- </tr>
- <tr>
- <td>rabbit_retry_interval = 1</td>
- <td>(IntOpt) How frequently to retry connecting with RabbitMQ</td>
- </tr>
- <tr>
- <td>rabbit_use_ssl = False</td>
- <td>(BoolOpt) Connect over SSL for RabbitMQ</td>
- </tr>
- <tr>
- <td>rabbit_userid = guest</td>
- <td>(StrOpt) The RabbitMQ userid</td>
- </tr>
- <tr>
- <td>rabbit_virtual_host = /</td>
- <td>(StrOpt) The RabbitMQ virtual host</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_ceilometer_rabbitmq">
+ <caption>Description of configuration options for rabbitmq</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>fake_rabbit = False</td>
+ <td>(BoolOpt) If passed, use a fake RabbitMQ provider</td>
+ </tr>
+ <tr>
+ <td>kombu_reconnect_delay = 1.0</td>
+ <td>(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.</td>
+ </tr>
+ <tr>
+ <td>kombu_ssl_ca_certs = </td>
+ <td>(StrOpt) SSL certification authority file (valid only if SSL enabled).</td>
+ </tr>
+ <tr>
+ <td>kombu_ssl_certfile = </td>
+ <td>(StrOpt) SSL cert file (valid only if SSL enabled).</td>
+ </tr>
+ <tr>
+ <td>kombu_ssl_keyfile = </td>
+ <td>(StrOpt) SSL key file (valid only if SSL enabled).</td>
+ </tr>
+ <tr>
+ <td>kombu_ssl_version = </td>
+ <td>(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions.</td>
+ </tr>
+ <tr>
+ <td>rabbit_ha_queues = False</td>
+ <td>(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database.</td>
+ </tr>
+ <tr>
+ <td>rabbit_host = localhost</td>
+ <td>(StrOpt) The RabbitMQ broker address where a single node is used.</td>
+ </tr>
+ <tr>
+ <td>rabbit_hosts = $rabbit_host:$rabbit_port</td>
+ <td>(ListOpt) RabbitMQ HA cluster host:port pairs.</td>
+ </tr>
+ <tr>
+ <td>rabbit_login_method = AMQPLAIN</td>
+ <td>(StrOpt) the RabbitMQ login method</td>
+ </tr>
+ <tr>
+ <td>rabbit_max_retries = 0</td>
+ <td>(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).</td>
+ </tr>
+ <tr>
+ <td>rabbit_password = guest</td>
+ <td>(StrOpt) The RabbitMQ password.</td>
+ </tr>
+ <tr>
+ <td>rabbit_port = 5672</td>
+ <td>(IntOpt) The RabbitMQ broker port where a single node is used.</td>
+ </tr>
+ <tr>
+ <td>rabbit_retry_backoff = 2</td>
+ <td>(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.</td>
+ </tr>
+ <tr>
+ <td>rabbit_retry_interval = 1</td>
+ <td>(IntOpt) How frequently to retry connecting with RabbitMQ.</td>
+ </tr>
+ <tr>
+ <td>rabbit_use_ssl = False</td>
+ <td>(BoolOpt) Connect over SSL for RabbitMQ.</td>
+ </tr>
+ <tr>
+ <td>rabbit_userid = guest</td>
+ <td>(StrOpt) The RabbitMQ userid.</td>
+ </tr>
+ <tr>
+ <td>rabbit_virtual_host = /</td>
+ <td>(StrOpt) The RabbitMQ virtual host.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/ceilometer-redis.xml b/doc/common/tables/ceilometer-redis.xml
index 7083301f22..b248c2eceb 100644
--- a/doc/common/tables/ceilometer-redis.xml
+++ b/doc/common/tables/ceilometer-redis.xml
@@ -1,57 +1,41 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_ceilometer_redis">
- <caption>Description of configuration options for redis</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>host = oslo</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>matchmaker_heartbeat_freq = 300</td>
- <td>(IntOpt) Heartbeat frequency</td>
- </tr>
- <tr>
- <td>matchmaker_heartbeat_ttl = 600</td>
- <td>(IntOpt) Heartbeat time-to-live.</td>
- </tr>
- <tr>
- <th colspan="2">[matchmaker_redis]</th>
- </tr>
- <tr>
- <td>host = 127.0.0.1</td>
- <td>(StrOpt) Host to locate redis</td>
- </tr>
- <tr>
- <td>password = None</td>
- <td>(StrOpt) Password for Redis server. (optional)</td>
- </tr>
- <tr>
- <td>port = 6379</td>
- <td>(IntOpt) Use this port to connect to redis host.</td>
- </tr>
- <tr>
- <th colspan="2">[matchmaker_ring]</th>
- </tr>
- <tr>
- <td>ringfile = /etc/oslo/matchmaker_ring.json</td>
- <td>(StrOpt) Matchmaker ring file (JSON)</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_ceilometer_redis">
+ <caption>Description of configuration options for redis</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>host = oslo</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>matchmaker_heartbeat_freq = 300</td>
+ <td>(IntOpt) Heartbeat frequency.</td>
+ </tr>
+ <tr>
+ <td>matchmaker_heartbeat_ttl = 600</td>
+ <td>(IntOpt) Heartbeat time-to-live.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[matchmaker_ring]</th>
+ </tr>
+ <tr>
+ <td>ringfile = /etc/oslo/matchmaker_ring.json</td>
+ <td>(StrOpt) Matchmaker ring file (JSON).</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/ceilometer-rpc.xml b/doc/common/tables/ceilometer-rpc.xml
index 50b1f07385..464bdc0648 100644
--- a/doc/common/tables/ceilometer-rpc.xml
+++ b/doc/common/tables/ceilometer-rpc.xml
@@ -1,100 +1,111 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_ceilometer_rpc">
- <caption>Description of configuration options for rpc</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>allowed_rpc_exception_modules = nova.exception, cinder.exception, exceptions</td>
- <td>(ListOpt) Modules of exceptions that are permitted to be recreated upon receiving exception data from an rpc call.</td>
- </tr>
- <tr>
- <td>dispatcher = ['database']</td>
- <td>(MultiStrOpt) Dispatcher to process data.</td>
- </tr>
- <tr>
- <td>rpc_backend = ceilometer.openstack.common.rpc.impl_kombu</td>
- <td>(StrOpt) The messaging module to use, defaults to kombu.</td>
- </tr>
- <tr>
- <td>rpc_cast_timeout = 30</td>
- <td>(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq.</td>
- </tr>
- <tr>
- <td>rpc_conn_pool_size = 30</td>
- <td>(IntOpt) Size of RPC connection pool</td>
- </tr>
- <tr>
- <td>rpc_response_timeout = 60</td>
- <td>(IntOpt) Seconds to wait for a response from call or multicall</td>
- </tr>
- <tr>
- <td>rpc_thread_pool_size = 64</td>
- <td>(IntOpt) Size of RPC thread pool</td>
- </tr>
- <tr>
- <td>rpc_zmq_bind_address = *</td>
- <td>(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address.</td>
- </tr>
- <tr>
- <td>rpc_zmq_contexts = 1</td>
- <td>(IntOpt) Number of ZeroMQ contexts, defaults to 1</td>
- </tr>
- <tr>
- <td>rpc_zmq_host = oslo</td>
- <td>(StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova.</td>
- </tr>
- <tr>
- <td>rpc_zmq_ipc_dir = /var/run/openstack</td>
- <td>(StrOpt) Directory for holding IPC sockets</td>
- </tr>
- <tr>
- <td>rpc_zmq_matchmaker = ceilometer.openstack.common.rpc.matchmaker.MatchMakerLocalhost</td>
- <td>(StrOpt) MatchMaker driver</td>
- </tr>
- <tr>
- <td>rpc_zmq_port = 9501</td>
- <td>(IntOpt) ZeroMQ receiver listening port</td>
- </tr>
- <tr>
- <td>rpc_zmq_topic_backlog = None</td>
- <td>(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited.</td>
- </tr>
- <tr>
- <th colspan="2">[publisher]</th>
- </tr>
- <tr>
- <td>metering_secret = change this or be hacked</td>
- <td>(StrOpt) Secret value for signing metering messages.</td>
- </tr>
- <tr>
- <th colspan="2">[publisher_rpc]</th>
- </tr>
- <tr>
- <td>metering_topic = metering</td>
- <td>(StrOpt) The topic that ceilometer uses for metering messages.</td>
- </tr>
- <tr>
- <th colspan="2">[rpc_notifier2]</th>
- </tr>
- <tr>
- <td>topics = notifications</td>
- <td>(ListOpt) AMQP topic(s) used for OpenStack notifications</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_ceilometer_rpc">
+ <caption>Description of configuration options for rpc</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>allowed_rpc_exception_modules = nova.exception, cinder.exception, exceptions</td>
+ <td>(ListOpt) Modules of exceptions that are permitted to be recreated upon receiving exception data from an rpc call.</td>
+ </tr>
+ <tr>
+ <td>dispatcher = ['database']</td>
+ <td>(MultiStrOpt) Dispatcher to process data.</td>
+ </tr>
+ <tr>
+ <td>password = None</td>
+ <td>(StrOpt) Password for Redis server (optional).</td>
+ </tr>
+ <tr>
+ <td>port = 6379</td>
+ <td>(IntOpt) Use this port to connect to redis host.</td>
+ </tr>
+ <tr>
+ <td>rpc_backend = ceilometer.openstack.common.rpc.impl_kombu</td>
+ <td>(StrOpt) The messaging module to use, defaults to kombu.</td>
+ </tr>
+ <tr>
+ <td>rpc_cast_timeout = 30</td>
+ <td>(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq.</td>
+ </tr>
+ <tr>
+ <td>rpc_conn_pool_size = 30</td>
+ <td>(IntOpt) Size of RPC connection pool</td>
+ </tr>
+ <tr>
+ <td>rpc_response_timeout = 60</td>
+ <td>(IntOpt) Seconds to wait for a response from call or multicall</td>
+ </tr>
+ <tr>
+ <td>rpc_thread_pool_size = 64</td>
+ <td>(IntOpt) Size of RPC thread pool</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_bind_address = *</td>
+ <td>(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_contexts = 1</td>
+ <td>(IntOpt) Number of ZeroMQ contexts, defaults to 1.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_host = oslo</td>
+ <td>(StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_ipc_dir = /var/run/openstack</td>
+ <td>(StrOpt) Directory for holding IPC sockets.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_matchmaker = oslo.messaging._drivers.matchmaker.MatchMakerLocalhost</td>
+ <td>(StrOpt) MatchMaker driver.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_port = 9501</td>
+ <td>(IntOpt) ZeroMQ receiver listening port.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_topic_backlog = None</td>
+ <td>(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited.</td>
+ </tr>
+ <tr>
+ <td>transport_url = None</td>
+ <td>(StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[notification]</th>
+ </tr>
+ <tr>
+ <td>messaging_urls = []</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">[publisher]</th>
+ </tr>
+ <tr>
+ <td>metering_secret = change this or be hacked</td>
+ <td>(StrOpt) Secret value for signing metering messages.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[publisher_rpc]</th>
+ </tr>
+ <tr>
+ <td>metering_topic = metering</td>
+ <td>(StrOpt) The topic that ceilometer uses for metering messages.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/ceilometer-ssl.xml b/doc/common/tables/ceilometer-ssl.xml
deleted file mode 100644
index 52108ab589..0000000000
--- a/doc/common/tables/ceilometer-ssl.xml
+++ /dev/null
@@ -1,35 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_ceilometer_ssl">
- <caption>Description of configuration options for ssl</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[ssl]</th>
- </tr>
- <tr>
- <td>ca_file = None</td>
- <td>(StrOpt) CA certificate file to use to verify connecting clients</td>
- </tr>
- <tr>
- <td>cert_file = None</td>
- <td>(StrOpt) Certificate file to use when starting the server securely</td>
- </tr>
- <tr>
- <td>key_file = None</td>
- <td>(StrOpt) Private key file to use when starting the server securely</td>
- </tr>
- </tbody>
- </table>
- </para>
diff --git a/doc/common/tables/ceilometer-swift.xml b/doc/common/tables/ceilometer-swift.xml
index 7b39c818d1..962afdee36 100644
--- a/doc/common/tables/ceilometer-swift.xml
+++ b/doc/common/tables/ceilometer-swift.xml
@@ -1,27 +1,26 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_ceilometer_swift">
- <caption>Description of configuration options for swift</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>reseller_prefix = AUTH_</td>
- <td>(StrOpt) Swift reseller prefix. Must be on par with reseller_prefix in proxy-server.conf.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_ceilometer_swift">
+ <caption>Description of configuration options for swift</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>reseller_prefix = AUTH_</td>
+ <td>(StrOpt) Swift reseller prefix. Must be on par with reseller_prefix in proxy-server.conf.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/ceilometer-vmware.xml b/doc/common/tables/ceilometer-vmware.xml
index 8c0f406cc5..f5bf2ea703 100644
--- a/doc/common/tables/ceilometer-vmware.xml
+++ b/doc/common/tables/ceilometer-vmware.xml
@@ -1,43 +1,46 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_ceilometer_vmware">
- <caption>Description of configuration options for vmware</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>api_retry_count = 10</td>
- <td>(IntOpt) Number of times a VMware Vsphere API must be retried</td>
- </tr>
- <tr>
- <td>host_ip = </td>
- <td>(StrOpt) IP address of the VMware Vsphere host</td>
- </tr>
- <tr>
- <td>host_password = </td>
- <td>(StrOpt) Password of VMware Vsphere</td>
- </tr>
- <tr>
- <td>host_username = </td>
- <td>(StrOpt) Username of VMware Vsphere</td>
- </tr>
- <tr>
- <td>task_poll_interval = 0.5</td>
- <td>(FloatOpt) Sleep time in seconds for polling an ongoing async task</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_ceilometer_vmware">
+ <caption>Description of configuration options for vmware</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>api_retry_count = 10</td>
+ <td>(IntOpt) Number of times a VMware Vsphere API must be retried</td>
+ </tr>
+ <tr>
+ <td>host_ip = </td>
+ <td>(StrOpt) IP address of the VMware Vsphere host</td>
+ </tr>
+ <tr>
+ <td>host_password = </td>
+ <td>(StrOpt) Password of VMware Vsphere</td>
+ </tr>
+ <tr>
+ <td>host_username = </td>
+ <td>(StrOpt) Username of VMware Vsphere</td>
+ </tr>
+ <tr>
+ <td>task_poll_interval = 0.5</td>
+ <td>(FloatOpt) Sleep time in seconds for polling an ongoing async task</td>
+ </tr>
+ <tr>
+ <td>wsdl_location = None</td>
+ <td>(StrOpt) Optional vim service WSDL location e.g http://<server>/vimService.wsdl. Optional over-ride to default location for bug work-arounds</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-api.xml b/doc/common/tables/cinder-api.xml
index a6c33fe3d9..4497dfb1fe 100644
--- a/doc/common/tables/cinder-api.xml
+++ b/doc/common/tables/cinder-api.xml
@@ -1,103 +1,102 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_api">
- <caption>Description of configuration options for api</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>api_paste_config = api-paste.ini</td>
- <td>(StrOpt) File name for the paste.deploy config for cinder-api</td>
- </tr>
- <tr>
- <td>api_rate_limit = True</td>
- <td>(BoolOpt) whether to rate limit the api</td>
- </tr>
- <tr>
- <td>backdoor_port = None</td>
- <td>(StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.</td>
- </tr>
- <tr>
- <td>enable_v1_api = True</td>
- <td>(BoolOpt) Deploy v1 of the Cinder API.</td>
- </tr>
- <tr>
- <td>enable_v2_api = True</td>
- <td>(BoolOpt) Deploy v2 of the Cinder API.</td>
- </tr>
- <tr>
- <td>extra_capabilities = {}</td>
- <td>(StrOpt) User defined capabilities, a JSON formatted string specifying key/value pairs.</td>
- </tr>
- <tr>
- <td>max_header_line = 16384</td>
- <td>(IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs).</td>
- </tr>
- <tr>
- <td>osapi_max_limit = 1000</td>
- <td>(IntOpt) the maximum number of items returned in a single response from a collection resource</td>
- </tr>
- <tr>
- <td>osapi_max_request_body_size = 114688</td>
- <td>(IntOpt) Max size for body of a request</td>
- </tr>
- <tr>
- <td>osapi_volume_base_URL = None</td>
- <td>(StrOpt) Base URL that will be presented to users in links to the OpenStack Volume API</td>
- </tr>
- <tr>
- <td>osapi_volume_ext_list = </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>osapi_volume_extension = ['cinder.api.contrib.standard_extensions']</td>
- <td>(MultiStrOpt) osapi volume extension to load</td>
- </tr>
- <tr>
- <td>osapi_volume_listen = 0.0.0.0</td>
- <td>(StrOpt) IP address for OpenStack Volume API to listen</td>
- </tr>
- <tr>
- <td>osapi_volume_listen_port = 8776</td>
- <td>(IntOpt) port for os volume api to listen</td>
- </tr>
- <tr>
- <td>osapi_volume_workers = None</td>
- <td>(IntOpt) Number of workers for OpenStack Volume API service</td>
- </tr>
- <tr>
- <td>transfer_api_class = cinder.transfer.api.API</td>
- <td>(StrOpt) The full class name of the volume transfer API class</td>
- </tr>
- <tr>
- <td>volume_api_class = cinder.volume.api.API</td>
- <td>(StrOpt) The full class name of the volume API class to use</td>
- </tr>
- <tr>
- <td>volume_name_template = volume-%s</td>
- <td>(StrOpt) Template string to be used to generate volume names</td>
- </tr>
- <tr>
- <td>volume_transfer_key_length = 16</td>
- <td>(IntOpt) The number of characters in the autogenerated auth key.</td>
- </tr>
- <tr>
- <td>volume_transfer_salt_length = 8</td>
- <td>(IntOpt) The number of characters in the salt.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_api">
+ <caption>Description of configuration options for api</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>api_paste_config = api-paste.ini</td>
+ <td>(StrOpt) File name for the paste.deploy config for cinder-api</td>
+ </tr>
+ <tr>
+ <td>api_rate_limit = True</td>
+ <td>(BoolOpt) Enables or disables rate limit of the API.</td>
+ </tr>
+ <tr>
+ <td>az_cache_duration = 3600</td>
+ <td>(IntOpt) Cache volume availability zones in memory for the provided duration in seconds</td>
+ </tr>
+ <tr>
+ <td>backdoor_port = None</td>
+ <td>(StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.</td>
+ </tr>
+ <tr>
+ <td>enable_v1_api = True</td>
+ <td>(BoolOpt) Deploy v1 of the Cinder API.</td>
+ </tr>
+ <tr>
+ <td>enable_v2_api = True</td>
+ <td>(BoolOpt) Deploy v2 of the Cinder API.</td>
+ </tr>
+ <tr>
+ <td>extra_capabilities = {}</td>
+ <td>(StrOpt) User defined capabilities, a JSON formatted string specifying key/value pairs.</td>
+ </tr>
+ <tr>
+ <td>max_header_line = 16384</td>
+ <td>(IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs).</td>
+ </tr>
+ <tr>
+ <td>osapi_max_limit = 1000</td>
+ <td>(IntOpt) The maximum number of items that a collection resource returns in a single response</td>
+ </tr>
+ <tr>
+ <td>osapi_max_request_body_size = 114688</td>
+ <td>(IntOpt) Max size for body of a request</td>
+ </tr>
+ <tr>
+ <td>osapi_volume_base_URL = None</td>
+ <td>(StrOpt) Base URL that will be presented to users in links to the OpenStack Volume API</td>
+ </tr>
+ <tr>
+ <td>osapi_volume_ext_list = </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>osapi_volume_extension = ['cinder.api.contrib.standard_extensions']</td>
+ <td>(MultiStrOpt) osapi volume extension to load</td>
+ </tr>
+ <tr>
+ <td>osapi_volume_listen = 0.0.0.0</td>
+ <td>(StrOpt) IP address on which OpenStack Volume API listens</td>
+ </tr>
+ <tr>
+ <td>osapi_volume_listen_port = 8776</td>
+ <td>(IntOpt) Port on which OpenStack Volume API listens</td>
+ </tr>
+ <tr>
+ <td>transfer_api_class = cinder.transfer.api.API</td>
+ <td>(StrOpt) The full class name of the volume transfer API class</td>
+ </tr>
+ <tr>
+ <td>volume_api_class = cinder.volume.api.API</td>
+ <td>(StrOpt) The full class name of the volume API class to use</td>
+ </tr>
+ <tr>
+ <td>volume_name_template = volume-%s</td>
+ <td>(StrOpt) Template string to be used to generate volume names</td>
+ </tr>
+ <tr>
+ <td>volume_transfer_key_length = 16</td>
+ <td>(IntOpt) The number of characters in the autogenerated auth key.</td>
+ </tr>
+ <tr>
+ <td>volume_transfer_salt_length = 8</td>
+ <td>(IntOpt) The number of characters in the salt.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-auth.xml b/doc/common/tables/cinder-auth.xml
index 899fd8dd78..06bf076489 100644
--- a/doc/common/tables/cinder-auth.xml
+++ b/doc/common/tables/cinder-auth.xml
@@ -1,27 +1,26 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_auth">
- <caption>Description of configuration options for auth</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>auth_strategy = noauth</td>
- <td>(StrOpt) The strategy to use for auth. Supports noauth, keystone, and deprecated.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_auth">
+ <caption>Description of configuration options for auth</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>auth_strategy = noauth</td>
+ <td>(StrOpt) The strategy to use for auth. Supports noauth, keystone, and deprecated.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-auth_token.xml b/doc/common/tables/cinder-auth_token.xml
index 2fce6f06da..3f718a125d 100644
--- a/doc/common/tables/cinder-auth_token.xml
+++ b/doc/common/tables/cinder-auth_token.xml
@@ -1,134 +1,145 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_auth_token">
- <caption>Description of configuration options for auth_token</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>memcached_servers = None</td>
- <td>(ListOpt) Memcached servers or None for in process cache.</td>
- </tr>
- <tr>
- <th colspan="2">[keystone_authtoken]</th>
- </tr>
- <tr>
- <td>admin_password = None</td>
- <td>(StrOpt) Keystone account password</td>
- </tr>
- <tr>
- <td>admin_tenant_name = admin</td>
- <td>(StrOpt) Keystone service account tenant name to validate user tokens</td>
- </tr>
- <tr>
- <td>admin_token = None</td>
- <td>(StrOpt) Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process.</td>
- </tr>
- <tr>
- <td>admin_user = None</td>
- <td>(StrOpt) Keystone account username</td>
- </tr>
- <tr>
- <td>auth_admin_prefix = </td>
- <td>(StrOpt) Prefix to prepend at the beginning of the path</td>
- </tr>
- <tr>
- <td>auth_host = 127.0.0.1</td>
- <td>(StrOpt) Host providing the admin Identity API endpoint</td>
- </tr>
- <tr>
- <td>auth_port = 35357</td>
- <td>(IntOpt) Port of the admin Identity API endpoint</td>
- </tr>
- <tr>
- <td>auth_protocol = https</td>
- <td>(StrOpt) Protocol of the admin Identity API endpoint(http or https)</td>
- </tr>
- <tr>
- <td>auth_uri = None</td>
- <td>(StrOpt) Complete public Identity API endpoint</td>
- </tr>
- <tr>
- <td>auth_version = None</td>
- <td>(StrOpt) API version of the admin Identity API endpoint</td>
- </tr>
- <tr>
- <td>cache = None</td>
- <td>(StrOpt) Env key for the swift cache</td>
- </tr>
- <tr>
- <td>cafile = None</td>
- <td>(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.</td>
- </tr>
- <tr>
- <td>certfile = None</td>
- <td>(StrOpt) Required if Keystone server requires client certificate</td>
- </tr>
- <tr>
- <td>delay_auth_decision = False</td>
- <td>(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components</td>
- </tr>
- <tr>
- <td>enforce_token_bind = permissive</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>http_connect_timeout = None</td>
- <td>(BoolOpt) Request timeout value for communicating with Identity API server.</td>
- </tr>
- <tr>
- <td>http_request_max_retries = 3</td>
- <td>(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server.</td>
- </tr>
- <tr>
- <td>include_service_catalog = True</td>
- <td>(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.</td>
- </tr>
- <tr>
- <td>insecure = False</td>
- <td>(BoolOpt) Verify HTTPS connections.</td>
- </tr>
- <tr>
- <td>keyfile = None</td>
- <td>(StrOpt) Required if Keystone server requires client certificate</td>
- </tr>
- <tr>
- <td>memcache_secret_key = None</td>
- <td>(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation.</td>
- </tr>
- <tr>
- <td>memcache_security_strategy = None</td>
- <td>(StrOpt) (optional) if defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.</td>
- </tr>
- <tr>
- <td>memcached_servers = None</td>
- <td>(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.</td>
- </tr>
- <tr>
- <td>revocation_cache_time = 300</td>
- <td>(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.</td>
- </tr>
- <tr>
- <td>signing_dir = None</td>
- <td>(StrOpt) Directory used to cache files related to PKI tokens</td>
- </tr>
- <tr>
- <td>token_cache_time = 300</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>
+<?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_auth_token">
+ <caption>Description of configuration options for auth_token</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>memcached_servers = None</td>
+ <td>(ListOpt) Memcached servers or None for in process cache.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[keystone_authtoken]</th>
+ </tr>
+ <tr>
+ <td>admin_password = None</td>
+ <td>(StrOpt) Keystone account password</td>
+ </tr>
+ <tr>
+ <td>admin_tenant_name = admin</td>
+ <td>(StrOpt) Keystone service account tenant name to validate user tokens</td>
+ </tr>
+ <tr>
+ <td>admin_token = None</td>
+ <td>(StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead.</td>
+ </tr>
+ <tr>
+ <td>admin_user = None</td>
+ <td>(StrOpt) Keystone account username</td>
+ </tr>
+ <tr>
+ <td>auth_admin_prefix = </td>
+ <td>(StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri.</td>
+ </tr>
+ <tr>
+ <td>auth_host = 127.0.0.1</td>
+ <td>(StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri.</td>
+ </tr>
+ <tr>
+ <td>auth_port = 35357</td>
+ <td>(IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri.</td>
+ </tr>
+ <tr>
+ <td>auth_protocol = https</td>
+ <td>(StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri.</td>
+ </tr>
+ <tr>
+ <td>auth_uri = None</td>
+ <td>(StrOpt) Complete public Identity API endpoint</td>
+ </tr>
+ <tr>
+ <td>auth_version = None</td>
+ <td>(StrOpt) API version of the admin Identity API endpoint</td>
+ </tr>
+ <tr>
+ <td>cache = None</td>
+ <td>(StrOpt) Env key for the swift cache</td>
+ </tr>
+ <tr>
+ <td>cafile = None</td>
+ <td>(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.</td>
+ </tr>
+ <tr>
+ <td>certfile = None</td>
+ <td>(StrOpt) Required if Keystone server requires client certificate</td>
+ </tr>
+ <tr>
+ <td>check_revocations_for_cached = False</td>
+ <td>(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the Keystone server.</td>
+ </tr>
+ <tr>
+ <td>delay_auth_decision = False</td>
+ <td>(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components</td>
+ </tr>
+ <tr>
+ <td>enforce_token_bind = permissive</td>
+ <td>(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens.</td>
+ </tr>
+ <tr>
+ <td>hash_algorithms = md5</td>
+ <td>(ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance.</td>
+ </tr>
+ <tr>
+ <td>http_connect_timeout = None</td>
+ <td>(BoolOpt) Request timeout value for communicating with Identity API server.</td>
+ </tr>
+ <tr>
+ <td>http_request_max_retries = 3</td>
+ <td>(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server.</td>
+ </tr>
+ <tr>
+ <td>identity_uri = None</td>
+ <td>(StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/</td>
+ </tr>
+ <tr>
+ <td>include_service_catalog = True</td>
+ <td>(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.</td>
+ </tr>
+ <tr>
+ <td>insecure = False</td>
+ <td>(BoolOpt) Verify HTTPS connections.</td>
+ </tr>
+ <tr>
+ <td>keyfile = None</td>
+ <td>(StrOpt) Required if Keystone server requires client certificate</td>
+ </tr>
+ <tr>
+ <td>memcache_secret_key = None</td>
+ <td>(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation.</td>
+ </tr>
+ <tr>
+ <td>memcache_security_strategy = None</td>
+ <td>(StrOpt) (optional) if defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.</td>
+ </tr>
+ <tr>
+ <td>memcached_servers = None</td>
+ <td>(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.</td>
+ </tr>
+ <tr>
+ <td>revocation_cache_time = 10</td>
+ <td>(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.</td>
+ </tr>
+ <tr>
+ <td>signing_dir = None</td>
+ <td>(StrOpt) Directory used to cache files related to PKI tokens</td>
+ </tr>
+ <tr>
+ <td>token_cache_time = 300</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>
diff --git a/doc/common/tables/cinder-backups.xml b/doc/common/tables/cinder-backups.xml
index 62f00d73c3..bea5a12391 100644
--- a/doc/common/tables/cinder-backups.xml
+++ b/doc/common/tables/cinder-backups.xml
@@ -1,59 +1,58 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_backups">
- <caption>Description of configuration options for backups</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>backup_api_class = cinder.backup.api.API</td>
- <td>(StrOpt) The full class name of the volume backup API class</td>
- </tr>
- <tr>
- <td>backup_compression_algorithm = zlib</td>
- <td>(StrOpt) Compression algorithm (None to disable)</td>
- </tr>
- <tr>
- <td>backup_driver = cinder.backup.drivers.swift</td>
- <td>(StrOpt) Driver to use for backups.</td>
- </tr>
- <tr>
- <td>backup_manager = cinder.backup.manager.BackupManager</td>
- <td>(StrOpt) full class name for the Manager for volume backup</td>
- </tr>
- <tr>
- <td>backup_metadata_version = 1</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>backup_name_template = backup-%s</td>
- <td>(StrOpt) Template string to be used to generate backup names</td>
- </tr>
- <tr>
- <td>backup_topic = cinder-backup</td>
- <td>(StrOpt) the topic volume backup nodes listen on</td>
- </tr>
- <tr>
- <td>snapshot_name_template = snapshot-%s</td>
- <td>(StrOpt) Template string to be used to generate snapshot names</td>
- </tr>
- <tr>
- <td>snapshot_same_host = True</td>
- <td>(BoolOpt) Create volume from snapshot at the host where snapshot resides</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_backups">
+ <caption>Description of configuration options for backups</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>backup_api_class = cinder.backup.api.API</td>
+ <td>(StrOpt) The full class name of the volume backup API class</td>
+ </tr>
+ <tr>
+ <td>backup_compression_algorithm = zlib</td>
+ <td>(StrOpt) Compression algorithm (None to disable)</td>
+ </tr>
+ <tr>
+ <td>backup_driver = cinder.backup.drivers.swift</td>
+ <td>(StrOpt) Driver to use for backups.</td>
+ </tr>
+ <tr>
+ <td>backup_manager = cinder.backup.manager.BackupManager</td>
+ <td>(StrOpt) Full class name for the Manager for volume backup</td>
+ </tr>
+ <tr>
+ <td>backup_metadata_version = 1</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>backup_name_template = backup-%s</td>
+ <td>(StrOpt) Template string to be used to generate backup names</td>
+ </tr>
+ <tr>
+ <td>backup_topic = cinder-backup</td>
+ <td>(StrOpt) The topic that volume backup nodes listen on</td>
+ </tr>
+ <tr>
+ <td>snapshot_name_template = snapshot-%s</td>
+ <td>(StrOpt) Template string to be used to generate snapshot names</td>
+ </tr>
+ <tr>
+ <td>snapshot_same_host = True</td>
+ <td>(BoolOpt) Create volume from snapshot at the host where snapshot resides</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-backups_ceph.xml b/doc/common/tables/cinder-backups_ceph.xml
index 105cd2c197..1adb8abc49 100644
--- a/doc/common/tables/cinder-backups_ceph.xml
+++ b/doc/common/tables/cinder-backups_ceph.xml
@@ -1,51 +1,50 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_backups_ceph">
- <caption>Description of configuration options for backups_ceph</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>backup_ceph_chunk_size = 134217728</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>backup_ceph_conf = /etc/ceph/ceph.conf</td>
- <td>(StrOpt) Ceph configuration file to use.</td>
- </tr>
- <tr>
- <td>backup_ceph_pool = backups</td>
- <td>(StrOpt) The Ceph pool where volume backups are stored.</td>
- </tr>
- <tr>
- <td>backup_ceph_stripe_count = 0</td>
- <td>(IntOpt) RBD stripe count to use when creating a backup image.</td>
- </tr>
- <tr>
- <td>backup_ceph_stripe_unit = 0</td>
- <td>(IntOpt) RBD stripe unit to use when creating a backup image.</td>
- </tr>
- <tr>
- <td>backup_ceph_user = cinder</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>restore_discard_excess_bytes = True</td>
- <td>(BoolOpt) If True, always discard excess bytes when restoring volumes i.e. pad with zeroes.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_backups_ceph">
+ <caption>Description of configuration options for backups_ceph</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>backup_ceph_chunk_size = 134217728</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>backup_ceph_conf = /etc/ceph/ceph.conf</td>
+ <td>(StrOpt) Ceph configuration file to use.</td>
+ </tr>
+ <tr>
+ <td>backup_ceph_pool = backups</td>
+ <td>(StrOpt) The Ceph pool where volume backups are stored.</td>
+ </tr>
+ <tr>
+ <td>backup_ceph_stripe_count = 0</td>
+ <td>(IntOpt) RBD stripe count to use when creating a backup image.</td>
+ </tr>
+ <tr>
+ <td>backup_ceph_stripe_unit = 0</td>
+ <td>(IntOpt) RBD stripe unit to use when creating a backup image.</td>
+ </tr>
+ <tr>
+ <td>backup_ceph_user = cinder</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>restore_discard_excess_bytes = True</td>
+ <td>(BoolOpt) If True, always discard excess bytes when restoring volumes i.e. pad with zeroes.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-backups_swift.xml b/doc/common/tables/cinder-backups_swift.xml
index f34187bace..b19f2f7620 100644
--- a/doc/common/tables/cinder-backups_swift.xml
+++ b/doc/common/tables/cinder-backups_swift.xml
@@ -1,55 +1,54 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_backups_swift">
- <caption>Description of configuration options for backups_swift</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>backup_swift_auth = per_user</td>
- <td>(StrOpt) Swift authentication mechanism</td>
- </tr>
- <tr>
- <td>backup_swift_container = volumebackups</td>
- <td>(StrOpt) The default Swift container to use</td>
- </tr>
- <tr>
- <td>backup_swift_key = None</td>
- <td>(StrOpt) Swift key for authentication</td>
- </tr>
- <tr>
- <td>backup_swift_object_size = 52428800</td>
- <td>(IntOpt) The size in bytes of Swift backup objects</td>
- </tr>
- <tr>
- <td>backup_swift_retry_attempts = 3</td>
- <td>(IntOpt) The number of retries to make for Swift operations</td>
- </tr>
- <tr>
- <td>backup_swift_retry_backoff = 2</td>
- <td>(IntOpt) The backoff time in seconds between Swift retries</td>
- </tr>
- <tr>
- <td>backup_swift_url = http://localhost:8080/v1/AUTH_</td>
- <td>(StrOpt) The URL of the Swift endpoint</td>
- </tr>
- <tr>
- <td>backup_swift_user = None</td>
- <td>(StrOpt) Swift user name</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_backups_swift">
+ <caption>Description of configuration options for backups_swift</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>backup_swift_auth = per_user</td>
+ <td>(StrOpt) Swift authentication mechanism</td>
+ </tr>
+ <tr>
+ <td>backup_swift_container = volumebackups</td>
+ <td>(StrOpt) The default Swift container to use</td>
+ </tr>
+ <tr>
+ <td>backup_swift_key = None</td>
+ <td>(StrOpt) Swift key for authentication</td>
+ </tr>
+ <tr>
+ <td>backup_swift_object_size = 52428800</td>
+ <td>(IntOpt) The size in bytes of Swift backup objects</td>
+ </tr>
+ <tr>
+ <td>backup_swift_retry_attempts = 3</td>
+ <td>(IntOpt) The number of retries to make for Swift operations</td>
+ </tr>
+ <tr>
+ <td>backup_swift_retry_backoff = 2</td>
+ <td>(IntOpt) The backoff time in seconds between Swift retries</td>
+ </tr>
+ <tr>
+ <td>backup_swift_url = http://localhost:8080/v1/AUTH_</td>
+ <td>(StrOpt) The URL of the Swift endpoint</td>
+ </tr>
+ <tr>
+ <td>backup_swift_user = None</td>
+ <td>(StrOpt) Swift user name</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-backups_tsm.xml b/doc/common/tables/cinder-backups_tsm.xml
index db47b26503..21b0a7e547 100644
--- a/doc/common/tables/cinder-backups_tsm.xml
+++ b/doc/common/tables/cinder-backups_tsm.xml
@@ -1,35 +1,34 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_backups_tsm">
- <caption>Description of configuration options for backups_tsm</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>backup_tsm_compression = True</td>
- <td>(BoolOpt) Enable or Disable compression for backups</td>
- </tr>
- <tr>
- <td>backup_tsm_password = password</td>
- <td>(StrOpt) TSM password for the running username</td>
- </tr>
- <tr>
- <td>backup_tsm_volume_prefix = backup</td>
- <td>(StrOpt) Volume prefix for the backup id when backing up to TSM</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_backups_tsm">
+ <caption>Description of configuration options for backups_tsm</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>backup_tsm_compression = True</td>
+ <td>(BoolOpt) Enable or Disable compression for backups</td>
+ </tr>
+ <tr>
+ <td>backup_tsm_password = password</td>
+ <td>(StrOpt) TSM password for the running username</td>
+ </tr>
+ <tr>
+ <td>backup_tsm_volume_prefix = backup</td>
+ <td>(StrOpt) Volume prefix for the backup id when backing up to TSM</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-block-device.xml b/doc/common/tables/cinder-block-device.xml
index 21393b9d02..4e1c65f9d7 100644
--- a/doc/common/tables/cinder-block-device.xml
+++ b/doc/common/tables/cinder-block-device.xml
@@ -1,27 +1,26 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_block-device">
- <caption>Description of configuration options for block-device</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>available_devices = </td>
- <td>(ListOpt) List of all available devices</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_block-device">
+ <caption>Description of configuration options for block-device</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>available_devices = </td>
+ <td>(ListOpt) List of all available devices</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-common.xml b/doc/common/tables/cinder-common.xml
index 3dcc0784a9..e62fe6fd9c 100644
--- a/doc/common/tables/cinder-common.xml
+++ b/doc/common/tables/cinder-common.xml
@@ -1,242 +1,230 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_common">
- <caption>Description of configuration options for common</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>compute_api_class = cinder.compute.nova.API</td>
- <td>(StrOpt) The full class name of the compute API class to use</td>
- </tr>
- <tr>
- <td>debug = False</td>
- <td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).</td>
- </tr>
- <tr>
- <td>default_availability_zone = None</td>
- <td>(StrOpt) default availability zone to use when creating a new volume. If this is not set then we use the value from the storage_availability_zone option as the default availability_zone for new volumes.</td>
- </tr>
- <tr>
- <td>default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN</td>
- <td>(ListOpt) List of logger=LEVEL pairs</td>
- </tr>
- <tr>
- <td>default_volume_type = None</td>
- <td>(StrOpt) default volume type to use</td>
- </tr>
- <tr>
- <td>disable_process_locking = False</td>
- <td>(BoolOpt) Whether to disable inter-process locks</td>
- </tr>
- <tr>
- <td>enable_new_services = True</td>
- <td>(BoolOpt) Services to be added to the available pool on create</td>
- </tr>
- <tr>
- <td>fatal_deprecations = False</td>
- <td>(BoolOpt) Make deprecations fatal</td>
- </tr>
- <tr>
- <td>fatal_exception_format_errors = False</td>
- <td>(BoolOpt) make exception message format errors fatal</td>
- </tr>
- <tr>
- <td>host = oslo</td>
- <td>(StrOpt) Name of this node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address.</td>
- </tr>
- <tr>
- <td>iet_conf = /etc/iet/ietd.conf</td>
- <td>(StrOpt) IET configuration file</td>
- </tr>
- <tr>
- <td>lio_initiator_iqns = </td>
- <td>(StrOpt) Comma-separated list of initiator IQNs allowed to connect to the iSCSI target. (From Nova compute nodes.)</td>
- </tr>
- <tr>
- <td>lock_path = None</td>
- <td>(StrOpt) Directory to use for lock files. Default to a temp directory</td>
- </tr>
- <tr>
- <td>log_config_append = None</td>
- <td>(StrOpt) The name of logging configuration file. It does not disable existing loggers, but just appends specified logging configuration to any other existing logging options. Please see the Python logging module documentation for details on logging configuration files.</td>
- </tr>
- <tr>
- <td>log_date_format = %Y-%m-%d %H:%M:%S</td>
- <td>(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s</td>
- </tr>
- <tr>
- <td>log_dir = None</td>
- <td>(StrOpt) (Optional) The base directory used for relative --log-file paths</td>
- </tr>
- <tr>
- <td>log_file = None</td>
- <td>(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.</td>
- </tr>
- <tr>
- <td>log_format = None</td>
- <td>(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.</td>
- </tr>
- <tr>
- <td>logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s</td>
- <td>(StrOpt) Format string to use for log messages with context</td>
- </tr>
- <tr>
- <td>logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d</td>
- <td>(StrOpt) Data to append to log format when level is DEBUG</td>
- </tr>
- <tr>
- <td>logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s</td>
- <td>(StrOpt) Format string to use for log messages without context</td>
- </tr>
- <tr>
- <td>logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s</td>
- <td>(StrOpt) Prefix each line of exception output with this format</td>
- </tr>
- <tr>
- <td>monkey_patch = False</td>
- <td>(BoolOpt) Enable monkey patching</td>
- </tr>
- <tr>
- <td>monkey_patch_modules = </td>
- <td>(ListOpt) List of modules/decorators to monkey patch</td>
- </tr>
- <tr>
- <td>my_ip = 10.0.0.1</td>
- <td>(StrOpt) ip address of this host</td>
- </tr>
- <tr>
- <td>no_snapshot_gb_quota = False</td>
- <td>(BoolOpt) Whether snapshots count against GigaByte quota</td>
- </tr>
- <tr>
- <td>num_shell_tries = 3</td>
- <td>(IntOpt) number of times to attempt to run flakey shell commands</td>
- </tr>
- <tr>
- <td>periodic_fuzzy_delay = 60</td>
- <td>(IntOpt) range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0)</td>
- </tr>
- <tr>
- <td>periodic_interval = 60</td>
- <td>(IntOpt) seconds between running periodic tasks</td>
- </tr>
- <tr>
- <td>policy_default_rule = default</td>
- <td>(StrOpt) Rule checked when requested rule is not found</td>
- </tr>
- <tr>
- <td>policy_file = policy.json</td>
- <td>(StrOpt) JSON file representing policy</td>
- </tr>
- <tr>
- <td>report_interval = 10</td>
- <td>(IntOpt) seconds between nodes reporting state to datastore</td>
- </tr>
- <tr>
- <td>reserved_percentage = 0</td>
- <td>(IntOpt) The percentage of backend capacity is reserved</td>
- </tr>
- <tr>
- <td>rootwrap_config = /etc/cinder/rootwrap.conf</td>
- <td>(StrOpt) Path to the rootwrap configuration file to use for running commands as root</td>
- </tr>
- <tr>
- <td>run_external_periodic_tasks = True</td>
- <td>(BoolOpt) Some periodic tasks can be run in a separate process. Should we run them here?</td>
- </tr>
- <tr>
- <td>service_down_time = 60</td>
- <td>(IntOpt) maximum time since last check-in for up service</td>
- </tr>
- <tr>
- <td>sqlite_db = cinder.sqlite</td>
- <td>(StrOpt) the filename to use with sqlite</td>
- </tr>
- <tr>
- <td>sqlite_synchronous = True</td>
- <td>(BoolOpt) If true, use synchronous mode for sqlite</td>
- </tr>
- <tr>
- <td>ssl_ca_file = None</td>
- <td>(StrOpt) CA certificate file to use to verify connecting clients</td>
- </tr>
- <tr>
- <td>ssl_cert_file = None</td>
- <td>(StrOpt) Certificate file to use when starting the server securely</td>
- </tr>
- <tr>
- <td>ssl_key_file = None</td>
- <td>(StrOpt) Private key file to use when starting the server securely</td>
- </tr>
- <tr>
- <td>state_path = /var/lib/cinder</td>
- <td>(StrOpt) Top-level directory for maintaining cinder's state</td>
- </tr>
- <tr>
- <td>storage_availability_zone = nova</td>
- <td>(StrOpt) availability zone of this node</td>
- </tr>
- <tr>
- <td>syslog_log_facility = LOG_USER</td>
- <td>(StrOpt) Syslog facility to receive log lines</td>
- </tr>
- <tr>
- <td>tcp_keepidle = 600</td>
- <td>(IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X.</td>
- </tr>
- <tr>
- <td>until_refresh = 0</td>
- <td>(IntOpt) count of reservations until usage is refreshed</td>
- </tr>
- <tr>
- <td>use_forwarded_for = False</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>use_stderr = True</td>
- <td>(BoolOpt) Log output to standard error</td>
- </tr>
- <tr>
- <td>use_syslog = False</td>
- <td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and then will be changed in J to honor RFC5424</td>
- </tr>
- <tr>
- <td>use_syslog_rfc_format = False</td>
- <td>(BoolOpt) (Optional) Use syslog rfc5424 format for logging. If enabled, will add APP-NAME (RFC5424) before the MSG part of the syslog message. The old format without APP-NAME is deprecated in I, and will be removed in J.</td>
- </tr>
- <tr>
- <td>verbose = False</td>
- <td>(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).</td>
- </tr>
- <tr>
- <th colspan="2">[database]</th>
- </tr>
- <tr>
- <td>idle_timeout = 3600</td>
- <td>(IntOpt) timeout before idle sql connections are reaped</td>
- </tr>
- <tr>
- <td>retry_interval = 10</td>
- <td>(IntOpt) interval between retries of opening a sql connection</td>
- </tr>
- <tr>
- <td>use_tpool = False</td>
- <td>(BoolOpt) Enable the experimental use of thread pooling for all DB API calls</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_common">
+ <caption>Description of configuration options for common</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>compute_api_class = cinder.compute.nova.API</td>
+ <td>(StrOpt) The full class name of the compute API class to use</td>
+ </tr>
+ <tr>
+ <td>debug = False</td>
+ <td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).</td>
+ </tr>
+ <tr>
+ <td>default_availability_zone = None</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>default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN</td>
+ <td>(ListOpt) List of logger=LEVEL pairs.</td>
+ </tr>
+ <tr>
+ <td>default_volume_type = None</td>
+ <td>(StrOpt) Default volume type to use</td>
+ </tr>
+ <tr>
+ <td>disable_process_locking = False</td>
+ <td>(BoolOpt) Whether to disable inter-process locks</td>
+ </tr>
+ <tr>
+ <td>enable_new_services = True</td>
+ <td>(BoolOpt) Services to be added to the available pool on create</td>
+ </tr>
+ <tr>
+ <td>fatal_deprecations = False</td>
+ <td>(BoolOpt) Enables or disables fatal status of deprecations.</td>
+ </tr>
+ <tr>
+ <td>fatal_exception_format_errors = False</td>
+ <td>(BoolOpt) make exception message format errors fatal</td>
+ </tr>
+ <tr>
+ <td>host = oslo</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>iet_conf = /etc/iet/ietd.conf</td>
+ <td>(StrOpt) IET configuration file</td>
+ </tr>
+ <tr>
+ <td>lio_initiator_iqns = </td>
+ <td>(StrOpt) Comma-separated list of initiator IQNs allowed to connect to the iSCSI target. (From Nova compute nodes.)</td>
+ </tr>
+ <tr>
+ <td>lock_path = None</td>
+ <td>(StrOpt) Directory to use for lock files. Default to a temp directory</td>
+ </tr>
+ <tr>
+ <td>log_config_append = None</td>
+ <td>(StrOpt) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation.</td>
+ </tr>
+ <tr>
+ <td>log_date_format = %Y-%m-%d %H:%M:%S</td>
+ <td>(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s .</td>
+ </tr>
+ <tr>
+ <td>log_dir = None</td>
+ <td>(StrOpt) (Optional) The base directory used for relative --log-file paths.</td>
+ </tr>
+ <tr>
+ <td>log_file = None</td>
+ <td>(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.</td>
+ </tr>
+ <tr>
+ <td>log_format = None</td>
+ <td>(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.</td>
+ </tr>
+ <tr>
+ <td>logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s</td>
+ <td>(StrOpt) Format string to use for log messages with context.</td>
+ </tr>
+ <tr>
+ <td>logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d</td>
+ <td>(StrOpt) Data to append to log format when level is DEBUG.</td>
+ </tr>
+ <tr>
+ <td>logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s</td>
+ <td>(StrOpt) Format string to use for log messages without context.</td>
+ </tr>
+ <tr>
+ <td>logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s</td>
+ <td>(StrOpt) Prefix each line of exception output with this format.</td>
+ </tr>
+ <tr>
+ <td>monkey_patch = False</td>
+ <td>(BoolOpt) Enable monkey patching</td>
+ </tr>
+ <tr>
+ <td>monkey_patch_modules = </td>
+ <td>(ListOpt) List of modules/decorators to monkey patch</td>
+ </tr>
+ <tr>
+ <td>my_ip = 10.0.0.1</td>
+ <td>(StrOpt) IP address of this host</td>
+ </tr>
+ <tr>
+ <td>no_snapshot_gb_quota = False</td>
+ <td>(BoolOpt) Whether snapshots count against GigaByte quota</td>
+ </tr>
+ <tr>
+ <td>num_shell_tries = 3</td>
+ <td>(IntOpt) Number of times to attempt to run flakey shell commands</td>
+ </tr>
+ <tr>
+ <td>periodic_fuzzy_delay = 60</td>
+ <td>(IntOpt) Range, in seconds, to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0)</td>
+ </tr>
+ <tr>
+ <td>periodic_interval = 60</td>
+ <td>(IntOpt) Interval, in seconds, between running periodic tasks</td>
+ </tr>
+ <tr>
+ <td>policy_default_rule = default</td>
+ <td>(StrOpt) Rule checked when requested rule is not found</td>
+ </tr>
+ <tr>
+ <td>policy_file = policy.json</td>
+ <td>(StrOpt) JSON file representing policy</td>
+ </tr>
+ <tr>
+ <td>report_interval = 10</td>
+ <td>(IntOpt) Interval, in seconds, between nodes reporting state to datastore</td>
+ </tr>
+ <tr>
+ <td>reserved_percentage = 0</td>
+ <td>(IntOpt) The percentage of backend capacity is reserved</td>
+ </tr>
+ <tr>
+ <td>rootwrap_config = /etc/cinder/rootwrap.conf</td>
+ <td>(StrOpt) Path to the rootwrap configuration file to use for running commands as root</td>
+ </tr>
+ <tr>
+ <td>run_external_periodic_tasks = True</td>
+ <td>(BoolOpt) Some periodic tasks can be run in a separate process. Should we run them here?</td>
+ </tr>
+ <tr>
+ <td>service_down_time = 60</td>
+ <td>(IntOpt) Maximum time since last check-in for a service to be considered up</td>
+ </tr>
+ <tr>
+ <td>ssl_ca_file = None</td>
+ <td>(StrOpt) CA certificate file to use to verify connecting clients</td>
+ </tr>
+ <tr>
+ <td>ssl_cert_file = None</td>
+ <td>(StrOpt) Certificate file to use when starting the server securely</td>
+ </tr>
+ <tr>
+ <td>ssl_key_file = None</td>
+ <td>(StrOpt) Private key file to use when starting the server securely</td>
+ </tr>
+ <tr>
+ <td>state_path = /var/lib/cinder</td>
+ <td>(StrOpt) Top-level directory for maintaining cinder's state</td>
+ </tr>
+ <tr>
+ <td>storage_availability_zone = nova</td>
+ <td>(StrOpt) Availability zone of this node</td>
+ </tr>
+ <tr>
+ <td>syslog_log_facility = LOG_USER</td>
+ <td>(StrOpt) Syslog facility to receive log lines.</td>
+ </tr>
+ <tr>
+ <td>tcp_keepalive = True</td>
+ <td>(BoolOpt) Sets the value of TCP_KEEPALIVE (True/False) for each server socket.</td>
+ </tr>
+ <tr>
+ <td>tcp_keepalive_count = None</td>
+ <td>(IntOpt) Sets the value of TCP_KEEPCNT for each server socket. Not supported on OS X.</td>
+ </tr>
+ <tr>
+ <td>tcp_keepalive_interval = None</td>
+ <td>(IntOpt) Sets the value of TCP_KEEPINTVL in seconds for each server socket. Not supported on OS X.</td>
+ </tr>
+ <tr>
+ <td>tcp_keepidle = 600</td>
+ <td>(IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X.</td>
+ </tr>
+ <tr>
+ <td>until_refresh = 0</td>
+ <td>(IntOpt) Count of reservations until usage is refreshed</td>
+ </tr>
+ <tr>
+ <td>use_forwarded_for = False</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>use_stderr = True</td>
+ <td>(BoolOpt) Log output to standard error.</td>
+ </tr>
+ <tr>
+ <td>use_syslog = False</td>
+ <td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will chang in J to honor RFC5424.</td>
+ </tr>
+ <tr>
+ <td>use_syslog_rfc_format = False</td>
+ <td>(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in I, and will be removed in J.</td>
+ </tr>
+ <tr>
+ <td>verbose = False</td>
+ <td>(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-compute.xml b/doc/common/tables/cinder-compute.xml
index 2d203eef8f..1716a4b2fc 100644
--- a/doc/common/tables/cinder-compute.xml
+++ b/doc/common/tables/cinder-compute.xml
@@ -1,51 +1,50 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_compute">
- <caption>Description of configuration options for compute</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>nova_api_insecure = False</td>
- <td>(BoolOpt) Allow to perform insecure SSL requests to nova</td>
- </tr>
- <tr>
- <td>nova_ca_certificates_file = None</td>
- <td>(StrOpt) Location of ca certificates file to use for nova client requests.</td>
- </tr>
- <tr>
- <td>nova_catalog_admin_info = compute:nova:adminURL</td>
- <td>(StrOpt) Same as nova_catalog_info, but for admin endpoint.</td>
- </tr>
- <tr>
- <td>nova_catalog_info = compute:nova:publicURL</td>
- <td>(StrOpt) Info to match when looking for nova in the service catalog. Format is : separated values of the form: <service_type>:<service_name>:<endpoint_type></td>
- </tr>
- <tr>
- <td>nova_endpoint_admin_template = None</td>
- <td>(StrOpt) Same as nova_endpoint_template, but for admin endpoint.</td>
- </tr>
- <tr>
- <td>nova_endpoint_template = None</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>os_region_name = None</td>
- <td>(StrOpt) region name of this node</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_compute">
+ <caption>Description of configuration options for compute</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>nova_api_insecure = False</td>
+ <td>(BoolOpt) Allow to perform insecure SSL requests to nova</td>
+ </tr>
+ <tr>
+ <td>nova_ca_certificates_file = None</td>
+ <td>(StrOpt) Location of ca certificates file to use for nova client requests.</td>
+ </tr>
+ <tr>
+ <td>nova_catalog_admin_info = compute:nova:adminURL</td>
+ <td>(StrOpt) Same as nova_catalog_info, but for admin endpoint.</td>
+ </tr>
+ <tr>
+ <td>nova_catalog_info = compute:nova:publicURL</td>
+ <td>(StrOpt) Match this value when searching for nova in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:<endpoint_type></td>
+ </tr>
+ <tr>
+ <td>nova_endpoint_admin_template = None</td>
+ <td>(StrOpt) Same as nova_endpoint_template, but for admin endpoint.</td>
+ </tr>
+ <tr>
+ <td>nova_endpoint_template = None</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>os_region_name = None</td>
+ <td>(StrOpt) Region name of this node</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-connection.xml b/doc/common/tables/cinder-connection.xml
deleted file mode 100644
index 5b95a79392..0000000000
--- a/doc/common/tables/cinder-connection.xml
+++ /dev/null
@@ -1,35 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_connection">
- <caption>Description of configuration options for connection</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>connection = sqlite:///$state_path/$sqlite_db</td>
- <td>(StrOpt) The SQLAlchemy connection string used to connect to the database</td>
- </tr>
- <tr>
- <td>connection_debug = 0</td>
- <td>(IntOpt) Verbosity of SQL debugging information. 0=None, 100=Everything</td>
- </tr>
- <tr>
- <td>connection_trace = False</td>
- <td>(BoolOpt) Add python stack traces to SQL as comment strings</td>
- </tr>
- </tbody>
- </table>
- </para>
diff --git a/doc/common/tables/cinder-coraid.xml b/doc/common/tables/cinder-coraid.xml
index c7f9528264..e097a6336b 100644
--- a/doc/common/tables/cinder-coraid.xml
+++ b/doc/common/tables/cinder-coraid.xml
@@ -1,43 +1,42 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_coraid">
- <caption>Description of configuration options for coraid</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>coraid_esm_address = </td>
- <td>(StrOpt) IP address of Coraid ESM</td>
- </tr>
- <tr>
- <td>coraid_group = admin</td>
- <td>(StrOpt) Name of group on Coraid ESM to which coraid_user belongs (must have admin privilege)</td>
- </tr>
- <tr>
- <td>coraid_password = password</td>
- <td>(StrOpt) Password to connect to Coraid ESM</td>
- </tr>
- <tr>
- <td>coraid_repository_key = coraid_repository</td>
- <td>(StrOpt) Volume Type key name to store ESM Repository Name</td>
- </tr>
- <tr>
- <td>coraid_user = admin</td>
- <td>(StrOpt) User name to connect to Coraid ESM</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_coraid">
+ <caption>Description of configuration options for coraid</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>coraid_esm_address = </td>
+ <td>(StrOpt) IP address of Coraid ESM</td>
+ </tr>
+ <tr>
+ <td>coraid_group = admin</td>
+ <td>(StrOpt) Name of group on Coraid ESM to which coraid_user belongs (must have admin privilege)</td>
+ </tr>
+ <tr>
+ <td>coraid_password = password</td>
+ <td>(StrOpt) Password to connect to Coraid ESM</td>
+ </tr>
+ <tr>
+ <td>coraid_repository_key = coraid_repository</td>
+ <td>(StrOpt) Volume Type key name to store ESM Repository Name</td>
+ </tr>
+ <tr>
+ <td>coraid_user = admin</td>
+ <td>(StrOpt) User name to connect to Coraid ESM</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-database.xml b/doc/common/tables/cinder-database.xml
index 274aa09422..5ea2843814 100644
--- a/doc/common/tables/cinder-database.xml
+++ b/doc/common/tables/cinder-database.xml
@@ -1,31 +1,117 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_database">
- <caption>Description of configuration options for database</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>db_backend = sqlalchemy</td>
- <td>(StrOpt) The backend to use for db</td>
- </tr>
- <tr>
- <td>db_driver = cinder.db</td>
- <td>(StrOpt) driver to use for database access</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_database">
+ <caption>Description of configuration options for database</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>db_backend = sqlalchemy</td>
+ <td>(StrOpt) The backend to use for db</td>
+ </tr>
+ <tr>
+ <td>db_driver = cinder.db</td>
+ <td>(StrOpt) Driver to use for database access</td>
+ </tr>
+ <tr>
+ <td>sqlite_clean_db = clean.sqlite</td>
+ <td>(StrOpt) File name of clean sqlite db</td>
+ </tr>
+ <tr>
+ <th colspan="2">[database]</th>
+ </tr>
+ <tr>
+ <td>backend = sqlalchemy</td>
+ <td>(StrOpt) The backend to use for db</td>
+ </tr>
+ <tr>
+ <td>connection = sqlite:///$state_path/$sqlite_db</td>
+ <td>(StrOpt) The SQLAlchemy connection string used to connect to the database</td>
+ </tr>
+ <tr>
+ <td>connection_debug = 0</td>
+ <td>(IntOpt) Verbosity of SQL debugging information. 0=None, 100=Everything</td>
+ </tr>
+ <tr>
+ <td>connection_trace = False</td>
+ <td>(BoolOpt) Add python stack traces to SQL as comment strings</td>
+ </tr>
+ <tr>
+ <td>db_inc_retry_interval = True</td>
+ <td>(BoolOpt) Whether to increase interval between db connection retries, up to db_max_retry_interval</td>
+ </tr>
+ <tr>
+ <td>db_max_retries = 20</td>
+ <td>(IntOpt) maximum db connection retries before error is raised. (setting -1 implies an infinite retry count)</td>
+ </tr>
+ <tr>
+ <td>db_max_retry_interval = 10</td>
+ <td>(IntOpt) max seconds between db connection retries, if db_inc_retry_interval is enabled</td>
+ </tr>
+ <tr>
+ <td>db_retry_interval = 1</td>
+ <td>(IntOpt) seconds between db connection retries</td>
+ </tr>
+ <tr>
+ <td>idle_timeout = 3600</td>
+ <td>(IntOpt) Timeout before idle sql connections are reaped</td>
+ </tr>
+ <tr>
+ <td>max_overflow = None</td>
+ <td>(IntOpt) If set, use this value for max_overflow with sqlalchemy</td>
+ </tr>
+ <tr>
+ <td>max_pool_size = None</td>
+ <td>(IntOpt) Maximum number of SQL connections to keep open in a pool</td>
+ </tr>
+ <tr>
+ <td>max_retries = 10</td>
+ <td>(IntOpt) Maximum db connection retries during startup. (setting -1 implies an infinite retry count)</td>
+ </tr>
+ <tr>
+ <td>min_pool_size = 1</td>
+ <td>(IntOpt) Minimum number of SQL connections to keep open in a pool</td>
+ </tr>
+ <tr>
+ <td>mysql_sql_mode = TRADITIONAL</td>
+ <td>(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=</td>
+ </tr>
+ <tr>
+ <td>pool_timeout = None</td>
+ <td>(IntOpt) If set, use this value for pool_timeout with sqlalchemy</td>
+ </tr>
+ <tr>
+ <td>retry_interval = 10</td>
+ <td>(IntOpt) Interval between retries of opening a sql connection</td>
+ </tr>
+ <tr>
+ <td>sqlite_db = cinder.sqlite</td>
+ <td>(StrOpt) The file name to use with SQLite</td>
+ </tr>
+ <tr>
+ <td>sqlite_synchronous = True</td>
+ <td>(BoolOpt) If True, SQLite uses synchronous mode</td>
+ </tr>
+ <tr>
+ <td>use_db_reconnect = False</td>
+ <td>(BoolOpt) Enable the experimental use of database reconnect on connection lost</td>
+ </tr>
+ <tr>
+ <td>use_tpool = False</td>
+ <td>(BoolOpt) Enable the experimental use of thread pooling for all DB API calls</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-emc.xml b/doc/common/tables/cinder-emc.xml
index 4eb6c91b7c..145d42083b 100644
--- a/doc/common/tables/cinder-emc.xml
+++ b/doc/common/tables/cinder-emc.xml
@@ -1,39 +1,38 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_emc">
- <caption>Description of configuration options for emc</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>cinder_emc_config_file = /etc/cinder/cinder_emc_config.xml</td>
- <td>(StrOpt) use this file for cinder emc plugin config data</td>
- </tr>
- <tr>
- <td>max_luns_per_storage_group = 256</td>
- <td>(IntOpt) Default max number of LUNs in a storage group</td>
- </tr>
- <tr>
- <td>naviseccli_path = </td>
- <td>(StrOpt) Naviseccli Path</td>
- </tr>
- <tr>
- <td>storage_vnx_pool_name = None</td>
- <td>(StrOpt) ISCSI pool name</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_emc">
+ <caption>Description of configuration options for emc</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>cinder_emc_config_file = /etc/cinder/cinder_emc_config.xml</td>
+ <td>(StrOpt) The configuration file for the Cinder EMC driver</td>
+ </tr>
+ <tr>
+ <td>max_luns_per_storage_group = 256</td>
+ <td>(IntOpt) Default max number of LUNs in a storage group</td>
+ </tr>
+ <tr>
+ <td>naviseccli_path = </td>
+ <td>(StrOpt) Naviseccli Path</td>
+ </tr>
+ <tr>
+ <td>storage_vnx_pool_name = None</td>
+ <td>(StrOpt) ISCSI pool name</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-eqlx.xml b/doc/common/tables/cinder-eqlx.xml
index 52cc9ad981..6e29bfbc3a 100644
--- a/doc/common/tables/cinder-eqlx.xml
+++ b/doc/common/tables/cinder-eqlx.xml
@@ -1,51 +1,50 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_eqlx">
- <caption>Description of configuration options for eqlx</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>eqlx_chap_login = admin</td>
- <td>(StrOpt) Existing CHAP account name</td>
- </tr>
- <tr>
- <td>eqlx_chap_password = password</td>
- <td>(StrOpt) Password for specified CHAP account name</td>
- </tr>
- <tr>
- <td>eqlx_cli_max_retries = 5</td>
- <td>(IntOpt) Maximum retry count for reconnection</td>
- </tr>
- <tr>
- <td>eqlx_cli_timeout = 30</td>
- <td>(IntOpt) Timeout for the Group Manager cli command execution</td>
- </tr>
- <tr>
- <td>eqlx_group_name = group-0</td>
- <td>(StrOpt) Group name to use for creating volumes</td>
- </tr>
- <tr>
- <td>eqlx_pool = default</td>
- <td>(StrOpt) Pool in which volumes will be created</td>
- </tr>
- <tr>
- <td>eqlx_use_chap = False</td>
- <td>(BoolOpt) Use CHAP authentication for targets?</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_eqlx">
+ <caption>Description of configuration options for eqlx</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>eqlx_chap_login = admin</td>
+ <td>(StrOpt) Existing CHAP account name</td>
+ </tr>
+ <tr>
+ <td>eqlx_chap_password = password</td>
+ <td>(StrOpt) Password for specified CHAP account name</td>
+ </tr>
+ <tr>
+ <td>eqlx_cli_max_retries = 5</td>
+ <td>(IntOpt) Maximum retry count for reconnection</td>
+ </tr>
+ <tr>
+ <td>eqlx_cli_timeout = 30</td>
+ <td>(IntOpt) Timeout for the Group Manager cli command execution</td>
+ </tr>
+ <tr>
+ <td>eqlx_group_name = group-0</td>
+ <td>(StrOpt) Group name to use for creating volumes</td>
+ </tr>
+ <tr>
+ <td>eqlx_pool = default</td>
+ <td>(StrOpt) Pool in which volumes will be created</td>
+ </tr>
+ <tr>
+ <td>eqlx_use_chap = False</td>
+ <td>(BoolOpt) Use CHAP authentication for targets?</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-hds-hus.xml b/doc/common/tables/cinder-hds-hus.xml
index 509fb69a93..46ab33b4d0 100644
--- a/doc/common/tables/cinder-hds-hus.xml
+++ b/doc/common/tables/cinder-hds-hus.xml
@@ -1,27 +1,34 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_hds-hus">
- <caption>Description of configuration options for hds-hus</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>hds_cinder_config_file = /opt/hds/hus/cinder_hus_conf.xml</td>
- <td>(StrOpt) configuration file for HDS cinder plugin for HUS</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_hds-hus">
+ <caption>Description of configuration options for hds-hus</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>hds_cinder_config_file = /opt/hds/hus/cinder_hus_conf.xml</td>
+ <td>(StrOpt) The configuration file for the Cinder HDS driver for HUS</td>
+ </tr>
+ <tr>
+ <td>hds_hnas_iscsi_config_file = /opt/hds/hnas/cinder_iscsi_conf.xml</td>
+ <td>(StrOpt) configuration file for HDS iSCSI cinder plugin</td>
+ </tr>
+ <tr>
+ <td>hds_hnas_nfs_config_file = /opt/hds/hnas/cinder_nfs_conf.xml</td>
+ <td>(StrOpt) configuration file for HDS NFS cinder plugin</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-hp3par.xml b/doc/common/tables/cinder-hp3par.xml
index 6b6cd3a05d..bbe2c48c00 100644
--- a/doc/common/tables/cinder-hp3par.xml
+++ b/doc/common/tables/cinder-hp3par.xml
@@ -1,59 +1,58 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_hp3par">
- <caption>Description of configuration options for hp3par</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>hp3par_api_url = </td>
- <td>(StrOpt) 3PAR WSAPI Server Url like https://<3par ip>:8080/api/v1</td>
- </tr>
- <tr>
- <td>hp3par_cpg = OpenStack</td>
- <td>(StrOpt) The CPG to use for volume creation</td>
- </tr>
- <tr>
- <td>hp3par_cpg_snap = </td>
- <td>(StrOpt) The CPG to use for Snapshots for volumes. If empty hp3par_cpg will be used</td>
- </tr>
- <tr>
- <td>hp3par_debug = False</td>
- <td>(BoolOpt) Enable HTTP debugging to 3PAR</td>
- </tr>
- <tr>
- <td>hp3par_iscsi_ips = </td>
- <td>(ListOpt) List of target iSCSI addresses to use.</td>
- </tr>
- <tr>
- <td>hp3par_password = </td>
- <td>(StrOpt) 3PAR Super user password</td>
- </tr>
- <tr>
- <td>hp3par_snapshot_expiration = </td>
- <td>(StrOpt) The time in hours when a snapshot expires and is deleted. This must be larger than expiration</td>
- </tr>
- <tr>
- <td>hp3par_snapshot_retention = </td>
- <td>(StrOpt) The time in hours to retain a snapshot. You can't delete it before this expires.</td>
- </tr>
- <tr>
- <td>hp3par_username = </td>
- <td>(StrOpt) 3PAR Super user username</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_hp3par">
+ <caption>Description of configuration options for hp3par</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>hp3par_api_url = </td>
+ <td>(StrOpt) 3PAR WSAPI Server Url like https://<3par ip>:8080/api/v1</td>
+ </tr>
+ <tr>
+ <td>hp3par_cpg = OpenStack</td>
+ <td>(StrOpt) The CPG to use for volume creation</td>
+ </tr>
+ <tr>
+ <td>hp3par_cpg_snap = </td>
+ <td>(StrOpt) The CPG to use for Snapshots for volumes. If empty hp3par_cpg will be used</td>
+ </tr>
+ <tr>
+ <td>hp3par_debug = False</td>
+ <td>(BoolOpt) Enable HTTP debugging to 3PAR</td>
+ </tr>
+ <tr>
+ <td>hp3par_iscsi_ips = </td>
+ <td>(ListOpt) List of target iSCSI addresses to use.</td>
+ </tr>
+ <tr>
+ <td>hp3par_password = </td>
+ <td>(StrOpt) 3PAR Super user password</td>
+ </tr>
+ <tr>
+ <td>hp3par_snapshot_expiration = </td>
+ <td>(StrOpt) The time in hours when a snapshot expires and is deleted. This must be larger than expiration</td>
+ </tr>
+ <tr>
+ <td>hp3par_snapshot_retention = </td>
+ <td>(StrOpt) The time in hours to retain a snapshot. You can't delete it before this expires.</td>
+ </tr>
+ <tr>
+ <td>hp3par_username = </td>
+ <td>(StrOpt) 3PAR Super user username</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-hplefthand.xml b/doc/common/tables/cinder-hplefthand.xml
index 5bf2ad3a1e..eee442fcf0 100644
--- a/doc/common/tables/cinder-hplefthand.xml
+++ b/doc/common/tables/cinder-hplefthand.xml
@@ -1,47 +1,46 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_hplefthand">
- <caption>Description of configuration options for hplefthand</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>hplefthand_api_url = None</td>
- <td>(StrOpt) HP LeftHand WSAPI Server Url like https://<LeftHand ip>:8081/lhos</td>
- </tr>
- <tr>
- <td>hplefthand_clustername = None</td>
- <td>(StrOpt) HP LeftHand cluster name</td>
- </tr>
- <tr>
- <td>hplefthand_debug = False</td>
- <td>(BoolOpt) Enable HTTP debugging to LeftHand</td>
- </tr>
- <tr>
- <td>hplefthand_iscsi_chap_enabled = False</td>
- <td>(BoolOpt) Configure CHAP authentication for iSCSI connections (Default: Disabled)</td>
- </tr>
- <tr>
- <td>hplefthand_password = None</td>
- <td>(StrOpt) HP LeftHand Super user password</td>
- </tr>
- <tr>
- <td>hplefthand_username = None</td>
- <td>(StrOpt) HP LeftHand Super user username</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_hplefthand">
+ <caption>Description of configuration options for hplefthand</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>hplefthand_api_url = None</td>
+ <td>(StrOpt) HP LeftHand WSAPI Server Url like https://<LeftHand ip>:8081/lhos</td>
+ </tr>
+ <tr>
+ <td>hplefthand_clustername = None</td>
+ <td>(StrOpt) HP LeftHand cluster name</td>
+ </tr>
+ <tr>
+ <td>hplefthand_debug = False</td>
+ <td>(BoolOpt) Enable HTTP debugging to LeftHand</td>
+ </tr>
+ <tr>
+ <td>hplefthand_iscsi_chap_enabled = False</td>
+ <td>(BoolOpt) Configure CHAP authentication for iSCSI connections (Default: Disabled)</td>
+ </tr>
+ <tr>
+ <td>hplefthand_password = None</td>
+ <td>(StrOpt) HP LeftHand Super user password</td>
+ </tr>
+ <tr>
+ <td>hplefthand_username = None</td>
+ <td>(StrOpt) HP LeftHand Super user username</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-hpmsa.xml b/doc/common/tables/cinder-hpmsa.xml
index 4dd5fb707b..c70b19b1c2 100644
--- a/doc/common/tables/cinder-hpmsa.xml
+++ b/doc/common/tables/cinder-hpmsa.xml
@@ -1,27 +1,26 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_hpmsa">
- <caption>Description of configuration options for hpmsa</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>msa_vdisk = OpenStack</td>
- <td>(StrOpt) The VDisk to use for volume creation.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_hpmsa">
+ <caption>Description of configuration options for hpmsa</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>msa_vdisk = OpenStack</td>
+ <td>(StrOpt) The VDisk to use for volume creation.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-huawei.xml b/doc/common/tables/cinder-huawei.xml
index 321985fca8..e8da14dc94 100644
--- a/doc/common/tables/cinder-huawei.xml
+++ b/doc/common/tables/cinder-huawei.xml
@@ -1,27 +1,26 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_huawei">
- <caption>Description of configuration options for huawei</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>cinder_huawei_conf_file = /etc/cinder/cinder_huawei_conf.xml</td>
- <td>(StrOpt) config data for cinder huawei plugin</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_huawei">
+ <caption>Description of configuration options for huawei</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>cinder_huawei_conf_file = /etc/cinder/cinder_huawei_conf.xml</td>
+ <td>(StrOpt) The configuration file for the Cinder Huawei driver</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-images.xml b/doc/common/tables/cinder-images.xml
index f946bd3bb4..2d147038c3 100644
--- a/doc/common/tables/cinder-images.xml
+++ b/doc/common/tables/cinder-images.xml
@@ -1,75 +1,78 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_images">
- <caption>Description of configuration options for images</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>allowed_direct_url_schemes = </td>
- <td>(ListOpt) A list of url schemes that can be downloaded directly via the direct_url. Currently supported schemes: [file].</td>
- </tr>
- <tr>
- <td>glance_api_insecure = False</td>
- <td>(BoolOpt) Allow to perform insecure SSL (https) requests to glance</td>
- </tr>
- <tr>
- <td>glance_api_servers = $glance_host:$glance_port</td>
- <td>(ListOpt) A list of the glance api servers available to cinder ([hostname|ip]:port)</td>
- </tr>
- <tr>
- <td>glance_api_ssl_compression = False</td>
- <td>(BoolOpt) Whether to attempt to negotiate SSL layer compression when using SSL (https) requests. Set to False to disable SSL layer compression. In some cases disabling this may improve data throughput, eg when high network bandwidth is available and you are using already compressed image formats such as qcow2 .</td>
- </tr>
- <tr>
- <td>glance_api_version = 1</td>
- <td>(IntOpt) Version of the glance api to use</td>
- </tr>
- <tr>
- <td>glance_host = $my_ip</td>
- <td>(StrOpt) default glance hostname or ip</td>
- </tr>
- <tr>
- <td>glance_num_retries = 0</td>
- <td>(IntOpt) Number retries when downloading an image from glance</td>
- </tr>
- <tr>
- <td>glance_port = 9292</td>
- <td>(IntOpt) default glance port</td>
- </tr>
- <tr>
- <td>glance_request_timeout = None</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>image_conversion_dir = $state_path/conversion</td>
- <td>(StrOpt) Directory used for temporary storage during image conversion</td>
- </tr>
- <tr>
- <td>instance_format = "[instance: %(uuid)s] "</td>
- <td>(StrOpt) If an instance is passed with the log message, format it like this</td>
- </tr>
- <tr>
- <td>instance_uuid_format = "[instance: %(uuid)s] "</td>
- <td>(StrOpt) If an instance UUID is passed with the log message, format it like this</td>
- </tr>
- <tr>
- <td>use_multipath_for_image_xfer = False</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>
+<?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_images">
+ <caption>Description of configuration options for images</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>allowed_direct_url_schemes = </td>
+ <td>(ListOpt) A list of url schemes that can be downloaded directly via the direct_url. Currently supported schemes: [file].</td>
+ </tr>
+ <tr>
+ <td>glance_api_insecure = False</td>
+ <td>(BoolOpt) Allow to perform insecure SSL (https) requests to glance</td>
+ </tr>
+ <tr>
+ <td>glance_api_servers = $glance_host:$glance_port</td>
+ <td>(ListOpt) A list of the glance API servers available to cinder ([hostname|ip]:port)</td>
+ </tr>
+ <tr>
+ <td>glance_api_ssl_compression = False</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>glance_api_version = 1</td>
+ <td>(IntOpt) Version of the glance API to use</td>
+ </tr>
+ <tr>
+ <td>glance_core_properties = checksum, container_format, disk_format, image_name, image_id, min_disk, min_ram, name, size</td>
+ <td>(ListOpt) Default core properties of image</td>
+ </tr>
+ <tr>
+ <td>glance_host = $my_ip</td>
+ <td>(StrOpt) Default glance host name or IP</td>
+ </tr>
+ <tr>
+ <td>glance_num_retries = 0</td>
+ <td>(IntOpt) Number retries when downloading an image from glance</td>
+ </tr>
+ <tr>
+ <td>glance_port = 9292</td>
+ <td>(IntOpt) Default glance port</td>
+ </tr>
+ <tr>
+ <td>glance_request_timeout = None</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>image_conversion_dir = $state_path/conversion</td>
+ <td>(StrOpt) Directory used for temporary storage during image conversion</td>
+ </tr>
+ <tr>
+ <td>instance_format = "[instance: %(uuid)s] "</td>
+ <td>(StrOpt) The format for an instance that is passed with the log message. </td>
+ </tr>
+ <tr>
+ <td>instance_uuid_format = "[instance: %(uuid)s] "</td>
+ <td>(StrOpt) The format for an instance UUID that is passed with the log message. </td>
+ </tr>
+ <tr>
+ <td>use_multipath_for_image_xfer = False</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>
diff --git a/doc/common/tables/cinder-keymgr.xml b/doc/common/tables/cinder-keymgr.xml
index 7f87deaa45..67282422f4 100644
--- a/doc/common/tables/cinder-keymgr.xml
+++ b/doc/common/tables/cinder-keymgr.xml
@@ -1,31 +1,30 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_keymgr">
- <caption>Description of configuration options for keymgr</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>api_class = cinder.keymgr.conf_key_mgr.ConfKeyManager</td>
- <td>(StrOpt) The full class name of the key manager API class</td>
- </tr>
- <tr>
- <td>fixed_key = None</td>
- <td>(StrOpt) Fixed key returned by key manager, specified in hex</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_keymgr">
+ <caption>Description of configuration options for keymgr</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>api_class = cinder.keymgr.conf_key_mgr.ConfKeyManager</td>
+ <td>(StrOpt) The full class name of the key manager API class</td>
+ </tr>
+ <tr>
+ <td>fixed_key = None</td>
+ <td>(StrOpt) Fixed key returned by key manager, specified in hex</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-lvm.xml b/doc/common/tables/cinder-lvm.xml
index 39ae7cb963..158aa9783b 100644
--- a/doc/common/tables/cinder-lvm.xml
+++ b/doc/common/tables/cinder-lvm.xml
@@ -1,35 +1,34 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_lvm">
- <caption>Description of configuration options for lvm</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>lvm_mirrors = 0</td>
- <td>(IntOpt) If set, create lvms with multiple mirrors. Note that this requires lvm_mirrors + 2 pvs with available space</td>
- </tr>
- <tr>
- <td>lvm_type = default</td>
- <td>(StrOpt) Type of LVM volumes to deploy; (default or thin)</td>
- </tr>
- <tr>
- <td>volume_group = cinder-volumes</td>
- <td>(StrOpt) Name for the VG that will contain exported volumes</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_lvm">
+ <caption>Description of configuration options for lvm</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>lvm_mirrors = 0</td>
+ <td>(IntOpt) If set, create lvms with multiple mirrors. Note that this requires lvm_mirrors + 2 pvs with available space</td>
+ </tr>
+ <tr>
+ <td>lvm_type = default</td>
+ <td>(StrOpt) Type of LVM volumes to deploy; (default or thin)</td>
+ </tr>
+ <tr>
+ <td>volume_group = cinder-volumes</td>
+ <td>(StrOpt) Name for the VG that will contain exported volumes</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-nas.xml b/doc/common/tables/cinder-nas.xml
index dce89ba518..6460cf57af 100644
--- a/doc/common/tables/cinder-nas.xml
+++ b/doc/common/tables/cinder-nas.xml
@@ -1,43 +1,42 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_nas">
- <caption>Description of configuration options for nas</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>nas_ip = </td>
- <td>(StrOpt) IP address or Hostname of NAS system.</td>
- </tr>
- <tr>
- <td>nas_login = admin</td>
- <td>(StrOpt) User name to connect to NAS system.</td>
- </tr>
- <tr>
- <td>nas_password = </td>
- <td>(StrOpt) Password to connect to NAS system.</td>
- </tr>
- <tr>
- <td>nas_private_key = </td>
- <td>(StrOpt) Filename of private key to use for SSH authentication.</td>
- </tr>
- <tr>
- <td>nas_ssh_port = 22</td>
- <td>(IntOpt) SSH port to use to connect to NAS system.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nas">
+ <caption>Description of configuration options for nas</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>nas_ip = </td>
+ <td>(StrOpt) IP address or Hostname of NAS system.</td>
+ </tr>
+ <tr>
+ <td>nas_login = admin</td>
+ <td>(StrOpt) User name to connect to NAS system.</td>
+ </tr>
+ <tr>
+ <td>nas_password = </td>
+ <td>(StrOpt) Password to connect to NAS system.</td>
+ </tr>
+ <tr>
+ <td>nas_private_key = </td>
+ <td>(StrOpt) Filename of private key to use for SSH authentication.</td>
+ </tr>
+ <tr>
+ <td>nas_ssh_port = 22</td>
+ <td>(IntOpt) SSH port to use to connect to NAS system.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-netapp_7mode_iscsi.xml b/doc/common/tables/cinder-netapp_7mode_iscsi.xml
index ceafa63635..d9247c9e95 100644
--- a/doc/common/tables/cinder-netapp_7mode_iscsi.xml
+++ b/doc/common/tables/cinder-netapp_7mode_iscsi.xml
@@ -1,63 +1,62 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_netapp_7mode_iscsi">
- <caption>Description of configuration options for netapp_7mode_iscsi</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>netapp_login = None</td>
- <td>(StrOpt) Administrative user account name used to access the storage system or proxy server.</td>
- </tr>
- <tr>
- <td>netapp_password = None</td>
- <td>(StrOpt) Password for the administrative user account specified in the netapp_login option.</td>
- </tr>
- <tr>
- <td>netapp_server_hostname = None</td>
- <td>(StrOpt) The hostname (or IP address) for the storage system or proxy server.</td>
- </tr>
- <tr>
- <td>netapp_server_port = 80</td>
- <td>(IntOpt) The TCP port to use for communication with the storage system or proxy server. Traditionally, port 80 is used for HTTP and port 443 is used for HTTPS; however, this value should be changed if an alternate port has been configured on the storage system or proxy server.</td>
- </tr>
- <tr>
- <td>netapp_size_multiplier = 1.2</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.</td>
- </tr>
- <tr>
- <td>netapp_storage_family = ontap_cluster</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>netapp_storage_protocol = None</td>
- <td>(StrOpt) The storage protocol to be used on the data path with the storage system; valid values are iscsi or nfs.</td>
- </tr>
- <tr>
- <td>netapp_transport_type = http</td>
- <td>(StrOpt) The transport protocol used when communicating with the storage system or proxy server. Valid values are http or https.</td>
- </tr>
- <tr>
- <td>netapp_vfiler = None</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 and the storage protocol selected is iSCSI. Only use this option when utilizing the MultiStore feature on the NetApp storage system.</td>
- </tr>
- <tr>
- <td>netapp_volume_list = None</td>
- <td>(StrOpt) This option is only utilized when the storage protocol is configured to use iSCSI. This option is used to restrict provisioning to the specified controller volumes. Specify the value of this option to be a comma separated list of NetApp controller volume names to be used for provisioning.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_netapp_7mode_iscsi">
+ <caption>Description of configuration options for netapp_7mode_iscsi</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>netapp_login = None</td>
+ <td>(StrOpt) Administrative user account name used to access the storage system or proxy server.</td>
+ </tr>
+ <tr>
+ <td>netapp_password = None</td>
+ <td>(StrOpt) Password for the administrative user account specified in the netapp_login option.</td>
+ </tr>
+ <tr>
+ <td>netapp_server_hostname = None</td>
+ <td>(StrOpt) The hostname (or IP address) for the storage system or proxy server.</td>
+ </tr>
+ <tr>
+ <td>netapp_server_port = 80</td>
+ <td>(IntOpt) The TCP port to use for communication with the storage system or proxy server. Traditionally, port 80 is used for HTTP and port 443 is used for HTTPS; however, this value should be changed if an alternate port has been configured on the storage system or proxy server.</td>
+ </tr>
+ <tr>
+ <td>netapp_size_multiplier = 1.2</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.</td>
+ </tr>
+ <tr>
+ <td>netapp_storage_family = ontap_cluster</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>netapp_storage_protocol = None</td>
+ <td>(StrOpt) The storage protocol to be used on the data path with the storage system; valid values are iscsi or nfs.</td>
+ </tr>
+ <tr>
+ <td>netapp_transport_type = http</td>
+ <td>(StrOpt) The transport protocol used when communicating with the storage system or proxy server. Valid values are http or https.</td>
+ </tr>
+ <tr>
+ <td>netapp_vfiler = None</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 and the storage protocol selected is iSCSI. Only use this option when utilizing the MultiStore feature on the NetApp storage system.</td>
+ </tr>
+ <tr>
+ <td>netapp_volume_list = None</td>
+ <td>(StrOpt) This option is only utilized when the storage protocol is configured to use iSCSI. This option is used to restrict provisioning to the specified controller volumes. Specify the value of this option to be a comma separated list of NetApp controller volume names to be used for provisioning.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-netapp_7mode_nfs.xml b/doc/common/tables/cinder-netapp_7mode_nfs.xml
index 05b9c10c4e..7802d48ba3 100644
--- a/doc/common/tables/cinder-netapp_7mode_nfs.xml
+++ b/doc/common/tables/cinder-netapp_7mode_nfs.xml
@@ -1,63 +1,62 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_netapp_7mode_nfs">
- <caption>Description of configuration options for netapp_7mode_nfs</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>expiry_thres_minutes = 720</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>netapp_login = None</td>
- <td>(StrOpt) Administrative user account name used to access the storage system or proxy server.</td>
- </tr>
- <tr>
- <td>netapp_password = None</td>
- <td>(StrOpt) Password for the administrative user account specified in the netapp_login option.</td>
- </tr>
- <tr>
- <td>netapp_server_hostname = None</td>
- <td>(StrOpt) The hostname (or IP address) for the storage system or proxy server.</td>
- </tr>
- <tr>
- <td>netapp_server_port = 80</td>
- <td>(IntOpt) The TCP port to use for communication with the storage system or proxy server. Traditionally, port 80 is used for HTTP and port 443 is used for HTTPS; however, this value should be changed if an alternate port has been configured on the storage system or proxy server.</td>
- </tr>
- <tr>
- <td>netapp_storage_family = ontap_cluster</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>netapp_storage_protocol = None</td>
- <td>(StrOpt) The storage protocol to be used on the data path with the storage system; valid values are iscsi or nfs.</td>
- </tr>
- <tr>
- <td>netapp_transport_type = http</td>
- <td>(StrOpt) The transport protocol used when communicating with the storage system or proxy server. Valid values are http or https.</td>
- </tr>
- <tr>
- <td>thres_avl_size_perc_start = 20</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>thres_avl_size_perc_stop = 60</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>
+<?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_netapp_7mode_nfs">
+ <caption>Description of configuration options for netapp_7mode_nfs</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>expiry_thres_minutes = 720</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>netapp_login = None</td>
+ <td>(StrOpt) Administrative user account name used to access the storage system or proxy server.</td>
+ </tr>
+ <tr>
+ <td>netapp_password = None</td>
+ <td>(StrOpt) Password for the administrative user account specified in the netapp_login option.</td>
+ </tr>
+ <tr>
+ <td>netapp_server_hostname = None</td>
+ <td>(StrOpt) The hostname (or IP address) for the storage system or proxy server.</td>
+ </tr>
+ <tr>
+ <td>netapp_server_port = 80</td>
+ <td>(IntOpt) The TCP port to use for communication with the storage system or proxy server. Traditionally, port 80 is used for HTTP and port 443 is used for HTTPS; however, this value should be changed if an alternate port has been configured on the storage system or proxy server.</td>
+ </tr>
+ <tr>
+ <td>netapp_storage_family = ontap_cluster</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>netapp_storage_protocol = None</td>
+ <td>(StrOpt) The storage protocol to be used on the data path with the storage system; valid values are iscsi or nfs.</td>
+ </tr>
+ <tr>
+ <td>netapp_transport_type = http</td>
+ <td>(StrOpt) The transport protocol used when communicating with the storage system or proxy server. Valid values are http or https.</td>
+ </tr>
+ <tr>
+ <td>thres_avl_size_perc_start = 20</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>thres_avl_size_perc_stop = 60</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>
diff --git a/doc/common/tables/cinder-netapp_cdot_iscsi.xml b/doc/common/tables/cinder-netapp_cdot_iscsi.xml
index de5c345629..d6bcdc3f91 100644
--- a/doc/common/tables/cinder-netapp_cdot_iscsi.xml
+++ b/doc/common/tables/cinder-netapp_cdot_iscsi.xml
@@ -1,59 +1,58 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_netapp_cdot_iscsi">
- <caption>Description of configuration options for netapp_cdot_iscsi</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>netapp_login = None</td>
- <td>(StrOpt) Administrative user account name used to access the storage system or proxy server.</td>
- </tr>
- <tr>
- <td>netapp_password = None</td>
- <td>(StrOpt) Password for the administrative user account specified in the netapp_login option.</td>
- </tr>
- <tr>
- <td>netapp_server_hostname = None</td>
- <td>(StrOpt) The hostname (or IP address) for the storage system or proxy server.</td>
- </tr>
- <tr>
- <td>netapp_server_port = 80</td>
- <td>(IntOpt) The TCP port to use for communication with the storage system or proxy server. Traditionally, port 80 is used for HTTP and port 443 is used for HTTPS; however, this value should be changed if an alternate port has been configured on the storage system or proxy server.</td>
- </tr>
- <tr>
- <td>netapp_size_multiplier = 1.2</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.</td>
- </tr>
- <tr>
- <td>netapp_storage_family = ontap_cluster</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>netapp_storage_protocol = None</td>
- <td>(StrOpt) The storage protocol to be used on the data path with the storage system; valid values are iscsi or nfs.</td>
- </tr>
- <tr>
- <td>netapp_transport_type = http</td>
- <td>(StrOpt) The transport protocol used when communicating with the storage system or proxy server. Valid values are http or https.</td>
- </tr>
- <tr>
- <td>netapp_vserver = None</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. If using the NFS storage protocol, this parameter is mandatory for storage service catalog support (utilized by Cinder volume type extra_specs support). If this option is specified, the exports belonging to the Vserver will only be used for provisioning in the future. Block storage volumes on exports not belonging to the Vserver specified by this option will continue to function normally.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_netapp_cdot_iscsi">
+ <caption>Description of configuration options for netapp_cdot_iscsi</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>netapp_login = None</td>
+ <td>(StrOpt) Administrative user account name used to access the storage system or proxy server.</td>
+ </tr>
+ <tr>
+ <td>netapp_password = None</td>
+ <td>(StrOpt) Password for the administrative user account specified in the netapp_login option.</td>
+ </tr>
+ <tr>
+ <td>netapp_server_hostname = None</td>
+ <td>(StrOpt) The hostname (or IP address) for the storage system or proxy server.</td>
+ </tr>
+ <tr>
+ <td>netapp_server_port = 80</td>
+ <td>(IntOpt) The TCP port to use for communication with the storage system or proxy server. Traditionally, port 80 is used for HTTP and port 443 is used for HTTPS; however, this value should be changed if an alternate port has been configured on the storage system or proxy server.</td>
+ </tr>
+ <tr>
+ <td>netapp_size_multiplier = 1.2</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.</td>
+ </tr>
+ <tr>
+ <td>netapp_storage_family = ontap_cluster</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>netapp_storage_protocol = None</td>
+ <td>(StrOpt) The storage protocol to be used on the data path with the storage system; valid values are iscsi or nfs.</td>
+ </tr>
+ <tr>
+ <td>netapp_transport_type = http</td>
+ <td>(StrOpt) The transport protocol used when communicating with the storage system or proxy server. Valid values are http or https.</td>
+ </tr>
+ <tr>
+ <td>netapp_vserver = None</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. If using the NFS storage protocol, this parameter is mandatory for storage service catalog support (utilized by Cinder volume type extra_specs support). If this option is specified, the exports belonging to the Vserver will only be used for provisioning in the future. Block storage volumes on exports not belonging to the Vserver specified by this option will continue to function normally.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-netapp_cdot_nfs.xml b/doc/common/tables/cinder-netapp_cdot_nfs.xml
index 216e548d4f..2ceb641d78 100644
--- a/doc/common/tables/cinder-netapp_cdot_nfs.xml
+++ b/doc/common/tables/cinder-netapp_cdot_nfs.xml
@@ -1,71 +1,70 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_netapp_cdot_nfs">
- <caption>Description of configuration options for netapp_cdot_nfs</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>expiry_thres_minutes = 720</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>netapp_copyoffload_tool_path = None</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>netapp_login = None</td>
- <td>(StrOpt) Administrative user account name used to access the storage system or proxy server.</td>
- </tr>
- <tr>
- <td>netapp_password = None</td>
- <td>(StrOpt) Password for the administrative user account specified in the netapp_login option.</td>
- </tr>
- <tr>
- <td>netapp_server_hostname = None</td>
- <td>(StrOpt) The hostname (or IP address) for the storage system or proxy server.</td>
- </tr>
- <tr>
- <td>netapp_server_port = 80</td>
- <td>(IntOpt) The TCP port to use for communication with the storage system or proxy server. Traditionally, port 80 is used for HTTP and port 443 is used for HTTPS; however, this value should be changed if an alternate port has been configured on the storage system or proxy server.</td>
- </tr>
- <tr>
- <td>netapp_storage_family = ontap_cluster</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>netapp_storage_protocol = None</td>
- <td>(StrOpt) The storage protocol to be used on the data path with the storage system; valid values are iscsi or nfs.</td>
- </tr>
- <tr>
- <td>netapp_transport_type = http</td>
- <td>(StrOpt) The transport protocol used when communicating with the storage system or proxy server. Valid values are http or https.</td>
- </tr>
- <tr>
- <td>netapp_vserver = None</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. If using the NFS storage protocol, this parameter is mandatory for storage service catalog support (utilized by Cinder volume type extra_specs support). If this option is specified, the exports belonging to the Vserver will only be used for provisioning in the future. Block storage volumes on exports not belonging to the Vserver specified by this option will continue to function normally.</td>
- </tr>
- <tr>
- <td>thres_avl_size_perc_start = 20</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>thres_avl_size_perc_stop = 60</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>
+<?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_netapp_cdot_nfs">
+ <caption>Description of configuration options for netapp_cdot_nfs</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>expiry_thres_minutes = 720</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>netapp_copyoffload_tool_path = None</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>netapp_login = None</td>
+ <td>(StrOpt) Administrative user account name used to access the storage system or proxy server.</td>
+ </tr>
+ <tr>
+ <td>netapp_password = None</td>
+ <td>(StrOpt) Password for the administrative user account specified in the netapp_login option.</td>
+ </tr>
+ <tr>
+ <td>netapp_server_hostname = None</td>
+ <td>(StrOpt) The hostname (or IP address) for the storage system or proxy server.</td>
+ </tr>
+ <tr>
+ <td>netapp_server_port = 80</td>
+ <td>(IntOpt) The TCP port to use for communication with the storage system or proxy server. Traditionally, port 80 is used for HTTP and port 443 is used for HTTPS; however, this value should be changed if an alternate port has been configured on the storage system or proxy server.</td>
+ </tr>
+ <tr>
+ <td>netapp_storage_family = ontap_cluster</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>netapp_storage_protocol = None</td>
+ <td>(StrOpt) The storage protocol to be used on the data path with the storage system; valid values are iscsi or nfs.</td>
+ </tr>
+ <tr>
+ <td>netapp_transport_type = http</td>
+ <td>(StrOpt) The transport protocol used when communicating with the storage system or proxy server. Valid values are http or https.</td>
+ </tr>
+ <tr>
+ <td>netapp_vserver = None</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. If using the NFS storage protocol, this parameter is mandatory for storage service catalog support (utilized by Cinder volume type extra_specs support). If this option is specified, the exports belonging to the Vserver will only be used for provisioning in the future. Block storage volumes on exports not belonging to the Vserver specified by this option will continue to function normally.</td>
+ </tr>
+ <tr>
+ <td>thres_avl_size_perc_start = 20</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>thres_avl_size_perc_stop = 60</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>
diff --git a/doc/common/tables/cinder-netapp_eseries_iscsi.xml b/doc/common/tables/cinder-netapp_eseries_iscsi.xml
index 8120a5849e..0fb321e93f 100644
--- a/doc/common/tables/cinder-netapp_eseries_iscsi.xml
+++ b/doc/common/tables/cinder-netapp_eseries_iscsi.xml
@@ -1,63 +1,62 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_netapp_eseries_iscsi">
- <caption>Description of configuration options for netapp_eseries_iscsi</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>netapp_controller_ips = None</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>netapp_login = None</td>
- <td>(StrOpt) Administrative user account name used to access the storage system or proxy server.</td>
- </tr>
- <tr>
- <td>netapp_password = None</td>
- <td>(StrOpt) Password for the administrative user account specified in the netapp_login option.</td>
- </tr>
- <tr>
- <td>netapp_sa_password = None</td>
- <td>(StrOpt) Password for the NetApp E-Series storage array.</td>
- </tr>
- <tr>
- <td>netapp_server_hostname = None</td>
- <td>(StrOpt) The hostname (or IP address) for the storage system or proxy server.</td>
- </tr>
- <tr>
- <td>netapp_server_port = 80</td>
- <td>(IntOpt) The TCP port to use for communication with the storage system or proxy server. Traditionally, port 80 is used for HTTP and port 443 is used for HTTPS; however, this value should be changed if an alternate port has been configured on the storage system or proxy server.</td>
- </tr>
- <tr>
- <td>netapp_storage_family = ontap_cluster</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>netapp_storage_pools = None</td>
- <td>(StrOpt) This option is used to restrict provisioning to the specified storage pools. Only dynamic disk pools are currently supported. Specify the value of this option to be a comma separated list of disk pool names to be used for provisioning.</td>
- </tr>
- <tr>
- <td>netapp_transport_type = http</td>
- <td>(StrOpt) The transport protocol used when communicating with the storage system or proxy server. Valid values are http or https.</td>
- </tr>
- <tr>
- <td>netapp_webservice_path = /devmgr/v2</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>
+<?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_netapp_eseries_iscsi">
+ <caption>Description of configuration options for netapp_eseries_iscsi</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>netapp_controller_ips = None</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>netapp_login = None</td>
+ <td>(StrOpt) Administrative user account name used to access the storage system or proxy server.</td>
+ </tr>
+ <tr>
+ <td>netapp_password = None</td>
+ <td>(StrOpt) Password for the administrative user account specified in the netapp_login option.</td>
+ </tr>
+ <tr>
+ <td>netapp_sa_password = None</td>
+ <td>(StrOpt) Password for the NetApp E-Series storage array.</td>
+ </tr>
+ <tr>
+ <td>netapp_server_hostname = None</td>
+ <td>(StrOpt) The hostname (or IP address) for the storage system or proxy server.</td>
+ </tr>
+ <tr>
+ <td>netapp_server_port = 80</td>
+ <td>(IntOpt) The TCP port to use for communication with the storage system or proxy server. Traditionally, port 80 is used for HTTP and port 443 is used for HTTPS; however, this value should be changed if an alternate port has been configured on the storage system or proxy server.</td>
+ </tr>
+ <tr>
+ <td>netapp_storage_family = ontap_cluster</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>netapp_storage_pools = None</td>
+ <td>(StrOpt) This option is used to restrict provisioning to the specified storage pools. Only dynamic disk pools are currently supported. Specify the value of this option to be a comma separated list of disk pool names to be used for provisioning.</td>
+ </tr>
+ <tr>
+ <td>netapp_transport_type = http</td>
+ <td>(StrOpt) The transport protocol used when communicating with the storage system or proxy server. Valid values are http or https.</td>
+ </tr>
+ <tr>
+ <td>netapp_webservice_path = /devmgr/v2</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>
diff --git a/doc/common/tables/cinder-nexenta_iscsi.xml b/doc/common/tables/cinder-nexenta_iscsi.xml
index 5543bb25e7..0960a4b287 100644
--- a/doc/common/tables/cinder-nexenta_iscsi.xml
+++ b/doc/common/tables/cinder-nexenta_iscsi.xml
@@ -1,83 +1,82 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_nexenta_iscsi">
- <caption>Description of configuration options for nexenta_iscsi</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>nexenta_blocksize = </td>
- <td>(StrOpt) block size for volumes (blank=default,8KB)</td>
- </tr>
- <tr>
- <td>nexenta_host = </td>
- <td>(StrOpt) IP address of Nexenta SA</td>
- </tr>
- <tr>
- <td>nexenta_iscsi_target_portal_port = 3260</td>
- <td>(IntOpt) Nexenta target portal port</td>
- </tr>
- <tr>
- <td>nexenta_password = nexenta</td>
- <td>(StrOpt) Password to connect to Nexenta SA</td>
- </tr>
- <tr>
- <td>nexenta_rest_port = 2000</td>
- <td>(IntOpt) HTTP port to connect to Nexenta REST API server</td>
- </tr>
- <tr>
- <td>nexenta_rest_protocol = auto</td>
- <td>(StrOpt) Use http or https for REST connection (default auto)</td>
- </tr>
- <tr>
- <td>nexenta_rrmgr_compression = 0</td>
- <td>(IntOpt) Enable stream compression, level 1..9. 1 - gives best speed; 9 - gives best compression.</td>
- </tr>
- <tr>
- <td>nexenta_rrmgr_connections = 2</td>
- <td>(IntOpt) Number of TCP connections.</td>
- </tr>
- <tr>
- <td>nexenta_rrmgr_tcp_buf_size = 4096</td>
- <td>(IntOpt) TCP Buffer size in KiloBytes.</td>
- </tr>
- <tr>
- <td>nexenta_sparse = False</td>
- <td>(BoolOpt) flag to create sparse volumes</td>
- </tr>
- <tr>
- <td>nexenta_sparsed_volumes = True</td>
- <td>(BoolOpt) Create volumes as sparsed files which take no space.If set to False volume is created as regular file.In such case volume creation takes a lot of time.</td>
- </tr>
- <tr>
- <td>nexenta_target_group_prefix = cinder/</td>
- <td>(StrOpt) prefix for iSCSI target groups on SA</td>
- </tr>
- <tr>
- <td>nexenta_target_prefix = iqn.1986-03.com.sun:02:cinder-</td>
- <td>(StrOpt) IQN prefix for iSCSI targets</td>
- </tr>
- <tr>
- <td>nexenta_user = admin</td>
- <td>(StrOpt) User name to connect to Nexenta SA</td>
- </tr>
- <tr>
- <td>nexenta_volume = cinder</td>
- <td>(StrOpt) pool on SA that will hold all volumes</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nexenta_iscsi">
+ <caption>Description of configuration options for nexenta_iscsi</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>nexenta_blocksize = </td>
+ <td>(StrOpt) Block size for volumes (default=blank means 8KB)</td>
+ </tr>
+ <tr>
+ <td>nexenta_host = </td>
+ <td>(StrOpt) IP address of Nexenta SA</td>
+ </tr>
+ <tr>
+ <td>nexenta_iscsi_target_portal_port = 3260</td>
+ <td>(IntOpt) Nexenta target portal port</td>
+ </tr>
+ <tr>
+ <td>nexenta_password = nexenta</td>
+ <td>(StrOpt) Password to connect to Nexenta SA</td>
+ </tr>
+ <tr>
+ <td>nexenta_rest_port = 2000</td>
+ <td>(IntOpt) HTTP port to connect to Nexenta REST API server</td>
+ </tr>
+ <tr>
+ <td>nexenta_rest_protocol = auto</td>
+ <td>(StrOpt) Use http or https for REST connection (default auto)</td>
+ </tr>
+ <tr>
+ <td>nexenta_rrmgr_compression = 0</td>
+ <td>(IntOpt) Enable stream compression, level 1..9. 1 - gives best speed; 9 - gives best compression.</td>
+ </tr>
+ <tr>
+ <td>nexenta_rrmgr_connections = 2</td>
+ <td>(IntOpt) Number of TCP connections.</td>
+ </tr>
+ <tr>
+ <td>nexenta_rrmgr_tcp_buf_size = 4096</td>
+ <td>(IntOpt) TCP Buffer size in KiloBytes.</td>
+ </tr>
+ <tr>
+ <td>nexenta_sparse = False</td>
+ <td>(BoolOpt) Enables or disables the creation of sparse volumes</td>
+ </tr>
+ <tr>
+ <td>nexenta_sparsed_volumes = True</td>
+ <td>(BoolOpt) Enables or disables the creation of volumes as sparsed files that take no space. If disabled (False), volume is created as a regular file, which takes a long time.</td>
+ </tr>
+ <tr>
+ <td>nexenta_target_group_prefix = cinder/</td>
+ <td>(StrOpt) Prefix for iSCSI target groups on SA</td>
+ </tr>
+ <tr>
+ <td>nexenta_target_prefix = iqn.1986-03.com.sun:02:cinder-</td>
+ <td>(StrOpt) IQN prefix for iSCSI targets</td>
+ </tr>
+ <tr>
+ <td>nexenta_user = admin</td>
+ <td>(StrOpt) User name to connect to Nexenta SA</td>
+ </tr>
+ <tr>
+ <td>nexenta_volume = cinder</td>
+ <td>(StrOpt) SA Pool that holds all volumes</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-nexenta_nfs.xml b/doc/common/tables/cinder-nexenta_nfs.xml
index 87814bb84d..0301ee3092 100644
--- a/doc/common/tables/cinder-nexenta_nfs.xml
+++ b/doc/common/tables/cinder-nexenta_nfs.xml
@@ -1,39 +1,38 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_nexenta_nfs">
- <caption>Description of configuration options for nexenta_nfs</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>nexenta_mount_point_base = $state_path/mnt</td>
- <td>(StrOpt) Base dir containing mount points for nfs shares</td>
- </tr>
- <tr>
- <td>nexenta_nms_cache_volroot = True</td>
- <td>(BoolOpt) If set True cache NexentaStor appliance volroot option value.</td>
- </tr>
- <tr>
- <td>nexenta_shares_config = /etc/cinder/nfs_shares</td>
- <td>(StrOpt) File with the list of available nfs shares</td>
- </tr>
- <tr>
- <td>nexenta_volume_compression = on</td>
- <td>(StrOpt) Default compression value for new ZFS folders.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nexenta_nfs">
+ <caption>Description of configuration options for nexenta_nfs</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>nexenta_mount_point_base = $state_path/mnt</td>
+ <td>(StrOpt) Base directory that contains NFS share mount points</td>
+ </tr>
+ <tr>
+ <td>nexenta_nms_cache_volroot = True</td>
+ <td>(BoolOpt) If set True cache NexentaStor appliance volroot option value.</td>
+ </tr>
+ <tr>
+ <td>nexenta_shares_config = /etc/cinder/nfs_shares</td>
+ <td>(StrOpt) File with the list of available nfs shares</td>
+ </tr>
+ <tr>
+ <td>nexenta_volume_compression = on</td>
+ <td>(StrOpt) Default compression value for new ZFS folders.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-quota.xml b/doc/common/tables/cinder-quota.xml
index 4fd1d976dd..c3d9de3f66 100644
--- a/doc/common/tables/cinder-quota.xml
+++ b/doc/common/tables/cinder-quota.xml
@@ -1,51 +1,50 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_quota">
- <caption>Description of configuration options for quota</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>max_age = 0</td>
- <td>(IntOpt) number of seconds between subsequent usage refreshes</td>
- </tr>
- <tr>
- <td>quota_driver = cinder.quota.DbQuotaDriver</td>
- <td>(StrOpt) default driver to use for quota checks</td>
- </tr>
- <tr>
- <td>quota_gigabytes = 1000</td>
- <td>(IntOpt) number of volume gigabytes (snapshots are also included) allowed per project</td>
- </tr>
- <tr>
- <td>quota_snapshots = 10</td>
- <td>(IntOpt) number of volume snapshots allowed per project</td>
- </tr>
- <tr>
- <td>quota_volumes = 10</td>
- <td>(IntOpt) number of volumes allowed per project</td>
- </tr>
- <tr>
- <td>reservation_expire = 86400</td>
- <td>(IntOpt) number of seconds until a reservation expires</td>
- </tr>
- <tr>
- <td>use_default_quota_class = True</td>
- <td>(BoolOpt) whether to use default quota class for default quota</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_quota">
+ <caption>Description of configuration options for quota</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>max_age = 0</td>
+ <td>(IntOpt) Number of seconds between subsequent usage refreshes</td>
+ </tr>
+ <tr>
+ <td>quota_driver = cinder.quota.DbQuotaDriver</td>
+ <td>(StrOpt) Default driver to use for quota checks</td>
+ </tr>
+ <tr>
+ <td>quota_gigabytes = 1000</td>
+ <td>(IntOpt) Total amount of storage, in gigabytes, allowed for volumes and snapshots per project</td>
+ </tr>
+ <tr>
+ <td>quota_snapshots = 10</td>
+ <td>(IntOpt) Number of volume snapshots allowed per project</td>
+ </tr>
+ <tr>
+ <td>quota_volumes = 10</td>
+ <td>(IntOpt) Number of volumes allowed per project</td>
+ </tr>
+ <tr>
+ <td>reservation_expire = 86400</td>
+ <td>(IntOpt) Number of seconds until a reservation expires</td>
+ </tr>
+ <tr>
+ <td>use_default_quota_class = True</td>
+ <td>(BoolOpt) Enables or disables use of default quota class with default quota.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-rootwrap.xml b/doc/common/tables/cinder-rootwrap.xml
index 4f42eb1e6d..72e425d27e 100644
--- a/doc/common/tables/cinder-rootwrap.xml
+++ b/doc/common/tables/cinder-rootwrap.xml
@@ -1,43 +1,42 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_rootwrap">
- <caption>Description of configuration options for rootwrap</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>filters_path = /etc/cinder/rootwrap.d,/usr/share/cinder/rootwrap</td>
- <td>List of directories to load filter definitions from (separated by ','). These directories MUST all be only writeable by root !</td>
- </tr>
- <tr>
- <td>exec_dirs = /sbin,/usr/sbin,/bin,/usr/bin</td>
- <td>List of directories to search executables in, in case filters do not explicitely specify a full path (separated by ',') If not specified, defaults to system PATH environment variable. These directories MUST all be only writeable by root !</td>
- </tr>
- <tr>
- <td>use_syslog = False</td>
- <td>Enable logging to syslog Default value is False</td>
- </tr>
- <tr>
- <td>syslog_log_facility = syslog</td>
- <td>Which syslog facility to use. Valid values include auth, authpriv, syslog, local0, local1... Default value is 'syslog'</td>
- </tr>
- <tr>
- <td>syslog_log_level = ERROR</td>
- <td>Which messages to log. INFO means log all usage ERROR means only log unsuccessful attempts</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_rootwrap">
+ <caption>Description of configuration options for rootwrap</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>filters_path = /etc/cinder/rootwrap.d,/usr/share/cinder/rootwrap</td>
+ <td>List of directories to load filter definitions from (separated by ','). These directories MUST all be only writeable by root !</td>
+ </tr>
+ <tr>
+ <td>exec_dirs = /sbin,/usr/sbin,/bin,/usr/bin</td>
+ <td>List of directories to search executables in, in case filters do not explicitely specify a full path (separated by ',') If not specified, defaults to system PATH environment variable. These directories MUST all be only writeable by root !</td>
+ </tr>
+ <tr>
+ <td>use_syslog = False</td>
+ <td>Enable logging to syslog Default value is False</td>
+ </tr>
+ <tr>
+ <td>syslog_log_facility = syslog</td>
+ <td>Which syslog facility to use. Valid values include auth, authpriv, syslog, local0, local1... Default value is 'syslog'</td>
+ </tr>
+ <tr>
+ <td>syslog_log_level = ERROR</td>
+ <td>Which messages to log. INFO means log all usage ERROR means only log unsuccessful attempts</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-rpc.xml b/doc/common/tables/cinder-rpc.xml
index b3e4e00b7f..5624f77557 100644
--- a/doc/common/tables/cinder-rpc.xml
+++ b/doc/common/tables/cinder-rpc.xml
@@ -1,246 +1,245 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_rpc">
- <caption>Description of configuration options for rpc</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>allowed_rpc_exception_modules = oslo.messaging.exceptions, nova.exception, cinder.exception, exceptions</td>
- <td>(ListOpt) Modules of exceptions that are permitted to be recreated upon receiving exception data from an rpc call.</td>
- </tr>
- <tr>
- <td>amqp_auto_delete = False</td>
- <td>(BoolOpt) Auto-delete queues in amqp.</td>
- </tr>
- <tr>
- <td>amqp_durable_queues = False</td>
- <td>(BoolOpt) Use durable queues in amqp.</td>
- </tr>
- <tr>
- <td>control_exchange = openstack</td>
- <td>(StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.</td>
- </tr>
- <tr>
- <td>default_timeout = 20</td>
- <td>(IntOpt) Default Time Out For CLI operations in minutes</td>
- </tr>
- <tr>
- <td>fake_rabbit = False</td>
- <td>(BoolOpt) If passed, use a fake RabbitMQ provider.</td>
- </tr>
- <tr>
- <td>kombu_reconnect_delay = 1.0</td>
- <td>(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.</td>
- </tr>
- <tr>
- <td>kombu_ssl_ca_certs = </td>
- <td>(StrOpt) SSL certification authority file (valid only if SSL enabled).</td>
- </tr>
- <tr>
- <td>kombu_ssl_certfile = </td>
- <td>(StrOpt) SSL cert file (valid only if SSL enabled).</td>
- </tr>
- <tr>
- <td>kombu_ssl_keyfile = </td>
- <td>(StrOpt) SSL key file (valid only if SSL enabled).</td>
- </tr>
- <tr>
- <td>kombu_ssl_version = </td>
- <td>(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions.</td>
- </tr>
- <tr>
- <td>matchmaker_heartbeat_freq = 300</td>
- <td>(IntOpt) Heartbeat frequency.</td>
- </tr>
- <tr>
- <td>matchmaker_heartbeat_ttl = 600</td>
- <td>(IntOpt) Heartbeat time-to-live.</td>
- </tr>
- <tr>
- <td>notification_driver = []</td>
- <td>(MultiStrOpt) Driver or drivers to handle sending notifications.</td>
- </tr>
- <tr>
- <td>notification_topics = notifications</td>
- <td>(ListOpt) AMQP topic used for OpenStack notifications.</td>
- </tr>
- <tr>
- <td>password = None</td>
- <td>(StrOpt) Password for Redis server (optional).</td>
- </tr>
- <tr>
- <td>port = 6379</td>
- <td>(IntOpt) Use this port to connect to redis host.</td>
- </tr>
- <tr>
- <td>publish_errors = False</td>
- <td>(BoolOpt) Publish error events</td>
- </tr>
- <tr>
- <td>qpid_heartbeat = 60</td>
- <td>(IntOpt) Seconds between connection keepalive heartbeats.</td>
- </tr>
- <tr>
- <td>qpid_hostname = localhost</td>
- <td>(StrOpt) Qpid broker hostname.</td>
- </tr>
- <tr>
- <td>qpid_hosts = $qpid_hostname:$qpid_port</td>
- <td>(ListOpt) Qpid HA cluster host:port pairs.</td>
- </tr>
- <tr>
- <td>qpid_password = </td>
- <td>(StrOpt) Password for Qpid connection.</td>
- </tr>
- <tr>
- <td>qpid_port = 5672</td>
- <td>(IntOpt) Qpid broker port.</td>
- </tr>
- <tr>
- <td>qpid_protocol = tcp</td>
- <td>(StrOpt) Transport to use, either 'tcp' or 'ssl'.</td>
- </tr>
- <tr>
- <td>qpid_sasl_mechanisms = </td>
- <td>(StrOpt) Space separated list of SASL mechanisms to use for auth.</td>
- </tr>
- <tr>
- <td>qpid_tcp_nodelay = True</td>
- <td>(BoolOpt) Whether to disable the Nagle algorithm.</td>
- </tr>
- <tr>
- <td>qpid_topology_version = 1</td>
- <td>(IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.</td>
- </tr>
- <tr>
- <td>qpid_username = </td>
- <td>(StrOpt) Username for Qpid connection.</td>
- </tr>
- <tr>
- <td>rabbit_ha_queues = False</td>
- <td>(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database.</td>
- </tr>
- <tr>
- <td>rabbit_host = localhost</td>
- <td>(StrOpt) The RabbitMQ broker address where a single node is used.</td>
- </tr>
- <tr>
- <td>rabbit_hosts = $rabbit_host:$rabbit_port</td>
- <td>(ListOpt) RabbitMQ HA cluster host:port pairs.</td>
- </tr>
- <tr>
- <td>rabbit_login_method = AMQPLAIN</td>
- <td>(StrOpt) the RabbitMQ login method</td>
- </tr>
- <tr>
- <td>rabbit_max_retries = 0</td>
- <td>(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).</td>
- </tr>
- <tr>
- <td>rabbit_password = guest</td>
- <td>(StrOpt) The RabbitMQ password.</td>
- </tr>
- <tr>
- <td>rabbit_port = 5672</td>
- <td>(IntOpt) The RabbitMQ broker port where a single node is used.</td>
- </tr>
- <tr>
- <td>rabbit_retry_backoff = 2</td>
- <td>(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.</td>
- </tr>
- <tr>
- <td>rabbit_retry_interval = 1</td>
- <td>(IntOpt) How frequently to retry connecting with RabbitMQ.</td>
- </tr>
- <tr>
- <td>rabbit_use_ssl = False</td>
- <td>(BoolOpt) Connect over SSL for RabbitMQ.</td>
- </tr>
- <tr>
- <td>rabbit_userid = guest</td>
- <td>(StrOpt) The RabbitMQ userid.</td>
- </tr>
- <tr>
- <td>rabbit_virtual_host = /</td>
- <td>(StrOpt) The RabbitMQ virtual host.</td>
- </tr>
- <tr>
- <td>rpc_backend = rabbit</td>
- <td>(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq.</td>
- </tr>
- <tr>
- <td>rpc_cast_timeout = 30</td>
- <td>(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq.</td>
- </tr>
- <tr>
- <td>rpc_conn_pool_size = 30</td>
- <td>(IntOpt) Size of RPC connection pool.</td>
- </tr>
- <tr>
- <td>rpc_response_timeout = 60</td>
- <td>(IntOpt) Seconds to wait for a response from a call.</td>
- </tr>
- <tr>
- <td>rpc_thread_pool_size = 64</td>
- <td>(IntOpt) Size of RPC greenthread pool.</td>
- </tr>
- <tr>
- <td>rpc_zmq_bind_address = *</td>
- <td>(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address.</td>
- </tr>
- <tr>
- <td>rpc_zmq_contexts = 1</td>
- <td>(IntOpt) Number of ZeroMQ contexts, defaults to 1.</td>
- </tr>
- <tr>
- <td>rpc_zmq_host = oslo</td>
- <td>(StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova.</td>
- </tr>
- <tr>
- <td>rpc_zmq_ipc_dir = /var/run/openstack</td>
- <td>(StrOpt) Directory for holding IPC sockets.</td>
- </tr>
- <tr>
- <td>rpc_zmq_matchmaker = oslo.messaging._drivers.matchmaker.MatchMakerLocalhost</td>
- <td>(StrOpt) MatchMaker driver.</td>
- </tr>
- <tr>
- <td>rpc_zmq_port = 9501</td>
- <td>(IntOpt) ZeroMQ receiver listening port.</td>
- </tr>
- <tr>
- <td>rpc_zmq_topic_backlog = None</td>
- <td>(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited.</td>
- </tr>
- <tr>
- <td>transport_url = None</td>
- <td>(StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration.</td>
- </tr>
- <tr>
- <td>volume_topic = cinder-volume</td>
- <td>(StrOpt) the topic volume nodes listen on</td>
- </tr>
- <tr>
- <th colspan="2">[matchmaker_ring]</th>
- </tr>
- <tr>
- <td>ringfile = /etc/oslo/matchmaker_ring.json</td>
- <td>(StrOpt) Matchmaker ring file (JSON).</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_rpc">
+ <caption>Description of configuration options for rpc</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>allowed_rpc_exception_modules = oslo.messaging.exceptions, nova.exception, cinder.exception, exceptions</td>
+ <td>(ListOpt) Modules of exceptions that are permitted to be recreated upon receiving exception data from an rpc call.</td>
+ </tr>
+ <tr>
+ <td>amqp_auto_delete = False</td>
+ <td>(BoolOpt) Auto-delete queues in amqp.</td>
+ </tr>
+ <tr>
+ <td>amqp_durable_queues = False</td>
+ <td>(BoolOpt) Use durable queues in amqp.</td>
+ </tr>
+ <tr>
+ <td>control_exchange = openstack</td>
+ <td>(StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.</td>
+ </tr>
+ <tr>
+ <td>default_timeout = 20</td>
+ <td>(IntOpt) Default Time Out For CLI operations in minutes</td>
+ </tr>
+ <tr>
+ <td>fake_rabbit = False</td>
+ <td>(BoolOpt) If passed, use a fake RabbitMQ provider.</td>
+ </tr>
+ <tr>
+ <td>kombu_reconnect_delay = 1.0</td>
+ <td>(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.</td>
+ </tr>
+ <tr>
+ <td>kombu_ssl_ca_certs = </td>
+ <td>(StrOpt) SSL certification authority file (valid only if SSL enabled).</td>
+ </tr>
+ <tr>
+ <td>kombu_ssl_certfile = </td>
+ <td>(StrOpt) SSL cert file (valid only if SSL enabled).</td>
+ </tr>
+ <tr>
+ <td>kombu_ssl_keyfile = </td>
+ <td>(StrOpt) SSL key file (valid only if SSL enabled).</td>
+ </tr>
+ <tr>
+ <td>kombu_ssl_version = </td>
+ <td>(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions.</td>
+ </tr>
+ <tr>
+ <td>matchmaker_heartbeat_freq = 300</td>
+ <td>(IntOpt) Heartbeat frequency.</td>
+ </tr>
+ <tr>
+ <td>matchmaker_heartbeat_ttl = 600</td>
+ <td>(IntOpt) Heartbeat time-to-live.</td>
+ </tr>
+ <tr>
+ <td>notification_driver = []</td>
+ <td>(MultiStrOpt) Driver or drivers to handle sending notifications.</td>
+ </tr>
+ <tr>
+ <td>notification_topics = notifications</td>
+ <td>(ListOpt) AMQP topic used for OpenStack notifications.</td>
+ </tr>
+ <tr>
+ <td>password = None</td>
+ <td>(StrOpt) Password for Redis server (optional).</td>
+ </tr>
+ <tr>
+ <td>port = 6379</td>
+ <td>(IntOpt) Use this port to connect to redis host.</td>
+ </tr>
+ <tr>
+ <td>publish_errors = False</td>
+ <td>(BoolOpt) Enables or disables publication of error events.</td>
+ </tr>
+ <tr>
+ <td>qpid_heartbeat = 60</td>
+ <td>(IntOpt) Seconds between connection keepalive heartbeats.</td>
+ </tr>
+ <tr>
+ <td>qpid_hostname = localhost</td>
+ <td>(StrOpt) Qpid broker hostname.</td>
+ </tr>
+ <tr>
+ <td>qpid_hosts = $qpid_hostname:$qpid_port</td>
+ <td>(ListOpt) Qpid HA cluster host:port pairs.</td>
+ </tr>
+ <tr>
+ <td>qpid_password = </td>
+ <td>(StrOpt) Password for Qpid connection.</td>
+ </tr>
+ <tr>
+ <td>qpid_port = 5672</td>
+ <td>(IntOpt) Qpid broker port.</td>
+ </tr>
+ <tr>
+ <td>qpid_protocol = tcp</td>
+ <td>(StrOpt) Transport to use, either 'tcp' or 'ssl'.</td>
+ </tr>
+ <tr>
+ <td>qpid_sasl_mechanisms = </td>
+ <td>(StrOpt) Space separated list of SASL mechanisms to use for auth.</td>
+ </tr>
+ <tr>
+ <td>qpid_tcp_nodelay = True</td>
+ <td>(BoolOpt) Whether to disable the Nagle algorithm.</td>
+ </tr>
+ <tr>
+ <td>qpid_topology_version = 1</td>
+ <td>(IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.</td>
+ </tr>
+ <tr>
+ <td>qpid_username = </td>
+ <td>(StrOpt) Username for Qpid connection.</td>
+ </tr>
+ <tr>
+ <td>rabbit_ha_queues = False</td>
+ <td>(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database.</td>
+ </tr>
+ <tr>
+ <td>rabbit_host = localhost</td>
+ <td>(StrOpt) The RabbitMQ broker address where a single node is used.</td>
+ </tr>
+ <tr>
+ <td>rabbit_hosts = $rabbit_host:$rabbit_port</td>
+ <td>(ListOpt) RabbitMQ HA cluster host:port pairs.</td>
+ </tr>
+ <tr>
+ <td>rabbit_login_method = AMQPLAIN</td>
+ <td>(StrOpt) the RabbitMQ login method</td>
+ </tr>
+ <tr>
+ <td>rabbit_max_retries = 0</td>
+ <td>(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).</td>
+ </tr>
+ <tr>
+ <td>rabbit_password = guest</td>
+ <td>(StrOpt) The RabbitMQ password.</td>
+ </tr>
+ <tr>
+ <td>rabbit_port = 5672</td>
+ <td>(IntOpt) The RabbitMQ broker port where a single node is used.</td>
+ </tr>
+ <tr>
+ <td>rabbit_retry_backoff = 2</td>
+ <td>(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.</td>
+ </tr>
+ <tr>
+ <td>rabbit_retry_interval = 1</td>
+ <td>(IntOpt) How frequently to retry connecting with RabbitMQ.</td>
+ </tr>
+ <tr>
+ <td>rabbit_use_ssl = False</td>
+ <td>(BoolOpt) Connect over SSL for RabbitMQ.</td>
+ </tr>
+ <tr>
+ <td>rabbit_userid = guest</td>
+ <td>(StrOpt) The RabbitMQ userid.</td>
+ </tr>
+ <tr>
+ <td>rabbit_virtual_host = /</td>
+ <td>(StrOpt) The RabbitMQ virtual host.</td>
+ </tr>
+ <tr>
+ <td>rpc_backend = rabbit</td>
+ <td>(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq.</td>
+ </tr>
+ <tr>
+ <td>rpc_cast_timeout = 30</td>
+ <td>(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq.</td>
+ </tr>
+ <tr>
+ <td>rpc_conn_pool_size = 30</td>
+ <td>(IntOpt) Size of RPC connection pool.</td>
+ </tr>
+ <tr>
+ <td>rpc_response_timeout = 60</td>
+ <td>(IntOpt) Seconds to wait for a response from a call.</td>
+ </tr>
+ <tr>
+ <td>rpc_thread_pool_size = 64</td>
+ <td>(IntOpt) Size of RPC greenthread pool.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_bind_address = *</td>
+ <td>(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_contexts = 1</td>
+ <td>(IntOpt) Number of ZeroMQ contexts, defaults to 1.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_host = oslo</td>
+ <td>(StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_ipc_dir = /var/run/openstack</td>
+ <td>(StrOpt) Directory for holding IPC sockets.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_matchmaker = oslo.messaging._drivers.matchmaker.MatchMakerLocalhost</td>
+ <td>(StrOpt) MatchMaker driver.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_port = 9501</td>
+ <td>(IntOpt) ZeroMQ receiver listening port.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_topic_backlog = None</td>
+ <td>(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited.</td>
+ </tr>
+ <tr>
+ <td>transport_url = None</td>
+ <td>(StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration.</td>
+ </tr>
+ <tr>
+ <td>volume_topic = cinder-volume</td>
+ <td>(StrOpt) The topic that volume nodes listen on</td>
+ </tr>
+ <tr>
+ <th colspan="2">[matchmaker_ring]</th>
+ </tr>
+ <tr>
+ <td>ringfile = /etc/oslo/matchmaker_ring.json</td>
+ <td>(StrOpt) Matchmaker ring file (JSON).</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-san-solaris.xml b/doc/common/tables/cinder-san-solaris.xml
index 0a1b015291..80c2e6eddb 100644
--- a/doc/common/tables/cinder-san-solaris.xml
+++ b/doc/common/tables/cinder-san-solaris.xml
@@ -1,27 +1,26 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_san-solaris">
- <caption>Description of configuration options for san-solaris</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>san_zfs_volume_base = rpool/</td>
- <td>(StrOpt) The ZFS path under which to create zvols for volumes.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_san-solaris">
+ <caption>Description of configuration options for san-solaris</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>san_zfs_volume_base = rpool/</td>
+ <td>(StrOpt) The ZFS path under which to create zvols for volumes.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-san.xml b/doc/common/tables/cinder-san.xml
index f8807a005e..3e2826c523 100644
--- a/doc/common/tables/cinder-san.xml
+++ b/doc/common/tables/cinder-san.xml
@@ -1,67 +1,66 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_san">
- <caption>Description of configuration options for san</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>san_clustername = </td>
- <td>(StrOpt) Cluster name to use for creating volumes</td>
- </tr>
- <tr>
- <td>san_ip = </td>
- <td>(StrOpt) IP address of SAN controller</td>
- </tr>
- <tr>
- <td>san_is_local = False</td>
- <td>(BoolOpt) Execute commands locally instead of over SSH; use if the volume service is running on the SAN device</td>
- </tr>
- <tr>
- <td>san_login = admin</td>
- <td>(StrOpt) Username for SAN controller</td>
- </tr>
- <tr>
- <td>san_password = </td>
- <td>(StrOpt) Password for SAN controller</td>
- </tr>
- <tr>
- <td>san_private_key = </td>
- <td>(StrOpt) Filename of private key to use for SSH authentication</td>
- </tr>
- <tr>
- <td>san_ssh_port = 22</td>
- <td>(IntOpt) SSH port to use with SAN</td>
- </tr>
- <tr>
- <td>san_thin_provision = True</td>
- <td>(BoolOpt) Use thin provisioning for SAN volumes?</td>
- </tr>
- <tr>
- <td>ssh_conn_timeout = 30</td>
- <td>(IntOpt) SSH connection timeout in seconds</td>
- </tr>
- <tr>
- <td>ssh_max_pool_conn = 5</td>
- <td>(IntOpt) Maximum ssh connections in the pool</td>
- </tr>
- <tr>
- <td>ssh_min_pool_conn = 1</td>
- <td>(IntOpt) Minimum ssh connections in the pool</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_san">
+ <caption>Description of configuration options for san</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>san_clustername = </td>
+ <td>(StrOpt) Cluster name to use for creating volumes</td>
+ </tr>
+ <tr>
+ <td>san_ip = </td>
+ <td>(StrOpt) IP address of SAN controller</td>
+ </tr>
+ <tr>
+ <td>san_is_local = False</td>
+ <td>(BoolOpt) Execute commands locally instead of over SSH; use if the volume service is running on the SAN device</td>
+ </tr>
+ <tr>
+ <td>san_login = admin</td>
+ <td>(StrOpt) Username for SAN controller</td>
+ </tr>
+ <tr>
+ <td>san_password = </td>
+ <td>(StrOpt) Password for SAN controller</td>
+ </tr>
+ <tr>
+ <td>san_private_key = </td>
+ <td>(StrOpt) Filename of private key to use for SSH authentication</td>
+ </tr>
+ <tr>
+ <td>san_ssh_port = 22</td>
+ <td>(IntOpt) SSH port to use with SAN</td>
+ </tr>
+ <tr>
+ <td>san_thin_provision = True</td>
+ <td>(BoolOpt) Use thin provisioning for SAN volumes?</td>
+ </tr>
+ <tr>
+ <td>ssh_conn_timeout = 30</td>
+ <td>(IntOpt) SSH connection timeout in seconds</td>
+ </tr>
+ <tr>
+ <td>ssh_max_pool_conn = 5</td>
+ <td>(IntOpt) Maximum ssh connections in the pool</td>
+ </tr>
+ <tr>
+ <td>ssh_min_pool_conn = 1</td>
+ <td>(IntOpt) Minimum ssh connections in the pool</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-scality.xml b/doc/common/tables/cinder-scality.xml
index f118743aef..17c77a7936 100644
--- a/doc/common/tables/cinder-scality.xml
+++ b/doc/common/tables/cinder-scality.xml
@@ -1,35 +1,34 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_scality">
- <caption>Description of configuration options for scality</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>scality_sofs_config = None</td>
- <td>(StrOpt) Path or URL to Scality SOFS configuration file</td>
- </tr>
- <tr>
- <td>scality_sofs_mount_point = $state_path/scality</td>
- <td>(StrOpt) Base dir where Scality SOFS shall be mounted</td>
- </tr>
- <tr>
- <td>scality_sofs_volume_dir = cinder/volumes</td>
- <td>(StrOpt) Path from Scality SOFS root to volume dir</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_scality">
+ <caption>Description of configuration options for scality</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>scality_sofs_config = None</td>
+ <td>(StrOpt) Path or URL to Scality SOFS configuration file</td>
+ </tr>
+ <tr>
+ <td>scality_sofs_mount_point = $state_path/scality</td>
+ <td>(StrOpt) Base dir where Scality SOFS shall be mounted</td>
+ </tr>
+ <tr>
+ <td>scality_sofs_volume_dir = cinder/volumes</td>
+ <td>(StrOpt) Path from Scality SOFS root to volume dir</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-scheduler.xml b/doc/common/tables/cinder-scheduler.xml
index 34f2f02ca2..a166de803b 100644
--- a/doc/common/tables/cinder-scheduler.xml
+++ b/doc/common/tables/cinder-scheduler.xml
@@ -1,55 +1,54 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_scheduler">
- <caption>Description of configuration options for scheduler</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>scheduler_default_filters = AvailabilityZoneFilter, CapacityFilter, CapabilitiesFilter</td>
- <td>(ListOpt) Which filter class names to use for filtering hosts when not specified in the request.</td>
- </tr>
- <tr>
- <td>scheduler_default_weighers = CapacityWeigher</td>
- <td>(ListOpt) Which weigher class names to use for weighing hosts.</td>
- </tr>
- <tr>
- <td>scheduler_driver = cinder.scheduler.filter_scheduler.FilterScheduler</td>
- <td>(StrOpt) Default scheduler driver to use</td>
- </tr>
- <tr>
- <td>scheduler_host_manager = cinder.scheduler.host_manager.HostManager</td>
- <td>(StrOpt) The scheduler host manager class to use</td>
- </tr>
- <tr>
- <td>scheduler_json_config_location = </td>
- <td>(StrOpt) Absolute path to scheduler configuration JSON file.</td>
- </tr>
- <tr>
- <td>scheduler_manager = cinder.scheduler.manager.SchedulerManager</td>
- <td>(StrOpt) full class name for the Manager for scheduler</td>
- </tr>
- <tr>
- <td>scheduler_max_attempts = 3</td>
- <td>(IntOpt) Maximum number of attempts to schedule an volume</td>
- </tr>
- <tr>
- <td>scheduler_topic = cinder-scheduler</td>
- <td>(StrOpt) the topic scheduler nodes listen on</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_scheduler">
+ <caption>Description of configuration options for scheduler</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>scheduler_default_filters = AvailabilityZoneFilter, CapacityFilter, CapabilitiesFilter</td>
+ <td>(ListOpt) Which filter class names to use for filtering hosts when not specified in the request.</td>
+ </tr>
+ <tr>
+ <td>scheduler_default_weighers = CapacityWeigher</td>
+ <td>(ListOpt) Which weigher class names to use for weighing hosts.</td>
+ </tr>
+ <tr>
+ <td>scheduler_driver = cinder.scheduler.filter_scheduler.FilterScheduler</td>
+ <td>(StrOpt) Default scheduler driver to use</td>
+ </tr>
+ <tr>
+ <td>scheduler_host_manager = cinder.scheduler.host_manager.HostManager</td>
+ <td>(StrOpt) The scheduler host manager class to use</td>
+ </tr>
+ <tr>
+ <td>scheduler_json_config_location = </td>
+ <td>(StrOpt) Absolute path to scheduler configuration JSON file.</td>
+ </tr>
+ <tr>
+ <td>scheduler_manager = cinder.scheduler.manager.SchedulerManager</td>
+ <td>(StrOpt) Full class name for the Manager for scheduler</td>
+ </tr>
+ <tr>
+ <td>scheduler_max_attempts = 3</td>
+ <td>(IntOpt) Maximum number of attempts to schedule an volume</td>
+ </tr>
+ <tr>
+ <td>scheduler_topic = cinder-scheduler</td>
+ <td>(StrOpt) The topic that scheduler nodes listen on</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-solidfire.xml b/doc/common/tables/cinder-solidfire.xml
index 94c4263856..7aadb4022a 100644
--- a/doc/common/tables/cinder-solidfire.xml
+++ b/doc/common/tables/cinder-solidfire.xml
@@ -1,39 +1,38 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_solidfire">
- <caption>Description of configuration options for solidfire</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>sf_account_prefix = None</td>
- <td>(StrOpt) Create SolidFire accounts with this prefix. Any string can be used here, but the string "hostname" is special and will create a prefix using the cinder node hostsname (previous default behavior). The default is NO prefix.</td>
- </tr>
- <tr>
- <td>sf_allow_tenant_qos = False</td>
- <td>(BoolOpt) Allow tenants to specify QOS on create</td>
- </tr>
- <tr>
- <td>sf_api_port = 443</td>
- <td>(IntOpt) SolidFire API port. Useful if the device api is behind a proxy on a different port.</td>
- </tr>
- <tr>
- <td>sf_emulate_512 = True</td>
- <td>(BoolOpt) Set 512 byte emulation on volume creation; </td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_solidfire">
+ <caption>Description of configuration options for solidfire</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>sf_account_prefix = None</td>
+ <td>(StrOpt) Create SolidFire accounts with this prefix. Any string can be used here, but the string "hostname" is special and will create a prefix using the cinder node hostsname (previous default behavior). The default is NO prefix.</td>
+ </tr>
+ <tr>
+ <td>sf_allow_tenant_qos = False</td>
+ <td>(BoolOpt) Allow tenants to specify QOS on create</td>
+ </tr>
+ <tr>
+ <td>sf_api_port = 443</td>
+ <td>(IntOpt) SolidFire API port. Useful if the device api is behind a proxy on a different port.</td>
+ </tr>
+ <tr>
+ <td>sf_emulate_512 = True</td>
+ <td>(BoolOpt) Set 512 byte emulation on volume creation; </td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-ssl.xml b/doc/common/tables/cinder-ssl.xml
index 9ad62614b8..3e92f049d1 100644
--- a/doc/common/tables/cinder-ssl.xml
+++ b/doc/common/tables/cinder-ssl.xml
@@ -1,35 +1,34 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_ssl">
- <caption>Description of configuration options for ssl</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[ssl]</th>
- </tr>
- <tr>
- <td>ca_file = None</td>
- <td>(StrOpt) CA certificate file to use to verify connecting clients</td>
- </tr>
- <tr>
- <td>cert_file = None</td>
- <td>(StrOpt) Certificate file to use when starting the server securely</td>
- </tr>
- <tr>
- <td>key_file = None</td>
- <td>(StrOpt) Private key file to use when starting the server securely</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_ssl">
+ <caption>Description of configuration options for ssl</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[ssl]</th>
+ </tr>
+ <tr>
+ <td>ca_file = None</td>
+ <td>(StrOpt) CA certificate file to use to verify connecting clients</td>
+ </tr>
+ <tr>
+ <td>cert_file = None</td>
+ <td>(StrOpt) Certificate file to use when starting the server securely</td>
+ </tr>
+ <tr>
+ <td>key_file = None</td>
+ <td>(StrOpt) Private key file to use when starting the server securely</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-storage.xml b/doc/common/tables/cinder-storage.xml
index 9294917573..42aaa6f0d7 100644
--- a/doc/common/tables/cinder-storage.xml
+++ b/doc/common/tables/cinder-storage.xml
@@ -1,158 +1,142 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_storage">
- <caption>Description of configuration options for storage</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>allocated_capacity_weight_multiplier = -1.0</td>
- <td>(FloatOpt) Multiplier used for weighing volume capacity. Negative numbers mean to stack vs spread.</td>
- </tr>
- <tr>
- <td>capacity_weight_multiplier = 1.0</td>
- <td>(FloatOpt) Multiplier used for weighing volume capacity. Negative numbers mean to stack vs spread.</td>
- </tr>
- <tr>
- <td>enabled_backends = None</td>
- <td>(ListOpt) A list of backend names to use. These backend names should be backed by a unique [CONFIG] group with its options</td>
- </tr>
- <tr>
- <td>iscsi_helper = tgtadm</td>
- <td>(StrOpt) iscsi target user-land tool to use</td>
- </tr>
- <tr>
- <td>iscsi_iotype = fileio</td>
- <td>(StrOpt) Sets the behavior of the iSCSI target to either perform blockio or fileio optionally, auto can be set and Cinder will autodetect type of backing device</td>
- </tr>
- <tr>
- <td>iscsi_ip_address = $my_ip</td>
- <td>(StrOpt) The IP address that the iSCSI daemon is listening on</td>
- </tr>
- <tr>
- <td>iscsi_num_targets = 100</td>
- <td>(IntOpt) The maximum number of iscsi target ids per host</td>
- </tr>
- <tr>
- <td>iscsi_port = 3260</td>
- <td>(IntOpt) The port that the iSCSI daemon is listening on</td>
- </tr>
- <tr>
- <td>iscsi_target_prefix = iqn.2010-10.org.openstack:</td>
- <td>(StrOpt) prefix for iscsi volumes</td>
- </tr>
- <tr>
- <td>iser_helper = tgtadm</td>
- <td>(StrOpt) iser target user-land tool to use</td>
- </tr>
- <tr>
- <td>iser_ip_address = $my_ip</td>
- <td>(StrOpt) The IP address that the iSER daemon is listening on</td>
- </tr>
- <tr>
- <td>iser_num_targets = 100</td>
- <td>(IntOpt) The maximum number of iser target ids per host</td>
- </tr>
- <tr>
- <td>iser_port = 3260</td>
- <td>(IntOpt) The port that the iSER daemon is listening on</td>
- </tr>
- <tr>
- <td>iser_target_prefix = iqn.2010-10.org.iser.openstack:</td>
- <td>(StrOpt) prefix for iser volumes</td>
- </tr>
- <tr>
- <td>max_gigabytes = 10000</td>
- <td>(IntOpt) This configure option has been deprecated along with the SimpleScheduler. New scheduler is able to gather capacity information for each host, thus setting the maximum number of volume gigabytes for host is no longer needed. It's safe to remove this configure from cinder.conf.</td>
- </tr>
- <tr>
- <td>migration_create_volume_timeout_secs = 300</td>
- <td>(IntOpt) Timeout for creating the volume to migrate to when performing volume migration (seconds)</td>
- </tr>
- <tr>
- <td>num_iser_scan_tries = 3</td>
- <td>(IntOpt) The maximum number of times to rescan iSER targetto find volume</td>
- </tr>
- <tr>
- <td>num_volume_device_scan_tries = 3</td>
- <td>(IntOpt) The maximum number of times to rescan targets to find volume</td>
- </tr>
- <tr>
- <td>volume_backend_name = None</td>
- <td>(StrOpt) The backend name for a given driver implementation</td>
- </tr>
- <tr>
- <td>volume_clear = zero</td>
- <td>(StrOpt) Method used to wipe old voumes (valid options are: none, zero, shred)</td>
- </tr>
- <tr>
- <td>volume_clear_ionice = None</td>
- <td>(StrOpt) The flag to pass to ionice to alter the i/o priority of the process used to zero a volume after deletion, for example "-c3" for idle only priority.</td>
- </tr>
- <tr>
- <td>volume_clear_size = 0</td>
- <td>(IntOpt) Size in MiB to wipe at start of old volumes. 0 => all</td>
- </tr>
- <tr>
- <td>volume_dd_blocksize = 1M</td>
- <td>(StrOpt) The default block size used when copying/clearing volumes</td>
- </tr>
- <tr>
- <td>volume_driver = cinder.volume.drivers.lvm.LVMISCSIDriver</td>
- <td>(StrOpt) Driver to use for volume creation</td>
- </tr>
- <tr>
- <td>volume_manager = cinder.volume.manager.VolumeManager</td>
- <td>(StrOpt) full class name for the Manager for volume</td>
- </tr>
- <tr>
- <td>volume_service_inithost_offload = False</td>
- <td>(BoolOpt) Offload pending volume delete during volume service startup</td>
- </tr>
- <tr>
- <td>volume_usage_audit_period = month</td>
- <td>(StrOpt) time period to generate volume usages for. Time period must be hour, day, month or year</td>
- </tr>
- <tr>
- <td>volumes_dir = $state_path/volumes</td>
- <td>(StrOpt) Volume configuration file storage directory</td>
- </tr>
- <tr>
- <th colspan="2">[database]</th>
- </tr>
- <tr>
- <td>backend = sqlalchemy</td>
- <td>(StrOpt) The backend to use for db</td>
- </tr>
- <tr>
- <td>max_overflow = None</td>
- <td>(IntOpt) If set, use this value for max_overflow with sqlalchemy</td>
- </tr>
- <tr>
- <td>max_pool_size = 5</td>
- <td>(IntOpt) Maximum number of SQL connections to keep open in a pool</td>
- </tr>
- <tr>
- <td>max_retries = 10</td>
- <td>(IntOpt) maximum db connection retries during startup. (setting -1 implies an infinite retry count)</td>
- </tr>
- <tr>
- <td>min_pool_size = 1</td>
- <td>(IntOpt) Minimum number of SQL connections to keep open in a pool</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_storage">
+ <caption>Description of configuration options for storage</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>allocated_capacity_weight_multiplier = -1.0</td>
+ <td>(FloatOpt) Multiplier used for weighing volume capacity. Negative numbers mean to stack vs spread.</td>
+ </tr>
+ <tr>
+ <td>capacity_weight_multiplier = 1.0</td>
+ <td>(FloatOpt) Multiplier used for weighing volume capacity. Negative numbers mean to stack vs spread.</td>
+ </tr>
+ <tr>
+ <td>enabled_backends = None</td>
+ <td>(ListOpt) A list of backend names to use. These backend names should be backed by a unique [CONFIG] group with its options</td>
+ </tr>
+ <tr>
+ <td>iscsi_helper = tgtadm</td>
+ <td>(StrOpt) iSCSI target user-land tool to use</td>
+ </tr>
+ <tr>
+ <td>iscsi_iotype = fileio</td>
+ <td>(StrOpt) Sets the behavior of the iSCSI target to either perform blockio or fileio optionally, auto can be set and Cinder will autodetect type of backing device</td>
+ </tr>
+ <tr>
+ <td>iscsi_ip_address = $my_ip</td>
+ <td>(StrOpt) The IP address that the iSCSI daemon is listening on</td>
+ </tr>
+ <tr>
+ <td>iscsi_num_targets = 100</td>
+ <td>(IntOpt) The maximum number of iSCSI target IDs per host</td>
+ </tr>
+ <tr>
+ <td>iscsi_port = 3260</td>
+ <td>(IntOpt) The port that the iSCSI daemon is listening on</td>
+ </tr>
+ <tr>
+ <td>iscsi_target_prefix = iqn.2010-10.org.openstack:</td>
+ <td>(StrOpt) Prefix for iSCSI volumes</td>
+ </tr>
+ <tr>
+ <td>iser_helper = tgtadm</td>
+ <td>(StrOpt) The name of the iSER target user-land tool to use</td>
+ </tr>
+ <tr>
+ <td>iser_ip_address = $my_ip</td>
+ <td>(StrOpt) The IP address that the iSER daemon is listening on</td>
+ </tr>
+ <tr>
+ <td>iser_num_targets = 100</td>
+ <td>(IntOpt) The maximum number of iSER target IDs per host</td>
+ </tr>
+ <tr>
+ <td>iser_port = 3260</td>
+ <td>(IntOpt) The port that the iSER daemon is listening on</td>
+ </tr>
+ <tr>
+ <td>iser_target_prefix = iqn.2010-10.org.iser.openstack:</td>
+ <td>(StrOpt) Prefix for iSER volumes</td>
+ </tr>
+ <tr>
+ <td>max_gigabytes = 10000</td>
+ <td>(IntOpt) This configure option has been deprecated along with the SimpleScheduler. New scheduler is able to gather capacity information for each host, thus setting the maximum number of volume gigabytes for host is no longer needed. It's safe to remove this configure from cinder.conf.</td>
+ </tr>
+ <tr>
+ <td>migration_create_volume_timeout_secs = 300</td>
+ <td>(IntOpt) Timeout for creating the volume to migrate to when performing volume migration (seconds)</td>
+ </tr>
+ <tr>
+ <td>num_iser_scan_tries = 3</td>
+ <td>(IntOpt) The maximum number of times to rescan iSER targetto find volume</td>
+ </tr>
+ <tr>
+ <td>num_volume_device_scan_tries = 3</td>
+ <td>(IntOpt) The maximum number of times to rescan targets to find volume</td>
+ </tr>
+ <tr>
+ <td>volume_backend_name = None</td>
+ <td>(StrOpt) The backend name for a given driver implementation</td>
+ </tr>
+ <tr>
+ <td>volume_clear = zero</td>
+ <td>(StrOpt) Method used to wipe old volumes (valid options are: none, zero, shred)</td>
+ </tr>
+ <tr>
+ <td>volume_clear_ionice = None</td>
+ <td>(StrOpt) The flag to pass to ionice to alter the i/o priority of the process used to zero a volume after deletion, for example "-c3" for idle only priority.</td>
+ </tr>
+ <tr>
+ <td>volume_clear_size = 0</td>
+ <td>(IntOpt) Size in MiB to wipe at start of old volumes. 0 => all</td>
+ </tr>
+ <tr>
+ <td>volume_copy_blkio_cgroup_name = cinder-volume-copy</td>
+ <td>(StrOpt) The blkio cgroup name to be used to limit bandwidth of volume copy</td>
+ </tr>
+ <tr>
+ <td>volume_copy_bps_limit = 0</td>
+ <td>(IntOpt) The upper limit of bandwidth of volume copy. 0 => unlimited</td>
+ </tr>
+ <tr>
+ <td>volume_dd_blocksize = 1M</td>
+ <td>(StrOpt) The default block size used when copying/clearing volumes</td>
+ </tr>
+ <tr>
+ <td>volume_driver = cinder.volume.drivers.lvm.LVMISCSIDriver</td>
+ <td>(StrOpt) Driver to use for volume creation</td>
+ </tr>
+ <tr>
+ <td>volume_manager = cinder.volume.manager.VolumeManager</td>
+ <td>(StrOpt) Full class name for the Manager for volume</td>
+ </tr>
+ <tr>
+ <td>volume_service_inithost_offload = False</td>
+ <td>(BoolOpt) Offload pending volume delete during volume service startup</td>
+ </tr>
+ <tr>
+ <td>volume_usage_audit_period = month</td>
+ <td>(StrOpt) Time period for which to generate volume usages. The options are hour, day, month, or year.</td>
+ </tr>
+ <tr>
+ <td>volumes_dir = $state_path/volumes</td>
+ <td>(StrOpt) Volume configuration file storage directory</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-storage_ceph.xml b/doc/common/tables/cinder-storage_ceph.xml
index 91c5c87264..9696259715 100644
--- a/doc/common/tables/cinder-storage_ceph.xml
+++ b/doc/common/tables/cinder-storage_ceph.xml
@@ -1,51 +1,54 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_storage_ceph">
- <caption>Description of configuration options for storage_ceph</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>rbd_ceph_conf = </td>
- <td>(StrOpt) path to the ceph configuration file to use</td>
- </tr>
- <tr>
- <td>rbd_flatten_volume_from_snapshot = False</td>
- <td>(BoolOpt) flatten volumes created from snapshots to remove dependency</td>
- </tr>
- <tr>
- <td>rbd_max_clone_depth = 5</td>
- <td>(IntOpt) maximum number of nested clones that can be taken of a volume before enforcing a flatten prior to next clone. A value of zero disables cloning</td>
- </tr>
- <tr>
- <td>rbd_pool = rbd</td>
- <td>(StrOpt) the RADOS pool in which rbd volumes are stored</td>
- </tr>
- <tr>
- <td>rbd_secret_uuid = None</td>
- <td>(StrOpt) the libvirt uuid of the secret for the rbd_uservolumes</td>
- </tr>
- <tr>
- <td>rbd_user = None</td>
- <td>(StrOpt) the RADOS client name for accessing rbd volumes - only set when using cephx authentication</td>
- </tr>
- <tr>
- <td>volume_tmp_dir = None</td>
- <td>(StrOpt) where to store temporary image files if the volume driver does not write them directly to the volume</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_storage_ceph">
+ <caption>Description of configuration options for storage_ceph</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>rbd_ceph_conf = </td>
+ <td>(StrOpt) Path to the ceph configuration file</td>
+ </tr>
+ <tr>
+ <td>rbd_flatten_volume_from_snapshot = False</td>
+ <td>(BoolOpt) Flatten volumes created from snapshots to remove dependency from volume to snapshot</td>
+ </tr>
+ <tr>
+ <td>rbd_max_clone_depth = 5</td>
+ <td>(IntOpt) Maximum number of nested volume clones that are taken before a flatten occurs. Set to 0 to disable cloning.</td>
+ </tr>
+ <tr>
+ <td>rbd_pool = rbd</td>
+ <td>(StrOpt) The RADOS pool where rbd volumes are stored</td>
+ </tr>
+ <tr>
+ <td>rbd_secret_uuid = None</td>
+ <td>(StrOpt) The libvirt uuid of the secret for the rbd_user volumes</td>
+ </tr>
+ <tr>
+ <td>rbd_store_chunk_size = 4</td>
+ <td>(IntOpt) Volumes will be chunked into objects of this size (in megabytes).</td>
+ </tr>
+ <tr>
+ <td>rbd_user = None</td>
+ <td>(StrOpt) The RADOS client name for accessing rbd volumes - only set when using cephx authentication</td>
+ </tr>
+ <tr>
+ <td>volume_tmp_dir = None</td>
+ <td>(StrOpt) Directory where temporary image files are stored when the volume driver does not write them directly to the volume.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-storage_glusterfs.xml b/doc/common/tables/cinder-storage_glusterfs.xml
index 2df7f980dc..730930cc2b 100644
--- a/doc/common/tables/cinder-storage_glusterfs.xml
+++ b/doc/common/tables/cinder-storage_glusterfs.xml
@@ -1,39 +1,38 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_storage_glusterfs">
- <caption>Description of configuration options for storage_glusterfs</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>glusterfs_mount_point_base = $state_path/mnt</td>
- <td>(StrOpt) Base dir containing mount points for gluster shares.</td>
- </tr>
- <tr>
- <td>glusterfs_qcow2_volumes = False</td>
- <td>(BoolOpt) Create volumes as QCOW2 files rather than raw files.</td>
- </tr>
- <tr>
- <td>glusterfs_shares_config = /etc/cinder/glusterfs_shares</td>
- <td>(StrOpt) File with the list of available gluster shares</td>
- </tr>
- <tr>
- <td>glusterfs_sparsed_volumes = True</td>
- <td>(BoolOpt) Create volumes as sparsed files which take no space.If set to False volume is created as regular file.In such case volume creation takes a lot of time.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_storage_glusterfs">
+ <caption>Description of configuration options for storage_glusterfs</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>glusterfs_mount_point_base = $state_path/mnt</td>
+ <td>(StrOpt) Base dir containing mount points for gluster shares.</td>
+ </tr>
+ <tr>
+ <td>glusterfs_qcow2_volumes = False</td>
+ <td>(BoolOpt) Create volumes as QCOW2 files rather than raw files.</td>
+ </tr>
+ <tr>
+ <td>glusterfs_shares_config = /etc/cinder/glusterfs_shares</td>
+ <td>(StrOpt) File with the list of available gluster shares</td>
+ </tr>
+ <tr>
+ <td>glusterfs_sparsed_volumes = True</td>
+ <td>(BoolOpt) Create volumes as sparsed files which take no space.If set to False volume is created as regular file.In such case volume creation takes a lot of time.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-storage_gpfs.xml b/doc/common/tables/cinder-storage_gpfs.xml
index af62e86722..55a10c40ed 100644
--- a/doc/common/tables/cinder-storage_gpfs.xml
+++ b/doc/common/tables/cinder-storage_gpfs.xml
@@ -1,47 +1,46 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_storage_gpfs">
- <caption>Description of configuration options for storage_gpfs</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>gpfs_images_dir = None</td>
- <td>(StrOpt) Specifies the path of the Image service repository in GPFS. Leave undefined if not storing images in GPFS.</td>
- </tr>
- <tr>
- <td>gpfs_images_share_mode = None</td>
- <td>(StrOpt) Specifies the type of image copy to be used. Set this when the Image service repository also uses GPFS so that image files can be transferred efficiently from the Image service to the Block Storage service. There are two valid values: "copy" specifies that a full copy of the image is made; "copy_on_write" specifies that copy-on-write optimization strategy is used and unmodified blocks of the image file are shared efficiently.</td>
- </tr>
- <tr>
- <td>gpfs_max_clone_depth = 0</td>
- <td>(IntOpt) Specifies an upper limit on the number of indirections required to reach a specific block due to snapshots or clones. A lengthy chain of copy-on-write snapshots or clones can have a negative impact on performance, but improves space utilization. 0 indicates unlimited clone depth.</td>
- </tr>
- <tr>
- <td>gpfs_mount_point_base = None</td>
- <td>(StrOpt) Specifies the path of the GPFS directory where Block Storage volume and snapshot files are stored.</td>
- </tr>
- <tr>
- <td>gpfs_sparse_volumes = True</td>
- <td>(BoolOpt) Specifies that volumes are created as sparse files which initially consume no space. If set to False, the volume is created as a fully allocated file, in which case, creation may take a significantly longer time.</td>
- </tr>
- <tr>
- <td>gpfs_storage_pool = None</td>
- <td>(StrOpt) Specifies the storage pool that volumes are assigned to. By default, the system storage pool is used.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_storage_gpfs">
+ <caption>Description of configuration options for storage_gpfs</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>gpfs_images_dir = None</td>
+ <td>(StrOpt) Specifies the path of the Image service repository in GPFS. Leave undefined if not storing images in GPFS.</td>
+ </tr>
+ <tr>
+ <td>gpfs_images_share_mode = None</td>
+ <td>(StrOpt) Specifies the type of image copy to be used. Set this when the Image service repository also uses GPFS so that image files can be transferred efficiently from the Image service to the Block Storage service. There are two valid values: "copy" specifies that a full copy of the image is made; "copy_on_write" specifies that copy-on-write optimization strategy is used and unmodified blocks of the image file are shared efficiently.</td>
+ </tr>
+ <tr>
+ <td>gpfs_max_clone_depth = 0</td>
+ <td>(IntOpt) Specifies an upper limit on the number of indirections required to reach a specific block due to snapshots or clones. A lengthy chain of copy-on-write snapshots or clones can have a negative impact on performance, but improves space utilization. 0 indicates unlimited clone depth.</td>
+ </tr>
+ <tr>
+ <td>gpfs_mount_point_base = None</td>
+ <td>(StrOpt) Specifies the path of the GPFS directory where Block Storage volume and snapshot files are stored.</td>
+ </tr>
+ <tr>
+ <td>gpfs_sparse_volumes = True</td>
+ <td>(BoolOpt) Specifies that volumes are created as sparse files which initially consume no space. If set to False, the volume is created as a fully allocated file, in which case, creation may take a significantly longer time.</td>
+ </tr>
+ <tr>
+ <td>gpfs_storage_pool = None</td>
+ <td>(StrOpt) Specifies the storage pool that volumes are assigned to. By default, the system storage pool is used.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-storage_nfs.xml b/doc/common/tables/cinder-storage_nfs.xml
index 4cb5f1c8e9..250f2c75ff 100644
--- a/doc/common/tables/cinder-storage_nfs.xml
+++ b/doc/common/tables/cinder-storage_nfs.xml
@@ -1,47 +1,46 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_storage_nfs">
- <caption>Description of configuration options for storage_nfs</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>nfs_mount_options = None</td>
- <td>(StrOpt) Mount options passed to the nfs client. See section of the nfs man page for details.</td>
- </tr>
- <tr>
- <td>nfs_mount_point_base = $state_path/mnt</td>
- <td>(StrOpt) Base dir containing mount points for nfs shares.</td>
- </tr>
- <tr>
- <td>nfs_oversub_ratio = 1.0</td>
- <td>(FloatOpt) This will compare the allocated to available space on the volume destination. If the ratio exceeds this number, the destination will no longer be valid.</td>
- </tr>
- <tr>
- <td>nfs_shares_config = /etc/cinder/nfs_shares</td>
- <td>(StrOpt) File with the list of available nfs shares</td>
- </tr>
- <tr>
- <td>nfs_sparsed_volumes = True</td>
- <td>(BoolOpt) Create volumes as sparsed files which take no space.If set to False volume is created as regular file.In such case volume creation takes a lot of time.</td>
- </tr>
- <tr>
- <td>nfs_used_ratio = 0.95</td>
- <td>(FloatOpt) Percent of ACTUAL usage of the underlying volume before no new volumes can be allocated to the volume destination.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_storage_nfs">
+ <caption>Description of configuration options for storage_nfs</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>nfs_mount_options = None</td>
+ <td>(StrOpt) Mount options passed to the nfs client. See section of the nfs man page for details.</td>
+ </tr>
+ <tr>
+ <td>nfs_mount_point_base = $state_path/mnt</td>
+ <td>(StrOpt) Base dir containing mount points for nfs shares.</td>
+ </tr>
+ <tr>
+ <td>nfs_oversub_ratio = 1.0</td>
+ <td>(FloatOpt) This will compare the allocated to available space on the volume destination. If the ratio exceeds this number, the destination will no longer be valid.</td>
+ </tr>
+ <tr>
+ <td>nfs_shares_config = /etc/cinder/nfs_shares</td>
+ <td>(StrOpt) File with the list of available nfs shares</td>
+ </tr>
+ <tr>
+ <td>nfs_sparsed_volumes = True</td>
+ <td>(BoolOpt) Create volumes as sparsed files which take no space.If set to False volume is created as regular file.In such case volume creation takes a lot of time.</td>
+ </tr>
+ <tr>
+ <td>nfs_used_ratio = 0.95</td>
+ <td>(FloatOpt) Percent of ACTUAL usage of the underlying volume before no new volumes can be allocated to the volume destination.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-storage_xen.xml b/doc/common/tables/cinder-storage_xen.xml
index ac7071cb98..cc1813b399 100644
--- a/doc/common/tables/cinder-storage_xen.xml
+++ b/doc/common/tables/cinder-storage_xen.xml
@@ -1,47 +1,46 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_storage_xen">
- <caption>Description of configuration options for storage_xen</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>xenapi_connection_password = None</td>
- <td>(StrOpt) Password for XenAPI connection</td>
- </tr>
- <tr>
- <td>xenapi_connection_url = None</td>
- <td>(StrOpt) URL for XenAPI connection</td>
- </tr>
- <tr>
- <td>xenapi_connection_username = root</td>
- <td>(StrOpt) Username for XenAPI connection</td>
- </tr>
- <tr>
- <td>xenapi_nfs_server = None</td>
- <td>(StrOpt) NFS server to be used by XenAPINFSDriver</td>
- </tr>
- <tr>
- <td>xenapi_nfs_serverpath = None</td>
- <td>(StrOpt) Path of exported NFS, used by XenAPINFSDriver</td>
- </tr>
- <tr>
- <td>xenapi_sr_base_path = /var/run/sr-mount</td>
- <td>(StrOpt) Base path to the storage repository</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_storage_xen">
+ <caption>Description of configuration options for storage_xen</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>xenapi_connection_password = None</td>
+ <td>(StrOpt) Password for XenAPI connection</td>
+ </tr>
+ <tr>
+ <td>xenapi_connection_url = None</td>
+ <td>(StrOpt) URL for XenAPI connection</td>
+ </tr>
+ <tr>
+ <td>xenapi_connection_username = root</td>
+ <td>(StrOpt) Username for XenAPI connection</td>
+ </tr>
+ <tr>
+ <td>xenapi_nfs_server = None</td>
+ <td>(StrOpt) NFS server to be used by XenAPINFSDriver</td>
+ </tr>
+ <tr>
+ <td>xenapi_nfs_serverpath = None</td>
+ <td>(StrOpt) Path of exported NFS, used by XenAPINFSDriver</td>
+ </tr>
+ <tr>
+ <td>xenapi_sr_base_path = /var/run/sr-mount</td>
+ <td>(StrOpt) Base path to the storage repository</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-storwize.xml b/doc/common/tables/cinder-storwize.xml
index 14ab6f628a..d551f49bfb 100644
--- a/doc/common/tables/cinder-storwize.xml
+++ b/doc/common/tables/cinder-storwize.xml
@@ -1,75 +1,74 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_storwize">
- <caption>Description of configuration options for storwize</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>storwize_svc_connection_protocol = iSCSI</td>
- <td>(StrOpt) Connection protocol (iSCSI/FC)</td>
- </tr>
- <tr>
- <td>storwize_svc_flashcopy_timeout = 120</td>
- <td>(IntOpt) Maximum number of seconds to wait for FlashCopy to be prepared. Maximum value is 600 seconds (10 minutes)</td>
- </tr>
- <tr>
- <td>storwize_svc_iscsi_chap_enabled = True</td>
- <td>(BoolOpt) Configure CHAP authentication for iSCSI connections (Default: Enabled)</td>
- </tr>
- <tr>
- <td>storwize_svc_multihostmap_enabled = True</td>
- <td>(BoolOpt) Allows vdisk to multi host mapping</td>
- </tr>
- <tr>
- <td>storwize_svc_multipath_enabled = False</td>
- <td>(BoolOpt) Connect with multipath (FC only; iSCSI multipath is controlled by Nova)</td>
- </tr>
- <tr>
- <td>storwize_svc_vol_autoexpand = True</td>
- <td>(BoolOpt) Storage system autoexpand parameter for volumes (True/False)</td>
- </tr>
- <tr>
- <td>storwize_svc_vol_compression = False</td>
- <td>(BoolOpt) Storage system compression option for volumes</td>
- </tr>
- <tr>
- <td>storwize_svc_vol_easytier = True</td>
- <td>(BoolOpt) Enable Easy Tier for volumes</td>
- </tr>
- <tr>
- <td>storwize_svc_vol_grainsize = 256</td>
- <td>(IntOpt) Storage system grain size parameter for volumes (32/64/128/256)</td>
- </tr>
- <tr>
- <td>storwize_svc_vol_iogrp = 0</td>
- <td>(IntOpt) The I/O group in which to allocate volumes</td>
- </tr>
- <tr>
- <td>storwize_svc_vol_rsize = 2</td>
- <td>(IntOpt) Storage system space-efficiency parameter for volumes (percentage)</td>
- </tr>
- <tr>
- <td>storwize_svc_vol_warning = 0</td>
- <td>(IntOpt) Storage system threshold for volume capacity warnings (percentage)</td>
- </tr>
- <tr>
- <td>storwize_svc_volpool_name = volpool</td>
- <td>(StrOpt) Storage system storage pool for volumes</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_storwize">
+ <caption>Description of configuration options for storwize</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>storwize_svc_connection_protocol = iSCSI</td>
+ <td>(StrOpt) Connection protocol (iSCSI/FC)</td>
+ </tr>
+ <tr>
+ <td>storwize_svc_flashcopy_timeout = 120</td>
+ <td>(IntOpt) Maximum number of seconds to wait for FlashCopy to be prepared. Maximum value is 600 seconds (10 minutes)</td>
+ </tr>
+ <tr>
+ <td>storwize_svc_iscsi_chap_enabled = True</td>
+ <td>(BoolOpt) Configure CHAP authentication for iSCSI connections (Default: Enabled)</td>
+ </tr>
+ <tr>
+ <td>storwize_svc_multihostmap_enabled = True</td>
+ <td>(BoolOpt) Allows vdisk to multi host mapping</td>
+ </tr>
+ <tr>
+ <td>storwize_svc_multipath_enabled = False</td>
+ <td>(BoolOpt) Connect with multipath (FC only; iSCSI multipath is controlled by Nova)</td>
+ </tr>
+ <tr>
+ <td>storwize_svc_vol_autoexpand = True</td>
+ <td>(BoolOpt) Storage system autoexpand parameter for volumes (True/False)</td>
+ </tr>
+ <tr>
+ <td>storwize_svc_vol_compression = False</td>
+ <td>(BoolOpt) Storage system compression option for volumes</td>
+ </tr>
+ <tr>
+ <td>storwize_svc_vol_easytier = True</td>
+ <td>(BoolOpt) Enable Easy Tier for volumes</td>
+ </tr>
+ <tr>
+ <td>storwize_svc_vol_grainsize = 256</td>
+ <td>(IntOpt) Storage system grain size parameter for volumes (32/64/128/256)</td>
+ </tr>
+ <tr>
+ <td>storwize_svc_vol_iogrp = 0</td>
+ <td>(IntOpt) The I/O group in which to allocate volumes</td>
+ </tr>
+ <tr>
+ <td>storwize_svc_vol_rsize = 2</td>
+ <td>(IntOpt) Storage system space-efficiency parameter for volumes (percentage)</td>
+ </tr>
+ <tr>
+ <td>storwize_svc_vol_warning = 0</td>
+ <td>(IntOpt) Storage system threshold for volume capacity warnings (percentage)</td>
+ </tr>
+ <tr>
+ <td>storwize_svc_volpool_name = volpool</td>
+ <td>(StrOpt) Storage system storage pool for volumes</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-vmware.xml b/doc/common/tables/cinder-vmware.xml
index 87b4657fc7..70cbb96dc7 100644
--- a/doc/common/tables/cinder-vmware.xml
+++ b/doc/common/tables/cinder-vmware.xml
@@ -1,63 +1,62 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_vmware">
- <caption>Description of configuration options for vmware</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>vmware_api_retry_count = 10</td>
- <td>(IntOpt) Number of times VMware ESX/VC server API must be retried upon connection related issues.</td>
- </tr>
- <tr>
- <td>vmware_host_ip = None</td>
- <td>(StrOpt) IP address for connecting to VMware ESX/VC server.</td>
- </tr>
- <tr>
- <td>vmware_host_password = None</td>
- <td>(StrOpt) Password for authenticating with VMware ESX/VC server.</td>
- </tr>
- <tr>
- <td>vmware_host_username = None</td>
- <td>(StrOpt) Username for authenticating with VMware ESX/VC server.</td>
- </tr>
- <tr>
- <td>vmware_host_version = None</td>
- <td>(StrOpt) Optional string specifying the VMware VC server version. The driver attempts to retrieve the version from VMware VC server. Set this configuration only if you want to override the VC server version.</td>
- </tr>
- <tr>
- <td>vmware_image_transfer_timeout_secs = 7200</td>
- <td>(IntOpt) Timeout in seconds for VMDK volume transfer between Cinder and Glance.</td>
- </tr>
- <tr>
- <td>vmware_max_objects_retrieval = 100</td>
- <td>(IntOpt) Max number of objects to be retrieved per batch. Query results will be obtained in batches from the server and not in one shot. Server may still limit the count to something less than the configured value.</td>
- </tr>
- <tr>
- <td>vmware_task_poll_interval = 5</td>
- <td>(IntOpt) The interval (in seconds) for polling remote tasks invoked on VMware ESX/VC server.</td>
- </tr>
- <tr>
- <td>vmware_volume_folder = cinder-volumes</td>
- <td>(StrOpt) Name for the folder in the VC datacenter that will contain cinder volumes.</td>
- </tr>
- <tr>
- <td>vmware_wsdl_location = None</td>
- <td>(StrOpt) Optional VIM service WSDL Location e.g http://<server>/vimService.wsdl. Optional over-ride to default location for bug work-arounds.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_vmware">
+ <caption>Description of configuration options for vmware</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>vmware_api_retry_count = 10</td>
+ <td>(IntOpt) Number of times VMware ESX/VC server API must be retried upon connection related issues.</td>
+ </tr>
+ <tr>
+ <td>vmware_host_ip = None</td>
+ <td>(StrOpt) IP address for connecting to VMware ESX/VC server.</td>
+ </tr>
+ <tr>
+ <td>vmware_host_password = None</td>
+ <td>(StrOpt) Password for authenticating with VMware ESX/VC server.</td>
+ </tr>
+ <tr>
+ <td>vmware_host_username = None</td>
+ <td>(StrOpt) Username for authenticating with VMware ESX/VC server.</td>
+ </tr>
+ <tr>
+ <td>vmware_host_version = None</td>
+ <td>(StrOpt) Optional string specifying the VMware VC server version. The driver attempts to retrieve the version from VMware VC server. Set this configuration only if you want to override the VC server version.</td>
+ </tr>
+ <tr>
+ <td>vmware_image_transfer_timeout_secs = 7200</td>
+ <td>(IntOpt) Timeout in seconds for VMDK volume transfer between Cinder and Glance.</td>
+ </tr>
+ <tr>
+ <td>vmware_max_objects_retrieval = 100</td>
+ <td>(IntOpt) Max number of objects to be retrieved per batch. Query results will be obtained in batches from the server and not in one shot. Server may still limit the count to something less than the configured value.</td>
+ </tr>
+ <tr>
+ <td>vmware_task_poll_interval = 5</td>
+ <td>(IntOpt) The interval (in seconds) for polling remote tasks invoked on VMware ESX/VC server.</td>
+ </tr>
+ <tr>
+ <td>vmware_volume_folder = cinder-volumes</td>
+ <td>(StrOpt) Name for the folder in the VC datacenter that will contain cinder volumes.</td>
+ </tr>
+ <tr>
+ <td>vmware_wsdl_location = None</td>
+ <td>(StrOpt) Optional VIM service WSDL Location e.g http://<server>/vimService.wsdl. Optional over-ride to default location for bug work-arounds.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-windows.xml b/doc/common/tables/cinder-windows.xml
index 0d72b580fa..110665b990 100644
--- a/doc/common/tables/cinder-windows.xml
+++ b/doc/common/tables/cinder-windows.xml
@@ -1,27 +1,26 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_windows">
- <caption>Description of configuration options for windows</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>windows_iscsi_lun_path = C:\iSCSIVirtualDisks</td>
- <td>(StrOpt) Path to store VHD backed volumes</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_windows">
+ <caption>Description of configuration options for windows</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>windows_iscsi_lun_path = C:\iSCSIVirtualDisks</td>
+ <td>(StrOpt) Path to store VHD backed volumes</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-xiv.xml b/doc/common/tables/cinder-xiv.xml
index eaaaee380f..60781d7569 100644
--- a/doc/common/tables/cinder-xiv.xml
+++ b/doc/common/tables/cinder-xiv.xml
@@ -1,35 +1,34 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_xiv">
- <caption>Description of configuration options for xiv</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>xiv_chap = disabled</td>
- <td>(StrOpt) CHAP authentication mode, effective only for iscsi (disabled|enabled)</td>
- </tr>
- <tr>
- <td>xiv_ds8k_connection_type = iscsi</td>
- <td>(StrOpt) Connection type to the IBM Storage Array (fibre_channel|iscsi)</td>
- </tr>
- <tr>
- <td>xiv_ds8k_proxy = xiv_ds8k_openstack.nova_proxy.XIVDS8KNovaProxy</td>
- <td>(StrOpt) Proxy driver that connects to the IBM Storage Array</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_xiv">
+ <caption>Description of configuration options for xiv</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>xiv_chap = disabled</td>
+ <td>(StrOpt) CHAP authentication mode, effective only for iscsi (disabled|enabled)</td>
+ </tr>
+ <tr>
+ <td>xiv_ds8k_connection_type = iscsi</td>
+ <td>(StrOpt) Connection type to the IBM Storage Array (fibre_channel|iscsi)</td>
+ </tr>
+ <tr>
+ <td>xiv_ds8k_proxy = xiv_ds8k_openstack.nova_proxy.XIVDS8KNovaProxy</td>
+ <td>(StrOpt) Proxy driver that connects to the IBM Storage Array</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-zadara.xml b/doc/common/tables/cinder-zadara.xml
index fa15573849..3995bc3e78 100644
--- a/doc/common/tables/cinder-zadara.xml
+++ b/doc/common/tables/cinder-zadara.xml
@@ -1,67 +1,66 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_zadara">
- <caption>Description of configuration options for zadara</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>zadara_password = None</td>
- <td>(StrOpt) Password for the VPSA</td>
- </tr>
- <tr>
- <td>zadara_user = None</td>
- <td>(StrOpt) User name for the VPSA</td>
- </tr>
- <tr>
- <td>zadara_vol_encrypt = False</td>
- <td>(BoolOpt) Default encryption policy for volumes</td>
- </tr>
- <tr>
- <td>zadara_vol_name_template = OS_%s</td>
- <td>(StrOpt) Default template for VPSA volume names</td>
- </tr>
- <tr>
- <td>zadara_vol_thin = True</td>
- <td>(BoolOpt) Default thin provisioning policy for volumes</td>
- </tr>
- <tr>
- <td>zadara_vpsa_allow_nonexistent_delete = True</td>
- <td>(BoolOpt) Don't halt on deletion of non-existing volumes</td>
- </tr>
- <tr>
- <td>zadara_vpsa_auto_detach_on_delete = True</td>
- <td>(BoolOpt) Automatically detach from servers on volume delete</td>
- </tr>
- <tr>
- <td>zadara_vpsa_ip = None</td>
- <td>(StrOpt) Management IP of Zadara VPSA</td>
- </tr>
- <tr>
- <td>zadara_vpsa_poolname = None</td>
- <td>(StrOpt) Name of VPSA storage pool for volumes</td>
- </tr>
- <tr>
- <td>zadara_vpsa_port = None</td>
- <td>(StrOpt) Zadara VPSA port number</td>
- </tr>
- <tr>
- <td>zadara_vpsa_use_ssl = False</td>
- <td>(BoolOpt) Use SSL connection</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_zadara">
+ <caption>Description of configuration options for zadara</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>zadara_password = None</td>
+ <td>(StrOpt) Password for the VPSA</td>
+ </tr>
+ <tr>
+ <td>zadara_user = None</td>
+ <td>(StrOpt) User name for the VPSA</td>
+ </tr>
+ <tr>
+ <td>zadara_vol_encrypt = False</td>
+ <td>(BoolOpt) Default encryption policy for volumes</td>
+ </tr>
+ <tr>
+ <td>zadara_vol_name_template = OS_%s</td>
+ <td>(StrOpt) Default template for VPSA volume names</td>
+ </tr>
+ <tr>
+ <td>zadara_vol_thin = True</td>
+ <td>(BoolOpt) Default thin provisioning policy for volumes</td>
+ </tr>
+ <tr>
+ <td>zadara_vpsa_allow_nonexistent_delete = True</td>
+ <td>(BoolOpt) Don't halt on deletion of non-existing volumes</td>
+ </tr>
+ <tr>
+ <td>zadara_vpsa_auto_detach_on_delete = True</td>
+ <td>(BoolOpt) Automatically detach from servers on volume delete</td>
+ </tr>
+ <tr>
+ <td>zadara_vpsa_ip = None</td>
+ <td>(StrOpt) Management IP of Zadara VPSA</td>
+ </tr>
+ <tr>
+ <td>zadara_vpsa_poolname = None</td>
+ <td>(StrOpt) Name of VPSA storage pool for volumes</td>
+ </tr>
+ <tr>
+ <td>zadara_vpsa_port = None</td>
+ <td>(StrOpt) Zadara VPSA port number</td>
+ </tr>
+ <tr>
+ <td>zadara_vpsa_use_ssl = False</td>
+ <td>(BoolOpt) Use SSL connection</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-zones.xml b/doc/common/tables/cinder-zones.xml
index 3cef453ae9..ea0880b5ef 100644
--- a/doc/common/tables/cinder-zones.xml
+++ b/doc/common/tables/cinder-zones.xml
@@ -1,27 +1,26 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_zones">
- <caption>Description of configuration options for zones</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>cloned_volume_same_az = True</td>
- <td>(BoolOpt) Ensure that the new volumes are the same AZ as snapshot or source volume</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_zones">
+ <caption>Description of configuration options for zones</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>cloned_volume_same_az = True</td>
+ <td>(BoolOpt) Ensure that the new volumes are the same AZ as snapshot or source volume</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-zoning.xml b/doc/common/tables/cinder-zoning.xml
index 4c1f8b7e42..9f92436613 100644
--- a/doc/common/tables/cinder-zoning.xml
+++ b/doc/common/tables/cinder-zoning.xml
@@ -1,38 +1,37 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_zoning">
- <caption>Description of configuration options for zoning</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>zoning_mode = none</td>
- <td>(StrOpt) FC Zoning mode configured</td>
- </tr>
- <tr>
- <th colspan="2">[fc-zone-manager]</th>
- </tr>
- <tr>
- <td>fc_fabric_names = None</td>
- <td>(StrOpt) Comma separated list of fibre channel fabric names. This list of names is used to retrieve other SAN credentials for connecting to each SAN fabric</td>
- </tr>
- <tr>
- <td>zoning_policy = initiator-target</td>
- <td>(StrOpt) Zoning policy configured by user</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_zoning">
+ <caption>Description of configuration options for zoning</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>zoning_mode = none</td>
+ <td>(StrOpt) FC Zoning mode configured</td>
+ </tr>
+ <tr>
+ <th colspan="2">[fc-zone-manager]</th>
+ </tr>
+ <tr>
+ <td>fc_fabric_names = None</td>
+ <td>(StrOpt) Comma separated list of fibre channel fabric names. This list of names is used to retrieve other SAN credentials for connecting to each SAN fabric</td>
+ </tr>
+ <tr>
+ <td>zoning_policy = initiator-target</td>
+ <td>(StrOpt) Zoning policy configured by user</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-zoning_fabric.xml b/doc/common/tables/cinder-zoning_fabric.xml
index c239692712..d8e2afb9e4 100644
--- a/doc/common/tables/cinder-zoning_fabric.xml
+++ b/doc/common/tables/cinder-zoning_fabric.xml
@@ -1,55 +1,54 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_zoning_fabric">
- <caption>Description of configuration options for zoning_fabric</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">[BRCD_FABRIC_EXAMPLE]</th>
- </tr>
- <tr>
- <td>fc_fabric_address = </td>
- <td>(StrOpt) Management IP of fabric</td>
- </tr>
- <tr>
- <td>fc_fabric_password = </td>
- <td>(StrOpt) Password for user</td>
- </tr>
- <tr>
- <td>fc_fabric_port = 22</td>
- <td>(IntOpt) Connecting port</td>
- </tr>
- <tr>
- <td>fc_fabric_user = </td>
- <td>(StrOpt) Fabric user ID</td>
- </tr>
- <tr>
- <td>principal_switch_wwn = None</td>
- <td>(StrOpt) Principal switch WWN of the fabric</td>
- </tr>
- <tr>
- <td>zone_activate = True</td>
- <td>(BoolOpt) overridden zoning activation state</td>
- </tr>
- <tr>
- <td>zone_name_prefix = None</td>
- <td>(StrOpt) overridden zone name prefix</td>
- </tr>
- <tr>
- <td>zoning_policy = initiator-target</td>
- <td>(StrOpt) overridden zoning policy</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_zoning_fabric">
+ <caption>Description of configuration options for zoning_fabric</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">[BRCD_FABRIC_EXAMPLE]</th>
+ </tr>
+ <tr>
+ <td>fc_fabric_address = </td>
+ <td>(StrOpt) Management IP of fabric</td>
+ </tr>
+ <tr>
+ <td>fc_fabric_password = </td>
+ <td>(StrOpt) Password for user</td>
+ </tr>
+ <tr>
+ <td>fc_fabric_port = 22</td>
+ <td>(IntOpt) Connecting port</td>
+ </tr>
+ <tr>
+ <td>fc_fabric_user = </td>
+ <td>(StrOpt) Fabric user ID</td>
+ </tr>
+ <tr>
+ <td>principal_switch_wwn = None</td>
+ <td>(StrOpt) Principal switch WWN of the fabric</td>
+ </tr>
+ <tr>
+ <td>zone_activate = True</td>
+ <td>(BoolOpt) overridden zoning activation state</td>
+ </tr>
+ <tr>
+ <td>zone_name_prefix = None</td>
+ <td>(StrOpt) overridden zone name prefix</td>
+ </tr>
+ <tr>
+ <td>zoning_policy = initiator-target</td>
+ <td>(StrOpt) overridden zoning policy</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/cinder-zoning_manager.xml b/doc/common/tables/cinder-zoning_manager.xml
index de83126882..1286ab9597 100644
--- a/doc/common/tables/cinder-zoning_manager.xml
+++ b/doc/common/tables/cinder-zoning_manager.xml
@@ -1,35 +1,34 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_cinder_zoning_manager">
- <caption>Description of configuration options for zoning_manager</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">[fc-zone-manager]</th>
- </tr>
- <tr>
- <td>brcd_sb_connector = cinder.zonemanager.drivers.brocade.brcd_fc_zone_client_cli.BrcdFCZoneClientCLI</td>
- <td>(StrOpt) Southbound connector for zoning operation</td>
- </tr>
- <tr>
- <td>fc_san_lookup_service = cinder.zonemanager.drivers.brocade.brcd_fc_san_lookup_service.BrcdFCSanLookupService</td>
- <td>(StrOpt) FC San Lookup Service</td>
- </tr>
- <tr>
- <td>zone_driver = cinder.zonemanager.drivers.brocade.brcd_fc_zone_driver.BrcdFCZoneDriver</td>
- <td>(StrOpt) FC Zone Driver responsible for zone management</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_zoning_manager">
+ <caption>Description of configuration options for zoning_manager</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">[fc-zone-manager]</th>
+ </tr>
+ <tr>
+ <td>brcd_sb_connector = cinder.zonemanager.drivers.brocade.brcd_fc_zone_client_cli.BrcdFCZoneClientCLI</td>
+ <td>(StrOpt) Southbound connector for zoning operation</td>
+ </tr>
+ <tr>
+ <td>fc_san_lookup_service = cinder.zonemanager.drivers.brocade.brcd_fc_san_lookup_service.BrcdFCSanLookupService</td>
+ <td>(StrOpt) FC San Lookup Service</td>
+ </tr>
+ <tr>
+ <td>zone_driver = cinder.zonemanager.drivers.brocade.brcd_fc_zone_driver.BrcdFCZoneDriver</td>
+ <td>(StrOpt) FC Zone Driver responsible for zone management</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/glance-amqp.xml b/doc/common/tables/glance-amqp.xml
index 437fb3962f..adf39188db 100644
--- a/doc/common/tables/glance-amqp.xml
+++ b/doc/common/tables/glance-amqp.xml
@@ -1,59 +1,58 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_glance_amqp">
- <caption>Description of configuration options for amqp</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>amqp_auto_delete = False</td>
- <td>(BoolOpt) Auto-delete queues in amqp.</td>
- </tr>
- <tr>
- <td>amqp_durable_queues = False</td>
- <td>(BoolOpt) Use durable queues in amqp.</td>
- </tr>
- <tr>
- <td>notification_driver = []</td>
- <td>(MultiStrOpt) Driver or drivers to handle sending notifications.</td>
- </tr>
- <tr>
- <td>notification_topics = notifications</td>
- <td>(ListOpt) AMQP topic used for OpenStack notifications.</td>
- </tr>
- <tr>
- <td>rpc_backend = rabbit</td>
- <td>(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq.</td>
- </tr>
- <tr>
- <td>rpc_conn_pool_size = 30</td>
- <td>(IntOpt) Size of RPC connection pool.</td>
- </tr>
- <tr>
- <td>rpc_response_timeout = 60</td>
- <td>(IntOpt) Seconds to wait for a response from a call.</td>
- </tr>
- <tr>
- <td>rpc_thread_pool_size = 64</td>
- <td>(IntOpt) Size of RPC greenthread pool.</td>
- </tr>
- <tr>
- <td>transport_url = None</td>
- <td>(StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_glance_amqp">
+ <caption>Description of configuration options for amqp</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>amqp_auto_delete = False</td>
+ <td>(BoolOpt) Auto-delete queues in amqp.</td>
+ </tr>
+ <tr>
+ <td>amqp_durable_queues = False</td>
+ <td>(BoolOpt) Use durable queues in amqp.</td>
+ </tr>
+ <tr>
+ <td>notification_driver = []</td>
+ <td>(MultiStrOpt) Driver or drivers to handle sending notifications.</td>
+ </tr>
+ <tr>
+ <td>notification_topics = notifications</td>
+ <td>(ListOpt) AMQP topic used for OpenStack notifications.</td>
+ </tr>
+ <tr>
+ <td>rpc_backend = rabbit</td>
+ <td>(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq.</td>
+ </tr>
+ <tr>
+ <td>rpc_conn_pool_size = 30</td>
+ <td>(IntOpt) Size of RPC connection pool.</td>
+ </tr>
+ <tr>
+ <td>rpc_response_timeout = 60</td>
+ <td>(IntOpt) Seconds to wait for a response from a call.</td>
+ </tr>
+ <tr>
+ <td>rpc_thread_pool_size = 64</td>
+ <td>(IntOpt) Size of RPC greenthread pool.</td>
+ </tr>
+ <tr>
+ <td>transport_url = None</td>
+ <td>(StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/glance-api.xml b/doc/common/tables/glance-api.xml
index 45b236513a..268dcd139c 100644
--- a/doc/common/tables/glance-api.xml
+++ b/doc/common/tables/glance-api.xml
@@ -1,90 +1,89 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_glance_api">
- <caption>Description of configuration options for api</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>admin_role = admin</td>
- <td>(StrOpt) Role used to identify an authenticated user as administrator.</td>
- </tr>
- <tr>
- <td>allow_anonymous_access = False</td>
- <td>(BoolOpt) Allow unauthenticated users to access the API with read-only privileges. This only applies when using ContextMiddleware.</td>
- </tr>
- <tr>
- <td>default_publisher_id = image.localhost</td>
- <td>(StrOpt) Default publisher_id for outgoing notifications.</td>
- </tr>
- <tr>
- <td>default_store = file</td>
- <td>(StrOpt) Default scheme to use to store image data. The scheme must be registered by one of the stores defined by the 'known_stores' config option.</td>
- </tr>
- <tr>
- <td>enable_v1_api = True</td>
- <td>(BoolOpt) Deploy the v1 OpenStack Images API.</td>
- </tr>
- <tr>
- <td>enable_v1_registry = True</td>
- <td>(BoolOpt) Deploy the v1 OpenStack Registry API.</td>
- </tr>
- <tr>
- <td>enable_v2_api = True</td>
- <td>(BoolOpt) Deploy the v2 OpenStack Images API.</td>
- </tr>
- <tr>
- <td>enable_v2_registry = True</td>
- <td>(BoolOpt) Deploy the v2 OpenStack Registry API.</td>
- </tr>
- <tr>
- <td>image_size_cap = 1099511627776</td>
- <td>(IntOpt) Maximum size of image a user can upload in bytes. Defaults to 1099511627776 bytes (1 TB).</td>
- </tr>
- <tr>
- <td>known_stores = glance.store.filesystem.Store, glance.store.http.Store</td>
- <td>(ListOpt) List of which store classes and store class locations are currently known to glance at startup.</td>
- </tr>
- <tr>
- <td>location_strategy = location_order</td>
- <td>(StrOpt) This value sets what strategy will be used to determine the image location order. Currently two strategies are packaged with Glance 'location_order' and 'store_type'.</td>
- </tr>
- <tr>
- <td>owner_is_tenant = True</td>
- <td>(BoolOpt) When true, this option sets the owner of an image to be the tenant. Otherwise, the owner of the image will be the authenticated user issuing the request.</td>
- </tr>
- <tr>
- <td>send_identity_headers = False</td>
- <td>(BoolOpt) Whether to pass through headers containing user and tenant information when making requests to the registry. This allows the registry to use the context middleware without the keystoneclients' auth_token middleware, removing calls to the keystone auth service. It is recommended that when using this option, secure communication between glance api and glance registry is ensured by means other than auth_token middleware.</td>
- </tr>
- <tr>
- <td>show_multiple_locations = False</td>
- <td>(BoolOpt) Whether to include the backend image locations in image properties. Revealing storage location can be a security risk, so use this setting with caution! The overrides show_image_direct_url.</td>
- </tr>
- <tr>
- <td>use_user_token = True</td>
- <td>(BoolOpt) Whether to pass through the user token when making requests to the registry.</td>
- </tr>
- <tr>
- <th colspan="2">[store_type_location_strategy]</th>
- </tr>
- <tr>
- <td>store_type_preference = </td>
- <td>(ListOpt) The store names to use to get store preference order. The name must be registered by one of the stores defined by the 'known_stores' config option. This option will be applied when you using 'store_type' option as image location strategy defined by the 'location_strategy' config option.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_glance_api">
+ <caption>Description of configuration options for api</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>admin_role = admin</td>
+ <td>(StrOpt) Role used to identify an authenticated user as administrator.</td>
+ </tr>
+ <tr>
+ <td>allow_anonymous_access = False</td>
+ <td>(BoolOpt) Allow unauthenticated users to access the API with read-only privileges. This only applies when using ContextMiddleware.</td>
+ </tr>
+ <tr>
+ <td>default_store = file</td>
+ <td>(StrOpt) Default scheme to use to store image data. The scheme must be registered by one of the stores defined by the 'known_stores' config option.</td>
+ </tr>
+ <tr>
+ <td>default_swift_reference = ref1</td>
+ <td>(StrOpt) The reference to the default swift account/backing store parameters to use for adding new images.</td>
+ </tr>
+ <tr>
+ <td>enable_v1_api = True</td>
+ <td>(BoolOpt) Deploy the v1 OpenStack Images API.</td>
+ </tr>
+ <tr>
+ <td>enable_v1_registry = True</td>
+ <td>(BoolOpt) Deploy the v1 OpenStack Registry API.</td>
+ </tr>
+ <tr>
+ <td>enable_v2_api = True</td>
+ <td>(BoolOpt) Deploy the v2 OpenStack Images API.</td>
+ </tr>
+ <tr>
+ <td>enable_v2_registry = True</td>
+ <td>(BoolOpt) Deploy the v2 OpenStack Registry API.</td>
+ </tr>
+ <tr>
+ <td>image_size_cap = 1099511627776</td>
+ <td>(IntOpt) Maximum size of image a user can upload in bytes. Defaults to 1099511627776 bytes (1 TB).</td>
+ </tr>
+ <tr>
+ <td>known_stores = glance.store.filesystem.Store, glance.store.http.Store</td>
+ <td>(ListOpt) List of which store classes and store class locations are currently known to glance at startup.</td>
+ </tr>
+ <tr>
+ <td>location_strategy = location_order</td>
+ <td>(StrOpt) This value sets what strategy will be used to determine the image location order. Currently two strategies are packaged with Glance 'location_order' and 'store_type'.</td>
+ </tr>
+ <tr>
+ <td>owner_is_tenant = True</td>
+ <td>(BoolOpt) When true, this option sets the owner of an image to be the tenant. Otherwise, the owner of the image will be the authenticated user issuing the request.</td>
+ </tr>
+ <tr>
+ <td>send_identity_headers = False</td>
+ <td>(BoolOpt) Whether to pass through headers containing user and tenant information when making requests to the registry. This allows the registry to use the context middleware without the keystoneclients' auth_token middleware, removing calls to the keystone auth service. It is recommended that when using this option, secure communication between glance api and glance registry is ensured by means other than auth_token middleware.</td>
+ </tr>
+ <tr>
+ <td>show_multiple_locations = False</td>
+ <td>(BoolOpt) Whether to include the backend image locations in image properties. Revealing storage location can be a security risk, so use this setting with caution! The overrides show_image_direct_url.</td>
+ </tr>
+ <tr>
+ <td>use_user_token = True</td>
+ <td>(BoolOpt) Whether to pass through the user token when making requests to the registry.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[store_type_location_strategy]</th>
+ </tr>
+ <tr>
+ <td>store_type_preference = </td>
+ <td>(ListOpt) The store names to use to get store preference order. The name must be registered by one of the stores defined by the 'known_stores' config option. This option will be applied when you using 'store_type' option as image location strategy defined by the 'location_strategy' config option.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/glance-auth_token.xml b/doc/common/tables/glance-auth_token.xml
index c901819527..aef982fa20 100644
--- a/doc/common/tables/glance-auth_token.xml
+++ b/doc/common/tables/glance-auth_token.xml
@@ -1,134 +1,145 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_glance_auth_token">
- <caption>Description of configuration options for auth_token</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>memcached_servers = None</td>
- <td>(ListOpt) Memcached servers or None for in process cache.</td>
- </tr>
- <tr>
- <th colspan="2">[keystone_authtoken]</th>
- </tr>
- <tr>
- <td>admin_password = None</td>
- <td>(StrOpt) Keystone account password</td>
- </tr>
- <tr>
- <td>admin_tenant_name = admin</td>
- <td>(StrOpt) Keystone service account tenant name to validate user tokens</td>
- </tr>
- <tr>
- <td>admin_token = None</td>
- <td>(StrOpt) Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process.</td>
- </tr>
- <tr>
- <td>admin_user = None</td>
- <td>(StrOpt) Keystone account username</td>
- </tr>
- <tr>
- <td>auth_admin_prefix = </td>
- <td>(StrOpt) Prefix to prepend at the beginning of the path</td>
- </tr>
- <tr>
- <td>auth_host = 127.0.0.1</td>
- <td>(StrOpt) Host providing the admin Identity API endpoint</td>
- </tr>
- <tr>
- <td>auth_port = 35357</td>
- <td>(IntOpt) Port of the admin Identity API endpoint</td>
- </tr>
- <tr>
- <td>auth_protocol = https</td>
- <td>(StrOpt) Protocol of the admin Identity API endpoint(http or https)</td>
- </tr>
- <tr>
- <td>auth_uri = None</td>
- <td>(StrOpt) Complete public Identity API endpoint</td>
- </tr>
- <tr>
- <td>auth_version = None</td>
- <td>(StrOpt) API version of the admin Identity API endpoint</td>
- </tr>
- <tr>
- <td>cache = None</td>
- <td>(StrOpt) Env key for the swift cache</td>
- </tr>
- <tr>
- <td>cafile = None</td>
- <td>(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.</td>
- </tr>
- <tr>
- <td>certfile = None</td>
- <td>(StrOpt) Required if Keystone server requires client certificate</td>
- </tr>
- <tr>
- <td>delay_auth_decision = False</td>
- <td>(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components</td>
- </tr>
- <tr>
- <td>enforce_token_bind = permissive</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>http_connect_timeout = None</td>
- <td>(BoolOpt) Request timeout value for communicating with Identity API server.</td>
- </tr>
- <tr>
- <td>http_request_max_retries = 3</td>
- <td>(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server.</td>
- </tr>
- <tr>
- <td>include_service_catalog = True</td>
- <td>(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.</td>
- </tr>
- <tr>
- <td>insecure = False</td>
- <td>(BoolOpt) Verify HTTPS connections.</td>
- </tr>
- <tr>
- <td>keyfile = None</td>
- <td>(StrOpt) Required if Keystone server requires client certificate</td>
- </tr>
- <tr>
- <td>memcache_secret_key = None</td>
- <td>(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation.</td>
- </tr>
- <tr>
- <td>memcache_security_strategy = None</td>
- <td>(StrOpt) (optional) if defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.</td>
- </tr>
- <tr>
- <td>memcached_servers = None</td>
- <td>(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.</td>
- </tr>
- <tr>
- <td>revocation_cache_time = 300</td>
- <td>(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.</td>
- </tr>
- <tr>
- <td>signing_dir = None</td>
- <td>(StrOpt) Directory used to cache files related to PKI tokens</td>
- </tr>
- <tr>
- <td>token_cache_time = 300</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>
+<?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_glance_auth_token">
+ <caption>Description of configuration options for auth_token</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>memcached_servers = None</td>
+ <td>(ListOpt) Memcached servers or None for in process cache.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[keystone_authtoken]</th>
+ </tr>
+ <tr>
+ <td>admin_password = None</td>
+ <td>(StrOpt) Keystone account password</td>
+ </tr>
+ <tr>
+ <td>admin_tenant_name = admin</td>
+ <td>(StrOpt) Keystone service account tenant name to validate user tokens</td>
+ </tr>
+ <tr>
+ <td>admin_token = None</td>
+ <td>(StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead.</td>
+ </tr>
+ <tr>
+ <td>admin_user = None</td>
+ <td>(StrOpt) Keystone account username</td>
+ </tr>
+ <tr>
+ <td>auth_admin_prefix = </td>
+ <td>(StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri.</td>
+ </tr>
+ <tr>
+ <td>auth_host = 127.0.0.1</td>
+ <td>(StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri.</td>
+ </tr>
+ <tr>
+ <td>auth_port = 35357</td>
+ <td>(IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri.</td>
+ </tr>
+ <tr>
+ <td>auth_protocol = https</td>
+ <td>(StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri.</td>
+ </tr>
+ <tr>
+ <td>auth_uri = None</td>
+ <td>(StrOpt) Complete public Identity API endpoint</td>
+ </tr>
+ <tr>
+ <td>auth_version = None</td>
+ <td>(StrOpt) API version of the admin Identity API endpoint</td>
+ </tr>
+ <tr>
+ <td>cache = None</td>
+ <td>(StrOpt) Env key for the swift cache</td>
+ </tr>
+ <tr>
+ <td>cafile = None</td>
+ <td>(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.</td>
+ </tr>
+ <tr>
+ <td>certfile = None</td>
+ <td>(StrOpt) Required if Keystone server requires client certificate</td>
+ </tr>
+ <tr>
+ <td>check_revocations_for_cached = False</td>
+ <td>(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the Keystone server.</td>
+ </tr>
+ <tr>
+ <td>delay_auth_decision = False</td>
+ <td>(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components</td>
+ </tr>
+ <tr>
+ <td>enforce_token_bind = permissive</td>
+ <td>(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens.</td>
+ </tr>
+ <tr>
+ <td>hash_algorithms = md5</td>
+ <td>(ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance.</td>
+ </tr>
+ <tr>
+ <td>http_connect_timeout = None</td>
+ <td>(BoolOpt) Request timeout value for communicating with Identity API server.</td>
+ </tr>
+ <tr>
+ <td>http_request_max_retries = 3</td>
+ <td>(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server.</td>
+ </tr>
+ <tr>
+ <td>identity_uri = None</td>
+ <td>(StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/</td>
+ </tr>
+ <tr>
+ <td>include_service_catalog = True</td>
+ <td>(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.</td>
+ </tr>
+ <tr>
+ <td>insecure = False</td>
+ <td>(BoolOpt) Verify HTTPS connections.</td>
+ </tr>
+ <tr>
+ <td>keyfile = None</td>
+ <td>(StrOpt) Required if Keystone server requires client certificate</td>
+ </tr>
+ <tr>
+ <td>memcache_secret_key = None</td>
+ <td>(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation.</td>
+ </tr>
+ <tr>
+ <td>memcache_security_strategy = None</td>
+ <td>(StrOpt) (optional) if defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.</td>
+ </tr>
+ <tr>
+ <td>memcached_servers = None</td>
+ <td>(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.</td>
+ </tr>
+ <tr>
+ <td>revocation_cache_time = 10</td>
+ <td>(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.</td>
+ </tr>
+ <tr>
+ <td>signing_dir = None</td>
+ <td>(StrOpt) Directory used to cache files related to PKI tokens</td>
+ </tr>
+ <tr>
+ <td>token_cache_time = 300</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>
diff --git a/doc/common/tables/glance-cinder.xml b/doc/common/tables/glance-cinder.xml
index 22d26da0a0..99c57b293e 100644
--- a/doc/common/tables/glance-cinder.xml
+++ b/doc/common/tables/glance-cinder.xml
@@ -1,43 +1,42 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_glance_cinder">
- <caption>Description of configuration options for cinder</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>cinder_api_insecure = False</td>
- <td>(BoolOpt) Allow to perform insecure SSL requests to cinder.</td>
- </tr>
- <tr>
- <td>cinder_ca_certificates_file = None</td>
- <td>(StrOpt) Location of CA certicates file to use for cinder client requests.</td>
- </tr>
- <tr>
- <td>cinder_catalog_info = volume:cinder:publicURL</td>
- <td>(StrOpt) Info to match when looking for cinder in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:<endpoint_type>.</td>
- </tr>
- <tr>
- <td>cinder_endpoint_template = None</td>
- <td>(StrOpt) Override service catalog lookup with template for cinder endpoint e.g. http://localhost:8776/v1/%(project_id)s.</td>
- </tr>
- <tr>
- <td>cinder_http_retries = 3</td>
- <td>(IntOpt) Number of cinderclient retries on failed http calls.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_glance_cinder">
+ <caption>Description of configuration options for cinder</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>cinder_api_insecure = False</td>
+ <td>(BoolOpt) Allow to perform insecure SSL requests to cinder.</td>
+ </tr>
+ <tr>
+ <td>cinder_ca_certificates_file = None</td>
+ <td>(StrOpt) Location of CA certicates file to use for cinder client requests.</td>
+ </tr>
+ <tr>
+ <td>cinder_catalog_info = volume:cinder:publicURL</td>
+ <td>(StrOpt) Info to match when looking for cinder in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:<endpoint_type>.</td>
+ </tr>
+ <tr>
+ <td>cinder_endpoint_template = None</td>
+ <td>(StrOpt) Override service catalog lookup with template for cinder endpoint e.g. http://localhost:8776/v1/%(project_id)s.</td>
+ </tr>
+ <tr>
+ <td>cinder_http_retries = 3</td>
+ <td>(IntOpt) Number of cinderclient retries on failed http calls.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/glance-common.xml b/doc/common/tables/glance-common.xml
index 1b03daed38..f2f6fe1b1b 100644
--- a/doc/common/tables/glance-common.xml
+++ b/doc/common/tables/glance-common.xml
@@ -1,125 +1,124 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_glance_common">
- <caption>Description of configuration options for common</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>allow_additional_image_properties = True</td>
- <td>(BoolOpt) Whether to allow users to specify image properties beyond what the image schema provides</td>
- </tr>
- <tr>
- <td>api_limit_max = 1000</td>
- <td>(IntOpt) Maximum permissible number of items that could be returned by a request</td>
- </tr>
- <tr>
- <td>backlog = 4096</td>
- <td>(IntOpt) The backlog value that will be used when creating the TCP listener socket.</td>
- </tr>
- <tr>
- <td>bind_host = 0.0.0.0</td>
- <td>(StrOpt) Address to bind the server. Useful when selecting a particular network interface.</td>
- </tr>
- <tr>
- <td>bind_port = None</td>
- <td>(IntOpt) The port on which the server will listen.</td>
- </tr>
- <tr>
- <td>data_api = glance.db.sqlalchemy.api</td>
- <td>(StrOpt) Python module path of data access API</td>
- </tr>
- <tr>
- <td>disable_process_locking = False</td>
- <td>(BoolOpt) Whether to disable inter-process locks</td>
- </tr>
- <tr>
- <td>image_location_quota = 10</td>
- <td>(IntOpt) Maximum number of locations allowed on an image. Negative values evaluate to unlimited.</td>
- </tr>
- <tr>
- <td>image_member_quota = 128</td>
- <td>(IntOpt) Maximum number of image members per image. Negative values evaluate to unlimited.</td>
- </tr>
- <tr>
- <td>image_property_quota = 128</td>
- <td>(IntOpt) Maximum number of properties allowed on an image. Negative values evaluate to unlimited.</td>
- </tr>
- <tr>
- <td>image_tag_quota = 128</td>
- <td>(IntOpt) Maximum number of tags allowed on an image. Negative values evaluate to unlimited.</td>
- </tr>
- <tr>
- <td>limit_param_default = 25</td>
- <td>(IntOpt) Default value for the number of items returned by a request if not specified explicitly in the request</td>
- </tr>
- <tr>
- <td>lock_path = None</td>
- <td>(StrOpt) Directory to use for lock files.</td>
- </tr>
- <tr>
- <td>metadata_encryption_key = None</td>
- <td>(StrOpt) Key used for encrypting sensitive metadata while talking to the registry or database.</td>
- </tr>
- <tr>
- <td>notifier_strategy = default</td>
- <td>(StrOpt) Notifications can be sent when images are create, updated or deleted. There are three methods of sending notifications, logging (via the log_file directive), rabbit (via a rabbitmq queue), qpid (via a Qpid message queue), or noop (no notifications sent, the default). (DEPRECATED)</td>
- </tr>
- <tr>
- <td>os_region_name = None</td>
- <td>(StrOpt) Region name of this node.</td>
- </tr>
- <tr>
- <td>property_protection_file = None</td>
- <td>(StrOpt) The location of the property protection file.</td>
- </tr>
- <tr>
- <td>property_protection_rule_format = roles</td>
- <td>(StrOpt) This config value indicates whether "roles" or "policies" are used in the property protection file.</td>
- </tr>
- <tr>
- <td>show_image_direct_url = False</td>
- <td>(BoolOpt) Whether to include the backend image storage location in image properties. Revealing storage location can be a security risk, so use this setting with caution!</td>
- </tr>
- <tr>
- <td>user_storage_quota = 0</td>
- <td>(IntOpt) Set a system wide quota for every user. This value is the total number of bytes that a user can use across all storage systems. A value of 0 means unlimited.</td>
- </tr>
- <tr>
- <td>workers = 1</td>
- <td>(IntOpt) The number of child process workers that will be created to service API requests.</td>
- </tr>
- <tr>
- <th colspan="2">[image_format]</th>
- </tr>
- <tr>
- <td>container_formats = ami, ari, aki, bare, ovf, ova</td>
- <td>(ListOpt) Supported values for the 'container_format' image attribute</td>
- </tr>
- <tr>
- <td>disk_formats = ami, ari, aki, vhd, vmdk, raw, qcow2, vdi, iso</td>
- <td>(ListOpt) Supported values for the 'disk_format' image attribute</td>
- </tr>
- <tr>
- <th colspan="2">[task]</th>
- </tr>
- <tr>
- <td>task_time_to_live = 48</td>
- <td>(IntOpt) Time in hours for which a task lives after, either succeeding or failing</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_glance_common">
+ <caption>Description of configuration options for common</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>allow_additional_image_properties = True</td>
+ <td>(BoolOpt) Whether to allow users to specify image properties beyond what the image schema provides</td>
+ </tr>
+ <tr>
+ <td>api_limit_max = 1000</td>
+ <td>(IntOpt) Maximum permissible number of items that could be returned by a request</td>
+ </tr>
+ <tr>
+ <td>backlog = 4096</td>
+ <td>(IntOpt) The backlog value that will be used when creating the TCP listener socket.</td>
+ </tr>
+ <tr>
+ <td>bind_host = 0.0.0.0</td>
+ <td>(StrOpt) Address to bind the server. Useful when selecting a particular network interface.</td>
+ </tr>
+ <tr>
+ <td>bind_port = None</td>
+ <td>(IntOpt) The port on which the server will listen.</td>
+ </tr>
+ <tr>
+ <td>data_api = glance.db.sqlalchemy.api</td>
+ <td>(StrOpt) Python module path of data access API</td>
+ </tr>
+ <tr>
+ <td>disable_process_locking = False</td>
+ <td>(BoolOpt) Whether to disable inter-process locks</td>
+ </tr>
+ <tr>
+ <td>image_location_quota = 10</td>
+ <td>(IntOpt) Maximum number of locations allowed on an image. Negative values evaluate to unlimited.</td>
+ </tr>
+ <tr>
+ <td>image_member_quota = 128</td>
+ <td>(IntOpt) Maximum number of image members per image. Negative values evaluate to unlimited.</td>
+ </tr>
+ <tr>
+ <td>image_property_quota = 128</td>
+ <td>(IntOpt) Maximum number of properties allowed on an image. Negative values evaluate to unlimited.</td>
+ </tr>
+ <tr>
+ <td>image_tag_quota = 128</td>
+ <td>(IntOpt) Maximum number of tags allowed on an image. Negative values evaluate to unlimited.</td>
+ </tr>
+ <tr>
+ <td>limit_param_default = 25</td>
+ <td>(IntOpt) Default value for the number of items returned by a request if not specified explicitly in the request</td>
+ </tr>
+ <tr>
+ <td>lock_path = None</td>
+ <td>(StrOpt) Directory to use for lock files.</td>
+ </tr>
+ <tr>
+ <td>metadata_encryption_key = None</td>
+ <td>(StrOpt) Key used for encrypting sensitive metadata while talking to the registry or database.</td>
+ </tr>
+ <tr>
+ <td>notifier_strategy = default</td>
+ <td>(StrOpt) Notifications can be sent when images are create, updated or deleted. There are three methods of sending notifications, logging (via the log_file directive), rabbit (via a rabbitmq queue), qpid (via a Qpid message queue), or noop (no notifications sent, the default).</td>
+ </tr>
+ <tr>
+ <td>os_region_name = None</td>
+ <td>(StrOpt) Region name of this node.</td>
+ </tr>
+ <tr>
+ <td>property_protection_file = None</td>
+ <td>(StrOpt) The location of the property protection file.</td>
+ </tr>
+ <tr>
+ <td>property_protection_rule_format = roles</td>
+ <td>(StrOpt) This config value indicates whether "roles" or "policies" are used in the property protection file.</td>
+ </tr>
+ <tr>
+ <td>show_image_direct_url = False</td>
+ <td>(BoolOpt) Whether to include the backend image storage location in image properties. Revealing storage location can be a security risk, so use this setting with caution!</td>
+ </tr>
+ <tr>
+ <td>user_storage_quota = 0</td>
+ <td>(StrOpt) Set a system wide quota for every user. This value is the total capacity that a user can use across all storage systems. A value of 0 means unlimited.Optional unit can be specified for the value. Accepted units are B, KB, MB, GB and TB representing Bytes, KiloBytes, MegaBytes, GigaBytes and TeraBytesrespectively. If no unit is specified then Bytes is assumed. Note that there should not be any space between value and unit and units are case sensitive.</td>
+ </tr>
+ <tr>
+ <td>workers = 1</td>
+ <td>(IntOpt) The number of child process workers that will be created to service API requests.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[image_format]</th>
+ </tr>
+ <tr>
+ <td>container_formats = ami, ari, aki, bare, ovf, ova</td>
+ <td>(ListOpt) Supported values for the 'container_format' image attribute</td>
+ </tr>
+ <tr>
+ <td>disk_formats = ami, ari, aki, vhd, vmdk, raw, qcow2, vdi, iso</td>
+ <td>(ListOpt) Supported values for the 'disk_format' image attribute</td>
+ </tr>
+ <tr>
+ <th colspan="2">[task]</th>
+ </tr>
+ <tr>
+ <td>task_time_to_live = 48</td>
+ <td>(IntOpt) Time in hours for which a task lives after, either succeeding or failing</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/glance-database.xml b/doc/common/tables/glance-database.xml
new file mode 100644
index 0000000000..cd280ab1af
--- /dev/null
+++ b/doc/common/tables/glance-database.xml
@@ -0,0 +1,98 @@
+<?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_glance_database">
+ <caption>Description of configuration options for database</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[database]</th>
+ </tr>
+ <tr>
+ <td>backend = sqlalchemy</td>
+ <td>(StrOpt) The backend to use for db</td>
+ </tr>
+ <tr>
+ <td>connection = None</td>
+ <td>(StrOpt) The SQLAlchemy connection string used to connect to the database</td>
+ </tr>
+ <tr>
+ <td>connection_debug = 0</td>
+ <td>(IntOpt) Verbosity of SQL debugging information. 0=None, 100=Everything</td>
+ </tr>
+ <tr>
+ <td>connection_trace = False</td>
+ <td>(BoolOpt) Add python stack traces to SQL as comment strings</td>
+ </tr>
+ <tr>
+ <td>db_inc_retry_interval = True</td>
+ <td>(BoolOpt) Whether to increase interval between db connection retries, up to db_max_retry_interval</td>
+ </tr>
+ <tr>
+ <td>db_max_retries = 20</td>
+ <td>(IntOpt) maximum db connection retries before error is raised. (setting -1 implies an infinite retry count)</td>
+ </tr>
+ <tr>
+ <td>db_max_retry_interval = 10</td>
+ <td>(IntOpt) max seconds between db connection retries, if db_inc_retry_interval is enabled</td>
+ </tr>
+ <tr>
+ <td>db_retry_interval = 1</td>
+ <td>(IntOpt) seconds between db connection retries</td>
+ </tr>
+ <tr>
+ <td>idle_timeout = 3600</td>
+ <td>(IntOpt) Timeout before idle sql connections are reaped</td>
+ </tr>
+ <tr>
+ <td>max_overflow = None</td>
+ <td>(IntOpt) If set, use this value for max_overflow with sqlalchemy</td>
+ </tr>
+ <tr>
+ <td>max_pool_size = None</td>
+ <td>(IntOpt) Maximum number of SQL connections to keep open in a pool</td>
+ </tr>
+ <tr>
+ <td>max_retries = 10</td>
+ <td>(IntOpt) Maximum db connection retries during startup. (setting -1 implies an infinite retry count)</td>
+ </tr>
+ <tr>
+ <td>min_pool_size = 1</td>
+ <td>(IntOpt) Minimum number of SQL connections to keep open in a pool</td>
+ </tr>
+ <tr>
+ <td>mysql_sql_mode = TRADITIONAL</td>
+ <td>(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=</td>
+ </tr>
+ <tr>
+ <td>pool_timeout = None</td>
+ <td>(IntOpt) If set, use this value for pool_timeout with sqlalchemy</td>
+ </tr>
+ <tr>
+ <td>retry_interval = 10</td>
+ <td>(IntOpt) Interval between retries of opening a sql connection</td>
+ </tr>
+ <tr>
+ <td>sqlite_db = glance.sqlite</td>
+ <td>(StrOpt) The file name to use with SQLite</td>
+ </tr>
+ <tr>
+ <td>sqlite_synchronous = True</td>
+ <td>(BoolOpt) If True, SQLite uses synchronous mode</td>
+ </tr>
+ <tr>
+ <td>use_db_reconnect = False</td>
+ <td>(BoolOpt) Enable the experimental use of database reconnect on connection lost</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/glance-db.xml b/doc/common/tables/glance-db.xml
deleted file mode 100644
index c2664d091a..0000000000
--- a/doc/common/tables/glance-db.xml
+++ /dev/null
@@ -1,99 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_glance_db">
- <caption>Description of configuration options for db</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>backend = sqlalchemy</td>
- <td>(StrOpt) The backend to use for db</td>
- </tr>
- <tr>
- <td>connection = None</td>
- <td>(StrOpt) The SQLAlchemy connection string used to connect to the database</td>
- </tr>
- <tr>
- <td>connection_debug = 0</td>
- <td>(IntOpt) Verbosity of SQL debugging information. 0=None, 100=Everything</td>
- </tr>
- <tr>
- <td>connection_trace = False</td>
- <td>(BoolOpt) Add python stack traces to SQL as comment strings</td>
- </tr>
- <tr>
- <td>db_inc_retry_interval = True</td>
- <td>(BoolOpt) Whether to increase interval between db connection retries, up to db_max_retry_interval</td>
- </tr>
- <tr>
- <td>db_max_retries = 20</td>
- <td>(IntOpt) maximum db connection retries before error is raised. (setting -1 implies an infinite retry count)</td>
- </tr>
- <tr>
- <td>db_max_retry_interval = 10</td>
- <td>(IntOpt) max seconds between db connection retries, if db_inc_retry_interval is enabled</td>
- </tr>
- <tr>
- <td>db_retry_interval = 1</td>
- <td>(IntOpt) seconds between db connection retries</td>
- </tr>
- <tr>
- <td>idle_timeout = 3600</td>
- <td>(IntOpt) Timeout before idle sql connections are reaped</td>
- </tr>
- <tr>
- <td>max_overflow = None</td>
- <td>(IntOpt) If set, use this value for max_overflow with sqlalchemy</td>
- </tr>
- <tr>
- <td>max_pool_size = None</td>
- <td>(IntOpt) Maximum number of SQL connections to keep open in a pool</td>
- </tr>
- <tr>
- <td>max_retries = 10</td>
- <td>(IntOpt) Maximum db connection retries during startup. (setting -1 implies an infinite retry count)</td>
- </tr>
- <tr>
- <td>min_pool_size = 1</td>
- <td>(IntOpt) Minimum number of SQL connections to keep open in a pool</td>
- </tr>
- <tr>
- <td>mysql_sql_mode = TRADITIONAL</td>
- <td>(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=</td>
- </tr>
- <tr>
- <td>pool_timeout = None</td>
- <td>(IntOpt) If set, use this value for pool_timeout with sqlalchemy</td>
- </tr>
- <tr>
- <td>retry_interval = 10</td>
- <td>(IntOpt) Interval between retries of opening a sql connection</td>
- </tr>
- <tr>
- <td>sqlite_db = glance.sqlite</td>
- <td>(StrOpt) The file name to use with SQLite</td>
- </tr>
- <tr>
- <td>sqlite_synchronous = True</td>
- <td>(BoolOpt) If True, SQLite uses synchronous mode</td>
- </tr>
- <tr>
- <td>use_db_reconnect = False</td>
- <td>(BoolOpt) Enable the experimental use of database reconnect on connection lost</td>
- </tr>
- </tbody>
- </table>
- </para>
diff --git a/doc/common/tables/glance-filesystem.xml b/doc/common/tables/glance-filesystem.xml
index 65ca145848..a28602d160 100644
--- a/doc/common/tables/glance-filesystem.xml
+++ b/doc/common/tables/glance-filesystem.xml
@@ -1,35 +1,34 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_glance_filesystem">
- <caption>Description of configuration options for filesystem</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>filesystem_store_datadir = None</td>
- <td>(StrOpt) Directory to which the Filesystem backend store writes images.</td>
- </tr>
- <tr>
- <td>filesystem_store_datadirs = None</td>
- <td>(MultiStrOpt) List of directories and its priorities to which the Filesystem backend store writes images.</td>
- </tr>
- <tr>
- <td>filesystem_store_metadata_file = None</td>
- <td>(StrOpt) The path to a file which contains the metadata to be returned with any location associated with this store. The file must contain a valid JSON dict.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_glance_filesystem">
+ <caption>Description of configuration options for filesystem</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>filesystem_store_datadir = None</td>
+ <td>(StrOpt) Directory to which the Filesystem backend store writes images.</td>
+ </tr>
+ <tr>
+ <td>filesystem_store_datadirs = None</td>
+ <td>(MultiStrOpt) List of directories and its priorities to which the Filesystem backend store writes images.</td>
+ </tr>
+ <tr>
+ <td>filesystem_store_metadata_file = None</td>
+ <td>(StrOpt) The path to a file which contains the metadata to be returned with any location associated with this store. The file must contain a valid JSON dict.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/glance-gridfs.xml b/doc/common/tables/glance-gridfs.xml
index 0524d404a3..31f8ae6cd4 100644
--- a/doc/common/tables/glance-gridfs.xml
+++ b/doc/common/tables/glance-gridfs.xml
@@ -1,31 +1,30 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_glance_gridfs">
- <caption>Description of configuration options for gridfs</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>mongodb_store_db = None</td>
- <td>(StrOpt) Database to use.</td>
- </tr>
- <tr>
- <td>mongodb_store_uri = None</td>
- <td>(StrOpt) Hostname or IP address of the instance to connect to, or a mongodb URI, or a list of hostnames / mongodb URIs. If host is an IPv6 literal it must be enclosed in '[' and ']' characters following the RFC2732 URL syntax (e.g. '[::1]' for localhost).</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_glance_gridfs">
+ <caption>Description of configuration options for gridfs</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>mongodb_store_db = None</td>
+ <td>(StrOpt) Database to use.</td>
+ </tr>
+ <tr>
+ <td>mongodb_store_uri = None</td>
+ <td>(StrOpt) Hostname or IP address of the instance to connect to, or a mongodb URI, or a list of hostnames / mongodb URIs. If host is an IPv6 literal it must be enclosed in '[' and ']' characters following the RFC2732 URL syntax (e.g. '[::1]' for localhost).</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/glance-imagecache.xml b/doc/common/tables/glance-imagecache.xml
index 7390b990d9..43cc1afeed 100644
--- a/doc/common/tables/glance-imagecache.xml
+++ b/doc/common/tables/glance-imagecache.xml
@@ -1,63 +1,62 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_glance_imagecache">
- <caption>Description of configuration options for imagecache</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>cleanup_scrubber = False</td>
- <td>(BoolOpt) A boolean that determines if the scrubber should clean up the files it uses for taking data. Only one server in your deployment should be designated the cleanup host.</td>
- </tr>
- <tr>
- <td>cleanup_scrubber_time = 86400</td>
- <td>(IntOpt) Items must have a modified time that is older than this value in order to be candidates for cleanup.</td>
- </tr>
- <tr>
- <td>delayed_delete = False</td>
- <td>(BoolOpt) Turn on/off delayed delete.</td>
- </tr>
- <tr>
- <td>image_cache_dir = None</td>
- <td>(StrOpt) Base directory that the Image Cache uses.</td>
- </tr>
- <tr>
- <td>image_cache_driver = sqlite</td>
- <td>(StrOpt) The driver to use for image cache management.</td>
- </tr>
- <tr>
- <td>image_cache_max_size = 10737418240</td>
- <td>(IntOpt) The maximum size in bytes that the cache can use.</td>
- </tr>
- <tr>
- <td>image_cache_sqlite_db = cache.db</td>
- <td>(StrOpt) The path to the sqlite file database that will be used for image cache management.</td>
- </tr>
- <tr>
- <td>image_cache_stall_time = 86400</td>
- <td>(IntOpt) The amount of time to let an image remain in the cache without being accessed.</td>
- </tr>
- <tr>
- <td>scrub_time = 0</td>
- <td>(IntOpt) The amount of time in seconds to delay before performing a delete.</td>
- </tr>
- <tr>
- <td>scrubber_datadir = /var/lib/glance/scrubber</td>
- <td>(StrOpt) Directory that the scrubber will use to track information about what to delete. Make sure this is set in glance-api.conf and glance-scrubber.conf.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_glance_imagecache">
+ <caption>Description of configuration options for imagecache</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>cleanup_scrubber = False</td>
+ <td>(BoolOpt) A boolean that determines if the scrubber should clean up the files it uses for taking data. Only one server in your deployment should be designated the cleanup host.</td>
+ </tr>
+ <tr>
+ <td>cleanup_scrubber_time = 86400</td>
+ <td>(IntOpt) Items must have a modified time that is older than this value in order to be candidates for cleanup.</td>
+ </tr>
+ <tr>
+ <td>delayed_delete = False</td>
+ <td>(BoolOpt) Turn on/off delayed delete.</td>
+ </tr>
+ <tr>
+ <td>image_cache_dir = None</td>
+ <td>(StrOpt) Base directory that the Image Cache uses.</td>
+ </tr>
+ <tr>
+ <td>image_cache_driver = sqlite</td>
+ <td>(StrOpt) The driver to use for image cache management.</td>
+ </tr>
+ <tr>
+ <td>image_cache_max_size = 10737418240</td>
+ <td>(IntOpt) The maximum size in bytes that the cache can use.</td>
+ </tr>
+ <tr>
+ <td>image_cache_sqlite_db = cache.db</td>
+ <td>(StrOpt) The path to the sqlite file database that will be used for image cache management.</td>
+ </tr>
+ <tr>
+ <td>image_cache_stall_time = 86400</td>
+ <td>(IntOpt) The amount of time to let an image remain in the cache without being accessed.</td>
+ </tr>
+ <tr>
+ <td>scrub_time = 0</td>
+ <td>(IntOpt) The amount of time in seconds to delay before performing a delete.</td>
+ </tr>
+ <tr>
+ <td>scrubber_datadir = /var/lib/glance/scrubber</td>
+ <td>(StrOpt) Directory that the scrubber will use to track information about what to delete. Make sure this is set in glance-api.conf and glance-scrubber.conf.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/glance-logging.xml b/doc/common/tables/glance-logging.xml
index 6b9f64b990..74b5d506c8 100644
--- a/doc/common/tables/glance-logging.xml
+++ b/doc/common/tables/glance-logging.xml
@@ -1,103 +1,102 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_glance_logging">
- <caption>Description of configuration options for logging</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>debug = False</td>
- <td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).</td>
- </tr>
- <tr>
- <td>default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN</td>
- <td>(ListOpt) List of logger=LEVEL pairs</td>
- </tr>
- <tr>
- <td>fatal_deprecations = False</td>
- <td>(BoolOpt) Make deprecations fatal</td>
- </tr>
- <tr>
- <td>instance_format = "[instance: %(uuid)s] "</td>
- <td>(StrOpt) If an instance is passed with the log message, format it like this</td>
- </tr>
- <tr>
- <td>instance_uuid_format = "[instance: %(uuid)s] "</td>
- <td>(StrOpt) If an instance UUID is passed with the log message, format it like this</td>
- </tr>
- <tr>
- <td>log_config_append = None</td>
- <td>(StrOpt) The name of logging configuration file. It does not disable existing loggers, but just appends specified logging configuration to any other existing logging options. Please see the Python logging module documentation for details on logging configuration files.</td>
- </tr>
- <tr>
- <td>log_date_format = %Y-%m-%d %H:%M:%S</td>
- <td>(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s</td>
- </tr>
- <tr>
- <td>log_dir = None</td>
- <td>(StrOpt) (Optional) The base directory used for relative --log-file paths</td>
- </tr>
- <tr>
- <td>log_file = None</td>
- <td>(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.</td>
- </tr>
- <tr>
- <td>log_format = None</td>
- <td>(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.</td>
- </tr>
- <tr>
- <td>logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s</td>
- <td>(StrOpt) Format string to use for log messages with context</td>
- </tr>
- <tr>
- <td>logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d</td>
- <td>(StrOpt) Data to append to log format when level is DEBUG</td>
- </tr>
- <tr>
- <td>logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s</td>
- <td>(StrOpt) Format string to use for log messages without context</td>
- </tr>
- <tr>
- <td>logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s</td>
- <td>(StrOpt) Prefix each line of exception output with this format</td>
- </tr>
- <tr>
- <td>publish_errors = False</td>
- <td>(BoolOpt) Publish error events</td>
- </tr>
- <tr>
- <td>syslog_log_facility = LOG_USER</td>
- <td>(StrOpt) Syslog facility to receive log lines</td>
- </tr>
- <tr>
- <td>use_stderr = True</td>
- <td>(BoolOpt) Log output to standard error</td>
- </tr>
- <tr>
- <td>use_syslog = False</td>
- <td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and then will be changed in J to honor RFC5424</td>
- </tr>
- <tr>
- <td>use_syslog_rfc_format = False</td>
- <td>(BoolOpt) (Optional) Use syslog rfc5424 format for logging. If enabled, will add APP-NAME (RFC5424) before the MSG part of the syslog message. The old format without APP-NAME is deprecated in I, and will be removed in J.</td>
- </tr>
- <tr>
- <td>verbose = False</td>
- <td>(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_glance_logging">
+ <caption>Description of configuration options for logging</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>debug = False</td>
+ <td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).</td>
+ </tr>
+ <tr>
+ <td>default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN</td>
+ <td>(ListOpt) List of logger=LEVEL pairs.</td>
+ </tr>
+ <tr>
+ <td>fatal_deprecations = False</td>
+ <td>(BoolOpt) Enables or disables fatal status of deprecations.</td>
+ </tr>
+ <tr>
+ <td>instance_format = "[instance: %(uuid)s] "</td>
+ <td>(StrOpt) The format for an instance that is passed with the log message. </td>
+ </tr>
+ <tr>
+ <td>instance_uuid_format = "[instance: %(uuid)s] "</td>
+ <td>(StrOpt) The format for an instance UUID that is passed with the log message. </td>
+ </tr>
+ <tr>
+ <td>log_config_append = None</td>
+ <td>(StrOpt) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation.</td>
+ </tr>
+ <tr>
+ <td>log_date_format = %Y-%m-%d %H:%M:%S</td>
+ <td>(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s .</td>
+ </tr>
+ <tr>
+ <td>log_dir = None</td>
+ <td>(StrOpt) (Optional) The base directory used for relative --log-file paths.</td>
+ </tr>
+ <tr>
+ <td>log_file = None</td>
+ <td>(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.</td>
+ </tr>
+ <tr>
+ <td>log_format = None</td>
+ <td>(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.</td>
+ </tr>
+ <tr>
+ <td>logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s</td>
+ <td>(StrOpt) Format string to use for log messages with context.</td>
+ </tr>
+ <tr>
+ <td>logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d</td>
+ <td>(StrOpt) Data to append to log format when level is DEBUG.</td>
+ </tr>
+ <tr>
+ <td>logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s</td>
+ <td>(StrOpt) Format string to use for log messages without context.</td>
+ </tr>
+ <tr>
+ <td>logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s</td>
+ <td>(StrOpt) Prefix each line of exception output with this format.</td>
+ </tr>
+ <tr>
+ <td>publish_errors = False</td>
+ <td>(BoolOpt) Enables or disables publication of error events.</td>
+ </tr>
+ <tr>
+ <td>syslog_log_facility = LOG_USER</td>
+ <td>(StrOpt) Syslog facility to receive log lines.</td>
+ </tr>
+ <tr>
+ <td>use_stderr = True</td>
+ <td>(BoolOpt) Log output to standard error.</td>
+ </tr>
+ <tr>
+ <td>use_syslog = False</td>
+ <td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will chang in J to honor RFC5424.</td>
+ </tr>
+ <tr>
+ <td>use_syslog_rfc_format = False</td>
+ <td>(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in I, and will be removed in J.</td>
+ </tr>
+ <tr>
+ <td>verbose = False</td>
+ <td>(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/glance-matchmaker.xml b/doc/common/tables/glance-matchmaker.xml
index 655d81beea..d06972e1e7 100644
--- a/doc/common/tables/glance-matchmaker.xml
+++ b/doc/common/tables/glance-matchmaker.xml
@@ -1,38 +1,37 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_glance_matchmaker">
- <caption>Description of configuration options for matchmaker</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>matchmaker_heartbeat_freq = 300</td>
- <td>(IntOpt) Heartbeat frequency.</td>
- </tr>
- <tr>
- <td>matchmaker_heartbeat_ttl = 600</td>
- <td>(IntOpt) Heartbeat time-to-live.</td>
- </tr>
- <tr>
- <th colspan="2">[matchmaker_ring]</th>
- </tr>
- <tr>
- <td>ringfile = /etc/oslo/matchmaker_ring.json</td>
- <td>(StrOpt) Matchmaker ring file (JSON).</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_glance_matchmaker">
+ <caption>Description of configuration options for matchmaker</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>matchmaker_heartbeat_freq = 300</td>
+ <td>(IntOpt) Heartbeat frequency.</td>
+ </tr>
+ <tr>
+ <td>matchmaker_heartbeat_ttl = 600</td>
+ <td>(IntOpt) Heartbeat time-to-live.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[matchmaker_ring]</th>
+ </tr>
+ <tr>
+ <td>ringfile = /etc/oslo/matchmaker_ring.json</td>
+ <td>(StrOpt) Matchmaker ring file (JSON).</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/glance-paste.xml b/doc/common/tables/glance-paste.xml
index 0dd81b7045..a20538ed1b 100644
--- a/doc/common/tables/glance-paste.xml
+++ b/doc/common/tables/glance-paste.xml
@@ -1,31 +1,30 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_glance_paste">
- <caption>Description of configuration options for paste</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">[paste_deploy]</th>
- </tr>
- <tr>
- <td>config_file = None</td>
- <td>(StrOpt) Name of the paste configuration file.</td>
- </tr>
- <tr>
- <td>flavor = None</td>
- <td>(StrOpt) Partial name of a pipeline in your paste configuration file with the service name removed. For example, if your paste section name is [pipeline:glance-api-keystone] use the value "keystone"</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_glance_paste">
+ <caption>Description of configuration options for paste</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">[paste_deploy]</th>
+ </tr>
+ <tr>
+ <td>config_file = None</td>
+ <td>(StrOpt) Name of the paste configuration file.</td>
+ </tr>
+ <tr>
+ <td>flavor = None</td>
+ <td>(StrOpt) Partial name of a pipeline in your paste configuration file with the service name removed. For example, if your paste section name is [pipeline:glance-api-keystone] use the value "keystone"</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/glance-policy.xml b/doc/common/tables/glance-policy.xml
index 536d383b16..eae1448bb1 100644
--- a/doc/common/tables/glance-policy.xml
+++ b/doc/common/tables/glance-policy.xml
@@ -1,31 +1,30 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_glance_policy">
- <caption>Description of configuration options for policy</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>policy_default_rule = default</td>
- <td>(StrOpt) The default policy to use.</td>
- </tr>
- <tr>
- <td>policy_file = policy.json</td>
- <td>(StrOpt) The location of the policy file.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_glance_policy">
+ <caption>Description of configuration options for policy</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>policy_default_rule = default</td>
+ <td>(StrOpt) The default policy to use.</td>
+ </tr>
+ <tr>
+ <td>policy_file = policy.json</td>
+ <td>(StrOpt) The location of the policy file.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/glance-qpid.xml b/doc/common/tables/glance-qpid.xml
index 0408bb59d5..fd80310b36 100644
--- a/doc/common/tables/glance-qpid.xml
+++ b/doc/common/tables/glance-qpid.xml
@@ -1,63 +1,62 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_glance_qpid">
- <caption>Description of configuration options for qpid</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>qpid_heartbeat = 60</td>
- <td>(IntOpt) Seconds between connection keepalive heartbeats.</td>
- </tr>
- <tr>
- <td>qpid_hostname = localhost</td>
- <td>(StrOpt) Qpid broker hostname.</td>
- </tr>
- <tr>
- <td>qpid_hosts = $qpid_hostname:$qpid_port</td>
- <td>(ListOpt) Qpid HA cluster host:port pairs.</td>
- </tr>
- <tr>
- <td>qpid_password = </td>
- <td>(StrOpt) Password for Qpid connection.</td>
- </tr>
- <tr>
- <td>qpid_port = 5672</td>
- <td>(IntOpt) Qpid broker port.</td>
- </tr>
- <tr>
- <td>qpid_protocol = tcp</td>
- <td>(StrOpt) Transport to use, either 'tcp' or 'ssl'.</td>
- </tr>
- <tr>
- <td>qpid_sasl_mechanisms = </td>
- <td>(StrOpt) Space separated list of SASL mechanisms to use for auth.</td>
- </tr>
- <tr>
- <td>qpid_tcp_nodelay = True</td>
- <td>(BoolOpt) Whether to disable the Nagle algorithm.</td>
- </tr>
- <tr>
- <td>qpid_topology_version = 1</td>
- <td>(IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.</td>
- </tr>
- <tr>
- <td>qpid_username = </td>
- <td>(StrOpt) Username for Qpid connection.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_glance_qpid">
+ <caption>Description of configuration options for qpid</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>qpid_heartbeat = 60</td>
+ <td>(IntOpt) Seconds between connection keepalive heartbeats.</td>
+ </tr>
+ <tr>
+ <td>qpid_hostname = localhost</td>
+ <td>(StrOpt) Qpid broker hostname.</td>
+ </tr>
+ <tr>
+ <td>qpid_hosts = $qpid_hostname:$qpid_port</td>
+ <td>(ListOpt) Qpid HA cluster host:port pairs.</td>
+ </tr>
+ <tr>
+ <td>qpid_password = </td>
+ <td>(StrOpt) Password for Qpid connection.</td>
+ </tr>
+ <tr>
+ <td>qpid_port = 5672</td>
+ <td>(IntOpt) Qpid broker port.</td>
+ </tr>
+ <tr>
+ <td>qpid_protocol = tcp</td>
+ <td>(StrOpt) Transport to use, either 'tcp' or 'ssl'.</td>
+ </tr>
+ <tr>
+ <td>qpid_sasl_mechanisms = </td>
+ <td>(StrOpt) Space separated list of SASL mechanisms to use for auth.</td>
+ </tr>
+ <tr>
+ <td>qpid_tcp_nodelay = True</td>
+ <td>(BoolOpt) Whether to disable the Nagle algorithm.</td>
+ </tr>
+ <tr>
+ <td>qpid_topology_version = 1</td>
+ <td>(IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.</td>
+ </tr>
+ <tr>
+ <td>qpid_username = </td>
+ <td>(StrOpt) Username for Qpid connection.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/glance-rabbitmq.xml b/doc/common/tables/glance-rabbitmq.xml
index cf47e1856a..adacae7574 100644
--- a/doc/common/tables/glance-rabbitmq.xml
+++ b/doc/common/tables/glance-rabbitmq.xml
@@ -1,99 +1,98 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_glance_rabbitmq">
- <caption>Description of configuration options for rabbitmq</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>control_exchange = openstack</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>fake_rabbit = False</td>
- <td>(BoolOpt) If passed, use a fake RabbitMQ provider.</td>
- </tr>
- <tr>
- <td>kombu_reconnect_delay = 1.0</td>
- <td>(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.</td>
- </tr>
- <tr>
- <td>kombu_ssl_ca_certs = </td>
- <td>(StrOpt) SSL certification authority file (valid only if SSL enabled).</td>
- </tr>
- <tr>
- <td>kombu_ssl_certfile = </td>
- <td>(StrOpt) SSL cert file (valid only if SSL enabled).</td>
- </tr>
- <tr>
- <td>kombu_ssl_keyfile = </td>
- <td>(StrOpt) SSL key file (valid only if SSL enabled).</td>
- </tr>
- <tr>
- <td>kombu_ssl_version = </td>
- <td>(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions.</td>
- </tr>
- <tr>
- <td>rabbit_ha_queues = False</td>
- <td>(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database.</td>
- </tr>
- <tr>
- <td>rabbit_host = localhost</td>
- <td>(StrOpt) The RabbitMQ broker address where a single node is used.</td>
- </tr>
- <tr>
- <td>rabbit_hosts = $rabbit_host:$rabbit_port</td>
- <td>(ListOpt) RabbitMQ HA cluster host:port pairs.</td>
- </tr>
- <tr>
- <td>rabbit_login_method = AMQPLAIN</td>
- <td>(StrOpt) the RabbitMQ login method</td>
- </tr>
- <tr>
- <td>rabbit_max_retries = 0</td>
- <td>(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).</td>
- </tr>
- <tr>
- <td>rabbit_password = guest</td>
- <td>(StrOpt) The RabbitMQ password.</td>
- </tr>
- <tr>
- <td>rabbit_port = 5672</td>
- <td>(IntOpt) The RabbitMQ broker port where a single node is used.</td>
- </tr>
- <tr>
- <td>rabbit_retry_backoff = 2</td>
- <td>(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.</td>
- </tr>
- <tr>
- <td>rabbit_retry_interval = 1</td>
- <td>(IntOpt) How frequently to retry connecting with RabbitMQ.</td>
- </tr>
- <tr>
- <td>rabbit_use_ssl = False</td>
- <td>(BoolOpt) Connect over SSL for RabbitMQ.</td>
- </tr>
- <tr>
- <td>rabbit_userid = guest</td>
- <td>(StrOpt) The RabbitMQ userid.</td>
- </tr>
- <tr>
- <td>rabbit_virtual_host = /</td>
- <td>(StrOpt) The RabbitMQ virtual host.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_glance_rabbitmq">
+ <caption>Description of configuration options for rabbitmq</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>control_exchange = openstack</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>fake_rabbit = False</td>
+ <td>(BoolOpt) If passed, use a fake RabbitMQ provider.</td>
+ </tr>
+ <tr>
+ <td>kombu_reconnect_delay = 1.0</td>
+ <td>(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.</td>
+ </tr>
+ <tr>
+ <td>kombu_ssl_ca_certs = </td>
+ <td>(StrOpt) SSL certification authority file (valid only if SSL enabled).</td>
+ </tr>
+ <tr>
+ <td>kombu_ssl_certfile = </td>
+ <td>(StrOpt) SSL cert file (valid only if SSL enabled).</td>
+ </tr>
+ <tr>
+ <td>kombu_ssl_keyfile = </td>
+ <td>(StrOpt) SSL key file (valid only if SSL enabled).</td>
+ </tr>
+ <tr>
+ <td>kombu_ssl_version = </td>
+ <td>(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions.</td>
+ </tr>
+ <tr>
+ <td>rabbit_ha_queues = False</td>
+ <td>(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database.</td>
+ </tr>
+ <tr>
+ <td>rabbit_host = localhost</td>
+ <td>(StrOpt) The RabbitMQ broker address where a single node is used.</td>
+ </tr>
+ <tr>
+ <td>rabbit_hosts = $rabbit_host:$rabbit_port</td>
+ <td>(ListOpt) RabbitMQ HA cluster host:port pairs.</td>
+ </tr>
+ <tr>
+ <td>rabbit_login_method = AMQPLAIN</td>
+ <td>(StrOpt) the RabbitMQ login method</td>
+ </tr>
+ <tr>
+ <td>rabbit_max_retries = 0</td>
+ <td>(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).</td>
+ </tr>
+ <tr>
+ <td>rabbit_password = guest</td>
+ <td>(StrOpt) The RabbitMQ password.</td>
+ </tr>
+ <tr>
+ <td>rabbit_port = 5672</td>
+ <td>(IntOpt) The RabbitMQ broker port where a single node is used.</td>
+ </tr>
+ <tr>
+ <td>rabbit_retry_backoff = 2</td>
+ <td>(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.</td>
+ </tr>
+ <tr>
+ <td>rabbit_retry_interval = 1</td>
+ <td>(IntOpt) How frequently to retry connecting with RabbitMQ.</td>
+ </tr>
+ <tr>
+ <td>rabbit_use_ssl = False</td>
+ <td>(BoolOpt) Connect over SSL for RabbitMQ.</td>
+ </tr>
+ <tr>
+ <td>rabbit_userid = guest</td>
+ <td>(StrOpt) The RabbitMQ userid.</td>
+ </tr>
+ <tr>
+ <td>rabbit_virtual_host = /</td>
+ <td>(StrOpt) The RabbitMQ virtual host.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/glance-rbd.xml b/doc/common/tables/glance-rbd.xml
index 953b602e10..e2568643d6 100644
--- a/doc/common/tables/glance-rbd.xml
+++ b/doc/common/tables/glance-rbd.xml
@@ -1,39 +1,38 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_glance_rbd">
- <caption>Description of configuration options for rbd</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>rbd_store_ceph_conf = /etc/ceph/ceph.conf</td>
- <td>(StrOpt) Ceph configuration file path. If <None>, librados will locate the default config. If using cephx authentication, this file should include a reference to the right keyring in a client.<USER> section.</td>
- </tr>
- <tr>
- <td>rbd_store_chunk_size = 8</td>
- <td>(IntOpt) RADOS images will be chunked into objects of this size (in megabytes). For best performance, this should be a power of two.</td>
- </tr>
- <tr>
- <td>rbd_store_pool = images</td>
- <td>(StrOpt) RADOS pool in which images are stored.</td>
- </tr>
- <tr>
- <td>rbd_store_user = None</td>
- <td>(StrOpt) RADOS user to authenticate as (only applicable if using Cephx. If <None>, a default will be chosen based on the client. section in rbd_store_ceph_conf).</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_glance_rbd">
+ <caption>Description of configuration options for rbd</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>rbd_store_ceph_conf = /etc/ceph/ceph.conf</td>
+ <td>(StrOpt) Ceph configuration file path. If <None>, librados will locate the default config. If using cephx authentication, this file should include a reference to the right keyring in a client.<USER> section.</td>
+ </tr>
+ <tr>
+ <td>rbd_store_chunk_size = 8</td>
+ <td>(IntOpt) RADOS images will be chunked into objects of this size (in megabytes). For best performance, this should be a power of two.</td>
+ </tr>
+ <tr>
+ <td>rbd_store_pool = images</td>
+ <td>(StrOpt) RADOS pool in which images are stored.</td>
+ </tr>
+ <tr>
+ <td>rbd_store_user = None</td>
+ <td>(StrOpt) RADOS user to authenticate as (only applicable if using Cephx. If <None>, a default will be chosen based on the client. section in rbd_store_ceph_conf).</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/glance-redis.xml b/doc/common/tables/glance-redis.xml
index 813bf752ce..28b81556e3 100644
--- a/doc/common/tables/glance-redis.xml
+++ b/doc/common/tables/glance-redis.xml
@@ -1,35 +1,34 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_glance_redis">
- <caption>Description of configuration options for redis</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>host = 127.0.0.1</td>
- <td>(StrOpt) Host to locate redis.</td>
- </tr>
- <tr>
- <td>password = None</td>
- <td>(StrOpt) Password for Redis server (optional).</td>
- </tr>
- <tr>
- <td>port = 6379</td>
- <td>(IntOpt) Use this port to connect to redis host.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_glance_redis">
+ <caption>Description of configuration options for redis</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>host = 127.0.0.1</td>
+ <td>(StrOpt) Host to locate redis.</td>
+ </tr>
+ <tr>
+ <td>password = None</td>
+ <td>(StrOpt) Password for Redis server (optional).</td>
+ </tr>
+ <tr>
+ <td>port = 6379</td>
+ <td>(IntOpt) Use this port to connect to redis host.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/glance-registry.xml b/doc/common/tables/glance-registry.xml
index 02bfb32982..b86b5086e0 100644
--- a/doc/common/tables/glance-registry.xml
+++ b/doc/common/tables/glance-registry.xml
@@ -1,79 +1,78 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_glance_registry">
- <caption>Description of configuration options for registry</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>admin_password = None</td>
- <td>(StrOpt) The administrators password.</td>
- </tr>
- <tr>
- <td>admin_tenant_name = None</td>
- <td>(StrOpt) The tenant name of the administrative user.</td>
- </tr>
- <tr>
- <td>admin_user = None</td>
- <td>(StrOpt) The administrators user name.</td>
- </tr>
- <tr>
- <td>auth_region = None</td>
- <td>(StrOpt) The region for the authentication service.</td>
- </tr>
- <tr>
- <td>auth_strategy = noauth</td>
- <td>(StrOpt) The strategy to use for authentication.</td>
- </tr>
- <tr>
- <td>auth_url = None</td>
- <td>(StrOpt) The URL to the keystone service.</td>
- </tr>
- <tr>
- <td>registry_client_ca_file = None</td>
- <td>(StrOpt) The path to the certifying authority cert file to use in SSL connections to the registry server.</td>
- </tr>
- <tr>
- <td>registry_client_cert_file = None</td>
- <td>(StrOpt) The path to the cert file to use in SSL connections to the registry server.</td>
- </tr>
- <tr>
- <td>registry_client_insecure = False</td>
- <td>(BoolOpt) When using SSL in connections to the registry server, do not require validation via a certifying authority.</td>
- </tr>
- <tr>
- <td>registry_client_key_file = None</td>
- <td>(StrOpt) The path to the key file to use in SSL connections to the registry server.</td>
- </tr>
- <tr>
- <td>registry_client_protocol = http</td>
- <td>(StrOpt) The protocol to use for communication with the registry server. Either http or https.</td>
- </tr>
- <tr>
- <td>registry_client_timeout = 600</td>
- <td>(IntOpt) The period of time, in seconds, that the API server will wait for a registry request to complete. A value of 0 implies no timeout.</td>
- </tr>
- <tr>
- <td>registry_host = 0.0.0.0</td>
- <td>(StrOpt) Address to find the registry server.</td>
- </tr>
- <tr>
- <td>registry_port = 9191</td>
- <td>(IntOpt) Port the registry server is listening on.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_glance_registry">
+ <caption>Description of configuration options for registry</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>admin_password = None</td>
+ <td>(StrOpt) The administrators password.</td>
+ </tr>
+ <tr>
+ <td>admin_tenant_name = None</td>
+ <td>(StrOpt) The tenant name of the administrative user.</td>
+ </tr>
+ <tr>
+ <td>admin_user = None</td>
+ <td>(StrOpt) The administrators user name.</td>
+ </tr>
+ <tr>
+ <td>auth_region = None</td>
+ <td>(StrOpt) The region for the authentication service.</td>
+ </tr>
+ <tr>
+ <td>auth_strategy = noauth</td>
+ <td>(StrOpt) The strategy to use for authentication.</td>
+ </tr>
+ <tr>
+ <td>auth_url = None</td>
+ <td>(StrOpt) The URL to the keystone service.</td>
+ </tr>
+ <tr>
+ <td>registry_client_ca_file = None</td>
+ <td>(StrOpt) The path to the certifying authority cert file to use in SSL connections to the registry server.</td>
+ </tr>
+ <tr>
+ <td>registry_client_cert_file = None</td>
+ <td>(StrOpt) The path to the cert file to use in SSL connections to the registry server.</td>
+ </tr>
+ <tr>
+ <td>registry_client_insecure = False</td>
+ <td>(BoolOpt) When using SSL in connections to the registry server, do not require validation via a certifying authority.</td>
+ </tr>
+ <tr>
+ <td>registry_client_key_file = None</td>
+ <td>(StrOpt) The path to the key file to use in SSL connections to the registry server.</td>
+ </tr>
+ <tr>
+ <td>registry_client_protocol = http</td>
+ <td>(StrOpt) The protocol to use for communication with the registry server. Either http or https.</td>
+ </tr>
+ <tr>
+ <td>registry_client_timeout = 600</td>
+ <td>(IntOpt) The period of time, in seconds, that the API server will wait for a registry request to complete. A value of 0 implies no timeout.</td>
+ </tr>
+ <tr>
+ <td>registry_host = 0.0.0.0</td>
+ <td>(StrOpt) Address to find the registry server.</td>
+ </tr>
+ <tr>
+ <td>registry_port = 9191</td>
+ <td>(IntOpt) Port the registry server is listening on.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/glance-rpc.xml b/doc/common/tables/glance-rpc.xml
index 433d9a8690..9ab4b31339 100644
--- a/doc/common/tables/glance-rpc.xml
+++ b/doc/common/tables/glance-rpc.xml
@@ -1,27 +1,26 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_glance_rpc">
- <caption>Description of configuration options for rpc</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>allowed_rpc_exception_modules = openstack.common.exception, glance.common.exception, exceptions</td>
- <td>(ListOpt) Modules of exceptions that are permitted to be recreatedupon receiving exception data from an rpc call.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_glance_rpc">
+ <caption>Description of configuration options for rpc</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>allowed_rpc_exception_modules = openstack.common.exception, glance.common.exception, exceptions</td>
+ <td>(ListOpt) Modules of exceptions that are permitted to be recreatedupon receiving exception data from an rpc call.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/glance-s3.xml b/doc/common/tables/glance-s3.xml
index 749736b65f..f913095cb7 100644
--- a/doc/common/tables/glance-s3.xml
+++ b/doc/common/tables/glance-s3.xml
@@ -1,51 +1,62 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_glance_s3">
- <caption>Description of configuration options for s3</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>s3_store_access_key = None</td>
- <td>(StrOpt) The S3 query token access key.</td>
- </tr>
- <tr>
- <td>s3_store_bucket = None</td>
- <td>(StrOpt) The S3 bucket to be used to store the Glance data.</td>
- </tr>
- <tr>
- <td>s3_store_bucket_url_format = subdomain</td>
- <td>(StrOpt) The S3 calling format used to determine the bucket. Either subdomain or path can be used.</td>
- </tr>
- <tr>
- <td>s3_store_create_bucket_on_put = False</td>
- <td>(BoolOpt) A boolean to determine if the S3 bucket should be created on upload if it does not exist or if an error should be returned to the user.</td>
- </tr>
- <tr>
- <td>s3_store_host = None</td>
- <td>(StrOpt) The host where the S3 server is listening.</td>
- </tr>
- <tr>
- <td>s3_store_object_buffer_dir = None</td>
- <td>(StrOpt) The local directory where uploads will be staged before they are transferred into S3.</td>
- </tr>
- <tr>
- <td>s3_store_secret_key = None</td>
- <td>(StrOpt) The S3 query token secret key.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_glance_s3">
+ <caption>Description of configuration options for s3</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>s3_store_access_key = None</td>
+ <td>(StrOpt) The S3 query token access key.</td>
+ </tr>
+ <tr>
+ <td>s3_store_bucket = None</td>
+ <td>(StrOpt) The S3 bucket to be used to store the Glance data.</td>
+ </tr>
+ <tr>
+ <td>s3_store_bucket_url_format = subdomain</td>
+ <td>(StrOpt) The S3 calling format used to determine the bucket. Either subdomain or path can be used.</td>
+ </tr>
+ <tr>
+ <td>s3_store_create_bucket_on_put = False</td>
+ <td>(BoolOpt) A boolean to determine if the S3 bucket should be created on upload if it does not exist or if an error should be returned to the user.</td>
+ </tr>
+ <tr>
+ <td>s3_store_host = None</td>
+ <td>(StrOpt) The host where the S3 server is listening.</td>
+ </tr>
+ <tr>
+ <td>s3_store_large_object_chunk_size = 10</td>
+ <td>(IntOpt) What multipart upload part size, in MB, should S3 use when uploading parts. The size must be greater than or equal to 5M.</td>
+ </tr>
+ <tr>
+ <td>s3_store_large_object_size = 100</td>
+ <td>(IntOpt) What size, in MB, should S3 start chunking image files and do a multipart upload in S3.</td>
+ </tr>
+ <tr>
+ <td>s3_store_object_buffer_dir = None</td>
+ <td>(StrOpt) The local directory where uploads will be staged before they are transferred into S3.</td>
+ </tr>
+ <tr>
+ <td>s3_store_secret_key = None</td>
+ <td>(StrOpt) The S3 query token secret key.</td>
+ </tr>
+ <tr>
+ <td>s3_store_thread_pools = 10</td>
+ <td>(IntOpt) The number of thread pools to perform a multipart upload in S3.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/glance-sheepdog.xml b/doc/common/tables/glance-sheepdog.xml
index c852c65c8f..51a65d2945 100644
--- a/doc/common/tables/glance-sheepdog.xml
+++ b/doc/common/tables/glance-sheepdog.xml
@@ -1,35 +1,34 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_glance_sheepdog">
- <caption>Description of configuration options for sheepdog</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>sheepdog_store_address = 127.0.0.1</td>
- <td>(StrOpt) IP address of sheep daemon.</td>
- </tr>
- <tr>
- <td>sheepdog_store_chunk_size = 64</td>
- <td>(IntOpt) Images will be chunked into objects of this size (in megabytes). For best performance, this should be a power of two.</td>
- </tr>
- <tr>
- <td>sheepdog_store_port = 7000</td>
- <td>(IntOpt) Port of sheep daemon.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_glance_sheepdog">
+ <caption>Description of configuration options for sheepdog</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>sheepdog_store_address = 127.0.0.1</td>
+ <td>(StrOpt) IP address of sheep daemon.</td>
+ </tr>
+ <tr>
+ <td>sheepdog_store_chunk_size = 64</td>
+ <td>(IntOpt) Images will be chunked into objects of this size (in megabytes). For best performance, this should be a power of two.</td>
+ </tr>
+ <tr>
+ <td>sheepdog_store_port = 7000</td>
+ <td>(IntOpt) Port of sheep daemon.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/glance-ssl.xml b/doc/common/tables/glance-ssl.xml
index ff7db178d9..a97845e1b5 100644
--- a/doc/common/tables/glance-ssl.xml
+++ b/doc/common/tables/glance-ssl.xml
@@ -1,35 +1,34 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_glance_ssl">
- <caption>Description of configuration options for ssl</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>ca_file = None</td>
- <td>(StrOpt) CA certificate file to use to verify connecting clients.</td>
- </tr>
- <tr>
- <td>cert_file = None</td>
- <td>(StrOpt) Certificate file to use when starting API server securely.</td>
- </tr>
- <tr>
- <td>key_file = None</td>
- <td>(StrOpt) Private key file to use when starting API server securely.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_glance_ssl">
+ <caption>Description of configuration options for ssl</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>ca_file = None</td>
+ <td>(StrOpt) CA certificate file to use to verify connecting clients.</td>
+ </tr>
+ <tr>
+ <td>cert_file = None</td>
+ <td>(StrOpt) Certificate file to use when starting API server securely.</td>
+ </tr>
+ <tr>
+ <td>key_file = None</td>
+ <td>(StrOpt) Private key file to use when starting API server securely.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/glance-swift.xml b/doc/common/tables/glance-swift.xml
index 452d6dfccd..61903b446e 100644
--- a/doc/common/tables/glance-swift.xml
+++ b/doc/common/tables/glance-swift.xml
@@ -1,91 +1,94 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_glance_swift">
- <caption>Description of configuration options for swift</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>swift_enable_snet = False</td>
- <td>(BoolOpt) Whether to use ServiceNET to communicate with the Swift storage servers.</td>
- </tr>
- <tr>
- <td>swift_store_admin_tenants = </td>
- <td>(ListOpt) A list of tenants that will be granted read/write access on all Swift containers created by Glance in multi-tenant mode.</td>
- </tr>
- <tr>
- <td>swift_store_auth_address = None</td>
- <td>(StrOpt) The address where the Swift authentication service is listening.</td>
- </tr>
- <tr>
- <td>swift_store_auth_insecure = False</td>
- <td>(BoolOpt) If True, swiftclient won't check for a valid SSL certificate when authenticating.</td>
- </tr>
- <tr>
- <td>swift_store_auth_version = 2</td>
- <td>(StrOpt) Version of the authentication service to use. Valid versions are 2 for keystone and 1 for swauth and rackspace.</td>
- </tr>
- <tr>
- <td>swift_store_container = glance</td>
- <td>(StrOpt) Container within the account that the account should use for storing images in Swift.</td>
- </tr>
- <tr>
- <td>swift_store_create_container_on_put = False</td>
- <td>(BoolOpt) A boolean value that determines if we create the container if it does not exist.</td>
- </tr>
- <tr>
- <td>swift_store_endpoint_type = publicURL</td>
- <td>(StrOpt) A string giving the endpoint type of the swift service to use (publicURL, adminURL or internalURL). This setting is only used if swift_store_auth_version is 2.</td>
- </tr>
- <tr>
- <td>swift_store_key = None</td>
- <td>(StrOpt) Auth key for the user authenticating against the Swift authentication service.</td>
- </tr>
- <tr>
- <td>swift_store_large_object_chunk_size = 200</td>
- <td>(IntOpt) The amount of data written to a temporary disk buffer during the process of chunking the image file.</td>
- </tr>
- <tr>
- <td>swift_store_large_object_size = 5120</td>
- <td>(IntOpt) The size, in MB, that Glance will start chunking image files and do a large object manifest in Swift.</td>
- </tr>
- <tr>
- <td>swift_store_multi_tenant = False</td>
- <td>(BoolOpt) If set to True, enables multi-tenant storage mode which causes Glance images to be stored in tenant specific Swift accounts.</td>
- </tr>
- <tr>
- <td>swift_store_region = None</td>
- <td>(StrOpt) The region of the swift endpoint to be used for single tenant. This setting is only necessary if the tenant has multiple swift endpoints.</td>
- </tr>
- <tr>
- <td>swift_store_retry_get_count = 0</td>
- <td>(IntOpt) The number of times a Swift download will be retried before the request fails.</td>
- </tr>
- <tr>
- <td>swift_store_service_type = object-store</td>
- <td>(StrOpt) A string giving the service type of the swift service to use. This setting is only used if swift_store_auth_version is 2.</td>
- </tr>
- <tr>
- <td>swift_store_ssl_compression = True</td>
- <td>(BoolOpt) If set to False, disables SSL layer compression of https swift requests. Setting to False may improve performance for images which are already in a compressed format, eg qcow2.</td>
- </tr>
- <tr>
- <td>swift_store_user = None</td>
- <td>(StrOpt) The user to authenticate against the Swift authentication service.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_glance_swift">
+ <caption>Description of configuration options for swift</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>swift_enable_snet = False</td>
+ <td>(BoolOpt) Whether to use ServiceNET to communicate with the Swift storage servers.</td>
+ </tr>
+ <tr>
+ <td>swift_store_admin_tenants = </td>
+ <td>(ListOpt) A list of tenants that will be granted read/write access on all Swift containers created by Glance in multi-tenant mode.</td>
+ </tr>
+ <tr>
+ <td>swift_store_auth_address = None</td>
+ <td>(StrOpt) The address where the Swift authentication service is listening.(deprecated)</td>
+ </tr>
+ <tr>
+ <td>swift_store_auth_insecure = False</td>
+ <td>(BoolOpt) If True, swiftclient won't check for a valid SSL certificate when authenticating.</td>
+ </tr>
+ <tr>
+ <td>swift_store_auth_version = 2</td>
+ <td>(StrOpt) Version of the authentication service to use. Valid versions are 2 for keystone and 1 for swauth and rackspace. (deprecated)</td>
+ </tr>
+ <tr>
+ <td>swift_store_config_file = None</td>
+ <td>(StrOpt) The config file that has the swift account(s)configs.</td>
+ </tr>
+ <tr>
+ <td>swift_store_container = glance</td>
+ <td>(StrOpt) Container within the account that the account should use for storing images in Swift.</td>
+ </tr>
+ <tr>
+ <td>swift_store_create_container_on_put = False</td>
+ <td>(BoolOpt) A boolean value that determines if we create the container if it does not exist.</td>
+ </tr>
+ <tr>
+ <td>swift_store_endpoint_type = publicURL</td>
+ <td>(StrOpt) A string giving the endpoint type of the swift service to use (publicURL, adminURL or internalURL). This setting is only used if swift_store_auth_version is 2.</td>
+ </tr>
+ <tr>
+ <td>swift_store_key = None</td>
+ <td>(StrOpt) Auth key for the user authenticating against the Swift authentication service. (deprecated)</td>
+ </tr>
+ <tr>
+ <td>swift_store_large_object_chunk_size = 200</td>
+ <td>(IntOpt) The amount of data written to a temporary disk buffer during the process of chunking the image file.</td>
+ </tr>
+ <tr>
+ <td>swift_store_large_object_size = 5120</td>
+ <td>(IntOpt) The size, in MB, that Glance will start chunking image files and do a large object manifest in Swift.</td>
+ </tr>
+ <tr>
+ <td>swift_store_multi_tenant = False</td>
+ <td>(BoolOpt) If set to True, enables multi-tenant storage mode which causes Glance images to be stored in tenant specific Swift accounts.</td>
+ </tr>
+ <tr>
+ <td>swift_store_region = None</td>
+ <td>(StrOpt) The region of the swift endpoint to be used for single tenant. This setting is only necessary if the tenant has multiple swift endpoints.</td>
+ </tr>
+ <tr>
+ <td>swift_store_retry_get_count = 0</td>
+ <td>(IntOpt) The number of times a Swift download will be retried before the request fails.</td>
+ </tr>
+ <tr>
+ <td>swift_store_service_type = object-store</td>
+ <td>(StrOpt) A string giving the service type of the swift service to use. This setting is only used if swift_store_auth_version is 2.</td>
+ </tr>
+ <tr>
+ <td>swift_store_ssl_compression = True</td>
+ <td>(BoolOpt) If set to False, disables SSL layer compression of https swift requests. Setting to False may improve performance for images which are already in a compressed format, eg qcow2.</td>
+ </tr>
+ <tr>
+ <td>swift_store_user = None</td>
+ <td>(StrOpt) The user to authenticate against the Swift authentication service (deprecated)</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/glance-testing.xml b/doc/common/tables/glance-testing.xml
index fe7538fad7..84c2e4ec85 100644
--- a/doc/common/tables/glance-testing.xml
+++ b/doc/common/tables/glance-testing.xml
@@ -1,31 +1,30 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_glance_testing">
- <caption>Description of configuration options for testing</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>pydev_worker_debug_host = None</td>
- <td>(StrOpt) The hostname/IP of the pydev process listening for debug connections</td>
- </tr>
- <tr>
- <td>pydev_worker_debug_port = 5678</td>
- <td>(IntOpt) The port on which a pydev process is listening for connections.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_glance_testing">
+ <caption>Description of configuration options for testing</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>pydev_worker_debug_host = None</td>
+ <td>(StrOpt) The hostname/IP of the pydev process listening for debug connections</td>
+ </tr>
+ <tr>
+ <td>pydev_worker_debug_port = 5678</td>
+ <td>(IntOpt) The port on which a pydev process is listening for connections.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/glance-vmware.xml b/doc/common/tables/glance-vmware.xml
index 23ce4f4812..334a94cfd4 100644
--- a/doc/common/tables/glance-vmware.xml
+++ b/doc/common/tables/glance-vmware.xml
@@ -1,59 +1,58 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_glance_vmware">
- <caption>Description of configuration options for vmware</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>vmware_api_insecure = False</td>
- <td>(BoolOpt) Allow to perform insecure SSL requests to ESX/VC.</td>
- </tr>
- <tr>
- <td>vmware_api_retry_count = 10</td>
- <td>(IntOpt) Number of times VMware ESX/VC server API must be retried upon connection related issues.</td>
- </tr>
- <tr>
- <td>vmware_datacenter_path = ha-datacenter</td>
- <td>(StrOpt) Inventory path to a datacenter. If the vmware_server_host specified is an ESX/ESXi, the vmware_datacenter_path is optional. If specified, it should be "ha-datacenter".</td>
- </tr>
- <tr>
- <td>vmware_datastore_name = None</td>
- <td>(StrOpt) Datastore associated with the datacenter.</td>
- </tr>
- <tr>
- <td>vmware_server_host = None</td>
- <td>(StrOpt) ESX/ESXi or vCenter Server target system. The server value can be an IP address or a DNS name.</td>
- </tr>
- <tr>
- <td>vmware_server_password = None</td>
- <td>(StrOpt) Password for authenticating with VMware ESX/VC server.</td>
- </tr>
- <tr>
- <td>vmware_server_username = None</td>
- <td>(StrOpt) Username for authenticating with VMware ESX/VC server.</td>
- </tr>
- <tr>
- <td>vmware_store_image_dir = /openstack_glance</td>
- <td>(StrOpt) The name of the directory where the glance images will be stored in the VMware datastore.</td>
- </tr>
- <tr>
- <td>vmware_task_poll_interval = 5</td>
- <td>(IntOpt) The interval used for polling remote tasks invoked on VMware ESX/VC server.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_glance_vmware">
+ <caption>Description of configuration options for vmware</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>vmware_api_insecure = False</td>
+ <td>(BoolOpt) Allow to perform insecure SSL requests to ESX/VC.</td>
+ </tr>
+ <tr>
+ <td>vmware_api_retry_count = 10</td>
+ <td>(IntOpt) Number of times VMware ESX/VC server API must be retried upon connection related issues.</td>
+ </tr>
+ <tr>
+ <td>vmware_datacenter_path = ha-datacenter</td>
+ <td>(StrOpt) Inventory path to a datacenter. If the vmware_server_host specified is an ESX/ESXi, the vmware_datacenter_path is optional. If specified, it should be "ha-datacenter".</td>
+ </tr>
+ <tr>
+ <td>vmware_datastore_name = None</td>
+ <td>(StrOpt) Datastore associated with the datacenter.</td>
+ </tr>
+ <tr>
+ <td>vmware_server_host = None</td>
+ <td>(StrOpt) ESX/ESXi or vCenter Server target system. The server value can be an IP address or a DNS name.</td>
+ </tr>
+ <tr>
+ <td>vmware_server_password = None</td>
+ <td>(StrOpt) Password for authenticating with VMware ESX/VC server.</td>
+ </tr>
+ <tr>
+ <td>vmware_server_username = None</td>
+ <td>(StrOpt) Username for authenticating with VMware ESX/VC server.</td>
+ </tr>
+ <tr>
+ <td>vmware_store_image_dir = /openstack_glance</td>
+ <td>(StrOpt) The name of the directory where the glance images will be stored in the VMware datastore.</td>
+ </tr>
+ <tr>
+ <td>vmware_task_poll_interval = 5</td>
+ <td>(IntOpt) The interval used for polling remote tasks invoked on VMware ESX/VC server.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/glance-wsgi.xml b/doc/common/tables/glance-wsgi.xml
index 02ccd11bfc..943c0fc0fb 100644
--- a/doc/common/tables/glance-wsgi.xml
+++ b/doc/common/tables/glance-wsgi.xml
@@ -1,39 +1,34 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_glance_wsgi">
- <caption>Description of configuration options for wsgi</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>backdoor_port = None</td>
- <td>(IntOpt) port for eventlet backdoor to listen</td>
- </tr>
- <tr>
- <td>eventlet_hub = poll</td>
- <td>(StrOpt) Name of eventlet hub to use. Traditionally, we have only supported 'poll', however 'selects' may be appropriate for some platforms. See http://eventlet.net/doc/hubs.html for more details.</td>
- </tr>
- <tr>
- <td>max_header_line = 16384</td>
- <td>(IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs</td>
- </tr>
- <tr>
- <td>tcp_keepidle = 600</td>
- <td>(IntOpt) The value for the socket option TCP_KEEPIDLE. This is the time in seconds that the connection must be idle before TCP starts sending keepalive probes.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_glance_wsgi">
+ <caption>Description of configuration options for wsgi</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>eventlet_hub = poll</td>
+ <td>(StrOpt) Name of eventlet hub to use. Traditionally, we have only supported 'poll', however 'selects' may be appropriate for some platforms. See http://eventlet.net/doc/hubs.html for more details.</td>
+ </tr>
+ <tr>
+ <td>max_header_line = 16384</td>
+ <td>(IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs</td>
+ </tr>
+ <tr>
+ <td>tcp_keepidle = 600</td>
+ <td>(IntOpt) The value for the socket option TCP_KEEPIDLE. This is the time in seconds that the connection must be idle before TCP starts sending keepalive probes.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/glance-zmq.xml b/doc/common/tables/glance-zmq.xml
index db3b8851f1..cca68c5c3a 100644
--- a/doc/common/tables/glance-zmq.xml
+++ b/doc/common/tables/glance-zmq.xml
@@ -1,55 +1,54 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_glance_zmq">
- <caption>Description of configuration options for zmq</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>rpc_cast_timeout = 30</td>
- <td>(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq.</td>
- </tr>
- <tr>
- <td>rpc_zmq_bind_address = *</td>
- <td>(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address.</td>
- </tr>
- <tr>
- <td>rpc_zmq_contexts = 1</td>
- <td>(IntOpt) Number of ZeroMQ contexts, defaults to 1.</td>
- </tr>
- <tr>
- <td>rpc_zmq_host = oslo</td>
- <td>(StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova.</td>
- </tr>
- <tr>
- <td>rpc_zmq_ipc_dir = /var/run/openstack</td>
- <td>(StrOpt) Directory for holding IPC sockets.</td>
- </tr>
- <tr>
- <td>rpc_zmq_matchmaker = oslo.messaging._drivers.matchmaker.MatchMakerLocalhost</td>
- <td>(StrOpt) MatchMaker driver.</td>
- </tr>
- <tr>
- <td>rpc_zmq_port = 9501</td>
- <td>(IntOpt) ZeroMQ receiver listening port.</td>
- </tr>
- <tr>
- <td>rpc_zmq_topic_backlog = None</td>
- <td>(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_glance_zmq">
+ <caption>Description of configuration options for zmq</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>rpc_cast_timeout = 30</td>
+ <td>(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_bind_address = *</td>
+ <td>(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_contexts = 1</td>
+ <td>(IntOpt) Number of ZeroMQ contexts, defaults to 1.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_host = oslo</td>
+ <td>(StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_ipc_dir = /var/run/openstack</td>
+ <td>(StrOpt) Directory for holding IPC sockets.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_matchmaker = oslo.messaging._drivers.matchmaker.MatchMakerLocalhost</td>
+ <td>(StrOpt) MatchMaker driver.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_port = 9501</td>
+ <td>(IntOpt) ZeroMQ receiver listening port.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_topic_backlog = None</td>
+ <td>(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/heat-amqp.xml b/doc/common/tables/heat-amqp.xml
index aa08b8d008..f56c1f7d05 100644
--- a/doc/common/tables/heat-amqp.xml
+++ b/doc/common/tables/heat-amqp.xml
@@ -1,59 +1,58 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_heat_amqp">
- <caption>Description of configuration options for amqp</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>amqp_auto_delete = False</td>
- <td>(BoolOpt) Auto-delete queues in amqp.</td>
- </tr>
- <tr>
- <td>amqp_durable_queues = False</td>
- <td>(BoolOpt) Use durable queues in amqp.</td>
- </tr>
- <tr>
- <td>control_exchange = heat</td>
- <td>(StrOpt) AMQP exchange to connect to if using RabbitMQ or Qpid</td>
- </tr>
- <tr>
- <td>default_notification_level = INFO</td>
- <td>(StrOpt) Default notification level for outgoing notifications</td>
- </tr>
- <tr>
- <td>default_publisher_id = None</td>
- <td>(StrOpt) Default publisher_id for outgoing notifications</td>
- </tr>
- <tr>
- <td>fake_rabbit = False</td>
- <td>(BoolOpt) If passed, use a fake RabbitMQ provider</td>
- </tr>
- <tr>
- <td>list_notifier_drivers = ['heat.openstack.common.notifier.no_op_notifier']</td>
- <td>(MultiStrOpt) List of drivers to send notifications</td>
- </tr>
- <tr>
- <td>notification_driver = []</td>
- <td>(MultiStrOpt) Driver or drivers to handle sending notifications</td>
- </tr>
- <tr>
- <td>notification_topics = notifications</td>
- <td>(ListOpt) AMQP topic used for OpenStack notifications</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_heat_amqp">
+ <caption>Description of configuration options for amqp</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>amqp_auto_delete = False</td>
+ <td>(BoolOpt) Auto-delete queues in amqp.</td>
+ </tr>
+ <tr>
+ <td>amqp_durable_queues = False</td>
+ <td>(BoolOpt) Use durable queues in amqp.</td>
+ </tr>
+ <tr>
+ <td>control_exchange = openstack</td>
+ <td>(StrOpt) AMQP exchange to connect to if using RabbitMQ or Qpid</td>
+ </tr>
+ <tr>
+ <td>default_notification_level = INFO</td>
+ <td>(StrOpt) Default notification level for outgoing notifications</td>
+ </tr>
+ <tr>
+ <td>default_publisher_id = None</td>
+ <td>(StrOpt) Default publisher_id for outgoing notifications</td>
+ </tr>
+ <tr>
+ <td>fake_rabbit = False</td>
+ <td>(BoolOpt) If passed, use a fake RabbitMQ provider</td>
+ </tr>
+ <tr>
+ <td>list_notifier_drivers = None</td>
+ <td>(MultiStrOpt) List of drivers to send notifications (DEPRECATED)</td>
+ </tr>
+ <tr>
+ <td>notification_driver = []</td>
+ <td>(MultiStrOpt) Driver or drivers to handle sending notifications.</td>
+ </tr>
+ <tr>
+ <td>notification_topics = notifications</td>
+ <td>(ListOpt) AMQP topic used for OpenStack notifications.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/heat-api.xml b/doc/common/tables/heat-api.xml
index 64a5c38202..577d8c13be 100644
--- a/doc/common/tables/heat-api.xml
+++ b/doc/common/tables/heat-api.xml
@@ -1,158 +1,161 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_heat_api">
- <caption>Description of configuration options for api</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>heat_metadata_server_url = </td>
- <td>(StrOpt) URL of the Heat metadata server.</td>
- </tr>
- <tr>
- <td>heat_stack_user_role = heat_stack_user</td>
- <td>(StrOpt) Keystone role for heat template-defined users.</td>
- </tr>
- <tr>
- <td>heat_waitcondition_server_url = </td>
- <td>(StrOpt) URL of the Heat waitcondition server.</td>
- </tr>
- <tr>
- <td>heat_watch_server_url = </td>
- <td>(StrOpt) URL of the Heat CloudWatch server.</td>
- </tr>
- <tr>
- <td>max_json_body_size = 1048576</td>
- <td>(IntOpt) Maximum raw byte size of JSON request body. Should be larger than max_template_size.</td>
- </tr>
- <tr>
- <td>policy_default_rule = default</td>
- <td>(StrOpt) Rule enforced when requested rule is not found</td>
- </tr>
- <tr>
- <td>policy_file = policy.json</td>
- <td>(StrOpt) JSON file containing policy</td>
- </tr>
- <tr>
- <td>secure_proxy_ssl_header = X-Forwarded-Proto</td>
- <td>(StrOpt) The HTTP Header that will be used to determine which the original request protocol scheme was, even if it was removed by an SSL terminator proxy.</td>
- </tr>
- <tr>
- <td>stack_action_timeout = 3600</td>
- <td>(IntOpt) Timeout in seconds for stack action (ie. create or update).</td>
- </tr>
- <tr>
- <td>stack_domain_admin = None</td>
- <td>(StrOpt) Keystone username, a user with roles sufficient to manage users and projects in the stack_user_domain.</td>
- </tr>
- <tr>
- <td>stack_domain_admin_password = None</td>
- <td>(StrOpt) Keystone password for stack_domain_admin user.</td>
- </tr>
- <tr>
- <td>stack_user_domain = None</td>
- <td>(StrOpt) Keystone domain ID which contains heat template-defined users.</td>
- </tr>
- <tr>
- <td>trusts_delegated_roles = heat_stack_owner</td>
- <td>(ListOpt) Subset of trustor roles to be delegated to heat.</td>
- </tr>
- <tr>
- <th colspan="2">[auth_password]</th>
- </tr>
- <tr>
- <td>allowed_auth_uris = </td>
- <td>(ListOpt) Allowed keystone endpoints for auth_uri when multi_cloud is enabled. At least one endpoint needs to be specified.</td>
- </tr>
- <tr>
- <td>multi_cloud = False</td>
- <td>(BoolOpt) Allow orchestration of multiple clouds.</td>
- </tr>
- <tr>
- <th colspan="2">[ec2authtoken]</th>
- </tr>
- <tr>
- <td>allowed_auth_uris = </td>
- <td>(ListOpt) Allowed keystone endpoints for auth_uri when multi_cloud is enabled. At least one endpoint needs to be specified.</td>
- </tr>
- <tr>
- <td>auth_uri = None</td>
- <td>(StrOpt) Authentication Endpoint URI.</td>
- </tr>
- <tr>
- <td>multi_cloud = False</td>
- <td>(BoolOpt) Allow orchestration of multiple clouds.</td>
- </tr>
- <tr>
- <th colspan="2">[heat_api]</th>
- </tr>
- <tr>
- <td>backlog = 4096</td>
- <td>(IntOpt) Number of backlog requests to configure the socket with.</td>
- </tr>
- <tr>
- <td>bind_host = 0.0.0.0</td>
- <td>(StrOpt) Address to bind the server. Useful when selecting a particular network interface.</td>
- </tr>
- <tr>
- <td>bind_port = 8004</td>
- <td>(IntOpt) The port on which the server will listen.</td>
- </tr>
- <tr>
- <td>cert_file = None</td>
- <td>(StrOpt) Location of the SSL certificate file to use for SSL mode.</td>
- </tr>
- <tr>
- <td>key_file = None</td>
- <td>(StrOpt) Location of the SSL key file to use for enabling SSL mode.</td>
- </tr>
- <tr>
- <td>max_header_line = 16384</td>
- <td>(IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs).</td>
- </tr>
- <tr>
- <td>workers = 0</td>
- <td>(IntOpt) Number of workers for Heat service.</td>
- </tr>
- <tr>
- <th colspan="2">[paste_deploy]</th>
- </tr>
- <tr>
- <td>api_paste_config = api-paste.ini</td>
- <td>(StrOpt) The API paste config file to use.</td>
- </tr>
- <tr>
- <td>flavor = None</td>
- <td>(StrOpt) The flavor to use.</td>
- </tr>
- <tr>
- <th colspan="2">[ssl]</th>
- </tr>
- <tr>
- <td>ca_file = None</td>
- <td>(StrOpt) CA certificate file to use to verify connecting clients</td>
- </tr>
- <tr>
- <td>cert_file = None</td>
- <td>(StrOpt) Certificate file to use when starting the server securely</td>
- </tr>
- <tr>
- <td>key_file = None</td>
- <td>(StrOpt) Private key file to use when starting the server securely</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_heat_api">
+ <caption>Description of configuration options for api</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>heat_metadata_server_url = </td>
+ <td>(StrOpt) URL of the Heat metadata server.</td>
+ </tr>
+ <tr>
+ <td>heat_stack_user_role = heat_stack_user</td>
+ <td>(StrOpt) Keystone role for heat template-defined users.</td>
+ </tr>
+ <tr>
+ <td>heat_waitcondition_server_url = </td>
+ <td>(StrOpt) URL of the Heat waitcondition server.</td>
+ </tr>
+ <tr>
+ <td>heat_watch_server_url = </td>
+ <td>(StrOpt) URL of the Heat CloudWatch server.</td>
+ </tr>
+ <tr>
+ <td>max_json_body_size = 1048576</td>
+ <td>(IntOpt) Maximum raw byte size of JSON request body. Should be larger than max_template_size.</td>
+ </tr>
+ <tr>
+ <td>num_engine_workers = 1</td>
+ <td>(IntOpt) Number of heat-engine processes to fork and run.</td>
+ </tr>
+ <tr>
+ <td>policy_default_rule = default</td>
+ <td>(StrOpt) Default rule. Enforced when a requested rule is not found.</td>
+ </tr>
+ <tr>
+ <td>policy_file = policy.json</td>
+ <td>(StrOpt) The JSON file that defines policies.</td>
+ </tr>
+ <tr>
+ <td>secure_proxy_ssl_header = X-Forwarded-Proto</td>
+ <td>(StrOpt) The HTTP Header that will be used to determine which the original request protocol scheme was, even if it was removed by an SSL terminator proxy.</td>
+ </tr>
+ <tr>
+ <td>stack_action_timeout = 3600</td>
+ <td>(IntOpt) Timeout in seconds for stack action (ie. create or update).</td>
+ </tr>
+ <tr>
+ <td>stack_domain_admin = None</td>
+ <td>(StrOpt) Keystone username, a user with roles sufficient to manage users and projects in the stack_user_domain.</td>
+ </tr>
+ <tr>
+ <td>stack_domain_admin_password = None</td>
+ <td>(StrOpt) Keystone password for stack_domain_admin user.</td>
+ </tr>
+ <tr>
+ <td>stack_user_domain = None</td>
+ <td>(StrOpt) Keystone domain ID which contains heat template-defined users.</td>
+ </tr>
+ <tr>
+ <td>trusts_delegated_roles = heat_stack_owner</td>
+ <td>(ListOpt) Subset of trustor roles to be delegated to heat.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[auth_password]</th>
+ </tr>
+ <tr>
+ <td>allowed_auth_uris = </td>
+ <td>(ListOpt) Allowed keystone endpoints for auth_uri when multi_cloud is enabled. At least one endpoint needs to be specified.</td>
+ </tr>
+ <tr>
+ <td>multi_cloud = False</td>
+ <td>(BoolOpt) Allow orchestration of multiple clouds.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[ec2authtoken]</th>
+ </tr>
+ <tr>
+ <td>allowed_auth_uris = </td>
+ <td>(ListOpt) Allowed keystone endpoints for auth_uri when multi_cloud is enabled. At least one endpoint needs to be specified.</td>
+ </tr>
+ <tr>
+ <td>auth_uri = None</td>
+ <td>(StrOpt) Authentication Endpoint URI.</td>
+ </tr>
+ <tr>
+ <td>multi_cloud = False</td>
+ <td>(BoolOpt) Allow orchestration of multiple clouds.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[heat_api]</th>
+ </tr>
+ <tr>
+ <td>backlog = 4096</td>
+ <td>(IntOpt) Number of backlog requests to configure the socket with.</td>
+ </tr>
+ <tr>
+ <td>bind_host = 0.0.0.0</td>
+ <td>(StrOpt) Address to bind the server. Useful when selecting a particular network interface.</td>
+ </tr>
+ <tr>
+ <td>bind_port = 8004</td>
+ <td>(IntOpt) The port on which the server will listen.</td>
+ </tr>
+ <tr>
+ <td>cert_file = None</td>
+ <td>(StrOpt) Location of the SSL certificate file to use for SSL mode.</td>
+ </tr>
+ <tr>
+ <td>key_file = None</td>
+ <td>(StrOpt) Location of the SSL key file to use for enabling SSL mode.</td>
+ </tr>
+ <tr>
+ <td>max_header_line = 16384</td>
+ <td>(IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs).</td>
+ </tr>
+ <tr>
+ <td>workers = 0</td>
+ <td>(IntOpt) Number of workers for Heat service.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[paste_deploy]</th>
+ </tr>
+ <tr>
+ <td>api_paste_config = api-paste.ini</td>
+ <td>(StrOpt) The API paste config file to use.</td>
+ </tr>
+ <tr>
+ <td>flavor = None</td>
+ <td>(StrOpt) The flavor to use.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[ssl]</th>
+ </tr>
+ <tr>
+ <td>ca_file = None</td>
+ <td>(StrOpt) CA certificate file to use to verify connecting clients.</td>
+ </tr>
+ <tr>
+ <td>cert_file = None</td>
+ <td>(StrOpt) Certificate file to use when starting the server securely.</td>
+ </tr>
+ <tr>
+ <td>key_file = None</td>
+ <td>(StrOpt) Private key file to use when starting the server securely.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/heat-auth_token.xml b/doc/common/tables/heat-auth_token.xml
index d2400ebd67..3016d972bf 100644
--- a/doc/common/tables/heat-auth_token.xml
+++ b/doc/common/tables/heat-auth_token.xml
@@ -1,134 +1,145 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_heat_auth_token">
- <caption>Description of configuration options for auth_token</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>memcached_servers = None</td>
- <td>(ListOpt) Memcached servers or None for in process cache.</td>
- </tr>
- <tr>
- <th colspan="2">[keystone_authtoken]</th>
- </tr>
- <tr>
- <td>admin_password = None</td>
- <td>(StrOpt) Keystone account password</td>
- </tr>
- <tr>
- <td>admin_tenant_name = admin</td>
- <td>(StrOpt) Keystone service account tenant name to validate user tokens</td>
- </tr>
- <tr>
- <td>admin_token = None</td>
- <td>(StrOpt) Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process.</td>
- </tr>
- <tr>
- <td>admin_user = None</td>
- <td>(StrOpt) Keystone account username</td>
- </tr>
- <tr>
- <td>auth_admin_prefix = </td>
- <td>(StrOpt) Prefix to prepend at the beginning of the path</td>
- </tr>
- <tr>
- <td>auth_host = 127.0.0.1</td>
- <td>(StrOpt) Host providing the admin Identity API endpoint</td>
- </tr>
- <tr>
- <td>auth_port = 35357</td>
- <td>(IntOpt) Port of the admin Identity API endpoint</td>
- </tr>
- <tr>
- <td>auth_protocol = https</td>
- <td>(StrOpt) Protocol of the admin Identity API endpoint(http or https)</td>
- </tr>
- <tr>
- <td>auth_uri = None</td>
- <td>(StrOpt) Complete public Identity API endpoint</td>
- </tr>
- <tr>
- <td>auth_version = None</td>
- <td>(StrOpt) API version of the admin Identity API endpoint</td>
- </tr>
- <tr>
- <td>cache = None</td>
- <td>(StrOpt) Env key for the swift cache</td>
- </tr>
- <tr>
- <td>cafile = None</td>
- <td>(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.</td>
- </tr>
- <tr>
- <td>certfile = None</td>
- <td>(StrOpt) Required if Keystone server requires client certificate</td>
- </tr>
- <tr>
- <td>delay_auth_decision = False</td>
- <td>(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components</td>
- </tr>
- <tr>
- <td>enforce_token_bind = permissive</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>http_connect_timeout = None</td>
- <td>(BoolOpt) Request timeout value for communicating with Identity API server.</td>
- </tr>
- <tr>
- <td>http_request_max_retries = 3</td>
- <td>(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server.</td>
- </tr>
- <tr>
- <td>include_service_catalog = True</td>
- <td>(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.</td>
- </tr>
- <tr>
- <td>insecure = False</td>
- <td>(BoolOpt) Verify HTTPS connections.</td>
- </tr>
- <tr>
- <td>keyfile = None</td>
- <td>(StrOpt) Required if Keystone server requires client certificate</td>
- </tr>
- <tr>
- <td>memcache_secret_key = None</td>
- <td>(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation.</td>
- </tr>
- <tr>
- <td>memcache_security_strategy = None</td>
- <td>(StrOpt) (optional) if defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.</td>
- </tr>
- <tr>
- <td>memcached_servers = None</td>
- <td>(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.</td>
- </tr>
- <tr>
- <td>revocation_cache_time = 300</td>
- <td>(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.</td>
- </tr>
- <tr>
- <td>signing_dir = None</td>
- <td>(StrOpt) Directory used to cache files related to PKI tokens</td>
- </tr>
- <tr>
- <td>token_cache_time = 300</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>
+<?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_heat_auth_token">
+ <caption>Description of configuration options for auth_token</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>memcached_servers = None</td>
+ <td>(ListOpt) Memcached servers or None for in process cache.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[keystone_authtoken]</th>
+ </tr>
+ <tr>
+ <td>admin_password = None</td>
+ <td>(StrOpt) Keystone account password</td>
+ </tr>
+ <tr>
+ <td>admin_tenant_name = admin</td>
+ <td>(StrOpt) Keystone service account tenant name to validate user tokens</td>
+ </tr>
+ <tr>
+ <td>admin_token = None</td>
+ <td>(StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead.</td>
+ </tr>
+ <tr>
+ <td>admin_user = None</td>
+ <td>(StrOpt) Keystone account username</td>
+ </tr>
+ <tr>
+ <td>auth_admin_prefix = </td>
+ <td>(StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri.</td>
+ </tr>
+ <tr>
+ <td>auth_host = 127.0.0.1</td>
+ <td>(StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri.</td>
+ </tr>
+ <tr>
+ <td>auth_port = 35357</td>
+ <td>(IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri.</td>
+ </tr>
+ <tr>
+ <td>auth_protocol = https</td>
+ <td>(StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri.</td>
+ </tr>
+ <tr>
+ <td>auth_uri = None</td>
+ <td>(StrOpt) Complete public Identity API endpoint</td>
+ </tr>
+ <tr>
+ <td>auth_version = None</td>
+ <td>(StrOpt) API version of the admin Identity API endpoint</td>
+ </tr>
+ <tr>
+ <td>cache = None</td>
+ <td>(StrOpt) Env key for the swift cache</td>
+ </tr>
+ <tr>
+ <td>cafile = None</td>
+ <td>(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.</td>
+ </tr>
+ <tr>
+ <td>certfile = None</td>
+ <td>(StrOpt) Required if Keystone server requires client certificate</td>
+ </tr>
+ <tr>
+ <td>check_revocations_for_cached = False</td>
+ <td>(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the Keystone server.</td>
+ </tr>
+ <tr>
+ <td>delay_auth_decision = False</td>
+ <td>(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components</td>
+ </tr>
+ <tr>
+ <td>enforce_token_bind = permissive</td>
+ <td>(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens.</td>
+ </tr>
+ <tr>
+ <td>hash_algorithms = md5</td>
+ <td>(ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance.</td>
+ </tr>
+ <tr>
+ <td>http_connect_timeout = None</td>
+ <td>(BoolOpt) Request timeout value for communicating with Identity API server.</td>
+ </tr>
+ <tr>
+ <td>http_request_max_retries = 3</td>
+ <td>(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server.</td>
+ </tr>
+ <tr>
+ <td>identity_uri = None</td>
+ <td>(StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/</td>
+ </tr>
+ <tr>
+ <td>include_service_catalog = True</td>
+ <td>(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.</td>
+ </tr>
+ <tr>
+ <td>insecure = False</td>
+ <td>(BoolOpt) Verify HTTPS connections.</td>
+ </tr>
+ <tr>
+ <td>keyfile = None</td>
+ <td>(StrOpt) Required if Keystone server requires client certificate</td>
+ </tr>
+ <tr>
+ <td>memcache_secret_key = None</td>
+ <td>(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation.</td>
+ </tr>
+ <tr>
+ <td>memcache_security_strategy = None</td>
+ <td>(StrOpt) (optional) if defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.</td>
+ </tr>
+ <tr>
+ <td>memcached_servers = None</td>
+ <td>(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.</td>
+ </tr>
+ <tr>
+ <td>revocation_cache_time = 10</td>
+ <td>(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.</td>
+ </tr>
+ <tr>
+ <td>signing_dir = None</td>
+ <td>(StrOpt) Directory used to cache files related to PKI tokens</td>
+ </tr>
+ <tr>
+ <td>token_cache_time = 300</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>
diff --git a/doc/common/tables/heat-cfn_api.xml b/doc/common/tables/heat-cfn_api.xml
index 34ac0af8f7..d0669ef3df 100644
--- a/doc/common/tables/heat-cfn_api.xml
+++ b/doc/common/tables/heat-cfn_api.xml
@@ -1,77 +1,76 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_heat_cfn_api">
- <caption>Description of configuration options for cfn_api</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>instance_connection_https_validate_certificates = 1</td>
- <td>(StrOpt) Instance connection to CFN/CW API validate certs if SSL is used.</td>
- </tr>
- <tr>
- <td>instance_connection_is_secure = 0</td>
- <td>(StrOpt) Instance connection to CFN/CW API via https.</td>
- </tr>
- <tr>
- <th colspan="2">[heat_api_cfn]</th>
- </tr>
- <tr>
- <td>backlog = 4096</td>
- <td>(IntOpt) Number of backlog requests to configure the socket with.</td>
- </tr>
- <tr>
- <td>bind_host = 0.0.0.0</td>
- <td>(StrOpt) Address to bind the server. Useful when selecting a particular network interface.</td>
- </tr>
- <tr>
- <td>bind_port = 8000</td>
- <td>(IntOpt) The port on which the server will listen.</td>
- </tr>
- <tr>
- <td>cert_file = None</td>
- <td>(StrOpt) Location of the SSL certificate file to use for SSL mode.</td>
- </tr>
- <tr>
- <td>key_file = None</td>
- <td>(StrOpt) Location of the SSL key file to use for enabling SSL mode.</td>
- </tr>
- <tr>
- <td>max_header_line = 16384</td>
- <td>(IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs).</td>
- </tr>
- <tr>
- <td>workers = 0</td>
- <td>(IntOpt) Number of workers for Heat service.</td>
- </tr>
- <tr>
- <th colspan="2">[ssl]</th>
- </tr>
- <tr>
- <td>ca_file = None</td>
- <td>(StrOpt) CA certificate file to use to verify connecting clients</td>
- </tr>
- <tr>
- <td>cert_file = None</td>
- <td>(StrOpt) Certificate file to use when starting the server securely</td>
- </tr>
- <tr>
- <td>key_file = None</td>
- <td>(StrOpt) Private key file to use when starting the server securely</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_heat_cfn_api">
+ <caption>Description of configuration options for cfn_api</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>instance_connection_https_validate_certificates = 1</td>
+ <td>(StrOpt) Instance connection to CFN/CW API validate certs if SSL is used.</td>
+ </tr>
+ <tr>
+ <td>instance_connection_is_secure = 0</td>
+ <td>(StrOpt) Instance connection to CFN/CW API via https.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[heat_api_cfn]</th>
+ </tr>
+ <tr>
+ <td>backlog = 4096</td>
+ <td>(IntOpt) Number of backlog requests to configure the socket with.</td>
+ </tr>
+ <tr>
+ <td>bind_host = 0.0.0.0</td>
+ <td>(StrOpt) Address to bind the server. Useful when selecting a particular network interface.</td>
+ </tr>
+ <tr>
+ <td>bind_port = 8000</td>
+ <td>(IntOpt) The port on which the server will listen.</td>
+ </tr>
+ <tr>
+ <td>cert_file = None</td>
+ <td>(StrOpt) Location of the SSL certificate file to use for SSL mode.</td>
+ </tr>
+ <tr>
+ <td>key_file = None</td>
+ <td>(StrOpt) Location of the SSL key file to use for enabling SSL mode.</td>
+ </tr>
+ <tr>
+ <td>max_header_line = 16384</td>
+ <td>(IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs).</td>
+ </tr>
+ <tr>
+ <td>workers = 0</td>
+ <td>(IntOpt) Number of workers for Heat service.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[ssl]</th>
+ </tr>
+ <tr>
+ <td>ca_file = None</td>
+ <td>(StrOpt) CA certificate file to use to verify connecting clients.</td>
+ </tr>
+ <tr>
+ <td>cert_file = None</td>
+ <td>(StrOpt) Certificate file to use when starting the server securely.</td>
+ </tr>
+ <tr>
+ <td>key_file = None</td>
+ <td>(StrOpt) Private key file to use when starting the server securely.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/heat-clients.xml b/doc/common/tables/heat-clients.xml
index 3efd53da59..0a9301f44c 100644
--- a/doc/common/tables/heat-clients.xml
+++ b/doc/common/tables/heat-clients.xml
@@ -1,50 +1,49 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_heat_clients">
- <caption>Description of configuration options for clients</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>region_name_for_services = None</td>
- <td>(StrOpt) Default region name used to get services endpoints.</td>
- </tr>
- <tr>
- <th colspan="2">[clients]</th>
- </tr>
- <tr>
- <td>ca_file = None</td>
- <td>(StrOpt) Optional CA cert file to use in SSL connections.</td>
- </tr>
- <tr>
- <td>cert_file = None</td>
- <td>(StrOpt) Optional PEM-formatted certificate chain file.</td>
- </tr>
- <tr>
- <td>endpoint_type = publicURL</td>
- <td>(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.</td>
- </tr>
- <tr>
- <td>insecure = False</td>
- <td>(BoolOpt) If set, then the server's certificate will not be verified.</td>
- </tr>
- <tr>
- <td>key_file = None</td>
- <td>(StrOpt) Optional PEM-formatted file that contains the private key.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_heat_clients">
+ <caption>Description of configuration options for clients</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>region_name_for_services = None</td>
+ <td>(StrOpt) Default region name used to get services endpoints.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[clients]</th>
+ </tr>
+ <tr>
+ <td>ca_file = None</td>
+ <td>(StrOpt) Optional CA cert file to use in SSL connections.</td>
+ </tr>
+ <tr>
+ <td>cert_file = None</td>
+ <td>(StrOpt) Optional PEM-formatted certificate chain file.</td>
+ </tr>
+ <tr>
+ <td>endpoint_type = publicURL</td>
+ <td>(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.</td>
+ </tr>
+ <tr>
+ <td>insecure = False</td>
+ <td>(BoolOpt) If set, then the server's certificate will not be verified.</td>
+ </tr>
+ <tr>
+ <td>key_file = None</td>
+ <td>(StrOpt) Optional PEM-formatted file that contains the private key.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/heat-clients_backends.xml b/doc/common/tables/heat-clients_backends.xml
index d9992a34b3..dd4ff09817 100644
--- a/doc/common/tables/heat-clients_backends.xml
+++ b/doc/common/tables/heat-clients_backends.xml
@@ -1,27 +1,26 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_heat_clients_backends">
- <caption>Description of configuration options for clients_backends</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>cloud_backend = heat.engine.clients.OpenStackClients</td>
- <td>(StrOpt) Fully qualified class name to use as a client backend.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_heat_clients_backends">
+ <caption>Description of configuration options for clients_backends</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>cloud_backend = heat.engine.clients.OpenStackClients</td>
+ <td>(StrOpt) Fully qualified class name to use as a client backend.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/heat-clients_ceilometer.xml b/doc/common/tables/heat-clients_ceilometer.xml
index 6c1242f72c..cf697cbbb0 100644
--- a/doc/common/tables/heat-clients_ceilometer.xml
+++ b/doc/common/tables/heat-clients_ceilometer.xml
@@ -1,43 +1,42 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_heat_clients_ceilometer">
- <caption>Description of configuration options for clients_ceilometer</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">[clients_ceilometer]</th>
- </tr>
- <tr>
- <td>ca_file = None</td>
- <td>(StrOpt) Optional CA cert file to use in SSL connections.</td>
- </tr>
- <tr>
- <td>cert_file = None</td>
- <td>(StrOpt) Optional PEM-formatted certificate chain file.</td>
- </tr>
- <tr>
- <td>endpoint_type = publicURL</td>
- <td>(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.</td>
- </tr>
- <tr>
- <td>insecure = False</td>
- <td>(BoolOpt) If set, then the server's certificate will not be verified.</td>
- </tr>
- <tr>
- <td>key_file = None</td>
- <td>(StrOpt) Optional PEM-formatted file that contains the private key.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_heat_clients_ceilometer">
+ <caption>Description of configuration options for clients_ceilometer</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">[clients_ceilometer]</th>
+ </tr>
+ <tr>
+ <td>ca_file = None</td>
+ <td>(StrOpt) Optional CA cert file to use in SSL connections.</td>
+ </tr>
+ <tr>
+ <td>cert_file = None</td>
+ <td>(StrOpt) Optional PEM-formatted certificate chain file.</td>
+ </tr>
+ <tr>
+ <td>endpoint_type = publicURL</td>
+ <td>(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.</td>
+ </tr>
+ <tr>
+ <td>insecure = False</td>
+ <td>(BoolOpt) If set, then the server's certificate will not be verified.</td>
+ </tr>
+ <tr>
+ <td>key_file = None</td>
+ <td>(StrOpt) Optional PEM-formatted file that contains the private key.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/heat-clients_cinder.xml b/doc/common/tables/heat-clients_cinder.xml
index 0cea397303..6b4e4f73dd 100644
--- a/doc/common/tables/heat-clients_cinder.xml
+++ b/doc/common/tables/heat-clients_cinder.xml
@@ -1,43 +1,42 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_heat_clients_cinder">
- <caption>Description of configuration options for clients_cinder</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">[clients_cinder]</th>
- </tr>
- <tr>
- <td>ca_file = None</td>
- <td>(StrOpt) Optional CA cert file to use in SSL connections.</td>
- </tr>
- <tr>
- <td>cert_file = None</td>
- <td>(StrOpt) Optional PEM-formatted certificate chain file.</td>
- </tr>
- <tr>
- <td>endpoint_type = publicURL</td>
- <td>(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.</td>
- </tr>
- <tr>
- <td>insecure = False</td>
- <td>(BoolOpt) If set, then the server's certificate will not be verified.</td>
- </tr>
- <tr>
- <td>key_file = None</td>
- <td>(StrOpt) Optional PEM-formatted file that contains the private key.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_heat_clients_cinder">
+ <caption>Description of configuration options for clients_cinder</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">[clients_cinder]</th>
+ </tr>
+ <tr>
+ <td>ca_file = None</td>
+ <td>(StrOpt) Optional CA cert file to use in SSL connections.</td>
+ </tr>
+ <tr>
+ <td>cert_file = None</td>
+ <td>(StrOpt) Optional PEM-formatted certificate chain file.</td>
+ </tr>
+ <tr>
+ <td>endpoint_type = publicURL</td>
+ <td>(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.</td>
+ </tr>
+ <tr>
+ <td>insecure = False</td>
+ <td>(BoolOpt) If set, then the server's certificate will not be verified.</td>
+ </tr>
+ <tr>
+ <td>key_file = None</td>
+ <td>(StrOpt) Optional PEM-formatted file that contains the private key.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/heat-clients_glance.xml b/doc/common/tables/heat-clients_glance.xml
new file mode 100644
index 0000000000..d3268f32f2
--- /dev/null
+++ b/doc/common/tables/heat-clients_glance.xml
@@ -0,0 +1,42 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_heat_clients_glance">
+ <caption>Description of configuration options for clients_glance</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">[clients_glance]</th>
+ </tr>
+ <tr>
+ <td>ca_file = None</td>
+ <td>(StrOpt) Optional CA cert file to use in SSL connections.</td>
+ </tr>
+ <tr>
+ <td>cert_file = None</td>
+ <td>(StrOpt) Optional PEM-formatted certificate chain file.</td>
+ </tr>
+ <tr>
+ <td>endpoint_type = publicURL</td>
+ <td>(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.</td>
+ </tr>
+ <tr>
+ <td>insecure = False</td>
+ <td>(BoolOpt) If set, then the server's certificate will not be verified.</td>
+ </tr>
+ <tr>
+ <td>key_file = None</td>
+ <td>(StrOpt) Optional PEM-formatted file that contains the private key.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/heat-clients_heat.xml b/doc/common/tables/heat-clients_heat.xml
index ef347efe9c..0acee5acd7 100644
--- a/doc/common/tables/heat-clients_heat.xml
+++ b/doc/common/tables/heat-clients_heat.xml
@@ -1,47 +1,46 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_heat_clients_heat">
- <caption>Description of configuration options for clients_heat</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[clients_heat]</th>
- </tr>
- <tr>
- <td>ca_file = None</td>
- <td>(StrOpt) Optional CA cert file to use in SSL connections.</td>
- </tr>
- <tr>
- <td>cert_file = None</td>
- <td>(StrOpt) Optional PEM-formatted certificate chain file.</td>
- </tr>
- <tr>
- <td>endpoint_type = publicURL</td>
- <td>(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.</td>
- </tr>
- <tr>
- <td>insecure = False</td>
- <td>(BoolOpt) If set, then the server's certificate will not be verified.</td>
- </tr>
- <tr>
- <td>key_file = None</td>
- <td>(StrOpt) Optional PEM-formatted file that contains the private key.</td>
- </tr>
- <tr>
- <td>url = None</td>
- <td>(StrOpt) Optional heat url in format like http://0.0.0.0:8004/v1/%(tenant_id)s.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_heat_clients_heat">
+ <caption>Description of configuration options for clients_heat</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[clients_heat]</th>
+ </tr>
+ <tr>
+ <td>ca_file = None</td>
+ <td>(StrOpt) Optional CA cert file to use in SSL connections.</td>
+ </tr>
+ <tr>
+ <td>cert_file = None</td>
+ <td>(StrOpt) Optional PEM-formatted certificate chain file.</td>
+ </tr>
+ <tr>
+ <td>endpoint_type = publicURL</td>
+ <td>(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.</td>
+ </tr>
+ <tr>
+ <td>insecure = False</td>
+ <td>(BoolOpt) If set, then the server's certificate will not be verified.</td>
+ </tr>
+ <tr>
+ <td>key_file = None</td>
+ <td>(StrOpt) Optional PEM-formatted file that contains the private key.</td>
+ </tr>
+ <tr>
+ <td>url = None</td>
+ <td>(StrOpt) Optional heat url in format like http://0.0.0.0:8004/v1/%(tenant_id)s.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/heat-clients_keystone.xml b/doc/common/tables/heat-clients_keystone.xml
index 84d9d186d8..9566c5a2d2 100644
--- a/doc/common/tables/heat-clients_keystone.xml
+++ b/doc/common/tables/heat-clients_keystone.xml
@@ -1,43 +1,42 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_heat_clients_keystone">
- <caption>Description of configuration options for clients_keystone</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">[clients_keystone]</th>
- </tr>
- <tr>
- <td>ca_file = None</td>
- <td>(StrOpt) Optional CA cert file to use in SSL connections.</td>
- </tr>
- <tr>
- <td>cert_file = None</td>
- <td>(StrOpt) Optional PEM-formatted certificate chain file.</td>
- </tr>
- <tr>
- <td>endpoint_type = publicURL</td>
- <td>(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.</td>
- </tr>
- <tr>
- <td>insecure = False</td>
- <td>(BoolOpt) If set, then the server's certificate will not be verified.</td>
- </tr>
- <tr>
- <td>key_file = None</td>
- <td>(StrOpt) Optional PEM-formatted file that contains the private key.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_heat_clients_keystone">
+ <caption>Description of configuration options for clients_keystone</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">[clients_keystone]</th>
+ </tr>
+ <tr>
+ <td>ca_file = None</td>
+ <td>(StrOpt) Optional CA cert file to use in SSL connections.</td>
+ </tr>
+ <tr>
+ <td>cert_file = None</td>
+ <td>(StrOpt) Optional PEM-formatted certificate chain file.</td>
+ </tr>
+ <tr>
+ <td>endpoint_type = publicURL</td>
+ <td>(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.</td>
+ </tr>
+ <tr>
+ <td>insecure = False</td>
+ <td>(BoolOpt) If set, then the server's certificate will not be verified.</td>
+ </tr>
+ <tr>
+ <td>key_file = None</td>
+ <td>(StrOpt) Optional PEM-formatted file that contains the private key.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/heat-clients_neutron.xml b/doc/common/tables/heat-clients_neutron.xml
index fb4e49260a..719ac21fa2 100644
--- a/doc/common/tables/heat-clients_neutron.xml
+++ b/doc/common/tables/heat-clients_neutron.xml
@@ -1,43 +1,42 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_heat_clients_neutron">
- <caption>Description of configuration options for clients_neutron</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">[clients_neutron]</th>
- </tr>
- <tr>
- <td>ca_file = None</td>
- <td>(StrOpt) Optional CA cert file to use in SSL connections.</td>
- </tr>
- <tr>
- <td>cert_file = None</td>
- <td>(StrOpt) Optional PEM-formatted certificate chain file.</td>
- </tr>
- <tr>
- <td>endpoint_type = publicURL</td>
- <td>(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.</td>
- </tr>
- <tr>
- <td>insecure = False</td>
- <td>(BoolOpt) If set, then the server's certificate will not be verified.</td>
- </tr>
- <tr>
- <td>key_file = None</td>
- <td>(StrOpt) Optional PEM-formatted file that contains the private key.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_heat_clients_neutron">
+ <caption>Description of configuration options for clients_neutron</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">[clients_neutron]</th>
+ </tr>
+ <tr>
+ <td>ca_file = None</td>
+ <td>(StrOpt) Optional CA cert file to use in SSL connections.</td>
+ </tr>
+ <tr>
+ <td>cert_file = None</td>
+ <td>(StrOpt) Optional PEM-formatted certificate chain file.</td>
+ </tr>
+ <tr>
+ <td>endpoint_type = publicURL</td>
+ <td>(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.</td>
+ </tr>
+ <tr>
+ <td>insecure = False</td>
+ <td>(BoolOpt) If set, then the server's certificate will not be verified.</td>
+ </tr>
+ <tr>
+ <td>key_file = None</td>
+ <td>(StrOpt) Optional PEM-formatted file that contains the private key.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/heat-clients_nova.xml b/doc/common/tables/heat-clients_nova.xml
index cde1012c1d..ed286d9a58 100644
--- a/doc/common/tables/heat-clients_nova.xml
+++ b/doc/common/tables/heat-clients_nova.xml
@@ -1,43 +1,46 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_heat_clients_nova">
- <caption>Description of configuration options for clients_nova</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[clients_nova]</th>
- </tr>
- <tr>
- <td>ca_file = None</td>
- <td>(StrOpt) Optional CA cert file to use in SSL connections.</td>
- </tr>
- <tr>
- <td>cert_file = None</td>
- <td>(StrOpt) Optional PEM-formatted certificate chain file.</td>
- </tr>
- <tr>
- <td>endpoint_type = publicURL</td>
- <td>(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.</td>
- </tr>
- <tr>
- <td>insecure = False</td>
- <td>(BoolOpt) If set, then the server's certificate will not be verified.</td>
- </tr>
- <tr>
- <td>key_file = None</td>
- <td>(StrOpt) Optional PEM-formatted file that contains the private key.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_heat_clients_nova">
+ <caption>Description of configuration options for clients_nova</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[clients_nova]</th>
+ </tr>
+ <tr>
+ <td>ca_file = None</td>
+ <td>(StrOpt) Optional CA cert file to use in SSL connections.</td>
+ </tr>
+ <tr>
+ <td>cert_file = None</td>
+ <td>(StrOpt) Optional PEM-formatted certificate chain file.</td>
+ </tr>
+ <tr>
+ <td>endpoint_type = publicURL</td>
+ <td>(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.</td>
+ </tr>
+ <tr>
+ <td>http_log_debug = False</td>
+ <td>(BoolOpt) Allow client's debug log output.</td>
+ </tr>
+ <tr>
+ <td>insecure = False</td>
+ <td>(BoolOpt) If set, then the server's certificate will not be verified.</td>
+ </tr>
+ <tr>
+ <td>key_file = None</td>
+ <td>(StrOpt) Optional PEM-formatted file that contains the private key.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/heat-clients_swift.xml b/doc/common/tables/heat-clients_swift.xml
index f597586310..574f280df1 100644
--- a/doc/common/tables/heat-clients_swift.xml
+++ b/doc/common/tables/heat-clients_swift.xml
@@ -1,43 +1,42 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_heat_clients_swift">
- <caption>Description of configuration options for clients_swift</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[clients_swift]</th>
- </tr>
- <tr>
- <td>ca_file = None</td>
- <td>(StrOpt) Optional CA cert file to use in SSL connections.</td>
- </tr>
- <tr>
- <td>cert_file = None</td>
- <td>(StrOpt) Optional PEM-formatted certificate chain file.</td>
- </tr>
- <tr>
- <td>endpoint_type = publicURL</td>
- <td>(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.</td>
- </tr>
- <tr>
- <td>insecure = False</td>
- <td>(BoolOpt) If set, then the server's certificate will not be verified.</td>
- </tr>
- <tr>
- <td>key_file = None</td>
- <td>(StrOpt) Optional PEM-formatted file that contains the private key.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_heat_clients_swift">
+ <caption>Description of configuration options for clients_swift</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[clients_swift]</th>
+ </tr>
+ <tr>
+ <td>ca_file = None</td>
+ <td>(StrOpt) Optional CA cert file to use in SSL connections.</td>
+ </tr>
+ <tr>
+ <td>cert_file = None</td>
+ <td>(StrOpt) Optional PEM-formatted certificate chain file.</td>
+ </tr>
+ <tr>
+ <td>endpoint_type = publicURL</td>
+ <td>(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.</td>
+ </tr>
+ <tr>
+ <td>insecure = False</td>
+ <td>(BoolOpt) If set, then the server's certificate will not be verified.</td>
+ </tr>
+ <tr>
+ <td>key_file = None</td>
+ <td>(StrOpt) Optional PEM-formatted file that contains the private key.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/heat-clients_trove.xml b/doc/common/tables/heat-clients_trove.xml
index 2008c11a17..1fdb79e952 100644
--- a/doc/common/tables/heat-clients_trove.xml
+++ b/doc/common/tables/heat-clients_trove.xml
@@ -1,43 +1,42 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_heat_clients_trove">
- <caption>Description of configuration options for clients_trove</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">[clients_trove]</th>
- </tr>
- <tr>
- <td>ca_file = None</td>
- <td>(StrOpt) Optional CA cert file to use in SSL connections.</td>
- </tr>
- <tr>
- <td>cert_file = None</td>
- <td>(StrOpt) Optional PEM-formatted certificate chain file.</td>
- </tr>
- <tr>
- <td>endpoint_type = publicURL</td>
- <td>(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.</td>
- </tr>
- <tr>
- <td>insecure = False</td>
- <td>(BoolOpt) If set, then the server's certificate will not be verified.</td>
- </tr>
- <tr>
- <td>key_file = None</td>
- <td>(StrOpt) Optional PEM-formatted file that contains the private key.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_heat_clients_trove">
+ <caption>Description of configuration options for clients_trove</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">[clients_trove]</th>
+ </tr>
+ <tr>
+ <td>ca_file = None</td>
+ <td>(StrOpt) Optional CA cert file to use in SSL connections.</td>
+ </tr>
+ <tr>
+ <td>cert_file = None</td>
+ <td>(StrOpt) Optional PEM-formatted certificate chain file.</td>
+ </tr>
+ <tr>
+ <td>endpoint_type = publicURL</td>
+ <td>(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.</td>
+ </tr>
+ <tr>
+ <td>insecure = False</td>
+ <td>(BoolOpt) If set, then the server's certificate will not be verified.</td>
+ </tr>
+ <tr>
+ <td>key_file = None</td>
+ <td>(StrOpt) Optional PEM-formatted file that contains the private key.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/heat-cloudwatch_api.xml b/doc/common/tables/heat-cloudwatch_api.xml
index 9f6dfddc11..afb9c58fcd 100644
--- a/doc/common/tables/heat-cloudwatch_api.xml
+++ b/doc/common/tables/heat-cloudwatch_api.xml
@@ -1,73 +1,72 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_heat_cloudwatch_api">
- <caption>Description of configuration options for cloudwatch_api</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>heat_watch_server_url = </td>
- <td>(StrOpt) URL of the Heat CloudWatch server.</td>
- </tr>
- <tr>
- <th colspan="2">[heat_api_cloudwatch]</th>
- </tr>
- <tr>
- <td>backlog = 4096</td>
- <td>(IntOpt) Number of backlog requests to configure the socket with.</td>
- </tr>
- <tr>
- <td>bind_host = 0.0.0.0</td>
- <td>(StrOpt) Address to bind the server. Useful when selecting a particular network interface.</td>
- </tr>
- <tr>
- <td>bind_port = 8003</td>
- <td>(IntOpt) The port on which the server will listen.</td>
- </tr>
- <tr>
- <td>cert_file = None</td>
- <td>(StrOpt) Location of the SSL certificate file to use for SSL mode.</td>
- </tr>
- <tr>
- <td>key_file = None</td>
- <td>(StrOpt) Location of the SSL key file to use for enabling SSL mode.</td>
- </tr>
- <tr>
- <td>max_header_line = 16384</td>
- <td>(IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs.)</td>
- </tr>
- <tr>
- <td>workers = 0</td>
- <td>(IntOpt) Number of workers for Heat service.</td>
- </tr>
- <tr>
- <th colspan="2">[ssl]</th>
- </tr>
- <tr>
- <td>ca_file = None</td>
- <td>(StrOpt) CA certificate file to use to verify connecting clients</td>
- </tr>
- <tr>
- <td>cert_file = None</td>
- <td>(StrOpt) Certificate file to use when starting the server securely</td>
- </tr>
- <tr>
- <td>key_file = None</td>
- <td>(StrOpt) Private key file to use when starting the server securely</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_heat_cloudwatch_api">
+ <caption>Description of configuration options for cloudwatch_api</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>heat_watch_server_url = </td>
+ <td>(StrOpt) URL of the Heat CloudWatch server.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[heat_api_cloudwatch]</th>
+ </tr>
+ <tr>
+ <td>backlog = 4096</td>
+ <td>(IntOpt) Number of backlog requests to configure the socket with.</td>
+ </tr>
+ <tr>
+ <td>bind_host = 0.0.0.0</td>
+ <td>(StrOpt) Address to bind the server. Useful when selecting a particular network interface.</td>
+ </tr>
+ <tr>
+ <td>bind_port = 8003</td>
+ <td>(IntOpt) The port on which the server will listen.</td>
+ </tr>
+ <tr>
+ <td>cert_file = None</td>
+ <td>(StrOpt) Location of the SSL certificate file to use for SSL mode.</td>
+ </tr>
+ <tr>
+ <td>key_file = None</td>
+ <td>(StrOpt) Location of the SSL key file to use for enabling SSL mode.</td>
+ </tr>
+ <tr>
+ <td>max_header_line = 16384</td>
+ <td>(IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs.)</td>
+ </tr>
+ <tr>
+ <td>workers = 0</td>
+ <td>(IntOpt) Number of workers for Heat service.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[ssl]</th>
+ </tr>
+ <tr>
+ <td>ca_file = None</td>
+ <td>(StrOpt) CA certificate file to use to verify connecting clients.</td>
+ </tr>
+ <tr>
+ <td>cert_file = None</td>
+ <td>(StrOpt) Certificate file to use when starting the server securely.</td>
+ </tr>
+ <tr>
+ <td>key_file = None</td>
+ <td>(StrOpt) Private key file to use when starting the server securely.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/heat-common.xml b/doc/common/tables/heat-common.xml
index 8c140dea2e..6a50691fa3 100644
--- a/doc/common/tables/heat-common.xml
+++ b/doc/common/tables/heat-common.xml
@@ -1,62 +1,61 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_heat_common">
- <caption>Description of configuration options for common</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>deferred_auth_method = password</td>
- <td>(StrOpt) Select deferred auth method, stored password or trusts.</td>
- </tr>
- <tr>
- <td>environment_dir = /etc/heat/environment.d</td>
- <td>(StrOpt) The directory to search for environment files.</td>
- </tr>
- <tr>
- <td>event_purge_batch_size = 10</td>
- <td>(IntOpt) Controls how many events will be pruned whenever a stack's events exceed max_events_per_stack. Set this lower to keep more events at the expense of more frequent purges.</td>
- </tr>
- <tr>
- <td>instance_driver = heat.engine.nova</td>
- <td>(StrOpt) Driver to use for controlling instances.</td>
- </tr>
- <tr>
- <td>instance_user = ec2-user</td>
- <td>(StrOpt) The default user for new instances. This option is deprecated and will be removed in the Juno release. If it's empty, Heat will use the default user set up with your cloud image (for OS::Nova::Server) or 'ec2-user' (for AWS::EC2::Instance).</td>
- </tr>
- <tr>
- <td>keystone_backend = heat.common.heat_keystoneclient.KeystoneClientV3</td>
- <td>(StrOpt) Fully qualified class name to use as a keystone backend.</td>
- </tr>
- <tr>
- <td>periodic_interval = 60</td>
- <td>(IntOpt) Seconds between running periodic tasks.</td>
- </tr>
- <tr>
- <td>plugin_dirs = /usr/lib64/heat, /usr/lib/heat</td>
- <td>(ListOpt) List of directories to search for plug-ins.</td>
- </tr>
- <tr>
- <th colspan="2">[revision]</th>
- </tr>
- <tr>
- <td>heat_revision = unknown</td>
- <td>(StrOpt) Heat build revision. If you would prefer to manage your build revision separately, you can move this section to a different file and add it as another config option.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_heat_common">
+ <caption>Description of configuration options for common</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>deferred_auth_method = password</td>
+ <td>(StrOpt) Select deferred auth method, stored password or trusts.</td>
+ </tr>
+ <tr>
+ <td>environment_dir = /etc/heat/environment.d</td>
+ <td>(StrOpt) The directory to search for environment files.</td>
+ </tr>
+ <tr>
+ <td>event_purge_batch_size = 10</td>
+ <td>(IntOpt) Controls how many events will be pruned whenever a stack's events exceed max_events_per_stack. Set this lower to keep more events at the expense of more frequent purges.</td>
+ </tr>
+ <tr>
+ <td>instance_driver = heat.engine.nova</td>
+ <td>(StrOpt) Driver to use for controlling instances.</td>
+ </tr>
+ <tr>
+ <td>instance_user = ec2-user</td>
+ <td>(StrOpt) The default user for new instances. This option is deprecated and will be removed in the Juno release. If it's empty, Heat will use the default user set up with your cloud image (for OS::Nova::Server) or 'ec2-user' (for AWS::EC2::Instance).</td>
+ </tr>
+ <tr>
+ <td>keystone_backend = heat.common.heat_keystoneclient.KeystoneClientV3</td>
+ <td>(StrOpt) Fully qualified class name to use as a keystone backend.</td>
+ </tr>
+ <tr>
+ <td>periodic_interval = 60</td>
+ <td>(IntOpt) Seconds between running periodic tasks.</td>
+ </tr>
+ <tr>
+ <td>plugin_dirs = /usr/lib64/heat, /usr/lib/heat</td>
+ <td>(ListOpt) List of directories to search for plug-ins.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[revision]</th>
+ </tr>
+ <tr>
+ <td>heat_revision = unknown</td>
+ <td>(StrOpt) Heat build revision. If you would prefer to manage your build revision separately, you can move this section to a different file and add it as another config option.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/heat-crypt.xml b/doc/common/tables/heat-crypt.xml
index dcdd87c22e..fec0ad44ec 100644
--- a/doc/common/tables/heat-crypt.xml
+++ b/doc/common/tables/heat-crypt.xml
@@ -1,27 +1,26 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_heat_crypt">
- <caption>Description of configuration options for crypt</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>auth_encryption_key = notgood but just long enough i think</td>
- <td>(StrOpt) Encryption key used for authentication info in database.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_heat_crypt">
+ <caption>Description of configuration options for crypt</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>auth_encryption_key = notgood but just long enough i think</td>
+ <td>(StrOpt) Encryption key used for authentication info in database.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/heat-database.xml b/doc/common/tables/heat-database.xml
index a5b47c434b..154da836a3 100644
--- a/doc/common/tables/heat-database.xml
+++ b/doc/common/tables/heat-database.xml
@@ -1,86 +1,98 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_heat_database">
- <caption>Description of configuration options for database</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>db_backend = sqlalchemy</td>
- <td>(StrOpt) The backend to use for db.</td>
- </tr>
- <tr>
- <td>sqlite_db = heat.sqlite</td>
- <td>(StrOpt) the filename to use with sqlite</td>
- </tr>
- <tr>
- <td>sqlite_synchronous = True</td>
- <td>(BoolOpt) If true, use synchronous mode for sqlite</td>
- </tr>
- <tr>
- <th colspan="2">[database]</th>
- </tr>
- <tr>
- <td>backend = sqlalchemy</td>
- <td>(StrOpt) The backend to use for db</td>
- </tr>
- <tr>
- <td>connection = sqlite:////usr/lib/python/site-packages/heat/openstack/common/db/$sqlite_db</td>
- <td>(StrOpt) The SQLAlchemy connection string used to connect to the database</td>
- </tr>
- <tr>
- <td>connection_debug = 0</td>
- <td>(IntOpt) Verbosity of SQL debugging information. 0=None, 100=Everything</td>
- </tr>
- <tr>
- <td>connection_trace = False</td>
- <td>(BoolOpt) Add python stack traces to SQL as comment strings</td>
- </tr>
- <tr>
- <td>idle_timeout = 3600</td>
- <td>(IntOpt) timeout before idle sql connections are reaped</td>
- </tr>
- <tr>
- <td>max_overflow = None</td>
- <td>(IntOpt) If set, use this value for max_overflow with sqlalchemy</td>
- </tr>
- <tr>
- <td>max_pool_size = None</td>
- <td>(IntOpt) Maximum number of SQL connections to keep open in a pool</td>
- </tr>
- <tr>
- <td>max_retries = 10</td>
- <td>(IntOpt) maximum db connection retries during startup. (setting -1 implies an infinite retry count)</td>
- </tr>
- <tr>
- <td>min_pool_size = 1</td>
- <td>(IntOpt) Minimum number of SQL connections to keep open in a pool</td>
- </tr>
- <tr>
- <td>pool_timeout = None</td>
- <td>(IntOpt) If set, use this value for pool_timeout with sqlalchemy</td>
- </tr>
- <tr>
- <td>retry_interval = 10</td>
- <td>(IntOpt) interval between retries of opening a sql connection</td>
- </tr>
- <tr>
- <td>slave_connection = </td>
- <td>(StrOpt) The SQLAlchemy connection string used to connect to the slave database</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_heat_database">
+ <caption>Description of configuration options for database</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[database]</th>
+ </tr>
+ <tr>
+ <td>backend = sqlalchemy</td>
+ <td>(StrOpt) The backend to use for db</td>
+ </tr>
+ <tr>
+ <td>connection = None</td>
+ <td>(StrOpt) The SQLAlchemy connection string used to connect to the database</td>
+ </tr>
+ <tr>
+ <td>connection_debug = 0</td>
+ <td>(IntOpt) Verbosity of SQL debugging information. 0=None, 100=Everything</td>
+ </tr>
+ <tr>
+ <td>connection_trace = False</td>
+ <td>(BoolOpt) Add python stack traces to SQL as comment strings</td>
+ </tr>
+ <tr>
+ <td>db_inc_retry_interval = True</td>
+ <td>(BoolOpt) Whether to increase interval between db connection retries, up to db_max_retry_interval</td>
+ </tr>
+ <tr>
+ <td>db_max_retries = 20</td>
+ <td>(IntOpt) maximum db connection retries before error is raised. (setting -1 implies an infinite retry count)</td>
+ </tr>
+ <tr>
+ <td>db_max_retry_interval = 10</td>
+ <td>(IntOpt) max seconds between db connection retries, if db_inc_retry_interval is enabled</td>
+ </tr>
+ <tr>
+ <td>db_retry_interval = 1</td>
+ <td>(IntOpt) seconds between db connection retries</td>
+ </tr>
+ <tr>
+ <td>idle_timeout = 3600</td>
+ <td>(IntOpt) Timeout before idle sql connections are reaped</td>
+ </tr>
+ <tr>
+ <td>max_overflow = None</td>
+ <td>(IntOpt) If set, use this value for max_overflow with sqlalchemy</td>
+ </tr>
+ <tr>
+ <td>max_pool_size = None</td>
+ <td>(IntOpt) Maximum number of SQL connections to keep open in a pool</td>
+ </tr>
+ <tr>
+ <td>max_retries = 10</td>
+ <td>(IntOpt) Maximum db connection retries during startup. (setting -1 implies an infinite retry count)</td>
+ </tr>
+ <tr>
+ <td>min_pool_size = 1</td>
+ <td>(IntOpt) Minimum number of SQL connections to keep open in a pool</td>
+ </tr>
+ <tr>
+ <td>mysql_sql_mode = TRADITIONAL</td>
+ <td>(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=</td>
+ </tr>
+ <tr>
+ <td>pool_timeout = None</td>
+ <td>(IntOpt) If set, use this value for pool_timeout with sqlalchemy</td>
+ </tr>
+ <tr>
+ <td>retry_interval = 10</td>
+ <td>(IntOpt) Interval between retries of opening a sql connection</td>
+ </tr>
+ <tr>
+ <td>sqlite_db = heat.sqlite</td>
+ <td>(StrOpt) The file name to use with SQLite</td>
+ </tr>
+ <tr>
+ <td>sqlite_synchronous = True</td>
+ <td>(BoolOpt) If True, SQLite uses synchronous mode</td>
+ </tr>
+ <tr>
+ <td>use_db_reconnect = False</td>
+ <td>(BoolOpt) Enable the experimental use of database reconnect on connection lost</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/heat-debug.xml b/doc/common/tables/heat-debug.xml
index f92ff231dc..9c253b1d93 100644
--- a/doc/common/tables/heat-debug.xml
+++ b/doc/common/tables/heat-debug.xml
@@ -1,43 +1,42 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_heat_debug">
- <caption>Description of configuration options for debug</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>backdoor_port = None</td>
- <td>(StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.</td>
- </tr>
- <tr>
- <td>debug = False</td>
- <td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).</td>
- </tr>
- <tr>
- <td>disable_process_locking = False</td>
- <td>(BoolOpt) Whether to disable inter-process locks</td>
- </tr>
- <tr>
- <td>fatal_deprecations = False</td>
- <td>(BoolOpt) make deprecations fatal</td>
- </tr>
- <tr>
- <td>lock_path = None</td>
- <td>(StrOpt) Directory to use for lock files.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_heat_debug">
+ <caption>Description of configuration options for debug</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>backdoor_port = None</td>
+ <td>(StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.</td>
+ </tr>
+ <tr>
+ <td>debug = False</td>
+ <td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).</td>
+ </tr>
+ <tr>
+ <td>disable_process_locking = False</td>
+ <td>(BoolOpt) Enables or disables inter-process locks.</td>
+ </tr>
+ <tr>
+ <td>fatal_deprecations = False</td>
+ <td>(BoolOpt) Enables or disables fatal status of deprecations.</td>
+ </tr>
+ <tr>
+ <td>lock_path = None</td>
+ <td>(StrOpt) Directory to use for lock files.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/heat-loadbalancer.xml b/doc/common/tables/heat-loadbalancer.xml
index 9de02b0094..b85512d1bb 100644
--- a/doc/common/tables/heat-loadbalancer.xml
+++ b/doc/common/tables/heat-loadbalancer.xml
@@ -1,27 +1,26 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_heat_loadbalancer">
- <caption>Description of configuration options for loadbalancer</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>loadbalancer_template = None</td>
- <td>(StrOpt) Custom template for the built-in loadbalancer nested stack.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_heat_loadbalancer">
+ <caption>Description of configuration options for loadbalancer</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>loadbalancer_template = None</td>
+ <td>(StrOpt) Custom template for the built-in loadbalancer nested stack.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/heat-logging.xml b/doc/common/tables/heat-logging.xml
index 3d0d377644..fe3e7502a2 100644
--- a/doc/common/tables/heat-logging.xml
+++ b/doc/common/tables/heat-logging.xml
@@ -1,87 +1,90 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_heat_logging">
- <caption>Description of configuration options for logging</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, iso8601=WARN</td>
- <td>(ListOpt) list of logger=LEVEL pairs</td>
- </tr>
- <tr>
- <td>instance_format = "[instance: %(uuid)s] "</td>
- <td>(StrOpt) If an instance is passed with the log message, format it like this</td>
- </tr>
- <tr>
- <td>instance_uuid_format = "[instance: %(uuid)s] "</td>
- <td>(StrOpt) If an instance UUID is passed with the log message, format it like this</td>
- </tr>
- <tr>
- <td>log_config_append = None</td>
- <td>(StrOpt) The name of logging configuration file. It does not disable existing loggers, but just appends specified logging configuration to any other existing logging options. Please see the Python logging module documentation for details on logging configuration files.</td>
- </tr>
- <tr>
- <td>log_date_format = %Y-%m-%d %H:%M:%S</td>
- <td>(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s</td>
- </tr>
- <tr>
- <td>log_dir = None</td>
- <td>(StrOpt) (Optional) The base directory used for relative --log-file paths</td>
- </tr>
- <tr>
- <td>log_file = None</td>
- <td>(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.</td>
- </tr>
- <tr>
- <td>log_format = None</td>
- <td>(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.</td>
- </tr>
- <tr>
- <td>logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s</td>
- <td>(StrOpt) format string to use for log messages with context</td>
- </tr>
- <tr>
- <td>logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d</td>
- <td>(StrOpt) data to append to log format when level is DEBUG</td>
- </tr>
- <tr>
- <td>logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s</td>
- <td>(StrOpt) format string to use for log messages without context</td>
- </tr>
- <tr>
- <td>logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s</td>
- <td>(StrOpt) prefix each line of exception output with this format</td>
- </tr>
- <tr>
- <td>syslog_log_facility = LOG_USER</td>
- <td>(StrOpt) syslog facility to receive log lines</td>
- </tr>
- <tr>
- <td>use_stderr = True</td>
- <td>(BoolOpt) Log output to standard error</td>
- </tr>
- <tr>
- <td>use_syslog = False</td>
- <td>(BoolOpt) Use syslog for logging.</td>
- </tr>
- <tr>
- <td>verbose = False</td>
- <td>(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_heat_logging">
+ <caption>Description of configuration options for logging</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN</td>
+ <td>(ListOpt) List of logger=LEVEL pairs.</td>
+ </tr>
+ <tr>
+ <td>instance_format = "[instance: %(uuid)s] "</td>
+ <td>(StrOpt) The format for an instance that is passed with the log message. </td>
+ </tr>
+ <tr>
+ <td>instance_uuid_format = "[instance: %(uuid)s] "</td>
+ <td>(StrOpt) The format for an instance UUID that is passed with the log message. </td>
+ </tr>
+ <tr>
+ <td>log_config_append = None</td>
+ <td>(StrOpt) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation.</td>
+ </tr>
+ <tr>
+ <td>log_date_format = %Y-%m-%d %H:%M:%S</td>
+ <td>(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s .</td>
+ </tr>
+ <tr>
+ <td>log_dir = None</td>
+ <td>(StrOpt) (Optional) The base directory used for relative --log-file paths.</td>
+ </tr>
+ <tr>
+ <td>log_file = None</td>
+ <td>(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.</td>
+ </tr>
+ <tr>
+ <td>log_format = None</td>
+ <td>(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.</td>
+ </tr>
+ <tr>
+ <td>logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s</td>
+ <td>(StrOpt) Format string to use for log messages with context.</td>
+ </tr>
+ <tr>
+ <td>logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d</td>
+ <td>(StrOpt) Data to append to log format when level is DEBUG.</td>
+ </tr>
+ <tr>
+ <td>logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s</td>
+ <td>(StrOpt) Format string to use for log messages without context.</td>
+ </tr>
+ <tr>
+ <td>logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s</td>
+ <td>(StrOpt) Prefix each line of exception output with this format.</td>
+ </tr>
+ <tr>
+ <td>syslog_log_facility = LOG_USER</td>
+ <td>(StrOpt) Syslog facility to receive log lines.</td>
+ </tr>
+ <tr>
+ <td>use_stderr = True</td>
+ <td>(BoolOpt) Log output to standard error.</td>
+ </tr>
+ <tr>
+ <td>use_syslog = False</td>
+ <td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424.</td>
+ </tr>
+ <tr>
+ <td>use_syslog_rfc_format = False</td>
+ <td>(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in I, and will be removed in J.</td>
+ </tr>
+ <tr>
+ <td>verbose = False</td>
+ <td>(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/heat-metadata_api.xml b/doc/common/tables/heat-metadata_api.xml
index 9bf75c0d0f..a1e2cccafb 100644
--- a/doc/common/tables/heat-metadata_api.xml
+++ b/doc/common/tables/heat-metadata_api.xml
@@ -1,27 +1,26 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_heat_metadata_api">
- <caption>Description of configuration options for metadata_api</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>heat_metadata_server_url = </td>
- <td>(StrOpt) URL of the Heat metadata server.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_heat_metadata_api">
+ <caption>Description of configuration options for metadata_api</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>heat_metadata_server_url = </td>
+ <td>(StrOpt) URL of the Heat metadata server.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/heat-notification.xml b/doc/common/tables/heat-notification.xml
index 22af226944..da5fd9c5bf 100644
--- a/doc/common/tables/heat-notification.xml
+++ b/doc/common/tables/heat-notification.xml
@@ -1,31 +1,30 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_heat_notification">
- <caption>Description of configuration options for notification</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>onready = None</td>
- <td>(StrOpt) onready allows you to send a notification when the heat processes are ready to serve. This is either a module with the notify() method or a shell command. To enable notifications with systemd, one may use the 'systemd-notify --ready' shell command or the 'heat.common.systemd' notification module.</td>
- </tr>
- <tr>
- <td>publish_errors = False</td>
- <td>(BoolOpt) publish error events</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_heat_notification">
+ <caption>Description of configuration options for notification</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>onready = None</td>
+ <td>(StrOpt) onready allows you to send a notification when the heat processes are ready to serve. This is either a module with the notify() method or a shell command. To enable notifications with systemd, one may use the 'systemd-notify --ready' shell command or the 'heat.common.systemd' notification module.</td>
+ </tr>
+ <tr>
+ <td>publish_errors = False</td>
+ <td>(BoolOpt) Enables or disables publication of error events.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/heat-qpid.xml b/doc/common/tables/heat-qpid.xml
index 7656a6e4f8..ae43c4fa22 100644
--- a/doc/common/tables/heat-qpid.xml
+++ b/doc/common/tables/heat-qpid.xml
@@ -1,63 +1,62 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_heat_qpid">
- <caption>Description of configuration options for qpid</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>qpid_heartbeat = 60</td>
- <td>(IntOpt) Seconds between connection keepalive heartbeats</td>
- </tr>
- <tr>
- <td>qpid_hostname = localhost</td>
- <td>(StrOpt) Qpid broker hostname</td>
- </tr>
- <tr>
- <td>qpid_hosts = $qpid_hostname:$qpid_port</td>
- <td>(ListOpt) Qpid HA cluster host:port pairs</td>
- </tr>
- <tr>
- <td>qpid_password = </td>
- <td>(StrOpt) Password for qpid connection</td>
- </tr>
- <tr>
- <td>qpid_port = 5672</td>
- <td>(IntOpt) Qpid broker port</td>
- </tr>
- <tr>
- <td>qpid_protocol = tcp</td>
- <td>(StrOpt) Transport to use, either 'tcp' or 'ssl'</td>
- </tr>
- <tr>
- <td>qpid_sasl_mechanisms = </td>
- <td>(StrOpt) Space separated list of SASL mechanisms to use for auth</td>
- </tr>
- <tr>
- <td>qpid_tcp_nodelay = True</td>
- <td>(BoolOpt) Disable Nagle algorithm</td>
- </tr>
- <tr>
- <td>qpid_topology_version = 1</td>
- <td>(IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.</td>
- </tr>
- <tr>
- <td>qpid_username = </td>
- <td>(StrOpt) Username for qpid connection</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_heat_qpid">
+ <caption>Description of configuration options for qpid</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>qpid_heartbeat = 60</td>
+ <td>(IntOpt) Seconds between connection keepalive heartbeats.</td>
+ </tr>
+ <tr>
+ <td>qpid_hostname = localhost</td>
+ <td>(StrOpt) Qpid broker hostname.</td>
+ </tr>
+ <tr>
+ <td>qpid_hosts = $qpid_hostname:$qpid_port</td>
+ <td>(ListOpt) Qpid HA cluster host:port pairs.</td>
+ </tr>
+ <tr>
+ <td>qpid_password = </td>
+ <td>(StrOpt) Password for Qpid connection.</td>
+ </tr>
+ <tr>
+ <td>qpid_port = 5672</td>
+ <td>(IntOpt) Qpid broker port.</td>
+ </tr>
+ <tr>
+ <td>qpid_protocol = tcp</td>
+ <td>(StrOpt) Transport to use, either 'tcp' or 'ssl'.</td>
+ </tr>
+ <tr>
+ <td>qpid_sasl_mechanisms = </td>
+ <td>(StrOpt) Space separated list of SASL mechanisms to use for auth.</td>
+ </tr>
+ <tr>
+ <td>qpid_tcp_nodelay = True</td>
+ <td>(BoolOpt) Whether to disable the Nagle algorithm.</td>
+ </tr>
+ <tr>
+ <td>qpid_topology_version = 1</td>
+ <td>(IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.</td>
+ </tr>
+ <tr>
+ <td>qpid_username = </td>
+ <td>(StrOpt) Username for Qpid connection.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/heat-quota.xml b/doc/common/tables/heat-quota.xml
index dc797146b8..e4d25b4172 100644
--- a/doc/common/tables/heat-quota.xml
+++ b/doc/common/tables/heat-quota.xml
@@ -1,43 +1,42 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_heat_quota">
- <caption>Description of configuration options for quota</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>max_events_per_stack = 1000</td>
- <td>(IntOpt) Maximum events that will be available per stack. Older events will be deleted when this is reached. Set to 0 for unlimited events per stack.</td>
- </tr>
- <tr>
- <td>max_nested_stack_depth = 3</td>
- <td>(IntOpt) Maximum depth allowed when using nested stacks.</td>
- </tr>
- <tr>
- <td>max_resources_per_stack = 1000</td>
- <td>(IntOpt) Maximum resources allowed per top-level stack.</td>
- </tr>
- <tr>
- <td>max_stacks_per_tenant = 100</td>
- <td>(IntOpt) Maximum number of stacks any one tenant may have active at one time.</td>
- </tr>
- <tr>
- <td>max_template_size = 524288</td>
- <td>(IntOpt) Maximum raw byte size of any template.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_heat_quota">
+ <caption>Description of configuration options for quota</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>max_events_per_stack = 1000</td>
+ <td>(IntOpt) Maximum events that will be available per stack. Older events will be deleted when this is reached. Set to 0 for unlimited events per stack.</td>
+ </tr>
+ <tr>
+ <td>max_nested_stack_depth = 3</td>
+ <td>(IntOpt) Maximum depth allowed when using nested stacks.</td>
+ </tr>
+ <tr>
+ <td>max_resources_per_stack = 1000</td>
+ <td>(IntOpt) Maximum resources allowed per top-level stack.</td>
+ </tr>
+ <tr>
+ <td>max_stacks_per_tenant = 100</td>
+ <td>(IntOpt) Maximum number of stacks any one tenant may have active at one time.</td>
+ </tr>
+ <tr>
+ <td>max_template_size = 524288</td>
+ <td>(IntOpt) Maximum raw byte size of any template.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/heat-rabbitmq.xml b/doc/common/tables/heat-rabbitmq.xml
index 0d3b08f71d..02904857e1 100644
--- a/doc/common/tables/heat-rabbitmq.xml
+++ b/doc/common/tables/heat-rabbitmq.xml
@@ -1,83 +1,90 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_heat_rabbitmq">
- <caption>Description of configuration options for rabbitmq</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>kombu_ssl_ca_certs = </td>
- <td>(StrOpt) SSL certification authority file (valid only if SSL enabled)</td>
- </tr>
- <tr>
- <td>kombu_ssl_certfile = </td>
- <td>(StrOpt) SSL cert file (valid only if SSL enabled)</td>
- </tr>
- <tr>
- <td>kombu_ssl_keyfile = </td>
- <td>(StrOpt) SSL key file (valid only if SSL enabled)</td>
- </tr>
- <tr>
- <td>kombu_ssl_version = </td>
- <td>(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions</td>
- </tr>
- <tr>
- <td>rabbit_ha_queues = False</td>
- <td>(BoolOpt) use H/A queues in RabbitMQ (x-ha-policy: all).You need to wipe RabbitMQ database when changing this option.</td>
- </tr>
- <tr>
- <td>rabbit_host = localhost</td>
- <td>(StrOpt) The RabbitMQ broker address where a single node is used</td>
- </tr>
- <tr>
- <td>rabbit_hosts = $rabbit_host:$rabbit_port</td>
- <td>(ListOpt) RabbitMQ HA cluster host:port pairs</td>
- </tr>
- <tr>
- <td>rabbit_max_retries = 0</td>
- <td>(IntOpt) maximum retries with trying to connect to RabbitMQ (the default of 0 implies an infinite retry count)</td>
- </tr>
- <tr>
- <td>rabbit_password = guest</td>
- <td>(StrOpt) the RabbitMQ password</td>
- </tr>
- <tr>
- <td>rabbit_port = 5672</td>
- <td>(IntOpt) The RabbitMQ broker port where a single node is used</td>
- </tr>
- <tr>
- <td>rabbit_retry_backoff = 2</td>
- <td>(IntOpt) how long to backoff for between retries when connecting to RabbitMQ</td>
- </tr>
- <tr>
- <td>rabbit_retry_interval = 1</td>
- <td>(IntOpt) how frequently to retry connecting with RabbitMQ</td>
- </tr>
- <tr>
- <td>rabbit_use_ssl = False</td>
- <td>(BoolOpt) connect over SSL for RabbitMQ</td>
- </tr>
- <tr>
- <td>rabbit_userid = guest</td>
- <td>(StrOpt) the RabbitMQ userid</td>
- </tr>
- <tr>
- <td>rabbit_virtual_host = /</td>
- <td>(StrOpt) the RabbitMQ virtual host</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_heat_rabbitmq">
+ <caption>Description of configuration options for rabbitmq</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>kombu_reconnect_delay = 1.0</td>
+ <td>(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.</td>
+ </tr>
+ <tr>
+ <td>kombu_ssl_ca_certs = </td>
+ <td>(StrOpt) SSL certification authority file (valid only if SSL enabled).</td>
+ </tr>
+ <tr>
+ <td>kombu_ssl_certfile = </td>
+ <td>(StrOpt) SSL cert file (valid only if SSL enabled).</td>
+ </tr>
+ <tr>
+ <td>kombu_ssl_keyfile = </td>
+ <td>(StrOpt) SSL key file (valid only if SSL enabled).</td>
+ </tr>
+ <tr>
+ <td>kombu_ssl_version = </td>
+ <td>(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions.</td>
+ </tr>
+ <tr>
+ <td>rabbit_ha_queues = False</td>
+ <td>(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database.</td>
+ </tr>
+ <tr>
+ <td>rabbit_host = localhost</td>
+ <td>(StrOpt) The RabbitMQ broker address where a single node is used.</td>
+ </tr>
+ <tr>
+ <td>rabbit_hosts = $rabbit_host:$rabbit_port</td>
+ <td>(ListOpt) RabbitMQ HA cluster host:port pairs.</td>
+ </tr>
+ <tr>
+ <td>rabbit_login_method = AMQPLAIN</td>
+ <td>(StrOpt) the RabbitMQ login method</td>
+ </tr>
+ <tr>
+ <td>rabbit_max_retries = 0</td>
+ <td>(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).</td>
+ </tr>
+ <tr>
+ <td>rabbit_password = guest</td>
+ <td>(StrOpt) The RabbitMQ password.</td>
+ </tr>
+ <tr>
+ <td>rabbit_port = 5672</td>
+ <td>(IntOpt) The RabbitMQ broker port where a single node is used.</td>
+ </tr>
+ <tr>
+ <td>rabbit_retry_backoff = 2</td>
+ <td>(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.</td>
+ </tr>
+ <tr>
+ <td>rabbit_retry_interval = 1</td>
+ <td>(IntOpt) How frequently to retry connecting with RabbitMQ.</td>
+ </tr>
+ <tr>
+ <td>rabbit_use_ssl = False</td>
+ <td>(BoolOpt) Connect over SSL for RabbitMQ.</td>
+ </tr>
+ <tr>
+ <td>rabbit_userid = guest</td>
+ <td>(StrOpt) The RabbitMQ userid.</td>
+ </tr>
+ <tr>
+ <td>rabbit_virtual_host = /</td>
+ <td>(StrOpt) The RabbitMQ virtual host.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/heat-redis.xml b/doc/common/tables/heat-redis.xml
index da664aacef..023befaefe 100644
--- a/doc/common/tables/heat-redis.xml
+++ b/doc/common/tables/heat-redis.xml
@@ -1,42 +1,26 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_heat_redis">
- <caption>Description of configuration options for redis</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>host = oslo</td>
- <td>(StrOpt) Name of the engine node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address.</td>
- </tr>
- <tr>
- <th colspan="2">[matchmaker_redis]</th>
- </tr>
- <tr>
- <td>host = 127.0.0.1</td>
- <td>(StrOpt) Host to locate redis</td>
- </tr>
- <tr>
- <td>password = None</td>
- <td>(StrOpt) Password for Redis server. (optional)</td>
- </tr>
- <tr>
- <td>port = 6379</td>
- <td>(IntOpt) Use this port to connect to redis host.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_heat_redis">
+ <caption>Description of configuration options for redis</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>host = oslo</td>
+ <td>(StrOpt) Name of the engine node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/heat-rpc.xml b/doc/common/tables/heat-rpc.xml
index a2e53ef561..0b886ccb37 100644
--- a/doc/common/tables/heat-rpc.xml
+++ b/doc/common/tables/heat-rpc.xml
@@ -1,73 +1,77 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_heat_rpc">
- <caption>Description of configuration options for rpc</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>allowed_rpc_exception_modules = nova.exception, cinder.exception, exceptions</td>
- <td>(ListOpt) Modules of exceptions that are permitted to be recreated upon receiving exception data from an rpc call.</td>
- </tr>
- <tr>
- <td>engine_life_check_timeout = 2</td>
- <td>(IntOpt) RPC timeout for the engine liveness check that is used for stack locking.</td>
- </tr>
- <tr>
- <td>matchmaker_heartbeat_freq = 300</td>
- <td>(IntOpt) Heartbeat frequency</td>
- </tr>
- <tr>
- <td>matchmaker_heartbeat_ttl = 600</td>
- <td>(IntOpt) Heartbeat time-to-live.</td>
- </tr>
- <tr>
- <td>rpc_backend = heat.openstack.common.rpc.impl_kombu</td>
- <td>(StrOpt) The messaging module to use, defaults to kombu.</td>
- </tr>
- <tr>
- <td>rpc_cast_timeout = 30</td>
- <td>(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq.</td>
- </tr>
- <tr>
- <td>rpc_conn_pool_size = 30</td>
- <td>(IntOpt) Size of RPC connection pool</td>
- </tr>
- <tr>
- <td>rpc_response_timeout = 60</td>
- <td>(IntOpt) Seconds to wait for a response from call or multicall</td>
- </tr>
- <tr>
- <td>rpc_thread_pool_size = 64</td>
- <td>(IntOpt) Size of RPC thread pool</td>
- </tr>
- <tr>
- <th colspan="2">[matchmaker_ring]</th>
- </tr>
- <tr>
- <td>ringfile = /etc/oslo/matchmaker_ring.json</td>
- <td>(StrOpt) Matchmaker ring file (JSON)</td>
- </tr>
- <tr>
- <th colspan="2">[rpc_notifier2]</th>
- </tr>
- <tr>
- <td>topics = notifications</td>
- <td>(ListOpt) AMQP topic(s) used for OpenStack notifications</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_heat_rpc">
+ <caption>Description of configuration options for rpc</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>allowed_rpc_exception_modules = nova.exception, cinder.exception, exceptions</td>
+ <td>(ListOpt) Modules of exceptions that are permitted to be recreated upon receiving exception data from an rpc call.</td>
+ </tr>
+ <tr>
+ <td>engine_life_check_timeout = 2</td>
+ <td>(IntOpt) RPC timeout for the engine liveness check that is used for stack locking.</td>
+ </tr>
+ <tr>
+ <td>matchmaker_heartbeat_freq = 300</td>
+ <td>(IntOpt) Heartbeat frequency.</td>
+ </tr>
+ <tr>
+ <td>matchmaker_heartbeat_ttl = 600</td>
+ <td>(IntOpt) Heartbeat time-to-live.</td>
+ </tr>
+ <tr>
+ <td>password = None</td>
+ <td>(StrOpt) Password for Redis server (optional).</td>
+ </tr>
+ <tr>
+ <td>port = 6379</td>
+ <td>(IntOpt) Use this port to connect to redis host.</td>
+ </tr>
+ <tr>
+ <td>rpc_backend = heat.openstack.common.rpc.impl_kombu</td>
+ <td>(StrOpt) The messaging module to use, defaults to kombu.</td>
+ </tr>
+ <tr>
+ <td>rpc_cast_timeout = 30</td>
+ <td>(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq.</td>
+ </tr>
+ <tr>
+ <td>rpc_conn_pool_size = 30</td>
+ <td>(IntOpt) Size of RPC connection pool</td>
+ </tr>
+ <tr>
+ <td>rpc_response_timeout = 60</td>
+ <td>(IntOpt) Seconds to wait for a response from call or multicall</td>
+ </tr>
+ <tr>
+ <td>rpc_thread_pool_size = 64</td>
+ <td>(IntOpt) Size of RPC thread pool</td>
+ </tr>
+ <tr>
+ <td>transport_url = None</td>
+ <td>(StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[matchmaker_ring]</th>
+ </tr>
+ <tr>
+ <td>ringfile = /etc/oslo/matchmaker_ring.json</td>
+ <td>(StrOpt) Matchmaker ring file (JSON).</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/heat-waitcondition_api.xml b/doc/common/tables/heat-waitcondition_api.xml
index d8aced5fa9..ea6923d367 100644
--- a/doc/common/tables/heat-waitcondition_api.xml
+++ b/doc/common/tables/heat-waitcondition_api.xml
@@ -1,27 +1,26 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_heat_waitcondition_api">
- <caption>Description of configuration options for waitcondition_api</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>heat_waitcondition_server_url = </td>
- <td>(StrOpt) URL of the Heat waitcondition server.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_heat_waitcondition_api">
+ <caption>Description of configuration options for waitcondition_api</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>heat_waitcondition_server_url = </td>
+ <td>(StrOpt) URL of the Heat waitcondition server.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/heat-zeromq.xml b/doc/common/tables/heat-zeromq.xml
index 1bf53ae2bc..adcf170a84 100644
--- a/doc/common/tables/heat-zeromq.xml
+++ b/doc/common/tables/heat-zeromq.xml
@@ -1,51 +1,50 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_heat_zeromq">
- <caption>Description of configuration options for zeromq</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>rpc_zmq_bind_address = *</td>
- <td>(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address.</td>
- </tr>
- <tr>
- <td>rpc_zmq_contexts = 1</td>
- <td>(IntOpt) Number of ZeroMQ contexts, defaults to 1</td>
- </tr>
- <tr>
- <td>rpc_zmq_host = oslo</td>
- <td>(StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova.</td>
- </tr>
- <tr>
- <td>rpc_zmq_ipc_dir = /var/run/openstack</td>
- <td>(StrOpt) Directory for holding IPC sockets</td>
- </tr>
- <tr>
- <td>rpc_zmq_matchmaker = heat.openstack.common.rpc.matchmaker.MatchMakerLocalhost</td>
- <td>(StrOpt) MatchMaker driver</td>
- </tr>
- <tr>
- <td>rpc_zmq_port = 9501</td>
- <td>(IntOpt) ZeroMQ receiver listening port</td>
- </tr>
- <tr>
- <td>rpc_zmq_topic_backlog = None</td>
- <td>(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_heat_zeromq">
+ <caption>Description of configuration options for zeromq</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>rpc_zmq_bind_address = *</td>
+ <td>(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_contexts = 1</td>
+ <td>(IntOpt) Number of ZeroMQ contexts, defaults to 1.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_host = oslo</td>
+ <td>(StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_ipc_dir = /var/run/openstack</td>
+ <td>(StrOpt) Directory for holding IPC sockets.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_matchmaker = oslo.messaging._drivers.matchmaker.MatchMakerLocalhost</td>
+ <td>(StrOpt) MatchMaker driver.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_port = 9501</td>
+ <td>(IntOpt) ZeroMQ receiver listening port.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_topic_backlog = None</td>
+ <td>(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/keystone-amqp.xml b/doc/common/tables/keystone-amqp.xml
index 77f7b15746..884d24b9a3 100644
--- a/doc/common/tables/keystone-amqp.xml
+++ b/doc/common/tables/keystone-amqp.xml
@@ -1,71 +1,70 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_keystone_amqp">
- <caption>Description of configuration options for amqp</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>amqp_auto_delete = False</td>
- <td>(BoolOpt) Auto-delete queues in amqp.</td>
- </tr>
- <tr>
- <td>amqp_durable_queues = False</td>
- <td>(BoolOpt) Use durable queues in amqp.</td>
- </tr>
- <tr>
- <td>control_exchange = openstack</td>
- <td>(StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.</td>
- </tr>
- <tr>
- <td>default_publisher_id = None</td>
- <td>(StrOpt) Default publisher_id for outgoing notifications</td>
- </tr>
- <tr>
- <td>notification_driver = []</td>
- <td>(MultiStrOpt) Driver or drivers to handle sending notifications.</td>
- </tr>
- <tr>
- <td>notification_topics = notifications</td>
- <td>(ListOpt) AMQP topic used for OpenStack notifications.</td>
- </tr>
- <tr>
- <td>rpc_backend = rabbit</td>
- <td>(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq.</td>
- </tr>
- <tr>
- <td>rpc_cast_timeout = 30</td>
- <td>(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq.</td>
- </tr>
- <tr>
- <td>rpc_conn_pool_size = 30</td>
- <td>(IntOpt) Size of RPC connection pool.</td>
- </tr>
- <tr>
- <td>rpc_response_timeout = 60</td>
- <td>(IntOpt) Seconds to wait for a response from a call.</td>
- </tr>
- <tr>
- <td>rpc_thread_pool_size = 64</td>
- <td>(IntOpt) Size of RPC greenthread pool.</td>
- </tr>
- <tr>
- <td>transport_url = None</td>
- <td>(StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_keystone_amqp">
+ <caption>Description of configuration options for amqp</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>amqp_auto_delete = False</td>
+ <td>(BoolOpt) Auto-delete queues in amqp.</td>
+ </tr>
+ <tr>
+ <td>amqp_durable_queues = False</td>
+ <td>(BoolOpt) Use durable queues in amqp.</td>
+ </tr>
+ <tr>
+ <td>control_exchange = openstack</td>
+ <td>(StrOpt) AMQP exchange to connect to if using RabbitMQ or Qpid</td>
+ </tr>
+ <tr>
+ <td>default_publisher_id = None</td>
+ <td>(StrOpt) Default publisher_id for outgoing notifications</td>
+ </tr>
+ <tr>
+ <td>notification_driver = []</td>
+ <td>(MultiStrOpt) Driver or drivers to handle sending notifications.</td>
+ </tr>
+ <tr>
+ <td>notification_topics = notifications</td>
+ <td>(ListOpt) AMQP topic used for OpenStack notifications.</td>
+ </tr>
+ <tr>
+ <td>rpc_backend = keystone.openstack.common.rpc.impl_kombu</td>
+ <td>(StrOpt) The messaging module to use, defaults to kombu.</td>
+ </tr>
+ <tr>
+ <td>rpc_cast_timeout = 30</td>
+ <td>(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq.</td>
+ </tr>
+ <tr>
+ <td>rpc_conn_pool_size = 30</td>
+ <td>(IntOpt) Size of RPC connection pool</td>
+ </tr>
+ <tr>
+ <td>rpc_response_timeout = 60</td>
+ <td>(IntOpt) Seconds to wait for a response from call or multicall</td>
+ </tr>
+ <tr>
+ <td>rpc_thread_pool_size = 64</td>
+ <td>(IntOpt) Size of RPC thread pool</td>
+ </tr>
+ <tr>
+ <td>transport_url = None</td>
+ <td>(StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/keystone-api.xml b/doc/common/tables/keystone-api.xml
index 26a87bc325..c3e95aeeb6 100644
--- a/doc/common/tables/keystone-api.xml
+++ b/doc/common/tables/keystone-api.xml
@@ -1,109 +1,120 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_keystone_api">
- <caption>Description of configuration options for api</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>admin_bind_host = 0.0.0.0</td>
- <td>(StrOpt) The IP Address of the network interface to for the admin service to listen on.</td>
- </tr>
- <tr>
- <td>admin_endpoint = None</td>
- <td>(StrOpt) The base admin endpoint URL for keystone that are advertised to clients (NOTE: this does NOT affect how keystone listens for connections). Defaults to the base host URL of the request. Eg a request to http://server:35357/v2.0/users will default to http://server:35357. You should only need to set this value if the base URL contains a path (eg /prefix/v2.0) or the endpoint should be found on a different server.</td>
- </tr>
- <tr>
- <td>admin_port = 35357</td>
- <td>(IntOpt) The port number which the admin service listens on.</td>
- </tr>
- <tr>
- <td>admin_token = ADMIN</td>
- <td>(StrOpt) A "shared secret" that can be used to bootstrap Keystone. This "token" does not represent a user, and carries no explicit authorization. To disable in production (highly recommended), remove AdminTokenAuthMiddleware from your paste application pipelines (for example, in keystone-paste.ini).</td>
- </tr>
- <tr>
- <td>compute_port = 8774</td>
- <td>(IntOpt) The port which the OpenStack Compute service listens on.</td>
- </tr>
- <tr>
- <td>domain_id_immutable = True</td>
- <td>(BoolOpt) Set this to false if you want to enable the ability for user, group and project entities to be moved between domains by updating their domain_id. Allowing such movement is not recommended if the scope of a domain admin is being restricted by use of an appropriate policy file (see policy.v3cloudsample as an example).</td>
- </tr>
- <tr>
- <td>list_limit = None</td>
- <td>(IntOpt) The maximum number of entities that will be returned in a collection can be set with list_limit, with no limit set by default. This global limit may be then overridden for a specific driver, by specifying a list_limit in the appropriate section (e.g. [assignment]).</td>
- </tr>
- <tr>
- <td>max_param_size = 64</td>
- <td>(IntOpt) limit the sizes of user & tenant ID/names.</td>
- </tr>
- <tr>
- <td>max_request_body_size = 114688</td>
- <td>(IntOpt) enforced by optional sizelimit middleware (keystone.middleware:RequestBodySizeLimiter).</td>
- </tr>
- <tr>
- <td>max_token_size = 8192</td>
- <td>(IntOpt) similar to max_param_size, but provides an exception for token values.</td>
- </tr>
- <tr>
- <td>member_role_id = 9fe2ff9ee4384b1894a90878d3e92bab</td>
- <td>(StrOpt) During a SQL upgrade member_role_id will be used to create a new role that will replace records in the user_tenant_membership table with explicit role grants. After migration, the member_role_id will be used in the API add_user_to_project.</td>
- </tr>
- <tr>
- <td>member_role_name = _member_</td>
- <td>(StrOpt) During a SQL upgrade member_role_id will be used to create a new role that will replace records in the user_tenant_membership table with explicit role grants. After migration, member_role_name will be ignored.</td>
- </tr>
- <tr>
- <td>public_bind_host = 0.0.0.0</td>
- <td>(StrOpt) The IP Address of the network interface to for the public service to listen on.</td>
- </tr>
- <tr>
- <td>public_endpoint = None</td>
- <td>(StrOpt) The base public endpoint URL for keystone that are advertised to clients (NOTE: this does NOT affect how keystone listens for connections). Defaults to the base host URL of the request. Eg a request to http://server:5000/v2.0/users will default to http://server:5000. You should only need to set this value if the base URL contains a path (eg /prefix/v2.0) or the endpoint should be found on a different server.</td>
- </tr>
- <tr>
- <td>public_port = 5000</td>
- <td>(IntOpt) The port number which the public service listens on.</td>
- </tr>
- <tr>
- <td>tcp_keepalive = False</td>
- <td>(BoolOpt) Set this to True if you want to enable TCP_KEEPALIVE on server sockets i.e. sockets used by the keystone wsgi server for client connections.</td>
- </tr>
- <tr>
- <td>tcp_keepidle = 600</td>
- <td>(IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Only applies if tcp_keepalive is True. Not supported on OS X.</td>
- </tr>
- <tr>
- <th colspan="2">[endpoint_filter]</th>
- </tr>
- <tr>
- <td>driver = keystone.contrib.endpoint_filter.backends.sql.EndpointFilter</td>
- <td>(StrOpt) Keystone Endpoint Filter backend driver</td>
- </tr>
- <tr>
- <td>return_all_endpoints_if_no_filter = True</td>
- <td>(BoolOpt) Toggle to return all active endpoints if no filter exists.</td>
- </tr>
- <tr>
- <th colspan="2">[paste_deploy]</th>
- </tr>
- <tr>
- <td>config_file = keystone-paste.ini</td>
- <td>(StrOpt) Name of the paste configuration file that defines the available pipelines.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_keystone_api">
+ <caption>Description of configuration options for api</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>admin_bind_host = 0.0.0.0</td>
+ <td>(StrOpt) The IP address of the network interface for the admin service to listen on.</td>
+ </tr>
+ <tr>
+ <td>admin_endpoint = None</td>
+ <td>(StrOpt) The base admin endpoint URL for Keystone that is advertised to clients (NOTE: this does NOT affect how Keystone listens for connections). Defaults to the base host URL of the request. E.g. a request to http://server:35357/v2.0/users will default to http://server:35357. You should only need to set this value if the base URL contains a path (e.g. /prefix/v2.0) or the endpoint should be found on a different server.</td>
+ </tr>
+ <tr>
+ <td>admin_port = 35357</td>
+ <td>(IntOpt) The port number which the admin service listens on.</td>
+ </tr>
+ <tr>
+ <td>admin_token = ADMIN</td>
+ <td>(StrOpt) A "shared secret" that can be used to bootstrap Keystone. This "token" does not represent a user, and carries no explicit authorization. To disable in production (highly recommended), remove AdminTokenAuthMiddleware from your paste application pipelines (for example, in keystone-paste.ini).</td>
+ </tr>
+ <tr>
+ <td>admin_workers = 1</td>
+ <td>(IntOpt) The number of worker processes to serve the admin WSGI application</td>
+ </tr>
+ <tr>
+ <td>compute_port = 8774</td>
+ <td>(IntOpt) The port which the OpenStack Compute service listens on.</td>
+ </tr>
+ <tr>
+ <td>domain_id_immutable = True</td>
+ <td>(BoolOpt) Set this to false if you want to enable the ability for user, group and project entities to be moved between domains by updating their domain_id. Allowing such movement is not recommended if the scope of a domain admin is being restricted by use of an appropriate policy file (see policy.v3cloudsample as an example).</td>
+ </tr>
+ <tr>
+ <td>list_limit = None</td>
+ <td>(IntOpt) The maximum number of entities that will be returned in a collection, with no limit set by default. This global limit may be then overridden for a specific driver, by specifying a list_limit in the appropriate section (e.g. [assignment]).</td>
+ </tr>
+ <tr>
+ <td>max_param_size = 64</td>
+ <td>(IntOpt) Limit the sizes of user & project ID/names.</td>
+ </tr>
+ <tr>
+ <td>max_request_body_size = 114688</td>
+ <td>(IntOpt) Enforced by optional sizelimit middleware (keystone.middleware:RequestBodySizeLimiter).</td>
+ </tr>
+ <tr>
+ <td>max_token_size = 8192</td>
+ <td>(IntOpt) Similar to max_param_size, but provides an exception for token values.</td>
+ </tr>
+ <tr>
+ <td>member_role_id = 9fe2ff9ee4384b1894a90878d3e92bab</td>
+ <td>(StrOpt) During a SQL upgrade member_role_id will be used to create a new role that will replace records in the assignment table with explicit role grants. After migration, the member_role_id will be used in the API add_user_to_project.</td>
+ </tr>
+ <tr>
+ <td>member_role_name = _member_</td>
+ <td>(StrOpt) During a SQL upgrade member_role_name will be used to create a new role that will replace records in the assignment table with explicit role grants. After migration, member_role_name will be ignored.</td>
+ </tr>
+ <tr>
+ <td>public_bind_host = 0.0.0.0</td>
+ <td>(StrOpt) The IP address of the network interface for the public service to listen on.</td>
+ </tr>
+ <tr>
+ <td>public_endpoint = None</td>
+ <td>(StrOpt) The base public endpoint URL for Keystone that is advertised to clients (NOTE: this does NOT affect how Keystone listens for connections). Defaults to the base host URL of the request. E.g. a request to http://server:5000/v2.0/users will default to http://server:5000. You should only need to set this value if the base URL contains a path (e.g. /prefix/v2.0) or the endpoint should be found on a different server.</td>
+ </tr>
+ <tr>
+ <td>public_port = 5000</td>
+ <td>(IntOpt) The port number which the public service listens on.</td>
+ </tr>
+ <tr>
+ <td>public_workers = 1</td>
+ <td>(IntOpt) The number of worker processes to serve the public WSGI application</td>
+ </tr>
+ <tr>
+ <td>strict_password_check = False</td>
+ <td>(BoolOpt) If set to true, strict password length checking is performed for password manipulation. If a password exceeds the maximum length, the operation will fail with an HTTP 403 Forbidden error. If set to false, passwords are automatically truncated to the maximum length.</td>
+ </tr>
+ <tr>
+ <td>tcp_keepalive = False</td>
+ <td>(BoolOpt) Set this to true if you want to enable TCP_KEEPALIVE on server sockets, i.e. sockets used by the Keystone wsgi server for client connections.</td>
+ </tr>
+ <tr>
+ <td>tcp_keepidle = 600</td>
+ <td>(IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Only applies if tcp_keepalive is true. Not supported on OS X.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[endpoint_filter]</th>
+ </tr>
+ <tr>
+ <td>driver = keystone.contrib.endpoint_filter.backends.sql.EndpointFilter</td>
+ <td>(StrOpt) Endpoint Filter backend driver</td>
+ </tr>
+ <tr>
+ <td>return_all_endpoints_if_no_filter = True</td>
+ <td>(BoolOpt) Toggle to return all active endpoints if no filter exists.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[paste_deploy]</th>
+ </tr>
+ <tr>
+ <td>config_file = keystone-paste.ini</td>
+ <td>(StrOpt) Name of the paste configuration file that defines the available pipelines.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/keystone-assignment.xml b/doc/common/tables/keystone-assignment.xml
index 6a09574a6c..d6c82e0a7a 100644
--- a/doc/common/tables/keystone-assignment.xml
+++ b/doc/common/tables/keystone-assignment.xml
@@ -1,39 +1,38 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_keystone_assignment">
- <caption>Description of configuration options for assignment</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">[assignment]</th>
- </tr>
- <tr>
- <td>cache_time = None</td>
- <td>(IntOpt) TTL (in seconds) to cache assignment data. This has no effect unless global caching is enabled.</td>
- </tr>
- <tr>
- <td>caching = True</td>
- <td>(BoolOpt) Toggle for assignment caching. This has no effect unless global caching is enabled.</td>
- </tr>
- <tr>
- <td>driver = None</td>
- <td>(StrOpt) Keystone Assignment backend driver.</td>
- </tr>
- <tr>
- <td>list_limit = None</td>
- <td>(IntOpt) Maximum number of entities that will be returned in an assignment collection.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_keystone_assignment">
+ <caption>Description of configuration options for assignment</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">[assignment]</th>
+ </tr>
+ <tr>
+ <td>cache_time = None</td>
+ <td>(IntOpt) TTL (in seconds) to cache assignment data. This has no effect unless global caching is enabled.</td>
+ </tr>
+ <tr>
+ <td>caching = True</td>
+ <td>(BoolOpt) Toggle for assignment caching. This has no effect unless global caching is enabled.</td>
+ </tr>
+ <tr>
+ <td>driver = None</td>
+ <td>(StrOpt) Assignment backend driver.</td>
+ </tr>
+ <tr>
+ <td>list_limit = None</td>
+ <td>(IntOpt) Maximum number of entities that will be returned in an assignment collection.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/keystone-auth.xml b/doc/common/tables/keystone-auth.xml
index 94157c2291..79f125ed9d 100644
--- a/doc/common/tables/keystone-auth.xml
+++ b/doc/common/tables/keystone-auth.xml
@@ -1,39 +1,38 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_keystone_auth">
- <caption>Description of configuration options for auth</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">[auth]</th>
- </tr>
- <tr>
- <td>external = keystone.auth.plugins.external.DefaultDomain</td>
- <td>(StrOpt) The external (REMOTE_USER) auth plugin module.</td>
- </tr>
- <tr>
- <td>methods = external, password, token</td>
- <td>(ListOpt) Default auth methods.</td>
- </tr>
- <tr>
- <td>password = keystone.auth.plugins.password.Password</td>
- <td>(StrOpt) The password auth plugin module.</td>
- </tr>
- <tr>
- <td>token = keystone.auth.plugins.token.Token</td>
- <td>(StrOpt) The token auth plugin module.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_keystone_auth">
+ <caption>Description of configuration options for auth</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">[auth]</th>
+ </tr>
+ <tr>
+ <td>external = keystone.auth.plugins.external.DefaultDomain</td>
+ <td>(StrOpt) The external (REMOTE_USER) auth plugin module.</td>
+ </tr>
+ <tr>
+ <td>methods = external, password, token</td>
+ <td>(ListOpt) Default auth methods.</td>
+ </tr>
+ <tr>
+ <td>password = keystone.auth.plugins.password.Password</td>
+ <td>(StrOpt) The password auth plugin module.</td>
+ </tr>
+ <tr>
+ <td>token = keystone.auth.plugins.token.Token</td>
+ <td>(StrOpt) The token auth plugin module.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/keystone-auth_token.xml b/doc/common/tables/keystone-auth_token.xml
index 093b339b97..30cb5d2f9c 100644
--- a/doc/common/tables/keystone-auth_token.xml
+++ b/doc/common/tables/keystone-auth_token.xml
@@ -1,134 +1,145 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_keystone_auth_token">
- <caption>Description of configuration options for auth_token</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>memcached_servers = None</td>
- <td>(ListOpt) Memcached servers or None for in process cache.</td>
- </tr>
- <tr>
- <th colspan="2">[keystone_authtoken]</th>
- </tr>
- <tr>
- <td>admin_password = None</td>
- <td>(StrOpt) Keystone account password</td>
- </tr>
- <tr>
- <td>admin_tenant_name = admin</td>
- <td>(StrOpt) Keystone service account tenant name to validate user tokens</td>
- </tr>
- <tr>
- <td>admin_token = None</td>
- <td>(StrOpt) Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process.</td>
- </tr>
- <tr>
- <td>admin_user = None</td>
- <td>(StrOpt) Keystone account username</td>
- </tr>
- <tr>
- <td>auth_admin_prefix = </td>
- <td>(StrOpt) Prefix to prepend at the beginning of the path</td>
- </tr>
- <tr>
- <td>auth_host = 127.0.0.1</td>
- <td>(StrOpt) Host providing the admin Identity API endpoint</td>
- </tr>
- <tr>
- <td>auth_port = 35357</td>
- <td>(IntOpt) Port of the admin Identity API endpoint</td>
- </tr>
- <tr>
- <td>auth_protocol = https</td>
- <td>(StrOpt) Protocol of the admin Identity API endpoint(http or https)</td>
- </tr>
- <tr>
- <td>auth_uri = None</td>
- <td>(StrOpt) Complete public Identity API endpoint</td>
- </tr>
- <tr>
- <td>auth_version = None</td>
- <td>(StrOpt) API version of the admin Identity API endpoint</td>
- </tr>
- <tr>
- <td>cache = None</td>
- <td>(StrOpt) Env key for the swift cache</td>
- </tr>
- <tr>
- <td>cafile = None</td>
- <td>(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.</td>
- </tr>
- <tr>
- <td>certfile = None</td>
- <td>(StrOpt) Required if Keystone server requires client certificate</td>
- </tr>
- <tr>
- <td>delay_auth_decision = False</td>
- <td>(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components</td>
- </tr>
- <tr>
- <td>enforce_token_bind = permissive</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>http_connect_timeout = None</td>
- <td>(BoolOpt) Request timeout value for communicating with Identity API server.</td>
- </tr>
- <tr>
- <td>http_request_max_retries = 3</td>
- <td>(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server.</td>
- </tr>
- <tr>
- <td>include_service_catalog = True</td>
- <td>(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.</td>
- </tr>
- <tr>
- <td>insecure = False</td>
- <td>(BoolOpt) Verify HTTPS connections.</td>
- </tr>
- <tr>
- <td>keyfile = None</td>
- <td>(StrOpt) Required if Keystone server requires client certificate</td>
- </tr>
- <tr>
- <td>memcache_secret_key = None</td>
- <td>(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation.</td>
- </tr>
- <tr>
- <td>memcache_security_strategy = None</td>
- <td>(StrOpt) (optional) if defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.</td>
- </tr>
- <tr>
- <td>memcached_servers = None</td>
- <td>(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.</td>
- </tr>
- <tr>
- <td>revocation_cache_time = 300</td>
- <td>(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.</td>
- </tr>
- <tr>
- <td>signing_dir = None</td>
- <td>(StrOpt) Directory used to cache files related to PKI tokens</td>
- </tr>
- <tr>
- <td>token_cache_time = 300</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>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_keystone_auth_token">
+ <caption>Description of configuration options for auth_token</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>memcached_servers = None</td>
+ <td>(ListOpt) Memcached servers or None for in process cache.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[keystone_authtoken]</th>
+ </tr>
+ <tr>
+ <td>admin_password = None</td>
+ <td>(StrOpt) Keystone account password</td>
+ </tr>
+ <tr>
+ <td>admin_tenant_name = admin</td>
+ <td>(StrOpt) Keystone service account tenant name to validate user tokens</td>
+ </tr>
+ <tr>
+ <td>admin_token = None</td>
+ <td>(StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead.</td>
+ </tr>
+ <tr>
+ <td>admin_user = None</td>
+ <td>(StrOpt) Keystone account username</td>
+ </tr>
+ <tr>
+ <td>auth_admin_prefix = </td>
+ <td>(StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri.</td>
+ </tr>
+ <tr>
+ <td>auth_host = 127.0.0.1</td>
+ <td>(StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri.</td>
+ </tr>
+ <tr>
+ <td>auth_port = 35357</td>
+ <td>(IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri.</td>
+ </tr>
+ <tr>
+ <td>auth_protocol = https</td>
+ <td>(StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri.</td>
+ </tr>
+ <tr>
+ <td>auth_uri = None</td>
+ <td>(StrOpt) Complete public Identity API endpoint</td>
+ </tr>
+ <tr>
+ <td>auth_version = None</td>
+ <td>(StrOpt) API version of the admin Identity API endpoint</td>
+ </tr>
+ <tr>
+ <td>cache = None</td>
+ <td>(StrOpt) Env key for the swift cache</td>
+ </tr>
+ <tr>
+ <td>cafile = None</td>
+ <td>(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.</td>
+ </tr>
+ <tr>
+ <td>certfile = None</td>
+ <td>(StrOpt) Required if Keystone server requires client certificate</td>
+ </tr>
+ <tr>
+ <td>check_revocations_for_cached = False</td>
+ <td>(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the Keystone server.</td>
+ </tr>
+ <tr>
+ <td>delay_auth_decision = False</td>
+ <td>(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components</td>
+ </tr>
+ <tr>
+ <td>enforce_token_bind = permissive</td>
+ <td>(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens.</td>
+ </tr>
+ <tr>
+ <td>hash_algorithms = md5</td>
+ <td>(ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance.</td>
+ </tr>
+ <tr>
+ <td>http_connect_timeout = None</td>
+ <td>(BoolOpt) Request timeout value for communicating with Identity API server.</td>
+ </tr>
+ <tr>
+ <td>http_request_max_retries = 3</td>
+ <td>(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server.</td>
+ </tr>
+ <tr>
+ <td>identity_uri = None</td>
+ <td>(StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/</td>
+ </tr>
+ <tr>
+ <td>include_service_catalog = True</td>
+ <td>(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.</td>
+ </tr>
+ <tr>
+ <td>insecure = False</td>
+ <td>(BoolOpt) Verify HTTPS connections.</td>
+ </tr>
+ <tr>
+ <td>keyfile = None</td>
+ <td>(StrOpt) Required if Keystone server requires client certificate</td>
+ </tr>
+ <tr>
+ <td>memcache_secret_key = None</td>
+ <td>(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation.</td>
+ </tr>
+ <tr>
+ <td>memcache_security_strategy = None</td>
+ <td>(StrOpt) (optional) if defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.</td>
+ </tr>
+ <tr>
+ <td>memcached_servers = None</td>
+ <td>(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.</td>
+ </tr>
+ <tr>
+ <td>revocation_cache_time = 10</td>
+ <td>(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.</td>
+ </tr>
+ <tr>
+ <td>signing_dir = None</td>
+ <td>(StrOpt) Directory used to cache files related to PKI tokens</td>
+ </tr>
+ <tr>
+ <td>token_cache_time = 300</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>
diff --git a/doc/common/tables/keystone-cache.xml b/doc/common/tables/keystone-cache.xml
index b44fa0c190..1b3ceb9473 100644
--- a/doc/common/tables/keystone-cache.xml
+++ b/doc/common/tables/keystone-cache.xml
@@ -1,55 +1,54 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_keystone_cache">
- <caption>Description of configuration options for cache</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">[cache]</th>
- </tr>
- <tr>
- <td>backend = keystone.common.cache.noop</td>
- <td>(StrOpt) Dogpile.cache backend module. It is recommended that Memcache (dogpile.cache.memcache) or Redis (dogpile.cache.redis) be used in production deployments. Small workloads (single process) like devstack can use the dogpile.cache.memory backend.</td>
- </tr>
- <tr>
- <td>backend_argument = []</td>
- <td>(MultiStrOpt) Arguments supplied to the backend module. Specify this option once per argument to be passed to the dogpile.cache backend. Example format: "<argname>:<value>".</td>
- </tr>
- <tr>
- <td>config_prefix = cache.keystone</td>
- <td>(StrOpt) Prefix for building the configuration dictionary for the cache region. This should not need to be changed unless there is another dogpile.cache region with the same configuration name.</td>
- </tr>
- <tr>
- <td>debug_cache_backend = False</td>
- <td>(BoolOpt) Extra debugging from the cache backend (cache keys, get/set/delete/etc calls) This is only really useful if you need to see the specific cache-backend get/set/delete calls with the keys/values. Typically this should be left set to False.</td>
- </tr>
- <tr>
- <td>enabled = False</td>
- <td>(BoolOpt) Global toggle for all caching using the should_cache_fn mechanism.</td>
- </tr>
- <tr>
- <td>expiration_time = 600</td>
- <td>(IntOpt) Default TTL, in seconds, for any cached item in the dogpile.cache region. This applies to any cached method that doesn't have an explicit cache expiration time defined for it.</td>
- </tr>
- <tr>
- <td>proxies = </td>
- <td>(ListOpt) Proxy Classes to import that will affect the way the dogpile.cache backend functions. See the dogpile.cache documentation on changing-backend-behavior. Comma delimited list e.g. my.dogpile.proxy.Class, my.dogpile.proxyClass2.</td>
- </tr>
- <tr>
- <td>use_key_mangler = True</td>
- <td>(BoolOpt) Use a key-mangling function (sha1) to ensure fixed length cache-keys. This is toggle-able for debugging purposes, it is highly recommended to always leave this set to True.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_keystone_cache">
+ <caption>Description of configuration options for cache</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">[cache]</th>
+ </tr>
+ <tr>
+ <td>backend = keystone.common.cache.noop</td>
+ <td>(StrOpt) Dogpile.cache backend module. It is recommended that Memcache (dogpile.cache.memcached) or Redis (dogpile.cache.redis) be used in production deployments. Small workloads (single process) like devstack can use the dogpile.cache.memory backend.</td>
+ </tr>
+ <tr>
+ <td>backend_argument = []</td>
+ <td>(MultiStrOpt) Arguments supplied to the backend module. Specify this option once per argument to be passed to the dogpile.cache backend. Example format: "<argname>:<value>".</td>
+ </tr>
+ <tr>
+ <td>config_prefix = cache.keystone</td>
+ <td>(StrOpt) Prefix for building the configuration dictionary for the cache region. This should not need to be changed unless there is another dogpile.cache region with the same configuration name.</td>
+ </tr>
+ <tr>
+ <td>debug_cache_backend = False</td>
+ <td>(BoolOpt) Extra debugging from the cache backend (cache keys, get/set/delete/etc calls). This is only really useful if you need to see the specific cache-backend get/set/delete calls with the keys/values. Typically this should be left set to false.</td>
+ </tr>
+ <tr>
+ <td>enabled = False</td>
+ <td>(BoolOpt) Global toggle for all caching using the should_cache_fn mechanism.</td>
+ </tr>
+ <tr>
+ <td>expiration_time = 600</td>
+ <td>(IntOpt) Default TTL, in seconds, for any cached item in the dogpile.cache region. This applies to any cached method that doesn't have an explicit cache expiration time defined for it.</td>
+ </tr>
+ <tr>
+ <td>proxies = </td>
+ <td>(ListOpt) Proxy classes to import that will affect the way the dogpile.cache backend functions. See the dogpile.cache documentation on changing-backend-behavior.</td>
+ </tr>
+ <tr>
+ <td>use_key_mangler = True</td>
+ <td>(BoolOpt) Use a key-mangling function (sha1) to ensure fixed length cache-keys. This is toggle-able for debugging purposes, it is highly recommended to always leave this set to true.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/keystone-catalog.xml b/doc/common/tables/keystone-catalog.xml
index 81f99570d1..fb08feaf1b 100644
--- a/doc/common/tables/keystone-catalog.xml
+++ b/doc/common/tables/keystone-catalog.xml
@@ -1,35 +1,34 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_keystone_catalog">
- <caption>Description of configuration options for catalog</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">[catalog]</th>
- </tr>
- <tr>
- <td>driver = keystone.catalog.backends.sql.Catalog</td>
- <td>(StrOpt) Keystone catalog backend driver.</td>
- </tr>
- <tr>
- <td>list_limit = None</td>
- <td>(IntOpt) Maximum number of entities that will be returned in a catalog collection.</td>
- </tr>
- <tr>
- <td>template_file = default_catalog.templates</td>
- <td>(StrOpt) Catalog template file name for use with the template catalog backend.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_keystone_catalog">
+ <caption>Description of configuration options for catalog</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">[catalog]</th>
+ </tr>
+ <tr>
+ <td>driver = keystone.catalog.backends.sql.Catalog</td>
+ <td>(StrOpt) Catalog backend driver.</td>
+ </tr>
+ <tr>
+ <td>list_limit = None</td>
+ <td>(IntOpt) Maximum number of entities that will be returned in a catalog collection.</td>
+ </tr>
+ <tr>
+ <td>template_file = default_catalog.templates</td>
+ <td>(StrOpt) Catalog template file name for use with the template catalog backend.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/keystone-credential.xml b/doc/common/tables/keystone-credential.xml
index badb673a57..63e99b3dbd 100644
--- a/doc/common/tables/keystone-credential.xml
+++ b/doc/common/tables/keystone-credential.xml
@@ -1,27 +1,26 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_keystone_credential">
- <caption>Description of configuration options for credential</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">[credential]</th>
- </tr>
- <tr>
- <td>driver = keystone.credential.backends.sql.Credential</td>
- <td>(StrOpt) Keystone Credential backend driver.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_keystone_credential">
+ <caption>Description of configuration options for credential</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">[credential]</th>
+ </tr>
+ <tr>
+ <td>driver = keystone.credential.backends.sql.Credential</td>
+ <td>(StrOpt) Credential backend driver.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/keystone-database.xml b/doc/common/tables/keystone-database.xml
index 7b0c922de6..63516ce009 100644
--- a/doc/common/tables/keystone-database.xml
+++ b/doc/common/tables/keystone-database.xml
@@ -1,99 +1,102 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_keystone_database">
- <caption>Description of configuration options for database</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[database]</th>
- </tr>
- <tr>
- <td>backend = sqlalchemy</td>
- <td>(StrOpt) The backend to use for db</td>
- </tr>
- <tr>
- <td>connection = None</td>
- <td>(StrOpt) The SQLAlchemy connection string used to connect to the database</td>
- </tr>
- <tr>
- <td>connection_debug = 0</td>
- <td>(IntOpt) Verbosity of SQL debugging information. 0=None, 100=Everything</td>
- </tr>
- <tr>
- <td>connection_trace = False</td>
- <td>(BoolOpt) Add python stack traces to SQL as comment strings</td>
- </tr>
- <tr>
- <td>db_inc_retry_interval = True</td>
- <td>(BoolOpt) Whether to increase interval between db connection retries, up to db_max_retry_interval</td>
- </tr>
- <tr>
- <td>db_max_retries = 20</td>
- <td>(IntOpt) maximum db connection retries before error is raised. (setting -1 implies an infinite retry count)</td>
- </tr>
- <tr>
- <td>db_max_retry_interval = 10</td>
- <td>(IntOpt) max seconds between db connection retries, if db_inc_retry_interval is enabled</td>
- </tr>
- <tr>
- <td>db_retry_interval = 1</td>
- <td>(IntOpt) seconds between db connection retries</td>
- </tr>
- <tr>
- <td>idle_timeout = 3600</td>
- <td>(IntOpt) Timeout before idle sql connections are reaped</td>
- </tr>
- <tr>
- <td>max_overflow = None</td>
- <td>(IntOpt) If set, use this value for max_overflow with sqlalchemy</td>
- </tr>
- <tr>
- <td>max_pool_size = None</td>
- <td>(IntOpt) Maximum number of SQL connections to keep open in a pool</td>
- </tr>
- <tr>
- <td>max_retries = 10</td>
- <td>(IntOpt) Maximum db connection retries during startup. (setting -1 implies an infinite retry count)</td>
- </tr>
- <tr>
- <td>min_pool_size = 1</td>
- <td>(IntOpt) Minimum number of SQL connections to keep open in a pool</td>
- </tr>
- <tr>
- <td>mysql_sql_mode = TRADITIONAL</td>
- <td>(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=</td>
- </tr>
- <tr>
- <td>pool_timeout = None</td>
- <td>(IntOpt) If set, use this value for pool_timeout with sqlalchemy</td>
- </tr>
- <tr>
- <td>retry_interval = 10</td>
- <td>(IntOpt) Interval between retries of opening a sql connection</td>
- </tr>
- <tr>
- <td>sqlite_db = keystone.sqlite</td>
- <td>(StrOpt) The file name to use with SQLite</td>
- </tr>
- <tr>
- <td>sqlite_synchronous = True</td>
- <td>(BoolOpt) If True, SQLite uses synchronous mode</td>
- </tr>
- <tr>
- <td>use_db_reconnect = False</td>
- <td>(BoolOpt) Enable the experimental use of database reconnect on connection lost</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_keystone_database">
+ <caption>Description of configuration options for database</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[database]</th>
+ </tr>
+ <tr>
+ <td>backend = sqlalchemy</td>
+ <td>(StrOpt) The back end to use for the database.</td>
+ </tr>
+ <tr>
+ <td>connection = None</td>
+ <td>(StrOpt) The SQLAlchemy connection string to use to connect to the database.</td>
+ </tr>
+ <tr>
+ <td>connection_debug = 0</td>
+ <td>(IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything.</td>
+ </tr>
+ <tr>
+ <td>connection_trace = False</td>
+ <td>(BoolOpt) Add Python stack traces to SQL as comment strings.</td>
+ </tr>
+ <tr>
+ <td>db_inc_retry_interval = True</td>
+ <td>(BoolOpt) If True, increases the interval between database connection retries up to db_max_retry_interval.</td>
+ </tr>
+ <tr>
+ <td>db_max_retries = 20</td>
+ <td>(IntOpt) Maximum database connection retries before error is raised. Set to -1 to specify an infinite retry count.</td>
+ </tr>
+ <tr>
+ <td>db_max_retry_interval = 10</td>
+ <td>(IntOpt) If db_inc_retry_interval is set, the maximum seconds between database connection retries.</td>
+ </tr>
+ <tr>
+ <td>db_retry_interval = 1</td>
+ <td>(IntOpt) Seconds between database connection retries.</td>
+ </tr>
+ <tr>
+ <td>idle_timeout = 3600</td>
+ <td>(IntOpt) Timeout before idle SQL connections are reaped.</td>
+ </tr>
+ <tr>
+ <td>max_overflow = None</td>
+ <td>(IntOpt) If set, use this value for max_overflow with SQLAlchemy.</td>
+ </tr>
+ <tr>
+ <td>max_pool_size = None</td>
+ <td>(IntOpt) Maximum number of SQL connections to keep open in a pool.</td>
+ </tr>
+ <tr>
+ <td>max_retries = 10</td>
+ <td>(IntOpt) Maximum db connection retries during startup. Set to -1 to specify an infinite retry count.</td>
+ </tr>
+ <tr>
+ <td>min_pool_size = 1</td>
+ <td>(IntOpt) Minimum number of SQL connections to keep open in a pool.</td>
+ </tr>
+ <tr>
+ <td>mysql_sql_mode = TRADITIONAL</td>
+ <td>(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=</td>
+ </tr>
+ <tr>
+ <td>pool_timeout = None</td>
+ <td>(IntOpt) If set, use this value for pool_timeout with SQLAlchemy.</td>
+ </tr>
+ <tr>
+ <td>retry_interval = 10</td>
+ <td>(IntOpt) Interval between retries of opening a SQL connection.</td>
+ </tr>
+ <tr>
+ <td>slave_connection = None</td>
+ <td>(StrOpt) The SQLAlchemy connection string to use to connect to the slave database.</td>
+ </tr>
+ <tr>
+ <td>sqlite_db = oslo.sqlite</td>
+ <td>(StrOpt) The file name to use with SQLite.</td>
+ </tr>
+ <tr>
+ <td>sqlite_synchronous = True</td>
+ <td>(BoolOpt) If True, SQLite uses synchronous mode.</td>
+ </tr>
+ <tr>
+ <td>use_db_reconnect = False</td>
+ <td>(BoolOpt) Enable the experimental use of database reconnect on connection lost.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/keystone-debug.xml b/doc/common/tables/keystone-debug.xml
index 6d464db2a9..1ef0525bff 100644
--- a/doc/common/tables/keystone-debug.xml
+++ b/doc/common/tables/keystone-debug.xml
@@ -1,62 +1,61 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_keystone_debug">
- <caption>Description of configuration options for debug</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>backdoor_port = None</td>
- <td>(StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.</td>
- </tr>
- <tr>
- <td>debug = False</td>
- <td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).</td>
- </tr>
- <tr>
- <td>disable_process_locking = False</td>
- <td>(BoolOpt) Whether to disable inter-process locks</td>
- </tr>
- <tr>
- <td>fatal_deprecations = False</td>
- <td>(BoolOpt) Make deprecations fatal</td>
- </tr>
- <tr>
- <td>publish_errors = False</td>
- <td>(BoolOpt) Publish error events</td>
- </tr>
- <tr>
- <td>pydev_debug_host = None</td>
- <td>(StrOpt) Host to connect to for remote debugger.</td>
- </tr>
- <tr>
- <td>pydev_debug_port = None</td>
- <td>(IntOpt) Port to connect to for remote debugger.</td>
- </tr>
- <tr>
- <td>standard_threads = False</td>
- <td>(BoolOpt) Do not monkey-patch threading system modules.</td>
- </tr>
- <tr>
- <th colspan="2">[audit]</th>
- </tr>
- <tr>
- <td>namespace = openstack</td>
- <td>(StrOpt) namespace prefix for generated id</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_keystone_debug">
+ <caption>Description of configuration options for debug</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>backdoor_port = None</td>
+ <td>(StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.</td>
+ </tr>
+ <tr>
+ <td>debug = False</td>
+ <td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).</td>
+ </tr>
+ <tr>
+ <td>disable_process_locking = False</td>
+ <td>(BoolOpt) Enables or disables inter-process locks.</td>
+ </tr>
+ <tr>
+ <td>fatal_deprecations = False</td>
+ <td>(BoolOpt) Enables or disables fatal status of deprecations.</td>
+ </tr>
+ <tr>
+ <td>publish_errors = False</td>
+ <td>(BoolOpt) Enables or disables publication of error events.</td>
+ </tr>
+ <tr>
+ <td>pydev_debug_host = None</td>
+ <td>(StrOpt) Host to connect to for remote debugger.</td>
+ </tr>
+ <tr>
+ <td>pydev_debug_port = None</td>
+ <td>(IntOpt) Port to connect to for remote debugger.</td>
+ </tr>
+ <tr>
+ <td>standard_threads = False</td>
+ <td>(BoolOpt) Do not monkey-patch threading system modules.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[audit]</th>
+ </tr>
+ <tr>
+ <td>namespace = openstack</td>
+ <td>(StrOpt) namespace prefix for generated id</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/keystone-ec2.xml b/doc/common/tables/keystone-ec2.xml
index f01e222aef..823af8b24c 100644
--- a/doc/common/tables/keystone-ec2.xml
+++ b/doc/common/tables/keystone-ec2.xml
@@ -1,50 +1,49 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_keystone_ec2">
- <caption>Description of configuration options for ec2</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>keystone_ec2_cafile = None</td>
- <td>(StrOpt) A PEM encoded certificate authority to use when verifying HTTPS connections. Defaults to the system CAs.</td>
- </tr>
- <tr>
- <td>keystone_ec2_certfile = None</td>
- <td>(StrOpt) Client certificate key filename. Required if EC2 server requires client certificate.</td>
- </tr>
- <tr>
- <td>keystone_ec2_insecure = False</td>
- <td>(BoolOpt) Disable SSL certificate verification.</td>
- </tr>
- <tr>
- <td>keystone_ec2_keyfile = None</td>
- <td>(StrOpt) Required if EC2 server requires client certificate.</td>
- </tr>
- <tr>
- <td>keystone_ec2_url = http://localhost:5000/v2.0/ec2tokens</td>
- <td>(StrOpt) URL to get token from ec2 request.</td>
- </tr>
- <tr>
- <th colspan="2">[ec2]</th>
- </tr>
- <tr>
- <td>driver = keystone.contrib.ec2.backends.kvs.Ec2</td>
- <td>(StrOpt) Keystone EC2Credential backend driver.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_keystone_ec2">
+ <caption>Description of configuration options for ec2</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>keystone_ec2_cafile = None</td>
+ <td>(StrOpt) A PEM encoded certificate authority to use when verifying HTTPS connections. Defaults to the system CAs.</td>
+ </tr>
+ <tr>
+ <td>keystone_ec2_certfile = None</td>
+ <td>(StrOpt) Client certificate key filename. Required if EC2 server requires client certificate.</td>
+ </tr>
+ <tr>
+ <td>keystone_ec2_insecure = False</td>
+ <td>(BoolOpt) Disable SSL certificate verification.</td>
+ </tr>
+ <tr>
+ <td>keystone_ec2_keyfile = None</td>
+ <td>(StrOpt) Required if EC2 server requires client certificate.</td>
+ </tr>
+ <tr>
+ <td>keystone_ec2_url = http://localhost:5000/v2.0/ec2tokens</td>
+ <td>(StrOpt) URL to get token from ec2 request.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[ec2]</th>
+ </tr>
+ <tr>
+ <td>driver = keystone.contrib.ec2.backends.kvs.Ec2</td>
+ <td>(StrOpt) EC2Credential backend driver.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/keystone-federation.xml b/doc/common/tables/keystone-federation.xml
index a1ef26ff16..43cfb71665 100644
--- a/doc/common/tables/keystone-federation.xml
+++ b/doc/common/tables/keystone-federation.xml
@@ -1,31 +1,30 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_keystone_federation">
- <caption>Description of configuration options for federation</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">[federation]</th>
- </tr>
- <tr>
- <td>assertion_prefix = </td>
- <td>(StrOpt) Value to be used when filtering assertion parameters from the environment.</td>
- </tr>
- <tr>
- <td>driver = keystone.contrib.federation.backends.sql.Federation</td>
- <td>(StrOpt) Keystone Federation backend driver.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_keystone_federation">
+ <caption>Description of configuration options for federation</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">[federation]</th>
+ </tr>
+ <tr>
+ <td>assertion_prefix = </td>
+ <td>(StrOpt) Value to be used when filtering assertion parameters from the environment.</td>
+ </tr>
+ <tr>
+ <td>driver = keystone.contrib.federation.backends.sql.Federation</td>
+ <td>(StrOpt) Federation backend driver.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/keystone-identity.xml b/doc/common/tables/keystone-identity.xml
index b0fec2964c..69b6f1ef68 100644
--- a/doc/common/tables/keystone-identity.xml
+++ b/doc/common/tables/keystone-identity.xml
@@ -1,47 +1,46 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_keystone_identity">
- <caption>Description of configuration options for identity</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">[identity]</th>
- </tr>
- <tr>
- <td>default_domain_id = default</td>
- <td>(StrOpt) This references the domain to use for all Identity API v2 requests (which are not aware of domains). A domain with this ID will be created for you by keystone-manage db_sync in migration 008. The domain referenced by this ID cannot be deleted on the v3 API, to prevent accidentally breaking the v2 API. There is nothing special about this domain, other than the fact that it must exist to order to maintain support for your v2 clients.</td>
- </tr>
- <tr>
- <td>domain_config_dir = /etc/keystone/domains</td>
- <td>(StrOpt) Path for Keystone to locate the domain specificidentity configuration files if domain_specific_drivers_enabled is set to true.</td>
- </tr>
- <tr>
- <td>domain_specific_drivers_enabled = False</td>
- <td>(BoolOpt) A subset (or all) of domains can have their own identity driver, each with their own partial configuration file in a domain configuration directory. Only values specific to the domain need to be placed in the domain specific configuration file. This feature is disabled by default; set to True to enable.</td>
- </tr>
- <tr>
- <td>driver = keystone.identity.backends.sql.Identity</td>
- <td>(StrOpt) Keystone Identity backend driver.</td>
- </tr>
- <tr>
- <td>list_limit = None</td>
- <td>(IntOpt) Maximum number of entities that will be returned in an identity collection.</td>
- </tr>
- <tr>
- <td>max_password_length = 4096</td>
- <td>(IntOpt) Maximum supported length for user passwords; decrease to improve performance.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_keystone_identity">
+ <caption>Description of configuration options for identity</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">[identity]</th>
+ </tr>
+ <tr>
+ <td>default_domain_id = default</td>
+ <td>(StrOpt) This references the domain to use for all Identity API v2 requests (which are not aware of domains). A domain with this ID will be created for you by keystone-manage db_sync in migration 008. The domain referenced by this ID cannot be deleted on the v3 API, to prevent accidentally breaking the v2 API. There is nothing special about this domain, other than the fact that it must exist to order to maintain support for your v2 clients.</td>
+ </tr>
+ <tr>
+ <td>domain_config_dir = /etc/keystone/domains</td>
+ <td>(StrOpt) Path for Keystone to locate the domain specific identity configuration files if domain_specific_drivers_enabled is set to true.</td>
+ </tr>
+ <tr>
+ <td>domain_specific_drivers_enabled = False</td>
+ <td>(BoolOpt) A subset (or all) of domains can have their own identity driver, each with their own partial configuration file in a domain configuration directory. Only values specific to the domain need to be placed in the domain specific configuration file. This feature is disabled by default; set to true to enable.</td>
+ </tr>
+ <tr>
+ <td>driver = keystone.identity.backends.sql.Identity</td>
+ <td>(StrOpt) Identity backend driver.</td>
+ </tr>
+ <tr>
+ <td>list_limit = None</td>
+ <td>(IntOpt) Maximum number of entities that will be returned in an identity collection.</td>
+ </tr>
+ <tr>
+ <td>max_password_length = 4096</td>
+ <td>(IntOpt) Maximum supported length for user passwords; decrease to improve performance.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/keystone-kvs.xml b/doc/common/tables/keystone-kvs.xml
index 54178b7eec..5b12481da8 100644
--- a/doc/common/tables/keystone-kvs.xml
+++ b/doc/common/tables/keystone-kvs.xml
@@ -1,39 +1,38 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_keystone_kvs">
- <caption>Description of configuration options for kvs</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">[kvs]</th>
- </tr>
- <tr>
- <td>backends = </td>
- <td>(ListOpt) Extra dogpile.cache backend modules to register with the dogpile.cache library.</td>
- </tr>
- <tr>
- <td>config_prefix = keystone.kvs</td>
- <td>(StrOpt) Prefix for building the configuration dictionary for the KVS region. This should not need to be changed unless there is another dogpile.cache region with the same configuration name.</td>
- </tr>
- <tr>
- <td>default_lock_timeout = 5</td>
- <td>(IntOpt) Default lock timeout for distributed locking.</td>
- </tr>
- <tr>
- <td>enable_key_mangler = True</td>
- <td>(BoolOpt) Toggle to disable using a key-mangling function to ensure fixed length keys. This is toggle-able for debugging purposes, it is highly recommended to always leave this set to True.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_keystone_kvs">
+ <caption>Description of configuration options for kvs</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">[kvs]</th>
+ </tr>
+ <tr>
+ <td>backends = </td>
+ <td>(ListOpt) Extra dogpile.cache backend modules to register with the dogpile.cache library.</td>
+ </tr>
+ <tr>
+ <td>config_prefix = keystone.kvs</td>
+ <td>(StrOpt) Prefix for building the configuration dictionary for the KVS region. This should not need to be changed unless there is another dogpile.cache region with the same configuration name.</td>
+ </tr>
+ <tr>
+ <td>default_lock_timeout = 5</td>
+ <td>(IntOpt) Default lock timeout for distributed locking.</td>
+ </tr>
+ <tr>
+ <td>enable_key_mangler = True</td>
+ <td>(BoolOpt) Toggle to disable using a key-mangling function to ensure fixed length keys. This is toggle-able for debugging purposes, it is highly recommended to always leave this set to true.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/keystone-ldap.xml b/doc/common/tables/keystone-ldap.xml
index aae003ef96..80227ab8de 100644
--- a/doc/common/tables/keystone-ldap.xml
+++ b/doc/common/tables/keystone-ldap.xml
@@ -1,311 +1,314 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_keystone_ldap">
- <caption>Description of configuration options for ldap</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">[ldap]</th>
- </tr>
- <tr>
- <td>alias_dereferencing = default</td>
- <td>(StrOpt) The LDAP dereferencing option for queries. This can be either "never", "searching", "always", "finding" or "default". The "default" option falls back to using default dereferencing configured by your ldap.conf.</td>
- </tr>
- <tr>
- <td>allow_subtree_delete = False</td>
- <td>(BoolOpt) allow deleting subtrees.</td>
- </tr>
- <tr>
- <td>chase_referrals = None</td>
- <td>(BoolOpt) Override the system's default referral chasing behavior for queries.</td>
- </tr>
- <tr>
- <td>dumb_member = cn=dumb,dc=nonexistent</td>
- <td>(StrOpt) DN of the "dummy member" to use when "use_dumb_member" is enabled.</td>
- </tr>
- <tr>
- <td>group_additional_attribute_mapping = </td>
- <td>(ListOpt) Additional attribute mappings for groups. Attribute mapping format is <ldap_attr>:<user_attr>, where ldap_attr is the attribute in the LDAP entry and user_attr is the Identity API attribute.</td>
- </tr>
- <tr>
- <td>group_allow_create = True</td>
- <td>(BoolOpt) Allow group creation in LDAP backend.</td>
- </tr>
- <tr>
- <td>group_allow_delete = True</td>
- <td>(BoolOpt) Allow group deletion in LDAP backend.</td>
- </tr>
- <tr>
- <td>group_allow_update = True</td>
- <td>(BoolOpt) Allow group update in LDAP backend.</td>
- </tr>
- <tr>
- <td>group_attribute_ignore = </td>
- <td>(ListOpt) List of attributes stripped off the group on update.</td>
- </tr>
- <tr>
- <td>group_desc_attribute = description</td>
- <td>(StrOpt) LDAP attribute mapped to group description.</td>
- </tr>
- <tr>
- <td>group_filter = None</td>
- <td>(StrOpt) LDAP search filter for groups.</td>
- </tr>
- <tr>
- <td>group_id_attribute = cn</td>
- <td>(StrOpt) LDAP attribute mapped to group id.</td>
- </tr>
- <tr>
- <td>group_member_attribute = member</td>
- <td>(StrOpt) LDAP attribute mapped to show group membership.</td>
- </tr>
- <tr>
- <td>group_name_attribute = ou</td>
- <td>(StrOpt) LDAP attribute mapped to group name.</td>
- </tr>
- <tr>
- <td>group_objectclass = groupOfNames</td>
- <td>(StrOpt) LDAP objectClass for groups.</td>
- </tr>
- <tr>
- <td>group_tree_dn = None</td>
- <td>(StrOpt) Search base for groups.</td>
- </tr>
- <tr>
- <td>page_size = 0</td>
- <td>(IntOpt) Maximum results per page; a value of zero ("0") disables paging.</td>
- </tr>
- <tr>
- <td>password = None</td>
- <td>(StrOpt) Password for the BindDN to query the LDAP server.</td>
- </tr>
- <tr>
- <td>query_scope = one</td>
- <td>(StrOpt) The LDAP scope for queries, this can be either "one" (onelevel/singleLevel) or "sub" (subtree/wholeSubtree).</td>
- </tr>
- <tr>
- <td>role_additional_attribute_mapping = </td>
- <td>(ListOpt) Additional attribute mappings for roles. Attribute mapping format is <ldap_attr>:<user_attr>, where ldap_attr is the attribute in the LDAP entry and user_attr is the Identity API attribute.</td>
- </tr>
- <tr>
- <td>role_allow_create = True</td>
- <td>(BoolOpt) Allow role creation in LDAP backend.</td>
- </tr>
- <tr>
- <td>role_allow_delete = True</td>
- <td>(BoolOpt) Allow role deletion in LDAP backend.</td>
- </tr>
- <tr>
- <td>role_allow_update = True</td>
- <td>(BoolOpt) Allow role update in LDAP backend.</td>
- </tr>
- <tr>
- <td>role_attribute_ignore = </td>
- <td>(ListOpt) List of attributes stripped off the role on update.</td>
- </tr>
- <tr>
- <td>role_filter = None</td>
- <td>(StrOpt) LDAP search filter for roles.</td>
- </tr>
- <tr>
- <td>role_id_attribute = cn</td>
- <td>(StrOpt) LDAP attribute mapped to role id.</td>
- </tr>
- <tr>
- <td>role_member_attribute = roleOccupant</td>
- <td>(StrOpt) LDAP attribute mapped to role membership.</td>
- </tr>
- <tr>
- <td>role_name_attribute = ou</td>
- <td>(StrOpt) LDAP attribute mapped to role name.</td>
- </tr>
- <tr>
- <td>role_objectclass = organizationalRole</td>
- <td>(StrOpt) LDAP objectClass for roles.</td>
- </tr>
- <tr>
- <td>role_tree_dn = None</td>
- <td>(StrOpt) Search base for roles.</td>
- </tr>
- <tr>
- <td>suffix = cn=example,cn=com</td>
- <td>(StrOpt) LDAP server suffix</td>
- </tr>
- <tr>
- <td>tenant_additional_attribute_mapping = </td>
- <td>(ListOpt) Additional attribute mappings for projects. Attribute mapping format is <ldap_attr>:<user_attr>, where ldap_attr is the attribute in the LDAP entry and user_attr is the Identity API attribute.</td>
- </tr>
- <tr>
- <td>tenant_allow_create = True</td>
- <td>(BoolOpt) Allow tenant creation in LDAP backend.</td>
- </tr>
- <tr>
- <td>tenant_allow_delete = True</td>
- <td>(BoolOpt) Allow tenant deletion in LDAP backend.</td>
- </tr>
- <tr>
- <td>tenant_allow_update = True</td>
- <td>(BoolOpt) Allow tenant update in LDAP backend.</td>
- </tr>
- <tr>
- <td>tenant_attribute_ignore = </td>
- <td>(ListOpt) List of attributes stripped off the project on update.</td>
- </tr>
- <tr>
- <td>tenant_desc_attribute = description</td>
- <td>(StrOpt) LDAP attribute mapped to project description.</td>
- </tr>
- <tr>
- <td>tenant_domain_id_attribute = businessCategory</td>
- <td>(StrOpt) LDAP attribute mapped to project domain_id.</td>
- </tr>
- <tr>
- <td>tenant_enabled_attribute = enabled</td>
- <td>(StrOpt) LDAP attribute mapped to project enabled.</td>
- </tr>
- <tr>
- <td>tenant_enabled_emulation = False</td>
- <td>(BoolOpt) If True, Keystone uses an alternative method to determine if a project is enabled or not by checking if they are a member of the "tenant_enabled_emulation_dn" group.</td>
- </tr>
- <tr>
- <td>tenant_enabled_emulation_dn = None</td>
- <td>(StrOpt) DN of the group entry to hold enabled projects when using enabled emulation.</td>
- </tr>
- <tr>
- <td>tenant_filter = None</td>
- <td>(StrOpt) LDAP search filter for projects.</td>
- </tr>
- <tr>
- <td>tenant_id_attribute = cn</td>
- <td>(StrOpt) LDAP attribute mapped to project id.</td>
- </tr>
- <tr>
- <td>tenant_member_attribute = member</td>
- <td>(StrOpt) LDAP attribute mapped to project membership for user.</td>
- </tr>
- <tr>
- <td>tenant_name_attribute = ou</td>
- <td>(StrOpt) LDAP attribute mapped to project name.</td>
- </tr>
- <tr>
- <td>tenant_objectclass = groupOfNames</td>
- <td>(StrOpt) LDAP objectClass for projects.</td>
- </tr>
- <tr>
- <td>tenant_tree_dn = None</td>
- <td>(StrOpt) Search base for projects</td>
- </tr>
- <tr>
- <td>tls_cacertdir = None</td>
- <td>(StrOpt) CA certificate directory path for communicating with LDAP servers.</td>
- </tr>
- <tr>
- <td>tls_cacertfile = None</td>
- <td>(StrOpt) CA certificate file path for communicating with LDAP servers.</td>
- </tr>
- <tr>
- <td>tls_req_cert = demand</td>
- <td>(StrOpt) valid options for tls_req_cert are demand, never, and allow.</td>
- </tr>
- <tr>
- <td>url = ldap://localhost</td>
- <td>(StrOpt) URL for connecting to the LDAP server.</td>
- </tr>
- <tr>
- <td>use_dumb_member = False</td>
- <td>(BoolOpt) If true, will add a dummy member to groups. This is required if the objectclass for groups requires the "member" attribute.</td>
- </tr>
- <tr>
- <td>use_tls = False</td>
- <td>(BoolOpt) Enable TLS for communicating with LDAP servers.</td>
- </tr>
- <tr>
- <td>user = None</td>
- <td>(StrOpt) User BindDN to query the LDAP server.</td>
- </tr>
- <tr>
- <td>user_additional_attribute_mapping = </td>
- <td>(ListOpt) List of additional LDAP attributes used for mapping Additional attribute mappings for users. Attribute mapping format is <ldap_attr>:<user_attr>, where ldap_attr is the attribute in the LDAP entry and user_attr is the Identity API attribute.</td>
- </tr>
- <tr>
- <td>user_allow_create = True</td>
- <td>(BoolOpt) Allow user creation in LDAP backend.</td>
- </tr>
- <tr>
- <td>user_allow_delete = True</td>
- <td>(BoolOpt) Allow user deletion in LDAP backend.</td>
- </tr>
- <tr>
- <td>user_allow_update = True</td>
- <td>(BoolOpt) Allow user updates in LDAP backend.</td>
- </tr>
- <tr>
- <td>user_attribute_ignore = default_project_id, tenants</td>
- <td>(ListOpt) List of attributes stripped off the user on update.</td>
- </tr>
- <tr>
- <td>user_default_project_id_attribute = None</td>
- <td>(StrOpt) LDAP attribute mapped to default_project_id for users.</td>
- </tr>
- <tr>
- <td>user_enabled_attribute = enabled</td>
- <td>(StrOpt) LDAP attribute mapped to user enabled flag.</td>
- </tr>
- <tr>
- <td>user_enabled_default = True</td>
- <td>(StrOpt) Default value to enable users. This should match an appropriate int value if the LDAP server uses non-boolean (bitmask) values to indicate if a user is enabled or disabled. If this is not set to "True"the typical value is "512". This is typically used when "user_enabled_attribute = userAccountControl".</td>
- </tr>
- <tr>
- <td>user_enabled_emulation = False</td>
- <td>(BoolOpt) If True, Keystone uses an alternative method to determine if a user is enabled or not by checking if they are a member of the "user_enabled_emulation_dn" group.</td>
- </tr>
- <tr>
- <td>user_enabled_emulation_dn = None</td>
- <td>(StrOpt) DN of the group entry to hold enabled users when using enabled emulation.</td>
- </tr>
- <tr>
- <td>user_enabled_mask = 0</td>
- <td>(IntOpt) Bitmask integer to indicate the bit that the enabled value is stored in if the LDAP server represents "enabled" as a bit on an integer rather than a boolean. A value of "0" indicates the mask is not used. If this is not set to "0" the typical value is "2". This is typically used when "user_enabled_attribute = userAccountControl".</td>
- </tr>
- <tr>
- <td>user_filter = None</td>
- <td>(StrOpt) LDAP search filter for users.</td>
- </tr>
- <tr>
- <td>user_id_attribute = cn</td>
- <td>(StrOpt) LDAP attribute mapped to user id.</td>
- </tr>
- <tr>
- <td>user_mail_attribute = email</td>
- <td>(StrOpt) LDAP attribute mapped to user email.</td>
- </tr>
- <tr>
- <td>user_name_attribute = sn</td>
- <td>(StrOpt) LDAP attribute mapped to user name.</td>
- </tr>
- <tr>
- <td>user_objectclass = inetOrgPerson</td>
- <td>(StrOpt) LDAP objectClass for users.</td>
- </tr>
- <tr>
- <td>user_pass_attribute = userPassword</td>
- <td>(StrOpt) LDAP attribute mapped to password.</td>
- </tr>
- <tr>
- <td>user_tree_dn = None</td>
- <td>(StrOpt) Search base for users.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_keystone_ldap">
+ <caption>Description of configuration options for ldap</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">[ldap]</th>
+ </tr>
+ <tr>
+ <td>alias_dereferencing = default</td>
+ <td>(StrOpt) The LDAP dereferencing option for queries. This can be either "never", "searching", "always", "finding" or "default". The "default" option falls back to using default dereferencing configured by your ldap.conf.</td>
+ </tr>
+ <tr>
+ <td>allow_subtree_delete = False</td>
+ <td>(BoolOpt) Delete subtrees using the subtree delete control. Only enable this option if your LDAP server supports subtree deletion.</td>
+ </tr>
+ <tr>
+ <td>chase_referrals = None</td>
+ <td>(BoolOpt) Override the system's default referral chasing behavior for queries.</td>
+ </tr>
+ <tr>
+ <td>debug_level = None</td>
+ <td>(IntOpt) Sets the LDAP debugging level for LDAP calls. A value of 0 means that debugging is not enabled. This value is a bitmask, consult your LDAP documentation for possible values.</td>
+ </tr>
+ <tr>
+ <td>dumb_member = cn=dumb,dc=nonexistent</td>
+ <td>(StrOpt) DN of the "dummy member" to use when "use_dumb_member" is enabled.</td>
+ </tr>
+ <tr>
+ <td>group_additional_attribute_mapping = </td>
+ <td>(ListOpt) Additional attribute mappings for groups. Attribute mapping format is <ldap_attr>:<user_attr>, where ldap_attr is the attribute in the LDAP entry and user_attr is the Identity API attribute.</td>
+ </tr>
+ <tr>
+ <td>group_allow_create = True</td>
+ <td>(BoolOpt) Allow group creation in LDAP backend.</td>
+ </tr>
+ <tr>
+ <td>group_allow_delete = True</td>
+ <td>(BoolOpt) Allow group deletion in LDAP backend.</td>
+ </tr>
+ <tr>
+ <td>group_allow_update = True</td>
+ <td>(BoolOpt) Allow group update in LDAP backend.</td>
+ </tr>
+ <tr>
+ <td>group_attribute_ignore = </td>
+ <td>(ListOpt) List of attributes stripped off the group on update.</td>
+ </tr>
+ <tr>
+ <td>group_desc_attribute = description</td>
+ <td>(StrOpt) LDAP attribute mapped to group description.</td>
+ </tr>
+ <tr>
+ <td>group_filter = None</td>
+ <td>(StrOpt) LDAP search filter for groups.</td>
+ </tr>
+ <tr>
+ <td>group_id_attribute = cn</td>
+ <td>(StrOpt) LDAP attribute mapped to group id.</td>
+ </tr>
+ <tr>
+ <td>group_member_attribute = member</td>
+ <td>(StrOpt) LDAP attribute mapped to show group membership.</td>
+ </tr>
+ <tr>
+ <td>group_name_attribute = ou</td>
+ <td>(StrOpt) LDAP attribute mapped to group name.</td>
+ </tr>
+ <tr>
+ <td>group_objectclass = groupOfNames</td>
+ <td>(StrOpt) LDAP objectclass for groups.</td>
+ </tr>
+ <tr>
+ <td>group_tree_dn = None</td>
+ <td>(StrOpt) Search base for groups.</td>
+ </tr>
+ <tr>
+ <td>page_size = 0</td>
+ <td>(IntOpt) Maximum results per page; a value of zero ("0") disables paging.</td>
+ </tr>
+ <tr>
+ <td>password = None</td>
+ <td>(StrOpt) Password for the BindDN to query the LDAP server.</td>
+ </tr>
+ <tr>
+ <td>project_additional_attribute_mapping = </td>
+ <td>(ListOpt) Additional attribute mappings for projects. Attribute mapping format is <ldap_attr>:<user_attr>, where ldap_attr is the attribute in the LDAP entry and user_attr is the Identity API attribute.</td>
+ </tr>
+ <tr>
+ <td>project_allow_create = True</td>
+ <td>(BoolOpt) Allow project creation in LDAP backend.</td>
+ </tr>
+ <tr>
+ <td>project_allow_delete = True</td>
+ <td>(BoolOpt) Allow project deletion in LDAP backend.</td>
+ </tr>
+ <tr>
+ <td>project_allow_update = True</td>
+ <td>(BoolOpt) Allow project update in LDAP backend.</td>
+ </tr>
+ <tr>
+ <td>project_attribute_ignore = </td>
+ <td>(ListOpt) List of attributes stripped off the project on update.</td>
+ </tr>
+ <tr>
+ <td>project_desc_attribute = description</td>
+ <td>(StrOpt) LDAP attribute mapped to project description.</td>
+ </tr>
+ <tr>
+ <td>project_domain_id_attribute = businessCategory</td>
+ <td>(StrOpt) LDAP attribute mapped to project domain_id.</td>
+ </tr>
+ <tr>
+ <td>project_enabled_attribute = enabled</td>
+ <td>(StrOpt) LDAP attribute mapped to project enabled.</td>
+ </tr>
+ <tr>
+ <td>project_enabled_emulation = False</td>
+ <td>(BoolOpt) If true, Keystone uses an alternative method to determine if a project is enabled or not by checking if they are a member of the "project_enabled_emulation_dn" group.</td>
+ </tr>
+ <tr>
+ <td>project_enabled_emulation_dn = None</td>
+ <td>(StrOpt) DN of the group entry to hold enabled projects when using enabled emulation.</td>
+ </tr>
+ <tr>
+ <td>project_filter = None</td>
+ <td>(StrOpt) LDAP search filter for projects.</td>
+ </tr>
+ <tr>
+ <td>project_id_attribute = cn</td>
+ <td>(StrOpt) LDAP attribute mapped to project id.</td>
+ </tr>
+ <tr>
+ <td>project_member_attribute = member</td>
+ <td>(StrOpt) LDAP attribute mapped to project membership for user.</td>
+ </tr>
+ <tr>
+ <td>project_name_attribute = ou</td>
+ <td>(StrOpt) LDAP attribute mapped to project name.</td>
+ </tr>
+ <tr>
+ <td>project_objectclass = groupOfNames</td>
+ <td>(StrOpt) LDAP objectclass for projects.</td>
+ </tr>
+ <tr>
+ <td>project_tree_dn = None</td>
+ <td>(StrOpt) Search base for projects</td>
+ </tr>
+ <tr>
+ <td>query_scope = one</td>
+ <td>(StrOpt) The LDAP scope for queries, this can be either "one" (onelevel/singleLevel) or "sub" (subtree/wholeSubtree).</td>
+ </tr>
+ <tr>
+ <td>role_additional_attribute_mapping = </td>
+ <td>(ListOpt) Additional attribute mappings for roles. Attribute mapping format is <ldap_attr>:<user_attr>, where ldap_attr is the attribute in the LDAP entry and user_attr is the Identity API attribute.</td>
+ </tr>
+ <tr>
+ <td>role_allow_create = True</td>
+ <td>(BoolOpt) Allow role creation in LDAP backend.</td>
+ </tr>
+ <tr>
+ <td>role_allow_delete = True</td>
+ <td>(BoolOpt) Allow role deletion in LDAP backend.</td>
+ </tr>
+ <tr>
+ <td>role_allow_update = True</td>
+ <td>(BoolOpt) Allow role update in LDAP backend.</td>
+ </tr>
+ <tr>
+ <td>role_attribute_ignore = </td>
+ <td>(ListOpt) List of attributes stripped off the role on update.</td>
+ </tr>
+ <tr>
+ <td>role_filter = None</td>
+ <td>(StrOpt) LDAP search filter for roles.</td>
+ </tr>
+ <tr>
+ <td>role_id_attribute = cn</td>
+ <td>(StrOpt) LDAP attribute mapped to role id.</td>
+ </tr>
+ <tr>
+ <td>role_member_attribute = roleOccupant</td>
+ <td>(StrOpt) LDAP attribute mapped to role membership.</td>
+ </tr>
+ <tr>
+ <td>role_name_attribute = ou</td>
+ <td>(StrOpt) LDAP attribute mapped to role name.</td>
+ </tr>
+ <tr>
+ <td>role_objectclass = organizationalRole</td>
+ <td>(StrOpt) LDAP objectclass for roles.</td>
+ </tr>
+ <tr>
+ <td>role_tree_dn = None</td>
+ <td>(StrOpt) Search base for roles.</td>
+ </tr>
+ <tr>
+ <td>suffix = cn=example,cn=com</td>
+ <td>(StrOpt) LDAP server suffix</td>
+ </tr>
+ <tr>
+ <td>tls_cacertdir = None</td>
+ <td>(StrOpt) CA certificate directory path for communicating with LDAP servers.</td>
+ </tr>
+ <tr>
+ <td>tls_cacertfile = None</td>
+ <td>(StrOpt) CA certificate file path for communicating with LDAP servers.</td>
+ </tr>
+ <tr>
+ <td>tls_req_cert = demand</td>
+ <td>(StrOpt) Valid options for tls_req_cert are demand, never, and allow.</td>
+ </tr>
+ <tr>
+ <td>url = ldap://localhost</td>
+ <td>(StrOpt) URL for connecting to the LDAP server.</td>
+ </tr>
+ <tr>
+ <td>use_dumb_member = False</td>
+ <td>(BoolOpt) If true, will add a dummy member to groups. This is required if the objectclass for groups requires the "member" attribute.</td>
+ </tr>
+ <tr>
+ <td>use_tls = False</td>
+ <td>(BoolOpt) Enable TLS for communicating with LDAP servers.</td>
+ </tr>
+ <tr>
+ <td>user = None</td>
+ <td>(StrOpt) User BindDN to query the LDAP server.</td>
+ </tr>
+ <tr>
+ <td>user_additional_attribute_mapping = </td>
+ <td>(ListOpt) List of additional LDAP attributes used for mapping additional attribute mappings for users. Attribute mapping format is <ldap_attr>:<user_attr>, where ldap_attr is the attribute in the LDAP entry and user_attr is the Identity API attribute.</td>
+ </tr>
+ <tr>
+ <td>user_allow_create = True</td>
+ <td>(BoolOpt) Allow user creation in LDAP backend.</td>
+ </tr>
+ <tr>
+ <td>user_allow_delete = True</td>
+ <td>(BoolOpt) Allow user deletion in LDAP backend.</td>
+ </tr>
+ <tr>
+ <td>user_allow_update = True</td>
+ <td>(BoolOpt) Allow user updates in LDAP backend.</td>
+ </tr>
+ <tr>
+ <td>user_attribute_ignore = default_project_id, tenants</td>
+ <td>(ListOpt) List of attributes stripped off the user on update.</td>
+ </tr>
+ <tr>
+ <td>user_default_project_id_attribute = None</td>
+ <td>(StrOpt) LDAP attribute mapped to default_project_id for users.</td>
+ </tr>
+ <tr>
+ <td>user_enabled_attribute = enabled</td>
+ <td>(StrOpt) LDAP attribute mapped to user enabled flag.</td>
+ </tr>
+ <tr>
+ <td>user_enabled_default = True</td>
+ <td>(StrOpt) Default value to enable users. This should match an appropriate int value if the LDAP server uses non-boolean (bitmask) values to indicate if a user is enabled or disabled. If this is not set to "True" the typical value is "512". This is typically used when "user_enabled_attribute = userAccountControl".</td>
+ </tr>
+ <tr>
+ <td>user_enabled_emulation = False</td>
+ <td>(BoolOpt) If true, Keystone uses an alternative method to determine if a user is enabled or not by checking if they are a member of the "user_enabled_emulation_dn" group.</td>
+ </tr>
+ <tr>
+ <td>user_enabled_emulation_dn = None</td>
+ <td>(StrOpt) DN of the group entry to hold enabled users when using enabled emulation.</td>
+ </tr>
+ <tr>
+ <td>user_enabled_mask = 0</td>
+ <td>(IntOpt) Bitmask integer to indicate the bit that the enabled value is stored in if the LDAP server represents "enabled" as a bit on an integer rather than a boolean. A value of "0" indicates the mask is not used. If this is not set to "0" the typical value is "2". This is typically used when "user_enabled_attribute = userAccountControl".</td>
+ </tr>
+ <tr>
+ <td>user_filter = None</td>
+ <td>(StrOpt) LDAP search filter for users.</td>
+ </tr>
+ <tr>
+ <td>user_id_attribute = cn</td>
+ <td>(StrOpt) LDAP attribute mapped to user id.</td>
+ </tr>
+ <tr>
+ <td>user_mail_attribute = email</td>
+ <td>(StrOpt) LDAP attribute mapped to user email.</td>
+ </tr>
+ <tr>
+ <td>user_name_attribute = sn</td>
+ <td>(StrOpt) LDAP attribute mapped to user name.</td>
+ </tr>
+ <tr>
+ <td>user_objectclass = inetOrgPerson</td>
+ <td>(StrOpt) LDAP objectclass for users.</td>
+ </tr>
+ <tr>
+ <td>user_pass_attribute = userPassword</td>
+ <td>(StrOpt) LDAP attribute mapped to password.</td>
+ </tr>
+ <tr>
+ <td>user_tree_dn = None</td>
+ <td>(StrOpt) Search base for users.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/keystone-logging.xml b/doc/common/tables/keystone-logging.xml
index 951836b8b1..59612a1e93 100644
--- a/doc/common/tables/keystone-logging.xml
+++ b/doc/common/tables/keystone-logging.xml
@@ -1,91 +1,90 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_keystone_logging">
- <caption>Description of configuration options for logging</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN</td>
- <td>(ListOpt) List of logger=LEVEL pairs</td>
- </tr>
- <tr>
- <td>instance_format = "[instance: %(uuid)s] "</td>
- <td>(StrOpt) If an instance is passed with the log message, format it like this</td>
- </tr>
- <tr>
- <td>instance_uuid_format = "[instance: %(uuid)s] "</td>
- <td>(StrOpt) If an instance UUID is passed with the log message, format it like this</td>
- </tr>
- <tr>
- <td>log_config_append = None</td>
- <td>(StrOpt) The name of logging configuration file. It does not disable existing loggers, but just appends specified logging configuration to any other existing logging options. Please see the Python logging module documentation for details on logging configuration files.</td>
- </tr>
- <tr>
- <td>log_date_format = %Y-%m-%d %H:%M:%S</td>
- <td>(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s</td>
- </tr>
- <tr>
- <td>log_dir = None</td>
- <td>(StrOpt) (Optional) The base directory used for relative --log-file paths</td>
- </tr>
- <tr>
- <td>log_file = None</td>
- <td>(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.</td>
- </tr>
- <tr>
- <td>log_format = None</td>
- <td>(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.</td>
- </tr>
- <tr>
- <td>logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s</td>
- <td>(StrOpt) Format string to use for log messages with context</td>
- </tr>
- <tr>
- <td>logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d</td>
- <td>(StrOpt) Data to append to log format when level is DEBUG</td>
- </tr>
- <tr>
- <td>logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s</td>
- <td>(StrOpt) Format string to use for log messages without context</td>
- </tr>
- <tr>
- <td>logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s</td>
- <td>(StrOpt) Prefix each line of exception output with this format</td>
- </tr>
- <tr>
- <td>syslog_log_facility = LOG_USER</td>
- <td>(StrOpt) Syslog facility to receive log lines</td>
- </tr>
- <tr>
- <td>use_stderr = True</td>
- <td>(BoolOpt) Log output to standard error</td>
- </tr>
- <tr>
- <td>use_syslog = False</td>
- <td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and then will be changed in J to honor RFC5424</td>
- </tr>
- <tr>
- <td>use_syslog_rfc_format = False</td>
- <td>(BoolOpt) (Optional) Use syslog rfc5424 format for logging. If enabled, will add APP-NAME (RFC5424) before the MSG part of the syslog message. The old format without APP-NAME is deprecated in I, and will be removed in J.</td>
- </tr>
- <tr>
- <td>verbose = False</td>
- <td>(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_keystone_logging">
+ <caption>Description of configuration options for logging</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN</td>
+ <td>(ListOpt) List of logger=LEVEL pairs.</td>
+ </tr>
+ <tr>
+ <td>instance_format = "[instance: %(uuid)s] "</td>
+ <td>(StrOpt) The format for an instance that is passed with the log message. </td>
+ </tr>
+ <tr>
+ <td>instance_uuid_format = "[instance: %(uuid)s] "</td>
+ <td>(StrOpt) The format for an instance UUID that is passed with the log message. </td>
+ </tr>
+ <tr>
+ <td>log_config_append = None</td>
+ <td>(StrOpt) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation.</td>
+ </tr>
+ <tr>
+ <td>log_date_format = %Y-%m-%d %H:%M:%S</td>
+ <td>(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s .</td>
+ </tr>
+ <tr>
+ <td>log_dir = None</td>
+ <td>(StrOpt) (Optional) The base directory used for relative --log-file paths.</td>
+ </tr>
+ <tr>
+ <td>log_file = None</td>
+ <td>(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.</td>
+ </tr>
+ <tr>
+ <td>log_format = None</td>
+ <td>(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.</td>
+ </tr>
+ <tr>
+ <td>logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s</td>
+ <td>(StrOpt) Format string to use for log messages with context.</td>
+ </tr>
+ <tr>
+ <td>logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d</td>
+ <td>(StrOpt) Data to append to log format when level is DEBUG.</td>
+ </tr>
+ <tr>
+ <td>logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s</td>
+ <td>(StrOpt) Format string to use for log messages without context.</td>
+ </tr>
+ <tr>
+ <td>logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s</td>
+ <td>(StrOpt) Prefix each line of exception output with this format.</td>
+ </tr>
+ <tr>
+ <td>syslog_log_facility = LOG_USER</td>
+ <td>(StrOpt) Syslog facility to receive log lines.</td>
+ </tr>
+ <tr>
+ <td>use_stderr = True</td>
+ <td>(BoolOpt) Log output to standard error.</td>
+ </tr>
+ <tr>
+ <td>use_syslog = False</td>
+ <td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will chang in J to honor RFC5424.</td>
+ </tr>
+ <tr>
+ <td>use_syslog_rfc_format = False</td>
+ <td>(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in I, and will be removed in J.</td>
+ </tr>
+ <tr>
+ <td>verbose = False</td>
+ <td>(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/keystone-memcache.xml b/doc/common/tables/keystone-memcache.xml
index 30d0d62828..368ef9c49b 100644
--- a/doc/common/tables/keystone-memcache.xml
+++ b/doc/common/tables/keystone-memcache.xml
@@ -1,31 +1,30 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_keystone_memcache">
- <caption>Description of configuration options for memcache</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">[memcache]</th>
- </tr>
- <tr>
- <td>max_compare_and_set_retry = 16</td>
- <td>(IntOpt) Number of compare-and-set attempts to make when using compare-and-set in the token memcache back end.</td>
- </tr>
- <tr>
- <td>servers = localhost:11211</td>
- <td>(ListOpt) Memcache servers in the format of "host:port"</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_keystone_memcache">
+ <caption>Description of configuration options for memcache</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">[memcache]</th>
+ </tr>
+ <tr>
+ <td>max_compare_and_set_retry = 16</td>
+ <td>(IntOpt) Number of compare-and-set attempts to make when using compare-and-set in the token memcache back end.</td>
+ </tr>
+ <tr>
+ <td>servers = localhost:11211</td>
+ <td>(ListOpt) Memcache servers in the format of "host:port".</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/keystone-misc.xml b/doc/common/tables/keystone-misc.xml
index 6a5f51f0ad..79addaaffd 100644
--- a/doc/common/tables/keystone-misc.xml
+++ b/doc/common/tables/keystone-misc.xml
@@ -1,27 +1,26 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_keystone_misc">
- <caption>Description of configuration options for misc</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>lock_path = None</td>
- <td>(StrOpt) Directory to use for lock files.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_keystone_misc">
+ <caption>Description of configuration options for misc</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>lock_path = None</td>
+ <td>(StrOpt) Directory to use for lock files.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/keystone-notification.xml b/doc/common/tables/keystone-notification.xml
deleted file mode 100644
index 99b721289b..0000000000
--- a/doc/common/tables/keystone-notification.xml
+++ /dev/null
@@ -1,27 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_keystone_notification">
- <caption>Description of configuration options for notification</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>onready = None</td>
- <td>(StrOpt) onready allows you to send a notification when the process is ready to serve For example, to have it notify using systemd, one could set shell command: "onready = systemd-notify --ready" or a module with notify() method: "onready = keystone.common.systemd".</td>
- </tr>
- </tbody>
- </table>
- </para>
diff --git a/doc/common/tables/keystone-oauth.xml b/doc/common/tables/keystone-oauth.xml
index 8543fdd276..d563f1b317 100644
--- a/doc/common/tables/keystone-oauth.xml
+++ b/doc/common/tables/keystone-oauth.xml
@@ -1,35 +1,34 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_keystone_oauth">
- <caption>Description of configuration options for oauth</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">[oauth1]</th>
- </tr>
- <tr>
- <td>access_token_duration = 86400</td>
- <td>(IntOpt) Duration (in seconds) for the OAuth Access Token.</td>
- </tr>
- <tr>
- <td>driver = keystone.contrib.oauth1.backends.sql.OAuth1</td>
- <td>(StrOpt) Keystone Credential backend driver.</td>
- </tr>
- <tr>
- <td>request_token_duration = 28800</td>
- <td>(IntOpt) Duration (in seconds) for the OAuth Request Token.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_keystone_oauth">
+ <caption>Description of configuration options for oauth</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">[oauth1]</th>
+ </tr>
+ <tr>
+ <td>access_token_duration = 86400</td>
+ <td>(IntOpt) Duration (in seconds) for the OAuth Access Token.</td>
+ </tr>
+ <tr>
+ <td>driver = keystone.contrib.oauth1.backends.sql.OAuth1</td>
+ <td>(StrOpt) Credential backend driver.</td>
+ </tr>
+ <tr>
+ <td>request_token_duration = 28800</td>
+ <td>(IntOpt) Duration (in seconds) for the OAuth Request Token.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/keystone-os_inherit.xml b/doc/common/tables/keystone-os_inherit.xml
index 21e2c5a59c..70717d96e3 100644
--- a/doc/common/tables/keystone-os_inherit.xml
+++ b/doc/common/tables/keystone-os_inherit.xml
@@ -1,27 +1,26 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_keystone_os_inherit">
- <caption>Description of configuration options for os_inherit</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">[os_inherit]</th>
- </tr>
- <tr>
- <td>enabled = False</td>
- <td>(BoolOpt) role-assignment inheritance to projects from owning domain can be optionally enabled.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_keystone_os_inherit">
+ <caption>Description of configuration options for os_inherit</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">[os_inherit]</th>
+ </tr>
+ <tr>
+ <td>enabled = False</td>
+ <td>(BoolOpt) role-assignment inheritance to projects from owning domain can be optionally enabled.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/keystone-policy.xml b/doc/common/tables/keystone-policy.xml
index 37f4f8a1fb..6401c95c82 100644
--- a/doc/common/tables/keystone-policy.xml
+++ b/doc/common/tables/keystone-policy.xml
@@ -1,42 +1,41 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_keystone_policy">
- <caption>Description of configuration options for policy</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>policy_default_rule = default</td>
- <td>(StrOpt) Rule enforced when requested rule is not found</td>
- </tr>
- <tr>
- <td>policy_file = policy.json</td>
- <td>(StrOpt) JSON file containing policy</td>
- </tr>
- <tr>
- <th colspan="2">[policy]</th>
- </tr>
- <tr>
- <td>driver = keystone.policy.backends.sql.Policy</td>
- <td>(StrOpt) Keystone Policy backend driver.</td>
- </tr>
- <tr>
- <td>list_limit = None</td>
- <td>(IntOpt) Maximum number of entities that will be returned in a policy collection.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_keystone_policy">
+ <caption>Description of configuration options for policy</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>policy_default_rule = default</td>
+ <td>(StrOpt) Default rule. Enforced when a requested rule is not found.</td>
+ </tr>
+ <tr>
+ <td>policy_file = policy.json</td>
+ <td>(StrOpt) The JSON file that defines policies.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[policy]</th>
+ </tr>
+ <tr>
+ <td>driver = keystone.policy.backends.sql.Policy</td>
+ <td>(StrOpt) Policy backend driver.</td>
+ </tr>
+ <tr>
+ <td>list_limit = None</td>
+ <td>(IntOpt) Maximum number of entities that will be returned in a policy collection.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/keystone-qpid.xml b/doc/common/tables/keystone-qpid.xml
index f224e177b5..c772f7a5a2 100644
--- a/doc/common/tables/keystone-qpid.xml
+++ b/doc/common/tables/keystone-qpid.xml
@@ -1,63 +1,62 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_keystone_qpid">
- <caption>Description of configuration options for qpid</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>qpid_heartbeat = 60</td>
- <td>(IntOpt) Seconds between connection keepalive heartbeats.</td>
- </tr>
- <tr>
- <td>qpid_hostname = localhost</td>
- <td>(StrOpt) Qpid broker hostname.</td>
- </tr>
- <tr>
- <td>qpid_hosts = $qpid_hostname:$qpid_port</td>
- <td>(ListOpt) Qpid HA cluster host:port pairs.</td>
- </tr>
- <tr>
- <td>qpid_password = </td>
- <td>(StrOpt) Password for Qpid connection.</td>
- </tr>
- <tr>
- <td>qpid_port = 5672</td>
- <td>(IntOpt) Qpid broker port.</td>
- </tr>
- <tr>
- <td>qpid_protocol = tcp</td>
- <td>(StrOpt) Transport to use, either 'tcp' or 'ssl'.</td>
- </tr>
- <tr>
- <td>qpid_sasl_mechanisms = </td>
- <td>(StrOpt) Space separated list of SASL mechanisms to use for auth.</td>
- </tr>
- <tr>
- <td>qpid_tcp_nodelay = True</td>
- <td>(BoolOpt) Whether to disable the Nagle algorithm.</td>
- </tr>
- <tr>
- <td>qpid_topology_version = 1</td>
- <td>(IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.</td>
- </tr>
- <tr>
- <td>qpid_username = </td>
- <td>(StrOpt) Username for Qpid connection.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_keystone_qpid">
+ <caption>Description of configuration options for qpid</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>qpid_heartbeat = 60</td>
+ <td>(IntOpt) Seconds between connection keepalive heartbeats.</td>
+ </tr>
+ <tr>
+ <td>qpid_hostname = localhost</td>
+ <td>(StrOpt) Qpid broker hostname.</td>
+ </tr>
+ <tr>
+ <td>qpid_hosts = $qpid_hostname:$qpid_port</td>
+ <td>(ListOpt) Qpid HA cluster host:port pairs.</td>
+ </tr>
+ <tr>
+ <td>qpid_password = </td>
+ <td>(StrOpt) Password for Qpid connection.</td>
+ </tr>
+ <tr>
+ <td>qpid_port = 5672</td>
+ <td>(IntOpt) Qpid broker port.</td>
+ </tr>
+ <tr>
+ <td>qpid_protocol = tcp</td>
+ <td>(StrOpt) Transport to use, either 'tcp' or 'ssl'.</td>
+ </tr>
+ <tr>
+ <td>qpid_sasl_mechanisms = </td>
+ <td>(StrOpt) Space separated list of SASL mechanisms to use for auth.</td>
+ </tr>
+ <tr>
+ <td>qpid_tcp_nodelay = True</td>
+ <td>(BoolOpt) Whether to disable the Nagle algorithm.</td>
+ </tr>
+ <tr>
+ <td>qpid_topology_version = 1</td>
+ <td>(IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.</td>
+ </tr>
+ <tr>
+ <td>qpid_username = </td>
+ <td>(StrOpt) Username for Qpid connection.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/keystone-rabbit.xml b/doc/common/tables/keystone-rabbit.xml
index 03cf18ed22..9d1ce2bf7c 100644
--- a/doc/common/tables/keystone-rabbit.xml
+++ b/doc/common/tables/keystone-rabbit.xml
@@ -1,95 +1,94 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_keystone_rabbit">
- <caption>Description of configuration options for rabbit</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>fake_rabbit = False</td>
- <td>(BoolOpt) If passed, use a fake RabbitMQ provider.</td>
- </tr>
- <tr>
- <td>kombu_reconnect_delay = 1.0</td>
- <td>(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.</td>
- </tr>
- <tr>
- <td>kombu_ssl_ca_certs = </td>
- <td>(StrOpt) SSL certification authority file (valid only if SSL enabled).</td>
- </tr>
- <tr>
- <td>kombu_ssl_certfile = </td>
- <td>(StrOpt) SSL cert file (valid only if SSL enabled).</td>
- </tr>
- <tr>
- <td>kombu_ssl_keyfile = </td>
- <td>(StrOpt) SSL key file (valid only if SSL enabled).</td>
- </tr>
- <tr>
- <td>kombu_ssl_version = </td>
- <td>(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions.</td>
- </tr>
- <tr>
- <td>rabbit_ha_queues = False</td>
- <td>(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database.</td>
- </tr>
- <tr>
- <td>rabbit_host = localhost</td>
- <td>(StrOpt) The RabbitMQ broker address where a single node is used.</td>
- </tr>
- <tr>
- <td>rabbit_hosts = $rabbit_host:$rabbit_port</td>
- <td>(ListOpt) RabbitMQ HA cluster host:port pairs.</td>
- </tr>
- <tr>
- <td>rabbit_login_method = AMQPLAIN</td>
- <td>(StrOpt) the RabbitMQ login method</td>
- </tr>
- <tr>
- <td>rabbit_max_retries = 0</td>
- <td>(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).</td>
- </tr>
- <tr>
- <td>rabbit_password = guest</td>
- <td>(StrOpt) The RabbitMQ password.</td>
- </tr>
- <tr>
- <td>rabbit_port = 5672</td>
- <td>(IntOpt) The RabbitMQ broker port where a single node is used.</td>
- </tr>
- <tr>
- <td>rabbit_retry_backoff = 2</td>
- <td>(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.</td>
- </tr>
- <tr>
- <td>rabbit_retry_interval = 1</td>
- <td>(IntOpt) How frequently to retry connecting with RabbitMQ.</td>
- </tr>
- <tr>
- <td>rabbit_use_ssl = False</td>
- <td>(BoolOpt) Connect over SSL for RabbitMQ.</td>
- </tr>
- <tr>
- <td>rabbit_userid = guest</td>
- <td>(StrOpt) The RabbitMQ userid.</td>
- </tr>
- <tr>
- <td>rabbit_virtual_host = /</td>
- <td>(StrOpt) The RabbitMQ virtual host.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_keystone_rabbit">
+ <caption>Description of configuration options for rabbit</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>fake_rabbit = False</td>
+ <td>(BoolOpt) If passed, use a fake RabbitMQ provider</td>
+ </tr>
+ <tr>
+ <td>kombu_reconnect_delay = 1.0</td>
+ <td>(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.</td>
+ </tr>
+ <tr>
+ <td>kombu_ssl_ca_certs = </td>
+ <td>(StrOpt) SSL certification authority file (valid only if SSL enabled).</td>
+ </tr>
+ <tr>
+ <td>kombu_ssl_certfile = </td>
+ <td>(StrOpt) SSL cert file (valid only if SSL enabled).</td>
+ </tr>
+ <tr>
+ <td>kombu_ssl_keyfile = </td>
+ <td>(StrOpt) SSL key file (valid only if SSL enabled).</td>
+ </tr>
+ <tr>
+ <td>kombu_ssl_version = </td>
+ <td>(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions.</td>
+ </tr>
+ <tr>
+ <td>rabbit_ha_queues = False</td>
+ <td>(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database.</td>
+ </tr>
+ <tr>
+ <td>rabbit_host = localhost</td>
+ <td>(StrOpt) The RabbitMQ broker address where a single node is used.</td>
+ </tr>
+ <tr>
+ <td>rabbit_hosts = $rabbit_host:$rabbit_port</td>
+ <td>(ListOpt) RabbitMQ HA cluster host:port pairs.</td>
+ </tr>
+ <tr>
+ <td>rabbit_login_method = AMQPLAIN</td>
+ <td>(StrOpt) the RabbitMQ login method</td>
+ </tr>
+ <tr>
+ <td>rabbit_max_retries = 0</td>
+ <td>(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).</td>
+ </tr>
+ <tr>
+ <td>rabbit_password = guest</td>
+ <td>(StrOpt) The RabbitMQ password.</td>
+ </tr>
+ <tr>
+ <td>rabbit_port = 5672</td>
+ <td>(IntOpt) The RabbitMQ broker port where a single node is used.</td>
+ </tr>
+ <tr>
+ <td>rabbit_retry_backoff = 2</td>
+ <td>(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.</td>
+ </tr>
+ <tr>
+ <td>rabbit_retry_interval = 1</td>
+ <td>(IntOpt) How frequently to retry connecting with RabbitMQ.</td>
+ </tr>
+ <tr>
+ <td>rabbit_use_ssl = False</td>
+ <td>(BoolOpt) Connect over SSL for RabbitMQ.</td>
+ </tr>
+ <tr>
+ <td>rabbit_userid = guest</td>
+ <td>(StrOpt) The RabbitMQ userid.</td>
+ </tr>
+ <tr>
+ <td>rabbit_virtual_host = /</td>
+ <td>(StrOpt) The RabbitMQ virtual host.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/keystone-redis.xml b/doc/common/tables/keystone-redis.xml
index 9c2539fca4..fcab3f52e4 100644
--- a/doc/common/tables/keystone-redis.xml
+++ b/doc/common/tables/keystone-redis.xml
@@ -1,50 +1,49 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_keystone_redis">
- <caption>Description of configuration options for redis</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>host = 127.0.0.1</td>
- <td>(StrOpt) Host to locate redis.</td>
- </tr>
- <tr>
- <td>matchmaker_heartbeat_freq = 300</td>
- <td>(IntOpt) Heartbeat frequency.</td>
- </tr>
- <tr>
- <td>matchmaker_heartbeat_ttl = 600</td>
- <td>(IntOpt) Heartbeat time-to-live.</td>
- </tr>
- <tr>
- <td>password = None</td>
- <td>(StrOpt) Password for Redis server (optional).</td>
- </tr>
- <tr>
- <td>port = 6379</td>
- <td>(IntOpt) Use this port to connect to redis host.</td>
- </tr>
- <tr>
- <th colspan="2">[matchmaker_ring]</th>
- </tr>
- <tr>
- <td>ringfile = /etc/oslo/matchmaker_ring.json</td>
- <td>(StrOpt) Matchmaker ring file (JSON).</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_keystone_redis">
+ <caption>Description of configuration options for redis</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>host = 127.0.0.1</td>
+ <td>(StrOpt) Host to locate redis.</td>
+ </tr>
+ <tr>
+ <td>matchmaker_heartbeat_freq = 300</td>
+ <td>(IntOpt) Heartbeat frequency.</td>
+ </tr>
+ <tr>
+ <td>matchmaker_heartbeat_ttl = 600</td>
+ <td>(IntOpt) Heartbeat time-to-live.</td>
+ </tr>
+ <tr>
+ <td>password = None</td>
+ <td>(StrOpt) Password for Redis server (optional).</td>
+ </tr>
+ <tr>
+ <td>port = 6379</td>
+ <td>(IntOpt) Use this port to connect to redis host.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[matchmaker_ring]</th>
+ </tr>
+ <tr>
+ <td>ringfile = /etc/oslo/matchmaker_ring.json</td>
+ <td>(StrOpt) Matchmaker ring file (JSON).</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/keystone-revoke.xml b/doc/common/tables/keystone-revoke.xml
index b42e3e762e..b788b3efb4 100644
--- a/doc/common/tables/keystone-revoke.xml
+++ b/doc/common/tables/keystone-revoke.xml
@@ -1,35 +1,34 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_keystone_revoke">
- <caption>Description of configuration options for revoke</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">[revoke]</th>
- </tr>
- <tr>
- <td>caching = True</td>
- <td>(BoolOpt) Toggle for revocation event cacheing. This has no effect unless global caching is enabled.</td>
- </tr>
- <tr>
- <td>driver = keystone.contrib.revoke.backends.kvs.Revoke</td>
- <td>(StrOpt) An implementation of the backend for persisting revocation events.</td>
- </tr>
- <tr>
- <td>expiration_buffer = 1800</td>
- <td>(IntOpt) This value (calculated in seconds) is added to token expiration before a revocation event may be removed from the backend.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_keystone_revoke">
+ <caption>Description of configuration options for revoke</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">[revoke]</th>
+ </tr>
+ <tr>
+ <td>caching = True</td>
+ <td>(BoolOpt) Toggle for revocation event cacheing. This has no effect unless global caching is enabled.</td>
+ </tr>
+ <tr>
+ <td>driver = keystone.contrib.revoke.backends.kvs.Revoke</td>
+ <td>(StrOpt) An implementation of the backend for persisting revocation events.</td>
+ </tr>
+ <tr>
+ <td>expiration_buffer = 1800</td>
+ <td>(IntOpt) This value (calculated in seconds) is added to token expiration before a revocation event may be removed from the backend.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/keystone-rpc.xml b/doc/common/tables/keystone-rpc.xml
index 67a87aae6f..56a03132e3 100644
--- a/doc/common/tables/keystone-rpc.xml
+++ b/doc/common/tables/keystone-rpc.xml
@@ -1,27 +1,26 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_keystone_rpc">
- <caption>Description of configuration options for rpc</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>allowed_rpc_exception_modules = oslo.messaging.exceptions, nova.exception, cinder.exception, exceptions</td>
- <td>(ListOpt) Modules of exceptions that are permitted to be recreated upon receiving exception data from an rpc call.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_keystone_rpc">
+ <caption>Description of configuration options for rpc</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>allowed_rpc_exception_modules = keystone.openstack.common.exception, nova.exception, cinder.exception, exceptions</td>
+ <td>(ListOpt) Modules of exceptions that are permitted to be recreatedupon receiving exception data from an rpc call.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/keystone-security.xml b/doc/common/tables/keystone-security.xml
index db1b0c8f68..a1e1d90553 100644
--- a/doc/common/tables/keystone-security.xml
+++ b/doc/common/tables/keystone-security.xml
@@ -1,27 +1,26 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_keystone_security">
- <caption>Description of configuration options for security</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>crypt_strength = 40000</td>
- <td>(IntOpt) The value passed as the keyword "rounds" to passlib encrypt method.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_keystone_security">
+ <caption>Description of configuration options for security</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>crypt_strength = 40000</td>
+ <td>(IntOpt) The value passed as the keyword "rounds" to passlib's encrypt method.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/keystone-ssl.xml b/doc/common/tables/keystone-ssl.xml
index 7eb6e3123a..f4a117402f 100644
--- a/doc/common/tables/keystone-ssl.xml
+++ b/doc/common/tables/keystone-ssl.xml
@@ -1,94 +1,93 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_keystone_ssl">
- <caption>Description of configuration options for ssl</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[signing]</th>
- </tr>
- <tr>
- <td>ca_certs = /etc/keystone/ssl/certs/ca.pem</td>
- <td>(StrOpt) Path of the CA for token signing.</td>
- </tr>
- <tr>
- <td>ca_key = /etc/keystone/ssl/private/cakey.pem</td>
- <td>(StrOpt) Path of the CA Key for token signing.</td>
- </tr>
- <tr>
- <td>cert_subject = /C=US/ST=Unset/L=Unset/O=Unset/CN=www.example.com</td>
- <td>(StrOpt) Certificate Subject (auto generated certificate) for token signing.</td>
- </tr>
- <tr>
- <td>certfile = /etc/keystone/ssl/certs/signing_cert.pem</td>
- <td>(StrOpt) Path of the certfile for token signing.</td>
- </tr>
- <tr>
- <td>key_size = 2048</td>
- <td>(IntOpt) Key Size (in bits) for token signing cert (auto generated certificate).</td>
- </tr>
- <tr>
- <td>keyfile = /etc/keystone/ssl/private/signing_key.pem</td>
- <td>(StrOpt) Path of the keyfile for token signing.</td>
- </tr>
- <tr>
- <td>token_format = None</td>
- <td>(StrOpt) Deprecated in favor of provider in the [token] section.</td>
- </tr>
- <tr>
- <td>valid_days = 3650</td>
- <td>(IntOpt) Day the token signing cert is valid for (auto generated certificate).</td>
- </tr>
- <tr>
- <th colspan="2">[ssl]</th>
- </tr>
- <tr>
- <td>ca_certs = /etc/keystone/ssl/certs/ca.pem</td>
- <td>(StrOpt) Path of the ca cert file for SSL.</td>
- </tr>
- <tr>
- <td>ca_key = /etc/keystone/ssl/private/cakey.pem</td>
- <td>(StrOpt) Path of the CA key file for SSL.</td>
- </tr>
- <tr>
- <td>cert_required = False</td>
- <td>(BoolOpt) Require client certificate.</td>
- </tr>
- <tr>
- <td>cert_subject = /C=US/ST=Unset/L=Unset/O=Unset/CN=localhost</td>
- <td>(StrOpt) SSL Certificate Subject (auto generated certificate).</td>
- </tr>
- <tr>
- <td>certfile = /etc/keystone/ssl/certs/keystone.pem</td>
- <td>(StrOpt) Path of the certfile for SSL.</td>
- </tr>
- <tr>
- <td>enable = False</td>
- <td>(BoolOpt) Toggle for SSL support on the keystone eventlet servers.</td>
- </tr>
- <tr>
- <td>key_size = 1024</td>
- <td>(IntOpt) SSL Key Length (in bits) (auto generated certificate).</td>
- </tr>
- <tr>
- <td>keyfile = /etc/keystone/ssl/private/keystonekey.pem</td>
- <td>(StrOpt) Path of the keyfile for SSL.</td>
- </tr>
- <tr>
- <td>valid_days = 3650</td>
- <td>(IntOpt) Days the certificate is valid for once signed (auto generated certificate).</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_keystone_ssl">
+ <caption>Description of configuration options for ssl</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[signing]</th>
+ </tr>
+ <tr>
+ <td>ca_certs = /etc/keystone/ssl/certs/ca.pem</td>
+ <td>(StrOpt) Path of the CA for token signing.</td>
+ </tr>
+ <tr>
+ <td>ca_key = /etc/keystone/ssl/private/cakey.pem</td>
+ <td>(StrOpt) Path of the CA key for token signing.</td>
+ </tr>
+ <tr>
+ <td>cert_subject = /C=US/ST=Unset/L=Unset/O=Unset/CN=www.example.com</td>
+ <td>(StrOpt) Certificate subject (auto generated certificate) for token signing.</td>
+ </tr>
+ <tr>
+ <td>certfile = /etc/keystone/ssl/certs/signing_cert.pem</td>
+ <td>(StrOpt) Path of the certfile for token signing. For non-production environments, you may be interested in using `keystone-manage pki_setup` to generate self-signed certificates.</td>
+ </tr>
+ <tr>
+ <td>key_size = 2048</td>
+ <td>(IntOpt) Key size (in bits) for token signing cert (auto generated certificate).</td>
+ </tr>
+ <tr>
+ <td>keyfile = /etc/keystone/ssl/private/signing_key.pem</td>
+ <td>(StrOpt) Path of the keyfile for token signing.</td>
+ </tr>
+ <tr>
+ <td>token_format = None</td>
+ <td>(StrOpt) Deprecated in favor of provider in the [token] section.</td>
+ </tr>
+ <tr>
+ <td>valid_days = 3650</td>
+ <td>(IntOpt) Days the token signing cert is valid for (auto generated certificate).</td>
+ </tr>
+ <tr>
+ <th colspan="2">[ssl]</th>
+ </tr>
+ <tr>
+ <td>ca_certs = /etc/keystone/ssl/certs/ca.pem</td>
+ <td>(StrOpt) Path of the ca cert file for SSL.</td>
+ </tr>
+ <tr>
+ <td>ca_key = /etc/keystone/ssl/private/cakey.pem</td>
+ <td>(StrOpt) Path of the CA key file for SSL.</td>
+ </tr>
+ <tr>
+ <td>cert_required = False</td>
+ <td>(BoolOpt) Require client certificate.</td>
+ </tr>
+ <tr>
+ <td>cert_subject = /C=US/ST=Unset/L=Unset/O=Unset/CN=localhost</td>
+ <td>(StrOpt) SSL certificate subject (auto generated certificate).</td>
+ </tr>
+ <tr>
+ <td>certfile = /etc/keystone/ssl/certs/keystone.pem</td>
+ <td>(StrOpt) Path of the certfile for SSL. For non-production environments, you may be interested in using `keystone-manage ssl_setup` to generate self-signed certificates.</td>
+ </tr>
+ <tr>
+ <td>enable = False</td>
+ <td>(BoolOpt) Toggle for SSL support on the Keystone eventlet servers.</td>
+ </tr>
+ <tr>
+ <td>key_size = 1024</td>
+ <td>(IntOpt) SSL key length (in bits) (auto generated certificate).</td>
+ </tr>
+ <tr>
+ <td>keyfile = /etc/keystone/ssl/private/keystonekey.pem</td>
+ <td>(StrOpt) Path of the keyfile for SSL.</td>
+ </tr>
+ <tr>
+ <td>valid_days = 3650</td>
+ <td>(IntOpt) Days the certificate is valid for once signed (auto generated certificate).</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/keystone-stats.xml b/doc/common/tables/keystone-stats.xml
index ff25c8e141..084bbcff9b 100644
--- a/doc/common/tables/keystone-stats.xml
+++ b/doc/common/tables/keystone-stats.xml
@@ -1,27 +1,26 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_keystone_stats">
- <caption>Description of configuration options for stats</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">[stats]</th>
- </tr>
- <tr>
- <td>driver = keystone.contrib.stats.backends.kvs.Stats</td>
- <td>(StrOpt) Keystone stats backend driver.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_keystone_stats">
+ <caption>Description of configuration options for stats</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">[stats]</th>
+ </tr>
+ <tr>
+ <td>driver = keystone.contrib.stats.backends.kvs.Stats</td>
+ <td>(StrOpt) Stats backend driver.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/keystone-token.xml b/doc/common/tables/keystone-token.xml
index 29d83f1927..8e6b2d8e91 100644
--- a/doc/common/tables/keystone-token.xml
+++ b/doc/common/tables/keystone-token.xml
@@ -1,59 +1,62 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_keystone_token">
- <caption>Description of configuration options for token</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">[token]</th>
- </tr>
- <tr>
- <td>bind = </td>
- <td>(ListOpt) External auth mechanisms that should add bind information to token e.g. kerberos, x509.</td>
- </tr>
- <tr>
- <td>cache_time = None</td>
- <td>(IntOpt) Time to cache tokens (in seconds). This has no effect unless global and token caching are enabled.</td>
- </tr>
- <tr>
- <td>caching = True</td>
- <td>(BoolOpt) Toggle for token system cacheing. This has no effect unless global caching is enabled.</td>
- </tr>
- <tr>
- <td>driver = keystone.token.backends.sql.Token</td>
- <td>(StrOpt) Keystone Token persistence backend driver.</td>
- </tr>
- <tr>
- <td>enforce_token_bind = permissive</td>
- <td>(StrOpt) Enforcement policy on tokens presented to keystone with bind information. One of disabled, permissive, strict, required or a specifically required bind mode e.g. kerberos or x509 to require binding to that authentication.</td>
- </tr>
- <tr>
- <td>expiration = 3600</td>
- <td>(IntOpt) Amount of time a token should remain valid (in seconds).</td>
- </tr>
- <tr>
- <td>provider = None</td>
- <td>(StrOpt) Controls the token construction, validation, and revocation operations. Core providers are "keystone.token.providers.[pki|uuid].Provider".</td>
- </tr>
- <tr>
- <td>revocation_cache_time = 3600</td>
- <td>(IntOpt) Time to cache the revocation list and the revocation events if revoke extension is enabled (in seconds). This has no effect unless global and token caching are enabled.</td>
- </tr>
- <tr>
- <td>revoke_by_id = True</td>
- <td>(BoolOpt) Revoke token by token identifier. Setting revoke_by_id to True enables various forms of enumerating tokens, e.g. `list tokens for user`. These enumerations are processed to determine the list of tokens to revoke. Only disable if you are switching to using the Revoke extension with a backend other than KVS, which stores events in memory.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_keystone_token">
+ <caption>Description of configuration options for token</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">[token]</th>
+ </tr>
+ <tr>
+ <td>bind = </td>
+ <td>(ListOpt) External auth mechanisms that should add bind information to token, e.g., kerberos,x509.</td>
+ </tr>
+ <tr>
+ <td>cache_time = None</td>
+ <td>(IntOpt) Time to cache tokens (in seconds). This has no effect unless global and token caching are enabled.</td>
+ </tr>
+ <tr>
+ <td>caching = True</td>
+ <td>(BoolOpt) Toggle for token system cacheing. This has no effect unless global caching is enabled.</td>
+ </tr>
+ <tr>
+ <td>driver = keystone.token.backends.sql.Token</td>
+ <td>(StrOpt) Token persistence backend driver.</td>
+ </tr>
+ <tr>
+ <td>enforce_token_bind = permissive</td>
+ <td>(StrOpt) Enforcement policy on tokens presented to Keystone with bind information. One of disabled, permissive, strict, required or a specifically required bind mode, e.g., kerberos or x509 to require binding to that authentication.</td>
+ </tr>
+ <tr>
+ <td>expiration = 3600</td>
+ <td>(IntOpt) Amount of time a token should remain valid (in seconds).</td>
+ </tr>
+ <tr>
+ <td>hash_algorithm = md5</td>
+ <td>(StrOpt) The hash algorithm to use for PKI tokens. This can be set to any algorithm that hashlib supports. WARNING: Before changing this value, the auth_token middleware must be configured with the hash_algorithms, otherwise token revocation will not be processed correctly.</td>
+ </tr>
+ <tr>
+ <td>provider = None</td>
+ <td>(StrOpt) Controls the token construction, validation, and revocation operations. Core providers are "keystone.token.providers.[pkiz|pki|uuid].Provider". The default provider is pkiz.</td>
+ </tr>
+ <tr>
+ <td>revocation_cache_time = 3600</td>
+ <td>(IntOpt) Time to cache the revocation list and the revocation events if revoke extension is enabled (in seconds). This has no effect unless global and token caching are enabled.</td>
+ </tr>
+ <tr>
+ <td>revoke_by_id = True</td>
+ <td>(BoolOpt) Revoke token by token identifier. Setting revoke_by_id to true enables various forms of enumerating tokens, e.g. `list tokens for user`. These enumerations are processed to determine the list of tokens to revoke. Only disable if you are switching to using the Revoke extension with a backend other than KVS, which stores events in memory.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/keystone-trust.xml b/doc/common/tables/keystone-trust.xml
index 780e030361..feafd42bf4 100644
--- a/doc/common/tables/keystone-trust.xml
+++ b/doc/common/tables/keystone-trust.xml
@@ -1,31 +1,30 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_keystone_trust">
- <caption>Description of configuration options for trust</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">[trust]</th>
- </tr>
- <tr>
- <td>driver = keystone.trust.backends.sql.Trust</td>
- <td>(StrOpt) Keystone Trust backend driver.</td>
- </tr>
- <tr>
- <td>enabled = True</td>
- <td>(BoolOpt) delegation and impersonation features can be optionally disabled.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_keystone_trust">
+ <caption>Description of configuration options for trust</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">[trust]</th>
+ </tr>
+ <tr>
+ <td>driver = keystone.trust.backends.sql.Trust</td>
+ <td>(StrOpt) Trust backend driver.</td>
+ </tr>
+ <tr>
+ <td>enabled = True</td>
+ <td>(BoolOpt) Delegation and impersonation features can be optionally disabled.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/keystone-zeromq.xml b/doc/common/tables/keystone-zeromq.xml
index dc19c0a49c..202966690e 100644
--- a/doc/common/tables/keystone-zeromq.xml
+++ b/doc/common/tables/keystone-zeromq.xml
@@ -1,51 +1,50 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_keystone_zeromq">
- <caption>Description of configuration options for zeromq</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>rpc_zmq_bind_address = *</td>
- <td>(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address.</td>
- </tr>
- <tr>
- <td>rpc_zmq_contexts = 1</td>
- <td>(IntOpt) Number of ZeroMQ contexts, defaults to 1.</td>
- </tr>
- <tr>
- <td>rpc_zmq_host = oslo</td>
- <td>(StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova.</td>
- </tr>
- <tr>
- <td>rpc_zmq_ipc_dir = /var/run/openstack</td>
- <td>(StrOpt) Directory for holding IPC sockets.</td>
- </tr>
- <tr>
- <td>rpc_zmq_matchmaker = oslo.messaging._drivers.matchmaker.MatchMakerLocalhost</td>
- <td>(StrOpt) MatchMaker driver.</td>
- </tr>
- <tr>
- <td>rpc_zmq_port = 9501</td>
- <td>(IntOpt) ZeroMQ receiver listening port.</td>
- </tr>
- <tr>
- <td>rpc_zmq_topic_backlog = None</td>
- <td>(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_keystone_zeromq">
+ <caption>Description of configuration options for zeromq</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>rpc_zmq_bind_address = *</td>
+ <td>(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_contexts = 1</td>
+ <td>(IntOpt) Number of ZeroMQ contexts, defaults to 1.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_host = oslo</td>
+ <td>(StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_ipc_dir = /var/run/openstack</td>
+ <td>(StrOpt) Directory for holding IPC sockets.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_matchmaker = oslo.messaging._drivers.matchmaker.MatchMakerLocalhost</td>
+ <td>(StrOpt) MatchMaker driver.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_port = 9501</td>
+ <td>(IntOpt) ZeroMQ receiver listening port.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_topic_backlog = None</td>
+ <td>(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-agent.xml b/doc/common/tables/neutron-agent.xml
index 6b0c0fa380..f0c3659399 100644
--- a/doc/common/tables/neutron-agent.xml
+++ b/doc/common/tables/neutron-agent.xml
@@ -1,31 +1,30 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_agent">
- <caption>Description of configuration options for agent</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>external_pids = $state_path/external/pids</td>
- <td>(StrOpt) Location to store child pid files</td>
- </tr>
- <tr>
- <td>network_device_mtu = None</td>
- <td>(IntOpt) MTU setting for device.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_agent">
+ <caption>Description of configuration options for agent</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>external_pids = $state_path/external/pids</td>
+ <td>(StrOpt) Location to store child pid files</td>
+ </tr>
+ <tr>
+ <td>network_device_mtu = None</td>
+ <td>(IntOpt) MTU setting for device.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-api.xml b/doc/common/tables/neutron-api.xml
index 40a48c300a..db06d13777 100644
--- a/doc/common/tables/neutron-api.xml
+++ b/doc/common/tables/neutron-api.xml
@@ -1,70 +1,69 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_api">
- <caption>Description of configuration options for api</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>allow_bulk = True</td>
- <td>(BoolOpt) Allow the usage of the bulk API</td>
- </tr>
- <tr>
- <td>allow_pagination = False</td>
- <td>(BoolOpt) Allow the usage of the pagination</td>
- </tr>
- <tr>
- <td>allow_sorting = False</td>
- <td>(BoolOpt) Allow the usage of the sorting</td>
- </tr>
- <tr>
- <td>api_extensions_path = </td>
- <td>(StrOpt) The path for API extensions</td>
- </tr>
- <tr>
- <td>api_paste_config = api-paste.ini</td>
- <td>(StrOpt) The API paste config file to use</td>
- </tr>
- <tr>
- <td>max_header_line = 16384</td>
- <td>(IntOpt) Max header line to accommodate large tokens</td>
- </tr>
- <tr>
- <td>max_request_body_size = 114688</td>
- <td>(IntOpt) the maximum body size per each request(bytes)</td>
- </tr>
- <tr>
- <td>pagination_max_limit = -1</td>
- <td>(StrOpt) The maximum number of items returned in a single response, value was 'infinite' or negative integer means no limit</td>
- </tr>
- <tr>
- <td>run_external_periodic_tasks = True</td>
- <td>(BoolOpt) Some periodic tasks can be run in a separate process. Should we run them here?</td>
- </tr>
- <tr>
- <td>service_plugins = </td>
- <td>(ListOpt) The service plugins Neutron will use</td>
- </tr>
- <tr>
- <th colspan="2">[service_providers]</th>
- </tr>
- <tr>
- <td>service_provider = []</td>
- <td>(MultiStrOpt) Defines providers for advanced services using the format: <service_type>:<name>:<driver>[:default]</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_api">
+ <caption>Description of configuration options for api</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>allow_bulk = True</td>
+ <td>(BoolOpt) Allow the usage of the bulk API</td>
+ </tr>
+ <tr>
+ <td>allow_pagination = False</td>
+ <td>(BoolOpt) Allow the usage of the pagination</td>
+ </tr>
+ <tr>
+ <td>allow_sorting = False</td>
+ <td>(BoolOpt) Allow the usage of the sorting</td>
+ </tr>
+ <tr>
+ <td>api_extensions_path = </td>
+ <td>(StrOpt) The path for API extensions</td>
+ </tr>
+ <tr>
+ <td>api_paste_config = api-paste.ini</td>
+ <td>(StrOpt) The API paste config file to use</td>
+ </tr>
+ <tr>
+ <td>max_header_line = 16384</td>
+ <td>(IntOpt) Max header line to accommodate large tokens</td>
+ </tr>
+ <tr>
+ <td>max_request_body_size = 114688</td>
+ <td>(IntOpt) the maximum body size per each request(bytes)</td>
+ </tr>
+ <tr>
+ <td>pagination_max_limit = -1</td>
+ <td>(StrOpt) The maximum number of items returned in a single response, value was 'infinite' or negative integer means no limit</td>
+ </tr>
+ <tr>
+ <td>run_external_periodic_tasks = True</td>
+ <td>(BoolOpt) Some periodic tasks can be run in a separate process. Should we run them here?</td>
+ </tr>
+ <tr>
+ <td>service_plugins = </td>
+ <td>(ListOpt) The service plugins Neutron will use</td>
+ </tr>
+ <tr>
+ <th colspan="2">[service_providers]</th>
+ </tr>
+ <tr>
+ <td>service_provider = []</td>
+ <td>(MultiStrOpt) Defines providers for advanced services using the format: <service_type>:<name>:<driver>[:default]</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-auth_token.xml b/doc/common/tables/neutron-auth_token.xml
index d808a49836..c87b0b0f8e 100644
--- a/doc/common/tables/neutron-auth_token.xml
+++ b/doc/common/tables/neutron-auth_token.xml
@@ -1,134 +1,145 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_auth_token">
- <caption>Description of configuration options for auth_token</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>memcached_servers = None</td>
- <td>(ListOpt) Memcached servers or None for in process cache.</td>
- </tr>
- <tr>
- <th colspan="2">[keystone_authtoken]</th>
- </tr>
- <tr>
- <td>admin_password = None</td>
- <td>(StrOpt) Keystone account password</td>
- </tr>
- <tr>
- <td>admin_tenant_name = admin</td>
- <td>(StrOpt) Keystone service account tenant name to validate user tokens</td>
- </tr>
- <tr>
- <td>admin_token = None</td>
- <td>(StrOpt) Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process.</td>
- </tr>
- <tr>
- <td>admin_user = None</td>
- <td>(StrOpt) Keystone account username</td>
- </tr>
- <tr>
- <td>auth_admin_prefix = </td>
- <td>(StrOpt) Prefix to prepend at the beginning of the path</td>
- </tr>
- <tr>
- <td>auth_host = 127.0.0.1</td>
- <td>(StrOpt) Host providing the admin Identity API endpoint</td>
- </tr>
- <tr>
- <td>auth_port = 35357</td>
- <td>(IntOpt) Port of the admin Identity API endpoint</td>
- </tr>
- <tr>
- <td>auth_protocol = https</td>
- <td>(StrOpt) Protocol of the admin Identity API endpoint(http or https)</td>
- </tr>
- <tr>
- <td>auth_uri = None</td>
- <td>(StrOpt) Complete public Identity API endpoint</td>
- </tr>
- <tr>
- <td>auth_version = None</td>
- <td>(StrOpt) API version of the admin Identity API endpoint</td>
- </tr>
- <tr>
- <td>cache = None</td>
- <td>(StrOpt) Env key for the swift cache</td>
- </tr>
- <tr>
- <td>cafile = None</td>
- <td>(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.</td>
- </tr>
- <tr>
- <td>certfile = None</td>
- <td>(StrOpt) Required if Keystone server requires client certificate</td>
- </tr>
- <tr>
- <td>delay_auth_decision = False</td>
- <td>(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components</td>
- </tr>
- <tr>
- <td>enforce_token_bind = permissive</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>http_connect_timeout = None</td>
- <td>(BoolOpt) Request timeout value for communicating with Identity API server.</td>
- </tr>
- <tr>
- <td>http_request_max_retries = 3</td>
- <td>(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server.</td>
- </tr>
- <tr>
- <td>include_service_catalog = True</td>
- <td>(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.</td>
- </tr>
- <tr>
- <td>insecure = False</td>
- <td>(BoolOpt) Verify HTTPS connections.</td>
- </tr>
- <tr>
- <td>keyfile = None</td>
- <td>(StrOpt) Required if Keystone server requires client certificate</td>
- </tr>
- <tr>
- <td>memcache_secret_key = None</td>
- <td>(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation.</td>
- </tr>
- <tr>
- <td>memcache_security_strategy = None</td>
- <td>(StrOpt) (optional) if defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.</td>
- </tr>
- <tr>
- <td>memcached_servers = None</td>
- <td>(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.</td>
- </tr>
- <tr>
- <td>revocation_cache_time = 300</td>
- <td>(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.</td>
- </tr>
- <tr>
- <td>signing_dir = None</td>
- <td>(StrOpt) Directory used to cache files related to PKI tokens</td>
- </tr>
- <tr>
- <td>token_cache_time = 300</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>
+<?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_neutron_auth_token">
+ <caption>Description of configuration options for auth_token</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>memcached_servers = None</td>
+ <td>(ListOpt) Memcached servers or None for in process cache.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[keystone_authtoken]</th>
+ </tr>
+ <tr>
+ <td>admin_password = None</td>
+ <td>(StrOpt) Keystone account password</td>
+ </tr>
+ <tr>
+ <td>admin_tenant_name = admin</td>
+ <td>(StrOpt) Keystone service account tenant name to validate user tokens</td>
+ </tr>
+ <tr>
+ <td>admin_token = None</td>
+ <td>(StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead.</td>
+ </tr>
+ <tr>
+ <td>admin_user = None</td>
+ <td>(StrOpt) Keystone account username</td>
+ </tr>
+ <tr>
+ <td>auth_admin_prefix = </td>
+ <td>(StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri.</td>
+ </tr>
+ <tr>
+ <td>auth_host = 127.0.0.1</td>
+ <td>(StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri.</td>
+ </tr>
+ <tr>
+ <td>auth_port = 35357</td>
+ <td>(IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri.</td>
+ </tr>
+ <tr>
+ <td>auth_protocol = https</td>
+ <td>(StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri.</td>
+ </tr>
+ <tr>
+ <td>auth_uri = None</td>
+ <td>(StrOpt) Complete public Identity API endpoint</td>
+ </tr>
+ <tr>
+ <td>auth_version = None</td>
+ <td>(StrOpt) API version of the admin Identity API endpoint</td>
+ </tr>
+ <tr>
+ <td>cache = None</td>
+ <td>(StrOpt) Env key for the swift cache</td>
+ </tr>
+ <tr>
+ <td>cafile = None</td>
+ <td>(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.</td>
+ </tr>
+ <tr>
+ <td>certfile = None</td>
+ <td>(StrOpt) Required if Keystone server requires client certificate</td>
+ </tr>
+ <tr>
+ <td>check_revocations_for_cached = False</td>
+ <td>(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the Keystone server.</td>
+ </tr>
+ <tr>
+ <td>delay_auth_decision = False</td>
+ <td>(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components</td>
+ </tr>
+ <tr>
+ <td>enforce_token_bind = permissive</td>
+ <td>(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens.</td>
+ </tr>
+ <tr>
+ <td>hash_algorithms = md5</td>
+ <td>(ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance.</td>
+ </tr>
+ <tr>
+ <td>http_connect_timeout = None</td>
+ <td>(BoolOpt) Request timeout value for communicating with Identity API server.</td>
+ </tr>
+ <tr>
+ <td>http_request_max_retries = 3</td>
+ <td>(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server.</td>
+ </tr>
+ <tr>
+ <td>identity_uri = None</td>
+ <td>(StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/</td>
+ </tr>
+ <tr>
+ <td>include_service_catalog = True</td>
+ <td>(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.</td>
+ </tr>
+ <tr>
+ <td>insecure = False</td>
+ <td>(BoolOpt) Verify HTTPS connections.</td>
+ </tr>
+ <tr>
+ <td>keyfile = None</td>
+ <td>(StrOpt) Required if Keystone server requires client certificate</td>
+ </tr>
+ <tr>
+ <td>memcache_secret_key = None</td>
+ <td>(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation.</td>
+ </tr>
+ <tr>
+ <td>memcache_security_strategy = None</td>
+ <td>(StrOpt) (optional) if defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.</td>
+ </tr>
+ <tr>
+ <td>memcached_servers = None</td>
+ <td>(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.</td>
+ </tr>
+ <tr>
+ <td>revocation_cache_time = 10</td>
+ <td>(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.</td>
+ </tr>
+ <tr>
+ <td>signing_dir = None</td>
+ <td>(StrOpt) Directory used to cache files related to PKI tokens</td>
+ </tr>
+ <tr>
+ <td>token_cache_time = 300</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>
diff --git a/doc/common/tables/neutron-bigswitch.xml b/doc/common/tables/neutron-bigswitch.xml
index e2c6f1e840..6bb25ceb81 100644
--- a/doc/common/tables/neutron-bigswitch.xml
+++ b/doc/common/tables/neutron-bigswitch.xml
@@ -1,164 +1,163 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_bigswitch">
- <caption>Description of configuration options for bigswitch</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">[NOVA]</th>
- </tr>
- <tr>
- <td>node_override_vif_802.1qbg = </td>
- <td>(ListOpt) Nova compute nodes to manually set VIF type to 802.1qbg</td>
- </tr>
- <tr>
- <td>node_override_vif_802.1qbh = </td>
- <td>(ListOpt) Nova compute nodes to manually set VIF type to 802.1qbh</td>
- </tr>
- <tr>
- <td>node_override_vif_binding_failed = </td>
- <td>(ListOpt) Nova compute nodes to manually set VIF type to binding_failed</td>
- </tr>
- <tr>
- <td>node_override_vif_bridge = </td>
- <td>(ListOpt) Nova compute nodes to manually set VIF type to bridge</td>
- </tr>
- <tr>
- <td>node_override_vif_hostdev = </td>
- <td>(ListOpt) Nova compute nodes to manually set VIF type to hostdev</td>
- </tr>
- <tr>
- <td>node_override_vif_hyperv = </td>
- <td>(ListOpt) Nova compute nodes to manually set VIF type to hyperv</td>
- </tr>
- <tr>
- <td>node_override_vif_ivs = </td>
- <td>(ListOpt) Nova compute nodes to manually set VIF type to ivs</td>
- </tr>
- <tr>
- <td>node_override_vif_midonet = </td>
- <td>(ListOpt) Nova compute nodes to manually set VIF type to midonet</td>
- </tr>
- <tr>
- <td>node_override_vif_mlnx_direct = </td>
- <td>(ListOpt) Nova compute nodes to manually set VIF type to mlnx_direct</td>
- </tr>
- <tr>
- <td>node_override_vif_other = </td>
- <td>(ListOpt) Nova compute nodes to manually set VIF type to other</td>
- </tr>
- <tr>
- <td>node_override_vif_ovs = </td>
- <td>(ListOpt) Nova compute nodes to manually set VIF type to ovs</td>
- </tr>
- <tr>
- <td>node_override_vif_unbound = </td>
- <td>(ListOpt) Nova compute nodes to manually set VIF type to unbound</td>
- </tr>
- <tr>
- <td>vif_type = ovs</td>
- <td>(StrOpt) Virtual interface type to configure on Nova compute nodes</td>
- </tr>
- <tr>
- <td>vif_types = unbound, binding_failed, ovs, ivs, bridge, 802.1qbg, 802.1qbh, hyperv, midonet, mlnx_direct, hostdev, other</td>
- <td>(ListOpt) List of allowed vif_type values.</td>
- </tr>
- <tr>
- <th colspan="2">[RESTPROXY]</th>
- </tr>
- <tr>
- <td>add_meta_server_route = True</td>
- <td>(BoolOpt) Flag to decide if a route to the metadata server should be injected into the VM</td>
- </tr>
- <tr>
- <td>auto_sync_on_failure = True</td>
- <td>(BoolOpt) If neutron fails to create a resource because the backend controller doesn't know of a dependency, the plugin automatically triggers a full data synchronization to the controller.</td>
- </tr>
- <tr>
- <td>cache_connections = True</td>
- <td>(BoolOpt) Re-use HTTP/HTTPS connections to the controller.</td>
- </tr>
- <tr>
- <td>consistency_interval = 60</td>
- <td>(IntOpt) Time between verifications that the backend controller database is consistent with Neutron</td>
- </tr>
- <tr>
- <td>neutron_id = neutron-oslo</td>
- <td>(StrOpt) User defined identifier for this Neutron deployment</td>
- </tr>
- <tr>
- <td>no_ssl_validation = False</td>
- <td>(BoolOpt) Disables SSL certificate validation for controllers</td>
- </tr>
- <tr>
- <td>server_auth = None</td>
- <td>(StrOpt) The username and password for authenticating against the Big Switch or Floodlight controller.</td>
- </tr>
- <tr>
- <td>server_ssl = True</td>
- <td>(BoolOpt) If True, Use SSL when connecting to the Big Switch or Floodlight controller.</td>
- </tr>
- <tr>
- <td>server_timeout = 10</td>
- <td>(IntOpt) Maximum number of seconds to wait for proxy request to connect and complete.</td>
- </tr>
- <tr>
- <td>servers = localhost:8800</td>
- <td>(ListOpt) A comma separated list of Big Switch or Floodlight servers and port numbers. The plugin proxies the requests to the Big Switch/Floodlight server, which performs the networking configuration. Only oneserver is needed per deployment, but you may wish todeploy multiple servers to support failover.</td>
- </tr>
- <tr>
- <td>ssl_cert_directory = /etc/neutron/plugins/bigswitch/ssl</td>
- <td>(StrOpt) Directory containing ca_certs and host_certs certificate directories.</td>
- </tr>
- <tr>
- <td>ssl_sticky = True</td>
- <td>(BoolOpt) Trust and store the first certificate received for each controller address and use it to validate future connections to that address.</td>
- </tr>
- <tr>
- <td>sync_data = False</td>
- <td>(BoolOpt) Sync data on connect</td>
- </tr>
- <tr>
- <td>thread_pool_size = 4</td>
- <td>(IntOpt) Maximum number of threads to spawn to handle large volumes of port creations.</td>
- </tr>
- <tr>
- <th colspan="2">[RESTPROXYAGENT]</th>
- </tr>
- <tr>
- <td>integration_bridge = br-int</td>
- <td>(StrOpt) Name of integration bridge on compute nodes used for security group insertion.</td>
- </tr>
- <tr>
- <td>polling_interval = 5</td>
- <td>(IntOpt) Seconds between agent checks for port changes</td>
- </tr>
- <tr>
- <td>virtual_switch_type = ovs</td>
- <td>(StrOpt) Virtual switch type.</td>
- </tr>
- <tr>
- <th colspan="2">[ROUTER]</th>
- </tr>
- <tr>
- <td>max_router_rules = 200</td>
- <td>(IntOpt) Maximum number of router rules</td>
- </tr>
- <tr>
- <td>tenant_default_router_rule = ['*:any:any:permit']</td>
- <td>(MultiStrOpt) The default router rules installed in new tenant routers. Repeat the config option for each rule. Format is <tenant>:<source>:<destination>:<action> Use an * to specify default for all tenants.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_bigswitch">
+ <caption>Description of configuration options for bigswitch</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">[NOVA]</th>
+ </tr>
+ <tr>
+ <td>node_override_vif_802.1qbg = </td>
+ <td>(ListOpt) Nova compute nodes to manually set VIF type to 802.1qbg</td>
+ </tr>
+ <tr>
+ <td>node_override_vif_802.1qbh = </td>
+ <td>(ListOpt) Nova compute nodes to manually set VIF type to 802.1qbh</td>
+ </tr>
+ <tr>
+ <td>node_override_vif_binding_failed = </td>
+ <td>(ListOpt) Nova compute nodes to manually set VIF type to binding_failed</td>
+ </tr>
+ <tr>
+ <td>node_override_vif_bridge = </td>
+ <td>(ListOpt) Nova compute nodes to manually set VIF type to bridge</td>
+ </tr>
+ <tr>
+ <td>node_override_vif_hostdev = </td>
+ <td>(ListOpt) Nova compute nodes to manually set VIF type to hostdev</td>
+ </tr>
+ <tr>
+ <td>node_override_vif_hyperv = </td>
+ <td>(ListOpt) Nova compute nodes to manually set VIF type to hyperv</td>
+ </tr>
+ <tr>
+ <td>node_override_vif_ivs = </td>
+ <td>(ListOpt) Nova compute nodes to manually set VIF type to ivs</td>
+ </tr>
+ <tr>
+ <td>node_override_vif_midonet = </td>
+ <td>(ListOpt) Nova compute nodes to manually set VIF type to midonet</td>
+ </tr>
+ <tr>
+ <td>node_override_vif_mlnx_direct = </td>
+ <td>(ListOpt) Nova compute nodes to manually set VIF type to mlnx_direct</td>
+ </tr>
+ <tr>
+ <td>node_override_vif_other = </td>
+ <td>(ListOpt) Nova compute nodes to manually set VIF type to other</td>
+ </tr>
+ <tr>
+ <td>node_override_vif_ovs = </td>
+ <td>(ListOpt) Nova compute nodes to manually set VIF type to ovs</td>
+ </tr>
+ <tr>
+ <td>node_override_vif_unbound = </td>
+ <td>(ListOpt) Nova compute nodes to manually set VIF type to unbound</td>
+ </tr>
+ <tr>
+ <td>vif_type = ovs</td>
+ <td>(StrOpt) Virtual interface type to configure on Nova compute nodes</td>
+ </tr>
+ <tr>
+ <td>vif_types = unbound, binding_failed, ovs, ivs, bridge, 802.1qbg, 802.1qbh, hyperv, midonet, mlnx_direct, hostdev, other</td>
+ <td>(ListOpt) List of allowed vif_type values.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[RESTPROXY]</th>
+ </tr>
+ <tr>
+ <td>add_meta_server_route = True</td>
+ <td>(BoolOpt) Flag to decide if a route to the metadata server should be injected into the VM</td>
+ </tr>
+ <tr>
+ <td>auto_sync_on_failure = True</td>
+ <td>(BoolOpt) If neutron fails to create a resource because the backend controller doesn't know of a dependency, the plugin automatically triggers a full data synchronization to the controller.</td>
+ </tr>
+ <tr>
+ <td>cache_connections = True</td>
+ <td>(BoolOpt) Re-use HTTP/HTTPS connections to the controller.</td>
+ </tr>
+ <tr>
+ <td>consistency_interval = 60</td>
+ <td>(IntOpt) Time between verifications that the backend controller database is consistent with Neutron. (0 to disable)</td>
+ </tr>
+ <tr>
+ <td>neutron_id = neutron-oslo</td>
+ <td>(StrOpt) User defined identifier for this Neutron deployment</td>
+ </tr>
+ <tr>
+ <td>no_ssl_validation = False</td>
+ <td>(BoolOpt) Disables SSL certificate validation for controllers</td>
+ </tr>
+ <tr>
+ <td>server_auth = None</td>
+ <td>(StrOpt) The username and password for authenticating against the Big Switch or Floodlight controller.</td>
+ </tr>
+ <tr>
+ <td>server_ssl = True</td>
+ <td>(BoolOpt) If True, Use SSL when connecting to the Big Switch or Floodlight controller.</td>
+ </tr>
+ <tr>
+ <td>server_timeout = 10</td>
+ <td>(IntOpt) Maximum number of seconds to wait for proxy request to connect and complete.</td>
+ </tr>
+ <tr>
+ <td>servers = localhost:8800</td>
+ <td>(ListOpt) A comma separated list of Big Switch or Floodlight servers and port numbers. The plugin proxies the requests to the Big Switch/Floodlight server, which performs the networking configuration. Only oneserver is needed per deployment, but you may wish todeploy multiple servers to support failover.</td>
+ </tr>
+ <tr>
+ <td>ssl_cert_directory = /etc/neutron/plugins/bigswitch/ssl</td>
+ <td>(StrOpt) Directory containing ca_certs and host_certs certificate directories.</td>
+ </tr>
+ <tr>
+ <td>ssl_sticky = True</td>
+ <td>(BoolOpt) Trust and store the first certificate received for each controller address and use it to validate future connections to that address.</td>
+ </tr>
+ <tr>
+ <td>sync_data = False</td>
+ <td>(BoolOpt) Sync data on connect</td>
+ </tr>
+ <tr>
+ <td>thread_pool_size = 4</td>
+ <td>(IntOpt) Maximum number of threads to spawn to handle large volumes of port creations.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[RESTPROXYAGENT]</th>
+ </tr>
+ <tr>
+ <td>integration_bridge = br-int</td>
+ <td>(StrOpt) Name of integration bridge on compute nodes used for security group insertion.</td>
+ </tr>
+ <tr>
+ <td>polling_interval = 5</td>
+ <td>(IntOpt) Seconds between agent checks for port changes</td>
+ </tr>
+ <tr>
+ <td>virtual_switch_type = ovs</td>
+ <td>(StrOpt) Virtual switch type.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[ROUTER]</th>
+ </tr>
+ <tr>
+ <td>max_router_rules = 200</td>
+ <td>(IntOpt) Maximum number of router rules</td>
+ </tr>
+ <tr>
+ <td>tenant_default_router_rule = ['*:any:any:permit']</td>
+ <td>(MultiStrOpt) The default router rules installed in new tenant routers. Repeat the config option for each rule. Format is <tenant>:<source>:<destination>:<action> Use an * to specify default for all tenants.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-brocade.xml b/doc/common/tables/neutron-brocade.xml
index 190135f0f5..7c8f4037e9 100644
--- a/doc/common/tables/neutron-brocade.xml
+++ b/doc/common/tables/neutron-brocade.xml
@@ -1,46 +1,45 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_brocade">
- <caption>Description of configuration options for brocade</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">[PHYSICAL_INTERFACE]</th>
- </tr>
- <tr>
- <td>physical_interface = eth0</td>
- <td>(StrOpt) The network interface to use when creatinga port</td>
- </tr>
- <tr>
- <th colspan="2">[SWITCH]</th>
- </tr>
- <tr>
- <td>address = </td>
- <td>(StrOpt) The address of the host to SSH to</td>
- </tr>
- <tr>
- <td>ostype = NOS</td>
- <td>(StrOpt) Currently unused</td>
- </tr>
- <tr>
- <td>password = </td>
- <td>(StrOpt) The SSH password to use</td>
- </tr>
- <tr>
- <td>username = </td>
- <td>(StrOpt) The SSH username to use</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_brocade">
+ <caption>Description of configuration options for brocade</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">[PHYSICAL_INTERFACE]</th>
+ </tr>
+ <tr>
+ <td>physical_interface = eth0</td>
+ <td>(StrOpt) The network interface to use when creatinga port</td>
+ </tr>
+ <tr>
+ <th colspan="2">[SWITCH]</th>
+ </tr>
+ <tr>
+ <td>address = </td>
+ <td>(StrOpt) The address of the host to SSH to</td>
+ </tr>
+ <tr>
+ <td>ostype = NOS</td>
+ <td>(StrOpt) Currently unused</td>
+ </tr>
+ <tr>
+ <td>password = </td>
+ <td>(StrOpt) The SSH password to use</td>
+ </tr>
+ <tr>
+ <td>username = </td>
+ <td>(StrOpt) The SSH username to use</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-cadf.xml b/doc/common/tables/neutron-cadf.xml
deleted file mode 100644
index b4491d1e30..0000000000
--- a/doc/common/tables/neutron-cadf.xml
+++ /dev/null
@@ -1,31 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_cadf">
- <caption>Description of configuration options for cadf</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">[audit]</th>
- </tr>
- <tr>
- <td>api_audit_map = api_audit_map.conf</td>
- <td>(StrOpt) File containing mapping for api paths and service endpoints</td>
- </tr>
- <tr>
- <td>namespace = openstack</td>
- <td>(StrOpt) namespace prefix for generated id</td>
- </tr>
- </tbody>
- </table>
- </para>
diff --git a/doc/common/tables/neutron-cisco.xml b/doc/common/tables/neutron-cisco.xml
index 928b393fe3..1b9d80381f 100644
--- a/doc/common/tables/neutron-cisco.xml
+++ b/doc/common/tables/neutron-cisco.xml
@@ -1,131 +1,134 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_cisco">
- <caption>Description of configuration options for cisco</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">[CISCO]</th>
- </tr>
- <tr>
- <td>model_class = neutron.plugins.cisco.models.virt_phy_sw_v2.VirtualPhysicalSwitchModelV2</td>
- <td>(StrOpt) Model Class</td>
- </tr>
- <tr>
- <td>nexus_driver = neutron.plugins.cisco.test.nexus.fake_nexus_driver.CiscoNEXUSFakeDriver</td>
- <td>(StrOpt) Nexus Driver Name</td>
- </tr>
- <tr>
- <td>nexus_l3_enable = False</td>
- <td>(BoolOpt) Enable L3 support on the Nexus switches</td>
- </tr>
- <tr>
- <td>provider_vlan_auto_create = True</td>
- <td>(BoolOpt) Provider VLANs are automatically created as needed on the Nexus switch</td>
- </tr>
- <tr>
- <td>provider_vlan_auto_trunk = True</td>
- <td>(BoolOpt) Provider VLANs are automatically trunked as needed on the ports of the Nexus switch</td>
- </tr>
- <tr>
- <td>provider_vlan_name_prefix = p-</td>
- <td>(StrOpt) VLAN Name prefix for provider vlans</td>
- </tr>
- <tr>
- <td>svi_round_robin = False</td>
- <td>(BoolOpt) Distribute SVI interfaces over all switches</td>
- </tr>
- <tr>
- <td>vlan_name_prefix = q-</td>
- <td>(StrOpt) VLAN Name prefix</td>
- </tr>
- <tr>
- <th colspan="2">[CISCO_N1K]</th>
- </tr>
- <tr>
- <td>bridge_mappings = </td>
- <td>(StrOpt) N1K Bridge Mappings</td>
- </tr>
- <tr>
- <td>default_network_profile = default_network_profile</td>
- <td>(StrOpt) N1K default network profile</td>
- </tr>
- <tr>
- <td>default_policy_profile = service_profile</td>
- <td>(StrOpt) N1K default policy profile</td>
- </tr>
- <tr>
- <td>enable_tunneling = True</td>
- <td>(BoolOpt) N1K Enable Tunneling</td>
- </tr>
- <tr>
- <td>integration_bridge = br-int</td>
- <td>(StrOpt) N1K Integration Bridge</td>
- </tr>
- <tr>
- <td>network_node_policy_profile = dhcp_pp</td>
- <td>(StrOpt) N1K policy profile for network node</td>
- </tr>
- <tr>
- <td>network_vlan_ranges = vlan:1:4095</td>
- <td>(StrOpt) N1K Network VLAN Ranges</td>
- </tr>
- <tr>
- <td>poll_duration = 10</td>
- <td>(StrOpt) N1K Policy profile polling duration in seconds</td>
- </tr>
- <tr>
- <td>tenant_network_type = local</td>
- <td>(StrOpt) N1K Tenant Network Type</td>
- </tr>
- <tr>
- <td>tunnel_bridge = br-tun</td>
- <td>(StrOpt) N1K Tunnel Bridge</td>
- </tr>
- <tr>
- <td>vxlan_id_ranges = 5000:10000</td>
- <td>(StrOpt) N1K VXLAN ID Ranges</td>
- </tr>
- <tr>
- <th colspan="2">[CISCO_PLUGINS]</th>
- </tr>
- <tr>
- <td>nexus_plugin = neutron.plugins.cisco.nexus.cisco_nexus_plugin_v2.NexusPlugin</td>
- <td>(StrOpt) Nexus Switch to use</td>
- </tr>
- <tr>
- <td>vswitch_plugin = neutron.plugins.openvswitch.ovs_neutron_plugin.OVSNeutronPluginV2</td>
- <td>(StrOpt) Virtual Switch to use</td>
- </tr>
- <tr>
- <th colspan="2">[cisco_csr_ipsec]</th>
- </tr>
- <tr>
- <td>status_check_interval = 60</td>
- <td>(IntOpt) Status check interval for Cisco CSR IPSec connections</td>
- </tr>
- <tr>
- <th colspan="2">[ml2_cisco]</th>
- </tr>
- <tr>
- <td>svi_round_robin = False</td>
- <td>(BoolOpt) Distribute SVI interfaces over all switches</td>
- </tr>
- <tr>
- <td>vlan_name_prefix = q-</td>
- <td>(StrOpt) VLAN Name prefix</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_cisco">
+ <caption>Description of configuration options for cisco</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">[CISCO]</th>
+ </tr>
+ <tr>
+ <td>model_class = neutron.plugins.cisco.models.virt_phy_sw_v2.VirtualPhysicalSwitchModelV2</td>
+ <td>(StrOpt) Model Class</td>
+ </tr>
+ <tr>
+ <td>nexus_driver = neutron.plugins.cisco.test.nexus.fake_nexus_driver.CiscoNEXUSFakeDriver</td>
+ <td>(StrOpt) Nexus Driver Name</td>
+ </tr>
+ <tr>
+ <td>nexus_l3_enable = False</td>
+ <td>(BoolOpt) Enable L3 support on the Nexus switches</td>
+ </tr>
+ <tr>
+ <td>provider_vlan_auto_create = True</td>
+ <td>(BoolOpt) Provider VLANs are automatically created as needed on the Nexus switch</td>
+ </tr>
+ <tr>
+ <td>provider_vlan_auto_trunk = True</td>
+ <td>(BoolOpt) Provider VLANs are automatically trunked as needed on the ports of the Nexus switch</td>
+ </tr>
+ <tr>
+ <td>provider_vlan_name_prefix = p-</td>
+ <td>(StrOpt) VLAN Name prefix for provider vlans</td>
+ </tr>
+ <tr>
+ <td>svi_round_robin = False</td>
+ <td>(BoolOpt) Distribute SVI interfaces over all switches</td>
+ </tr>
+ <tr>
+ <td>vlan_name_prefix = q-</td>
+ <td>(StrOpt) VLAN Name prefix</td>
+ </tr>
+ <tr>
+ <th colspan="2">[CISCO_N1K]</th>
+ </tr>
+ <tr>
+ <td>bridge_mappings = </td>
+ <td>(StrOpt) N1K Bridge Mappings</td>
+ </tr>
+ <tr>
+ <td>default_network_profile = default_network_profile</td>
+ <td>(StrOpt) N1K default network profile</td>
+ </tr>
+ <tr>
+ <td>default_policy_profile = service_profile</td>
+ <td>(StrOpt) N1K default policy profile</td>
+ </tr>
+ <tr>
+ <td>enable_tunneling = True</td>
+ <td>(BoolOpt) N1K Enable Tunneling</td>
+ </tr>
+ <tr>
+ <td>http_pool_size = 4</td>
+ <td>(IntOpt) Number of threads to use to make HTTP requests</td>
+ </tr>
+ <tr>
+ <td>integration_bridge = br-int</td>
+ <td>(StrOpt) N1K Integration Bridge</td>
+ </tr>
+ <tr>
+ <td>network_node_policy_profile = dhcp_pp</td>
+ <td>(StrOpt) N1K policy profile for network node</td>
+ </tr>
+ <tr>
+ <td>network_vlan_ranges = vlan:1:4095</td>
+ <td>(StrOpt) N1K Network VLAN Ranges</td>
+ </tr>
+ <tr>
+ <td>poll_duration = 10</td>
+ <td>(IntOpt) N1K Policy profile polling duration in seconds</td>
+ </tr>
+ <tr>
+ <td>tenant_network_type = local</td>
+ <td>(StrOpt) N1K Tenant Network Type</td>
+ </tr>
+ <tr>
+ <td>tunnel_bridge = br-tun</td>
+ <td>(StrOpt) N1K Tunnel Bridge</td>
+ </tr>
+ <tr>
+ <td>vxlan_id_ranges = 5000:10000</td>
+ <td>(StrOpt) N1K VXLAN ID Ranges</td>
+ </tr>
+ <tr>
+ <th colspan="2">[CISCO_PLUGINS]</th>
+ </tr>
+ <tr>
+ <td>nexus_plugin = neutron.plugins.cisco.nexus.cisco_nexus_plugin_v2.NexusPlugin</td>
+ <td>(StrOpt) Nexus Switch to use</td>
+ </tr>
+ <tr>
+ <td>vswitch_plugin = neutron.plugins.openvswitch.ovs_neutron_plugin.OVSNeutronPluginV2</td>
+ <td>(StrOpt) Virtual Switch to use</td>
+ </tr>
+ <tr>
+ <th colspan="2">[cisco_csr_ipsec]</th>
+ </tr>
+ <tr>
+ <td>status_check_interval = 60</td>
+ <td>(IntOpt) Status check interval for Cisco CSR IPSec connections</td>
+ </tr>
+ <tr>
+ <th colspan="2">[ml2_cisco]</th>
+ </tr>
+ <tr>
+ <td>svi_round_robin = False</td>
+ <td>(BoolOpt) Distribute SVI interfaces over all switches</td>
+ </tr>
+ <tr>
+ <td>vlan_name_prefix = q-</td>
+ <td>(StrOpt) VLAN Name prefix</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-common.xml b/doc/common/tables/neutron-common.xml
index 947a7abd34..4a743ff46e 100644
--- a/doc/common/tables/neutron-common.xml
+++ b/doc/common/tables/neutron-common.xml
@@ -1,224 +1,223 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_common">
- <caption>Description of configuration options for common</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>admin_password = None</td>
- <td>(StrOpt) Admin password</td>
- </tr>
- <tr>
- <td>admin_tenant_name = None</td>
- <td>(StrOpt) Admin tenant name</td>
- </tr>
- <tr>
- <td>admin_user = None</td>
- <td>(StrOpt) Admin username</td>
- </tr>
- <tr>
- <td>agent_down_time = 75</td>
- <td>(IntOpt) Seconds to regard the agent is down; should be at least twice report_interval, to be sure the agent is down for good.</td>
- </tr>
- <tr>
- <td>allowed_rpc_exception_modules = nova.exception, cinder.exception, exceptions</td>
- <td>(ListOpt) Modules of exceptions that are permitted to be recreated upon receiving exception data from an rpc call.</td>
- </tr>
- <tr>
- <td>api_workers = 0</td>
- <td>(IntOpt) Number of separate worker processes for service</td>
- </tr>
- <tr>
- <td>auth_ca_cert = None</td>
- <td>(StrOpt) Certificate Authority public key (CA cert) file for ssl</td>
- </tr>
- <tr>
- <td>auth_insecure = False</td>
- <td>(BoolOpt) Turn off verification of the certificate for ssl</td>
- </tr>
- <tr>
- <td>auth_region = None</td>
- <td>(StrOpt) Authentication region</td>
- </tr>
- <tr>
- <td>auth_strategy = keystone</td>
- <td>(StrOpt) The type of authentication to use</td>
- </tr>
- <tr>
- <td>auth_url = None</td>
- <td>(StrOpt) Authentication URL</td>
- </tr>
- <tr>
- <td>base_mac = fa:16:3e:00:00:00</td>
- <td>(StrOpt) The base MAC address Neutron will use for VIFs</td>
- </tr>
- <tr>
- <td>bind_host = 0.0.0.0</td>
- <td>(StrOpt) The host IP to bind to</td>
- </tr>
- <tr>
- <td>bind_port = 9696</td>
- <td>(IntOpt) The port to bind to</td>
- </tr>
- <tr>
- <td>ca_certs = None</td>
- <td>(StrOpt) CA certificates</td>
- </tr>
- <tr>
- <td>core_plugin = None</td>
- <td>(StrOpt) The core plugin Neutron will use</td>
- </tr>
- <tr>
- <td>ctl_cert = None</td>
- <td>(StrOpt) controller certificate</td>
- </tr>
- <tr>
- <td>ctl_privkey = None</td>
- <td>(StrOpt) controller private key</td>
- </tr>
- <tr>
- <td>dhcp_agent_notification = True</td>
- <td>(BoolOpt) Allow sending resource operation notification to DHCP agent</td>
- </tr>
- <tr>
- <td>dhcp_agents_per_network = 1</td>
- <td>(IntOpt) Number of DHCP agents scheduled to host a network.</td>
- </tr>
- <tr>
- <td>dhcp_confs = $state_path/dhcp</td>
- <td>(StrOpt) Location to store DHCP server config files</td>
- </tr>
- <tr>
- <td>dhcp_delete_namespaces = False</td>
- <td>(BoolOpt) Delete namespace after removing a dhcp server.</td>
- </tr>
- <tr>
- <td>dhcp_domain = openstacklocal</td>
- <td>(StrOpt) Domain to use for building the hostnames</td>
- </tr>
- <tr>
- <td>dhcp_driver = neutron.agent.linux.dhcp.Dnsmasq</td>
- <td>(StrOpt) The driver used to manage the DHCP server.</td>
- </tr>
- <tr>
- <td>dhcp_lease_duration = 86400</td>
- <td>(IntOpt) DHCP lease duration</td>
- </tr>
- <tr>
- <td>disable_process_locking = False</td>
- <td>(BoolOpt) Whether to disable inter-process locks</td>
- </tr>
- <tr>
- <td>endpoint_type = adminURL</td>
- <td>(StrOpt) Network service endpoint type to pull from the keystone catalog</td>
- </tr>
- <tr>
- <td>force_gateway_on_subnet = False</td>
- <td>(BoolOpt) Ensure that configured gateway is on subnet</td>
- </tr>
- <tr>
- <td>interface_driver = None</td>
- <td>(StrOpt) The driver used to manage the virtual interface.</td>
- </tr>
- <tr>
- <td>ip_lib_force_root = False</td>
- <td>(BoolOpt) Force ip_lib calls to use the root helper</td>
- </tr>
- <tr>
- <td>lock_path = None</td>
- <td>(StrOpt) Directory to use for lock files.</td>
- </tr>
- <tr>
- <td>mac_generation_retries = 16</td>
- <td>(IntOpt) How many times Neutron will retry MAC generation</td>
- </tr>
- <tr>
- <td>max_dns_nameservers = 5</td>
- <td>(IntOpt) Maximum number of DNS nameservers</td>
- </tr>
- <tr>
- <td>max_fixed_ips_per_port = 5</td>
- <td>(IntOpt) Maximum number of fixed ips per port</td>
- </tr>
- <tr>
- <td>max_subnet_host_routes = 20</td>
- <td>(IntOpt) Maximum number of host routes per subnet</td>
- </tr>
- <tr>
- <td>periodic_fuzzy_delay = 5</td>
- <td>(IntOpt) Range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0)</td>
- </tr>
- <tr>
- <td>periodic_interval = 40</td>
- <td>(IntOpt) Seconds between running periodic tasks</td>
- </tr>
- <tr>
- <td>report_interval = 300</td>
- <td>(IntOpt) Interval between two metering reports</td>
- </tr>
- <tr>
- <td>root_helper = sudo</td>
- <td>(StrOpt) Root helper application.</td>
- </tr>
- <tr>
- <td>state_path = /var/lib/neutron</td>
- <td>(StrOpt) Where to store Neutron state files. This directory must be writable by the agent.</td>
- </tr>
- <tr>
- <th colspan="2">[AGENT]</th>
- </tr>
- <tr>
- <td>root_helper = sudo</td>
- <td>(StrOpt) Root helper application.</td>
- </tr>
- <tr>
- <th colspan="2">[PROXY]</th>
- </tr>
- <tr>
- <td>admin_password = None</td>
- <td>(StrOpt) Admin password</td>
- </tr>
- <tr>
- <td>admin_tenant_name = None</td>
- <td>(StrOpt) Admin tenant name</td>
- </tr>
- <tr>
- <td>admin_user = None</td>
- <td>(StrOpt) Admin user</td>
- </tr>
- <tr>
- <td>auth_region = None</td>
- <td>(StrOpt) Authentication region</td>
- </tr>
- <tr>
- <td>auth_strategy = keystone</td>
- <td>(StrOpt) The type of authentication to use</td>
- </tr>
- <tr>
- <td>auth_url = None</td>
- <td>(StrOpt) Authentication URL</td>
- </tr>
- <tr>
- <th colspan="2">[heleos]</th>
- </tr>
- <tr>
- <td>admin_password = None</td>
- <td>(StrOpt) ESM admin password.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_common">
+ <caption>Description of configuration options for common</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>admin_password = None</td>
+ <td>(StrOpt) Admin password</td>
+ </tr>
+ <tr>
+ <td>admin_tenant_name = None</td>
+ <td>(StrOpt) Admin tenant name</td>
+ </tr>
+ <tr>
+ <td>admin_user = None</td>
+ <td>(StrOpt) Admin username</td>
+ </tr>
+ <tr>
+ <td>agent_down_time = 75</td>
+ <td>(IntOpt) Seconds to regard the agent is down; should be at least twice report_interval, to be sure the agent is down for good.</td>
+ </tr>
+ <tr>
+ <td>allowed_rpc_exception_modules = nova.exception, cinder.exception, exceptions</td>
+ <td>(ListOpt) Modules of exceptions that are permitted to be recreated upon receiving exception data from an rpc call.</td>
+ </tr>
+ <tr>
+ <td>api_workers = 0</td>
+ <td>(IntOpt) Number of separate worker processes for service</td>
+ </tr>
+ <tr>
+ <td>auth_ca_cert = None</td>
+ <td>(StrOpt) Certificate Authority public key (CA cert) file for ssl</td>
+ </tr>
+ <tr>
+ <td>auth_insecure = False</td>
+ <td>(BoolOpt) Turn off verification of the certificate for ssl</td>
+ </tr>
+ <tr>
+ <td>auth_region = None</td>
+ <td>(StrOpt) Authentication region</td>
+ </tr>
+ <tr>
+ <td>auth_strategy = keystone</td>
+ <td>(StrOpt) The type of authentication to use</td>
+ </tr>
+ <tr>
+ <td>auth_url = None</td>
+ <td>(StrOpt) Authentication URL</td>
+ </tr>
+ <tr>
+ <td>base_mac = fa:16:3e:00:00:00</td>
+ <td>(StrOpt) The base MAC address Neutron will use for VIFs</td>
+ </tr>
+ <tr>
+ <td>bind_host = 0.0.0.0</td>
+ <td>(StrOpt) The host IP to bind to</td>
+ </tr>
+ <tr>
+ <td>bind_port = 9696</td>
+ <td>(IntOpt) The port to bind to</td>
+ </tr>
+ <tr>
+ <td>ca_certs = None</td>
+ <td>(StrOpt) CA certificates</td>
+ </tr>
+ <tr>
+ <td>core_plugin = None</td>
+ <td>(StrOpt) The core plugin Neutron will use</td>
+ </tr>
+ <tr>
+ <td>ctl_cert = None</td>
+ <td>(StrOpt) controller certificate</td>
+ </tr>
+ <tr>
+ <td>ctl_privkey = None</td>
+ <td>(StrOpt) controller private key</td>
+ </tr>
+ <tr>
+ <td>dhcp_agent_notification = True</td>
+ <td>(BoolOpt) Allow sending resource operation notification to DHCP agent</td>
+ </tr>
+ <tr>
+ <td>dhcp_agents_per_network = 1</td>
+ <td>(IntOpt) Number of DHCP agents scheduled to host a network.</td>
+ </tr>
+ <tr>
+ <td>dhcp_confs = $state_path/dhcp</td>
+ <td>(StrOpt) Location to store DHCP server config files</td>
+ </tr>
+ <tr>
+ <td>dhcp_delete_namespaces = False</td>
+ <td>(BoolOpt) Delete namespace after removing a dhcp server.</td>
+ </tr>
+ <tr>
+ <td>dhcp_domain = openstacklocal</td>
+ <td>(StrOpt) Domain to use for building the hostnames</td>
+ </tr>
+ <tr>
+ <td>dhcp_driver = neutron.agent.linux.dhcp.Dnsmasq</td>
+ <td>(StrOpt) The driver used to manage the DHCP server.</td>
+ </tr>
+ <tr>
+ <td>dhcp_lease_duration = 86400</td>
+ <td>(IntOpt) DHCP lease duration (in seconds). Use -1 to tell dnsmasq to use infinite lease times.</td>
+ </tr>
+ <tr>
+ <td>disable_process_locking = False</td>
+ <td>(BoolOpt) Whether to disable inter-process locks</td>
+ </tr>
+ <tr>
+ <td>endpoint_type = adminURL</td>
+ <td>(StrOpt) Network service endpoint type to pull from the keystone catalog</td>
+ </tr>
+ <tr>
+ <td>force_gateway_on_subnet = False</td>
+ <td>(BoolOpt) Ensure that configured gateway is on subnet</td>
+ </tr>
+ <tr>
+ <td>interface_driver = None</td>
+ <td>(StrOpt) The driver used to manage the virtual interface.</td>
+ </tr>
+ <tr>
+ <td>ip_lib_force_root = False</td>
+ <td>(BoolOpt) Force ip_lib calls to use the root helper</td>
+ </tr>
+ <tr>
+ <td>lock_path = None</td>
+ <td>(StrOpt) Directory to use for lock files.</td>
+ </tr>
+ <tr>
+ <td>mac_generation_retries = 16</td>
+ <td>(IntOpt) How many times Neutron will retry MAC generation</td>
+ </tr>
+ <tr>
+ <td>max_dns_nameservers = 5</td>
+ <td>(IntOpt) Maximum number of DNS nameservers</td>
+ </tr>
+ <tr>
+ <td>max_fixed_ips_per_port = 5</td>
+ <td>(IntOpt) Maximum number of fixed ips per port</td>
+ </tr>
+ <tr>
+ <td>max_subnet_host_routes = 20</td>
+ <td>(IntOpt) Maximum number of host routes per subnet</td>
+ </tr>
+ <tr>
+ <td>periodic_fuzzy_delay = 5</td>
+ <td>(IntOpt) Range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0)</td>
+ </tr>
+ <tr>
+ <td>periodic_interval = 40</td>
+ <td>(IntOpt) Seconds between running periodic tasks</td>
+ </tr>
+ <tr>
+ <td>report_interval = 300</td>
+ <td>(IntOpt) Interval between two metering reports</td>
+ </tr>
+ <tr>
+ <td>root_helper = sudo</td>
+ <td>(StrOpt) Root helper application.</td>
+ </tr>
+ <tr>
+ <td>state_path = /var/lib/neutron</td>
+ <td>(StrOpt) Where to store Neutron state files. This directory must be writable by the agent.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[AGENT]</th>
+ </tr>
+ <tr>
+ <td>root_helper = sudo</td>
+ <td>(StrOpt) Root helper application.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[PROXY]</th>
+ </tr>
+ <tr>
+ <td>admin_password = None</td>
+ <td>(StrOpt) Admin password</td>
+ </tr>
+ <tr>
+ <td>admin_tenant_name = None</td>
+ <td>(StrOpt) Admin tenant name</td>
+ </tr>
+ <tr>
+ <td>admin_user = None</td>
+ <td>(StrOpt) Admin user</td>
+ </tr>
+ <tr>
+ <td>auth_region = None</td>
+ <td>(StrOpt) Authentication region</td>
+ </tr>
+ <tr>
+ <td>auth_strategy = keystone</td>
+ <td>(StrOpt) The type of authentication to use</td>
+ </tr>
+ <tr>
+ <td>auth_url = None</td>
+ <td>(StrOpt) Authentication URL</td>
+ </tr>
+ <tr>
+ <th colspan="2">[heleos]</th>
+ </tr>
+ <tr>
+ <td>admin_password = None</td>
+ <td>(StrOpt) ESM admin password.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-compute.xml b/doc/common/tables/neutron-compute.xml
index 86bae07640..ad85507341 100644
--- a/doc/common/tables/neutron-compute.xml
+++ b/doc/common/tables/neutron-compute.xml
@@ -1,59 +1,74 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_compute">
- <caption>Description of configuration options for compute</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>notify_nova_on_port_data_changes = True</td>
- <td>(BoolOpt) Send notification to nova when port data (fixed_ips/floatingip) changes so nova can update its cache.</td>
- </tr>
- <tr>
- <td>notify_nova_on_port_status_changes = True</td>
- <td>(BoolOpt) Send notification to nova when port status changes</td>
- </tr>
- <tr>
- <td>nova_admin_auth_url = http://localhost:5000/v2.0</td>
- <td>(StrOpt) Authorization URL for connecting to nova in admin context</td>
- </tr>
- <tr>
- <td>nova_admin_password = None</td>
- <td>(StrOpt) Password for connection to nova in admin context</td>
- </tr>
- <tr>
- <td>nova_admin_tenant_id = None</td>
- <td>(StrOpt) The uuid of the admin nova tenant</td>
- </tr>
- <tr>
- <td>nova_admin_username = None</td>
- <td>(StrOpt) Username for connecting to nova in admin context</td>
- </tr>
- <tr>
- <td>nova_region_name = None</td>
- <td>(StrOpt) Name of nova region to use. Useful if keystone manages more than one region.</td>
- </tr>
- <tr>
- <td>nova_url = http://127.0.0.1:8774</td>
- <td>(StrOpt) URL for connection to nova</td>
- </tr>
- <tr>
- <td>send_events_interval = 2</td>
- <td>(IntOpt) Number of seconds between sending events to nova if there are any events to send.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_compute">
+ <caption>Description of configuration options for compute</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>notify_nova_on_port_data_changes = True</td>
+ <td>(BoolOpt) Send notification to nova when port data (fixed_ips/floatingip) changes so nova can update its cache.</td>
+ </tr>
+ <tr>
+ <td>notify_nova_on_port_status_changes = True</td>
+ <td>(BoolOpt) Send notification to nova when port status changes</td>
+ </tr>
+ <tr>
+ <td>nova_admin_auth_url = http://localhost:5000/v2.0</td>
+ <td>(StrOpt) Authorization URL for connecting to nova in admin context</td>
+ </tr>
+ <tr>
+ <td>nova_admin_password = None</td>
+ <td>(StrOpt) Password for connection to nova in admin context</td>
+ </tr>
+ <tr>
+ <td>nova_admin_tenant_id = None</td>
+ <td>(StrOpt) The uuid of the admin nova tenant</td>
+ </tr>
+ <tr>
+ <td>nova_admin_username = None</td>
+ <td>(StrOpt) Username for connecting to nova in admin context</td>
+ </tr>
+ <tr>
+ <td>nova_api_insecure = False</td>
+ <td>(BoolOpt) If True, ignore any SSL validation issues</td>
+ </tr>
+ <tr>
+ <td>nova_ca_certificates_file = None</td>
+ <td>(StrOpt) CA file for novaclient to verify server certificates</td>
+ </tr>
+ <tr>
+ <td>nova_client_cert = </td>
+ <td>(StrOpt) Client certificate for nova metadata api server.</td>
+ </tr>
+ <tr>
+ <td>nova_client_priv_key = </td>
+ <td>(StrOpt) Private key of client certificate.</td>
+ </tr>
+ <tr>
+ <td>nova_region_name = None</td>
+ <td>(StrOpt) Name of nova region to use. Useful if keystone manages more than one region.</td>
+ </tr>
+ <tr>
+ <td>nova_url = http://127.0.0.1:8774/v2</td>
+ <td>(StrOpt) URL for connection to nova</td>
+ </tr>
+ <tr>
+ <td>send_events_interval = 2</td>
+ <td>(IntOpt) Number of seconds between sending events to nova if there are any events to send.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-database.xml b/doc/common/tables/neutron-database.xml
new file mode 100644
index 0000000000..6588e40608
--- /dev/null
+++ b/doc/common/tables/neutron-database.xml
@@ -0,0 +1,98 @@
+<?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_neutron_database">
+ <caption>Description of configuration options for database</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[database]</th>
+ </tr>
+ <tr>
+ <td>backend = sqlalchemy</td>
+ <td>(StrOpt) The backend to use for db</td>
+ </tr>
+ <tr>
+ <td>connection = sqlite://</td>
+ <td>(StrOpt) The SQLAlchemy connection string used to connect to the database</td>
+ </tr>
+ <tr>
+ <td>connection_debug = 0</td>
+ <td>(IntOpt) Verbosity of SQL debugging information. 0=None, 100=Everything</td>
+ </tr>
+ <tr>
+ <td>connection_trace = False</td>
+ <td>(BoolOpt) Add python stack traces to SQL as comment strings</td>
+ </tr>
+ <tr>
+ <td>db_inc_retry_interval = True</td>
+ <td>(BoolOpt) Whether to increase interval between db connection retries, up to db_max_retry_interval</td>
+ </tr>
+ <tr>
+ <td>db_max_retries = 20</td>
+ <td>(IntOpt) maximum db connection retries before error is raised. (setting -1 implies an infinite retry count)</td>
+ </tr>
+ <tr>
+ <td>db_max_retry_interval = 10</td>
+ <td>(IntOpt) max seconds between db connection retries, if db_inc_retry_interval is enabled</td>
+ </tr>
+ <tr>
+ <td>db_retry_interval = 1</td>
+ <td>(IntOpt) seconds between db connection retries</td>
+ </tr>
+ <tr>
+ <td>idle_timeout = 3600</td>
+ <td>(IntOpt) Timeout before idle sql connections are reaped</td>
+ </tr>
+ <tr>
+ <td>max_overflow = 20</td>
+ <td>(IntOpt) If set, use this value for max_overflow with sqlalchemy</td>
+ </tr>
+ <tr>
+ <td>max_pool_size = 10</td>
+ <td>(IntOpt) Maximum number of SQL connections to keep open in a pool</td>
+ </tr>
+ <tr>
+ <td>max_retries = 10</td>
+ <td>(IntOpt) Maximum db connection retries during startup. (setting -1 implies an infinite retry count)</td>
+ </tr>
+ <tr>
+ <td>min_pool_size = 1</td>
+ <td>(IntOpt) Minimum number of SQL connections to keep open in a pool</td>
+ </tr>
+ <tr>
+ <td>mysql_sql_mode = TRADITIONAL</td>
+ <td>(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=</td>
+ </tr>
+ <tr>
+ <td>pool_timeout = 10</td>
+ <td>(IntOpt) If set, use this value for pool_timeout with sqlalchemy</td>
+ </tr>
+ <tr>
+ <td>retry_interval = 10</td>
+ <td>(IntOpt) Interval between retries of opening a sql connection</td>
+ </tr>
+ <tr>
+ <td>sqlite_db = </td>
+ <td>(StrOpt) The file name to use with SQLite</td>
+ </tr>
+ <tr>
+ <td>sqlite_synchronous = True</td>
+ <td>(BoolOpt) If True, SQLite uses synchronous mode</td>
+ </tr>
+ <tr>
+ <td>use_db_reconnect = False</td>
+ <td>(BoolOpt) Enable the experimental use of database reconnect on connection lost</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-db.xml b/doc/common/tables/neutron-db.xml
deleted file mode 100644
index b99ed6637e..0000000000
--- a/doc/common/tables/neutron-db.xml
+++ /dev/null
@@ -1,102 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_db">
- <caption>Description of configuration options for db</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>sqlite_db = </td>
- <td>(StrOpt) The file name to use with SQLite</td>
- </tr>
- <tr>
- <td>sqlite_synchronous = True</td>
- <td>(BoolOpt) If True, SQLite uses synchronous mode</td>
- </tr>
- <tr>
- <th colspan="2">[database]</th>
- </tr>
- <tr>
- <td>backend = sqlalchemy</td>
- <td>(StrOpt) The backend to use for db</td>
- </tr>
- <tr>
- <td>connection = sqlite://</td>
- <td>(StrOpt) The SQLAlchemy connection string used to connect to the database</td>
- </tr>
- <tr>
- <td>connection_debug = 0</td>
- <td>(IntOpt) Verbosity of SQL debugging information. 0=None, 100=Everything</td>
- </tr>
- <tr>
- <td>connection_trace = False</td>
- <td>(BoolOpt) Add python stack traces to SQL as comment strings</td>
- </tr>
- <tr>
- <td>db_inc_retry_interval = True</td>
- <td>(BoolOpt) Whether to increase interval between db connection retries, up to db_max_retry_interval</td>
- </tr>
- <tr>
- <td>db_max_retries = 20</td>
- <td>(IntOpt) maximum db connection retries before error is raised. (setting -1 implies an infinite retry count)</td>
- </tr>
- <tr>
- <td>db_max_retry_interval = 10</td>
- <td>(IntOpt) max seconds between db connection retries, if db_inc_retry_interval is enabled</td>
- </tr>
- <tr>
- <td>db_retry_interval = 1</td>
- <td>(IntOpt) seconds between db connection retries</td>
- </tr>
- <tr>
- <td>idle_timeout = 3600</td>
- <td>(IntOpt) Timeout before idle sql connections are reaped</td>
- </tr>
- <tr>
- <td>max_overflow = 20</td>
- <td>(IntOpt) If set, use this value for max_overflow with sqlalchemy</td>
- </tr>
- <tr>
- <td>max_pool_size = 10</td>
- <td>(IntOpt) Maximum number of SQL connections to keep open in a pool</td>
- </tr>
- <tr>
- <td>max_retries = 10</td>
- <td>(IntOpt) Maximum db connection retries during startup. (setting -1 implies an infinite retry count)</td>
- </tr>
- <tr>
- <td>min_pool_size = 1</td>
- <td>(IntOpt) Minimum number of SQL connections to keep open in a pool</td>
- </tr>
- <tr>
- <td>pool_timeout = 10</td>
- <td>(IntOpt) If set, use this value for pool_timeout with sqlalchemy</td>
- </tr>
- <tr>
- <td>retry_interval = 10</td>
- <td>(IntOpt) Interval between retries of opening a sql connection</td>
- </tr>
- <tr>
- <td>slave_connection = </td>
- <td>(StrOpt) The SQLAlchemy connection string used to connect to the slave database</td>
- </tr>
- <tr>
- <td>use_db_reconnect = False</td>
- <td>(BoolOpt) Enable the experimental use of database reconnect on connection lost</td>
- </tr>
- </tbody>
- </table>
- </para>
diff --git a/doc/common/tables/neutron-dhcp_agent.xml b/doc/common/tables/neutron-dhcp_agent.xml
index 272398a0dc..506da8ffbd 100644
--- a/doc/common/tables/neutron-dhcp_agent.xml
+++ b/doc/common/tables/neutron-dhcp_agent.xml
@@ -1,55 +1,54 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_dhcp_agent">
- <caption>Description of configuration options for dhcp_agent</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>dnsmasq_config_file = </td>
- <td>(StrOpt) Override the default dnsmasq settings with this file</td>
- </tr>
- <tr>
- <td>dnsmasq_dns_servers = None</td>
- <td>(ListOpt) Comma-separated list of the DNS servers which will be used as forwarders.</td>
- </tr>
- <tr>
- <td>dnsmasq_lease_max = 16777216</td>
- <td>(IntOpt) Limit number of leases to prevent a denial-of-service.</td>
- </tr>
- <tr>
- <td>enable_isolated_metadata = False</td>
- <td>(BoolOpt) Support Metadata requests on isolated networks.</td>
- </tr>
- <tr>
- <td>enable_metadata_network = False</td>
- <td>(BoolOpt) Allows for serving metadata requests from a dedicated network. Requires enable_isolated_metadata = True</td>
- </tr>
- <tr>
- <td>num_sync_threads = 4</td>
- <td>(IntOpt) Number of threads to use during sync process.</td>
- </tr>
- <tr>
- <td>resync_interval = 5</td>
- <td>(IntOpt) Interval to resync.</td>
- </tr>
- <tr>
- <td>use_namespaces = True</td>
- <td>(BoolOpt) Allow overlapping IP.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_dhcp_agent">
+ <caption>Description of configuration options for dhcp_agent</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>dnsmasq_config_file = </td>
+ <td>(StrOpt) Override the default dnsmasq settings with this file</td>
+ </tr>
+ <tr>
+ <td>dnsmasq_dns_servers = None</td>
+ <td>(ListOpt) Comma-separated list of the DNS servers which will be used as forwarders.</td>
+ </tr>
+ <tr>
+ <td>dnsmasq_lease_max = 16777216</td>
+ <td>(IntOpt) Limit number of leases to prevent a denial-of-service.</td>
+ </tr>
+ <tr>
+ <td>enable_isolated_metadata = False</td>
+ <td>(BoolOpt) Support Metadata requests on isolated networks.</td>
+ </tr>
+ <tr>
+ <td>enable_metadata_network = False</td>
+ <td>(BoolOpt) Allows for serving metadata requests from a dedicated network. Requires enable_isolated_metadata = True</td>
+ </tr>
+ <tr>
+ <td>num_sync_threads = 4</td>
+ <td>(IntOpt) Number of threads to use during sync process.</td>
+ </tr>
+ <tr>
+ <td>resync_interval = 5</td>
+ <td>(IntOpt) Interval to resync.</td>
+ </tr>
+ <tr>
+ <td>use_namespaces = True</td>
+ <td>(BoolOpt) Allow overlapping IP.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-embrane.xml b/doc/common/tables/neutron-embrane.xml
index 465908e41d..faf56fe3b1 100644
--- a/doc/common/tables/neutron-embrane.xml
+++ b/doc/common/tables/neutron-embrane.xml
@@ -1,59 +1,58 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_embrane">
- <caption>Description of configuration options for embrane</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">[heleos]</th>
- </tr>
- <tr>
- <td>admin_username = admin</td>
- <td>(StrOpt) ESM admin username.</td>
- </tr>
- <tr>
- <td>async_requests = True</td>
- <td>(BoolOpt) Define if the requests have run asynchronously or not</td>
- </tr>
- <tr>
- <td>dummy_utif_id = None</td>
- <td>(StrOpt) Dummy user traffic Security Zone id</td>
- </tr>
- <tr>
- <td>esm_mgmt = None</td>
- <td>(StrOpt) ESM management root address</td>
- </tr>
- <tr>
- <td>inband_id = None</td>
- <td>(StrOpt) In band Security Zone id</td>
- </tr>
- <tr>
- <td>mgmt_id = None</td>
- <td>(StrOpt) Management Security Zone id</td>
- </tr>
- <tr>
- <td>oob_id = None</td>
- <td>(StrOpt) Out of band Security Zone id</td>
- </tr>
- <tr>
- <td>resource_pool_id = default</td>
- <td>(StrOpt) Shared resource pool id</td>
- </tr>
- <tr>
- <td>router_image = None</td>
- <td>(StrOpt) Router image id (Embrane FW/VPN)</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_embrane">
+ <caption>Description of configuration options for embrane</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">[heleos]</th>
+ </tr>
+ <tr>
+ <td>admin_username = admin</td>
+ <td>(StrOpt) ESM admin username.</td>
+ </tr>
+ <tr>
+ <td>async_requests = True</td>
+ <td>(BoolOpt) Define if the requests have run asynchronously or not</td>
+ </tr>
+ <tr>
+ <td>dummy_utif_id = None</td>
+ <td>(StrOpt) Dummy user traffic Security Zone id</td>
+ </tr>
+ <tr>
+ <td>esm_mgmt = None</td>
+ <td>(StrOpt) ESM management root address</td>
+ </tr>
+ <tr>
+ <td>inband_id = None</td>
+ <td>(StrOpt) In band Security Zone id</td>
+ </tr>
+ <tr>
+ <td>mgmt_id = None</td>
+ <td>(StrOpt) Management Security Zone id</td>
+ </tr>
+ <tr>
+ <td>oob_id = None</td>
+ <td>(StrOpt) Out of band Security Zone id</td>
+ </tr>
+ <tr>
+ <td>resource_pool_id = default</td>
+ <td>(StrOpt) Shared resource pool id</td>
+ </tr>
+ <tr>
+ <td>router_image = None</td>
+ <td>(StrOpt) Router image id (Embrane FW/VPN)</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-embrane_lb.xml b/doc/common/tables/neutron-embrane_lb.xml
index cb2b31c7ae..49a9dba0b1 100644
--- a/doc/common/tables/neutron-embrane_lb.xml
+++ b/doc/common/tables/neutron-embrane_lb.xml
@@ -1,71 +1,70 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_embrane_lb">
- <caption>Description of configuration options for embrane_lb</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">[heleoslb]</th>
- </tr>
- <tr>
- <td>admin_password = None</td>
- <td>(StrOpt) ESM admin password.</td>
- </tr>
- <tr>
- <td>admin_username = None</td>
- <td>(StrOpt) ESM admin username.</td>
- </tr>
- <tr>
- <td>async_requests = None</td>
- <td>(BoolOpt) Define if the requests have run asynchronously or not</td>
- </tr>
- <tr>
- <td>dummy_utif_id = None</td>
- <td>(StrOpt) Dummy user traffic Security Zone id for LBs</td>
- </tr>
- <tr>
- <td>esm_mgmt = None</td>
- <td>(StrOpt) ESM management root address</td>
- </tr>
- <tr>
- <td>inband_id = None</td>
- <td>(StrOpt) In band Security Zone id for LBs</td>
- </tr>
- <tr>
- <td>lb_flavor = small</td>
- <td>(StrOpt) choose LB image flavor to use, accepted values: small, medium</td>
- </tr>
- <tr>
- <td>lb_image = None</td>
- <td>(StrOpt) Load Balancer image id (Embrane LB)</td>
- </tr>
- <tr>
- <td>mgmt_id = None</td>
- <td>(StrOpt) Management Security Zone id for LBs</td>
- </tr>
- <tr>
- <td>oob_id = None</td>
- <td>(StrOpt) Out of band Security Zone id for LBs</td>
- </tr>
- <tr>
- <td>resource_pool_id = None</td>
- <td>(StrOpt) Shared resource pool id</td>
- </tr>
- <tr>
- <td>sync_interval = 60</td>
- <td>(IntOpt) resource synchronization interval in seconds</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_embrane_lb">
+ <caption>Description of configuration options for embrane_lb</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">[heleoslb]</th>
+ </tr>
+ <tr>
+ <td>admin_password = None</td>
+ <td>(StrOpt) ESM admin password.</td>
+ </tr>
+ <tr>
+ <td>admin_username = None</td>
+ <td>(StrOpt) ESM admin username.</td>
+ </tr>
+ <tr>
+ <td>async_requests = None</td>
+ <td>(BoolOpt) Define if the requests have run asynchronously or not</td>
+ </tr>
+ <tr>
+ <td>dummy_utif_id = None</td>
+ <td>(StrOpt) Dummy user traffic Security Zone id for LBs</td>
+ </tr>
+ <tr>
+ <td>esm_mgmt = None</td>
+ <td>(StrOpt) ESM management root address</td>
+ </tr>
+ <tr>
+ <td>inband_id = None</td>
+ <td>(StrOpt) In band Security Zone id for LBs</td>
+ </tr>
+ <tr>
+ <td>lb_flavor = small</td>
+ <td>(StrOpt) choose LB image flavor to use, accepted values: small, medium</td>
+ </tr>
+ <tr>
+ <td>lb_image = None</td>
+ <td>(StrOpt) Load Balancer image id (Embrane LB)</td>
+ </tr>
+ <tr>
+ <td>mgmt_id = None</td>
+ <td>(StrOpt) Management Security Zone id for LBs</td>
+ </tr>
+ <tr>
+ <td>oob_id = None</td>
+ <td>(StrOpt) Out of band Security Zone id for LBs</td>
+ </tr>
+ <tr>
+ <td>resource_pool_id = None</td>
+ <td>(StrOpt) Shared resource pool id</td>
+ </tr>
+ <tr>
+ <td>sync_interval = 60</td>
+ <td>(IntOpt) resource synchronization interval in seconds</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-fwaas.xml b/doc/common/tables/neutron-fwaas.xml
index d7de3da7fe..f61d87936e 100644
--- a/doc/common/tables/neutron-fwaas.xml
+++ b/doc/common/tables/neutron-fwaas.xml
@@ -1,27 +1,26 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_fwaas">
- <caption>Description of configuration options for fwaas</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">[fwaas]</th>
- </tr>
- <tr>
- <td>enabled = False</td>
- <td>(BoolOpt) Enable FWaaS</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_fwaas">
+ <caption>Description of configuration options for fwaas</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">[fwaas]</th>
+ </tr>
+ <tr>
+ <td>enabled = False</td>
+ <td>(BoolOpt) Enable FWaaS</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-hyperv_agent.xml b/doc/common/tables/neutron-hyperv_agent.xml
index ea27490740..51e21db12f 100644
--- a/doc/common/tables/neutron-hyperv_agent.xml
+++ b/doc/common/tables/neutron-hyperv_agent.xml
@@ -1,61 +1,60 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_hyperv_agent">
- <caption>Description of configuration options for hyperv_agent</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">[AGENT]</th>
- </tr>
- <tr>
- <td>enable_metrics_collection = False</td>
- <td>(BoolOpt) Enables metrics collections for switch ports by using Hyper-V's metric APIs. Collected data can by retrieved by other apps and services, e.g.: Ceilometer. Requires Hyper-V / Windows Server 2012 and above</td>
- </tr>
- <tr>
- <td>local_network_vswitch = private</td>
- <td>(StrOpt) Private vswitch name used for local networks</td>
- </tr>
- <tr>
- <td>metrics_max_retries = 100</td>
- <td>(IntOpt) Specifies the maximum number of retries to enable Hyper-V's port metrics collection. The agent will try to enable the feature once every polling_interval period for at most metrics_max_retries or until it succeedes.</td>
- </tr>
- <tr>
- <td>physical_network_vswitch_mappings = </td>
- <td>(ListOpt) List of <physical_network>:<vswitch> where the physical networks can be expressed with wildcards, e.g.: ."*:external"</td>
- </tr>
- <tr>
- <td>polling_interval = 2</td>
- <td>(IntOpt) The number of seconds the agent will wait between polling for local device changes.</td>
- </tr>
- <tr>
- <th colspan="2">[HYPERV]</th>
- </tr>
- <tr>
- <td>network_vlan_ranges = </td>
- <td>(ListOpt) List of <physical_network>:<vlan_min>:<vlan_max> or <physical_network></td>
- </tr>
- <tr>
- <td>tenant_network_type = local</td>
- <td>(StrOpt) Network type for tenant networks (local, flat, vlan or none)</td>
- </tr>
- <tr>
- <th colspan="2">[hyperv]</th>
- </tr>
- <tr>
- <td>force_hyperv_utils_v1 = False</td>
- <td>(BoolOpt) Force V1 WMI utility classes</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_hyperv_agent">
+ <caption>Description of configuration options for hyperv_agent</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">[AGENT]</th>
+ </tr>
+ <tr>
+ <td>enable_metrics_collection = False</td>
+ <td>(BoolOpt) Enables metrics collections for switch ports by using Hyper-V's metric APIs. Collected data can by retrieved by other apps and services, e.g.: Ceilometer. Requires Hyper-V / Windows Server 2012 and above</td>
+ </tr>
+ <tr>
+ <td>local_network_vswitch = private</td>
+ <td>(StrOpt) Private vswitch name used for local networks</td>
+ </tr>
+ <tr>
+ <td>metrics_max_retries = 100</td>
+ <td>(IntOpt) Specifies the maximum number of retries to enable Hyper-V's port metrics collection. The agent will try to enable the feature once every polling_interval period for at most metrics_max_retries or until it succeedes.</td>
+ </tr>
+ <tr>
+ <td>physical_network_vswitch_mappings = </td>
+ <td>(ListOpt) List of <physical_network>:<vswitch> where the physical networks can be expressed with wildcards, e.g.: ."*:external"</td>
+ </tr>
+ <tr>
+ <td>polling_interval = 2</td>
+ <td>(IntOpt) The number of seconds the agent will wait between polling for local device changes.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[HYPERV]</th>
+ </tr>
+ <tr>
+ <td>network_vlan_ranges = </td>
+ <td>(ListOpt) List of <physical_network>:<vlan_min>:<vlan_max> or <physical_network></td>
+ </tr>
+ <tr>
+ <td>tenant_network_type = local</td>
+ <td>(StrOpt) Network type for tenant networks (local, flat, vlan or none)</td>
+ </tr>
+ <tr>
+ <th colspan="2">[hyperv]</th>
+ </tr>
+ <tr>
+ <td>force_hyperv_utils_v1 = False</td>
+ <td>(BoolOpt) Force V1 WMI utility classes</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-kombu.xml b/doc/common/tables/neutron-kombu.xml
deleted file mode 100644
index 8f2b4e70ec..0000000000
--- a/doc/common/tables/neutron-kombu.xml
+++ /dev/null
@@ -1,39 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_kombu">
- <caption>Description of configuration options for kombu</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>kombu_ssl_ca_certs = </td>
- <td>(StrOpt) SSL certification authority file (valid only if SSL enabled)</td>
- </tr>
- <tr>
- <td>kombu_ssl_certfile = </td>
- <td>(StrOpt) SSL cert file (valid only if SSL enabled)</td>
- </tr>
- <tr>
- <td>kombu_ssl_keyfile = </td>
- <td>(StrOpt) SSL key file (valid only if SSL enabled)</td>
- </tr>
- <tr>
- <td>kombu_ssl_version = </td>
- <td>(StrOpt) If SSL is enabled, the SSL version to use. Valid values are TLSv1, SSLv23 and SSLv3. SSLv2 might be available on some distributions.</td>
- </tr>
- </tbody>
- </table>
- </para>
diff --git a/doc/common/tables/neutron-l3_agent.xml b/doc/common/tables/neutron-l3_agent.xml
index f13afda9b6..fab25012da 100644
--- a/doc/common/tables/neutron-l3_agent.xml
+++ b/doc/common/tables/neutron-l3_agent.xml
@@ -1,47 +1,46 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_l3_agent">
- <caption>Description of configuration options for l3_agent</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>enable_metadata_proxy = True</td>
- <td>(BoolOpt) Allow running metadata proxy.</td>
- </tr>
- <tr>
- <td>external_network_bridge = br-ex</td>
- <td>(StrOpt) Name of bridge used for external network traffic.</td>
- </tr>
- <tr>
- <td>gateway_external_network_id = </td>
- <td>(StrOpt) UUID of external network for routers implemented by the agents.</td>
- </tr>
- <tr>
- <td>handle_internal_only_routers = True</td>
- <td>(BoolOpt) Agent should implement routers with no gateway</td>
- </tr>
- <tr>
- <td>router_id = </td>
- <td>(StrOpt) If namespaces is disabled, the l3 agent can only configure a router that has the matching router ID.</td>
- </tr>
- <tr>
- <td>send_arp_for_ha = 0</td>
- <td>(IntOpt) Send this many gratuitous ARPs for HA setup, if less than or equal to 0, the feature is disabled</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_l3_agent">
+ <caption>Description of configuration options for l3_agent</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>enable_metadata_proxy = True</td>
+ <td>(BoolOpt) Allow running metadata proxy.</td>
+ </tr>
+ <tr>
+ <td>external_network_bridge = br-ex</td>
+ <td>(StrOpt) Name of bridge used for external network traffic.</td>
+ </tr>
+ <tr>
+ <td>gateway_external_network_id = </td>
+ <td>(StrOpt) UUID of external network for routers implemented by the agents.</td>
+ </tr>
+ <tr>
+ <td>handle_internal_only_routers = True</td>
+ <td>(BoolOpt) Agent should implement routers with no gateway</td>
+ </tr>
+ <tr>
+ <td>router_id = </td>
+ <td>(StrOpt) If namespaces is disabled, the l3 agent can only configure a router that has the matching router ID.</td>
+ </tr>
+ <tr>
+ <td>send_arp_for_ha = 3</td>
+ <td>(IntOpt) Send this many gratuitous ARPs for HA setup, if less than or equal to 0, the feature is disabled</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-lbaas.xml b/doc/common/tables/neutron-lbaas.xml
index a16020ec03..45d892e6cc 100644
--- a/doc/common/tables/neutron-lbaas.xml
+++ b/doc/common/tables/neutron-lbaas.xml
@@ -1,136 +1,30 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_lbaas">
- <caption>Description of configuration options for lbaas</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>device_driver = ['neutron.services.loadbalancer.drivers.haproxy.namespace_driver.HaproxyNSDriver']</td>
- <td>(MultiStrOpt) Drivers used to manage loadbalancing devices</td>
- </tr>
- <tr>
- <td>loadbalancer_pool_scheduler_driver = neutron.services.loadbalancer.agent_scheduler.ChanceScheduler</td>
- <td>(StrOpt) Driver to use for scheduling pool to a default loadbalancer agent</td>
- </tr>
- <tr>
- <th colspan="2">[haproxy]</th>
- </tr>
- <tr>
- <td>loadbalancer_state_path = $state_path/lbaas</td>
- <td>(StrOpt) Location to store config and state files</td>
- </tr>
- <tr>
- <td>user_group = nogroup</td>
- <td>(StrOpt) The user group</td>
- </tr>
- <tr>
- <th colspan="2">[netscaler_driver]</th>
- </tr>
- <tr>
- <td>netscaler_ncc_password = None</td>
- <td>(StrOpt) Password to login to the NetScaler Control Center Server.</td>
- </tr>
- <tr>
- <td>netscaler_ncc_uri = None</td>
- <td>(StrOpt) The URL to reach the NetScaler Control Center Server.</td>
- </tr>
- <tr>
- <td>netscaler_ncc_username = None</td>
- <td>(StrOpt) Username to login to the NetScaler Control Center Server.</td>
- </tr>
- <tr>
- <th colspan="2">[radware]</th>
- </tr>
- <tr>
- <td>actions_to_skip = setup_l2_l3</td>
- <td>(ListOpt) List of actions that we dont want to push to the completion queue</td>
- </tr>
- <tr>
- <td>l2_l3_ctor_params = {'ha_ip_pool_name': 'default', 'allocate_ha_vrrp': True, 'ha_network_name': 'HA-Network', 'service': '_REPLACE_', 'allocate_ha_ips': True}</td>
- <td>(DictOpt) l2_l3 workflow constructor params</td>
- </tr>
- <tr>
- <td>l2_l3_setup_params = {'data_ip_address': '192.168.200.99', 'data_port': 1, 'gateway': '192.168.200.1', 'ha_port': 2, 'data_ip_mask': '255.255.255.0'}</td>
- <td>(DictOpt) l2_l3 workflow setup params</td>
- </tr>
- <tr>
- <td>l2_l3_workflow_name = openstack_l2_l3</td>
- <td>(StrOpt) l2_l3 workflow name</td>
- </tr>
- <tr>
- <td>l4_action_name = BaseCreate</td>
- <td>(StrOpt) l4 workflow action name</td>
- </tr>
- <tr>
- <td>l4_workflow_name = openstack_l4</td>
- <td>(StrOpt) l4 workflow name</td>
- </tr>
- <tr>
- <td>service_adc_type = VA</td>
- <td>(StrOpt) Service ADC type</td>
- </tr>
- <tr>
- <td>service_adc_version = </td>
- <td>(StrOpt) Service ADC version</td>
- </tr>
- <tr>
- <td>service_cache = 20</td>
- <td>(IntOpt) service cache</td>
- </tr>
- <tr>
- <td>service_compression_throughput = 100</td>
- <td>(IntOpt) service compression throughtput</td>
- </tr>
- <tr>
- <td>service_ha_pair = False</td>
- <td>(BoolOpt) service HA pair</td>
- </tr>
- <tr>
- <td>service_isl_vlan = -1</td>
- <td>(IntOpt) A required VLAN for the interswitch link to use</td>
- </tr>
- <tr>
- <td>service_resource_pool_ids = </td>
- <td>(ListOpt) Resource pool ids</td>
- </tr>
- <tr>
- <td>service_session_mirroring_enabled = False</td>
- <td>(BoolOpt) Support an Alteon interswitch link for stateful session failover</td>
- </tr>
- <tr>
- <td>service_ssl_throughput = 100</td>
- <td>(IntOpt) service ssl throughtput</td>
- </tr>
- <tr>
- <td>service_throughput = 1000</td>
- <td>(IntOpt) service throughtput</td>
- </tr>
- <tr>
- <td>vdirect_address = None</td>
- <td>(StrOpt) vdirect server IP address</td>
- </tr>
- <tr>
- <td>vdirect_password = radware</td>
- <td>(StrOpt) vdirect user password</td>
- </tr>
- <tr>
- <td>vdirect_user = vDirect</td>
- <td>(StrOpt) vdirect user name</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_lbaas">
+ <caption>Description of configuration options for lbaas</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>device_driver = ['neutron.services.loadbalancer.drivers.haproxy.namespace_driver.HaproxyNSDriver']</td>
+ <td>(MultiStrOpt) Drivers used to manage loadbalancing devices</td>
+ </tr>
+ <tr>
+ <td>loadbalancer_pool_scheduler_driver = neutron.services.loadbalancer.agent_scheduler.ChanceScheduler</td>
+ <td>(StrOpt) Driver to use for scheduling pool to a default loadbalancer agent</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-lbaas_haproxy.xml b/doc/common/tables/neutron-lbaas_haproxy.xml
new file mode 100644
index 0000000000..99d777fb65
--- /dev/null
+++ b/doc/common/tables/neutron-lbaas_haproxy.xml
@@ -0,0 +1,34 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_neutron_lbaas_haproxy">
+ <caption>Description of configuration options for lbaas_haproxy</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">[haproxy]</th>
+ </tr>
+ <tr>
+ <td>loadbalancer_state_path = $state_path/lbaas</td>
+ <td>(StrOpt) Location to store config and state files</td>
+ </tr>
+ <tr>
+ <td>send_gratuitous_arp = 3</td>
+ <td>(IntOpt) When delete and re-add the same vip, send this many gratuitous ARPs to flush the ARP cache in the Router. Set it below or equal to 0 to disable this feature.</td>
+ </tr>
+ <tr>
+ <td>user_group = nogroup</td>
+ <td>(StrOpt) The user group</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-lbaas_netscalar.xml b/doc/common/tables/neutron-lbaas_netscalar.xml
new file mode 100644
index 0000000000..aa9efaf2e6
--- /dev/null
+++ b/doc/common/tables/neutron-lbaas_netscalar.xml
@@ -0,0 +1,34 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_neutron_lbaas_netscalar">
+ <caption>Description of configuration options for lbaas_netscalar</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">[netscaler_driver]</th>
+ </tr>
+ <tr>
+ <td>netscaler_ncc_password = None</td>
+ <td>(StrOpt) Password to login to the NetScaler Control Center Server.</td>
+ </tr>
+ <tr>
+ <td>netscaler_ncc_uri = None</td>
+ <td>(StrOpt) The URL to reach the NetScaler Control Center Server.</td>
+ </tr>
+ <tr>
+ <td>netscaler_ncc_username = None</td>
+ <td>(StrOpt) Username to login to the NetScaler Control Center Server.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-lbaas_radware.xml b/doc/common/tables/neutron-lbaas_radware.xml
new file mode 100644
index 0000000000..2fb152d6eb
--- /dev/null
+++ b/doc/common/tables/neutron-lbaas_radware.xml
@@ -0,0 +1,102 @@
+<?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_neutron_lbaas_radware">
+ <caption>Description of configuration options for lbaas_radware</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">[radware]</th>
+ </tr>
+ <tr>
+ <td>actions_to_skip = setup_l2_l3</td>
+ <td>(ListOpt) List of actions that are not pushed to the completion queue.</td>
+ </tr>
+ <tr>
+ <td>ha_secondary_address = None</td>
+ <td>(StrOpt) IP address of secondary vDirect server.</td>
+ </tr>
+ <tr>
+ <td>l2_l3_ctor_params = {'ha_network_name': 'HA-Network', 'service': '_REPLACE_', 'ha_ip_pool_name': 'default', 'twoleg_enabled': '_REPLACE_', 'allocate_ha_ips': True, 'allocate_ha_vrrp': True}</td>
+ <td>(DictOpt) Parameter for l2_l3 workflow constructor.</td>
+ </tr>
+ <tr>
+ <td>l2_l3_setup_params = {'data_ip_address': '192.168.200.99', 'data_port': 1, 'gateway': '192.168.200.1', 'ha_port': 2, 'data_ip_mask': '255.255.255.0'}</td>
+ <td>(DictOpt) Parameter for l2_l3 workflow setup.</td>
+ </tr>
+ <tr>
+ <td>l2_l3_workflow_name = openstack_l2_l3</td>
+ <td>(StrOpt) Name of l2_l3 workflow. Default: openstack_l2_l3.</td>
+ </tr>
+ <tr>
+ <td>l4_action_name = BaseCreate</td>
+ <td>(StrOpt) Name of the l4 workflow action. Default: BaseCreate.</td>
+ </tr>
+ <tr>
+ <td>l4_workflow_name = openstack_l4</td>
+ <td>(StrOpt) Name of l4 workflow. Default: openstack_l4.</td>
+ </tr>
+ <tr>
+ <td>service_adc_type = VA</td>
+ <td>(StrOpt) Service ADC type. Default: VA.</td>
+ </tr>
+ <tr>
+ <td>service_adc_version = </td>
+ <td>(StrOpt) Service ADC version.</td>
+ </tr>
+ <tr>
+ <td>service_cache = 20</td>
+ <td>(IntOpt) Size of service cache. Default: 20.</td>
+ </tr>
+ <tr>
+ <td>service_compression_throughput = 100</td>
+ <td>(IntOpt) Service compression throughput. Default: 100.</td>
+ </tr>
+ <tr>
+ <td>service_ha_pair = False</td>
+ <td>(BoolOpt) Enables or disables the Service HA pair. Default: False.</td>
+ </tr>
+ <tr>
+ <td>service_isl_vlan = -1</td>
+ <td>(IntOpt) A required VLAN for the interswitch link to use.</td>
+ </tr>
+ <tr>
+ <td>service_resource_pool_ids = </td>
+ <td>(ListOpt) Resource pool IDs.</td>
+ </tr>
+ <tr>
+ <td>service_session_mirroring_enabled = False</td>
+ <td>(BoolOpt) Enable or disable Alteon interswitch link for stateful session failover. Default: False.</td>
+ </tr>
+ <tr>
+ <td>service_ssl_throughput = 100</td>
+ <td>(IntOpt) Service SSL throughput. Default: 100.</td>
+ </tr>
+ <tr>
+ <td>service_throughput = 1000</td>
+ <td>(IntOpt) Service throughput. Default: 1000.</td>
+ </tr>
+ <tr>
+ <td>vdirect_address = None</td>
+ <td>(StrOpt) IP address of vDirect server.</td>
+ </tr>
+ <tr>
+ <td>vdirect_password = radware</td>
+ <td>(StrOpt) vDirect user password.</td>
+ </tr>
+ <tr>
+ <td>vdirect_user = vDirect</td>
+ <td>(StrOpt) vDirect user name.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-linuxbridge_agent.xml b/doc/common/tables/neutron-linuxbridge_agent.xml
index c03c05a9b6..4de4eb21df 100644
--- a/doc/common/tables/neutron-linuxbridge_agent.xml
+++ b/doc/common/tables/neutron-linuxbridge_agent.xml
@@ -1,65 +1,64 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_linuxbridge_agent">
- <caption>Description of configuration options for linuxbridge_agent</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">[LINUX_BRIDGE]</th>
- </tr>
- <tr>
- <td>physical_interface_mappings = </td>
- <td>(ListOpt) List of <physical_network>:<physical_interface></td>
- </tr>
- <tr>
- <th colspan="2">[VLANS]</th>
- </tr>
- <tr>
- <td>network_vlan_ranges = </td>
- <td>(ListOpt) List of <physical_network>:<vlan_min>:<vlan_max> or <physical_network></td>
- </tr>
- <tr>
- <td>tenant_network_type = local</td>
- <td>(StrOpt) Network type for tenant networks (local, vlan, or none)</td>
- </tr>
- <tr>
- <th colspan="2">[VXLAN]</th>
- </tr>
- <tr>
- <td>enable_vxlan = False</td>
- <td>(BoolOpt) Enable VXLAN on the agent. Can be enabled when agent is managed by ml2 plugin using linuxbridge mechanism driver</td>
- </tr>
- <tr>
- <td>l2_population = False</td>
- <td>(BoolOpt) Extension to use alongside ml2 plugin's l2population mechanism driver. It enables the plugin to populate VXLAN forwarding table.</td>
- </tr>
- <tr>
- <td>local_ip = </td>
- <td>(StrOpt) Local IP address of the VXLAN endpoints.</td>
- </tr>
- <tr>
- <td>tos = None</td>
- <td>(IntOpt) TOS for vxlan interface protocol packets.</td>
- </tr>
- <tr>
- <td>ttl = None</td>
- <td>(IntOpt) TTL for vxlan interface protocol packets.</td>
- </tr>
- <tr>
- <td>vxlan_group = 224.0.0.1</td>
- <td>(StrOpt) Multicast group for vxlan interface.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_linuxbridge_agent">
+ <caption>Description of configuration options for linuxbridge_agent</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">[LINUX_BRIDGE]</th>
+ </tr>
+ <tr>
+ <td>physical_interface_mappings = </td>
+ <td>(ListOpt) List of <physical_network>:<physical_interface></td>
+ </tr>
+ <tr>
+ <th colspan="2">[VLANS]</th>
+ </tr>
+ <tr>
+ <td>network_vlan_ranges = </td>
+ <td>(ListOpt) List of <physical_network>:<vlan_min>:<vlan_max> or <physical_network></td>
+ </tr>
+ <tr>
+ <td>tenant_network_type = local</td>
+ <td>(StrOpt) Network type for tenant networks (local, vlan, or none)</td>
+ </tr>
+ <tr>
+ <th colspan="2">[VXLAN]</th>
+ </tr>
+ <tr>
+ <td>enable_vxlan = False</td>
+ <td>(BoolOpt) Enable VXLAN on the agent. Can be enabled when agent is managed by ml2 plugin using linuxbridge mechanism driver</td>
+ </tr>
+ <tr>
+ <td>l2_population = False</td>
+ <td>(BoolOpt) Extension to use alongside ml2 plugin's l2population mechanism driver. It enables the plugin to populate VXLAN forwarding table.</td>
+ </tr>
+ <tr>
+ <td>local_ip = </td>
+ <td>(StrOpt) Local IP address of the VXLAN endpoints.</td>
+ </tr>
+ <tr>
+ <td>tos = None</td>
+ <td>(IntOpt) TOS for vxlan interface protocol packets.</td>
+ </tr>
+ <tr>
+ <td>ttl = None</td>
+ <td>(IntOpt) TTL for vxlan interface protocol packets.</td>
+ </tr>
+ <tr>
+ <td>vxlan_group = 224.0.0.1</td>
+ <td>(StrOpt) Multicast group for vxlan interface.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-logging.xml b/doc/common/tables/neutron-logging.xml
index a8920d9362..9ee3cded2c 100644
--- a/doc/common/tables/neutron-logging.xml
+++ b/doc/common/tables/neutron-logging.xml
@@ -1,103 +1,106 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_logging">
- <caption>Description of configuration options for logging</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>debug = False</td>
- <td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).</td>
- </tr>
- <tr>
- <td>default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, iso8601=WARN</td>
- <td>(ListOpt) list of logger=LEVEL pairs</td>
- </tr>
- <tr>
- <td>fatal_deprecations = False</td>
- <td>(BoolOpt) make deprecations fatal</td>
- </tr>
- <tr>
- <td>instance_format = "[instance: %(uuid)s] "</td>
- <td>(StrOpt) If an instance is passed with the log message, format it like this</td>
- </tr>
- <tr>
- <td>instance_uuid_format = "[instance: %(uuid)s] "</td>
- <td>(StrOpt) If an instance UUID is passed with the log message, format it like this</td>
- </tr>
- <tr>
- <td>log_config_append = None</td>
- <td>(StrOpt) The name of logging configuration file. It does not disable existing loggers, but just appends specified logging configuration to any other existing logging options. Please see the Python logging module documentation for details on logging configuration files.</td>
- </tr>
- <tr>
- <td>log_date_format = %Y-%m-%d %H:%M:%S</td>
- <td>(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s</td>
- </tr>
- <tr>
- <td>log_dir = None</td>
- <td>(StrOpt) (Optional) The base directory used for relative --log-file paths</td>
- </tr>
- <tr>
- <td>log_file = None</td>
- <td>(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.</td>
- </tr>
- <tr>
- <td>log_format = None</td>
- <td>(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.</td>
- </tr>
- <tr>
- <td>logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s</td>
- <td>(StrOpt) format string to use for log messages with context</td>
- </tr>
- <tr>
- <td>logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d</td>
- <td>(StrOpt) data to append to log format when level is DEBUG</td>
- </tr>
- <tr>
- <td>logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s</td>
- <td>(StrOpt) format string to use for log messages without context</td>
- </tr>
- <tr>
- <td>logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s</td>
- <td>(StrOpt) prefix each line of exception output with this format</td>
- </tr>
- <tr>
- <td>publish_errors = False</td>
- <td>(BoolOpt) publish error events</td>
- </tr>
- <tr>
- <td>syslog_log_facility = LOG_USER</td>
- <td>(StrOpt) syslog facility to receive log lines</td>
- </tr>
- <tr>
- <td>use_ssl = False</td>
- <td>(BoolOpt) Enable SSL on the API server</td>
- </tr>
- <tr>
- <td>use_stderr = True</td>
- <td>(BoolOpt) Log output to standard error</td>
- </tr>
- <tr>
- <td>use_syslog = False</td>
- <td>(BoolOpt) Use syslog for logging.</td>
- </tr>
- <tr>
- <td>verbose = False</td>
- <td>(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_logging">
+ <caption>Description of configuration options for logging</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>debug = False</td>
+ <td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).</td>
+ </tr>
+ <tr>
+ <td>default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN</td>
+ <td>(ListOpt) List of logger=LEVEL pairs.</td>
+ </tr>
+ <tr>
+ <td>fatal_deprecations = False</td>
+ <td>(BoolOpt) Enables or disables fatal status of deprecations.</td>
+ </tr>
+ <tr>
+ <td>instance_format = "[instance: %(uuid)s] "</td>
+ <td>(StrOpt) The format for an instance that is passed with the log message. </td>
+ </tr>
+ <tr>
+ <td>instance_uuid_format = "[instance: %(uuid)s] "</td>
+ <td>(StrOpt) The format for an instance UUID that is passed with the log message. </td>
+ </tr>
+ <tr>
+ <td>log_config_append = None</td>
+ <td>(StrOpt) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation.</td>
+ </tr>
+ <tr>
+ <td>log_date_format = %Y-%m-%d %H:%M:%S</td>
+ <td>(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s .</td>
+ </tr>
+ <tr>
+ <td>log_dir = None</td>
+ <td>(StrOpt) (Optional) The base directory used for relative --log-file paths.</td>
+ </tr>
+ <tr>
+ <td>log_file = None</td>
+ <td>(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.</td>
+ </tr>
+ <tr>
+ <td>log_format = None</td>
+ <td>(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.</td>
+ </tr>
+ <tr>
+ <td>logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s</td>
+ <td>(StrOpt) Format string to use for log messages with context.</td>
+ </tr>
+ <tr>
+ <td>logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d</td>
+ <td>(StrOpt) Data to append to log format when level is DEBUG.</td>
+ </tr>
+ <tr>
+ <td>logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s</td>
+ <td>(StrOpt) Format string to use for log messages without context.</td>
+ </tr>
+ <tr>
+ <td>logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s</td>
+ <td>(StrOpt) Prefix each line of exception output with this format.</td>
+ </tr>
+ <tr>
+ <td>publish_errors = False</td>
+ <td>(BoolOpt) Enables or disables publication of error events.</td>
+ </tr>
+ <tr>
+ <td>syslog_log_facility = LOG_USER</td>
+ <td>(StrOpt) Syslog facility to receive log lines.</td>
+ </tr>
+ <tr>
+ <td>use_ssl = False</td>
+ <td>(BoolOpt) Enable SSL on the API server</td>
+ </tr>
+ <tr>
+ <td>use_stderr = True</td>
+ <td>(BoolOpt) Log output to standard error.</td>
+ </tr>
+ <tr>
+ <td>use_syslog = False</td>
+ <td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424.</td>
+ </tr>
+ <tr>
+ <td>use_syslog_rfc_format = False</td>
+ <td>(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in I, and will be removed in J.</td>
+ </tr>
+ <tr>
+ <td>verbose = False</td>
+ <td>(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-meta.xml b/doc/common/tables/neutron-meta.xml
index 0ce05d3eb0..b42c69ba49 100644
--- a/doc/common/tables/neutron-meta.xml
+++ b/doc/common/tables/neutron-meta.xml
@@ -1,51 +1,50 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_meta">
- <caption>Description of configuration options for meta</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">[META]</th>
- </tr>
- <tr>
- <td>default_flavor = </td>
- <td>(StrOpt) Default flavor to use</td>
- </tr>
- <tr>
- <td>default_l3_flavor = </td>
- <td>(StrOpt) Default L3 flavor to use</td>
- </tr>
- <tr>
- <td>extension_map = </td>
- <td>(StrOpt) A list of extensions, per plugin, to load.</td>
- </tr>
- <tr>
- <td>l3_plugin_list = </td>
- <td>(StrOpt) List of L3 plugins to load</td>
- </tr>
- <tr>
- <td>plugin_list = </td>
- <td>(StrOpt) List of plugins to load</td>
- </tr>
- <tr>
- <td>rpc_flavor = </td>
- <td>(StrOpt) Flavor of which plugin handles RPC</td>
- </tr>
- <tr>
- <td>supported_extension_aliases = </td>
- <td>(StrOpt) Supported extension aliases</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_meta">
+ <caption>Description of configuration options for meta</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">[META]</th>
+ </tr>
+ <tr>
+ <td>default_flavor = </td>
+ <td>(StrOpt) Default flavor to use, when flavor:network is not specified at network creation.</td>
+ </tr>
+ <tr>
+ <td>default_l3_flavor = </td>
+ <td>(StrOpt) Default L3 flavor to use, when flavor:router is not specified at router creation. Ignored if 'l3_plugin_list' is blank.</td>
+ </tr>
+ <tr>
+ <td>extension_map = </td>
+ <td>(StrOpt) Comma separated list of method:flavor to select specific plugin for a method. This has priority over method search order based on 'plugin_list'.</td>
+ </tr>
+ <tr>
+ <td>l3_plugin_list = </td>
+ <td>(StrOpt) Comma separated list of flavor:neutron_plugin for L3 service plugins to load. This is intended for specifying L2 plugins which support L3 functions. If you use a router service plugin, set this blank.</td>
+ </tr>
+ <tr>
+ <td>plugin_list = </td>
+ <td>(StrOpt) Comma separated list of flavor:neutron_plugin for plugins to load. Extension method is searched in the list order and the first one is used.</td>
+ </tr>
+ <tr>
+ <td>rpc_flavor = </td>
+ <td>(StrOpt) Specifies flavor for plugin to handle 'q-plugin' RPC requests.</td>
+ </tr>
+ <tr>
+ <td>supported_extension_aliases = </td>
+ <td>(StrOpt) Comma separated list of supported extension aliases.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-metadata.xml b/doc/common/tables/neutron-metadata.xml
index aa42d5eaf7..90c16a2179 100644
--- a/doc/common/tables/neutron-metadata.xml
+++ b/doc/common/tables/neutron-metadata.xml
@@ -1,55 +1,62 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_metadata">
- <caption>Description of configuration options for metadata</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>meta_flavor_driver_mappings = None</td>
- <td>(StrOpt) Mapping between flavor and LinuxInterfaceDriver</td>
- </tr>
- <tr>
- <td>metadata_backlog = 128</td>
- <td>(IntOpt) Number of backlog requests to configure the metadata server socket with</td>
- </tr>
- <tr>
- <td>metadata_port = 9697</td>
- <td>(IntOpt) TCP Port used by Neutron metadata namespace proxy.</td>
- </tr>
- <tr>
- <td>metadata_proxy_shared_secret = </td>
- <td>(StrOpt) Shared secret to sign instance-id request</td>
- </tr>
- <tr>
- <td>metadata_proxy_socket = $state_path/metadata_proxy</td>
- <td>(StrOpt) Location of Metadata Proxy UNIX domain socket</td>
- </tr>
- <tr>
- <td>metadata_workers = 0</td>
- <td>(IntOpt) Number of separate worker processes for metadata server</td>
- </tr>
- <tr>
- <td>nova_metadata_ip = 127.0.0.1</td>
- <td>(StrOpt) IP address used by Nova metadata server.</td>
- </tr>
- <tr>
- <td>nova_metadata_port = 8775</td>
- <td>(IntOpt) TCP Port used by Nova metadata server.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_metadata">
+ <caption>Description of configuration options for metadata</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>meta_flavor_driver_mappings = None</td>
+ <td>(StrOpt) Mapping between flavor and LinuxInterfaceDriver</td>
+ </tr>
+ <tr>
+ <td>metadata_backlog = 4096</td>
+ <td>(IntOpt) Number of backlog requests to configure the metadata server socket with</td>
+ </tr>
+ <tr>
+ <td>metadata_port = 9697</td>
+ <td>(IntOpt) TCP Port used by Neutron metadata namespace proxy.</td>
+ </tr>
+ <tr>
+ <td>metadata_proxy_shared_secret = </td>
+ <td>(StrOpt) Shared secret to sign instance-id request</td>
+ </tr>
+ <tr>
+ <td>metadata_proxy_socket = $state_path/metadata_proxy</td>
+ <td>(StrOpt) Location of Metadata Proxy UNIX domain socket</td>
+ </tr>
+ <tr>
+ <td>metadata_workers = 2</td>
+ <td>(IntOpt) Number of separate worker processes for metadata server</td>
+ </tr>
+ <tr>
+ <td>nova_metadata_insecure = False</td>
+ <td>(BoolOpt) Allow to perform insecure SSL (https) requests to nova metadata</td>
+ </tr>
+ <tr>
+ <td>nova_metadata_ip = 127.0.0.1</td>
+ <td>(StrOpt) IP address used by Nova metadata server.</td>
+ </tr>
+ <tr>
+ <td>nova_metadata_port = 8775</td>
+ <td>(IntOpt) TCP Port used by Nova metadata server.</td>
+ </tr>
+ <tr>
+ <td>nova_metadata_protocol = http</td>
+ <td>(StrOpt) Protocol to access nova metadata, http or https</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-metering_agent.xml b/doc/common/tables/neutron-metering_agent.xml
index 63e0c8cc11..7974879435 100644
--- a/doc/common/tables/neutron-metering_agent.xml
+++ b/doc/common/tables/neutron-metering_agent.xml
@@ -1,38 +1,37 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_metering_agent">
- <caption>Description of configuration options for metering_agent</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>driver = neutron.services.metering.drivers.noop.noop_driver.NoopMeteringDriver</td>
- <td>(StrOpt) Metering driver</td>
- </tr>
- <tr>
- <td>measure_interval = 30</td>
- <td>(IntOpt) Interval between two metering measures</td>
- </tr>
- <tr>
- <th colspan="2">[AGENT]</th>
- </tr>
- <tr>
- <td>report_interval = 30</td>
- <td>(FloatOpt) Seconds between nodes reporting state to server; should be less than agent_down_time, best if it is half or less than agent_down_time.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_metering_agent">
+ <caption>Description of configuration options for metering_agent</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>driver = neutron.services.metering.drivers.noop.noop_driver.NoopMeteringDriver</td>
+ <td>(StrOpt) Metering driver</td>
+ </tr>
+ <tr>
+ <td>measure_interval = 30</td>
+ <td>(IntOpt) Interval between two metering measures</td>
+ </tr>
+ <tr>
+ <th colspan="2">[AGENT]</th>
+ </tr>
+ <tr>
+ <td>report_interval = 30</td>
+ <td>(FloatOpt) Seconds between nodes reporting state to server; should be less than agent_down_time, best if it is half or less than agent_down_time.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-midonet.xml b/doc/common/tables/neutron-midonet.xml
index 3df3334cb0..8133daf834 100644
--- a/doc/common/tables/neutron-midonet.xml
+++ b/doc/common/tables/neutron-midonet.xml
@@ -1,51 +1,50 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_midonet">
- <caption>Description of configuration options for midonet</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">[MIDONET]</th>
- </tr>
- <tr>
- <td>midonet_host_uuid_path = /etc/midolman/host_uuid.properties</td>
- <td>(StrOpt) Path to midonet host uuid file</td>
- </tr>
- <tr>
- <td>midonet_uri = http://localhost:8080/midonet-api</td>
- <td>(StrOpt) MidoNet API server URI.</td>
- </tr>
- <tr>
- <td>mode = dev</td>
- <td>(StrOpt) Operational mode. Internal dev use only.</td>
- </tr>
- <tr>
- <td>password = passw0rd</td>
- <td>(StrOpt) MidoNet admin password.</td>
- </tr>
- <tr>
- <td>project_id = 77777777-7777-7777-7777-777777777777</td>
- <td>(StrOpt) ID of the project that MidoNet admin userbelongs to.</td>
- </tr>
- <tr>
- <td>provider_router_id = None</td>
- <td>(StrOpt) Virtual provider router ID.</td>
- </tr>
- <tr>
- <td>username = admin</td>
- <td>(StrOpt) MidoNet admin username.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_midonet">
+ <caption>Description of configuration options for midonet</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">[MIDONET]</th>
+ </tr>
+ <tr>
+ <td>midonet_host_uuid_path = /etc/midolman/host_uuid.properties</td>
+ <td>(StrOpt) Path to midonet host uuid file</td>
+ </tr>
+ <tr>
+ <td>midonet_uri = http://localhost:8080/midonet-api</td>
+ <td>(StrOpt) MidoNet API server URI.</td>
+ </tr>
+ <tr>
+ <td>mode = dev</td>
+ <td>(StrOpt) Operational mode. Internal dev use only.</td>
+ </tr>
+ <tr>
+ <td>password = passw0rd</td>
+ <td>(StrOpt) MidoNet admin password.</td>
+ </tr>
+ <tr>
+ <td>project_id = 77777777-7777-7777-7777-777777777777</td>
+ <td>(StrOpt) ID of the project that MidoNet admin userbelongs to.</td>
+ </tr>
+ <tr>
+ <td>provider_router_id = None</td>
+ <td>(StrOpt) Virtual provider router ID.</td>
+ </tr>
+ <tr>
+ <td>username = admin</td>
+ <td>(StrOpt) MidoNet admin username.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-ml2.xml b/doc/common/tables/neutron-ml2.xml
index 0c2931014a..afd39e7f73 100644
--- a/doc/common/tables/neutron-ml2.xml
+++ b/doc/common/tables/neutron-ml2.xml
@@ -1,35 +1,34 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_ml2">
- <caption>Description of configuration options for ml2</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">[ml2]</th>
- </tr>
- <tr>
- <td>mechanism_drivers = </td>
- <td>(ListOpt) An ordered list of networking mechanism driver entrypoints to be loaded from the neutron.ml2.mechanism_drivers namespace.</td>
- </tr>
- <tr>
- <td>tenant_network_types = local</td>
- <td>(ListOpt) Ordered list of network_types to allocate as tenant networks.</td>
- </tr>
- <tr>
- <td>type_drivers = local, flat, vlan, gre, vxlan</td>
- <td>(ListOpt) List of network type driver entrypoints to be loaded from the neutron.ml2.type_drivers namespace.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_ml2">
+ <caption>Description of configuration options for ml2</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">[ml2]</th>
+ </tr>
+ <tr>
+ <td>mechanism_drivers = </td>
+ <td>(ListOpt) An ordered list of networking mechanism driver entrypoints to be loaded from the neutron.ml2.mechanism_drivers namespace.</td>
+ </tr>
+ <tr>
+ <td>tenant_network_types = local</td>
+ <td>(ListOpt) Ordered list of network_types to allocate as tenant networks.</td>
+ </tr>
+ <tr>
+ <td>type_drivers = local, flat, vlan, gre, vxlan</td>
+ <td>(ListOpt) List of network type driver entrypoints to be loaded from the neutron.ml2.type_drivers namespace.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-ml2_arista.xml b/doc/common/tables/neutron-ml2_arista.xml
index 3dcd565159..4c6968eaee 100644
--- a/doc/common/tables/neutron-ml2_arista.xml
+++ b/doc/common/tables/neutron-ml2_arista.xml
@@ -1,47 +1,46 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_ml2_arista">
- <caption>Description of configuration options for ml2_arista</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">[ml2_arista]</th>
- </tr>
- <tr>
- <td>eapi_host = </td>
- <td>(StrOpt) Arista EOS IP address. This is required field.If not set, all communications to Arista EOSwill fail</td>
- </tr>
- <tr>
- <td>eapi_password = </td>
- <td>(StrOpt) Password for Arista EOS. This is required field.if not set, all communications to Arista EOSwill fail</td>
- </tr>
- <tr>
- <td>eapi_username = </td>
- <td>(StrOpt) Username for Arista EOS. This is required field.if not set, all communications to Arista EOSwill fail</td>
- </tr>
- <tr>
- <td>region_name = RegionOne</td>
- <td>(StrOpt) Defines Region Name that is assigned to this OpenStackController. This is useful when multipleOpenStack/Neutron controllers are managing the sameArista HW clusters. Note that this name must match withthe region name registered (or known) to keystoneservice. Authentication with Keysotne is performed byEOS. This is optional. If not set, a value of"RegionOne" is assumed</td>
- </tr>
- <tr>
- <td>sync_interval = 180</td>
- <td>(IntOpt) Sync interval in seconds between Neutron plugin andEOS. This interval defines how often thesynchronization is performed. This is an optionalfield. If not set, a value of 180 seconds is assumed</td>
- </tr>
- <tr>
- <td>use_fqdn = True</td>
- <td>(BoolOpt) Defines if hostnames are sent to Arista EOS as FQDNs("node1.domain.com") or as short names ("node1").This is optional. If not set, a value of "True"is assumed.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_ml2_arista">
+ <caption>Description of configuration options for ml2_arista</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">[ml2_arista]</th>
+ </tr>
+ <tr>
+ <td>eapi_host = </td>
+ <td>(StrOpt) Arista EOS IP address. This is required field. If not set, all communications to Arista EOSwill fail.</td>
+ </tr>
+ <tr>
+ <td>eapi_password = </td>
+ <td>(StrOpt) Password for Arista EOS. This is required field. If not set, all communications to Arista EOS will fail.</td>
+ </tr>
+ <tr>
+ <td>eapi_username = </td>
+ <td>(StrOpt) Username for Arista EOS. This is required field. If not set, all communications to Arista EOSwill fail.</td>
+ </tr>
+ <tr>
+ <td>region_name = RegionOne</td>
+ <td>(StrOpt) Defines Region Name that is assigned to this OpenStack Controller. This is useful when multiple OpenStack/Neutron controllers are managing the same Arista HW clusters. Note that this name must match with the region name registered (or known) to keystone service. Authentication with Keysotne is performed by EOS. This is optional. If not set, a value of "RegionOne" is assumed.</td>
+ </tr>
+ <tr>
+ <td>sync_interval = 180</td>
+ <td>(IntOpt) Sync interval in seconds between Neutron plugin and EOS. This interval defines how often the synchronization is performed. This is an optional field. If not set, a value of 180 seconds is assumed.</td>
+ </tr>
+ <tr>
+ <td>use_fqdn = True</td>
+ <td>(BoolOpt) Defines if hostnames are sent to Arista EOS as FQDNs ("node1.domain.com") or as short names ("node1"). This is optional. If not set, a value of "True" is assumed.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-ml2_bigswitch.xml b/doc/common/tables/neutron-ml2_bigswitch.xml
index 759fb09d80..9938fe3f25 100644
--- a/doc/common/tables/neutron-ml2_bigswitch.xml
+++ b/doc/common/tables/neutron-ml2_bigswitch.xml
@@ -1,164 +1,163 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_ml2_bigswitch">
- <caption>Description of configuration options for ml2_bigswitch</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">[NOVA]</th>
- </tr>
- <tr>
- <td>node_override_vif_802.1qbg = </td>
- <td>(ListOpt) Nova compute nodes to manually set VIF type to 802.1qbg</td>
- </tr>
- <tr>
- <td>node_override_vif_802.1qbh = </td>
- <td>(ListOpt) Nova compute nodes to manually set VIF type to 802.1qbh</td>
- </tr>
- <tr>
- <td>node_override_vif_binding_failed = </td>
- <td>(ListOpt) Nova compute nodes to manually set VIF type to binding_failed</td>
- </tr>
- <tr>
- <td>node_override_vif_bridge = </td>
- <td>(ListOpt) Nova compute nodes to manually set VIF type to bridge</td>
- </tr>
- <tr>
- <td>node_override_vif_hostdev = </td>
- <td>(ListOpt) Nova compute nodes to manually set VIF type to hostdev</td>
- </tr>
- <tr>
- <td>node_override_vif_hyperv = </td>
- <td>(ListOpt) Nova compute nodes to manually set VIF type to hyperv</td>
- </tr>
- <tr>
- <td>node_override_vif_ivs = </td>
- <td>(ListOpt) Nova compute nodes to manually set VIF type to ivs</td>
- </tr>
- <tr>
- <td>node_override_vif_midonet = </td>
- <td>(ListOpt) Nova compute nodes to manually set VIF type to midonet</td>
- </tr>
- <tr>
- <td>node_override_vif_mlnx_direct = </td>
- <td>(ListOpt) Nova compute nodes to manually set VIF type to mlnx_direct</td>
- </tr>
- <tr>
- <td>node_override_vif_other = </td>
- <td>(ListOpt) Nova compute nodes to manually set VIF type to other</td>
- </tr>
- <tr>
- <td>node_override_vif_ovs = </td>
- <td>(ListOpt) Nova compute nodes to manually set VIF type to ovs</td>
- </tr>
- <tr>
- <td>node_override_vif_unbound = </td>
- <td>(ListOpt) Nova compute nodes to manually set VIF type to unbound</td>
- </tr>
- <tr>
- <td>vif_type = ovs</td>
- <td>(StrOpt) Virtual interface type to configure on Nova compute nodes</td>
- </tr>
- <tr>
- <td>vif_types = unbound, binding_failed, ovs, ivs, bridge, 802.1qbg, 802.1qbh, hyperv, midonet, mlnx_direct, hostdev, other</td>
- <td>(ListOpt) List of allowed vif_type values.</td>
- </tr>
- <tr>
- <th colspan="2">[RESTPROXY]</th>
- </tr>
- <tr>
- <td>add_meta_server_route = True</td>
- <td>(BoolOpt) Flag to decide if a route to the metadata server should be injected into the VM</td>
- </tr>
- <tr>
- <td>auto_sync_on_failure = True</td>
- <td>(BoolOpt) If neutron fails to create a resource because the backend controller doesn't know of a dependency, the plugin automatically triggers a full data synchronization to the controller.</td>
- </tr>
- <tr>
- <td>cache_connections = True</td>
- <td>(BoolOpt) Re-use HTTP/HTTPS connections to the controller.</td>
- </tr>
- <tr>
- <td>consistency_interval = 60</td>
- <td>(IntOpt) Time between verifications that the backend controller database is consistent with Neutron</td>
- </tr>
- <tr>
- <td>neutron_id = neutron-oslo</td>
- <td>(StrOpt) User defined identifier for this Neutron deployment</td>
- </tr>
- <tr>
- <td>no_ssl_validation = False</td>
- <td>(BoolOpt) Disables SSL certificate validation for controllers</td>
- </tr>
- <tr>
- <td>server_auth = None</td>
- <td>(StrOpt) The username and password for authenticating against the Big Switch or Floodlight controller.</td>
- </tr>
- <tr>
- <td>server_ssl = True</td>
- <td>(BoolOpt) If True, Use SSL when connecting to the Big Switch or Floodlight controller.</td>
- </tr>
- <tr>
- <td>server_timeout = 10</td>
- <td>(IntOpt) Maximum number of seconds to wait for proxy request to connect and complete.</td>
- </tr>
- <tr>
- <td>servers = localhost:8800</td>
- <td>(ListOpt) A comma separated list of Big Switch or Floodlight servers and port numbers. The plugin proxies the requests to the Big Switch/Floodlight server, which performs the networking configuration. Only oneserver is needed per deployment, but you may wish todeploy multiple servers to support failover.</td>
- </tr>
- <tr>
- <td>ssl_cert_directory = /etc/neutron/plugins/bigswitch/ssl</td>
- <td>(StrOpt) Directory containing ca_certs and host_certs certificate directories.</td>
- </tr>
- <tr>
- <td>ssl_sticky = True</td>
- <td>(BoolOpt) Trust and store the first certificate received for each controller address and use it to validate future connections to that address.</td>
- </tr>
- <tr>
- <td>sync_data = False</td>
- <td>(BoolOpt) Sync data on connect</td>
- </tr>
- <tr>
- <td>thread_pool_size = 4</td>
- <td>(IntOpt) Maximum number of threads to spawn to handle large volumes of port creations.</td>
- </tr>
- <tr>
- <th colspan="2">[RESTPROXYAGENT]</th>
- </tr>
- <tr>
- <td>integration_bridge = br-int</td>
- <td>(StrOpt) Name of integration bridge on compute nodes used for security group insertion.</td>
- </tr>
- <tr>
- <td>polling_interval = 5</td>
- <td>(IntOpt) Seconds between agent checks for port changes</td>
- </tr>
- <tr>
- <td>virtual_switch_type = ovs</td>
- <td>(StrOpt) Virtual switch type.</td>
- </tr>
- <tr>
- <th colspan="2">[ROUTER]</th>
- </tr>
- <tr>
- <td>max_router_rules = 200</td>
- <td>(IntOpt) Maximum number of router rules</td>
- </tr>
- <tr>
- <td>tenant_default_router_rule = ['*:any:any:permit']</td>
- <td>(MultiStrOpt) The default router rules installed in new tenant routers. Repeat the config option for each rule. Format is <tenant>:<source>:<destination>:<action> Use an * to specify default for all tenants.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_ml2_bigswitch">
+ <caption>Description of configuration options for ml2_bigswitch</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">[NOVA]</th>
+ </tr>
+ <tr>
+ <td>node_override_vif_802.1qbg = </td>
+ <td>(ListOpt) Nova compute nodes to manually set VIF type to 802.1qbg</td>
+ </tr>
+ <tr>
+ <td>node_override_vif_802.1qbh = </td>
+ <td>(ListOpt) Nova compute nodes to manually set VIF type to 802.1qbh</td>
+ </tr>
+ <tr>
+ <td>node_override_vif_binding_failed = </td>
+ <td>(ListOpt) Nova compute nodes to manually set VIF type to binding_failed</td>
+ </tr>
+ <tr>
+ <td>node_override_vif_bridge = </td>
+ <td>(ListOpt) Nova compute nodes to manually set VIF type to bridge</td>
+ </tr>
+ <tr>
+ <td>node_override_vif_hostdev = </td>
+ <td>(ListOpt) Nova compute nodes to manually set VIF type to hostdev</td>
+ </tr>
+ <tr>
+ <td>node_override_vif_hyperv = </td>
+ <td>(ListOpt) Nova compute nodes to manually set VIF type to hyperv</td>
+ </tr>
+ <tr>
+ <td>node_override_vif_ivs = </td>
+ <td>(ListOpt) Nova compute nodes to manually set VIF type to ivs</td>
+ </tr>
+ <tr>
+ <td>node_override_vif_midonet = </td>
+ <td>(ListOpt) Nova compute nodes to manually set VIF type to midonet</td>
+ </tr>
+ <tr>
+ <td>node_override_vif_mlnx_direct = </td>
+ <td>(ListOpt) Nova compute nodes to manually set VIF type to mlnx_direct</td>
+ </tr>
+ <tr>
+ <td>node_override_vif_other = </td>
+ <td>(ListOpt) Nova compute nodes to manually set VIF type to other</td>
+ </tr>
+ <tr>
+ <td>node_override_vif_ovs = </td>
+ <td>(ListOpt) Nova compute nodes to manually set VIF type to ovs</td>
+ </tr>
+ <tr>
+ <td>node_override_vif_unbound = </td>
+ <td>(ListOpt) Nova compute nodes to manually set VIF type to unbound</td>
+ </tr>
+ <tr>
+ <td>vif_type = ovs</td>
+ <td>(StrOpt) Virtual interface type to configure on Nova compute nodes</td>
+ </tr>
+ <tr>
+ <td>vif_types = unbound, binding_failed, ovs, ivs, bridge, 802.1qbg, 802.1qbh, hyperv, midonet, mlnx_direct, hostdev, other</td>
+ <td>(ListOpt) List of allowed vif_type values.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[RESTPROXY]</th>
+ </tr>
+ <tr>
+ <td>add_meta_server_route = True</td>
+ <td>(BoolOpt) Flag to decide if a route to the metadata server should be injected into the VM</td>
+ </tr>
+ <tr>
+ <td>auto_sync_on_failure = True</td>
+ <td>(BoolOpt) If neutron fails to create a resource because the backend controller doesn't know of a dependency, the plugin automatically triggers a full data synchronization to the controller.</td>
+ </tr>
+ <tr>
+ <td>cache_connections = True</td>
+ <td>(BoolOpt) Re-use HTTP/HTTPS connections to the controller.</td>
+ </tr>
+ <tr>
+ <td>consistency_interval = 60</td>
+ <td>(IntOpt) Time between verifications that the backend controller database is consistent with Neutron. (0 to disable)</td>
+ </tr>
+ <tr>
+ <td>neutron_id = neutron-oslo</td>
+ <td>(StrOpt) User defined identifier for this Neutron deployment</td>
+ </tr>
+ <tr>
+ <td>no_ssl_validation = False</td>
+ <td>(BoolOpt) Disables SSL certificate validation for controllers</td>
+ </tr>
+ <tr>
+ <td>server_auth = None</td>
+ <td>(StrOpt) The username and password for authenticating against the Big Switch or Floodlight controller.</td>
+ </tr>
+ <tr>
+ <td>server_ssl = True</td>
+ <td>(BoolOpt) If True, Use SSL when connecting to the Big Switch or Floodlight controller.</td>
+ </tr>
+ <tr>
+ <td>server_timeout = 10</td>
+ <td>(IntOpt) Maximum number of seconds to wait for proxy request to connect and complete.</td>
+ </tr>
+ <tr>
+ <td>servers = localhost:8800</td>
+ <td>(ListOpt) A comma separated list of Big Switch or Floodlight servers and port numbers. The plugin proxies the requests to the Big Switch/Floodlight server, which performs the networking configuration. Only oneserver is needed per deployment, but you may wish todeploy multiple servers to support failover.</td>
+ </tr>
+ <tr>
+ <td>ssl_cert_directory = /etc/neutron/plugins/bigswitch/ssl</td>
+ <td>(StrOpt) Directory containing ca_certs and host_certs certificate directories.</td>
+ </tr>
+ <tr>
+ <td>ssl_sticky = True</td>
+ <td>(BoolOpt) Trust and store the first certificate received for each controller address and use it to validate future connections to that address.</td>
+ </tr>
+ <tr>
+ <td>sync_data = False</td>
+ <td>(BoolOpt) Sync data on connect</td>
+ </tr>
+ <tr>
+ <td>thread_pool_size = 4</td>
+ <td>(IntOpt) Maximum number of threads to spawn to handle large volumes of port creations.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[RESTPROXYAGENT]</th>
+ </tr>
+ <tr>
+ <td>integration_bridge = br-int</td>
+ <td>(StrOpt) Name of integration bridge on compute nodes used for security group insertion.</td>
+ </tr>
+ <tr>
+ <td>polling_interval = 5</td>
+ <td>(IntOpt) Seconds between agent checks for port changes</td>
+ </tr>
+ <tr>
+ <td>virtual_switch_type = ovs</td>
+ <td>(StrOpt) Virtual switch type.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[ROUTER]</th>
+ </tr>
+ <tr>
+ <td>max_router_rules = 200</td>
+ <td>(IntOpt) Maximum number of router rules</td>
+ </tr>
+ <tr>
+ <td>tenant_default_router_rule = ['*:any:any:permit']</td>
+ <td>(MultiStrOpt) The default router rules installed in new tenant routers. Repeat the config option for each rule. Format is <tenant>:<source>:<destination>:<action> Use an * to specify default for all tenants.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-ml2_brocade.xml b/doc/common/tables/neutron-ml2_brocade.xml
index b124762b0e..93394f79ae 100644
--- a/doc/common/tables/neutron-ml2_brocade.xml
+++ b/doc/common/tables/neutron-ml2_brocade.xml
@@ -1,43 +1,42 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_ml2_brocade">
- <caption>Description of configuration options for ml2_brocade</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">[ml2_brocade]</th>
- </tr>
- <tr>
- <td>address = </td>
- <td>(StrOpt) The address of the host to SSH to</td>
- </tr>
- <tr>
- <td>ostype = NOS</td>
- <td>(StrOpt) Unused</td>
- </tr>
- <tr>
- <td>password = password</td>
- <td>(StrOpt) The SSH password to use</td>
- </tr>
- <tr>
- <td>physical_networks = </td>
- <td>(StrOpt) Allowed physical networks</td>
- </tr>
- <tr>
- <td>username = admin</td>
- <td>(StrOpt) The SSH username to use</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_ml2_brocade">
+ <caption>Description of configuration options for ml2_brocade</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">[ml2_brocade]</th>
+ </tr>
+ <tr>
+ <td>address = </td>
+ <td>(StrOpt) The address of the host to SSH to</td>
+ </tr>
+ <tr>
+ <td>ostype = NOS</td>
+ <td>(StrOpt) Unused</td>
+ </tr>
+ <tr>
+ <td>password = password</td>
+ <td>(StrOpt) The SSH password to use</td>
+ </tr>
+ <tr>
+ <td>physical_networks = </td>
+ <td>(StrOpt) Allowed physical networks</td>
+ </tr>
+ <tr>
+ <td>username = admin</td>
+ <td>(StrOpt) The SSH username to use</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-ml2_cisco.xml b/doc/common/tables/neutron-ml2_cisco.xml
index ceb7f0e447..f6c929d3c3 100644
--- a/doc/common/tables/neutron-ml2_cisco.xml
+++ b/doc/common/tables/neutron-ml2_cisco.xml
@@ -1,27 +1,26 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_ml2_cisco">
- <caption>Description of configuration options for ml2_cisco</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">[ml2_cisco]</th>
- </tr>
- <tr>
- <td>managed_physical_network = None</td>
- <td>(StrOpt) The physical network managed by the switches.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_ml2_cisco">
+ <caption>Description of configuration options for ml2_cisco</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">[ml2_cisco]</th>
+ </tr>
+ <tr>
+ <td>managed_physical_network = None</td>
+ <td>(StrOpt) The physical network managed by the switches.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-ml2_cisco_apic.xml b/doc/common/tables/neutron-ml2_cisco_apic.xml
new file mode 100644
index 0000000000..1944353c0e
--- /dev/null
+++ b/doc/common/tables/neutron-ml2_cisco_apic.xml
@@ -0,0 +1,70 @@
+<?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_neutron_ml2_cisco_apic">
+ <caption>Description of configuration options for ml2_cisco_apic</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">[ml2_cisco_apic]</th>
+ </tr>
+ <tr>
+ <td>apic_clear_node_profiles = False</td>
+ <td>(BoolOpt) Clear the node profiles on the APIC at startup (mainly used for testing)</td>
+ </tr>
+ <tr>
+ <td>apic_entity_profile = openstack_entity</td>
+ <td>(StrOpt) Name of the entity profile to be created</td>
+ </tr>
+ <tr>
+ <td>apic_function_profile = openstack_function</td>
+ <td>(StrOpt) Name of the function profile to be created</td>
+ </tr>
+ <tr>
+ <td>apic_host = None</td>
+ <td>(StrOpt) Host name or IP Address of the APIC controller</td>
+ </tr>
+ <tr>
+ <td>apic_node_profile = openstack_profile</td>
+ <td>(StrOpt) Name of the node profile to be created</td>
+ </tr>
+ <tr>
+ <td>apic_password = None</td>
+ <td>(StrOpt) Password for the APIC controller</td>
+ </tr>
+ <tr>
+ <td>apic_port = None</td>
+ <td>(StrOpt) Communication port for the APIC controller</td>
+ </tr>
+ <tr>
+ <td>apic_username = None</td>
+ <td>(StrOpt) Username for the APIC controller</td>
+ </tr>
+ <tr>
+ <td>apic_vlan_ns_name = openstack_ns</td>
+ <td>(StrOpt) Name for the vlan namespace to be used for openstack</td>
+ </tr>
+ <tr>
+ <td>apic_vlan_range = 2:4093</td>
+ <td>(StrOpt) Range of VLAN's to be used for Openstack</td>
+ </tr>
+ <tr>
+ <td>apic_vmm_domain = openstack</td>
+ <td>(StrOpt) Name for the VMM domain to be created for Openstack</td>
+ </tr>
+ <tr>
+ <td>apic_vmm_provider = VMware</td>
+ <td>(StrOpt) Name for the VMM domain provider</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-ml2_flat.xml b/doc/common/tables/neutron-ml2_flat.xml
index f1445a9f3b..d92bc731ec 100644
--- a/doc/common/tables/neutron-ml2_flat.xml
+++ b/doc/common/tables/neutron-ml2_flat.xml
@@ -1,27 +1,26 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_ml2_flat">
- <caption>Description of configuration options for ml2_flat</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">[ml2_type_flat]</th>
- </tr>
- <tr>
- <td>flat_networks = </td>
- <td>(ListOpt) List of physical_network names with which flat networks can be created. Use * to allow flat networks with arbitrary physical_network names.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_ml2_flat">
+ <caption>Description of configuration options for ml2_flat</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">[ml2_type_flat]</th>
+ </tr>
+ <tr>
+ <td>flat_networks = </td>
+ <td>(ListOpt) List of physical_network names with which flat networks can be created. Use * to allow flat networks with arbitrary physical_network names.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-ml2_fslsdn.xml b/doc/common/tables/neutron-ml2_fslsdn.xml
new file mode 100644
index 0000000000..2a806aca50
--- /dev/null
+++ b/doc/common/tables/neutron-ml2_fslsdn.xml
@@ -0,0 +1,62 @@
+<?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_neutron_ml2_fslsdn">
+ <caption>Description of configuration options for ml2_fslsdn</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">[ml2_fslsdn]</th>
+ </tr>
+ <tr>
+ <td>crd_api_insecure = False</td>
+ <td>(BoolOpt) If set, ignore any SSL validation issues</td>
+ </tr>
+ <tr>
+ <td>crd_auth_strategy = keystone</td>
+ <td>(StrOpt) Auth strategy for connecting to neutron in admin context</td>
+ </tr>
+ <tr>
+ <td>crd_auth_url = http://127.0.0.1:5000/v2.0/</td>
+ <td>(StrOpt) CRD Auth URL</td>
+ </tr>
+ <tr>
+ <td>crd_ca_certificates_file = None</td>
+ <td>(StrOpt) Location of ca certificates file to use for CRD client requests.</td>
+ </tr>
+ <tr>
+ <td>crd_password = password</td>
+ <td>(StrOpt) CRD Service Password</td>
+ </tr>
+ <tr>
+ <td>crd_region_name = RegionOne</td>
+ <td>(StrOpt) Region name for connecting to CRD Service in admin context</td>
+ </tr>
+ <tr>
+ <td>crd_tenant_name = service</td>
+ <td>(StrOpt) CRD Tenant Name</td>
+ </tr>
+ <tr>
+ <td>crd_url = http://127.0.0.1:9797</td>
+ <td>(StrOpt) URL for connecting to CRD service</td>
+ </tr>
+ <tr>
+ <td>crd_url_timeout = 30</td>
+ <td>(IntOpt) Timeout value for connecting to CRD service in seconds</td>
+ </tr>
+ <tr>
+ <td>crd_user_name = crd</td>
+ <td>(StrOpt) CRD service Username</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-ml2_gre.xml b/doc/common/tables/neutron-ml2_gre.xml
index 1b36d8c5de..3b53645e14 100644
--- a/doc/common/tables/neutron-ml2_gre.xml
+++ b/doc/common/tables/neutron-ml2_gre.xml
@@ -1,27 +1,26 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_ml2_gre">
- <caption>Description of configuration options for ml2_gre</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">[ml2_type_gre]</th>
- </tr>
- <tr>
- <td>tunnel_id_ranges = </td>
- <td>(ListOpt) Comma-separated list of <tun_min>:<tun_max> tuples enumerating ranges of GRE tunnel IDs that are available for tenant network allocation</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_ml2_gre">
+ <caption>Description of configuration options for ml2_gre</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">[ml2_type_gre]</th>
+ </tr>
+ <tr>
+ <td>tunnel_id_ranges = </td>
+ <td>(ListOpt) Comma-separated list of <tun_min>:<tun_max> tuples enumerating ranges of GRE tunnel IDs that are available for tenant network allocation</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-ml2_l2pop.xml b/doc/common/tables/neutron-ml2_l2pop.xml
index 21f031baba..62a5824d8b 100644
--- a/doc/common/tables/neutron-ml2_l2pop.xml
+++ b/doc/common/tables/neutron-ml2_l2pop.xml
@@ -1,27 +1,26 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_ml2_l2pop">
- <caption>Description of configuration options for ml2_l2pop</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">[l2pop]</th>
- </tr>
- <tr>
- <td>agent_boot_time = 180</td>
- <td>(IntOpt) Delay within which agent is expected to update existing ports whent it restarts</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_ml2_l2pop">
+ <caption>Description of configuration options for ml2_l2pop</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">[l2pop]</th>
+ </tr>
+ <tr>
+ <td>agent_boot_time = 180</td>
+ <td>(IntOpt) Delay within which agent is expected to update existing ports whent it restarts</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-ml2_mlnx.xml b/doc/common/tables/neutron-ml2_mlnx.xml
index e7a36c6e74..eb832a67cd 100644
--- a/doc/common/tables/neutron-ml2_mlnx.xml
+++ b/doc/common/tables/neutron-ml2_mlnx.xml
@@ -1,31 +1,30 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_ml2_mlnx">
- <caption>Description of configuration options for ml2_mlnx</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">[ESWITCH]</th>
- </tr>
- <tr>
- <td>apply_profile_patch = False</td>
- <td>(BoolOpt) Enable server compatibility with old nova</td>
- </tr>
- <tr>
- <td>vnic_type = mlnx_direct</td>
- <td>(StrOpt) Type of VM network interface: mlnx_direct or hostdev</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_ml2_mlnx">
+ <caption>Description of configuration options for ml2_mlnx</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">[ESWITCH]</th>
+ </tr>
+ <tr>
+ <td>apply_profile_patch = False</td>
+ <td>(BoolOpt) Enable server compatibility with old nova</td>
+ </tr>
+ <tr>
+ <td>vnic_type = mlnx_direct</td>
+ <td>(StrOpt) Type of VM network interface: mlnx_direct or hostdev</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-ml2_ncs.xml b/doc/common/tables/neutron-ml2_ncs.xml
index cc3e37a8bf..698ff4271c 100644
--- a/doc/common/tables/neutron-ml2_ncs.xml
+++ b/doc/common/tables/neutron-ml2_ncs.xml
@@ -1,39 +1,38 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_ml2_ncs">
- <caption>Description of configuration options for ml2_ncs</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">[ml2_ncs]</th>
- </tr>
- <tr>
- <td>password = None</td>
- <td>(StrOpt) HTTP password for authentication</td>
- </tr>
- <tr>
- <td>timeout = 10</td>
- <td>(IntOpt) HTTP timeout in seconds.</td>
- </tr>
- <tr>
- <td>url = None</td>
- <td>(StrOpt) HTTP URL of Tail-f NCS REST interface.</td>
- </tr>
- <tr>
- <td>username = None</td>
- <td>(StrOpt) HTTP username for authentication</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_ml2_ncs">
+ <caption>Description of configuration options for ml2_ncs</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">[ml2_ncs]</th>
+ </tr>
+ <tr>
+ <td>password = None</td>
+ <td>(StrOpt) HTTP password for authentication</td>
+ </tr>
+ <tr>
+ <td>timeout = 10</td>
+ <td>(IntOpt) HTTP timeout in seconds.</td>
+ </tr>
+ <tr>
+ <td>url = None</td>
+ <td>(StrOpt) HTTP URL of Tail-f NCS REST interface.</td>
+ </tr>
+ <tr>
+ <td>username = None</td>
+ <td>(StrOpt) HTTP username for authentication</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-ml2_odl.xml b/doc/common/tables/neutron-ml2_odl.xml
index 9f19db40e3..67fa1b2dc9 100644
--- a/doc/common/tables/neutron-ml2_odl.xml
+++ b/doc/common/tables/neutron-ml2_odl.xml
@@ -1,43 +1,42 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_ml2_odl">
- <caption>Description of configuration options for ml2_odl</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">[ml2_odl]</th>
- </tr>
- <tr>
- <td>password = None</td>
- <td>(StrOpt) HTTP password for authentication</td>
- </tr>
- <tr>
- <td>session_timeout = 30</td>
- <td>(IntOpt) Tomcat session timeout in minutes.</td>
- </tr>
- <tr>
- <td>timeout = 10</td>
- <td>(IntOpt) HTTP timeout in seconds.</td>
- </tr>
- <tr>
- <td>url = None</td>
- <td>(StrOpt) HTTP URL of OpenDaylight REST interface.</td>
- </tr>
- <tr>
- <td>username = None</td>
- <td>(StrOpt) HTTP username for authentication</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_ml2_odl">
+ <caption>Description of configuration options for ml2_odl</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">[ml2_odl]</th>
+ </tr>
+ <tr>
+ <td>password = None</td>
+ <td>(StrOpt) HTTP password for authentication</td>
+ </tr>
+ <tr>
+ <td>session_timeout = 30</td>
+ <td>(IntOpt) Tomcat session timeout in minutes.</td>
+ </tr>
+ <tr>
+ <td>timeout = 10</td>
+ <td>(IntOpt) HTTP timeout in seconds.</td>
+ </tr>
+ <tr>
+ <td>url = None</td>
+ <td>(StrOpt) HTTP URL of OpenDaylight REST interface.</td>
+ </tr>
+ <tr>
+ <td>username = None</td>
+ <td>(StrOpt) HTTP username for authentication</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-ml2_ofa.xml b/doc/common/tables/neutron-ml2_ofa.xml
index 54b9d72ec4..1293b81d59 100644
--- a/doc/common/tables/neutron-ml2_ofa.xml
+++ b/doc/common/tables/neutron-ml2_ofa.xml
@@ -1,42 +1,45 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_ml2_ofa">
- <caption>Description of configuration options for ml2_ofa</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>ofp_listen_host = </td>
- <td>(StrOpt) openflow listen host</td>
- </tr>
- <tr>
- <td>ofp_ssl_listen_port = 6633</td>
- <td>(IntOpt) openflow ssl listen port</td>
- </tr>
- <tr>
- <td>ofp_tcp_listen_port = 6633</td>
- <td>(IntOpt) openflow tcp listen port</td>
- </tr>
- <tr>
- <th colspan="2">[AGENT]</th>
- </tr>
- <tr>
- <td>get_datapath_retry_times = 60</td>
- <td>(IntOpt) Number of seconds to retry acquiring an Open vSwitch datapath</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_ml2_ofa">
+ <caption>Description of configuration options for ml2_ofa</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>ofp_listen_host = </td>
+ <td>(StrOpt) openflow listen host</td>
+ </tr>
+ <tr>
+ <td>ofp_ssl_listen_port = 6633</td>
+ <td>(IntOpt) openflow ssl listen port</td>
+ </tr>
+ <tr>
+ <td>ofp_tcp_listen_port = 6633</td>
+ <td>(IntOpt) openflow tcp listen port</td>
+ </tr>
+ <tr>
+ <th colspan="2">[AGENT]</th>
+ </tr>
+ <tr>
+ <td>dont_fragment = True</td>
+ <td>(BoolOpt) Set or un-set the don't fragment (DF) bit on outgoing IP packet carrying GRE/VXLAN tunnel</td>
+ </tr>
+ <tr>
+ <td>get_datapath_retry_times = 60</td>
+ <td>(IntOpt) Number of seconds to retry acquiring an Open vSwitch datapath</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-ml2_vlan.xml b/doc/common/tables/neutron-ml2_vlan.xml
index 8e445ad1f1..9b244f0127 100644
--- a/doc/common/tables/neutron-ml2_vlan.xml
+++ b/doc/common/tables/neutron-ml2_vlan.xml
@@ -1,27 +1,26 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_ml2_vlan">
- <caption>Description of configuration options for ml2_vlan</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">[ml2_type_vlan]</th>
- </tr>
- <tr>
- <td>network_vlan_ranges = </td>
- <td>(ListOpt) List of <physical_network>:<vlan_min>:<vlan_max> or <physical_network> specifying physical_network names usable for VLAN provider and tenant networks, as well as ranges of VLAN tags on each available for allocation to tenant networks.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_ml2_vlan">
+ <caption>Description of configuration options for ml2_vlan</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">[ml2_type_vlan]</th>
+ </tr>
+ <tr>
+ <td>network_vlan_ranges = </td>
+ <td>(ListOpt) List of <physical_network>:<vlan_min>:<vlan_max> or <physical_network> specifying physical_network names usable for VLAN provider and tenant networks, as well as ranges of VLAN tags on each available for allocation to tenant networks.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-ml2_vxlan.xml b/doc/common/tables/neutron-ml2_vxlan.xml
index 2a915752a4..3bf50df32f 100644
--- a/doc/common/tables/neutron-ml2_vxlan.xml
+++ b/doc/common/tables/neutron-ml2_vxlan.xml
@@ -1,31 +1,30 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_ml2_vxlan">
- <caption>Description of configuration options for ml2_vxlan</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">[ml2_type_vxlan]</th>
- </tr>
- <tr>
- <td>vni_ranges = </td>
- <td>(ListOpt) Comma-separated list of <vni_min>:<vni_max> tuples enumerating ranges of VXLAN VNI IDs that are available for tenant network allocation</td>
- </tr>
- <tr>
- <td>vxlan_group = None</td>
- <td>(StrOpt) Multicast group for VXLAN. If unset, disables VXLAN multicast mode.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_ml2_vxlan">
+ <caption>Description of configuration options for ml2_vxlan</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">[ml2_type_vxlan]</th>
+ </tr>
+ <tr>
+ <td>vni_ranges = </td>
+ <td>(ListOpt) Comma-separated list of <vni_min>:<vni_max> tuples enumerating ranges of VXLAN VNI IDs that are available for tenant network allocation</td>
+ </tr>
+ <tr>
+ <td>vxlan_group = None</td>
+ <td>(StrOpt) Multicast group for VXLAN. If unset, disables VXLAN multicast mode.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-mlnx.xml b/doc/common/tables/neutron-mlnx.xml
index 7d659ed987..df0bb7d636 100644
--- a/doc/common/tables/neutron-mlnx.xml
+++ b/doc/common/tables/neutron-mlnx.xml
@@ -1,58 +1,57 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_mlnx">
- <caption>Description of configuration options for mlnx</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">[ESWITCH]</th>
- </tr>
- <tr>
- <td>backoff_rate = 2</td>
- <td>(IntOpt) backoff rate multiplier for waiting period between retries for request to daemon, i.e. value of 2 will double the request timeout each retry</td>
- </tr>
- <tr>
- <td>daemon_endpoint = tcp://127.0.0.1:60001</td>
- <td>(StrOpt) eswitch daemon end point</td>
- </tr>
- <tr>
- <td>physical_interface_mappings = </td>
- <td>(ListOpt) List of <physical_network>:<physical_interface></td>
- </tr>
- <tr>
- <td>request_timeout = 3000</td>
- <td>(IntOpt) The number of milliseconds the agent will wait for response on request to daemon.</td>
- </tr>
- <tr>
- <th colspan="2">[MLNX]</th>
- </tr>
- <tr>
- <td>network_vlan_ranges = default:1:1000</td>
- <td>(ListOpt) List of <physical_network>:<vlan_min>:<vlan_max> or <physical_network></td>
- </tr>
- <tr>
- <td>physical_network_type = eth</td>
- <td>(StrOpt) Physical network type for provider network (eth or ib)</td>
- </tr>
- <tr>
- <td>physical_network_type_mappings = </td>
- <td>(ListOpt) List of <physical_network>:<physical_network_type> with physical_network_type is either eth or ib</td>
- </tr>
- <tr>
- <td>tenant_network_type = vlan</td>
- <td>(StrOpt) Network type for tenant networks (local, vlan, or none)</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_mlnx">
+ <caption>Description of configuration options for mlnx</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">[ESWITCH]</th>
+ </tr>
+ <tr>
+ <td>backoff_rate = 2</td>
+ <td>(IntOpt) backoff rate multiplier for waiting period between retries for request to daemon, i.e. value of 2 will double the request timeout each retry</td>
+ </tr>
+ <tr>
+ <td>daemon_endpoint = tcp://127.0.0.1:60001</td>
+ <td>(StrOpt) eswitch daemon end point</td>
+ </tr>
+ <tr>
+ <td>physical_interface_mappings = </td>
+ <td>(ListOpt) List of <physical_network>:<physical_interface></td>
+ </tr>
+ <tr>
+ <td>request_timeout = 3000</td>
+ <td>(IntOpt) The number of milliseconds the agent will wait for response on request to daemon.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[MLNX]</th>
+ </tr>
+ <tr>
+ <td>network_vlan_ranges = default:1:1000</td>
+ <td>(ListOpt) List of <physical_network>:<vlan_min>:<vlan_max> or <physical_network></td>
+ </tr>
+ <tr>
+ <td>physical_network_type = eth</td>
+ <td>(StrOpt) Physical network type for provider network (eth or ib)</td>
+ </tr>
+ <tr>
+ <td>physical_network_type_mappings = </td>
+ <td>(ListOpt) List of <physical_network>:<physical_network_type> with physical_network_type is either eth or ib</td>
+ </tr>
+ <tr>
+ <td>tenant_network_type = vlan</td>
+ <td>(StrOpt) Network type for tenant networks (local, vlan, or none)</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-nec.xml b/doc/common/tables/neutron-nec.xml
index 4c420ebf1f..8f4d14a166 100644
--- a/doc/common/tables/neutron-nec.xml
+++ b/doc/common/tables/neutron-nec.xml
@@ -1,81 +1,80 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_nec">
- <caption>Description of configuration options for nec</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">[OFC]</th>
- </tr>
- <tr>
- <td>api_max_attempts = 3</td>
- <td>(IntOpt) Maximum attempts per OFC API request.NEC plugin retries API request to OFC when OFC returns ServiceUnavailable (503).The value must be greater than 0.</td>
- </tr>
- <tr>
- <td>cert_file = None</td>
- <td>(StrOpt) Certificate file</td>
- </tr>
- <tr>
- <td>driver = trema</td>
- <td>(StrOpt) Driver to use</td>
- </tr>
- <tr>
- <td>enable_packet_filter = True</td>
- <td>(BoolOpt) Enable packet filter</td>
- </tr>
- <tr>
- <td>host = 127.0.0.1</td>
- <td>(StrOpt) Host to connect to</td>
- </tr>
- <tr>
- <td>insecure_ssl = False</td>
- <td>(BoolOpt) Disable SSL certificate verification</td>
- </tr>
- <tr>
- <td>key_file = None</td>
- <td>(StrOpt) Key file</td>
- </tr>
- <tr>
- <td>path_prefix = </td>
- <td>(StrOpt) Base URL of OFC REST API. It is prepended to each API request.</td>
- </tr>
- <tr>
- <td>port = 8888</td>
- <td>(StrOpt) Port to connect to</td>
- </tr>
- <tr>
- <td>use_ssl = False</td>
- <td>(BoolOpt) Use SSL to connect</td>
- </tr>
- <tr>
- <th colspan="2">[PROVIDER]</th>
- </tr>
- <tr>
- <td>default_router_provider = l3-agent</td>
- <td>(StrOpt) Default router provider to use.</td>
- </tr>
- <tr>
- <td>router_providers = l3-agent, openflow</td>
- <td>(ListOpt) List of enabled router providers.</td>
- </tr>
- <tr>
- <th colspan="2">[fwaas]</th>
- </tr>
- <tr>
- <td>driver = </td>
- <td>(StrOpt) Name of the FWaaS Driver</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_nec">
+ <caption>Description of configuration options for nec</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">[OFC]</th>
+ </tr>
+ <tr>
+ <td>api_max_attempts = 3</td>
+ <td>(IntOpt) Maximum attempts per OFC API request.NEC plugin retries API request to OFC when OFC returns ServiceUnavailable (503).The value must be greater than 0.</td>
+ </tr>
+ <tr>
+ <td>cert_file = None</td>
+ <td>(StrOpt) Certificate file</td>
+ </tr>
+ <tr>
+ <td>driver = trema</td>
+ <td>(StrOpt) Driver to use</td>
+ </tr>
+ <tr>
+ <td>enable_packet_filter = True</td>
+ <td>(BoolOpt) Enable packet filter</td>
+ </tr>
+ <tr>
+ <td>host = 127.0.0.1</td>
+ <td>(StrOpt) Host to connect to</td>
+ </tr>
+ <tr>
+ <td>insecure_ssl = False</td>
+ <td>(BoolOpt) Disable SSL certificate verification</td>
+ </tr>
+ <tr>
+ <td>key_file = None</td>
+ <td>(StrOpt) Key file</td>
+ </tr>
+ <tr>
+ <td>path_prefix = </td>
+ <td>(StrOpt) Base URL of OFC REST API. It is prepended to each API request.</td>
+ </tr>
+ <tr>
+ <td>port = 8888</td>
+ <td>(StrOpt) Port to connect to</td>
+ </tr>
+ <tr>
+ <td>use_ssl = False</td>
+ <td>(BoolOpt) Use SSL to connect</td>
+ </tr>
+ <tr>
+ <th colspan="2">[PROVIDER]</th>
+ </tr>
+ <tr>
+ <td>default_router_provider = l3-agent</td>
+ <td>(StrOpt) Default router provider to use.</td>
+ </tr>
+ <tr>
+ <td>router_providers = l3-agent, openflow</td>
+ <td>(ListOpt) List of enabled router providers.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[fwaas]</th>
+ </tr>
+ <tr>
+ <td>driver = </td>
+ <td>(StrOpt) Name of the FWaaS Driver</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-notifier.xml b/doc/common/tables/neutron-notifier.xml
index 41463d020d..a1d0624161 100644
--- a/doc/common/tables/neutron-notifier.xml
+++ b/doc/common/tables/neutron-notifier.xml
@@ -1,39 +1,30 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_notifier">
- <caption>Description of configuration options for notifier</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>default_notification_level = INFO</td>
- <td>(StrOpt) Default notification level for outgoing notifications</td>
- </tr>
- <tr>
- <td>default_publisher_id = $host</td>
- <td>(StrOpt) Default publisher_id for outgoing notifications</td>
- </tr>
- <tr>
- <td>notification_driver = []</td>
- <td>(MultiStrOpt) Driver or drivers to handle sending notifications</td>
- </tr>
- <tr>
- <td>notification_topics = notifications</td>
- <td>(ListOpt) AMQP topic used for openstack notifications</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_notifier">
+ <caption>Description of configuration options for notifier</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>notification_driver = []</td>
+ <td>(MultiStrOpt) Driver or drivers to handle sending notifications.</td>
+ </tr>
+ <tr>
+ <td>notification_topics = notifications</td>
+ <td>(ListOpt) AMQP topic used for OpenStack notifications.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-nuage.xml b/doc/common/tables/neutron-nuage.xml
index 66cd3c1222..a035faba12 100644
--- a/doc/common/tables/neutron-nuage.xml
+++ b/doc/common/tables/neutron-nuage.xml
@@ -1,55 +1,54 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_nuage">
- <caption>Description of configuration options for nuage</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">[RESTPROXY]</th>
- </tr>
- <tr>
- <td>auth_resource = </td>
- <td>(StrOpt) Nuage provided uri for initial authorization to access VSD</td>
- </tr>
- <tr>
- <td>base_uri = /</td>
- <td>(StrOpt) Nuage provided base uri to reach out to VSD</td>
- </tr>
- <tr>
- <td>default_floatingip_quota = 254</td>
- <td>(IntOpt) Per Net Partition quota of floating ips</td>
- </tr>
- <tr>
- <td>default_net_partition_name = OpenStackDefaultNetPartition</td>
- <td>(StrOpt) Default Network partition in which VSD will orchestrate network resources using openstack</td>
- </tr>
- <tr>
- <td>organization = system</td>
- <td>(StrOpt) Organization name in which VSD will orchestrate network resources using openstack</td>
- </tr>
- <tr>
- <td>server = localhost:8800</td>
- <td>(StrOpt) IP Address and Port of Nuage's VSD server</td>
- </tr>
- <tr>
- <td>serverauth = username:password</td>
- <td>(StrOpt) Username and password for authentication</td>
- </tr>
- <tr>
- <td>serverssl = False</td>
- <td>(BoolOpt) Boolean for SSL connection with VSD server</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_nuage">
+ <caption>Description of configuration options for nuage</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">[RESTPROXY]</th>
+ </tr>
+ <tr>
+ <td>auth_resource = </td>
+ <td>(StrOpt) Nuage provided uri for initial authorization to access VSD</td>
+ </tr>
+ <tr>
+ <td>base_uri = /</td>
+ <td>(StrOpt) Nuage provided base uri to reach out to VSD</td>
+ </tr>
+ <tr>
+ <td>default_floatingip_quota = 254</td>
+ <td>(IntOpt) Per Net Partition quota of floating ips</td>
+ </tr>
+ <tr>
+ <td>default_net_partition_name = OpenStackDefaultNetPartition</td>
+ <td>(StrOpt) Default Network partition in which VSD will orchestrate network resources using openstack</td>
+ </tr>
+ <tr>
+ <td>organization = system</td>
+ <td>(StrOpt) Organization name in which VSD will orchestrate network resources using openstack</td>
+ </tr>
+ <tr>
+ <td>server = localhost:8800</td>
+ <td>(StrOpt) IP Address and Port of Nuage's VSD server</td>
+ </tr>
+ <tr>
+ <td>serverauth = username:password</td>
+ <td>(StrOpt) Username and password for authentication</td>
+ </tr>
+ <tr>
+ <td>serverssl = False</td>
+ <td>(BoolOpt) Boolean for SSL connection with VSD server</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-nvsd.xml b/doc/common/tables/neutron-nvsd.xml
index 0151b16bd8..69d8d588d3 100644
--- a/doc/common/tables/neutron-nvsd.xml
+++ b/doc/common/tables/neutron-nvsd.xml
@@ -1,54 +1,53 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_nvsd">
- <caption>Description of configuration options for nvsd</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">[AGENT]</th>
- </tr>
- <tr>
- <td>integration_bridge = br-int</td>
- <td>(StrOpt) integration bridge</td>
- </tr>
- <tr>
- <th colspan="2">[nvsd]</th>
- </tr>
- <tr>
- <td>nvsd_ip = 127.0.0.1</td>
- <td>(StrOpt) NVSD Controller IP address</td>
- </tr>
- <tr>
- <td>nvsd_passwd = oc123</td>
- <td>(StrOpt) NVSD Controller password</td>
- </tr>
- <tr>
- <td>nvsd_port = 8082</td>
- <td>(IntOpt) NVSD Controller Port number</td>
- </tr>
- <tr>
- <td>nvsd_retries = 0</td>
- <td>(IntOpt) Number of login retries to NVSD controller</td>
- </tr>
- <tr>
- <td>nvsd_user = ocplugin</td>
- <td>(StrOpt) NVSD Controller username</td>
- </tr>
- <tr>
- <td>request_timeout = 30</td>
- <td>(IntOpt) NVSD controller REST API request timeout in seconds</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_nvsd">
+ <caption>Description of configuration options for nvsd</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">[AGENT]</th>
+ </tr>
+ <tr>
+ <td>integration_bridge = br-int</td>
+ <td>(StrOpt) integration bridge</td>
+ </tr>
+ <tr>
+ <th colspan="2">[nvsd]</th>
+ </tr>
+ <tr>
+ <td>nvsd_ip = 127.0.0.1</td>
+ <td>(StrOpt) NVSD Controller IP address</td>
+ </tr>
+ <tr>
+ <td>nvsd_passwd = oc123</td>
+ <td>(StrOpt) NVSD Controller password</td>
+ </tr>
+ <tr>
+ <td>nvsd_port = 8082</td>
+ <td>(IntOpt) NVSD Controller Port number</td>
+ </tr>
+ <tr>
+ <td>nvsd_retries = 0</td>
+ <td>(IntOpt) Number of login retries to NVSD controller</td>
+ </tr>
+ <tr>
+ <td>nvsd_user = ocplugin</td>
+ <td>(StrOpt) NVSD Controller username</td>
+ </tr>
+ <tr>
+ <td>request_timeout = 30</td>
+ <td>(IntOpt) NVSD controller REST API request timeout in seconds</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-openvswitch_agent.xml b/doc/common/tables/neutron-openvswitch_agent.xml
index 2745c69799..15d31d7a2e 100644
--- a/doc/common/tables/neutron-openvswitch_agent.xml
+++ b/doc/common/tables/neutron-openvswitch_agent.xml
@@ -1,116 +1,127 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_openvswitch_agent">
- <caption>Description of configuration options for openvswitch_agent</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>ovs_integration_bridge = br-int</td>
- <td>(StrOpt) Name of Open vSwitch bridge to use</td>
- </tr>
- <tr>
- <td>ovs_use_veth = False</td>
- <td>(BoolOpt) Uses veth for an interface or not</td>
- </tr>
- <tr>
- <td>ovs_vsctl_timeout = 10</td>
- <td>(IntOpt) Timeout in seconds for ovs-vsctl commands</td>
- </tr>
- <tr>
- <th colspan="2">[AGENT]</th>
- </tr>
- <tr>
- <td>l2_population = False</td>
- <td>(BoolOpt) Use ml2 l2population mechanism driver to learn remote mac and IPs and improve tunnel scalability</td>
- </tr>
- <tr>
- <td>minimize_polling = True</td>
- <td>(BoolOpt) Minimize polling by monitoring ovsdb for interface changes.</td>
- </tr>
- <tr>
- <td>ovsdb_monitor_respawn_interval = 30</td>
- <td>(IntOpt) The number of seconds to wait before respawning the ovsdb monitor after losing communication with it</td>
- </tr>
- <tr>
- <td>tunnel_types = </td>
- <td>(ListOpt) Network types supported by the agent (gre and/or vxlan)</td>
- </tr>
- <tr>
- <td>veth_mtu = None</td>
- <td>(IntOpt) MTU size of veth interfaces</td>
- </tr>
- <tr>
- <td>vxlan_udp_port = 4789</td>
- <td>(IntOpt) The UDP port to use for VXLAN tunnels.</td>
- </tr>
- <tr>
- <th colspan="2">[CISCO_N1K]</th>
- </tr>
- <tr>
- <td>local_ip = 10.0.0.3</td>
- <td>(StrOpt) N1K Local IP</td>
- </tr>
- <tr>
- <th colspan="2">[OVS]</th>
- </tr>
- <tr>
- <td>bridge_mappings = </td>
- <td>(ListOpt) List of <physical_network>:<bridge></td>
- </tr>
- <tr>
- <td>enable_tunneling = False</td>
- <td>(BoolOpt) Enable tunneling support</td>
- </tr>
- <tr>
- <td>int_peer_patch_port = patch-tun</td>
- <td>(StrOpt) Peer patch port in integration bridge for tunnel bridge</td>
- </tr>
- <tr>
- <td>integration_bridge = br-int</td>
- <td>(StrOpt) Integration bridge to use</td>
- </tr>
- <tr>
- <td>local_ip = </td>
- <td>(StrOpt) Local IP address of GRE tunnel endpoints.</td>
- </tr>
- <tr>
- <td>network_vlan_ranges = </td>
- <td>(ListOpt) List of <physical_network>:<vlan_min>:<vlan_max> or <physical_network></td>
- </tr>
- <tr>
- <td>tenant_network_type = local</td>
- <td>(StrOpt) Network type for tenant networks (local, vlan, gre, vxlan, or none)</td>
- </tr>
- <tr>
- <td>tun_peer_patch_port = patch-int</td>
- <td>(StrOpt) Peer patch port in tunnel bridge for integration bridge</td>
- </tr>
- <tr>
- <td>tunnel_bridge = br-tun</td>
- <td>(StrOpt) Tunnel bridge to use</td>
- </tr>
- <tr>
- <td>tunnel_id_ranges = </td>
- <td>(ListOpt) List of <tun_min>:<tun_max></td>
- </tr>
- <tr>
- <td>tunnel_type = </td>
- <td>(StrOpt) The type of tunnels to use when utilizing tunnels, either 'gre' or 'vxlan'</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_openvswitch_agent">
+ <caption>Description of configuration options for openvswitch_agent</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>ovs_integration_bridge = br-int</td>
+ <td>(StrOpt) Name of Open vSwitch bridge to use</td>
+ </tr>
+ <tr>
+ <td>ovs_use_veth = False</td>
+ <td>(BoolOpt) Uses veth for an interface or not</td>
+ </tr>
+ <tr>
+ <td>ovs_vsctl_timeout = 10</td>
+ <td>(IntOpt) Timeout in seconds for ovs-vsctl commands</td>
+ </tr>
+ <tr>
+ <th colspan="2">[AGENT]</th>
+ </tr>
+ <tr>
+ <td>arp_responder = False</td>
+ <td>(BoolOpt) Enable local ARP responder if it is supported</td>
+ </tr>
+ <tr>
+ <td>dont_fragment = True</td>
+ <td>(BoolOpt) Set or un-set the don't fragment (DF) bit on outgoing IP packet carrying GRE/VXLAN tunnel</td>
+ </tr>
+ <tr>
+ <td>l2_population = False</td>
+ <td>(BoolOpt) Use ml2 l2population mechanism driver to learn remote mac and IPs and improve tunnel scalability</td>
+ </tr>
+ <tr>
+ <td>minimize_polling = True</td>
+ <td>(BoolOpt) Minimize polling by monitoring ovsdb for interface changes.</td>
+ </tr>
+ <tr>
+ <td>ovsdb_monitor_respawn_interval = 30</td>
+ <td>(IntOpt) The number of seconds to wait before respawning the ovsdb monitor after losing communication with it</td>
+ </tr>
+ <tr>
+ <td>tunnel_types = </td>
+ <td>(ListOpt) Network types supported by the agent (gre and/or vxlan)</td>
+ </tr>
+ <tr>
+ <td>veth_mtu = None</td>
+ <td>(IntOpt) MTU size of veth interfaces</td>
+ </tr>
+ <tr>
+ <td>vxlan_udp_port = 4789</td>
+ <td>(IntOpt) The UDP port to use for VXLAN tunnels.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[CISCO_N1K]</th>
+ </tr>
+ <tr>
+ <td>local_ip = 10.0.0.3</td>
+ <td>(StrOpt) N1K Local IP</td>
+ </tr>
+ <tr>
+ <th colspan="2">[OVS]</th>
+ </tr>
+ <tr>
+ <td>bridge_mappings = </td>
+ <td>(ListOpt) List of <physical_network>:<bridge></td>
+ </tr>
+ <tr>
+ <td>enable_tunneling = False</td>
+ <td>(BoolOpt) Enable tunneling support</td>
+ </tr>
+ <tr>
+ <td>int_peer_patch_port = patch-tun</td>
+ <td>(StrOpt) Peer patch port in integration bridge for tunnel bridge</td>
+ </tr>
+ <tr>
+ <td>integration_bridge = br-int</td>
+ <td>(StrOpt) Integration bridge to use</td>
+ </tr>
+ <tr>
+ <td>local_ip = </td>
+ <td>(StrOpt) Local IP address of GRE tunnel endpoints.</td>
+ </tr>
+ <tr>
+ <td>network_vlan_ranges = </td>
+ <td>(ListOpt) List of <physical_network>:<vlan_min>:<vlan_max> or <physical_network></td>
+ </tr>
+ <tr>
+ <td>tenant_network_type = local</td>
+ <td>(StrOpt) Network type for tenant networks (local, vlan, gre, vxlan, or none)</td>
+ </tr>
+ <tr>
+ <td>tun_peer_patch_port = patch-int</td>
+ <td>(StrOpt) Peer patch port in tunnel bridge for integration bridge</td>
+ </tr>
+ <tr>
+ <td>tunnel_bridge = br-tun</td>
+ <td>(StrOpt) Tunnel bridge to use</td>
+ </tr>
+ <tr>
+ <td>tunnel_id_ranges = </td>
+ <td>(ListOpt) List of <tun_min>:<tun_max></td>
+ </tr>
+ <tr>
+ <td>tunnel_type = </td>
+ <td>(StrOpt) The type of tunnels to use when utilizing tunnels, either 'gre' or 'vxlan'</td>
+ </tr>
+ <tr>
+ <td>use_veth_interconnection = False</td>
+ <td>(BoolOpt) Use veths instead of patch ports to interconnect the integration bridge to physical bridges</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-plumgrid.xml b/doc/common/tables/neutron-plumgrid.xml
index 5685e9e917..279ad0ef01 100644
--- a/doc/common/tables/neutron-plumgrid.xml
+++ b/doc/common/tables/neutron-plumgrid.xml
@@ -1,43 +1,46 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_plumgrid">
- <caption>Description of configuration options for plumgrid</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">[plumgriddirector]</th>
- </tr>
- <tr>
- <td>director_server = localhost</td>
- <td>(StrOpt) PLUMgrid Director server to connect to</td>
- </tr>
- <tr>
- <td>director_server_port = 8080</td>
- <td>(StrOpt) PLUMgrid Director server port to connect to</td>
- </tr>
- <tr>
- <td>password = password</td>
- <td>(StrOpt) PLUMgrid Director admin password</td>
- </tr>
- <tr>
- <td>servertimeout = 5</td>
- <td>(IntOpt) PLUMgrid Director server timeout</td>
- </tr>
- <tr>
- <td>username = username</td>
- <td>(StrOpt) PLUMgrid Director admin username</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_plumgrid">
+ <caption>Description of configuration options for plumgrid</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">[plumgriddirector]</th>
+ </tr>
+ <tr>
+ <td>director_server = localhost</td>
+ <td>(StrOpt) PLUMgrid Director server to connect to</td>
+ </tr>
+ <tr>
+ <td>director_server_port = 8080</td>
+ <td>(StrOpt) PLUMgrid Director server port to connect to</td>
+ </tr>
+ <tr>
+ <td>driver = neutron.plugins.plumgrid.drivers.plumlib.Plumlib</td>
+ <td>(StrOpt) PLUMgrid Driver</td>
+ </tr>
+ <tr>
+ <td>password = password</td>
+ <td>(StrOpt) PLUMgrid Director admin password</td>
+ </tr>
+ <tr>
+ <td>servertimeout = 5</td>
+ <td>(IntOpt) PLUMgrid Director server timeout</td>
+ </tr>
+ <tr>
+ <td>username = username</td>
+ <td>(StrOpt) PLUMgrid Director admin username</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-policy.xml b/doc/common/tables/neutron-policy.xml
index 76a95ae023..dba6da4925 100644
--- a/doc/common/tables/neutron-policy.xml
+++ b/doc/common/tables/neutron-policy.xml
@@ -1,31 +1,30 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_policy">
- <caption>Description of configuration options for policy</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>allow_overlapping_ips = False</td>
- <td>(BoolOpt) Allow overlapping IP support in Neutron</td>
- </tr>
- <tr>
- <td>policy_file = policy.json</td>
- <td>(StrOpt) The policy file to use</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_policy">
+ <caption>Description of configuration options for policy</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>allow_overlapping_ips = False</td>
+ <td>(BoolOpt) Allow overlapping IP support in Neutron</td>
+ </tr>
+ <tr>
+ <td>policy_file = policy.json</td>
+ <td>(StrOpt) The policy file to use</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-qpid.xml b/doc/common/tables/neutron-qpid.xml
index aac6e35fc5..99acdc3caf 100644
--- a/doc/common/tables/neutron-qpid.xml
+++ b/doc/common/tables/neutron-qpid.xml
@@ -1,63 +1,62 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_qpid">
- <caption>Description of configuration options for qpid</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>qpid_heartbeat = 60</td>
- <td>(IntOpt) Seconds between connection keepalive heartbeats</td>
- </tr>
- <tr>
- <td>qpid_hostname = localhost</td>
- <td>(StrOpt) Qpid broker hostname</td>
- </tr>
- <tr>
- <td>qpid_hosts = $qpid_hostname:$qpid_port</td>
- <td>(ListOpt) Qpid HA cluster host:port pairs</td>
- </tr>
- <tr>
- <td>qpid_password = </td>
- <td>(StrOpt) Password for qpid connection</td>
- </tr>
- <tr>
- <td>qpid_port = 5672</td>
- <td>(IntOpt) Qpid broker port</td>
- </tr>
- <tr>
- <td>qpid_protocol = tcp</td>
- <td>(StrOpt) Transport to use, either 'tcp' or 'ssl'</td>
- </tr>
- <tr>
- <td>qpid_sasl_mechanisms = </td>
- <td>(StrOpt) Space separated list of SASL mechanisms to use for auth</td>
- </tr>
- <tr>
- <td>qpid_tcp_nodelay = True</td>
- <td>(BoolOpt) Disable Nagle algorithm</td>
- </tr>
- <tr>
- <td>qpid_topology_version = 1</td>
- <td>(IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.</td>
- </tr>
- <tr>
- <td>qpid_username = </td>
- <td>(StrOpt) Username for qpid connection</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_qpid">
+ <caption>Description of configuration options for qpid</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>qpid_heartbeat = 60</td>
+ <td>(IntOpt) Seconds between connection keepalive heartbeats.</td>
+ </tr>
+ <tr>
+ <td>qpid_hostname = localhost</td>
+ <td>(StrOpt) Qpid broker hostname.</td>
+ </tr>
+ <tr>
+ <td>qpid_hosts = $qpid_hostname:$qpid_port</td>
+ <td>(ListOpt) Qpid HA cluster host:port pairs.</td>
+ </tr>
+ <tr>
+ <td>qpid_password = </td>
+ <td>(StrOpt) Password for Qpid connection.</td>
+ </tr>
+ <tr>
+ <td>qpid_port = 5672</td>
+ <td>(IntOpt) Qpid broker port.</td>
+ </tr>
+ <tr>
+ <td>qpid_protocol = tcp</td>
+ <td>(StrOpt) Transport to use, either 'tcp' or 'ssl'.</td>
+ </tr>
+ <tr>
+ <td>qpid_sasl_mechanisms = </td>
+ <td>(StrOpt) Space separated list of SASL mechanisms to use for auth.</td>
+ </tr>
+ <tr>
+ <td>qpid_tcp_nodelay = True</td>
+ <td>(BoolOpt) Whether to disable the Nagle algorithm.</td>
+ </tr>
+ <tr>
+ <td>qpid_topology_version = 1</td>
+ <td>(IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.</td>
+ </tr>
+ <tr>
+ <td>qpid_username = </td>
+ <td>(StrOpt) Username for Qpid connection.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-quotas.xml b/doc/common/tables/neutron-quotas.xml
index ae213706f9..a6e5a4b8e8 100644
--- a/doc/common/tables/neutron-quotas.xml
+++ b/doc/common/tables/neutron-quotas.xml
@@ -1,106 +1,105 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_quotas">
- <caption>Description of configuration options for quotas</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>max_routes = 30</td>
- <td>(IntOpt) Maximum number of routes</td>
- </tr>
- <tr>
- <th colspan="2">[QUOTAS]</th>
- </tr>
- <tr>
- <td>default_quota = -1</td>
- <td>(IntOpt) Default number of resource allowed per tenant. A negative value means unlimited.</td>
- </tr>
- <tr>
- <td>quota_driver = neutron.db.quota_db.DbQuotaDriver</td>
- <td>(StrOpt) Default driver to use for quota checks</td>
- </tr>
- <tr>
- <td>quota_firewall = 1</td>
- <td>(IntOpt) Number of firewalls allowed per tenant. A negative value means unlimited.</td>
- </tr>
- <tr>
- <td>quota_firewall_policy = 1</td>
- <td>(IntOpt) Number of firewall policies allowed per tenant. A negative value means unlimited.</td>
- </tr>
- <tr>
- <td>quota_firewall_rule = -1</td>
- <td>(IntOpt) Number of firewall rules allowed per tenant. A negative value means unlimited.</td>
- </tr>
- <tr>
- <td>quota_floatingip = 50</td>
- <td>(IntOpt) Number of floating IPs allowed per tenant. A negative value means unlimited.</td>
- </tr>
- <tr>
- <td>quota_health_monitor = -1</td>
- <td>(IntOpt) Number of health monitors allowed per tenant. A negative value means unlimited.</td>
- </tr>
- <tr>
- <td>quota_items = network, subnet, port</td>
- <td>(ListOpt) Resource name(s) that are supported in quota features</td>
- </tr>
- <tr>
- <td>quota_member = -1</td>
- <td>(IntOpt) Number of pool members allowed per tenant. A negative value means unlimited.</td>
- </tr>
- <tr>
- <td>quota_network = 10</td>
- <td>(IntOpt) Number of networks allowed per tenant.A negative value means unlimited.</td>
- </tr>
- <tr>
- <td>quota_network_gateway = 5</td>
- <td>(IntOpt) Number of network gateways allowed per tenant, -1 for unlimited</td>
- </tr>
- <tr>
- <td>quota_packet_filter = 100</td>
- <td>(IntOpt) Number of packet_filters allowed per tenant, -1 for unlimited</td>
- </tr>
- <tr>
- <td>quota_pool = 10</td>
- <td>(IntOpt) Number of pools allowed per tenant. A negative value means unlimited.</td>
- </tr>
- <tr>
- <td>quota_port = 50</td>
- <td>(IntOpt) Number of ports allowed per tenant. A negative value means unlimited.</td>
- </tr>
- <tr>
- <td>quota_router = 10</td>
- <td>(IntOpt) Number of routers allowed per tenant. A negative value means unlimited.</td>
- </tr>
- <tr>
- <td>quota_security_group = 10</td>
- <td>(IntOpt) Number of security groups allowed per tenant. A negative value means unlimited.</td>
- </tr>
- <tr>
- <td>quota_security_group_rule = 100</td>
- <td>(IntOpt) Number of security rules allowed per tenant. A negative value means unlimited.</td>
- </tr>
- <tr>
- <td>quota_subnet = 10</td>
- <td>(IntOpt) Number of subnets allowed per tenant, A negative value means unlimited.</td>
- </tr>
- <tr>
- <td>quota_vip = 10</td>
- <td>(IntOpt) Number of vips allowed per tenant. A negative value means unlimited.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_quotas">
+ <caption>Description of configuration options for quotas</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>max_routes = 30</td>
+ <td>(IntOpt) Maximum number of routes</td>
+ </tr>
+ <tr>
+ <th colspan="2">[QUOTAS]</th>
+ </tr>
+ <tr>
+ <td>default_quota = -1</td>
+ <td>(IntOpt) Default number of resource allowed per tenant. A negative value means unlimited.</td>
+ </tr>
+ <tr>
+ <td>quota_driver = neutron.db.quota_db.DbQuotaDriver</td>
+ <td>(StrOpt) Default driver to use for quota checks</td>
+ </tr>
+ <tr>
+ <td>quota_firewall = 1</td>
+ <td>(IntOpt) Number of firewalls allowed per tenant. A negative value means unlimited.</td>
+ </tr>
+ <tr>
+ <td>quota_firewall_policy = 1</td>
+ <td>(IntOpt) Number of firewall policies allowed per tenant. A negative value means unlimited.</td>
+ </tr>
+ <tr>
+ <td>quota_firewall_rule = -1</td>
+ <td>(IntOpt) Number of firewall rules allowed per tenant. A negative value means unlimited.</td>
+ </tr>
+ <tr>
+ <td>quota_floatingip = 50</td>
+ <td>(IntOpt) Number of floating IPs allowed per tenant. A negative value means unlimited.</td>
+ </tr>
+ <tr>
+ <td>quota_health_monitor = -1</td>
+ <td>(IntOpt) Number of health monitors allowed per tenant. A negative value means unlimited.</td>
+ </tr>
+ <tr>
+ <td>quota_items = network, subnet, port</td>
+ <td>(ListOpt) Resource name(s) that are supported in quota features</td>
+ </tr>
+ <tr>
+ <td>quota_member = -1</td>
+ <td>(IntOpt) Number of pool members allowed per tenant. A negative value means unlimited.</td>
+ </tr>
+ <tr>
+ <td>quota_network = 10</td>
+ <td>(IntOpt) Number of networks allowed per tenant.A negative value means unlimited.</td>
+ </tr>
+ <tr>
+ <td>quota_network_gateway = 5</td>
+ <td>(IntOpt) Number of network gateways allowed per tenant, -1 for unlimited</td>
+ </tr>
+ <tr>
+ <td>quota_packet_filter = 100</td>
+ <td>(IntOpt) Number of packet_filters allowed per tenant, -1 for unlimited</td>
+ </tr>
+ <tr>
+ <td>quota_pool = 10</td>
+ <td>(IntOpt) Number of pools allowed per tenant. A negative value means unlimited.</td>
+ </tr>
+ <tr>
+ <td>quota_port = 50</td>
+ <td>(IntOpt) Number of ports allowed per tenant. A negative value means unlimited.</td>
+ </tr>
+ <tr>
+ <td>quota_router = 10</td>
+ <td>(IntOpt) Number of routers allowed per tenant. A negative value means unlimited.</td>
+ </tr>
+ <tr>
+ <td>quota_security_group = 10</td>
+ <td>(IntOpt) Number of security groups allowed per tenant. A negative value means unlimited.</td>
+ </tr>
+ <tr>
+ <td>quota_security_group_rule = 100</td>
+ <td>(IntOpt) Number of security rules allowed per tenant. A negative value means unlimited.</td>
+ </tr>
+ <tr>
+ <td>quota_subnet = 10</td>
+ <td>(IntOpt) Number of subnets allowed per tenant, A negative value means unlimited.</td>
+ </tr>
+ <tr>
+ <td>quota_vip = 10</td>
+ <td>(IntOpt) Number of vips allowed per tenant. A negative value means unlimited.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-rabbitmq.xml b/doc/common/tables/neutron-rabbitmq.xml
index c6261f34d4..925137b352 100644
--- a/doc/common/tables/neutron-rabbitmq.xml
+++ b/doc/common/tables/neutron-rabbitmq.xml
@@ -1,67 +1,90 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_rabbitmq">
- <caption>Description of configuration options for rabbitmq</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>rabbit_ha_queues = False</td>
- <td>(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database.</td>
- </tr>
- <tr>
- <td>rabbit_host = localhost</td>
- <td>(StrOpt) The RabbitMQ broker address where a single node is used</td>
- </tr>
- <tr>
- <td>rabbit_hosts = $rabbit_host:$rabbit_port</td>
- <td>(ListOpt) RabbitMQ HA cluster host:port pairs</td>
- </tr>
- <tr>
- <td>rabbit_max_retries = 0</td>
- <td>(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count)</td>
- </tr>
- <tr>
- <td>rabbit_password = guest</td>
- <td>(StrOpt) The RabbitMQ password</td>
- </tr>
- <tr>
- <td>rabbit_port = 5672</td>
- <td>(IntOpt) The RabbitMQ broker port where a single node is used</td>
- </tr>
- <tr>
- <td>rabbit_retry_backoff = 2</td>
- <td>(IntOpt) How long to backoff for between retries when connecting to RabbitMQ</td>
- </tr>
- <tr>
- <td>rabbit_retry_interval = 1</td>
- <td>(IntOpt) How frequently to retry connecting with RabbitMQ</td>
- </tr>
- <tr>
- <td>rabbit_use_ssl = False</td>
- <td>(BoolOpt) Connect over SSL for RabbitMQ</td>
- </tr>
- <tr>
- <td>rabbit_userid = guest</td>
- <td>(StrOpt) The RabbitMQ userid</td>
- </tr>
- <tr>
- <td>rabbit_virtual_host = /</td>
- <td>(StrOpt) The RabbitMQ virtual host</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_rabbitmq">
+ <caption>Description of configuration options for rabbitmq</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>kombu_reconnect_delay = 1.0</td>
+ <td>(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.</td>
+ </tr>
+ <tr>
+ <td>kombu_ssl_ca_certs = </td>
+ <td>(StrOpt) SSL certification authority file (valid only if SSL enabled).</td>
+ </tr>
+ <tr>
+ <td>kombu_ssl_certfile = </td>
+ <td>(StrOpt) SSL cert file (valid only if SSL enabled).</td>
+ </tr>
+ <tr>
+ <td>kombu_ssl_keyfile = </td>
+ <td>(StrOpt) SSL key file (valid only if SSL enabled).</td>
+ </tr>
+ <tr>
+ <td>kombu_ssl_version = </td>
+ <td>(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions.</td>
+ </tr>
+ <tr>
+ <td>rabbit_ha_queues = False</td>
+ <td>(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database.</td>
+ </tr>
+ <tr>
+ <td>rabbit_host = localhost</td>
+ <td>(StrOpt) The RabbitMQ broker address where a single node is used.</td>
+ </tr>
+ <tr>
+ <td>rabbit_hosts = $rabbit_host:$rabbit_port</td>
+ <td>(ListOpt) RabbitMQ HA cluster host:port pairs.</td>
+ </tr>
+ <tr>
+ <td>rabbit_login_method = AMQPLAIN</td>
+ <td>(StrOpt) the RabbitMQ login method</td>
+ </tr>
+ <tr>
+ <td>rabbit_max_retries = 0</td>
+ <td>(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).</td>
+ </tr>
+ <tr>
+ <td>rabbit_password = guest</td>
+ <td>(StrOpt) The RabbitMQ password.</td>
+ </tr>
+ <tr>
+ <td>rabbit_port = 5672</td>
+ <td>(IntOpt) The RabbitMQ broker port where a single node is used.</td>
+ </tr>
+ <tr>
+ <td>rabbit_retry_backoff = 2</td>
+ <td>(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.</td>
+ </tr>
+ <tr>
+ <td>rabbit_retry_interval = 1</td>
+ <td>(IntOpt) How frequently to retry connecting with RabbitMQ.</td>
+ </tr>
+ <tr>
+ <td>rabbit_use_ssl = False</td>
+ <td>(BoolOpt) Connect over SSL for RabbitMQ.</td>
+ </tr>
+ <tr>
+ <td>rabbit_userid = guest</td>
+ <td>(StrOpt) The RabbitMQ userid.</td>
+ </tr>
+ <tr>
+ <td>rabbit_virtual_host = /</td>
+ <td>(StrOpt) The RabbitMQ virtual host.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-redis.xml b/doc/common/tables/neutron-redis.xml
index 6ffe69a42c..94866adb1a 100644
--- a/doc/common/tables/neutron-redis.xml
+++ b/doc/common/tables/neutron-redis.xml
@@ -1,42 +1,26 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_redis">
- <caption>Description of configuration options for redis</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>host = oslo</td>
- <td>(StrOpt) The hostname Neutron is running on</td>
- </tr>
- <tr>
- <th colspan="2">[matchmaker_redis]</th>
- </tr>
- <tr>
- <td>host = 127.0.0.1</td>
- <td>(StrOpt) Host to locate redis</td>
- </tr>
- <tr>
- <td>password = None</td>
- <td>(StrOpt) Password for Redis server. (optional)</td>
- </tr>
- <tr>
- <td>port = 6379</td>
- <td>(IntOpt) Use this port to connect to redis host.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_redis">
+ <caption>Description of configuration options for redis</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>host = oslo</td>
+ <td>(StrOpt) The hostname Neutron is running on</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-rootwrap.xml b/doc/common/tables/neutron-rootwrap.xml
index ab7712383b..2dfbe7ad35 100644
--- a/doc/common/tables/neutron-rootwrap.xml
+++ b/doc/common/tables/neutron-rootwrap.xml
@@ -1,58 +1,57 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_rootwrap">
- <caption>Description of configuration options for rootwrap</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>filters_path = /etc/neutron/rootwrap.d,/usr/share/neutron/rootwrap,/etc/quantum/rootwrap.d,/usr/share/quantum/rootwrap</td>
- <td>List of directories to load filter definitions from (separated by ','). These directories MUST all be only writeable by root !</td>
- </tr>
- <tr>
- <td>exec_dirs = /sbin,/usr/sbin,/bin,/usr/bin</td>
- <td>List of directories to search executables in, in case filters do not explicitely specify a full path (separated by ',') If not specified, defaults to system PATH environment variable. These directories MUST all be only writeable by root !</td>
- </tr>
- <tr>
- <td>use_syslog = False</td>
- <td>Enable logging to syslog Default value is False</td>
- </tr>
- <tr>
- <td>syslog_log_facility = syslog</td>
- <td>Which syslog facility to use. Valid values include auth, authpriv, syslog, local0, local1... Default value is 'syslog'</td>
- </tr>
- <tr>
- <td>syslog_log_level = ERROR</td>
- <td>Which messages to log. INFO means log all usage ERROR means only log unsuccessful attempts</td>
- </tr>
- <tr>
- <th colspan="2">[xenapi]</th>
- </tr>
- <tr>
- <td>xenapi_connection_url = <None></td>
- <td>XenAPI configuration is only required by the L2 agent if it is to target a XenServer/XCP compute host's dom0.</td>
- </tr>
- <tr>
- <td>xenapi_connection_username = root</td>
- <td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>xenapi_connection_password = <None></td>
- <td>No help text available for this option.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_rootwrap">
+ <caption>Description of configuration options for rootwrap</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>filters_path = /etc/neutron/rootwrap.d,/usr/share/neutron/rootwrap</td>
+ <td>List of directories to load filter definitions from (separated by ','). These directories MUST all be only writeable by root !</td>
+ </tr>
+ <tr>
+ <td>exec_dirs = /sbin,/usr/sbin,/bin,/usr/bin</td>
+ <td>List of directories to search executables in, in case filters do not explicitely specify a full path (separated by ',') If not specified, defaults to system PATH environment variable. These directories MUST all be only writeable by root !</td>
+ </tr>
+ <tr>
+ <td>use_syslog = False</td>
+ <td>Enable logging to syslog Default value is False</td>
+ </tr>
+ <tr>
+ <td>syslog_log_facility = syslog</td>
+ <td>Which syslog facility to use. Valid values include auth, authpriv, syslog, local0, local1... Default value is 'syslog'</td>
+ </tr>
+ <tr>
+ <td>syslog_log_level = ERROR</td>
+ <td>Which messages to log. INFO means log all usage ERROR means only log unsuccessful attempts</td>
+ </tr>
+ <tr>
+ <th colspan="2">[xenapi]</th>
+ </tr>
+ <tr>
+ <td>xenapi_connection_url = <None></td>
+ <td>XenAPI configuration is only required by the L2 agent if it is to target a XenServer/XCP compute host's dom0.</td>
+ </tr>
+ <tr>
+ <td>xenapi_connection_username = root</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>xenapi_connection_password = <None></td>
+ <td>No help text available for this option.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-rpc.xml b/doc/common/tables/neutron-rpc.xml
index 4f2cdfffcd..5d239c23d8 100644
--- a/doc/common/tables/neutron-rpc.xml
+++ b/doc/common/tables/neutron-rpc.xml
@@ -1,88 +1,92 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_rpc">
- <caption>Description of configuration options for rpc</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>amqp_auto_delete = False</td>
- <td>(BoolOpt) Auto-delete queues in amqp.</td>
- </tr>
- <tr>
- <td>amqp_durable_queues = False</td>
- <td>(BoolOpt) Use durable queues in amqp.</td>
- </tr>
- <tr>
- <td>control_exchange = neutron</td>
- <td>(StrOpt) AMQP exchange to connect to if using RabbitMQ or Qpid</td>
- </tr>
- <tr>
- <td>matchmaker_heartbeat_freq = 300</td>
- <td>(IntOpt) Heartbeat frequency</td>
- </tr>
- <tr>
- <td>matchmaker_heartbeat_ttl = 600</td>
- <td>(IntOpt) Heartbeat time-to-live.</td>
- </tr>
- <tr>
- <td>rpc_backend = neutron.openstack.common.rpc.impl_kombu</td>
- <td>(StrOpt) The messaging module to use, defaults to kombu.</td>
- </tr>
- <tr>
- <td>rpc_cast_timeout = 30</td>
- <td>(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq.</td>
- </tr>
- <tr>
- <td>rpc_conn_pool_size = 30</td>
- <td>(IntOpt) Size of RPC connection pool</td>
- </tr>
- <tr>
- <td>rpc_response_timeout = 60</td>
- <td>(IntOpt) Seconds to wait for a response from call or multicall</td>
- </tr>
- <tr>
- <td>rpc_thread_pool_size = 64</td>
- <td>(IntOpt) Size of RPC thread pool</td>
- </tr>
- <tr>
- <td>rpc_workers = 0</td>
- <td>(IntOpt) Number of RPC worker processes for service</td>
- </tr>
- <tr>
- <th colspan="2">[AGENT]</th>
- </tr>
- <tr>
- <td>rpc_support_old_agents = False</td>
- <td>(BoolOpt) Enable server RPC compatibility with old agents</td>
- </tr>
- <tr>
- <th colspan="2">[matchmaker_ring]</th>
- </tr>
- <tr>
- <td>ringfile = /etc/oslo/matchmaker_ring.json</td>
- <td>(StrOpt) Matchmaker ring file (JSON)</td>
- </tr>
- <tr>
- <th colspan="2">[rpc_notifier2]</th>
- </tr>
- <tr>
- <td>topics = notifications</td>
- <td>(ListOpt) AMQP topic(s) used for openstack notifications</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_rpc">
+ <caption>Description of configuration options for rpc</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>amqp_auto_delete = False</td>
+ <td>(BoolOpt) Auto-delete queues in amqp.</td>
+ </tr>
+ <tr>
+ <td>amqp_durable_queues = False</td>
+ <td>(BoolOpt) Use durable queues in amqp.</td>
+ </tr>
+ <tr>
+ <td>control_exchange = openstack</td>
+ <td>(StrOpt) AMQP exchange to connect to if using RabbitMQ or Qpid</td>
+ </tr>
+ <tr>
+ <td>matchmaker_heartbeat_freq = 300</td>
+ <td>(IntOpt) Heartbeat frequency.</td>
+ </tr>
+ <tr>
+ <td>matchmaker_heartbeat_ttl = 600</td>
+ <td>(IntOpt) Heartbeat time-to-live.</td>
+ </tr>
+ <tr>
+ <td>password = None</td>
+ <td>(StrOpt) Password for Redis server (optional).</td>
+ </tr>
+ <tr>
+ <td>port = 6379</td>
+ <td>(IntOpt) Use this port to connect to redis host.</td>
+ </tr>
+ <tr>
+ <td>rpc_backend = neutron.openstack.common.rpc.impl_kombu</td>
+ <td>(StrOpt) The messaging module to use, defaults to kombu.</td>
+ </tr>
+ <tr>
+ <td>rpc_cast_timeout = 30</td>
+ <td>(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq.</td>
+ </tr>
+ <tr>
+ <td>rpc_conn_pool_size = 30</td>
+ <td>(IntOpt) Size of RPC connection pool</td>
+ </tr>
+ <tr>
+ <td>rpc_response_timeout = 60</td>
+ <td>(IntOpt) Seconds to wait for a response from call or multicall</td>
+ </tr>
+ <tr>
+ <td>rpc_thread_pool_size = 64</td>
+ <td>(IntOpt) Size of RPC thread pool</td>
+ </tr>
+ <tr>
+ <td>rpc_workers = 0</td>
+ <td>(IntOpt) Number of RPC worker processes for service</td>
+ </tr>
+ <tr>
+ <td>transport_url = None</td>
+ <td>(StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[AGENT]</th>
+ </tr>
+ <tr>
+ <td>rpc_support_old_agents = False</td>
+ <td>(BoolOpt) Enable server RPC compatibility with old agents</td>
+ </tr>
+ <tr>
+ <th colspan="2">[matchmaker_ring]</th>
+ </tr>
+ <tr>
+ <td>ringfile = /etc/oslo/matchmaker_ring.json</td>
+ <td>(StrOpt) Matchmaker ring file (JSON).</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-ryu.xml b/doc/common/tables/neutron-ryu.xml
index 3287e229c7..01e4910dea 100644
--- a/doc/common/tables/neutron-ryu.xml
+++ b/doc/common/tables/neutron-ryu.xml
@@ -1,55 +1,54 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_ryu">
- <caption>Description of configuration options for ryu</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">[OVS]</th>
- </tr>
- <tr>
- <td>openflow_rest_api = 127.0.0.1:8080</td>
- <td>(StrOpt) OpenFlow REST API location</td>
- </tr>
- <tr>
- <td>ovsdb_interface = None</td>
- <td>(StrOpt) OVSDB interface to connect to</td>
- </tr>
- <tr>
- <td>ovsdb_ip = None</td>
- <td>(StrOpt) OVSDB IP to connect to</td>
- </tr>
- <tr>
- <td>ovsdb_port = 6634</td>
- <td>(IntOpt) OVSDB port to connect to</td>
- </tr>
- <tr>
- <td>tunnel_interface = None</td>
- <td>(StrOpt) Tunnel interface to use</td>
- </tr>
- <tr>
- <td>tunnel_ip = None</td>
- <td>(StrOpt) Tunnel IP to use</td>
- </tr>
- <tr>
- <td>tunnel_key_max = 16777215</td>
- <td>(IntOpt) Maximum tunnel ID to use</td>
- </tr>
- <tr>
- <td>tunnel_key_min = 1</td>
- <td>(IntOpt) Minimum tunnel ID to use</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_ryu">
+ <caption>Description of configuration options for ryu</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">[OVS]</th>
+ </tr>
+ <tr>
+ <td>openflow_rest_api = 127.0.0.1:8080</td>
+ <td>(StrOpt) OpenFlow REST API location</td>
+ </tr>
+ <tr>
+ <td>ovsdb_interface = None</td>
+ <td>(StrOpt) OVSDB interface to connect to</td>
+ </tr>
+ <tr>
+ <td>ovsdb_ip = None</td>
+ <td>(StrOpt) OVSDB IP to connect to</td>
+ </tr>
+ <tr>
+ <td>ovsdb_port = 6634</td>
+ <td>(IntOpt) OVSDB port to connect to</td>
+ </tr>
+ <tr>
+ <td>tunnel_interface = None</td>
+ <td>(StrOpt) Tunnel interface to use</td>
+ </tr>
+ <tr>
+ <td>tunnel_ip = None</td>
+ <td>(StrOpt) Tunnel IP to use</td>
+ </tr>
+ <tr>
+ <td>tunnel_key_max = 16777215</td>
+ <td>(IntOpt) Maximum tunnel ID to use</td>
+ </tr>
+ <tr>
+ <td>tunnel_key_min = 1</td>
+ <td>(IntOpt) Minimum tunnel ID to use</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-scheduler.xml b/doc/common/tables/neutron-scheduler.xml
index e937143b70..1648900ba9 100644
--- a/doc/common/tables/neutron-scheduler.xml
+++ b/doc/common/tables/neutron-scheduler.xml
@@ -1,43 +1,42 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_scheduler">
- <caption>Description of configuration options for scheduler</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>network_auto_schedule = True</td>
- <td>(BoolOpt) Allow auto scheduling networks to DHCP agent.</td>
- </tr>
- <tr>
- <td>network_scheduler_driver = neutron.scheduler.dhcp_agent_scheduler.ChanceScheduler</td>
- <td>(StrOpt) Driver to use for scheduling network to DHCP agent</td>
- </tr>
- <tr>
- <td>router_auto_schedule = True</td>
- <td>(BoolOpt) Allow auto scheduling of routers to L3 agent.</td>
- </tr>
- <tr>
- <td>router_delete_namespaces = False</td>
- <td>(BoolOpt) Delete namespace after removing a router.</td>
- </tr>
- <tr>
- <td>router_scheduler_driver = neutron.scheduler.l3_agent_scheduler.ChanceScheduler</td>
- <td>(StrOpt) Driver to use for scheduling router to a default L3 agent</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_scheduler">
+ <caption>Description of configuration options for scheduler</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>network_auto_schedule = True</td>
+ <td>(BoolOpt) Allow auto scheduling networks to DHCP agent.</td>
+ </tr>
+ <tr>
+ <td>network_scheduler_driver = neutron.scheduler.dhcp_agent_scheduler.ChanceScheduler</td>
+ <td>(StrOpt) Driver to use for scheduling network to DHCP agent</td>
+ </tr>
+ <tr>
+ <td>router_auto_schedule = True</td>
+ <td>(BoolOpt) Allow auto scheduling of routers to L3 agent.</td>
+ </tr>
+ <tr>
+ <td>router_delete_namespaces = False</td>
+ <td>(BoolOpt) Delete namespace after removing a router.</td>
+ </tr>
+ <tr>
+ <td>router_scheduler_driver = neutron.scheduler.l3_agent_scheduler.ChanceScheduler</td>
+ <td>(StrOpt) Driver to use for scheduling router to a default L3 agent</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-sdnve.xml b/doc/common/tables/neutron-sdnve.xml
index fb911c5cb6..435265238f 100644
--- a/doc/common/tables/neutron-sdnve.xml
+++ b/doc/common/tables/neutron-sdnve.xml
@@ -1,98 +1,97 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_sdnve">
- <caption>Description of configuration options for sdnve</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">[SDNVE]</th>
- </tr>
- <tr>
- <td>base_url = /one/nb/v2/</td>
- <td>(StrOpt) Base URL for SDN-VE controller REST API</td>
- </tr>
- <tr>
- <td>controller_ips = 127.0.0.1</td>
- <td>(ListOpt) List of IP addresses of SDN-VE controller(s)</td>
- </tr>
- <tr>
- <td>default_tenant_type = OF</td>
- <td>(StrOpt) Tenant type: OF (default) and OVERLAY</td>
- </tr>
- <tr>
- <td>format = json</td>
- <td>(StrOpt) SDN-VE request/response format</td>
- </tr>
- <tr>
- <td>info = sdnve_info_string</td>
- <td>(StrOpt) SDN-VE RPC subject</td>
- </tr>
- <tr>
- <td>integration_bridge = None</td>
- <td>(StrOpt) Integration bridge to use</td>
- </tr>
- <tr>
- <td>interface_mappings = </td>
- <td>(ListOpt) List of <physical_network_name>:<interface_name></td>
- </tr>
- <tr>
- <td>of_signature = SDNVE-OF</td>
- <td>(StrOpt) The string in tenant description that indicates the tenant is a OF tenant</td>
- </tr>
- <tr>
- <td>out_of_band = True</td>
- <td>(BoolOpt) Indicating if controller is out of band or not</td>
- </tr>
- <tr>
- <td>overlay_signature = SDNVE-OVERLAY</td>
- <td>(StrOpt) The string in tenant description that indicates the tenant is a OVERLAY tenant</td>
- </tr>
- <tr>
- <td>password = admin</td>
- <td>(StrOpt) SDN-VE administrator password</td>
- </tr>
- <tr>
- <td>port = 8443</td>
- <td>(StrOpt) SDN-VE controller port number</td>
- </tr>
- <tr>
- <td>reset_bridge = True</td>
- <td>(BoolOpt) Reset the integration bridge before use</td>
- </tr>
- <tr>
- <td>use_fake_controller = False</td>
- <td>(BoolOpt) If set to True uses a fake controller.</td>
- </tr>
- <tr>
- <td>userid = admin</td>
- <td>(StrOpt) SDN-VE administrator user id</td>
- </tr>
- <tr>
- <th colspan="2">[SDNVE_AGENT]</th>
- </tr>
- <tr>
- <td>polling_interval = 2</td>
- <td>(IntOpt) Agent polling interval if necessary</td>
- </tr>
- <tr>
- <td>root_helper = sudo</td>
- <td>(StrOpt) Using root helper</td>
- </tr>
- <tr>
- <td>rpc = True</td>
- <td>(BoolOpt) Whether using rpc</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_sdnve">
+ <caption>Description of configuration options for sdnve</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">[SDNVE]</th>
+ </tr>
+ <tr>
+ <td>base_url = /one/nb/v2/</td>
+ <td>(StrOpt) Base URL for SDN-VE controller REST API</td>
+ </tr>
+ <tr>
+ <td>controller_ips = 127.0.0.1</td>
+ <td>(ListOpt) List of IP addresses of SDN-VE controller(s)</td>
+ </tr>
+ <tr>
+ <td>default_tenant_type = OVERLAY</td>
+ <td>(StrOpt) Tenant type: OVERLAY (default) or OF</td>
+ </tr>
+ <tr>
+ <td>format = json</td>
+ <td>(StrOpt) SDN-VE request/response format</td>
+ </tr>
+ <tr>
+ <td>info = sdnve_info_string</td>
+ <td>(StrOpt) SDN-VE RPC subject</td>
+ </tr>
+ <tr>
+ <td>integration_bridge = None</td>
+ <td>(StrOpt) Integration bridge to use</td>
+ </tr>
+ <tr>
+ <td>interface_mappings = </td>
+ <td>(ListOpt) List of <physical_network_name>:<interface_name></td>
+ </tr>
+ <tr>
+ <td>of_signature = SDNVE-OF</td>
+ <td>(StrOpt) The string in tenant description that indicates the tenant is a OF tenant</td>
+ </tr>
+ <tr>
+ <td>out_of_band = True</td>
+ <td>(BoolOpt) Indicating if controller is out of band or not</td>
+ </tr>
+ <tr>
+ <td>overlay_signature = SDNVE-OVERLAY</td>
+ <td>(StrOpt) The string in tenant description that indicates the tenant is a OVERLAY tenant</td>
+ </tr>
+ <tr>
+ <td>password = admin</td>
+ <td>(StrOpt) SDN-VE administrator password</td>
+ </tr>
+ <tr>
+ <td>port = 8443</td>
+ <td>(StrOpt) SDN-VE controller port number</td>
+ </tr>
+ <tr>
+ <td>reset_bridge = True</td>
+ <td>(BoolOpt) Reset the integration bridge before use</td>
+ </tr>
+ <tr>
+ <td>use_fake_controller = False</td>
+ <td>(BoolOpt) If set to True uses a fake controller.</td>
+ </tr>
+ <tr>
+ <td>userid = admin</td>
+ <td>(StrOpt) SDN-VE administrator user id</td>
+ </tr>
+ <tr>
+ <th colspan="2">[SDNVE_AGENT]</th>
+ </tr>
+ <tr>
+ <td>polling_interval = 2</td>
+ <td>(IntOpt) Agent polling interval if necessary</td>
+ </tr>
+ <tr>
+ <td>root_helper = sudo</td>
+ <td>(StrOpt) Using root helper</td>
+ </tr>
+ <tr>
+ <td>rpc = True</td>
+ <td>(BoolOpt) Whether using rpc</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-securitygroups.xml b/doc/common/tables/neutron-securitygroups.xml
index dbbde91436..cf7407309f 100644
--- a/doc/common/tables/neutron-securitygroups.xml
+++ b/doc/common/tables/neutron-securitygroups.xml
@@ -1,31 +1,30 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_securitygroups">
- <caption>Description of configuration options for securitygroups</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">[SECURITYGROUP]</th>
- </tr>
- <tr>
- <td>enable_security_group = True</td>
- <td>(BoolOpt) Controls whether the neutron security group API is enabled in the server. It should be false when using no security groups or using the nova security group API.</td>
- </tr>
- <tr>
- <td>firewall_driver = None</td>
- <td>(StrOpt) Driver for security groups firewall in the L2 agent</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_securitygroups">
+ <caption>Description of configuration options for securitygroups</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">[SECURITYGROUP]</th>
+ </tr>
+ <tr>
+ <td>enable_security_group = True</td>
+ <td>(BoolOpt) Controls whether the neutron security group API is enabled in the server. It should be false when using no security groups or using the nova security group API.</td>
+ </tr>
+ <tr>
+ <td>firewall_driver = None</td>
+ <td>(StrOpt) Driver for security groups firewall in the L2 agent</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-ssl.xml b/doc/common/tables/neutron-ssl.xml
index 9a36f47d3d..9ea48a20b1 100644
--- a/doc/common/tables/neutron-ssl.xml
+++ b/doc/common/tables/neutron-ssl.xml
@@ -1,50 +1,49 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_ssl">
- <caption>Description of configuration options for ssl</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>ssl_ca_file = None</td>
- <td>(StrOpt) CA certificate file to use to verify connecting clients</td>
- </tr>
- <tr>
- <td>ssl_cert_file = None</td>
- <td>(StrOpt) Certificate file to use when starting the server securely</td>
- </tr>
- <tr>
- <td>ssl_key_file = None</td>
- <td>(StrOpt) Private key file to use when starting the server securely</td>
- </tr>
- <tr>
- <th colspan="2">[ssl]</th>
- </tr>
- <tr>
- <td>ca_file = None</td>
- <td>(StrOpt) CA certificate file to use to verify connecting clients</td>
- </tr>
- <tr>
- <td>cert_file = None</td>
- <td>(StrOpt) Certificate file to use when starting the server securely</td>
- </tr>
- <tr>
- <td>key_file = None</td>
- <td>(StrOpt) Private key file to use when starting the server securely</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_ssl">
+ <caption>Description of configuration options for ssl</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>ssl_ca_file = None</td>
+ <td>(StrOpt) CA certificate file to use to verify connecting clients</td>
+ </tr>
+ <tr>
+ <td>ssl_cert_file = None</td>
+ <td>(StrOpt) Certificate file to use when starting the server securely</td>
+ </tr>
+ <tr>
+ <td>ssl_key_file = None</td>
+ <td>(StrOpt) Private key file to use when starting the server securely</td>
+ </tr>
+ <tr>
+ <th colspan="2">[ssl]</th>
+ </tr>
+ <tr>
+ <td>ca_file = None</td>
+ <td>(StrOpt) CA certificate file to use to verify connecting clients</td>
+ </tr>
+ <tr>
+ <td>cert_file = None</td>
+ <td>(StrOpt) Certificate file to use when starting the server securely</td>
+ </tr>
+ <tr>
+ <td>key_file = None</td>
+ <td>(StrOpt) Private key file to use when starting the server securely</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-testing.xml b/doc/common/tables/neutron-testing.xml
index 14725d4f13..e04199a8a8 100644
--- a/doc/common/tables/neutron-testing.xml
+++ b/doc/common/tables/neutron-testing.xml
@@ -1,31 +1,30 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_testing">
- <caption>Description of configuration options for testing</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>backdoor_port = None</td>
- <td>(StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.</td>
- </tr>
- <tr>
- <td>fake_rabbit = False</td>
- <td>(BoolOpt) If passed, use a fake RabbitMQ provider</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_testing">
+ <caption>Description of configuration options for testing</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>backdoor_port = None</td>
+ <td>(StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.</td>
+ </tr>
+ <tr>
+ <td>fake_rabbit = False</td>
+ <td>(BoolOpt) If passed, use a fake RabbitMQ provider</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-varmour.xml b/doc/common/tables/neutron-varmour.xml
index 2df7145616..ac44b5006a 100644
--- a/doc/common/tables/neutron-varmour.xml
+++ b/doc/common/tables/neutron-varmour.xml
@@ -1,39 +1,38 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_varmour">
- <caption>Description of configuration options for varmour</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">[vArmour]</th>
- </tr>
- <tr>
- <td>director = localhost</td>
- <td>(StrOpt) vArmour director ip</td>
- </tr>
- <tr>
- <td>director_port = 443</td>
- <td>(StrOpt) vArmour director port</td>
- </tr>
- <tr>
- <td>password = varmour</td>
- <td>(StrOpt) vArmour director password</td>
- </tr>
- <tr>
- <td>username = varmour</td>
- <td>(StrOpt) vArmour director username</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_varmour">
+ <caption>Description of configuration options for varmour</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">[vArmour]</th>
+ </tr>
+ <tr>
+ <td>director = localhost</td>
+ <td>(StrOpt) vArmour director ip</td>
+ </tr>
+ <tr>
+ <td>director_port = 443</td>
+ <td>(StrOpt) vArmour director port</td>
+ </tr>
+ <tr>
+ <td>password = varmour</td>
+ <td>(StrOpt) vArmour director password</td>
+ </tr>
+ <tr>
+ <td>username = varmour</td>
+ <td>(StrOpt) vArmour director username</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-vmware.xml b/doc/common/tables/neutron-vmware.xml
index a9c292e9e4..0371e6cef4 100644
--- a/doc/common/tables/neutron-vmware.xml
+++ b/doc/common/tables/neutron-vmware.xml
@@ -1,212 +1,211 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_vmware">
- <caption>Description of configuration options for vmware</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>default_interface_name = breth0</td>
- <td>(StrOpt) Name of the interface on a L2 Gateway transport nodewhich should be used by default when setting up a network connection</td>
- </tr>
- <tr>
- <td>default_l2_gw_service_uuid = None</td>
- <td>(StrOpt) Unique identifier of the NSX L2 Gateway service which will be used by default for network gateways</td>
- </tr>
- <tr>
- <td>default_l3_gw_service_uuid = None</td>
- <td>(StrOpt) Unique identifier of the NSX L3 Gateway service which will be used for implementing routers and floating IPs</td>
- </tr>
- <tr>
- <td>default_service_cluster_uuid = None</td>
- <td>(StrOpt) Unique identifier of the Service Cluster which will be used by logical services like dhcp and metadata</td>
- </tr>
- <tr>
- <td>default_tz_uuid = None</td>
- <td>(StrOpt) This is uuid of the default NSX Transport zone that will be used for creating tunneled isolated "Neutron" networks. It needs to be created in NSX before starting Neutron with the nsx plugin.</td>
- </tr>
- <tr>
- <td>http_timeout = 10</td>
- <td>(IntOpt) Time before aborting a request</td>
- </tr>
- <tr>
- <td>nsx_controllers = None</td>
- <td>(ListOpt) Lists the NSX controllers in this cluster</td>
- </tr>
- <tr>
- <td>nsx_password = admin</td>
- <td>(StrOpt) Password for NSX controllers in this cluster</td>
- </tr>
- <tr>
- <td>nsx_user = admin</td>
- <td>(StrOpt) User name for NSX controllers in this cluster</td>
- </tr>
- <tr>
- <td>redirects = 2</td>
- <td>(IntOpt) Number of times a redirect should be followed</td>
- </tr>
- <tr>
- <td>req_timeout = 30</td>
- <td>(IntOpt) Total time limit for a cluster request</td>
- </tr>
- <tr>
- <td>retries = 2</td>
- <td>(IntOpt) Number of time a request should be retried</td>
- </tr>
- <tr>
- <th colspan="2">[ESWITCH]</th>
- </tr>
- <tr>
- <td>retries = 3</td>
- <td>(IntOpt) The number of retries the agent will send request to daemon before giving up</td>
- </tr>
- <tr>
- <th colspan="2">[NSX]</th>
- </tr>
- <tr>
- <td>agent_mode = agent</td>
- <td>(StrOpt) The mode used to implement DHCP/metadata services.</td>
- </tr>
- <tr>
- <td>concurrent_connections = 10</td>
- <td>(IntOpt) Maximum concurrent connections to each NSX controller.</td>
- </tr>
- <tr>
- <td>default_transport_type = stt</td>
- <td>(StrOpt) The default network tranport type to use (stt, gre, bridge, ipsec_gre, or ipsec_stt)</td>
- </tr>
- <tr>
- <td>max_lp_per_bridged_ls = 5000</td>
- <td>(IntOpt) Maximum number of ports of a logical switch on a bridged transport zone (default 5000)</td>
- </tr>
- <tr>
- <td>max_lp_per_overlay_ls = 256</td>
- <td>(IntOpt) Maximum number of ports of a logical switch on an overlay transport zone (default 256)</td>
- </tr>
- <tr>
- <td>metadata_mode = access_network</td>
- <td>(StrOpt) If set to access_network this enables a dedicated connection to the metadata proxy for metadata server access via Neutron router. If set to dhcp_host_route this enables host route injection via the dhcp agent. This option is only useful if running on a host that does not support namespaces otherwise access_network should be used.</td>
- </tr>
- <tr>
- <td>nsx_gen_timeout = -1</td>
- <td>(IntOpt) Number of seconds a generation id should be valid for (default -1 meaning do not time out)</td>
- </tr>
- <tr>
- <td>replication_mode = service</td>
- <td>(StrOpt) The default option leverages service nodes to perform packet replication though one could set to this to 'source' to perform replication locally. This is useful if one does not want to deploy a service node(s).</td>
- </tr>
- <tr>
- <th colspan="2">[NSX_DHCP]</th>
- </tr>
- <tr>
- <td>default_lease_time = 43200</td>
- <td>(IntOpt) Default DHCP lease time</td>
- </tr>
- <tr>
- <td>domain_name = openstacklocal</td>
- <td>(StrOpt) Domain to use for building the hostnames</td>
- </tr>
- <tr>
- <td>extra_domain_name_servers = </td>
- <td>(ListOpt) Comma separated list of additional domain name servers</td>
- </tr>
- <tr>
- <th colspan="2">[NSX_LSN]</th>
- </tr>
- <tr>
- <td>sync_on_missing_data = False</td>
- <td>(BoolOpt) Pull LSN information from NSX in case it is missing from the local data store. This is useful to rebuild the local store in case of server recovery.</td>
- </tr>
- <tr>
- <th colspan="2">[NSX_METADATA]</th>
- </tr>
- <tr>
- <td>metadata_server_address = 127.0.0.1</td>
- <td>(StrOpt) IP address used by Metadata server.</td>
- </tr>
- <tr>
- <td>metadata_server_port = 8775</td>
- <td>(IntOpt) TCP Port used by Metadata server.</td>
- </tr>
- <tr>
- <td>metadata_shared_secret = </td>
- <td>(StrOpt) Shared secret to sign instance-id request</td>
- </tr>
- <tr>
- <th colspan="2">[NSX_SYNC]</th>
- </tr>
- <tr>
- <td>always_read_status = False</td>
- <td>(BoolOpt) Always read operational status from backend on show operations. Enabling this option might slow down the system.</td>
- </tr>
- <tr>
- <td>max_random_sync_delay = 0</td>
- <td>(IntOpt) Maximum value for the additional random delay in seconds between runs of the state synchronization task</td>
- </tr>
- <tr>
- <td>min_chunk_size = 500</td>
- <td>(IntOpt) Minimum number of resources to be retrieved from NSX during state synchronization</td>
- </tr>
- <tr>
- <td>min_sync_req_delay = 1</td>
- <td>(IntOpt) Minimum delay, in seconds, between two state synchronization queries to NSX. It must not exceed state_sync_interval</td>
- </tr>
- <tr>
- <td>state_sync_interval = 10</td>
- <td>(IntOpt) Interval in seconds between runs of the state synchronization task. Set it to 0 to disable it</td>
- </tr>
- <tr>
- <th colspan="2">[vcns]</th>
- </tr>
- <tr>
- <td>datacenter_moid = None</td>
- <td>(StrOpt) Optional parameter identifying the ID of datacenter to deploy NSX Edges</td>
- </tr>
- <tr>
- <td>datastore_id = None</td>
- <td>(StrOpt) Optional parameter identifying the ID of datastore to deploy NSX Edges</td>
- </tr>
- <tr>
- <td>deployment_container_id = None</td>
- <td>(StrOpt) Optional parameter identifying the ID of datastore to deploy NSX Edges</td>
- </tr>
- <tr>
- <td>external_network = None</td>
- <td>(StrOpt) Network ID for physical network connectivity</td>
- </tr>
- <tr>
- <td>manager_uri = None</td>
- <td>(StrOpt) uri for vsm</td>
- </tr>
- <tr>
- <td>password = default</td>
- <td>(StrOpt) Password for vsm</td>
- </tr>
- <tr>
- <td>resource_pool_id = None</td>
- <td>(StrOpt) Optional parameter identifying the ID of resource to deploy NSX Edges</td>
- </tr>
- <tr>
- <td>task_status_check_interval = 2000</td>
- <td>(IntOpt) Task status check interval</td>
- </tr>
- <tr>
- <td>user = admin</td>
- <td>(StrOpt) User name for vsm</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_vmware">
+ <caption>Description of configuration options for vmware</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>default_interface_name = breth0</td>
+ <td>(StrOpt) Name of the interface on a L2 Gateway transport nodewhich should be used by default when setting up a network connection</td>
+ </tr>
+ <tr>
+ <td>default_l2_gw_service_uuid = None</td>
+ <td>(StrOpt) Unique identifier of the NSX L2 Gateway service which will be used by default for network gateways</td>
+ </tr>
+ <tr>
+ <td>default_l3_gw_service_uuid = None</td>
+ <td>(StrOpt) Unique identifier of the NSX L3 Gateway service which will be used for implementing routers and floating IPs</td>
+ </tr>
+ <tr>
+ <td>default_service_cluster_uuid = None</td>
+ <td>(StrOpt) Unique identifier of the Service Cluster which will be used by logical services like dhcp and metadata</td>
+ </tr>
+ <tr>
+ <td>default_tz_uuid = None</td>
+ <td>(StrOpt) This is uuid of the default NSX Transport zone that will be used for creating tunneled isolated "Neutron" networks. It needs to be created in NSX before starting Neutron with the nsx plugin.</td>
+ </tr>
+ <tr>
+ <td>http_timeout = 30</td>
+ <td>(IntOpt) Time before aborting a request</td>
+ </tr>
+ <tr>
+ <td>nsx_controllers = None</td>
+ <td>(ListOpt) Lists the NSX controllers in this cluster</td>
+ </tr>
+ <tr>
+ <td>nsx_password = admin</td>
+ <td>(StrOpt) Password for NSX controllers in this cluster</td>
+ </tr>
+ <tr>
+ <td>nsx_user = admin</td>
+ <td>(StrOpt) User name for NSX controllers in this cluster</td>
+ </tr>
+ <tr>
+ <td>redirects = 2</td>
+ <td>(IntOpt) Number of times a redirect should be followed</td>
+ </tr>
+ <tr>
+ <td>req_timeout = 30</td>
+ <td>(IntOpt) Total time limit for a cluster request</td>
+ </tr>
+ <tr>
+ <td>retries = 2</td>
+ <td>(IntOpt) Number of time a request should be retried</td>
+ </tr>
+ <tr>
+ <th colspan="2">[ESWITCH]</th>
+ </tr>
+ <tr>
+ <td>retries = 3</td>
+ <td>(IntOpt) The number of retries the agent will send request to daemon before giving up</td>
+ </tr>
+ <tr>
+ <th colspan="2">[NSX]</th>
+ </tr>
+ <tr>
+ <td>agent_mode = agent</td>
+ <td>(StrOpt) The mode used to implement DHCP/metadata services.</td>
+ </tr>
+ <tr>
+ <td>concurrent_connections = 10</td>
+ <td>(IntOpt) Maximum concurrent connections to each NSX controller.</td>
+ </tr>
+ <tr>
+ <td>default_transport_type = stt</td>
+ <td>(StrOpt) The default network tranport type to use (stt, gre, bridge, ipsec_gre, or ipsec_stt)</td>
+ </tr>
+ <tr>
+ <td>max_lp_per_bridged_ls = 5000</td>
+ <td>(IntOpt) Maximum number of ports of a logical switch on a bridged transport zone (default 5000)</td>
+ </tr>
+ <tr>
+ <td>max_lp_per_overlay_ls = 256</td>
+ <td>(IntOpt) Maximum number of ports of a logical switch on an overlay transport zone (default 256)</td>
+ </tr>
+ <tr>
+ <td>metadata_mode = access_network</td>
+ <td>(StrOpt) If set to access_network this enables a dedicated connection to the metadata proxy for metadata server access via Neutron router. If set to dhcp_host_route this enables host route injection via the dhcp agent. This option is only useful if running on a host that does not support namespaces otherwise access_network should be used.</td>
+ </tr>
+ <tr>
+ <td>nsx_gen_timeout = -1</td>
+ <td>(IntOpt) Number of seconds a generation id should be valid for (default -1 meaning do not time out)</td>
+ </tr>
+ <tr>
+ <td>replication_mode = service</td>
+ <td>(StrOpt) The default option leverages service nodes to perform packet replication though one could set to this to 'source' to perform replication locally. This is useful if one does not want to deploy a service node(s).</td>
+ </tr>
+ <tr>
+ <th colspan="2">[NSX_DHCP]</th>
+ </tr>
+ <tr>
+ <td>default_lease_time = 43200</td>
+ <td>(IntOpt) Default DHCP lease time</td>
+ </tr>
+ <tr>
+ <td>domain_name = openstacklocal</td>
+ <td>(StrOpt) Domain to use for building the hostnames</td>
+ </tr>
+ <tr>
+ <td>extra_domain_name_servers = </td>
+ <td>(ListOpt) Comma separated list of additional domain name servers</td>
+ </tr>
+ <tr>
+ <th colspan="2">[NSX_LSN]</th>
+ </tr>
+ <tr>
+ <td>sync_on_missing_data = False</td>
+ <td>(BoolOpt) Pull LSN information from NSX in case it is missing from the local data store. This is useful to rebuild the local store in case of server recovery.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[NSX_METADATA]</th>
+ </tr>
+ <tr>
+ <td>metadata_server_address = 127.0.0.1</td>
+ <td>(StrOpt) IP address used by Metadata server.</td>
+ </tr>
+ <tr>
+ <td>metadata_server_port = 8775</td>
+ <td>(IntOpt) TCP Port used by Metadata server.</td>
+ </tr>
+ <tr>
+ <td>metadata_shared_secret = </td>
+ <td>(StrOpt) Shared secret to sign instance-id request</td>
+ </tr>
+ <tr>
+ <th colspan="2">[NSX_SYNC]</th>
+ </tr>
+ <tr>
+ <td>always_read_status = False</td>
+ <td>(BoolOpt) Always read operational status from backend on show operations. Enabling this option might slow down the system.</td>
+ </tr>
+ <tr>
+ <td>max_random_sync_delay = 0</td>
+ <td>(IntOpt) Maximum value for the additional random delay in seconds between runs of the state synchronization task</td>
+ </tr>
+ <tr>
+ <td>min_chunk_size = 500</td>
+ <td>(IntOpt) Minimum number of resources to be retrieved from NSX during state synchronization</td>
+ </tr>
+ <tr>
+ <td>min_sync_req_delay = 1</td>
+ <td>(IntOpt) Minimum delay, in seconds, between two state synchronization queries to NSX. It must not exceed state_sync_interval</td>
+ </tr>
+ <tr>
+ <td>state_sync_interval = 10</td>
+ <td>(IntOpt) Interval in seconds between runs of the state synchronization task. Set it to 0 to disable it</td>
+ </tr>
+ <tr>
+ <th colspan="2">[vcns]</th>
+ </tr>
+ <tr>
+ <td>datacenter_moid = None</td>
+ <td>(StrOpt) Optional parameter identifying the ID of datacenter to deploy NSX Edges</td>
+ </tr>
+ <tr>
+ <td>datastore_id = None</td>
+ <td>(StrOpt) Optional parameter identifying the ID of datastore to deploy NSX Edges</td>
+ </tr>
+ <tr>
+ <td>deployment_container_id = None</td>
+ <td>(StrOpt) Optional parameter identifying the ID of datastore to deploy NSX Edges</td>
+ </tr>
+ <tr>
+ <td>external_network = None</td>
+ <td>(StrOpt) Network ID for physical network connectivity</td>
+ </tr>
+ <tr>
+ <td>manager_uri = None</td>
+ <td>(StrOpt) uri for vsm</td>
+ </tr>
+ <tr>
+ <td>password = default</td>
+ <td>(StrOpt) Password for vsm</td>
+ </tr>
+ <tr>
+ <td>resource_pool_id = None</td>
+ <td>(StrOpt) Optional parameter identifying the ID of resource to deploy NSX Edges</td>
+ </tr>
+ <tr>
+ <td>task_status_check_interval = 2000</td>
+ <td>(IntOpt) Task status check interval</td>
+ </tr>
+ <tr>
+ <td>user = admin</td>
+ <td>(StrOpt) User name for vsm</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-vpn.xml b/doc/common/tables/neutron-vpn.xml
index 7819fb1c5a..e88ab0bb6a 100644
--- a/doc/common/tables/neutron-vpn.xml
+++ b/doc/common/tables/neutron-vpn.xml
@@ -1,49 +1,48 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_vpn">
- <caption>Description of configuration options for vpn</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">[ipsec]</th>
- </tr>
- <tr>
- <td>config_base_dir = $state_path/ipsec</td>
- <td>(StrOpt) Location to store ipsec server config files</td>
- </tr>
- <tr>
- <td>ipsec_status_check_interval = 60</td>
- <td>(IntOpt) Interval for checking ipsec status</td>
- </tr>
- <tr>
- <th colspan="2">[openswan]</th>
- </tr>
- <tr>
- <td>ipsec_config_template = /usr/lib/python/site-packages/neutron/services/vpn/device_drivers/template/openswan/ipsec.conf.template</td>
- <td>(StrOpt) Template file for ipsec configuration</td>
- </tr>
- <tr>
- <td>ipsec_secret_template = /usr/lib/python/site-packages/neutron/services/vpn/device_drivers/template/openswan/ipsec.secret.template</td>
- <td>(StrOpt) Template file for ipsec secret configuration</td>
- </tr>
- <tr>
- <th colspan="2">[vpnagent]</th>
- </tr>
- <tr>
- <td>vpn_device_driver = ['neutron.services.vpn.device_drivers.ipsec.OpenSwanDriver']</td>
- <td>(MultiStrOpt) The vpn device drivers Neutron will use</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_vpn">
+ <caption>Description of configuration options for vpn</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">[ipsec]</th>
+ </tr>
+ <tr>
+ <td>config_base_dir = $state_path/ipsec</td>
+ <td>(StrOpt) Location to store ipsec server config files</td>
+ </tr>
+ <tr>
+ <td>ipsec_status_check_interval = 60</td>
+ <td>(IntOpt) Interval for checking ipsec status</td>
+ </tr>
+ <tr>
+ <th colspan="2">[openswan]</th>
+ </tr>
+ <tr>
+ <td>ipsec_config_template = /usr/lib/python/site-packages/neutron/services/vpn/device_drivers/template/openswan/ipsec.conf.template</td>
+ <td>(StrOpt) Template file for ipsec configuration</td>
+ </tr>
+ <tr>
+ <td>ipsec_secret_template = /usr/lib/python/site-packages/neutron/services/vpn/device_drivers/template/openswan/ipsec.secret.template</td>
+ <td>(StrOpt) Template file for ipsec secret configuration</td>
+ </tr>
+ <tr>
+ <th colspan="2">[vpnagent]</th>
+ </tr>
+ <tr>
+ <td>vpn_device_driver = ['neutron.services.vpn.device_drivers.ipsec.OpenSwanDriver']</td>
+ <td>(MultiStrOpt) The vpn device drivers Neutron will use</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-wsgi.xml b/doc/common/tables/neutron-wsgi.xml
index 328e507f0f..5817376f50 100644
--- a/doc/common/tables/neutron-wsgi.xml
+++ b/doc/common/tables/neutron-wsgi.xml
@@ -1,35 +1,34 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_wsgi">
- <caption>Description of configuration options for wsgi</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>backlog = 4096</td>
- <td>(IntOpt) Number of backlog requests to configure the socket with</td>
- </tr>
- <tr>
- <td>retry_until_window = 30</td>
- <td>(IntOpt) Number of seconds to keep retrying to listen</td>
- </tr>
- <tr>
- <td>tcp_keepidle = 600</td>
- <td>(IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_wsgi">
+ <caption>Description of configuration options for wsgi</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>backlog = 4096</td>
+ <td>(IntOpt) Number of backlog requests to configure the socket with</td>
+ </tr>
+ <tr>
+ <td>retry_until_window = 30</td>
+ <td>(IntOpt) Number of seconds to keep retrying to listen</td>
+ </tr>
+ <tr>
+ <td>tcp_keepidle = 600</td>
+ <td>(IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/neutron-zeromq.xml b/doc/common/tables/neutron-zeromq.xml
index 4f7f88156b..423c0a5d35 100644
--- a/doc/common/tables/neutron-zeromq.xml
+++ b/doc/common/tables/neutron-zeromq.xml
@@ -1,51 +1,50 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_neutron_zeromq">
- <caption>Description of configuration options for zeromq</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>rpc_zmq_bind_address = *</td>
- <td>(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address.</td>
- </tr>
- <tr>
- <td>rpc_zmq_contexts = 1</td>
- <td>(IntOpt) Number of ZeroMQ contexts, defaults to 1</td>
- </tr>
- <tr>
- <td>rpc_zmq_host = oslo</td>
- <td>(StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova.</td>
- </tr>
- <tr>
- <td>rpc_zmq_ipc_dir = /var/run/openstack</td>
- <td>(StrOpt) Directory for holding IPC sockets</td>
- </tr>
- <tr>
- <td>rpc_zmq_matchmaker = neutron.openstack.common.rpc.matchmaker.MatchMakerLocalhost</td>
- <td>(StrOpt) MatchMaker driver</td>
- </tr>
- <tr>
- <td>rpc_zmq_port = 9501</td>
- <td>(IntOpt) ZeroMQ receiver listening port</td>
- </tr>
- <tr>
- <td>rpc_zmq_topic_backlog = None</td>
- <td>(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_neutron_zeromq">
+ <caption>Description of configuration options for zeromq</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>rpc_zmq_bind_address = *</td>
+ <td>(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_contexts = 1</td>
+ <td>(IntOpt) Number of ZeroMQ contexts, defaults to 1.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_host = oslo</td>
+ <td>(StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_ipc_dir = /var/run/openstack</td>
+ <td>(StrOpt) Directory for holding IPC sockets.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_matchmaker = oslo.messaging._drivers.matchmaker.MatchMakerLocalhost</td>
+ <td>(StrOpt) MatchMaker driver.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_port = 9501</td>
+ <td>(IntOpt) ZeroMQ receiver listening port.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_topic_backlog = None</td>
+ <td>(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-api.xml b/doc/common/tables/nova-api.xml
index c48cc079d4..a4b67a8a61 100644
--- a/doc/common/tables/nova-api.xml
+++ b/doc/common/tables/nova-api.xml
@@ -1,99 +1,98 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_api">
- <caption>Description of configuration options for api</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>api_rate_limit = False</td>
- <td>(BoolOpt) Whether to use per-user rate limiting for the api. This option is only used by v2 api. Rate limiting is removed from v3 api.</td>
- </tr>
- <tr>
- <td>enable_new_services = True</td>
- <td>(BoolOpt) Services to be added to the available pool on create</td>
- </tr>
- <tr>
- <td>enabled_apis = ec2, osapi_compute, metadata</td>
- <td>(ListOpt) A list of APIs to enable by default</td>
- </tr>
- <tr>
- <td>enabled_ssl_apis = </td>
- <td>(ListOpt) A list of APIs with enabled SSL</td>
- </tr>
- <tr>
- <td>instance_name_template = instance-%08x</td>
- <td>(StrOpt) Template string to be used to generate instance names</td>
- </tr>
- <tr>
- <td>max_header_line = 16384</td>
- <td>(IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs).</td>
- </tr>
- <tr>
- <td>multi_instance_display_name_template = %(name)s-%(uuid)s</td>
- <td>(StrOpt) When creating multiple instances with a single request using the os-multiple-create API extension, this template will be used to build the display name for each instance. The benefit is that the instances end up with different hostnames. To restore legacy behavior of every instance having the same name, set this option to "%(name)s". Valid keys for the template are: name, uuid, count.</td>
- </tr>
- <tr>
- <td>non_inheritable_image_properties = cache_in_nova, bittorrent</td>
- <td>(ListOpt) These are image properties which a snapshot should not inherit from an instance</td>
- </tr>
- <tr>
- <td>null_kernel = nokernel</td>
- <td>(StrOpt) Kernel image that indicates not to use a kernel, but to use a raw disk image instead</td>
- </tr>
- <tr>
- <td>osapi_compute_ext_list = </td>
- <td>(ListOpt) Specify list of extensions to load when using osapi_compute_extension option with nova.api.openstack.compute.contrib.select_extensions</td>
- </tr>
- <tr>
- <td>osapi_compute_extension = ['nova.api.openstack.compute.contrib.standard_extensions']</td>
- <td>(MultiStrOpt) osapi compute extension to load</td>
- </tr>
- <tr>
- <td>osapi_compute_link_prefix = None</td>
- <td>(StrOpt) Base URL that will be presented to users in links to the OpenStack Compute API</td>
- </tr>
- <tr>
- <td>osapi_compute_listen = 0.0.0.0</td>
- <td>(StrOpt) The IP address on which the OpenStack API will listen.</td>
- </tr>
- <tr>
- <td>osapi_compute_listen_port = 8774</td>
- <td>(IntOpt) The port on which the OpenStack API will listen.</td>
- </tr>
- <tr>
- <td>osapi_compute_workers = None</td>
- <td>(IntOpt) Number of workers for OpenStack API service. The default will be the number of CPUs available.</td>
- </tr>
- <tr>
- <td>osapi_hide_server_address_states = building</td>
- <td>(ListOpt) List of instance states that should hide network info</td>
- </tr>
- <tr>
- <td>servicegroup_driver = db</td>
- <td>(StrOpt) The driver for servicegroup service (valid options are: db, zk, mc)</td>
- </tr>
- <tr>
- <td>snapshot_name_template = snapshot-%s</td>
- <td>(StrOpt) Template string to be used to generate snapshot names</td>
- </tr>
- <tr>
- <td>use_forwarded_for = False</td>
- <td>(BoolOpt) Treat X-Forwarded-For as the canonical remote address. Only enable this if you have a sanitizing proxy.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_api">
+ <caption>Description of configuration options for api</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>api_rate_limit = False</td>
+ <td>(BoolOpt) Whether to use per-user rate limiting for the api. This option is only used by v2 api. Rate limiting is removed from v3 api.</td>
+ </tr>
+ <tr>
+ <td>enable_new_services = True</td>
+ <td>(BoolOpt) Services to be added to the available pool on create</td>
+ </tr>
+ <tr>
+ <td>enabled_apis = ec2, osapi_compute, metadata</td>
+ <td>(ListOpt) A list of APIs to enable by default</td>
+ </tr>
+ <tr>
+ <td>enabled_ssl_apis = </td>
+ <td>(ListOpt) A list of APIs with enabled SSL</td>
+ </tr>
+ <tr>
+ <td>instance_name_template = instance-%08x</td>
+ <td>(StrOpt) Template string to be used to generate instance names</td>
+ </tr>
+ <tr>
+ <td>max_header_line = 16384</td>
+ <td>(IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs).</td>
+ </tr>
+ <tr>
+ <td>multi_instance_display_name_template = %(name)s-%(uuid)s</td>
+ <td>(StrOpt) When creating multiple instances with a single request using the os-multiple-create API extension, this template will be used to build the display name for each instance. The benefit is that the instances end up with different hostnames. To restore legacy behavior of every instance having the same name, set this option to "%(name)s". Valid keys for the template are: name, uuid, count.</td>
+ </tr>
+ <tr>
+ <td>non_inheritable_image_properties = cache_in_nova, bittorrent</td>
+ <td>(ListOpt) These are image properties which a snapshot should not inherit from an instance</td>
+ </tr>
+ <tr>
+ <td>null_kernel = nokernel</td>
+ <td>(StrOpt) Kernel image that indicates not to use a kernel, but to use a raw disk image instead</td>
+ </tr>
+ <tr>
+ <td>osapi_compute_ext_list = </td>
+ <td>(ListOpt) Specify list of extensions to load when using osapi_compute_extension option with nova.api.openstack.compute.contrib.select_extensions</td>
+ </tr>
+ <tr>
+ <td>osapi_compute_extension = ['nova.api.openstack.compute.contrib.standard_extensions']</td>
+ <td>(MultiStrOpt) osapi compute extension to load</td>
+ </tr>
+ <tr>
+ <td>osapi_compute_link_prefix = None</td>
+ <td>(StrOpt) Base URL that will be presented to users in links to the OpenStack Compute API</td>
+ </tr>
+ <tr>
+ <td>osapi_compute_listen = 0.0.0.0</td>
+ <td>(StrOpt) The IP address on which the OpenStack API will listen.</td>
+ </tr>
+ <tr>
+ <td>osapi_compute_listen_port = 8774</td>
+ <td>(IntOpt) The port on which the OpenStack API will listen.</td>
+ </tr>
+ <tr>
+ <td>osapi_compute_workers = None</td>
+ <td>(IntOpt) Number of workers for OpenStack API service. The default will be the number of CPUs available.</td>
+ </tr>
+ <tr>
+ <td>osapi_hide_server_address_states = building</td>
+ <td>(ListOpt) List of instance states that should hide network info</td>
+ </tr>
+ <tr>
+ <td>servicegroup_driver = db</td>
+ <td>(StrOpt) The driver for servicegroup service (valid options are: db, zk, mc)</td>
+ </tr>
+ <tr>
+ <td>snapshot_name_template = snapshot-%s</td>
+ <td>(StrOpt) Template string to be used to generate snapshot names</td>
+ </tr>
+ <tr>
+ <td>use_forwarded_for = False</td>
+ <td>(BoolOpt) Treat X-Forwarded-For as the canonical remote address. Only enable this if you have a sanitizing proxy.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-apiv3.xml b/doc/common/tables/nova-apiv3.xml
index 99fcdae8c4..3b288b2a4d 100644
--- a/doc/common/tables/nova-apiv3.xml
+++ b/doc/common/tables/nova-apiv3.xml
@@ -1,35 +1,34 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_apiv3">
- <caption>Description of configuration options for apiv3</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">[osapi_v3]</th>
- </tr>
- <tr>
- <td>enabled = False</td>
- <td>(BoolOpt) Whether the V3 API is enabled or not</td>
- </tr>
- <tr>
- <td>extensions_blacklist = </td>
- <td>(ListOpt) A list of v3 API extensions to never load. Specify the extension aliases here.</td>
- </tr>
- <tr>
- <td>extensions_whitelist = </td>
- <td>(ListOpt) If the list is not empty then a v3 API extension will only be loaded if it exists in this list. Specify the extension aliases here.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_apiv3">
+ <caption>Description of configuration options for apiv3</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">[osapi_v3]</th>
+ </tr>
+ <tr>
+ <td>enabled = False</td>
+ <td>(BoolOpt) Whether the V3 API is enabled or not</td>
+ </tr>
+ <tr>
+ <td>extensions_blacklist = </td>
+ <td>(ListOpt) A list of v3 API extensions to never load. Specify the extension aliases here.</td>
+ </tr>
+ <tr>
+ <td>extensions_whitelist = </td>
+ <td>(ListOpt) If the list is not empty then a v3 API extension will only be loaded if it exists in this list. Specify the extension aliases here.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-auth_token.xml b/doc/common/tables/nova-auth_token.xml
index 20fc823fbe..be91e7d4e3 100644
--- a/doc/common/tables/nova-auth_token.xml
+++ b/doc/common/tables/nova-auth_token.xml
@@ -1,127 +1,138 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_auth_token">
- <caption>Description of configuration options for auth_token</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>admin_password = None</td>
- <td>(StrOpt) Keystone account password</td>
- </tr>
- <tr>
- <td>admin_tenant_name = admin</td>
- <td>(StrOpt) Keystone service account tenant name to validate user tokens</td>
- </tr>
- <tr>
- <td>admin_token = None</td>
- <td>(StrOpt) Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process.</td>
- </tr>
- <tr>
- <td>admin_user = None</td>
- <td>(StrOpt) Keystone account username</td>
- </tr>
- <tr>
- <td>auth_admin_prefix = </td>
- <td>(StrOpt) Prefix to prepend at the beginning of the path</td>
- </tr>
- <tr>
- <td>auth_host = 127.0.0.1</td>
- <td>(StrOpt) Host providing the admin Identity API endpoint</td>
- </tr>
- <tr>
- <td>auth_port = 35357</td>
- <td>(IntOpt) Port of the admin Identity API endpoint</td>
- </tr>
- <tr>
- <td>auth_protocol = https</td>
- <td>(StrOpt) Protocol of the admin Identity API endpoint(http or https)</td>
- </tr>
- <tr>
- <td>auth_uri = None</td>
- <td>(StrOpt) Complete public Identity API endpoint</td>
- </tr>
- <tr>
- <td>auth_version = None</td>
- <td>(StrOpt) API version of the admin Identity API endpoint</td>
- </tr>
- <tr>
- <td>cache = None</td>
- <td>(StrOpt) Env key for the swift cache</td>
- </tr>
- <tr>
- <td>cafile = None</td>
- <td>(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.</td>
- </tr>
- <tr>
- <td>certfile = None</td>
- <td>(StrOpt) Required if Keystone server requires client certificate</td>
- </tr>
- <tr>
- <td>delay_auth_decision = False</td>
- <td>(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components</td>
- </tr>
- <tr>
- <td>enforce_token_bind = permissive</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>http_connect_timeout = None</td>
- <td>(BoolOpt) Request timeout value for communicating with Identity API server.</td>
- </tr>
- <tr>
- <td>http_request_max_retries = 3</td>
- <td>(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server.</td>
- </tr>
- <tr>
- <td>include_service_catalog = True</td>
- <td>(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.</td>
- </tr>
- <tr>
- <td>insecure = False</td>
- <td>(BoolOpt) Verify HTTPS connections.</td>
- </tr>
- <tr>
- <td>keyfile = None</td>
- <td>(StrOpt) Required if Keystone server requires client certificate</td>
- </tr>
- <tr>
- <td>memcache_secret_key = None</td>
- <td>(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation.</td>
- </tr>
- <tr>
- <td>memcache_security_strategy = None</td>
- <td>(StrOpt) (optional) if defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.</td>
- </tr>
- <tr>
- <td>memcached_servers = None</td>
- <td>(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.</td>
- </tr>
- <tr>
- <td>revocation_cache_time = 300</td>
- <td>(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.</td>
- </tr>
- <tr>
- <td>signing_dir = None</td>
- <td>(StrOpt) Directory used to cache files related to PKI tokens</td>
- </tr>
- <tr>
- <td>token_cache_time = 300</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>
+<?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_nova_auth_token">
+ <caption>Description of configuration options for auth_token</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>admin_password = None</td>
+ <td>(StrOpt) Keystone account password</td>
+ </tr>
+ <tr>
+ <td>admin_tenant_name = admin</td>
+ <td>(StrOpt) Keystone service account tenant name to validate user tokens</td>
+ </tr>
+ <tr>
+ <td>admin_token = None</td>
+ <td>(StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead.</td>
+ </tr>
+ <tr>
+ <td>admin_user = None</td>
+ <td>(StrOpt) Keystone account username</td>
+ </tr>
+ <tr>
+ <td>auth_admin_prefix = </td>
+ <td>(StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri.</td>
+ </tr>
+ <tr>
+ <td>auth_host = 127.0.0.1</td>
+ <td>(StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri.</td>
+ </tr>
+ <tr>
+ <td>auth_port = 35357</td>
+ <td>(IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri.</td>
+ </tr>
+ <tr>
+ <td>auth_protocol = https</td>
+ <td>(StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri.</td>
+ </tr>
+ <tr>
+ <td>auth_uri = None</td>
+ <td>(StrOpt) Complete public Identity API endpoint</td>
+ </tr>
+ <tr>
+ <td>auth_version = None</td>
+ <td>(StrOpt) API version of the admin Identity API endpoint</td>
+ </tr>
+ <tr>
+ <td>cache = None</td>
+ <td>(StrOpt) Env key for the swift cache</td>
+ </tr>
+ <tr>
+ <td>cafile = None</td>
+ <td>(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.</td>
+ </tr>
+ <tr>
+ <td>certfile = None</td>
+ <td>(StrOpt) Required if Keystone server requires client certificate</td>
+ </tr>
+ <tr>
+ <td>check_revocations_for_cached = False</td>
+ <td>(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the Keystone server.</td>
+ </tr>
+ <tr>
+ <td>delay_auth_decision = False</td>
+ <td>(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components</td>
+ </tr>
+ <tr>
+ <td>enforce_token_bind = permissive</td>
+ <td>(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens.</td>
+ </tr>
+ <tr>
+ <td>hash_algorithms = md5</td>
+ <td>(ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance.</td>
+ </tr>
+ <tr>
+ <td>http_connect_timeout = None</td>
+ <td>(BoolOpt) Request timeout value for communicating with Identity API server.</td>
+ </tr>
+ <tr>
+ <td>http_request_max_retries = 3</td>
+ <td>(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server.</td>
+ </tr>
+ <tr>
+ <td>identity_uri = None</td>
+ <td>(StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/</td>
+ </tr>
+ <tr>
+ <td>include_service_catalog = True</td>
+ <td>(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.</td>
+ </tr>
+ <tr>
+ <td>insecure = False</td>
+ <td>(BoolOpt) Verify HTTPS connections.</td>
+ </tr>
+ <tr>
+ <td>keyfile = None</td>
+ <td>(StrOpt) Required if Keystone server requires client certificate</td>
+ </tr>
+ <tr>
+ <td>memcache_secret_key = None</td>
+ <td>(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation.</td>
+ </tr>
+ <tr>
+ <td>memcache_security_strategy = None</td>
+ <td>(StrOpt) (optional) if defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.</td>
+ </tr>
+ <tr>
+ <td>memcached_servers = None</td>
+ <td>(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.</td>
+ </tr>
+ <tr>
+ <td>revocation_cache_time = 10</td>
+ <td>(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.</td>
+ </tr>
+ <tr>
+ <td>signing_dir = None</td>
+ <td>(StrOpt) Directory used to cache files related to PKI tokens</td>
+ </tr>
+ <tr>
+ <td>token_cache_time = 300</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>
diff --git a/doc/common/tables/nova-authentication.xml b/doc/common/tables/nova-authentication.xml
index 9094434a02..40e9e1c7ce 100644
--- a/doc/common/tables/nova-authentication.xml
+++ b/doc/common/tables/nova-authentication.xml
@@ -1,27 +1,26 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_authentication">
- <caption>Description of configuration options for authentication</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>auth_strategy = noauth</td>
- <td>(StrOpt) The strategy to use for auth: noauth or keystone.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_authentication">
+ <caption>Description of configuration options for authentication</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>auth_strategy = keystone</td>
+ <td>(StrOpt) The strategy to use for auth: noauth or keystone.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-availabilityzones.xml b/doc/common/tables/nova-availabilityzones.xml
index e0a81c6d63..1cf553e716 100644
--- a/doc/common/tables/nova-availabilityzones.xml
+++ b/doc/common/tables/nova-availabilityzones.xml
@@ -1,35 +1,34 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_availabilityzones">
- <caption>Description of configuration options for availabilityzones</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>default_availability_zone = nova</td>
- <td>(StrOpt) Default compute node availability_zone</td>
- </tr>
- <tr>
- <td>default_schedule_zone = None</td>
- <td>(StrOpt) Availability zone to use when user doesn't specify one</td>
- </tr>
- <tr>
- <td>internal_service_availability_zone = internal</td>
- <td>(StrOpt) The availability_zone to show internal services under</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_availabilityzones">
+ <caption>Description of configuration options for availabilityzones</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>default_availability_zone = nova</td>
+ <td>(StrOpt) Default compute node availability_zone</td>
+ </tr>
+ <tr>
+ <td>default_schedule_zone = None</td>
+ <td>(StrOpt) Availability zone to use when user doesn't specify one</td>
+ </tr>
+ <tr>
+ <td>internal_service_availability_zone = internal</td>
+ <td>(StrOpt) The availability_zone to show internal services under</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-baremetal.xml b/doc/common/tables/nova-baremetal.xml
index d7a2d811c2..98805d572e 100644
--- a/doc/common/tables/nova-baremetal.xml
+++ b/doc/common/tables/nova-baremetal.xml
@@ -1,138 +1,137 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_baremetal">
- <caption>Description of configuration options for baremetal</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">[baremetal]</th>
- </tr>
- <tr>
- <td>db_backend = sqlalchemy</td>
- <td>(StrOpt) The backend to use for bare-metal database</td>
- </tr>
- <tr>
- <td>deploy_kernel = None</td>
- <td>(StrOpt) Default kernel image ID used in deployment phase</td>
- </tr>
- <tr>
- <td>deploy_ramdisk = None</td>
- <td>(StrOpt) Default ramdisk image ID used in deployment phase</td>
- </tr>
- <tr>
- <td>driver = nova.virt.baremetal.pxe.PXE</td>
- <td>(StrOpt) Baremetal driver back-end (pxe or tilera)</td>
- </tr>
- <tr>
- <td>flavor_extra_specs = </td>
- <td>(ListOpt) A list of additional capabilities corresponding to flavor_extra_specs for this compute host to advertise. Valid entries are name=value, pairs For example, "key1:val1, key2:val2"</td>
- </tr>
- <tr>
- <td>ipmi_power_retry = 10</td>
- <td>(IntOpt) Maximal number of retries for IPMI operations</td>
- </tr>
- <tr>
- <td>net_config_template = $pybasedir/nova/virt/baremetal/net-dhcp.ubuntu.template</td>
- <td>(StrOpt) Template file for injected network config</td>
- </tr>
- <tr>
- <td>power_manager = nova.virt.baremetal.ipmi.IPMI</td>
- <td>(StrOpt) Baremetal power management method</td>
- </tr>
- <tr>
- <td>pxe_append_params = nofb nomodeset vga=normal</td>
- <td>(StrOpt) Additional append parameters for baremetal PXE boot</td>
- </tr>
- <tr>
- <td>pxe_bootfile_name = pxelinux.0</td>
- <td>(StrOpt) This gets passed to Neutron as the bootfile dhcp parameter.</td>
- </tr>
- <tr>
- <td>pxe_config_template = $pybasedir/nova/virt/baremetal/pxe_config.template</td>
- <td>(StrOpt) Template file for PXE configuration</td>
- </tr>
- <tr>
- <td>pxe_deploy_timeout = 0</td>
- <td>(IntOpt) Timeout for PXE deployments. Default: 0 (unlimited)</td>
- </tr>
- <tr>
- <td>pxe_network_config = False</td>
- <td>(BoolOpt) If set, pass the network configuration details to the initramfs via cmdline.</td>
- </tr>
- <tr>
- <td>sql_connection = sqlite:///$state_path/baremetal_nova.sqlite</td>
- <td>(StrOpt) The SQLAlchemy connection string used to connect to the bare-metal database</td>
- </tr>
- <tr>
- <td>terminal = shellinaboxd</td>
- <td>(StrOpt) Path to baremetal terminal program</td>
- </tr>
- <tr>
- <td>terminal_cert_dir = None</td>
- <td>(StrOpt) Path to baremetal terminal SSL cert(PEM)</td>
- </tr>
- <tr>
- <td>terminal_pid_dir = $state_path/baremetal/console</td>
- <td>(StrOpt) Path to directory stores pidfiles of baremetal_terminal</td>
- </tr>
- <tr>
- <td>tftp_root = /tftpboot</td>
- <td>(StrOpt) Baremetal compute node's tftp root path</td>
- </tr>
- <tr>
- <td>use_file_injection = False</td>
- <td>(BoolOpt) If True, enable file injection for network info, files and admin password</td>
- </tr>
- <tr>
- <td>use_unsafe_iscsi = False</td>
- <td>(BoolOpt) Do not set this out of dev/test environments. If a node does not have a fixed PXE IP address, volumes are exported with globally opened ACL</td>
- </tr>
- <tr>
- <td>vif_driver = nova.virt.baremetal.vif_driver.BareMetalVIFDriver</td>
- <td>(StrOpt) Baremetal VIF driver.</td>
- </tr>
- <tr>
- <td>virtual_power_host_key = None</td>
- <td>(StrOpt) The ssh key for virtual power host_user</td>
- </tr>
- <tr>
- <td>virtual_power_host_pass = </td>
- <td>(StrOpt) Password for virtual power host_user</td>
- </tr>
- <tr>
- <td>virtual_power_host_user = </td>
- <td>(StrOpt) User to execute virtual power commands as</td>
- </tr>
- <tr>
- <td>virtual_power_ssh_host = </td>
- <td>(StrOpt) IP or name to virtual power host</td>
- </tr>
- <tr>
- <td>virtual_power_ssh_port = 22</td>
- <td>(IntOpt) Port to use for ssh to virtual power host</td>
- </tr>
- <tr>
- <td>virtual_power_type = virsh</td>
- <td>(StrOpt) Base command to use for virtual power(vbox, virsh)</td>
- </tr>
- <tr>
- <th colspan="2">[xenserver]</th>
- </tr>
- <tr>
- <td>vif_driver = nova.virt.xenapi.vif.XenAPIBridgeDriver</td>
- <td>(StrOpt) The XenAPI VIF driver using XenServer Network APIs.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_baremetal">
+ <caption>Description of configuration options for baremetal</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">[baremetal]</th>
+ </tr>
+ <tr>
+ <td>db_backend = sqlalchemy</td>
+ <td>(StrOpt) The backend to use for bare-metal database</td>
+ </tr>
+ <tr>
+ <td>deploy_kernel = None</td>
+ <td>(StrOpt) Default kernel image ID used in deployment phase</td>
+ </tr>
+ <tr>
+ <td>deploy_ramdisk = None</td>
+ <td>(StrOpt) Default ramdisk image ID used in deployment phase</td>
+ </tr>
+ <tr>
+ <td>driver = nova.virt.baremetal.pxe.PXE</td>
+ <td>(StrOpt) Baremetal driver back-end (pxe or tilera)</td>
+ </tr>
+ <tr>
+ <td>flavor_extra_specs = </td>
+ <td>(ListOpt) A list of additional capabilities corresponding to flavor_extra_specs for this compute host to advertise. Valid entries are name=value, pairs For example, "key1:val1, key2:val2"</td>
+ </tr>
+ <tr>
+ <td>ipmi_power_retry = 10</td>
+ <td>(IntOpt) Maximal number of retries for IPMI operations</td>
+ </tr>
+ <tr>
+ <td>net_config_template = $pybasedir/nova/virt/baremetal/net-dhcp.ubuntu.template</td>
+ <td>(StrOpt) Template file for injected network config</td>
+ </tr>
+ <tr>
+ <td>power_manager = nova.virt.baremetal.ipmi.IPMI</td>
+ <td>(StrOpt) Baremetal power management method</td>
+ </tr>
+ <tr>
+ <td>pxe_append_params = nofb nomodeset vga=normal</td>
+ <td>(StrOpt) Additional append parameters for baremetal PXE boot</td>
+ </tr>
+ <tr>
+ <td>pxe_bootfile_name = pxelinux.0</td>
+ <td>(StrOpt) This gets passed to Neutron as the bootfile dhcp parameter.</td>
+ </tr>
+ <tr>
+ <td>pxe_config_template = $pybasedir/nova/virt/baremetal/pxe_config.template</td>
+ <td>(StrOpt) Template file for PXE configuration</td>
+ </tr>
+ <tr>
+ <td>pxe_deploy_timeout = 0</td>
+ <td>(IntOpt) Timeout for PXE deployments. Default: 0 (unlimited)</td>
+ </tr>
+ <tr>
+ <td>pxe_network_config = False</td>
+ <td>(BoolOpt) If set, pass the network configuration details to the initramfs via cmdline.</td>
+ </tr>
+ <tr>
+ <td>sql_connection = sqlite:///$state_path/baremetal_nova.sqlite</td>
+ <td>(StrOpt) The SQLAlchemy connection string used to connect to the bare-metal database</td>
+ </tr>
+ <tr>
+ <td>terminal = shellinaboxd</td>
+ <td>(StrOpt) Path to baremetal terminal program</td>
+ </tr>
+ <tr>
+ <td>terminal_cert_dir = None</td>
+ <td>(StrOpt) Path to baremetal terminal SSL cert(PEM)</td>
+ </tr>
+ <tr>
+ <td>terminal_pid_dir = $state_path/baremetal/console</td>
+ <td>(StrOpt) Path to directory stores pidfiles of baremetal_terminal</td>
+ </tr>
+ <tr>
+ <td>tftp_root = /tftpboot</td>
+ <td>(StrOpt) Baremetal compute node's tftp root path</td>
+ </tr>
+ <tr>
+ <td>use_file_injection = False</td>
+ <td>(BoolOpt) If True, enable file injection for network info, files and admin password</td>
+ </tr>
+ <tr>
+ <td>use_unsafe_iscsi = False</td>
+ <td>(BoolOpt) Do not set this out of dev/test environments. If a node does not have a fixed PXE IP address, volumes are exported with globally opened ACL</td>
+ </tr>
+ <tr>
+ <td>vif_driver = nova.virt.baremetal.vif_driver.BareMetalVIFDriver</td>
+ <td>(StrOpt) Baremetal VIF driver.</td>
+ </tr>
+ <tr>
+ <td>virtual_power_host_key = None</td>
+ <td>(StrOpt) The ssh key for virtual power host_user</td>
+ </tr>
+ <tr>
+ <td>virtual_power_host_pass = </td>
+ <td>(StrOpt) Password for virtual power host_user</td>
+ </tr>
+ <tr>
+ <td>virtual_power_host_user = </td>
+ <td>(StrOpt) User to execute virtual power commands as</td>
+ </tr>
+ <tr>
+ <td>virtual_power_ssh_host = </td>
+ <td>(StrOpt) IP or name to virtual power host</td>
+ </tr>
+ <tr>
+ <td>virtual_power_ssh_port = 22</td>
+ <td>(IntOpt) Port to use for ssh to virtual power host</td>
+ </tr>
+ <tr>
+ <td>virtual_power_type = virsh</td>
+ <td>(StrOpt) Base command to use for virtual power(vbox, virsh)</td>
+ </tr>
+ <tr>
+ <th colspan="2">[xenserver]</th>
+ </tr>
+ <tr>
+ <td>vif_driver = nova.virt.xenapi.vif.XenAPIBridgeDriver</td>
+ <td>(StrOpt) The XenAPI VIF driver using XenServer Network APIs.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-ca.xml b/doc/common/tables/nova-ca.xml
index 79842f2d09..08756a1865 100644
--- a/doc/common/tables/nova-ca.xml
+++ b/doc/common/tables/nova-ca.xml
@@ -1,78 +1,77 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_ca">
- <caption>Description of configuration options for ca</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>ca_file = cacert.pem</td>
- <td>(StrOpt) Filename of root CA</td>
- </tr>
- <tr>
- <td>ca_path = $state_path/CA</td>
- <td>(StrOpt) Where we keep our root CA</td>
- </tr>
- <tr>
- <td>cert_manager = nova.cert.manager.CertManager</td>
- <td>(StrOpt) Full class name for the Manager for cert</td>
- </tr>
- <tr>
- <td>cert_topic = cert</td>
- <td>(StrOpt) The topic cert nodes listen on</td>
- </tr>
- <tr>
- <td>crl_file = crl.pem</td>
- <td>(StrOpt) Filename of root Certificate Revocation List</td>
- </tr>
- <tr>
- <td>key_file = private/cakey.pem</td>
- <td>(StrOpt) Filename of private key</td>
- </tr>
- <tr>
- <td>keys_path = $state_path/keys</td>
- <td>(StrOpt) Where we keep our keys</td>
- </tr>
- <tr>
- <td>project_cert_subject = /C=US/ST=California/O=OpenStack/OU=NovaDev/CN=project-ca-%.16s-%s</td>
- <td>(StrOpt) Subject for certificate for projects, %s for project, timestamp</td>
- </tr>
- <tr>
- <td>use_project_ca = False</td>
- <td>(BoolOpt) Should we use a CA for each project?</td>
- </tr>
- <tr>
- <td>user_cert_subject = /C=US/ST=California/O=OpenStack/OU=NovaDev/CN=%.16s-%.16s-%s</td>
- <td>(StrOpt) Subject for certificate for users, %s for project, user, timestamp</td>
- </tr>
- <tr>
- <th colspan="2">[ssl]</th>
- </tr>
- <tr>
- <td>ca_file = None</td>
- <td>(StrOpt) CA certificate file to use to verify connecting clients.</td>
- </tr>
- <tr>
- <td>cert_file = None</td>
- <td>(StrOpt) Certificate file to use when starting the server securely.</td>
- </tr>
- <tr>
- <td>key_file = None</td>
- <td>(StrOpt) Private key file to use when starting the server securely.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_ca">
+ <caption>Description of configuration options for ca</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>ca_file = cacert.pem</td>
+ <td>(StrOpt) Filename of root CA</td>
+ </tr>
+ <tr>
+ <td>ca_path = $state_path/CA</td>
+ <td>(StrOpt) Where we keep our root CA</td>
+ </tr>
+ <tr>
+ <td>cert_manager = nova.cert.manager.CertManager</td>
+ <td>(StrOpt) Full class name for the Manager for cert</td>
+ </tr>
+ <tr>
+ <td>cert_topic = cert</td>
+ <td>(StrOpt) The topic cert nodes listen on</td>
+ </tr>
+ <tr>
+ <td>crl_file = crl.pem</td>
+ <td>(StrOpt) Filename of root Certificate Revocation List</td>
+ </tr>
+ <tr>
+ <td>key_file = private/cakey.pem</td>
+ <td>(StrOpt) Filename of private key</td>
+ </tr>
+ <tr>
+ <td>keys_path = $state_path/keys</td>
+ <td>(StrOpt) Where we keep our keys</td>
+ </tr>
+ <tr>
+ <td>project_cert_subject = /C=US/ST=California/O=OpenStack/OU=NovaDev/CN=project-ca-%.16s-%s</td>
+ <td>(StrOpt) Subject for certificate for projects, %s for project, timestamp</td>
+ </tr>
+ <tr>
+ <td>use_project_ca = False</td>
+ <td>(BoolOpt) Should we use a CA for each project?</td>
+ </tr>
+ <tr>
+ <td>user_cert_subject = /C=US/ST=California/O=OpenStack/OU=NovaDev/CN=%.16s-%.16s-%s</td>
+ <td>(StrOpt) Subject for certificate for users, %s for project, user, timestamp</td>
+ </tr>
+ <tr>
+ <th colspan="2">[ssl]</th>
+ </tr>
+ <tr>
+ <td>ca_file = None</td>
+ <td>(StrOpt) CA certificate file to use to verify connecting clients.</td>
+ </tr>
+ <tr>
+ <td>cert_file = None</td>
+ <td>(StrOpt) Certificate file to use when starting the server securely.</td>
+ </tr>
+ <tr>
+ <td>key_file = None</td>
+ <td>(StrOpt) Private key file to use when starting the server securely.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-cells.xml b/doc/common/tables/nova-cells.xml
index d8c1974384..b4c447b84f 100644
--- a/doc/common/tables/nova-cells.xml
+++ b/doc/common/tables/nova-cells.xml
@@ -1,91 +1,94 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_cells">
- <caption>Description of configuration options for cells</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">[cells]</th>
- </tr>
- <tr>
- <td>call_timeout = 60</td>
- <td>(IntOpt) Seconds to wait for response from a call to a cell.</td>
- </tr>
- <tr>
- <td>capabilities = hypervisor=xenserver;kvm, os=linux;windows</td>
- <td>(ListOpt) Key/Multi-value list with the capabilities of the cell</td>
- </tr>
- <tr>
- <td>cell_type = compute</td>
- <td>(StrOpt) Type of cell: api or compute</td>
- </tr>
- <tr>
- <td>cells_config = None</td>
- <td>(StrOpt) Configuration file from which to read cells configuration. If given, overrides reading cells from the database.</td>
- </tr>
- <tr>
- <td>driver = nova.cells.rpc_driver.CellsRPCDriver</td>
- <td>(StrOpt) Cells communication driver to use</td>
- </tr>
- <tr>
- <td>enable = False</td>
- <td>(BoolOpt) Enable cell functionality</td>
- </tr>
- <tr>
- <td>instance_update_num_instances = 1</td>
- <td>(IntOpt) Number of instances to update per periodic task run</td>
- </tr>
- <tr>
- <td>instance_updated_at_threshold = 3600</td>
- <td>(IntOpt) Number of seconds after an instance was updated or deleted to continue to update cells</td>
- </tr>
- <tr>
- <td>manager = nova.cells.manager.CellsManager</td>
- <td>(StrOpt) Manager for cells</td>
- </tr>
- <tr>
- <td>max_hop_count = 10</td>
- <td>(IntOpt) Maximum number of hops for cells routing.</td>
- </tr>
- <tr>
- <td>mute_child_interval = 300</td>
- <td>(IntOpt) Number of seconds after which a lack of capability and capacity updates signals the child cell is to be treated as a mute.</td>
- </tr>
- <tr>
- <td>mute_weight_multiplier = -10.0</td>
- <td>(FloatOpt) Multiplier used to weigh mute children. (The value should be negative.)</td>
- </tr>
- <tr>
- <td>mute_weight_value = 1000.0</td>
- <td>(FloatOpt) Weight value assigned to mute children. (The value should be positive.)</td>
- </tr>
- <tr>
- <td>name = nova</td>
- <td>(StrOpt) Name of this cell</td>
- </tr>
- <tr>
- <td>offset_weight_multiplier = 1.0</td>
- <td>(FloatOpt) Multiplier used to weigh offset weigher.</td>
- </tr>
- <tr>
- <td>reserve_percent = 10.0</td>
- <td>(FloatOpt) Percentage of cell capacity to hold in reserve. Affects both memory and disk utilization</td>
- </tr>
- <tr>
- <td>topic = cells</td>
- <td>(StrOpt) The topic cells nodes listen on</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_cells">
+ <caption>Description of configuration options for cells</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">[cells]</th>
+ </tr>
+ <tr>
+ <td>call_timeout = 60</td>
+ <td>(IntOpt) Seconds to wait for response from a call to a cell.</td>
+ </tr>
+ <tr>
+ <td>capabilities = hypervisor=xenserver;kvm, os=linux;windows</td>
+ <td>(ListOpt) Key/Multi-value list with the capabilities of the cell</td>
+ </tr>
+ <tr>
+ <td>cell_type = compute</td>
+ <td>(StrOpt) Type of cell: api or compute</td>
+ </tr>
+ <tr>
+ <td>cells_config = None</td>
+ <td>(StrOpt) Configuration file from which to read cells configuration. If given, overrides reading cells from the database.</td>
+ </tr>
+ <tr>
+ <td>db_check_interval = 60</td>
+ <td>(IntOpt) Interval, in seconds, for getting fresh cell information from the database.</td>
+ </tr>
+ <tr>
+ <td>driver = nova.cells.rpc_driver.CellsRPCDriver</td>
+ <td>(StrOpt) Cells communication driver to use</td>
+ </tr>
+ <tr>
+ <td>enable = False</td>
+ <td>(BoolOpt) Enable cell functionality</td>
+ </tr>
+ <tr>
+ <td>instance_update_num_instances = 1</td>
+ <td>(IntOpt) Number of instances to update per periodic task run</td>
+ </tr>
+ <tr>
+ <td>instance_updated_at_threshold = 3600</td>
+ <td>(IntOpt) Number of seconds after an instance was updated or deleted to continue to update cells</td>
+ </tr>
+ <tr>
+ <td>manager = nova.cells.manager.CellsManager</td>
+ <td>(StrOpt) Manager for cells</td>
+ </tr>
+ <tr>
+ <td>max_hop_count = 10</td>
+ <td>(IntOpt) Maximum number of hops for cells routing.</td>
+ </tr>
+ <tr>
+ <td>mute_child_interval = 300</td>
+ <td>(IntOpt) Number of seconds after which a lack of capability and capacity updates signals the child cell is to be treated as a mute.</td>
+ </tr>
+ <tr>
+ <td>mute_weight_multiplier = -10.0</td>
+ <td>(FloatOpt) Multiplier used to weigh mute children. (The value should be negative.)</td>
+ </tr>
+ <tr>
+ <td>mute_weight_value = 1000.0</td>
+ <td>(FloatOpt) Weight value assigned to mute children. (The value should be positive.)</td>
+ </tr>
+ <tr>
+ <td>name = nova</td>
+ <td>(StrOpt) Name of this cell</td>
+ </tr>
+ <tr>
+ <td>offset_weight_multiplier = 1.0</td>
+ <td>(FloatOpt) Multiplier used to weigh offset weigher.</td>
+ </tr>
+ <tr>
+ <td>reserve_percent = 10.0</td>
+ <td>(FloatOpt) Percentage of cell capacity to hold in reserve. Affects both memory and disk utilization</td>
+ </tr>
+ <tr>
+ <td>topic = cells</td>
+ <td>(StrOpt) The topic cells nodes listen on</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-common.xml b/doc/common/tables/nova-common.xml
index 09ee2c1a11..6b15f4a0a2 100644
--- a/doc/common/tables/nova-common.xml
+++ b/doc/common/tables/nova-common.xml
@@ -1,107 +1,106 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_common">
- <caption>Description of configuration options for common</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>bindir = /usr/local/bin</td>
- <td>(StrOpt) Directory where nova binaries are installed</td>
- </tr>
- <tr>
- <td>compute_topic = compute</td>
- <td>(StrOpt) The topic compute nodes listen on</td>
- </tr>
- <tr>
- <td>console_topic = console</td>
- <td>(StrOpt) The topic console proxy nodes listen on</td>
- </tr>
- <tr>
- <td>consoleauth_topic = consoleauth</td>
- <td>(StrOpt) The topic console auth proxy nodes listen on</td>
- </tr>
- <tr>
- <td>disable_process_locking = False</td>
- <td>(BoolOpt) Whether to disable inter-process locks</td>
- </tr>
- <tr>
- <td>host = oslo</td>
- <td>(StrOpt) Name of this node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address. However, the node name must be valid within an AMQP key, and if using ZeroMQ, a valid hostname, FQDN, or IP address</td>
- </tr>
- <tr>
- <td>lock_path = None</td>
- <td>(StrOpt) Directory to use for lock files.</td>
- </tr>
- <tr>
- <td>memcached_servers = None</td>
- <td>(ListOpt) Memcached servers or None for in process cache.</td>
- </tr>
- <tr>
- <td>my_ip = 10.0.0.1</td>
- <td>(StrOpt) IP address of this host</td>
- </tr>
- <tr>
- <td>notification_driver = []</td>
- <td>(MultiStrOpt) Driver or drivers to handle sending notifications.</td>
- </tr>
- <tr>
- <td>notification_topics = notifications</td>
- <td>(ListOpt) AMQP topic used for OpenStack notifications.</td>
- </tr>
- <tr>
- <td>notify_api_faults = False</td>
- <td>(BoolOpt) If set, send api.fault notifications on caught exceptions in the API service.</td>
- </tr>
- <tr>
- <td>notify_on_state_change = None</td>
- <td>(StrOpt) If set, send compute.instance.update notifications on instance state changes. Valid values are None for no notifications, "vm_state" for notifications on VM state changes, or "vm_and_task_state" for notifications on VM and task state changes.</td>
- </tr>
- <tr>
- <td>port = 6379</td>
- <td>(IntOpt) Use this port to connect to redis host.</td>
- </tr>
- <tr>
- <td>pybasedir = /usr/lib/python/site-packages</td>
- <td>(StrOpt) Directory where the nova python module is installed</td>
- </tr>
- <tr>
- <td>report_interval = 10</td>
- <td>(IntOpt) Seconds between nodes reporting state to datastore</td>
- </tr>
- <tr>
- <td>rootwrap_config = /etc/nova/rootwrap.conf</td>
- <td>(StrOpt) Path to the rootwrap configuration file to use for running commands as root</td>
- </tr>
- <tr>
- <td>service_down_time = 60</td>
- <td>(IntOpt) Maximum time since last check-in for up service</td>
- </tr>
- <tr>
- <td>state_path = $pybasedir</td>
- <td>(StrOpt) Top-level directory for maintaining nova's state</td>
- </tr>
- <tr>
- <td>tempdir = None</td>
- <td>(StrOpt) Explicitly specify the temporary working directory</td>
- </tr>
- <tr>
- <td>transport_url = None</td>
- <td>(StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_common">
+ <caption>Description of configuration options for common</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>bindir = /usr/local/local/bin</td>
+ <td>(StrOpt) Directory where nova binaries are installed</td>
+ </tr>
+ <tr>
+ <td>compute_topic = compute</td>
+ <td>(StrOpt) The topic compute nodes listen on</td>
+ </tr>
+ <tr>
+ <td>console_topic = console</td>
+ <td>(StrOpt) The topic console proxy nodes listen on</td>
+ </tr>
+ <tr>
+ <td>consoleauth_topic = consoleauth</td>
+ <td>(StrOpt) The topic console auth proxy nodes listen on</td>
+ </tr>
+ <tr>
+ <td>disable_process_locking = False</td>
+ <td>(BoolOpt) Whether to disable inter-process locks</td>
+ </tr>
+ <tr>
+ <td>host = oslo</td>
+ <td>(StrOpt) Name of this node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address. However, the node name must be valid within an AMQP key, and if using ZeroMQ, a valid hostname, FQDN, or IP address</td>
+ </tr>
+ <tr>
+ <td>lock_path = None</td>
+ <td>(StrOpt) Directory to use for lock files.</td>
+ </tr>
+ <tr>
+ <td>memcached_servers = None</td>
+ <td>(ListOpt) Memcached servers or None for in process cache.</td>
+ </tr>
+ <tr>
+ <td>my_ip = 10.0.0.1</td>
+ <td>(StrOpt) IP address of this host</td>
+ </tr>
+ <tr>
+ <td>notification_driver = []</td>
+ <td>(MultiStrOpt) Driver or drivers to handle sending notifications.</td>
+ </tr>
+ <tr>
+ <td>notification_topics = notifications</td>
+ <td>(ListOpt) AMQP topic used for OpenStack notifications.</td>
+ </tr>
+ <tr>
+ <td>notify_api_faults = False</td>
+ <td>(BoolOpt) If set, send api.fault notifications on caught exceptions in the API service.</td>
+ </tr>
+ <tr>
+ <td>notify_on_state_change = None</td>
+ <td>(StrOpt) If set, send compute.instance.update notifications on instance state changes. Valid values are None for no notifications, "vm_state" for notifications on VM state changes, or "vm_and_task_state" for notifications on VM and task state changes.</td>
+ </tr>
+ <tr>
+ <td>port = 6379</td>
+ <td>(IntOpt) Use this port to connect to redis host.</td>
+ </tr>
+ <tr>
+ <td>pybasedir = /usr/lib/python/site-packages/sources/nova</td>
+ <td>(StrOpt) Directory where the nova python module is installed</td>
+ </tr>
+ <tr>
+ <td>report_interval = 10</td>
+ <td>(IntOpt) Seconds between nodes reporting state to datastore</td>
+ </tr>
+ <tr>
+ <td>rootwrap_config = /etc/nova/rootwrap.conf</td>
+ <td>(StrOpt) Path to the rootwrap configuration file to use for running commands as root</td>
+ </tr>
+ <tr>
+ <td>service_down_time = 60</td>
+ <td>(IntOpt) Maximum time since last check-in for up service</td>
+ </tr>
+ <tr>
+ <td>state_path = $pybasedir</td>
+ <td>(StrOpt) Top-level directory for maintaining nova's state</td>
+ </tr>
+ <tr>
+ <td>tempdir = None</td>
+ <td>(StrOpt) Explicitly specify the temporary working directory</td>
+ </tr>
+ <tr>
+ <td>transport_url = None</td>
+ <td>(StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-compute.xml b/doc/common/tables/nova-compute.xml
index c8b3573423..eb3b1f757d 100644
--- a/doc/common/tables/nova-compute.xml
+++ b/doc/common/tables/nova-compute.xml
@@ -1,155 +1,150 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_compute">
- <caption>Description of configuration options for compute</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>compute_available_monitors = ['nova.compute.monitors.all_monitors']</td>
- <td>(MultiStrOpt) Monitor classes available to the compute which may be specified more than once.</td>
- </tr>
- <tr>
- <td>compute_driver = None</td>
- <td>(StrOpt) Driver to use for controlling virtualization. Options include: libvirt.LibvirtDriver, xenapi.XenAPIDriver, fake.FakeDriver, baremetal.BareMetalDriver, vmwareapi.VMwareESXDriver, vmwareapi.VMwareVCDriver</td>
- </tr>
- <tr>
- <td>compute_manager = nova.compute.manager.ComputeManager</td>
- <td>(StrOpt) Full class name for the Manager for compute</td>
- </tr>
- <tr>
- <td>compute_monitors = </td>
- <td>(ListOpt) A list of monitors that can be used for getting compute metrics.</td>
- </tr>
- <tr>
- <td>compute_stats_class = nova.compute.stats.Stats</td>
- <td>(StrOpt) Class that will manage stats for the local compute host</td>
- </tr>
- <tr>
- <td>console_host = oslo</td>
- <td>(StrOpt) Console proxy host to use to connect to instances on this host.</td>
- </tr>
- <tr>
- <td>console_manager = nova.console.manager.ConsoleProxyManager</td>
- <td>(StrOpt) Full class name for the Manager for console proxy</td>
- </tr>
- <tr>
- <td>default_flavor = m1.small</td>
- <td>(StrOpt) Default flavor to use for the EC2 API only. The Nova API does not support a default flavor.</td>
- </tr>
- <tr>
- <td>default_notification_level = INFO</td>
- <td>(StrOpt) Default notification level for outgoing notifications</td>
- </tr>
- <tr>
- <td>default_publisher_id = None</td>
- <td>(StrOpt) Default publisher_id for outgoing notifications</td>
- </tr>
- <tr>
- <td>enable_instance_password = True</td>
- <td>(BoolOpt) Enables returning of the instance password by the relevant server API calls such as create, rebuild or rescue, If the hypervisor does not support password injection then the password returned will not be correct</td>
- </tr>
- <tr>
- <td>heal_instance_info_cache_interval = 60</td>
- <td>(IntOpt) Number of seconds between instance info_cache self healing updates</td>
- </tr>
- <tr>
- <td>image_cache_manager_interval = 2400</td>
- <td>(IntOpt) Number of seconds to wait between runs of the image cache manager</td>
- </tr>
- <tr>
- <td>image_cache_subdirectory_name = _base</td>
- <td>(StrOpt) Where cached images are stored under $instances_path. This is NOT the full path - just a folder name. For per-compute-host cached images, set to _base_$my_ip</td>
- </tr>
- <tr>
- <td>image_handlers = download</td>
- <td>(ListOpt) Specifies which image handler extension names to use for handling images. The first extension in the list which can handle the image with a suitable location will be used.</td>
- </tr>
- <tr>
- <td>instance_build_timeout = 0</td>
- <td>(IntOpt) Amount of time in seconds an instance can be in BUILD before going into ERROR status.Set to 0 to disable.</td>
- </tr>
- <tr>
- <td>instance_delete_interval = 300</td>
- <td>(IntOpt) Interval in seconds for retrying failed instance file deletes</td>
- </tr>
- <tr>
- <td>instance_usage_audit = False</td>
- <td>(BoolOpt) Generate periodic compute.instance.exists notifications</td>
- </tr>
- <tr>
- <td>instance_usage_audit_period = month</td>
- <td>(StrOpt) Time period to generate instance usages for. Time period must be hour, day, month or year</td>
- </tr>
- <tr>
- <td>instances_path = $state_path/instances</td>
- <td>(StrOpt) Where instances are stored on disk</td>
- </tr>
- <tr>
- <td>maximum_instance_delete_attempts = 5</td>
- <td>(IntOpt) The number of times to attempt to reap an instance's files.</td>
- </tr>
- <tr>
- <td>reboot_timeout = 0</td>
- <td>(IntOpt) Automatically hard reboot an instance if it has been stuck in a rebooting state longer than N seconds. Set to 0 to disable.</td>
- </tr>
- <tr>
- <td>reclaim_instance_interval = 0</td>
- <td>(IntOpt) Interval in seconds for reclaiming deleted instances</td>
- </tr>
- <tr>
- <td>resize_confirm_window = 0</td>
- <td>(IntOpt) Automatically confirm resizes after N seconds. Set to 0 to disable.</td>
- </tr>
- <tr>
- <td>resume_guests_state_on_host_boot = False</td>
- <td>(BoolOpt) Whether to start guests that were running before the host rebooted</td>
- </tr>
- <tr>
- <td>running_deleted_instance_action = reap</td>
- <td>(StrOpt) Action to take if a running deleted instance is detected.Valid options are 'noop', 'log', 'shutdown', or 'reap'. Set to 'noop' to take no action.</td>
- </tr>
- <tr>
- <td>running_deleted_instance_poll_interval = 1800</td>
- <td>(IntOpt) Number of seconds to wait between runs of the cleanup task.</td>
- </tr>
- <tr>
- <td>running_deleted_instance_timeout = 0</td>
- <td>(IntOpt) Number of seconds after being deleted when a running instance should be considered eligible for cleanup.</td>
- </tr>
- <tr>
- <td>shelved_offload_time = 0</td>
- <td>(IntOpt) Time in seconds before a shelved instance is eligible for removing from a host. -1 never offload, 0 offload when shelved</td>
- </tr>
- <tr>
- <td>shelved_poll_interval = 3600</td>
- <td>(IntOpt) Interval in seconds for polling shelved instances to offload</td>
- </tr>
- <tr>
- <td>sync_power_state_interval = 600</td>
- <td>(IntOpt) Interval to sync power states between the database and the hypervisor</td>
- </tr>
- <tr>
- <td>vif_plugging_is_fatal = True</td>
- <td>(BoolOpt) Fail instance boot if vif plugging fails</td>
- </tr>
- <tr>
- <td>vif_plugging_timeout = 300</td>
- <td>(IntOpt) Number of seconds to wait for neutron vif plugging events to arrive before continuing or failing (see vif_plugging_is_fatal). If this is set to zero and vif_plugging_is_fatal is False, events should not be expected to arrive at all.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_compute">
+ <caption>Description of configuration options for compute</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>compute_available_monitors = ['nova.compute.monitors.all_monitors']</td>
+ <td>(MultiStrOpt) Monitor classes available to the compute which may be specified more than once.</td>
+ </tr>
+ <tr>
+ <td>compute_driver = None</td>
+ <td>(StrOpt) Driver to use for controlling virtualization. Options include: libvirt.LibvirtDriver, xenapi.XenAPIDriver, fake.FakeDriver, baremetal.BareMetalDriver, vmwareapi.VMwareVCDriver</td>
+ </tr>
+ <tr>
+ <td>compute_manager = nova.compute.manager.ComputeManager</td>
+ <td>(StrOpt) Full class name for the Manager for compute</td>
+ </tr>
+ <tr>
+ <td>compute_monitors = </td>
+ <td>(ListOpt) A list of monitors that can be used for getting compute metrics.</td>
+ </tr>
+ <tr>
+ <td>compute_stats_class = nova.compute.stats.Stats</td>
+ <td>(StrOpt) Class that will manage stats for the local compute host</td>
+ </tr>
+ <tr>
+ <td>console_host = oslo</td>
+ <td>(StrOpt) Console proxy host to use to connect to instances on this host.</td>
+ </tr>
+ <tr>
+ <td>console_manager = nova.console.manager.ConsoleProxyManager</td>
+ <td>(StrOpt) Full class name for the Manager for console proxy</td>
+ </tr>
+ <tr>
+ <td>default_flavor = m1.small</td>
+ <td>(StrOpt) Default flavor to use for the EC2 API only. The Nova API does not support a default flavor.</td>
+ </tr>
+ <tr>
+ <td>default_notification_level = INFO</td>
+ <td>(StrOpt) Default notification level for outgoing notifications</td>
+ </tr>
+ <tr>
+ <td>default_publisher_id = None</td>
+ <td>(StrOpt) Default publisher_id for outgoing notifications</td>
+ </tr>
+ <tr>
+ <td>enable_instance_password = True</td>
+ <td>(BoolOpt) Enables returning of the instance password by the relevant server API calls such as create, rebuild or rescue, If the hypervisor does not support password injection then the password returned will not be correct</td>
+ </tr>
+ <tr>
+ <td>heal_instance_info_cache_interval = 60</td>
+ <td>(IntOpt) Number of seconds between instance info_cache self healing updates</td>
+ </tr>
+ <tr>
+ <td>image_cache_manager_interval = 2400</td>
+ <td>(IntOpt) Number of seconds to wait between runs of the image cache manager. Set to -1 to disable. Setting this to 0 will disable, but this will change in the K release to mean "run at the default rate".</td>
+ </tr>
+ <tr>
+ <td>image_cache_subdirectory_name = _base</td>
+ <td>(StrOpt) Where cached images are stored under $instances_path. This is NOT the full path - just a folder name. For per-compute-host cached images, set to _base_$my_ip</td>
+ </tr>
+ <tr>
+ <td>instance_build_timeout = 0</td>
+ <td>(IntOpt) Amount of time in seconds an instance can be in BUILD before going into ERROR status.Set to 0 to disable.</td>
+ </tr>
+ <tr>
+ <td>instance_delete_interval = 300</td>
+ <td>(IntOpt) Interval in seconds for retrying failed instance file deletes</td>
+ </tr>
+ <tr>
+ <td>instance_usage_audit = False</td>
+ <td>(BoolOpt) Generate periodic compute.instance.exists notifications</td>
+ </tr>
+ <tr>
+ <td>instance_usage_audit_period = month</td>
+ <td>(StrOpt) Time period to generate instance usages for. Time period must be hour, day, month or year</td>
+ </tr>
+ <tr>
+ <td>instances_path = $state_path/instances</td>
+ <td>(StrOpt) Where instances are stored on disk</td>
+ </tr>
+ <tr>
+ <td>maximum_instance_delete_attempts = 5</td>
+ <td>(IntOpt) The number of times to attempt to reap an instance's files.</td>
+ </tr>
+ <tr>
+ <td>reboot_timeout = 0</td>
+ <td>(IntOpt) Automatically hard reboot an instance if it has been stuck in a rebooting state longer than N seconds. Set to 0 to disable.</td>
+ </tr>
+ <tr>
+ <td>reclaim_instance_interval = 0</td>
+ <td>(IntOpt) Interval in seconds for reclaiming deleted instances</td>
+ </tr>
+ <tr>
+ <td>resize_confirm_window = 0</td>
+ <td>(IntOpt) Automatically confirm resizes after N seconds. Set to 0 to disable.</td>
+ </tr>
+ <tr>
+ <td>resume_guests_state_on_host_boot = False</td>
+ <td>(BoolOpt) Whether to start guests that were running before the host rebooted</td>
+ </tr>
+ <tr>
+ <td>running_deleted_instance_action = reap</td>
+ <td>(StrOpt) Action to take if a running deleted instance is detected.Valid options are 'noop', 'log', 'shutdown', or 'reap'. Set to 'noop' to take no action.</td>
+ </tr>
+ <tr>
+ <td>running_deleted_instance_poll_interval = 1800</td>
+ <td>(IntOpt) Number of seconds to wait between runs of the cleanup task.</td>
+ </tr>
+ <tr>
+ <td>running_deleted_instance_timeout = 0</td>
+ <td>(IntOpt) Number of seconds after being deleted when a running instance should be considered eligible for cleanup.</td>
+ </tr>
+ <tr>
+ <td>shelved_offload_time = 0</td>
+ <td>(IntOpt) Time in seconds before a shelved instance is eligible for removing from a host. -1 never offload, 0 offload when shelved</td>
+ </tr>
+ <tr>
+ <td>shelved_poll_interval = 3600</td>
+ <td>(IntOpt) Interval in seconds for polling shelved instances to offload. Set to -1 to disable.Setting this to 0 will disable, but this will change in Juno to mean "run at the default rate".</td>
+ </tr>
+ <tr>
+ <td>sync_power_state_interval = 600</td>
+ <td>(IntOpt) Interval to sync power states between the database and the hypervisor. Set to -1 to disable. Setting this to 0 will disable, but this will change in Juno to mean "run at the default rate".</td>
+ </tr>
+ <tr>
+ <td>vif_plugging_is_fatal = True</td>
+ <td>(BoolOpt) Fail instance boot if vif plugging fails</td>
+ </tr>
+ <tr>
+ <td>vif_plugging_timeout = 300</td>
+ <td>(IntOpt) Number of seconds to wait for neutron vif plugging events to arrive before continuing or failing (see vif_plugging_is_fatal). If this is set to zero and vif_plugging_is_fatal is False, events should not be expected to arrive at all.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-conductor.xml b/doc/common/tables/nova-conductor.xml
index 8198e8dc7d..ca643c5b03 100644
--- a/doc/common/tables/nova-conductor.xml
+++ b/doc/common/tables/nova-conductor.xml
@@ -1,46 +1,45 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_conductor">
- <caption>Description of configuration options for conductor</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>migrate_max_retries = -1</td>
- <td>(IntOpt) Number of times to retry live-migration before failing. If == -1, try until out of hosts. If == 0, only try once, no retries.</td>
- </tr>
- <tr>
- <th colspan="2">[conductor]</th>
- </tr>
- <tr>
- <td>manager = nova.conductor.manager.ConductorManager</td>
- <td>(StrOpt) Full class name for the Manager for conductor</td>
- </tr>
- <tr>
- <td>topic = conductor</td>
- <td>(StrOpt) The topic on which conductor nodes listen</td>
- </tr>
- <tr>
- <td>use_local = False</td>
- <td>(BoolOpt) Perform nova-conductor operations locally</td>
- </tr>
- <tr>
- <td>workers = None</td>
- <td>(IntOpt) Number of workers for OpenStack Conductor service. The default will be the number of CPUs available.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_conductor">
+ <caption>Description of configuration options for conductor</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>migrate_max_retries = -1</td>
+ <td>(IntOpt) Number of times to retry live-migration before failing. If == -1, try until out of hosts. If == 0, only try once, no retries.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[conductor]</th>
+ </tr>
+ <tr>
+ <td>manager = nova.conductor.manager.ConductorManager</td>
+ <td>(StrOpt) Full class name for the Manager for conductor</td>
+ </tr>
+ <tr>
+ <td>topic = conductor</td>
+ <td>(StrOpt) The topic on which conductor nodes listen</td>
+ </tr>
+ <tr>
+ <td>use_local = False</td>
+ <td>(BoolOpt) Perform nova-conductor operations locally</td>
+ </tr>
+ <tr>
+ <td>workers = None</td>
+ <td>(IntOpt) Number of workers for OpenStack Conductor service. The default will be the number of CPUs available.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-configdrive.xml b/doc/common/tables/nova-configdrive.xml
index 2a9bae274f..3e8306cd5b 100644
--- a/doc/common/tables/nova-configdrive.xml
+++ b/doc/common/tables/nova-configdrive.xml
@@ -1,54 +1,53 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_configdrive">
- <caption>Description of configuration options for configdrive</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>config_drive_format = iso9660</td>
- <td>(StrOpt) Config drive format. One of iso9660 (default) or vfat</td>
- </tr>
- <tr>
- <td>config_drive_skip_versions = 1.0 2007-01-19 2007-03-01 2007-08-29 2007-10-10 2007-12-15 2008-02-01 2008-09-01</td>
- <td>(StrOpt) List of metadata versions to skip placing into the config drive</td>
- </tr>
- <tr>
- <td>config_drive_tempdir = None</td>
- <td>(StrOpt) Where to put temporary files associated with config drive creation</td>
- </tr>
- <tr>
- <td>force_config_drive = None</td>
- <td>(StrOpt) Set to force injection to take place on a config drive (if set, valid options are: always)</td>
- </tr>
- <tr>
- <td>mkisofs_cmd = genisoimage</td>
- <td>(StrOpt) Name and optionally path of the tool used for ISO image creation</td>
- </tr>
- <tr>
- <th colspan="2">[hyperv]</th>
- </tr>
- <tr>
- <td>config_drive_cdrom = False</td>
- <td>(BoolOpt) Attaches the Config Drive image as a cdrom drive instead of a disk drive</td>
- </tr>
- <tr>
- <td>config_drive_inject_password = False</td>
- <td>(BoolOpt) Sets the admin password in the config drive image</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_configdrive">
+ <caption>Description of configuration options for configdrive</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>config_drive_format = iso9660</td>
+ <td>(StrOpt) Config drive format. One of iso9660 (default) or vfat</td>
+ </tr>
+ <tr>
+ <td>config_drive_skip_versions = 1.0 2007-01-19 2007-03-01 2007-08-29 2007-10-10 2007-12-15 2008-02-01 2008-09-01</td>
+ <td>(StrOpt) List of metadata versions to skip placing into the config drive</td>
+ </tr>
+ <tr>
+ <td>config_drive_tempdir = None</td>
+ <td>(StrOpt) Where to put temporary files associated with config drive creation</td>
+ </tr>
+ <tr>
+ <td>force_config_drive = None</td>
+ <td>(StrOpt) Set to force injection to take place on a config drive (if set, valid options are: always)</td>
+ </tr>
+ <tr>
+ <td>mkisofs_cmd = genisoimage</td>
+ <td>(StrOpt) Name and optionally path of the tool used for ISO image creation</td>
+ </tr>
+ <tr>
+ <th colspan="2">[hyperv]</th>
+ </tr>
+ <tr>
+ <td>config_drive_cdrom = False</td>
+ <td>(BoolOpt) Attaches the Config Drive image as a cdrom drive instead of a disk drive</td>
+ </tr>
+ <tr>
+ <td>config_drive_inject_password = False</td>
+ <td>(BoolOpt) Sets the admin password in the config drive image</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-console.xml b/doc/common/tables/nova-console.xml
index fda487ef60..dff8674984 100644
--- a/doc/common/tables/nova-console.xml
+++ b/doc/common/tables/nova-console.xml
@@ -1,35 +1,34 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_console">
- <caption>Description of configuration options for console</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>console_public_hostname = oslo</td>
- <td>(StrOpt) Publicly visible name for this console host</td>
- </tr>
- <tr>
- <td>console_token_ttl = 600</td>
- <td>(IntOpt) How many seconds before deleting tokens</td>
- </tr>
- <tr>
- <td>consoleauth_manager = nova.consoleauth.manager.ConsoleAuthManager</td>
- <td>(StrOpt) Manager for console auth</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_console">
+ <caption>Description of configuration options for console</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>console_public_hostname = oslo</td>
+ <td>(StrOpt) Publicly visible name for this console host</td>
+ </tr>
+ <tr>
+ <td>console_token_ttl = 600</td>
+ <td>(IntOpt) How many seconds before deleting tokens</td>
+ </tr>
+ <tr>
+ <td>consoleauth_manager = nova.consoleauth.manager.ConsoleAuthManager</td>
+ <td>(StrOpt) Manager for console auth</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-database.xml b/doc/common/tables/nova-database.xml
new file mode 100644
index 0000000000..a6de02c2a5
--- /dev/null
+++ b/doc/common/tables/nova-database.xml
@@ -0,0 +1,113 @@
+<?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_nova_database">
+ <caption>Description of configuration options for database</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>db_driver = nova.db</td>
+ <td>(StrOpt) The driver to use for database access</td>
+ </tr>
+ <tr>
+ <th colspan="2">[database]</th>
+ </tr>
+ <tr>
+ <td>backend = sqlalchemy</td>
+ <td>(StrOpt) The backend to use for db</td>
+ </tr>
+ <tr>
+ <td>connection = None</td>
+ <td>(StrOpt) The SQLAlchemy connection string used to connect to the database</td>
+ </tr>
+ <tr>
+ <td>connection_debug = 0</td>
+ <td>(IntOpt) Verbosity of SQL debugging information. 0=None, 100=Everything</td>
+ </tr>
+ <tr>
+ <td>connection_trace = False</td>
+ <td>(BoolOpt) Add python stack traces to SQL as comment strings</td>
+ </tr>
+ <tr>
+ <td>db_inc_retry_interval = True</td>
+ <td>(BoolOpt) Whether to increase interval between db connection retries, up to db_max_retry_interval</td>
+ </tr>
+ <tr>
+ <td>db_max_retries = 20</td>
+ <td>(IntOpt) maximum db connection retries before error is raised. (setting -1 implies an infinite retry count)</td>
+ </tr>
+ <tr>
+ <td>db_max_retry_interval = 10</td>
+ <td>(IntOpt) max seconds between db connection retries, if db_inc_retry_interval is enabled</td>
+ </tr>
+ <tr>
+ <td>db_retry_interval = 1</td>
+ <td>(IntOpt) seconds between db connection retries</td>
+ </tr>
+ <tr>
+ <td>idle_timeout = 3600</td>
+ <td>(IntOpt) Timeout before idle sql connections are reaped</td>
+ </tr>
+ <tr>
+ <td>max_overflow = None</td>
+ <td>(IntOpt) If set, use this value for max_overflow with sqlalchemy</td>
+ </tr>
+ <tr>
+ <td>max_pool_size = None</td>
+ <td>(IntOpt) Maximum number of SQL connections to keep open in a pool</td>
+ </tr>
+ <tr>
+ <td>max_retries = 10</td>
+ <td>(IntOpt) Maximum db connection retries during startup. (setting -1 implies an infinite retry count)</td>
+ </tr>
+ <tr>
+ <td>min_pool_size = 1</td>
+ <td>(IntOpt) Minimum number of SQL connections to keep open in a pool</td>
+ </tr>
+ <tr>
+ <td>mysql_sql_mode = TRADITIONAL</td>
+ <td>(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=</td>
+ </tr>
+ <tr>
+ <td>pool_timeout = None</td>
+ <td>(IntOpt) If set, use this value for pool_timeout with sqlalchemy</td>
+ </tr>
+ <tr>
+ <td>retry_interval = 10</td>
+ <td>(IntOpt) Interval between retries of opening a sql connection</td>
+ </tr>
+ <tr>
+ <td>slave_connection = None</td>
+ <td>(StrOpt) The SQLAlchemy connection string used to connect to the slave database</td>
+ </tr>
+ <tr>
+ <td>sqlite_db = nova.sqlite</td>
+ <td>(StrOpt) The file name to use with SQLite</td>
+ </tr>
+ <tr>
+ <td>sqlite_synchronous = True</td>
+ <td>(BoolOpt) If True, SQLite uses synchronous mode</td>
+ </tr>
+ <tr>
+ <td>use_db_reconnect = False</td>
+ <td>(BoolOpt) Enable the experimental use of database reconnect on connection lost</td>
+ </tr>
+ <tr>
+ <td>use_tpool = False</td>
+ <td>(BoolOpt) Enable the experimental use of thread pooling for all DB API calls</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-db.xml b/doc/common/tables/nova-db.xml
deleted file mode 100644
index 9fc955a00d..0000000000
--- a/doc/common/tables/nova-db.xml
+++ /dev/null
@@ -1,117 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_db">
- <caption>Description of configuration options for db</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>db_driver = nova.db</td>
- <td>(StrOpt) The driver to use for database access</td>
- </tr>
- <tr>
- <th colspan="2">[cells]</th>
- </tr>
- <tr>
- <td>db_check_interval = 60</td>
- <td>(IntOpt) Interval, in seconds, for getting fresh cell information from the database.</td>
- </tr>
- <tr>
- <th colspan="2">[database]</th>
- </tr>
- <tr>
- <td>backend = sqlalchemy</td>
- <td>(StrOpt) The backend to use for db</td>
- </tr>
- <tr>
- <td>connection = None</td>
- <td>(StrOpt) The SQLAlchemy connection string used to connect to the database</td>
- </tr>
- <tr>
- <td>connection_debug = 0</td>
- <td>(IntOpt) Verbosity of SQL debugging information. 0=None, 100=Everything</td>
- </tr>
- <tr>
- <td>connection_trace = False</td>
- <td>(BoolOpt) Add python stack traces to SQL as comment strings</td>
- </tr>
- <tr>
- <td>db_inc_retry_interval = True</td>
- <td>(BoolOpt) Whether to increase interval between db connection retries, up to db_max_retry_interval</td>
- </tr>
- <tr>
- <td>db_max_retries = 20</td>
- <td>(IntOpt) maximum db connection retries before error is raised. (setting -1 implies an infinite retry count)</td>
- </tr>
- <tr>
- <td>db_max_retry_interval = 10</td>
- <td>(IntOpt) max seconds between db connection retries, if db_inc_retry_interval is enabled</td>
- </tr>
- <tr>
- <td>db_retry_interval = 1</td>
- <td>(IntOpt) seconds between db connection retries</td>
- </tr>
- <tr>
- <td>idle_timeout = 3600</td>
- <td>(IntOpt) Timeout before idle sql connections are reaped</td>
- </tr>
- <tr>
- <td>max_overflow = None</td>
- <td>(IntOpt) If set, use this value for max_overflow with sqlalchemy</td>
- </tr>
- <tr>
- <td>max_pool_size = None</td>
- <td>(IntOpt) Maximum number of SQL connections to keep open in a pool</td>
- </tr>
- <tr>
- <td>max_retries = 10</td>
- <td>(IntOpt) Maximum db connection retries during startup. (setting -1 implies an infinite retry count)</td>
- </tr>
- <tr>
- <td>min_pool_size = 1</td>
- <td>(IntOpt) Minimum number of SQL connections to keep open in a pool</td>
- </tr>
- <tr>
- <td>mysql_sql_mode = None</td>
- <td>(StrOpt) The SQL mode to be used for MySQL sessions (default is empty, meaning do not override any server-side SQL mode setting)</td>
- </tr>
- <tr>
- <td>pool_timeout = None</td>
- <td>(IntOpt) If set, use this value for pool_timeout with sqlalchemy</td>
- </tr>
- <tr>
- <td>retry_interval = 10</td>
- <td>(IntOpt) Interval between retries of opening a sql connection</td>
- </tr>
- <tr>
- <td>slave_connection = None</td>
- <td>(StrOpt) The SQLAlchemy connection string used to connect to the slave database</td>
- </tr>
- <tr>
- <td>sqlite_db = nova.sqlite</td>
- <td>(StrOpt) The file name to use with SQLite</td>
- </tr>
- <tr>
- <td>sqlite_synchronous = True</td>
- <td>(BoolOpt) If True, SQLite uses synchronous mode</td>
- </tr>
- <tr>
- <td>use_db_reconnect = False</td>
- <td>(BoolOpt) Enable the experimental use of database reconnect on connection lost</td>
- </tr>
- </tbody>
- </table>
- </para>
diff --git a/doc/common/tables/nova-ec2.xml b/doc/common/tables/nova-ec2.xml
index 2a045e6b66..6af5a72bf5 100644
--- a/doc/common/tables/nova-ec2.xml
+++ b/doc/common/tables/nova-ec2.xml
@@ -1,87 +1,86 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_ec2">
- <caption>Description of configuration options for ec2</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>ec2_dmz_host = $my_ip</td>
- <td>(StrOpt) The internal IP address of the EC2 API server</td>
- </tr>
- <tr>
- <td>ec2_host = $my_ip</td>
- <td>(StrOpt) The IP address of the EC2 API server</td>
- </tr>
- <tr>
- <td>ec2_listen = 0.0.0.0</td>
- <td>(StrOpt) The IP address on which the EC2 API will listen.</td>
- </tr>
- <tr>
- <td>ec2_listen_port = 8773</td>
- <td>(IntOpt) The port on which the EC2 API will listen.</td>
- </tr>
- <tr>
- <td>ec2_path = /services/Cloud</td>
- <td>(StrOpt) The path prefix used to call the ec2 API server</td>
- </tr>
- <tr>
- <td>ec2_port = 8773</td>
- <td>(IntOpt) The port of the EC2 API server</td>
- </tr>
- <tr>
- <td>ec2_private_dns_show_ip = False</td>
- <td>(BoolOpt) Return the IP address as private dns hostname in describe instances</td>
- </tr>
- <tr>
- <td>ec2_scheme = http</td>
- <td>(StrOpt) The protocol to use when connecting to the EC2 API server (http, https)</td>
- </tr>
- <tr>
- <td>ec2_strict_validation = True</td>
- <td>(BoolOpt) Validate security group names according to EC2 specification</td>
- </tr>
- <tr>
- <td>ec2_timestamp_expiry = 300</td>
- <td>(IntOpt) Time in seconds before ec2 timestamp expires</td>
- </tr>
- <tr>
- <td>ec2_workers = None</td>
- <td>(IntOpt) Number of workers for EC2 API service. The default will be equal to the number of CPUs available.</td>
- </tr>
- <tr>
- <td>keystone_ec2_url = http://localhost:5000/v2.0/ec2tokens</td>
- <td>(StrOpt) URL to get token from ec2 request.</td>
- </tr>
- <tr>
- <td>lockout_attempts = 5</td>
- <td>(IntOpt) Number of failed auths before lockout.</td>
- </tr>
- <tr>
- <td>lockout_minutes = 15</td>
- <td>(IntOpt) Number of minutes to lockout if triggered.</td>
- </tr>
- <tr>
- <td>lockout_window = 15</td>
- <td>(IntOpt) Number of minutes for lockout window.</td>
- </tr>
- <tr>
- <td>region_list = </td>
- <td>(ListOpt) List of region=fqdn pairs separated by commas</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_ec2">
+ <caption>Description of configuration options for ec2</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>ec2_dmz_host = $my_ip</td>
+ <td>(StrOpt) The internal IP address of the EC2 API server</td>
+ </tr>
+ <tr>
+ <td>ec2_host = $my_ip</td>
+ <td>(StrOpt) The IP address of the EC2 API server</td>
+ </tr>
+ <tr>
+ <td>ec2_listen = 0.0.0.0</td>
+ <td>(StrOpt) The IP address on which the EC2 API will listen.</td>
+ </tr>
+ <tr>
+ <td>ec2_listen_port = 8773</td>
+ <td>(IntOpt) The port on which the EC2 API will listen.</td>
+ </tr>
+ <tr>
+ <td>ec2_path = /services/Cloud</td>
+ <td>(StrOpt) The path prefix used to call the ec2 API server</td>
+ </tr>
+ <tr>
+ <td>ec2_port = 8773</td>
+ <td>(IntOpt) The port of the EC2 API server</td>
+ </tr>
+ <tr>
+ <td>ec2_private_dns_show_ip = False</td>
+ <td>(BoolOpt) Return the IP address as private dns hostname in describe instances</td>
+ </tr>
+ <tr>
+ <td>ec2_scheme = http</td>
+ <td>(StrOpt) The protocol to use when connecting to the EC2 API server (http, https)</td>
+ </tr>
+ <tr>
+ <td>ec2_strict_validation = True</td>
+ <td>(BoolOpt) Validate security group names according to EC2 specification</td>
+ </tr>
+ <tr>
+ <td>ec2_timestamp_expiry = 300</td>
+ <td>(IntOpt) Time in seconds before ec2 timestamp expires</td>
+ </tr>
+ <tr>
+ <td>ec2_workers = None</td>
+ <td>(IntOpt) Number of workers for EC2 API service. The default will be equal to the number of CPUs available.</td>
+ </tr>
+ <tr>
+ <td>keystone_ec2_url = http://localhost:5000/v2.0/ec2tokens</td>
+ <td>(StrOpt) URL to get token from ec2 request.</td>
+ </tr>
+ <tr>
+ <td>lockout_attempts = 5</td>
+ <td>(IntOpt) Number of failed auths before lockout.</td>
+ </tr>
+ <tr>
+ <td>lockout_minutes = 15</td>
+ <td>(IntOpt) Number of minutes to lockout if triggered.</td>
+ </tr>
+ <tr>
+ <td>lockout_window = 15</td>
+ <td>(IntOpt) Number of minutes for lockout window.</td>
+ </tr>
+ <tr>
+ <td>region_list = </td>
+ <td>(ListOpt) List of region=fqdn pairs separated by commas</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-fping.xml b/doc/common/tables/nova-fping.xml
index c7105981b6..22c1e72a95 100644
--- a/doc/common/tables/nova-fping.xml
+++ b/doc/common/tables/nova-fping.xml
@@ -1,27 +1,26 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_fping">
- <caption>Description of configuration options for fping</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>fping_path = /usr/sbin/fping</td>
- <td>(StrOpt) Full path to fping.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_fping">
+ <caption>Description of configuration options for fping</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>fping_path = /usr/sbin/fping</td>
+ <td>(StrOpt) Full path to fping.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-glance.xml b/doc/common/tables/nova-glance.xml
index 3795227be0..82db25a7aa 100644
--- a/doc/common/tables/nova-glance.xml
+++ b/doc/common/tables/nova-glance.xml
@@ -1,62 +1,64 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_glance">
- <caption>Description of configuration options for glance</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>allowed_direct_url_schemes = </td>
- <td>(ListOpt) A list of url scheme that can be downloaded directly via the direct_url. Currently supported schemes: [file].</td>
- </tr>
- <tr>
- <td>glance_api_insecure = False</td>
- <td>(BoolOpt) Allow to perform insecure SSL (https) requests to glance</td>
- </tr>
- <tr>
- <td>glance_api_servers = $glance_host:$glance_port</td>
- <td>(ListOpt) A list of the glance api servers available to nova. Prefix with https:// for ssl-based glance api servers. ([hostname|ip]:port)</td>
- </tr>
- <tr>
- <td>glance_host = $my_ip</td>
- <td>(StrOpt) Default glance hostname or IP address</td>
- </tr>
- <tr>
- <td>glance_num_retries = 0</td>
- <td>(IntOpt) Number of retries when downloading an image from glance</td>
- </tr>
- <tr>
- <td>glance_port = 9292</td>
- <td>(IntOpt) Default glance port</td>
- </tr>
- <tr>
- <td>glance_protocol = http</td>
- <td>(StrOpt) Default protocol to use when connecting to glance. Set to https for SSL.</td>
- </tr>
- <tr>
- <td>osapi_glance_link_prefix = None</td>
- <td>(StrOpt) Base URL that will be presented to users in links to glance resources</td>
- </tr>
- <tr>
- <th colspan="2">[image_file_url]</th>
- </tr>
- <tr>
- <td>filesystems = </td>
- <td>(ListOpt) List of file systems that are configured in this file in the image_file_url:<list entry name> sections</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_glance">
+ <caption>Description of configuration options for glance</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>osapi_glance_link_prefix = None</td>
+ <td>(StrOpt) Base URL that will be presented to users in links to glance resources</td>
+ </tr>
+ <tr>
+ <th colspan="2">[glance]</th>
+ </tr>
+ <tr>
+ <td>allowed_direct_url_schemes = </td>
+ <td>(ListOpt) A list of url scheme that can be downloaded directly via the direct_url. Currently supported schemes: [file].</td>
+ </tr>
+ <tr>
+ <td>api_insecure = False</td>
+ <td>(BoolOpt) Allow to perform insecure SSL (https) requests to glance</td>
+ </tr>
+ <tr>
+ <td>api_servers = None</td>
+ <td>(ListOpt) A list of the glance api servers available to nova. Prefix with https:// for ssl-based glance api servers. ([hostname|ip]:port)</td>
+ </tr>
+ <tr>
+ <td>host = $my_ip</td>
+ <td>(StrOpt) Default glance hostname or IP address</td>
+ </tr>
+ <tr>
+ <td>num_retries = 0</td>
+ <td>(IntOpt) Number of retries when downloading an image from glance</td>
+ </tr>
+ <tr>
+ <td>port = 9292</td>
+ <td>(IntOpt) Default glance port</td>
+ </tr>
+ <tr>
+ <td>protocol = http</td>
+ <td>(StrOpt) Default protocol to use when connecting to glance. Set to https for SSL.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[image_file_url]</th>
+ </tr>
+ <tr>
+ <td>filesystems = </td>
+ <td>(ListOpt) List of file systems that are configured in this file in the image_file_url:<list entry name> sections</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-hyperv.xml b/doc/common/tables/nova-hyperv.xml
index f6ae5a023c..f27676cba4 100644
--- a/doc/common/tables/nova-hyperv.xml
+++ b/doc/common/tables/nova-hyperv.xml
@@ -1,59 +1,58 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_hyperv">
- <caption>Description of configuration options for hyperv</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">[hyperv]</th>
- </tr>
- <tr>
- <td>dynamic_memory_ratio = 1.0</td>
- <td>(FloatOpt) Enables dynamic memory allocation (ballooning) when set to a value greater than 1. The value expresses the ratio between the total RAM assigned to an instance and its startup RAM amount. For example a ratio of 2.0 for an instance with 1024MB of RAM implies 512MB of RAM allocated at startup</td>
- </tr>
- <tr>
- <td>enable_instance_metrics_collection = False</td>
- <td>(BoolOpt) Enables metrics collections for an instance by using Hyper-V's metric APIs. Collected data can by retrieved by other apps and services, e.g.: Ceilometer. Requires Hyper-V / Windows Server 2012 and above</td>
- </tr>
- <tr>
- <td>force_hyperv_utils_v1 = False</td>
- <td>(BoolOpt) Force V1 WMI utility classes</td>
- </tr>
- <tr>
- <td>instances_path_share = </td>
- <td>(StrOpt) The name of a Windows share name mapped to the "instances_path" dir and used by the resize feature to copy files to the target host. If left blank, an administrative share will be used, looking for the same "instances_path" used locally</td>
- </tr>
- <tr>
- <td>limit_cpu_features = False</td>
- <td>(BoolOpt) Required for live migration among hosts with different CPU features</td>
- </tr>
- <tr>
- <td>mounted_disk_query_retry_count = 10</td>
- <td>(IntOpt) The number of times to retry checking for a disk mounted via iSCSI.</td>
- </tr>
- <tr>
- <td>mounted_disk_query_retry_interval = 5</td>
- <td>(IntOpt) Interval between checks for a mounted iSCSI disk, in seconds.</td>
- </tr>
- <tr>
- <td>qemu_img_cmd = qemu-img.exe</td>
- <td>(StrOpt) Path of qemu-img command which is used to convert between different image types</td>
- </tr>
- <tr>
- <td>vswitch_name = None</td>
- <td>(StrOpt) External virtual switch Name, if not provided, the first external virtual switch is used</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_hyperv">
+ <caption>Description of configuration options for hyperv</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">[hyperv]</th>
+ </tr>
+ <tr>
+ <td>dynamic_memory_ratio = 1.0</td>
+ <td>(FloatOpt) Enables dynamic memory allocation (ballooning) when set to a value greater than 1. The value expresses the ratio between the total RAM assigned to an instance and its startup RAM amount. For example a ratio of 2.0 for an instance with 1024MB of RAM implies 512MB of RAM allocated at startup</td>
+ </tr>
+ <tr>
+ <td>enable_instance_metrics_collection = False</td>
+ <td>(BoolOpt) Enables metrics collections for an instance by using Hyper-V's metric APIs. Collected data can by retrieved by other apps and services, e.g.: Ceilometer. Requires Hyper-V / Windows Server 2012 and above</td>
+ </tr>
+ <tr>
+ <td>force_hyperv_utils_v1 = False</td>
+ <td>(BoolOpt) Force V1 WMI utility classes</td>
+ </tr>
+ <tr>
+ <td>instances_path_share = </td>
+ <td>(StrOpt) The name of a Windows share name mapped to the "instances_path" dir and used by the resize feature to copy files to the target host. If left blank, an administrative share will be used, looking for the same "instances_path" used locally</td>
+ </tr>
+ <tr>
+ <td>limit_cpu_features = False</td>
+ <td>(BoolOpt) Required for live migration among hosts with different CPU features</td>
+ </tr>
+ <tr>
+ <td>mounted_disk_query_retry_count = 10</td>
+ <td>(IntOpt) The number of times to retry checking for a disk mounted via iSCSI.</td>
+ </tr>
+ <tr>
+ <td>mounted_disk_query_retry_interval = 5</td>
+ <td>(IntOpt) Interval between checks for a mounted iSCSI disk, in seconds.</td>
+ </tr>
+ <tr>
+ <td>qemu_img_cmd = qemu-img.exe</td>
+ <td>(StrOpt) Path of qemu-img command which is used to convert between different image types</td>
+ </tr>
+ <tr>
+ <td>vswitch_name = None</td>
+ <td>(StrOpt) External virtual switch Name, if not provided, the first external virtual switch is used</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-hypervisor.xml b/doc/common/tables/nova-hypervisor.xml
index 78304c0662..9fa245e1c0 100644
--- a/doc/common/tables/nova-hypervisor.xml
+++ b/doc/common/tables/nova-hypervisor.xml
@@ -1,134 +1,133 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_hypervisor">
- <caption>Description of configuration options for hypervisor</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>default_ephemeral_format = None</td>
- <td>(StrOpt) The default format an ephemeral_volume will be formatted with on creation.</td>
- </tr>
- <tr>
- <td>force_raw_images = True</td>
- <td>(BoolOpt) Force backing images to raw format</td>
- </tr>
- <tr>
- <td>preallocate_images = none</td>
- <td>(StrOpt) VM image preallocation mode: "none" => no storage provisioning is done up front, "space" => storage is fully allocated at instance start</td>
- </tr>
- <tr>
- <td>rescue_timeout = 0</td>
- <td>(IntOpt) Automatically unrescue an instance after N seconds. Set to 0 to disable.</td>
- </tr>
- <tr>
- <td>timeout_nbd = 10</td>
- <td>(IntOpt) Amount of time, in seconds, to wait for NBD device start up.</td>
- </tr>
- <tr>
- <td>use_cow_images = True</td>
- <td>(BoolOpt) Whether to use cow images</td>
- </tr>
- <tr>
- <td>vcpu_pin_set = None</td>
- <td>(StrOpt) Defines which pcpus that instance vcpus can use. For example, "4-12,^8,15"</td>
- </tr>
- <tr>
- <td>virt_mkfs = []</td>
- <td>(MultiStrOpt) Name of the mkfs commands for ephemeral device. The format is <os_type>=<mkfs command></td>
- </tr>
- <tr>
- <th colspan="2">[libvirt]</th>
- </tr>
- <tr>
- <td>block_migration_flag = VIR_MIGRATE_UNDEFINE_SOURCE, VIR_MIGRATE_PEER2PEER, VIR_MIGRATE_NON_SHARED_INC</td>
- <td>(StrOpt) Migration flags to be set for block migration</td>
- </tr>
- <tr>
- <td>disk_cachemodes = </td>
- <td>(ListOpt) Specific cachemodes to use for different disk types e.g: file=directsync,block=none</td>
- </tr>
- <tr>
- <td>images_rbd_ceph_conf = </td>
- <td>(StrOpt) Path to the ceph configuration file to use</td>
- </tr>
- <tr>
- <td>images_rbd_pool = rbd</td>
- <td>(StrOpt) The RADOS pool in which rbd volumes are stored</td>
- </tr>
- <tr>
- <td>images_type = default</td>
- <td>(StrOpt) VM Images format. Acceptable values are: raw, qcow2, lvm, rbd, default. If default is specified, then use_cow_images flag is used instead of this one.</td>
- </tr>
- <tr>
- <td>images_volume_group = None</td>
- <td>(StrOpt) LVM Volume Group that is used for VM images, when you specify images_type=lvm.</td>
- </tr>
- <tr>
- <td>inject_key = False</td>
- <td>(BoolOpt) Inject the ssh public key at boot time</td>
- </tr>
- <tr>
- <td>inject_partition = -2</td>
- <td>(IntOpt) The partition to inject to : -2 => disable, -1 => inspect (libguestfs only), 0 => not partitioned, >0 => partition number</td>
- </tr>
- <tr>
- <td>inject_password = False</td>
- <td>(BoolOpt) Inject the admin password at boot time, without an agent.</td>
- </tr>
- <tr>
- <td>iscsi_use_multipath = False</td>
- <td>(BoolOpt) Use multipath connection of the iSCSI volume</td>
- </tr>
- <tr>
- <td>iser_use_multipath = False</td>
- <td>(BoolOpt) Use multipath connection of the iSER volume</td>
- </tr>
- <tr>
- <td>rescue_image_id = None</td>
- <td>(StrOpt) Rescue ami image</td>
- </tr>
- <tr>
- <td>rescue_kernel_id = None</td>
- <td>(StrOpt) Rescue aki image</td>
- </tr>
- <tr>
- <td>rescue_ramdisk_id = None</td>
- <td>(StrOpt) Rescue ari image</td>
- </tr>
- <tr>
- <td>snapshot_compression = False</td>
- <td>(BoolOpt) Compress snapshot images when possible. This currently applies exclusively to qcow2 images</td>
- </tr>
- <tr>
- <td>snapshot_image_format = None</td>
- <td>(StrOpt) Snapshot image format (valid options are : raw, qcow2, vmdk, vdi). Defaults to same as source image</td>
- </tr>
- <tr>
- <td>sparse_logical_volumes = False</td>
- <td>(BoolOpt) Create sparse logical volumes (with virtualsize) if this flag is set to True.</td>
- </tr>
- <tr>
- <td>use_usb_tablet = True</td>
- <td>(BoolOpt) Sync virtual and real mouse cursors in Windows VMs</td>
- </tr>
- <tr>
- <td>use_virtio_for_bridges = True</td>
- <td>(BoolOpt) Use virtio for bridge interfaces with KVM/QEMU</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_hypervisor">
+ <caption>Description of configuration options for hypervisor</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>default_ephemeral_format = None</td>
+ <td>(StrOpt) The default format an ephemeral_volume will be formatted with on creation.</td>
+ </tr>
+ <tr>
+ <td>force_raw_images = True</td>
+ <td>(BoolOpt) Force backing images to raw format</td>
+ </tr>
+ <tr>
+ <td>preallocate_images = none</td>
+ <td>(StrOpt) VM image preallocation mode: "none" => no storage provisioning is done up front, "space" => storage is fully allocated at instance start</td>
+ </tr>
+ <tr>
+ <td>rescue_timeout = 0</td>
+ <td>(IntOpt) Automatically unrescue an instance after N seconds. Set to 0 to disable.</td>
+ </tr>
+ <tr>
+ <td>timeout_nbd = 10</td>
+ <td>(IntOpt) Amount of time, in seconds, to wait for NBD device start up.</td>
+ </tr>
+ <tr>
+ <td>use_cow_images = True</td>
+ <td>(BoolOpt) Whether to use cow images</td>
+ </tr>
+ <tr>
+ <td>vcpu_pin_set = None</td>
+ <td>(StrOpt) Defines which pcpus that instance vcpus can use. For example, "4-12,^8,15"</td>
+ </tr>
+ <tr>
+ <td>virt_mkfs = []</td>
+ <td>(MultiStrOpt) Name of the mkfs commands for ephemeral device. The format is <os_type>=<mkfs command></td>
+ </tr>
+ <tr>
+ <th colspan="2">[libvirt]</th>
+ </tr>
+ <tr>
+ <td>block_migration_flag = VIR_MIGRATE_UNDEFINE_SOURCE, VIR_MIGRATE_PEER2PEER, VIR_MIGRATE_NON_SHARED_INC</td>
+ <td>(StrOpt) Migration flags to be set for block migration</td>
+ </tr>
+ <tr>
+ <td>disk_cachemodes = </td>
+ <td>(ListOpt) Specific cachemodes to use for different disk types e.g: file=directsync,block=none</td>
+ </tr>
+ <tr>
+ <td>images_rbd_ceph_conf = </td>
+ <td>(StrOpt) Path to the ceph configuration file to use</td>
+ </tr>
+ <tr>
+ <td>images_rbd_pool = rbd</td>
+ <td>(StrOpt) The RADOS pool in which rbd volumes are stored</td>
+ </tr>
+ <tr>
+ <td>images_type = default</td>
+ <td>(StrOpt) VM Images format. Acceptable values are: raw, qcow2, lvm, rbd, default. If default is specified, then use_cow_images flag is used instead of this one.</td>
+ </tr>
+ <tr>
+ <td>images_volume_group = None</td>
+ <td>(StrOpt) LVM Volume Group that is used for VM images, when you specify images_type=lvm.</td>
+ </tr>
+ <tr>
+ <td>inject_key = False</td>
+ <td>(BoolOpt) Inject the ssh public key at boot time</td>
+ </tr>
+ <tr>
+ <td>inject_partition = -2</td>
+ <td>(IntOpt) The partition to inject to : -2 => disable, -1 => inspect (libguestfs only), 0 => not partitioned, >0 => partition number</td>
+ </tr>
+ <tr>
+ <td>inject_password = False</td>
+ <td>(BoolOpt) Inject the admin password at boot time, without an agent.</td>
+ </tr>
+ <tr>
+ <td>iscsi_use_multipath = False</td>
+ <td>(BoolOpt) Use multipath connection of the iSCSI volume</td>
+ </tr>
+ <tr>
+ <td>iser_use_multipath = False</td>
+ <td>(BoolOpt) Use multipath connection of the iSER volume</td>
+ </tr>
+ <tr>
+ <td>rescue_image_id = None</td>
+ <td>(StrOpt) Rescue ami image. This will not be used if an image id is provided by the user.</td>
+ </tr>
+ <tr>
+ <td>rescue_kernel_id = None</td>
+ <td>(StrOpt) Rescue aki image</td>
+ </tr>
+ <tr>
+ <td>rescue_ramdisk_id = None</td>
+ <td>(StrOpt) Rescue ari image</td>
+ </tr>
+ <tr>
+ <td>snapshot_compression = False</td>
+ <td>(BoolOpt) Compress snapshot images when possible. This currently applies exclusively to qcow2 images</td>
+ </tr>
+ <tr>
+ <td>snapshot_image_format = None</td>
+ <td>(StrOpt) Snapshot image format (valid options are : raw, qcow2, vmdk, vdi). Defaults to same as source image</td>
+ </tr>
+ <tr>
+ <td>sparse_logical_volumes = False</td>
+ <td>(BoolOpt) Create sparse logical volumes (with virtualsize) if this flag is set to True.</td>
+ </tr>
+ <tr>
+ <td>use_usb_tablet = True</td>
+ <td>(BoolOpt) Sync virtual and real mouse cursors in Windows VMs</td>
+ </tr>
+ <tr>
+ <td>use_virtio_for_bridges = True</td>
+ <td>(BoolOpt) Use virtio for bridge interfaces with KVM/QEMU</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-ipv6.xml b/doc/common/tables/nova-ipv6.xml
index e1c5bd87c3..c4d14c9b85 100644
--- a/doc/common/tables/nova-ipv6.xml
+++ b/doc/common/tables/nova-ipv6.xml
@@ -1,39 +1,38 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_ipv6">
- <caption>Description of configuration options for ipv6</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>fixed_range_v6 = fd00::/48</td>
- <td>(StrOpt) Fixed IPv6 address block</td>
- </tr>
- <tr>
- <td>gateway_v6 = None</td>
- <td>(StrOpt) Default IPv6 gateway</td>
- </tr>
- <tr>
- <td>ipv6_backend = rfc2462</td>
- <td>(StrOpt) Backend to use for IPv6 generation</td>
- </tr>
- <tr>
- <td>use_ipv6 = False</td>
- <td>(BoolOpt) Use IPv6</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_ipv6">
+ <caption>Description of configuration options for ipv6</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>fixed_range_v6 = fd00::/48</td>
+ <td>(StrOpt) Fixed IPv6 address block</td>
+ </tr>
+ <tr>
+ <td>gateway_v6 = None</td>
+ <td>(StrOpt) Default IPv6 gateway</td>
+ </tr>
+ <tr>
+ <td>ipv6_backend = rfc2462</td>
+ <td>(StrOpt) Backend to use for IPv6 generation</td>
+ </tr>
+ <tr>
+ <td>use_ipv6 = False</td>
+ <td>(BoolOpt) Use IPv6</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-keymgr.xml b/doc/common/tables/nova-keymgr.xml
index f10c08e496..91943d4a58 100644
--- a/doc/common/tables/nova-keymgr.xml
+++ b/doc/common/tables/nova-keymgr.xml
@@ -1,31 +1,30 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_keymgr">
- <caption>Description of configuration options for keymgr</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>api_class = nova.keymgr.conf_key_mgr.ConfKeyManager</td>
- <td>(StrOpt) The full class name of the key manager API class</td>
- </tr>
- <tr>
- <td>fixed_key = None</td>
- <td>(StrOpt) Fixed key returned by key manager, specified in hex</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_keymgr">
+ <caption>Description of configuration options for keymgr</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>api_class = nova.keymgr.conf_key_mgr.ConfKeyManager</td>
+ <td>(StrOpt) The full class name of the key manager API class</td>
+ </tr>
+ <tr>
+ <td>fixed_key = None</td>
+ <td>(StrOpt) Fixed key returned by key manager, specified in hex</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-kombu.xml b/doc/common/tables/nova-kombu.xml
index 3e442f8dff..d20df91e78 100644
--- a/doc/common/tables/nova-kombu.xml
+++ b/doc/common/tables/nova-kombu.xml
@@ -1,43 +1,42 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_kombu">
- <caption>Description of configuration options for kombu</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>kombu_reconnect_delay = 1.0</td>
- <td>(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.</td>
- </tr>
- <tr>
- <td>kombu_ssl_ca_certs = </td>
- <td>(StrOpt) SSL certification authority file (valid only if SSL enabled).</td>
- </tr>
- <tr>
- <td>kombu_ssl_certfile = </td>
- <td>(StrOpt) SSL cert file (valid only if SSL enabled).</td>
- </tr>
- <tr>
- <td>kombu_ssl_keyfile = </td>
- <td>(StrOpt) SSL key file (valid only if SSL enabled).</td>
- </tr>
- <tr>
- <td>kombu_ssl_version = </td>
- <td>(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_kombu">
+ <caption>Description of configuration options for kombu</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>kombu_reconnect_delay = 1.0</td>
+ <td>(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.</td>
+ </tr>
+ <tr>
+ <td>kombu_ssl_ca_certs = </td>
+ <td>(StrOpt) SSL certification authority file (valid only if SSL enabled).</td>
+ </tr>
+ <tr>
+ <td>kombu_ssl_certfile = </td>
+ <td>(StrOpt) SSL cert file (valid only if SSL enabled).</td>
+ </tr>
+ <tr>
+ <td>kombu_ssl_keyfile = </td>
+ <td>(StrOpt) SSL key file (valid only if SSL enabled).</td>
+ </tr>
+ <tr>
+ <td>kombu_ssl_version = </td>
+ <td>(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-ldap.xml b/doc/common/tables/nova-ldap.xml
index 90058eb816..55e9ba43b3 100644
--- a/doc/common/tables/nova-ldap.xml
+++ b/doc/common/tables/nova-ldap.xml
@@ -1,63 +1,62 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_ldap">
- <caption>Description of configuration options for ldap</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>ldap_dns_base_dn = ou=hosts,dc=example,dc=org</td>
- <td>(StrOpt) Base DN for DNS entries in LDAP</td>
- </tr>
- <tr>
- <td>ldap_dns_password = password</td>
- <td>(StrOpt) Password for LDAP DNS</td>
- </tr>
- <tr>
- <td>ldap_dns_servers = ['dns.example.org']</td>
- <td>(MultiStrOpt) DNS Servers for LDAP DNS driver</td>
- </tr>
- <tr>
- <td>ldap_dns_soa_expiry = 86400</td>
- <td>(StrOpt) Expiry interval (in seconds) for LDAP DNS driver Statement of Authority</td>
- </tr>
- <tr>
- <td>ldap_dns_soa_hostmaster = hostmaster@example.org</td>
- <td>(StrOpt) Hostmaster for LDAP DNS driver Statement of Authority</td>
- </tr>
- <tr>
- <td>ldap_dns_soa_minimum = 7200</td>
- <td>(StrOpt) Minimum interval (in seconds) for LDAP DNS driver Statement of Authority</td>
- </tr>
- <tr>
- <td>ldap_dns_soa_refresh = 1800</td>
- <td>(StrOpt) Refresh interval (in seconds) for LDAP DNS driver Statement of Authority</td>
- </tr>
- <tr>
- <td>ldap_dns_soa_retry = 3600</td>
- <td>(StrOpt) Retry interval (in seconds) for LDAP DNS driver Statement of Authority</td>
- </tr>
- <tr>
- <td>ldap_dns_url = ldap://ldap.example.com:389</td>
- <td>(StrOpt) URL for LDAP server which will store DNS entries</td>
- </tr>
- <tr>
- <td>ldap_dns_user = uid=admin,ou=people,dc=example,dc=org</td>
- <td>(StrOpt) User for LDAP DNS</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_ldap">
+ <caption>Description of configuration options for ldap</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>ldap_dns_base_dn = ou=hosts,dc=example,dc=org</td>
+ <td>(StrOpt) Base DN for DNS entries in LDAP</td>
+ </tr>
+ <tr>
+ <td>ldap_dns_password = password</td>
+ <td>(StrOpt) Password for LDAP DNS</td>
+ </tr>
+ <tr>
+ <td>ldap_dns_servers = ['dns.example.org']</td>
+ <td>(MultiStrOpt) DNS Servers for LDAP DNS driver</td>
+ </tr>
+ <tr>
+ <td>ldap_dns_soa_expiry = 86400</td>
+ <td>(StrOpt) Expiry interval (in seconds) for LDAP DNS driver Statement of Authority</td>
+ </tr>
+ <tr>
+ <td>ldap_dns_soa_hostmaster = hostmaster@example.org</td>
+ <td>(StrOpt) Hostmaster for LDAP DNS driver Statement of Authority</td>
+ </tr>
+ <tr>
+ <td>ldap_dns_soa_minimum = 7200</td>
+ <td>(StrOpt) Minimum interval (in seconds) for LDAP DNS driver Statement of Authority</td>
+ </tr>
+ <tr>
+ <td>ldap_dns_soa_refresh = 1800</td>
+ <td>(StrOpt) Refresh interval (in seconds) for LDAP DNS driver Statement of Authority</td>
+ </tr>
+ <tr>
+ <td>ldap_dns_soa_retry = 3600</td>
+ <td>(StrOpt) Retry interval (in seconds) for LDAP DNS driver Statement of Authority</td>
+ </tr>
+ <tr>
+ <td>ldap_dns_url = ldap://ldap.example.com:389</td>
+ <td>(StrOpt) URL for LDAP server which will store DNS entries</td>
+ </tr>
+ <tr>
+ <td>ldap_dns_user = uid=admin,ou=people,dc=example,dc=org</td>
+ <td>(StrOpt) User for LDAP DNS</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-libvirt.xml b/doc/common/tables/nova-libvirt.xml
index 6370d3cca1..5a3cf1dc88 100644
--- a/doc/common/tables/nova-libvirt.xml
+++ b/doc/common/tables/nova-libvirt.xml
@@ -1,102 +1,101 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_libvirt">
- <caption>Description of configuration options for libvirt</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>remove_unused_base_images = True</td>
- <td>(BoolOpt) Should unused base images be removed?</td>
- </tr>
- <tr>
- <td>remove_unused_original_minimum_age_seconds = 86400</td>
- <td>(IntOpt) Unused unresized base images younger than this will not be removed</td>
- </tr>
- <tr>
- <th colspan="2">[libvirt]</th>
- </tr>
- <tr>
- <td>checksum_base_images = False</td>
- <td>(BoolOpt) Write a checksum for files in _base to disk</td>
- </tr>
- <tr>
- <td>checksum_interval_seconds = 3600</td>
- <td>(IntOpt) How frequently to checksum base images</td>
- </tr>
- <tr>
- <td>connection_uri = </td>
- <td>(StrOpt) Override the default libvirt URI (which is dependent on virt_type)</td>
- </tr>
- <tr>
- <td>cpu_mode = None</td>
- <td>(StrOpt) Set to "host-model" to clone the host CPU feature flags; to "host-passthrough" to use the host CPU model exactly; to "custom" to use a named CPU model; to "none" to not set any CPU model. If virt_type="kvm|qemu", it will default to "host-model", otherwise it will default to "none"</td>
- </tr>
- <tr>
- <td>cpu_model = None</td>
- <td>(StrOpt) Set to a named libvirt CPU model (see names listed in /usr/share/libvirt/cpu_map.xml). Only has effect if cpu_mode="custom" and virt_type="kvm|qemu"</td>
- </tr>
- <tr>
- <td>disk_prefix = None</td>
- <td>(StrOpt) Override the default disk prefix for the devices attached to a server, which is dependent on virt_type. (valid options are: sd, xvd, uvd, vd)</td>
- </tr>
- <tr>
- <td>image_info_filename_pattern = $instances_path/$image_cache_subdirectory_name/%(image)s.info</td>
- <td>(StrOpt) Allows image information files to be stored in non-standard locations</td>
- </tr>
- <tr>
- <td>remove_unused_kernels = False</td>
- <td>(BoolOpt) Should unused kernel images be removed? This is only safe to enable if all compute nodes have been updated to support this option. This will be enabled by default in future.</td>
- </tr>
- <tr>
- <td>remove_unused_resized_minimum_age_seconds = 3600</td>
- <td>(IntOpt) Unused resized base images younger than this will not be removed</td>
- </tr>
- <tr>
- <td>rng_dev_path = None</td>
- <td>(StrOpt) A path to a device that will be used as source of entropy on the host. Permitted options are: /dev/random or /dev/hwrng</td>
- </tr>
- <tr>
- <td>snapshots_directory = $instances_path/snapshots</td>
- <td>(StrOpt) Location where libvirt driver will store snapshots before uploading them to image service</td>
- </tr>
- <tr>
- <td>vif_driver = nova.virt.libvirt.vif.LibvirtGenericVIFDriver</td>
- <td>(StrOpt) DEPRECATED. The libvirt VIF driver to configure the VIFs.This option is deprecated and will be removed in the Juno release.</td>
- </tr>
- <tr>
- <td>virt_type = kvm</td>
- <td>(StrOpt) Libvirt domain type (valid options are: kvm, lxc, qemu, uml, xen)</td>
- </tr>
- <tr>
- <td>volume_clear = zero</td>
- <td>(StrOpt) Method used to wipe old volumes (valid options are: none, zero, shred)</td>
- </tr>
- <tr>
- <td>volume_clear_size = 0</td>
- <td>(IntOpt) Size in MiB to wipe at start of old volumes. 0 => all</td>
- </tr>
- <tr>
- <td>volume_drivers = iscsi=nova.virt.libvirt.volume.LibvirtISCSIVolumeDriver, iser=nova.virt.libvirt.volume.LibvirtISERVolumeDriver, local=nova.virt.libvirt.volume.LibvirtVolumeDriver, fake=nova.virt.libvirt.volume.LibvirtFakeVolumeDriver, rbd=nova.virt.libvirt.volume.LibvirtNetVolumeDriver, sheepdog=nova.virt.libvirt.volume.LibvirtNetVolumeDriver, nfs=nova.virt.libvirt.volume.LibvirtNFSVolumeDriver, aoe=nova.virt.libvirt.volume.LibvirtAOEVolumeDriver, glusterfs=nova.virt.libvirt.volume.LibvirtGlusterfsVolumeDriver, fibre_channel=nova.virt.libvirt.volume.LibvirtFibreChannelVolumeDriver, scality=nova.virt.libvirt.volume.LibvirtScalityVolumeDriver</td>
- <td>(ListOpt) Libvirt handlers for remote volumes.</td>
- </tr>
- <tr>
- <td>wait_soft_reboot_seconds = 120</td>
- <td>(IntOpt) Number of seconds to wait for instance to shut down after soft reboot request is made. We fall back to hard reboot if instance does not shutdown within this window.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_libvirt">
+ <caption>Description of configuration options for libvirt</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>remove_unused_base_images = True</td>
+ <td>(BoolOpt) Should unused base images be removed?</td>
+ </tr>
+ <tr>
+ <td>remove_unused_original_minimum_age_seconds = 86400</td>
+ <td>(IntOpt) Unused unresized base images younger than this will not be removed</td>
+ </tr>
+ <tr>
+ <th colspan="2">[libvirt]</th>
+ </tr>
+ <tr>
+ <td>checksum_base_images = False</td>
+ <td>(BoolOpt) Write a checksum for files in _base to disk</td>
+ </tr>
+ <tr>
+ <td>checksum_interval_seconds = 3600</td>
+ <td>(IntOpt) How frequently to checksum base images</td>
+ </tr>
+ <tr>
+ <td>connection_uri = </td>
+ <td>(StrOpt) Override the default libvirt URI (which is dependent on virt_type)</td>
+ </tr>
+ <tr>
+ <td>cpu_mode = None</td>
+ <td>(StrOpt) Set to "host-model" to clone the host CPU feature flags; to "host-passthrough" to use the host CPU model exactly; to "custom" to use a named CPU model; to "none" to not set any CPU model. If virt_type="kvm|qemu", it will default to "host-model", otherwise it will default to "none"</td>
+ </tr>
+ <tr>
+ <td>cpu_model = None</td>
+ <td>(StrOpt) Set to a named libvirt CPU model (see names listed in /usr/share/libvirt/cpu_map.xml). Only has effect if cpu_mode="custom" and virt_type="kvm|qemu"</td>
+ </tr>
+ <tr>
+ <td>disk_prefix = None</td>
+ <td>(StrOpt) Override the default disk prefix for the devices attached to a server, which is dependent on virt_type. (valid options are: sd, xvd, uvd, vd)</td>
+ </tr>
+ <tr>
+ <td>image_info_filename_pattern = $instances_path/$image_cache_subdirectory_name/%(image)s.info</td>
+ <td>(StrOpt) Allows image information files to be stored in non-standard locations</td>
+ </tr>
+ <tr>
+ <td>remove_unused_kernels = False</td>
+ <td>(BoolOpt) Should unused kernel images be removed? This is only safe to enable if all compute nodes have been updated to support this option. This will be enabled by default in future.</td>
+ </tr>
+ <tr>
+ <td>remove_unused_resized_minimum_age_seconds = 3600</td>
+ <td>(IntOpt) Unused resized base images younger than this will not be removed</td>
+ </tr>
+ <tr>
+ <td>rng_dev_path = None</td>
+ <td>(StrOpt) A path to a device that will be used as source of entropy on the host. Permitted options are: /dev/random or /dev/hwrng</td>
+ </tr>
+ <tr>
+ <td>snapshots_directory = $instances_path/snapshots</td>
+ <td>(StrOpt) Location where libvirt driver will store snapshots before uploading them to image service</td>
+ </tr>
+ <tr>
+ <td>vif_driver = nova.virt.libvirt.vif.LibvirtGenericVIFDriver</td>
+ <td>(StrOpt) DEPRECATED. The libvirt VIF driver to configure the VIFs.This option is deprecated and will be removed in the Juno release.</td>
+ </tr>
+ <tr>
+ <td>virt_type = kvm</td>
+ <td>(StrOpt) Libvirt domain type (valid options are: kvm, lxc, qemu, uml, xen)</td>
+ </tr>
+ <tr>
+ <td>volume_clear = zero</td>
+ <td>(StrOpt) Method used to wipe old volumes (valid options are: none, zero, shred)</td>
+ </tr>
+ <tr>
+ <td>volume_clear_size = 0</td>
+ <td>(IntOpt) Size in MiB to wipe at start of old volumes. 0 => all</td>
+ </tr>
+ <tr>
+ <td>volume_drivers = iscsi=nova.virt.libvirt.volume.LibvirtISCSIVolumeDriver, iser=nova.virt.libvirt.volume.LibvirtISERVolumeDriver, local=nova.virt.libvirt.volume.LibvirtVolumeDriver, fake=nova.virt.libvirt.volume.LibvirtFakeVolumeDriver, rbd=nova.virt.libvirt.volume.LibvirtNetVolumeDriver, sheepdog=nova.virt.libvirt.volume.LibvirtNetVolumeDriver, nfs=nova.virt.libvirt.volume.LibvirtNFSVolumeDriver, aoe=nova.virt.libvirt.volume.LibvirtAOEVolumeDriver, glusterfs=nova.virt.libvirt.volume.LibvirtGlusterfsVolumeDriver, fibre_channel=nova.virt.libvirt.volume.LibvirtFibreChannelVolumeDriver, scality=nova.virt.libvirt.volume.LibvirtScalityVolumeDriver</td>
+ <td>(ListOpt) Libvirt handlers for remote volumes.</td>
+ </tr>
+ <tr>
+ <td>wait_soft_reboot_seconds = 120</td>
+ <td>(IntOpt) Number of seconds to wait for instance to shut down after soft reboot request is made. We fall back to hard reboot if instance does not shutdown within this window.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-livemigration.xml b/doc/common/tables/nova-livemigration.xml
index 0497e215f5..349cdb1d7b 100644
--- a/doc/common/tables/nova-livemigration.xml
+++ b/doc/common/tables/nova-livemigration.xml
@@ -1,42 +1,41 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_livemigration">
- <caption>Description of configuration options for livemigration</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>live_migration_retry_count = 30</td>
- <td>(IntOpt) Number of 1 second retries needed in live_migration</td>
- </tr>
- <tr>
- <th colspan="2">[libvirt]</th>
- </tr>
- <tr>
- <td>live_migration_bandwidth = 0</td>
- <td>(IntOpt) Maximum bandwidth to be used during migration, in Mbps</td>
- </tr>
- <tr>
- <td>live_migration_flag = VIR_MIGRATE_UNDEFINE_SOURCE, VIR_MIGRATE_PEER2PEER</td>
- <td>(StrOpt) Migration flags to be set for live migration</td>
- </tr>
- <tr>
- <td>live_migration_uri = qemu+tcp://%s/system</td>
- <td>(StrOpt) Migration target URI (any included "%s" is replaced with the migration target hostname)</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_livemigration">
+ <caption>Description of configuration options for livemigration</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>live_migration_retry_count = 30</td>
+ <td>(IntOpt) Number of 1 second retries needed in live_migration</td>
+ </tr>
+ <tr>
+ <th colspan="2">[libvirt]</th>
+ </tr>
+ <tr>
+ <td>live_migration_bandwidth = 0</td>
+ <td>(IntOpt) Maximum bandwidth to be used during migration, in Mbps</td>
+ </tr>
+ <tr>
+ <td>live_migration_flag = VIR_MIGRATE_UNDEFINE_SOURCE, VIR_MIGRATE_PEER2PEER</td>
+ <td>(StrOpt) Migration flags to be set for live migration</td>
+ </tr>
+ <tr>
+ <td>live_migration_uri = qemu+tcp://%s/system</td>
+ <td>(StrOpt) Migration target URI (any included "%s" is replaced with the migration target hostname)</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-logging.xml b/doc/common/tables/nova-logging.xml
index 939101aba3..002b6ee715 100644
--- a/doc/common/tables/nova-logging.xml
+++ b/doc/common/tables/nova-logging.xml
@@ -1,107 +1,106 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_logging">
- <caption>Description of configuration options for logging</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>debug = False</td>
- <td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).</td>
- </tr>
- <tr>
- <td>default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN</td>
- <td>(ListOpt) list of logger=LEVEL pairs</td>
- </tr>
- <tr>
- <td>fatal_deprecations = False</td>
- <td>(BoolOpt) make deprecations fatal</td>
- </tr>
- <tr>
- <td>fatal_exception_format_errors = False</td>
- <td>(BoolOpt) Make exception message format errors fatal</td>
- </tr>
- <tr>
- <td>instance_format = "[instance: %(uuid)s] "</td>
- <td>(StrOpt) If an instance is passed with the log message, format it like this</td>
- </tr>
- <tr>
- <td>instance_uuid_format = "[instance: %(uuid)s] "</td>
- <td>(StrOpt) If an instance UUID is passed with the log message, format it like this</td>
- </tr>
- <tr>
- <td>log_config_append = None</td>
- <td>(StrOpt) The name of logging configuration file. It does not disable existing loggers, but just appends specified logging configuration to any other existing logging options. Please see the Python logging module documentation for details on logging configuration files.</td>
- </tr>
- <tr>
- <td>log_date_format = %Y-%m-%d %H:%M:%S</td>
- <td>(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s</td>
- </tr>
- <tr>
- <td>log_dir = None</td>
- <td>(StrOpt) (Optional) The base directory used for relative --log-file paths</td>
- </tr>
- <tr>
- <td>log_file = None</td>
- <td>(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.</td>
- </tr>
- <tr>
- <td>log_format = None</td>
- <td>(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.</td>
- </tr>
- <tr>
- <td>logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user)s %(tenant)s] %(instance)s%(message)s</td>
- <td>(StrOpt) format string to use for log messages with context</td>
- </tr>
- <tr>
- <td>logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d</td>
- <td>(StrOpt) data to append to log format when level is DEBUG</td>
- </tr>
- <tr>
- <td>logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s</td>
- <td>(StrOpt) format string to use for log messages without context</td>
- </tr>
- <tr>
- <td>logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s</td>
- <td>(StrOpt) prefix each line of exception output with this format</td>
- </tr>
- <tr>
- <td>publish_errors = False</td>
- <td>(BoolOpt) publish error events</td>
- </tr>
- <tr>
- <td>syslog_log_facility = LOG_USER</td>
- <td>(StrOpt) syslog facility to receive log lines</td>
- </tr>
- <tr>
- <td>use_stderr = True</td>
- <td>(BoolOpt) Log output to standard error</td>
- </tr>
- <tr>
- <td>use_syslog = False</td>
- <td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and then will be changed in J to honor RFC5424</td>
- </tr>
- <tr>
- <td>use_syslog_rfc_format = False</td>
- <td>(BoolOpt) (Optional) Use syslog rfc5424 format for logging. If enabled, will add APP-NAME (RFC5424) before the MSG part of the syslog message. The old format without APP-NAME is deprecated in I, and will be removed in J.</td>
- </tr>
- <tr>
- <td>verbose = False</td>
- <td>(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_logging">
+ <caption>Description of configuration options for logging</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>debug = False</td>
+ <td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).</td>
+ </tr>
+ <tr>
+ <td>default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN</td>
+ <td>(ListOpt) List of logger=LEVEL pairs.</td>
+ </tr>
+ <tr>
+ <td>fatal_deprecations = False</td>
+ <td>(BoolOpt) Enables or disables fatal status of deprecations.</td>
+ </tr>
+ <tr>
+ <td>fatal_exception_format_errors = False</td>
+ <td>(BoolOpt) Make exception message format errors fatal</td>
+ </tr>
+ <tr>
+ <td>instance_format = "[instance: %(uuid)s] "</td>
+ <td>(StrOpt) The format for an instance that is passed with the log message. </td>
+ </tr>
+ <tr>
+ <td>instance_uuid_format = "[instance: %(uuid)s] "</td>
+ <td>(StrOpt) The format for an instance UUID that is passed with the log message. </td>
+ </tr>
+ <tr>
+ <td>log_config_append = None</td>
+ <td>(StrOpt) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation.</td>
+ </tr>
+ <tr>
+ <td>log_date_format = %Y-%m-%d %H:%M:%S</td>
+ <td>(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s .</td>
+ </tr>
+ <tr>
+ <td>log_dir = None</td>
+ <td>(StrOpt) (Optional) The base directory used for relative --log-file paths.</td>
+ </tr>
+ <tr>
+ <td>log_file = None</td>
+ <td>(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.</td>
+ </tr>
+ <tr>
+ <td>log_format = None</td>
+ <td>(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.</td>
+ </tr>
+ <tr>
+ <td>logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s</td>
+ <td>(StrOpt) Format string to use for log messages with context.</td>
+ </tr>
+ <tr>
+ <td>logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d</td>
+ <td>(StrOpt) Data to append to log format when level is DEBUG.</td>
+ </tr>
+ <tr>
+ <td>logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s</td>
+ <td>(StrOpt) Format string to use for log messages without context.</td>
+ </tr>
+ <tr>
+ <td>logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s</td>
+ <td>(StrOpt) Prefix each line of exception output with this format.</td>
+ </tr>
+ <tr>
+ <td>publish_errors = False</td>
+ <td>(BoolOpt) Enables or disables publication of error events.</td>
+ </tr>
+ <tr>
+ <td>syslog_log_facility = LOG_USER</td>
+ <td>(StrOpt) Syslog facility to receive log lines.</td>
+ </tr>
+ <tr>
+ <td>use_stderr = True</td>
+ <td>(BoolOpt) Log output to standard error.</td>
+ </tr>
+ <tr>
+ <td>use_syslog = False</td>
+ <td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424.</td>
+ </tr>
+ <tr>
+ <td>use_syslog_rfc_format = False</td>
+ <td>(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in I, and will be removed in J.</td>
+ </tr>
+ <tr>
+ <td>verbose = False</td>
+ <td>(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-metadata.xml b/doc/common/tables/nova-metadata.xml
index 15c31d25d8..050b69f7b6 100644
--- a/doc/common/tables/nova-metadata.xml
+++ b/doc/common/tables/nova-metadata.xml
@@ -1,55 +1,54 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_metadata">
- <caption>Description of configuration options for metadata</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>metadata_host = $my_ip</td>
- <td>(StrOpt) The IP address for the metadata API server</td>
- </tr>
- <tr>
- <td>metadata_listen = 0.0.0.0</td>
- <td>(StrOpt) The IP address on which the metadata API will listen.</td>
- </tr>
- <tr>
- <td>metadata_listen_port = 8775</td>
- <td>(IntOpt) The port on which the metadata API will listen.</td>
- </tr>
- <tr>
- <td>metadata_manager = nova.api.manager.MetadataManager</td>
- <td>(StrOpt) OpenStack metadata service manager</td>
- </tr>
- <tr>
- <td>metadata_port = 8775</td>
- <td>(IntOpt) The port for the metadata API port</td>
- </tr>
- <tr>
- <td>metadata_workers = None</td>
- <td>(IntOpt) Number of workers for metadata service. The default will be the number of CPUs available.</td>
- </tr>
- <tr>
- <td>vendordata_driver = nova.api.metadata.vendordata_json.JsonFileVendorData</td>
- <td>(StrOpt) Driver to use for vendor data</td>
- </tr>
- <tr>
- <td>vendordata_jsonfile_path = None</td>
- <td>(StrOpt) File to load json formatted vendor data from</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_metadata">
+ <caption>Description of configuration options for metadata</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>metadata_host = $my_ip</td>
+ <td>(StrOpt) The IP address for the metadata API server</td>
+ </tr>
+ <tr>
+ <td>metadata_listen = 0.0.0.0</td>
+ <td>(StrOpt) The IP address on which the metadata API will listen.</td>
+ </tr>
+ <tr>
+ <td>metadata_listen_port = 8775</td>
+ <td>(IntOpt) The port on which the metadata API will listen.</td>
+ </tr>
+ <tr>
+ <td>metadata_manager = nova.api.manager.MetadataManager</td>
+ <td>(StrOpt) OpenStack metadata service manager</td>
+ </tr>
+ <tr>
+ <td>metadata_port = 8775</td>
+ <td>(IntOpt) The port for the metadata API port</td>
+ </tr>
+ <tr>
+ <td>metadata_workers = None</td>
+ <td>(IntOpt) Number of workers for metadata service. The default will be the number of CPUs available.</td>
+ </tr>
+ <tr>
+ <td>vendordata_driver = nova.api.metadata.vendordata_json.JsonFileVendorData</td>
+ <td>(StrOpt) Driver to use for vendor data</td>
+ </tr>
+ <tr>
+ <td>vendordata_jsonfile_path = None</td>
+ <td>(StrOpt) File to load json formatted vendor data from</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-network.xml b/doc/common/tables/nova-network.xml
index 4892eaf386..781e049296 100644
--- a/doc/common/tables/nova-network.xml
+++ b/doc/common/tables/nova-network.xml
@@ -1,262 +1,261 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_network">
- <caption>Description of configuration options for network</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>allow_same_net_traffic = True</td>
- <td>(BoolOpt) Whether to allow network traffic from same network</td>
- </tr>
- <tr>
- <td>auto_assign_floating_ip = False</td>
- <td>(BoolOpt) Autoassigning floating IP to VM</td>
- </tr>
- <tr>
- <td>cnt_vpn_clients = 0</td>
- <td>(IntOpt) Number of addresses reserved for vpn clients</td>
- </tr>
- <tr>
- <td>create_unique_mac_address_attempts = 5</td>
- <td>(IntOpt) Number of attempts to create unique mac address</td>
- </tr>
- <tr>
- <td>default_access_ip_network_name = None</td>
- <td>(StrOpt) Name of network to use to set access IPs for instances</td>
- </tr>
- <tr>
- <td>default_floating_pool = nova</td>
- <td>(StrOpt) Default pool for floating IPs</td>
- </tr>
- <tr>
- <td>defer_iptables_apply = False</td>
- <td>(BoolOpt) Whether to batch up the application of IPTables rules during a host restart and apply all at the end of the init phase</td>
- </tr>
- <tr>
- <td>dhcp_domain = novalocal</td>
- <td>(StrOpt) Domain to use for building the hostnames</td>
- </tr>
- <tr>
- <td>dhcp_lease_time = 120</td>
- <td>(IntOpt) Lifetime of a DHCP lease in seconds</td>
- </tr>
- <tr>
- <td>dhcpbridge = $bindir/nova-dhcpbridge</td>
- <td>(StrOpt) Location of nova-dhcpbridge</td>
- </tr>
- <tr>
- <td>dhcpbridge_flagfile = ['/etc/nova/nova-dhcpbridge.conf']</td>
- <td>(MultiStrOpt) Location of flagfiles for dhcpbridge</td>
- </tr>
- <tr>
- <td>dns_server = []</td>
- <td>(MultiStrOpt) If set, uses specific DNS server for dnsmasq. Can be specified multiple times.</td>
- </tr>
- <tr>
- <td>dns_update_periodic_interval = -1</td>
- <td>(IntOpt) Number of seconds to wait between runs of updates to DNS entries.</td>
- </tr>
- <tr>
- <td>dnsmasq_config_file = </td>
- <td>(StrOpt) Override the default dnsmasq settings with this file</td>
- </tr>
- <tr>
- <td>firewall_driver = None</td>
- <td>(StrOpt) Firewall driver (defaults to hypervisor specific iptables driver)</td>
- </tr>
- <tr>
- <td>fixed_ip_disassociate_timeout = 600</td>
- <td>(IntOpt) Seconds after which a deallocated IP is disassociated</td>
- </tr>
- <tr>
- <td>flat_injected = False</td>
- <td>(BoolOpt) Whether to attempt to inject network setup into guest</td>
- </tr>
- <tr>
- <td>flat_interface = None</td>
- <td>(StrOpt) FlatDhcp will bridge into this interface if set</td>
- </tr>
- <tr>
- <td>flat_network_bridge = None</td>
- <td>(StrOpt) Bridge for simple network instances</td>
- </tr>
- <tr>
- <td>flat_network_dns = 8.8.4.4</td>
- <td>(StrOpt) DNS server for simple network</td>
- </tr>
- <tr>
- <td>floating_ip_dns_manager = nova.network.noop_dns_driver.NoopDNSDriver</td>
- <td>(StrOpt) Full class name for the DNS Manager for floating IPs</td>
- </tr>
- <tr>
- <td>force_dhcp_release = True</td>
- <td>(BoolOpt) If True, send a dhcp release on instance termination</td>
- </tr>
- <tr>
- <td>force_snat_range = []</td>
- <td>(MultiStrOpt) Traffic to this range will always be snatted to the fallback ip, even if it would normally be bridged out of the node. Can be specified multiple times.</td>
- </tr>
- <tr>
- <td>forward_bridge_interface = ['all']</td>
- <td>(MultiStrOpt) An interface that bridges can forward to. If this is set to all then all traffic will be forwarded. Can be specified multiple times.</td>
- </tr>
- <tr>
- <td>gateway = None</td>
- <td>(StrOpt) Default IPv4 gateway</td>
- </tr>
- <tr>
- <td>injected_network_template = $pybasedir/nova/virt/interfaces.template</td>
- <td>(StrOpt) Template file for injected network</td>
- </tr>
- <tr>
- <td>instance_dns_domain = </td>
- <td>(StrOpt) Full class name for the DNS Zone for instance IPs</td>
- </tr>
- <tr>
- <td>instance_dns_manager = nova.network.noop_dns_driver.NoopDNSDriver</td>
- <td>(StrOpt) Full class name for the DNS Manager for instance IPs</td>
- </tr>
- <tr>
- <td>iptables_bottom_regex = </td>
- <td>(StrOpt) Regular expression to match iptables rule that should always be on the bottom.</td>
- </tr>
- <tr>
- <td>iptables_drop_action = DROP</td>
- <td>(StrOpt) The table that iptables to jump to when a packet is to be dropped.</td>
- </tr>
- <tr>
- <td>iptables_top_regex = </td>
- <td>(StrOpt) Regular expression to match iptables rule that should always be on the top.</td>
- </tr>
- <tr>
- <td>l3_lib = nova.network.l3.LinuxNetL3</td>
- <td>(StrOpt) Indicates underlying L3 management library</td>
- </tr>
- <tr>
- <td>linuxnet_interface_driver = nova.network.linux_net.LinuxBridgeInterfaceDriver</td>
- <td>(StrOpt) Driver used to create ethernet devices.</td>
- </tr>
- <tr>
- <td>linuxnet_ovs_integration_bridge = br-int</td>
- <td>(StrOpt) Name of Open vSwitch bridge used with linuxnet</td>
- </tr>
- <tr>
- <td>multi_host = False</td>
- <td>(BoolOpt) Default value for multi_host in networks. Also, if set, some rpc network calls will be sent directly to host.</td>
- </tr>
- <tr>
- <td>network_allocate_retries = 0</td>
- <td>(IntOpt) Number of times to retry network allocation on failures</td>
- </tr>
- <tr>
- <td>network_api_class = nova.network.api.API</td>
- <td>(StrOpt) The full class name of the network API class to use</td>
- </tr>
- <tr>
- <td>network_device_mtu = None</td>
- <td>(IntOpt) MTU setting for network interface</td>
- </tr>
- <tr>
- <td>network_driver = nova.network.linux_net</td>
- <td>(StrOpt) Driver to use for network creation</td>
- </tr>
- <tr>
- <td>network_manager = nova.network.manager.VlanManager</td>
- <td>(StrOpt) Full class name for the Manager for network</td>
- </tr>
- <tr>
- <td>network_size = 256</td>
- <td>(IntOpt) Number of addresses in each private subnet</td>
- </tr>
- <tr>
- <td>network_topic = network</td>
- <td>(StrOpt) The topic network nodes listen on</td>
- </tr>
- <tr>
- <td>networks_path = $state_path/networks</td>
- <td>(StrOpt) Location to keep network config files</td>
- </tr>
- <tr>
- <td>num_networks = 1</td>
- <td>(IntOpt) Number of networks to support</td>
- </tr>
- <tr>
- <td>ovs_vsctl_timeout = 120</td>
- <td>(IntOpt) Amount of time, in seconds, that ovs_vsctl should wait for a response from the database. 0 is to wait forever.</td>
- </tr>
- <tr>
- <td>public_interface = eth0</td>
- <td>(StrOpt) Interface for public IP addresses</td>
- </tr>
- <tr>
- <td>routing_source_ip = $my_ip</td>
- <td>(StrOpt) Public IP of network host</td>
- </tr>
- <tr>
- <td>security_group_api = nova</td>
- <td>(StrOpt) The full class name of the security API class</td>
- </tr>
- <tr>
- <td>send_arp_for_ha = False</td>
- <td>(BoolOpt) Send gratuitous ARPs for HA setup</td>
- </tr>
- <tr>
- <td>send_arp_for_ha_count = 3</td>
- <td>(IntOpt) Send this many gratuitous ARPs for HA setup</td>
- </tr>
- <tr>
- <td>share_dhcp_address = False</td>
- <td>(BoolOpt) If True in multi_host mode, all compute hosts share the same dhcp address. The same IP address used for DHCP will be added on each nova-network node which is only visible to the vms on the same host.</td>
- </tr>
- <tr>
- <td>teardown_unused_network_gateway = False</td>
- <td>(BoolOpt) If True, unused gateway devices (VLAN and bridge) are deleted in VLAN network mode with multi hosted networks</td>
- </tr>
- <tr>
- <td>update_dns_entries = False</td>
- <td>(BoolOpt) If True, when a DNS entry must be updated, it sends a fanout cast to all network hosts to update their DNS entries in multi host mode</td>
- </tr>
- <tr>
- <td>use_network_dns_servers = False</td>
- <td>(BoolOpt) If set, uses the dns1 and dns2 from the network ref. as dns servers.</td>
- </tr>
- <tr>
- <td>use_neutron_default_nets = False</td>
- <td>(StrOpt) Control for checking for default networks</td>
- </tr>
- <tr>
- <td>use_single_default_gateway = False</td>
- <td>(BoolOpt) Use single default gateway. Only first nic of vm will get default gateway from dhcp server</td>
- </tr>
- <tr>
- <td>vlan_interface = None</td>
- <td>(StrOpt) VLANs will bridge into this interface if set</td>
- </tr>
- <tr>
- <td>vlan_start = 100</td>
- <td>(IntOpt) First VLAN for private networks</td>
- </tr>
- <tr>
- <th colspan="2">[vmware]</th>
- </tr>
- <tr>
- <td>vlan_interface = vmnic0</td>
- <td>(StrOpt) Physical ethernet adapter name for vlan networking</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_network">
+ <caption>Description of configuration options for network</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>allow_same_net_traffic = True</td>
+ <td>(BoolOpt) Whether to allow network traffic from same network</td>
+ </tr>
+ <tr>
+ <td>auto_assign_floating_ip = False</td>
+ <td>(BoolOpt) Autoassigning floating IP to VM</td>
+ </tr>
+ <tr>
+ <td>cnt_vpn_clients = 0</td>
+ <td>(IntOpt) Number of addresses reserved for vpn clients</td>
+ </tr>
+ <tr>
+ <td>create_unique_mac_address_attempts = 5</td>
+ <td>(IntOpt) Number of attempts to create unique mac address</td>
+ </tr>
+ <tr>
+ <td>default_access_ip_network_name = None</td>
+ <td>(StrOpt) Name of network to use to set access IPs for instances</td>
+ </tr>
+ <tr>
+ <td>default_floating_pool = nova</td>
+ <td>(StrOpt) Default pool for floating IPs</td>
+ </tr>
+ <tr>
+ <td>defer_iptables_apply = False</td>
+ <td>(BoolOpt) Whether to batch up the application of IPTables rules during a host restart and apply all at the end of the init phase</td>
+ </tr>
+ <tr>
+ <td>dhcp_domain = novalocal</td>
+ <td>(StrOpt) Domain to use for building the hostnames</td>
+ </tr>
+ <tr>
+ <td>dhcp_lease_time = 86400</td>
+ <td>(IntOpt) Lifetime of a DHCP lease in seconds</td>
+ </tr>
+ <tr>
+ <td>dhcpbridge = $bindir/nova-dhcpbridge</td>
+ <td>(StrOpt) Location of nova-dhcpbridge</td>
+ </tr>
+ <tr>
+ <td>dhcpbridge_flagfile = ['/etc/nova/nova-dhcpbridge.conf']</td>
+ <td>(MultiStrOpt) Location of flagfiles for dhcpbridge</td>
+ </tr>
+ <tr>
+ <td>dns_server = []</td>
+ <td>(MultiStrOpt) If set, uses specific DNS server for dnsmasq. Can be specified multiple times.</td>
+ </tr>
+ <tr>
+ <td>dns_update_periodic_interval = -1</td>
+ <td>(IntOpt) Number of seconds to wait between runs of updates to DNS entries.</td>
+ </tr>
+ <tr>
+ <td>dnsmasq_config_file = </td>
+ <td>(StrOpt) Override the default dnsmasq settings with this file</td>
+ </tr>
+ <tr>
+ <td>firewall_driver = None</td>
+ <td>(StrOpt) Firewall driver (defaults to hypervisor specific iptables driver)</td>
+ </tr>
+ <tr>
+ <td>fixed_ip_disassociate_timeout = 600</td>
+ <td>(IntOpt) Seconds after which a deallocated IP is disassociated</td>
+ </tr>
+ <tr>
+ <td>flat_injected = False</td>
+ <td>(BoolOpt) Whether to attempt to inject network setup into guest</td>
+ </tr>
+ <tr>
+ <td>flat_interface = None</td>
+ <td>(StrOpt) FlatDhcp will bridge into this interface if set</td>
+ </tr>
+ <tr>
+ <td>flat_network_bridge = None</td>
+ <td>(StrOpt) Bridge for simple network instances</td>
+ </tr>
+ <tr>
+ <td>flat_network_dns = 8.8.4.4</td>
+ <td>(StrOpt) DNS server for simple network</td>
+ </tr>
+ <tr>
+ <td>floating_ip_dns_manager = nova.network.noop_dns_driver.NoopDNSDriver</td>
+ <td>(StrOpt) Full class name for the DNS Manager for floating IPs</td>
+ </tr>
+ <tr>
+ <td>force_dhcp_release = True</td>
+ <td>(BoolOpt) If True, send a dhcp release on instance termination</td>
+ </tr>
+ <tr>
+ <td>force_snat_range = []</td>
+ <td>(MultiStrOpt) Traffic to this range will always be snatted to the fallback ip, even if it would normally be bridged out of the node. Can be specified multiple times.</td>
+ </tr>
+ <tr>
+ <td>forward_bridge_interface = ['all']</td>
+ <td>(MultiStrOpt) An interface that bridges can forward to. If this is set to all then all traffic will be forwarded. Can be specified multiple times.</td>
+ </tr>
+ <tr>
+ <td>gateway = None</td>
+ <td>(StrOpt) Default IPv4 gateway</td>
+ </tr>
+ <tr>
+ <td>injected_network_template = $pybasedir/nova/virt/interfaces.template</td>
+ <td>(StrOpt) Template file for injected network</td>
+ </tr>
+ <tr>
+ <td>instance_dns_domain = </td>
+ <td>(StrOpt) Full class name for the DNS Zone for instance IPs</td>
+ </tr>
+ <tr>
+ <td>instance_dns_manager = nova.network.noop_dns_driver.NoopDNSDriver</td>
+ <td>(StrOpt) Full class name for the DNS Manager for instance IPs</td>
+ </tr>
+ <tr>
+ <td>iptables_bottom_regex = </td>
+ <td>(StrOpt) Regular expression to match iptables rule that should always be on the bottom.</td>
+ </tr>
+ <tr>
+ <td>iptables_drop_action = DROP</td>
+ <td>(StrOpt) The table that iptables to jump to when a packet is to be dropped.</td>
+ </tr>
+ <tr>
+ <td>iptables_top_regex = </td>
+ <td>(StrOpt) Regular expression to match iptables rule that should always be on the top.</td>
+ </tr>
+ <tr>
+ <td>l3_lib = nova.network.l3.LinuxNetL3</td>
+ <td>(StrOpt) Indicates underlying L3 management library</td>
+ </tr>
+ <tr>
+ <td>linuxnet_interface_driver = nova.network.linux_net.LinuxBridgeInterfaceDriver</td>
+ <td>(StrOpt) Driver used to create ethernet devices.</td>
+ </tr>
+ <tr>
+ <td>linuxnet_ovs_integration_bridge = br-int</td>
+ <td>(StrOpt) Name of Open vSwitch bridge used with linuxnet</td>
+ </tr>
+ <tr>
+ <td>multi_host = False</td>
+ <td>(BoolOpt) Default value for multi_host in networks. Also, if set, some rpc network calls will be sent directly to host.</td>
+ </tr>
+ <tr>
+ <td>network_allocate_retries = 0</td>
+ <td>(IntOpt) Number of times to retry network allocation on failures</td>
+ </tr>
+ <tr>
+ <td>network_api_class = nova.network.api.API</td>
+ <td>(StrOpt) The full class name of the network API class to use</td>
+ </tr>
+ <tr>
+ <td>network_device_mtu = None</td>
+ <td>(IntOpt) MTU setting for network interface</td>
+ </tr>
+ <tr>
+ <td>network_driver = nova.network.linux_net</td>
+ <td>(StrOpt) Driver to use for network creation</td>
+ </tr>
+ <tr>
+ <td>network_manager = nova.network.manager.VlanManager</td>
+ <td>(StrOpt) Full class name for the Manager for network</td>
+ </tr>
+ <tr>
+ <td>network_size = 256</td>
+ <td>(IntOpt) Number of addresses in each private subnet</td>
+ </tr>
+ <tr>
+ <td>network_topic = network</td>
+ <td>(StrOpt) The topic network nodes listen on</td>
+ </tr>
+ <tr>
+ <td>networks_path = $state_path/networks</td>
+ <td>(StrOpt) Location to keep network config files</td>
+ </tr>
+ <tr>
+ <td>num_networks = 1</td>
+ <td>(IntOpt) Number of networks to support</td>
+ </tr>
+ <tr>
+ <td>ovs_vsctl_timeout = 120</td>
+ <td>(IntOpt) Amount of time, in seconds, that ovs_vsctl should wait for a response from the database. 0 is to wait forever.</td>
+ </tr>
+ <tr>
+ <td>public_interface = eth0</td>
+ <td>(StrOpt) Interface for public IP addresses</td>
+ </tr>
+ <tr>
+ <td>routing_source_ip = $my_ip</td>
+ <td>(StrOpt) Public IP of network host</td>
+ </tr>
+ <tr>
+ <td>security_group_api = nova</td>
+ <td>(StrOpt) The full class name of the security API class</td>
+ </tr>
+ <tr>
+ <td>send_arp_for_ha = False</td>
+ <td>(BoolOpt) Send gratuitous ARPs for HA setup</td>
+ </tr>
+ <tr>
+ <td>send_arp_for_ha_count = 3</td>
+ <td>(IntOpt) Send this many gratuitous ARPs for HA setup</td>
+ </tr>
+ <tr>
+ <td>share_dhcp_address = False</td>
+ <td>(BoolOpt) DEPRECATED: THIS VALUE SHOULD BE SET WHEN CREATING THE NETWORK. If True in multi_host mode, all compute hosts share the same dhcp address. The same IP address used for DHCP will be added on each nova-network node which is only visible to the vms on the same host.</td>
+ </tr>
+ <tr>
+ <td>teardown_unused_network_gateway = False</td>
+ <td>(BoolOpt) If True, unused gateway devices (VLAN and bridge) are deleted in VLAN network mode with multi hosted networks</td>
+ </tr>
+ <tr>
+ <td>update_dns_entries = False</td>
+ <td>(BoolOpt) If True, when a DNS entry must be updated, it sends a fanout cast to all network hosts to update their DNS entries in multi host mode</td>
+ </tr>
+ <tr>
+ <td>use_network_dns_servers = False</td>
+ <td>(BoolOpt) If set, uses the dns1 and dns2 from the network ref. as dns servers.</td>
+ </tr>
+ <tr>
+ <td>use_neutron_default_nets = False</td>
+ <td>(StrOpt) Control for checking for default networks</td>
+ </tr>
+ <tr>
+ <td>use_single_default_gateway = False</td>
+ <td>(BoolOpt) Use single default gateway. Only first nic of vm will get default gateway from dhcp server</td>
+ </tr>
+ <tr>
+ <td>vlan_interface = None</td>
+ <td>(StrOpt) VLANs will bridge into this interface if set</td>
+ </tr>
+ <tr>
+ <td>vlan_start = 100</td>
+ <td>(IntOpt) First VLAN for private networks</td>
+ </tr>
+ <tr>
+ <th colspan="2">[vmware]</th>
+ </tr>
+ <tr>
+ <td>vlan_interface = vmnic0</td>
+ <td>(StrOpt) Physical ethernet adapter name for vlan networking</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-neutron.xml b/doc/common/tables/nova-neutron.xml
index 3cb1ccdf35..adce4d25a9 100644
--- a/doc/common/tables/nova-neutron.xml
+++ b/doc/common/tables/nova-neutron.xml
@@ -1,87 +1,89 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_neutron">
- <caption>Description of configuration options for neutron</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>neutron_admin_auth_url = http://localhost:5000/v2.0</td>
- <td>(StrOpt) Authorization URL for connecting to neutron in admin context</td>
- </tr>
- <tr>
- <td>neutron_admin_password = None</td>
- <td>(StrOpt) Password for connecting to neutron in admin context</td>
- </tr>
- <tr>
- <td>neutron_admin_tenant_id = None</td>
- <td>(StrOpt) Tenant id for connecting to neutron in admin context</td>
- </tr>
- <tr>
- <td>neutron_admin_tenant_name = None</td>
- <td>(StrOpt) Tenant name for connecting to neutron in admin context. This option is mutually exclusive with neutron_admin_tenant_id. Note that with Keystone V3 tenant names are only unique within a domain.</td>
- </tr>
- <tr>
- <td>neutron_admin_username = None</td>
- <td>(StrOpt) Username for connecting to neutron in admin context</td>
- </tr>
- <tr>
- <td>neutron_api_insecure = False</td>
- <td>(BoolOpt) If set, ignore any SSL validation issues</td>
- </tr>
- <tr>
- <td>neutron_auth_strategy = keystone</td>
- <td>(StrOpt) Authorization strategy for connecting to neutron in admin context</td>
- </tr>
- <tr>
- <td>neutron_ca_certificates_file = None</td>
- <td>(StrOpt) Location of CA certificates file to use for neutron client requests.</td>
- </tr>
- <tr>
- <td>neutron_default_tenant_id = default</td>
- <td>(StrOpt) Default tenant id when creating neutron networks</td>
- </tr>
- <tr>
- <td>neutron_extension_sync_interval = 600</td>
- <td>(IntOpt) Number of seconds before querying neutron for extensions</td>
- </tr>
- <tr>
- <td>neutron_metadata_proxy_shared_secret = </td>
- <td>(StrOpt) Shared secret to validate proxies Neutron metadata requests</td>
- </tr>
- <tr>
- <td>neutron_ovs_bridge = br-int</td>
- <td>(StrOpt) Name of Integration Bridge used by Open vSwitch</td>
- </tr>
- <tr>
- <td>neutron_region_name = None</td>
- <td>(StrOpt) Region name for connecting to neutron in admin context</td>
- </tr>
- <tr>
- <td>neutron_url = http://127.0.0.1:9696</td>
- <td>(StrOpt) URL for connecting to neutron</td>
- </tr>
- <tr>
- <td>neutron_url_timeout = 30</td>
- <td>(IntOpt) Timeout value for connecting to neutron in seconds</td>
- </tr>
- <tr>
- <td>service_neutron_metadata_proxy = False</td>
- <td>(BoolOpt) Set flag to indicate Neutron will proxy metadata requests and resolve instance ids.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_neutron">
+ <caption>Description of configuration options for neutron</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>neutron_default_tenant_id = default</td>
+ <td>(StrOpt) Default tenant id when creating neutron networks</td>
+ </tr>
+ <tr>
+ <td>neutron_metadata_proxy_shared_secret = </td>
+ <td>(StrOpt) Shared secret to validate proxies Neutron metadata requests</td>
+ </tr>
+ <tr>
+ <td>service_neutron_metadata_proxy = False</td>
+ <td>(BoolOpt) Set flag to indicate Neutron will proxy metadata requests and resolve instance ids.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[neutron]</th>
+ </tr>
+ <tr>
+ <td>admin_auth_url = http://localhost:5000/v2.0</td>
+ <td>(StrOpt) Authorization URL for connecting to neutron in admin context</td>
+ </tr>
+ <tr>
+ <td>admin_password = None</td>
+ <td>(StrOpt) Password for connecting to neutron in admin context</td>
+ </tr>
+ <tr>
+ <td>admin_tenant_id = None</td>
+ <td>(StrOpt) Tenant id for connecting to neutron in admin context</td>
+ </tr>
+ <tr>
+ <td>admin_tenant_name = None</td>
+ <td>(StrOpt) Tenant name for connecting to neutron in admin context. This option is mutually exclusive with admin_tenant_id. Note that with Keystone V3 tenant names are only unique within a domain.</td>
+ </tr>
+ <tr>
+ <td>admin_username = None</td>
+ <td>(StrOpt) Username for connecting to neutron in admin context</td>
+ </tr>
+ <tr>
+ <td>api_insecure = False</td>
+ <td>(BoolOpt) If set, ignore any SSL validation issues</td>
+ </tr>
+ <tr>
+ <td>auth_strategy = keystone</td>
+ <td>(StrOpt) Authorization strategy for connecting to neutron in admin context</td>
+ </tr>
+ <tr>
+ <td>ca_certificates_file = None</td>
+ <td>(StrOpt) Location of CA certificates file to use for neutron client requests.</td>
+ </tr>
+ <tr>
+ <td>extension_sync_interval = 600</td>
+ <td>(IntOpt) Number of seconds before querying neutron for extensions</td>
+ </tr>
+ <tr>
+ <td>ovs_bridge = br-int</td>
+ <td>(StrOpt) Name of Integration Bridge used by Open vSwitch</td>
+ </tr>
+ <tr>
+ <td>region_name = None</td>
+ <td>(StrOpt) Region name for connecting to neutron in admin context</td>
+ </tr>
+ <tr>
+ <td>url = http://127.0.0.1:9696</td>
+ <td>(StrOpt) URL for connecting to neutron</td>
+ </tr>
+ <tr>
+ <td>url_timeout = 30</td>
+ <td>(IntOpt) Timeout value for connecting to neutron in seconds</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-pci.xml b/doc/common/tables/nova-pci.xml
index 0d21ffa7ee..dc74766e72 100644
--- a/doc/common/tables/nova-pci.xml
+++ b/doc/common/tables/nova-pci.xml
@@ -1,31 +1,30 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_pci">
- <caption>Description of configuration options for pci</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>pci_alias = []</td>
- <td>(MultiStrOpt) An alias for a PCI passthrough device requirement. This allows users to specify the alias in the extra_spec for a flavor, without needing to repeat all the PCI property requirements. For example: pci_alias = { "name": "QuicAssist", "product_id": "0443", "vendor_id": "8086", "device_type": "ACCEL" } defines an alias for the Intel QuickAssist card. (multi valued)</td>
- </tr>
- <tr>
- <td>pci_passthrough_whitelist = []</td>
- <td>(MultiStrOpt) White list of PCI devices available to VMs. For example: pci_passthrough_whitelist = [{"vendor_id": "8086", "product_id": "0443"}]</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_pci">
+ <caption>Description of configuration options for pci</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>pci_alias = []</td>
+ <td>(MultiStrOpt) An alias for a PCI passthrough device requirement. This allows users to specify the alias in the extra_spec for a flavor, without needing to repeat all the PCI property requirements. For example: pci_alias = { "name": "QuicAssist", "product_id": "0443", "vendor_id": "8086", "device_type": "ACCEL" } defines an alias for the Intel QuickAssist card. (multi valued)</td>
+ </tr>
+ <tr>
+ <td>pci_passthrough_whitelist = []</td>
+ <td>(MultiStrOpt) White list of PCI devices available to VMs. For example: pci_passthrough_whitelist = [{"vendor_id": "8086", "product_id": "0443"}]</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-periodic.xml b/doc/common/tables/nova-periodic.xml
index 7e3b7641cf..24483b91ef 100644
--- a/doc/common/tables/nova-periodic.xml
+++ b/doc/common/tables/nova-periodic.xml
@@ -1,35 +1,34 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_periodic">
- <caption>Description of configuration options for periodic</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>periodic_enable = True</td>
- <td>(BoolOpt) Enable periodic tasks</td>
- </tr>
- <tr>
- <td>periodic_fuzzy_delay = 60</td>
- <td>(IntOpt) Range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0)</td>
- </tr>
- <tr>
- <td>run_external_periodic_tasks = True</td>
- <td>(BoolOpt) Some periodic tasks can be run in a separate process. Should we run them here?</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_periodic">
+ <caption>Description of configuration options for periodic</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>periodic_enable = True</td>
+ <td>(BoolOpt) Enable periodic tasks</td>
+ </tr>
+ <tr>
+ <td>periodic_fuzzy_delay = 60</td>
+ <td>(IntOpt) Range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0)</td>
+ </tr>
+ <tr>
+ <td>run_external_periodic_tasks = True</td>
+ <td>(BoolOpt) Some periodic tasks can be run in a separate process. Should we run them here?</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-policy.xml b/doc/common/tables/nova-policy.xml
index b1101cc72d..b11416dcd9 100644
--- a/doc/common/tables/nova-policy.xml
+++ b/doc/common/tables/nova-policy.xml
@@ -1,79 +1,78 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_policy">
- <caption>Description of configuration options for policy</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>allow_instance_snapshots = True</td>
- <td>(BoolOpt) Permit instance snapshot operations.</td>
- </tr>
- <tr>
- <td>allow_migrate_to_same_host = False</td>
- <td>(BoolOpt) Allow migrate machine to the same host. Useful when testing in single-host environments.</td>
- </tr>
- <tr>
- <td>allow_resize_to_same_host = False</td>
- <td>(BoolOpt) Allow destination machine to match source for resize. Useful when testing in single-host environments.</td>
- </tr>
- <tr>
- <td>max_age = 0</td>
- <td>(IntOpt) Number of seconds between subsequent usage refreshes</td>
- </tr>
- <tr>
- <td>max_local_block_devices = 3</td>
- <td>(IntOpt) Maximum number of devices that will result in a local image being created on the hypervisor node. Setting this to 0 means nova will allow only boot from volume. A negative number means unlimited.</td>
- </tr>
- <tr>
- <td>osapi_compute_unique_server_name_scope = </td>
- <td>(StrOpt) When set, compute API will consider duplicate hostnames invalid within the specified scope, regardless of case. Should be empty, "project" or "global".</td>
- </tr>
- <tr>
- <td>osapi_max_limit = 1000</td>
- <td>(IntOpt) The maximum number of items returned in a single response from a collection resource</td>
- </tr>
- <tr>
- <td>osapi_max_request_body_size = 114688</td>
- <td>(IntOpt) The maximum body size per each osapi request(bytes)</td>
- </tr>
- <tr>
- <td>password_length = 12</td>
- <td>(IntOpt) Length of generated instance admin passwords</td>
- </tr>
- <tr>
- <td>policy_default_rule = default</td>
- <td>(StrOpt) Rule checked when requested rule is not found</td>
- </tr>
- <tr>
- <td>policy_file = policy.json</td>
- <td>(StrOpt) JSON file representing policy</td>
- </tr>
- <tr>
- <td>reservation_expire = 86400</td>
- <td>(IntOpt) Number of seconds until a reservation expires</td>
- </tr>
- <tr>
- <td>resize_fs_using_block_device = False</td>
- <td>(BoolOpt) Attempt to resize the filesystem by accessing the image over a block device. This is done by the host and may not be necessary if the image contains a recent version of cloud-init. Possible mechanisms require the nbd driver (for qcow and raw), or loop (for raw).</td>
- </tr>
- <tr>
- <td>until_refresh = 0</td>
- <td>(IntOpt) Count of reservations until usage is refreshed</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_policy">
+ <caption>Description of configuration options for policy</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>allow_instance_snapshots = True</td>
+ <td>(BoolOpt) Permit instance snapshot operations.</td>
+ </tr>
+ <tr>
+ <td>allow_migrate_to_same_host = False</td>
+ <td>(BoolOpt) Allow migrate machine to the same host. Useful when testing in single-host environments.</td>
+ </tr>
+ <tr>
+ <td>allow_resize_to_same_host = False</td>
+ <td>(BoolOpt) Allow destination machine to match source for resize. Useful when testing in single-host environments.</td>
+ </tr>
+ <tr>
+ <td>max_age = 0</td>
+ <td>(IntOpt) Number of seconds between subsequent usage refreshes</td>
+ </tr>
+ <tr>
+ <td>max_local_block_devices = 3</td>
+ <td>(IntOpt) Maximum number of devices that will result in a local image being created on the hypervisor node. Setting this to 0 means nova will allow only boot from volume. A negative number means unlimited.</td>
+ </tr>
+ <tr>
+ <td>osapi_compute_unique_server_name_scope = </td>
+ <td>(StrOpt) When set, compute API will consider duplicate hostnames invalid within the specified scope, regardless of case. Should be empty, "project" or "global".</td>
+ </tr>
+ <tr>
+ <td>osapi_max_limit = 1000</td>
+ <td>(IntOpt) The maximum number of items returned in a single response from a collection resource</td>
+ </tr>
+ <tr>
+ <td>osapi_max_request_body_size = 114688</td>
+ <td>(IntOpt) The maximum body size per each osapi request(bytes)</td>
+ </tr>
+ <tr>
+ <td>password_length = 12</td>
+ <td>(IntOpt) Length of generated instance admin passwords</td>
+ </tr>
+ <tr>
+ <td>policy_default_rule = default</td>
+ <td>(StrOpt) Default rule. Enforced when a requested rule is not found.</td>
+ </tr>
+ <tr>
+ <td>policy_file = policy.json</td>
+ <td>(StrOpt) The JSON file that defines policies.</td>
+ </tr>
+ <tr>
+ <td>reservation_expire = 86400</td>
+ <td>(IntOpt) Number of seconds until a reservation expires</td>
+ </tr>
+ <tr>
+ <td>resize_fs_using_block_device = False</td>
+ <td>(BoolOpt) Attempt to resize the filesystem by accessing the image over a block device. This is done by the host and may not be necessary if the image contains a recent version of cloud-init. Possible mechanisms require the nbd driver (for qcow and raw), or loop (for raw).</td>
+ </tr>
+ <tr>
+ <td>until_refresh = 0</td>
+ <td>(IntOpt) Count of reservations until usage is refreshed</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-qpid.xml b/doc/common/tables/nova-qpid.xml
index d8390c16dd..9e2b14f9c2 100644
--- a/doc/common/tables/nova-qpid.xml
+++ b/doc/common/tables/nova-qpid.xml
@@ -1,63 +1,62 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_qpid">
- <caption>Description of configuration options for qpid</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>qpid_heartbeat = 60</td>
- <td>(IntOpt) Seconds between connection keepalive heartbeats.</td>
- </tr>
- <tr>
- <td>qpid_hostname = localhost</td>
- <td>(StrOpt) Qpid broker hostname.</td>
- </tr>
- <tr>
- <td>qpid_hosts = $qpid_hostname:$qpid_port</td>
- <td>(ListOpt) Qpid HA cluster host:port pairs.</td>
- </tr>
- <tr>
- <td>qpid_password = </td>
- <td>(StrOpt) Password for Qpid connection.</td>
- </tr>
- <tr>
- <td>qpid_port = 5672</td>
- <td>(IntOpt) Qpid broker port.</td>
- </tr>
- <tr>
- <td>qpid_protocol = tcp</td>
- <td>(StrOpt) Transport to use, either 'tcp' or 'ssl'.</td>
- </tr>
- <tr>
- <td>qpid_sasl_mechanisms = </td>
- <td>(StrOpt) Space separated list of SASL mechanisms to use for auth.</td>
- </tr>
- <tr>
- <td>qpid_tcp_nodelay = True</td>
- <td>(BoolOpt) Whether to disable the Nagle algorithm.</td>
- </tr>
- <tr>
- <td>qpid_topology_version = 1</td>
- <td>(IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.</td>
- </tr>
- <tr>
- <td>qpid_username = </td>
- <td>(StrOpt) Username for Qpid connection.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_qpid">
+ <caption>Description of configuration options for qpid</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>qpid_heartbeat = 60</td>
+ <td>(IntOpt) Seconds between connection keepalive heartbeats.</td>
+ </tr>
+ <tr>
+ <td>qpid_hostname = localhost</td>
+ <td>(StrOpt) Qpid broker hostname.</td>
+ </tr>
+ <tr>
+ <td>qpid_hosts = $qpid_hostname:$qpid_port</td>
+ <td>(ListOpt) Qpid HA cluster host:port pairs.</td>
+ </tr>
+ <tr>
+ <td>qpid_password = </td>
+ <td>(StrOpt) Password for Qpid connection.</td>
+ </tr>
+ <tr>
+ <td>qpid_port = 5672</td>
+ <td>(IntOpt) Qpid broker port.</td>
+ </tr>
+ <tr>
+ <td>qpid_protocol = tcp</td>
+ <td>(StrOpt) Transport to use, either 'tcp' or 'ssl'.</td>
+ </tr>
+ <tr>
+ <td>qpid_sasl_mechanisms = </td>
+ <td>(StrOpt) Space separated list of SASL mechanisms to use for auth.</td>
+ </tr>
+ <tr>
+ <td>qpid_tcp_nodelay = True</td>
+ <td>(BoolOpt) Whether to disable the Nagle algorithm.</td>
+ </tr>
+ <tr>
+ <td>qpid_topology_version = 1</td>
+ <td>(IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.</td>
+ </tr>
+ <tr>
+ <td>qpid_username = </td>
+ <td>(StrOpt) Username for Qpid connection.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-quota.xml b/doc/common/tables/nova-quota.xml
index cb67cf162c..6d9720d353 100644
--- a/doc/common/tables/nova-quota.xml
+++ b/doc/common/tables/nova-quota.xml
@@ -1,90 +1,89 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_quota">
- <caption>Description of configuration options for quota</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>bandwidth_poll_interval = 600</td>
- <td>(IntOpt) Interval to pull network bandwidth usage info. Not supported on all hypervisors. Set to 0 to disable.</td>
- </tr>
- <tr>
- <td>enable_network_quota = False</td>
- <td>(BoolOpt) Enables or disables quota checking for tenant networks</td>
- </tr>
- <tr>
- <td>quota_cores = 20</td>
- <td>(IntOpt) Number of instance cores allowed per project</td>
- </tr>
- <tr>
- <td>quota_driver = nova.quota.DbQuotaDriver</td>
- <td>(StrOpt) Default driver to use for quota checks</td>
- </tr>
- <tr>
- <td>quota_fixed_ips = -1</td>
- <td>(IntOpt) Number of fixed IPs allowed per project (this should be at least the number of instances allowed)</td>
- </tr>
- <tr>
- <td>quota_floating_ips = 10</td>
- <td>(IntOpt) Number of floating IPs allowed per project</td>
- </tr>
- <tr>
- <td>quota_injected_file_content_bytes = 10240</td>
- <td>(IntOpt) Number of bytes allowed per injected file</td>
- </tr>
- <tr>
- <td>quota_injected_file_path_bytes = 255</td>
- <td>(IntOpt) Number of bytes allowed per injected file path</td>
- </tr>
- <tr>
- <td>quota_injected_files = 5</td>
- <td>(IntOpt) Number of injected files allowed</td>
- </tr>
- <tr>
- <td>quota_instances = 10</td>
- <td>(IntOpt) Number of instances allowed per project</td>
- </tr>
- <tr>
- <td>quota_key_pairs = 100</td>
- <td>(IntOpt) Number of key pairs per user</td>
- </tr>
- <tr>
- <td>quota_metadata_items = 128</td>
- <td>(IntOpt) Number of metadata items allowed per instance</td>
- </tr>
- <tr>
- <td>quota_ram = 51200</td>
- <td>(IntOpt) Megabytes of instance RAM allowed per project</td>
- </tr>
- <tr>
- <td>quota_security_group_rules = 20</td>
- <td>(IntOpt) Number of security rules per security group</td>
- </tr>
- <tr>
- <td>quota_security_groups = 10</td>
- <td>(IntOpt) Number of security groups per project</td>
- </tr>
- <tr>
- <th colspan="2">[cells]</th>
- </tr>
- <tr>
- <td>bandwidth_update_interval = 600</td>
- <td>(IntOpt) Seconds between bandwidth updates for cells.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_quota">
+ <caption>Description of configuration options for quota</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>bandwidth_poll_interval = 600</td>
+ <td>(IntOpt) Interval to pull network bandwidth usage info. Not supported on all hypervisors. Set to -1 to disable. Setting this to 0 will disable, but this will change in the K release to mean "run at the default rate".</td>
+ </tr>
+ <tr>
+ <td>enable_network_quota = False</td>
+ <td>(BoolOpt) Enables or disables quota checking for tenant networks</td>
+ </tr>
+ <tr>
+ <td>quota_cores = 20</td>
+ <td>(IntOpt) Number of instance cores allowed per project</td>
+ </tr>
+ <tr>
+ <td>quota_driver = nova.quota.DbQuotaDriver</td>
+ <td>(StrOpt) Default driver to use for quota checks</td>
+ </tr>
+ <tr>
+ <td>quota_fixed_ips = -1</td>
+ <td>(IntOpt) Number of fixed IPs allowed per project (this should be at least the number of instances allowed)</td>
+ </tr>
+ <tr>
+ <td>quota_floating_ips = 10</td>
+ <td>(IntOpt) Number of floating IPs allowed per project</td>
+ </tr>
+ <tr>
+ <td>quota_injected_file_content_bytes = 10240</td>
+ <td>(IntOpt) Number of bytes allowed per injected file</td>
+ </tr>
+ <tr>
+ <td>quota_injected_file_path_length = 255</td>
+ <td>(IntOpt) Length of injected file path</td>
+ </tr>
+ <tr>
+ <td>quota_injected_files = 5</td>
+ <td>(IntOpt) Number of injected files allowed</td>
+ </tr>
+ <tr>
+ <td>quota_instances = 10</td>
+ <td>(IntOpt) Number of instances allowed per project</td>
+ </tr>
+ <tr>
+ <td>quota_key_pairs = 100</td>
+ <td>(IntOpt) Number of key pairs per user</td>
+ </tr>
+ <tr>
+ <td>quota_metadata_items = 128</td>
+ <td>(IntOpt) Number of metadata items allowed per instance</td>
+ </tr>
+ <tr>
+ <td>quota_ram = 51200</td>
+ <td>(IntOpt) Megabytes of instance RAM allowed per project</td>
+ </tr>
+ <tr>
+ <td>quota_security_group_rules = 20</td>
+ <td>(IntOpt) Number of security rules per security group</td>
+ </tr>
+ <tr>
+ <td>quota_security_groups = 10</td>
+ <td>(IntOpt) Number of security groups per project</td>
+ </tr>
+ <tr>
+ <th colspan="2">[cells]</th>
+ </tr>
+ <tr>
+ <td>bandwidth_update_interval = 600</td>
+ <td>(IntOpt) Seconds between bandwidth updates for cells.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-rabbitmq.xml b/doc/common/tables/nova-rabbitmq.xml
index 05e4a96203..b042b82423 100644
--- a/doc/common/tables/nova-rabbitmq.xml
+++ b/doc/common/tables/nova-rabbitmq.xml
@@ -1,71 +1,70 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_rabbitmq">
- <caption>Description of configuration options for rabbitmq</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>rabbit_ha_queues = False</td>
- <td>(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database.</td>
- </tr>
- <tr>
- <td>rabbit_host = localhost</td>
- <td>(StrOpt) The RabbitMQ broker address where a single node is used.</td>
- </tr>
- <tr>
- <td>rabbit_hosts = $rabbit_host:$rabbit_port</td>
- <td>(ListOpt) RabbitMQ HA cluster host:port pairs.</td>
- </tr>
- <tr>
- <td>rabbit_login_method = AMQPLAIN</td>
- <td>(StrOpt) the RabbitMQ login method</td>
- </tr>
- <tr>
- <td>rabbit_max_retries = 0</td>
- <td>(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).</td>
- </tr>
- <tr>
- <td>rabbit_password = guest</td>
- <td>(StrOpt) The RabbitMQ password.</td>
- </tr>
- <tr>
- <td>rabbit_port = 5672</td>
- <td>(IntOpt) The RabbitMQ broker port where a single node is used.</td>
- </tr>
- <tr>
- <td>rabbit_retry_backoff = 2</td>
- <td>(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.</td>
- </tr>
- <tr>
- <td>rabbit_retry_interval = 1</td>
- <td>(IntOpt) How frequently to retry connecting with RabbitMQ.</td>
- </tr>
- <tr>
- <td>rabbit_use_ssl = False</td>
- <td>(BoolOpt) Connect over SSL for RabbitMQ.</td>
- </tr>
- <tr>
- <td>rabbit_userid = guest</td>
- <td>(StrOpt) The RabbitMQ userid.</td>
- </tr>
- <tr>
- <td>rabbit_virtual_host = /</td>
- <td>(StrOpt) The RabbitMQ virtual host.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_rabbitmq">
+ <caption>Description of configuration options for rabbitmq</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>rabbit_ha_queues = False</td>
+ <td>(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database.</td>
+ </tr>
+ <tr>
+ <td>rabbit_host = localhost</td>
+ <td>(StrOpt) The RabbitMQ broker address where a single node is used.</td>
+ </tr>
+ <tr>
+ <td>rabbit_hosts = $rabbit_host:$rabbit_port</td>
+ <td>(ListOpt) RabbitMQ HA cluster host:port pairs.</td>
+ </tr>
+ <tr>
+ <td>rabbit_login_method = AMQPLAIN</td>
+ <td>(StrOpt) the RabbitMQ login method</td>
+ </tr>
+ <tr>
+ <td>rabbit_max_retries = 0</td>
+ <td>(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).</td>
+ </tr>
+ <tr>
+ <td>rabbit_password = guest</td>
+ <td>(StrOpt) The RabbitMQ password.</td>
+ </tr>
+ <tr>
+ <td>rabbit_port = 5672</td>
+ <td>(IntOpt) The RabbitMQ broker port where a single node is used.</td>
+ </tr>
+ <tr>
+ <td>rabbit_retry_backoff = 2</td>
+ <td>(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.</td>
+ </tr>
+ <tr>
+ <td>rabbit_retry_interval = 1</td>
+ <td>(IntOpt) How frequently to retry connecting with RabbitMQ.</td>
+ </tr>
+ <tr>
+ <td>rabbit_use_ssl = False</td>
+ <td>(BoolOpt) Connect over SSL for RabbitMQ.</td>
+ </tr>
+ <tr>
+ <td>rabbit_userid = guest</td>
+ <td>(StrOpt) The RabbitMQ userid.</td>
+ </tr>
+ <tr>
+ <td>rabbit_virtual_host = /</td>
+ <td>(StrOpt) The RabbitMQ virtual host.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-rdp.xml b/doc/common/tables/nova-rdp.xml
index d7a187287a..49932e030d 100644
--- a/doc/common/tables/nova-rdp.xml
+++ b/doc/common/tables/nova-rdp.xml
@@ -1,31 +1,30 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_rdp">
- <caption>Description of configuration options for rdp</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">[rdp]</th>
- </tr>
- <tr>
- <td>enabled = False</td>
- <td>(BoolOpt) Enable RDP related features</td>
- </tr>
- <tr>
- <td>html5_proxy_base_url = http://127.0.0.1:6083/</td>
- <td>(StrOpt) Location of RDP html5 console proxy, in the form "http://127.0.0.1:6083/"</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_rdp">
+ <caption>Description of configuration options for rdp</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">[rdp]</th>
+ </tr>
+ <tr>
+ <td>enabled = False</td>
+ <td>(BoolOpt) Enable RDP related features</td>
+ </tr>
+ <tr>
+ <td>html5_proxy_base_url = http://127.0.0.1:6083/</td>
+ <td>(StrOpt) Location of RDP html5 console proxy, in the form "http://127.0.0.1:6083/"</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-redis.xml b/doc/common/tables/nova-redis.xml
index 021ac3ab70..18d0f60e7e 100644
--- a/doc/common/tables/nova-redis.xml
+++ b/doc/common/tables/nova-redis.xml
@@ -1,27 +1,26 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_redis">
- <caption>Description of configuration options for redis</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>password = None</td>
- <td>(StrOpt) Password for Redis server (optional).</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_redis">
+ <caption>Description of configuration options for redis</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>password = None</td>
+ <td>(StrOpt) Password for Redis server (optional).</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-rootwrap.xml b/doc/common/tables/nova-rootwrap.xml
index ba3b0cf055..cca4b21b70 100644
--- a/doc/common/tables/nova-rootwrap.xml
+++ b/doc/common/tables/nova-rootwrap.xml
@@ -1,43 +1,42 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_rootwrap">
- <caption>Description of configuration options for rootwrap</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>filters_path = /etc/nova/rootwrap.d,/usr/share/nova/rootwrap</td>
- <td>List of directories to load filter definitions from (separated by ','). These directories MUST all be only writeable by root !</td>
- </tr>
- <tr>
- <td>exec_dirs = /sbin,/usr/sbin,/bin,/usr/bin</td>
- <td>List of directories to search executables in, in case filters do not explicitely specify a full path (separated by ',') If not specified, defaults to system PATH environment variable. These directories MUST all be only writeable by root !</td>
- </tr>
- <tr>
- <td>use_syslog = False</td>
- <td>Enable logging to syslog Default value is False</td>
- </tr>
- <tr>
- <td>syslog_log_facility = syslog</td>
- <td>Which syslog facility to use. Valid values include auth, authpriv, syslog, user0, user1... Default value is 'syslog'</td>
- </tr>
- <tr>
- <td>syslog_log_level = ERROR</td>
- <td>Which messages to log. INFO means log all usage ERROR means only log unsuccessful attempts</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_rootwrap">
+ <caption>Description of configuration options for rootwrap</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>filters_path = /etc/nova/rootwrap.d,/usr/share/nova/rootwrap</td>
+ <td>List of directories to load filter definitions from (separated by ','). These directories MUST all be only writeable by root !</td>
+ </tr>
+ <tr>
+ <td>exec_dirs = /sbin,/usr/sbin,/bin,/usr/bin</td>
+ <td>List of directories to search executables in, in case filters do not explicitely specify a full path (separated by ',') If not specified, defaults to system PATH environment variable. These directories MUST all be only writeable by root !</td>
+ </tr>
+ <tr>
+ <td>use_syslog = False</td>
+ <td>Enable logging to syslog Default value is False</td>
+ </tr>
+ <tr>
+ <td>syslog_log_facility = syslog</td>
+ <td>Which syslog facility to use. Valid values include auth, authpriv, syslog, local0, local1... Default value is 'syslog'</td>
+ </tr>
+ <tr>
+ <td>syslog_log_level = ERROR</td>
+ <td>Which messages to log. INFO means log all usage ERROR means only log unsuccessful attempts</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-rpc.xml b/doc/common/tables/nova-rpc.xml
index 2beecc2e6e..ead44134fc 100644
--- a/doc/common/tables/nova-rpc.xml
+++ b/doc/common/tables/nova-rpc.xml
@@ -1,84 +1,83 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_rpc">
- <caption>Description of configuration options for rpc</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>amqp_auto_delete = False</td>
- <td>(BoolOpt) Auto-delete queues in amqp.</td>
- </tr>
- <tr>
- <td>amqp_durable_queues = False</td>
- <td>(BoolOpt) Use durable queues in amqp.</td>
- </tr>
- <tr>
- <td>control_exchange = openstack</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>matchmaker_heartbeat_freq = 300</td>
- <td>(IntOpt) Heartbeat frequency.</td>
- </tr>
- <tr>
- <td>matchmaker_heartbeat_ttl = 600</td>
- <td>(IntOpt) Heartbeat time-to-live.</td>
- </tr>
- <tr>
- <td>rpc_backend = rabbit</td>
- <td>(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq.</td>
- </tr>
- <tr>
- <td>rpc_cast_timeout = 30</td>
- <td>(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq.</td>
- </tr>
- <tr>
- <td>rpc_conn_pool_size = 30</td>
- <td>(IntOpt) Size of RPC connection pool.</td>
- </tr>
- <tr>
- <td>rpc_response_timeout = 60</td>
- <td>(IntOpt) Seconds to wait for a response from a call.</td>
- </tr>
- <tr>
- <td>rpc_thread_pool_size = 64</td>
- <td>(IntOpt) Size of RPC greenthread pool.</td>
- </tr>
- <tr>
- <th colspan="2">[cells]</th>
- </tr>
- <tr>
- <td>rpc_driver_queue_base = cells.intercell</td>
- <td>(StrOpt) Base queue name to use when communicating between cells. Various topics by message type will be appended to this.</td>
- </tr>
- <tr>
- <th colspan="2">[matchmaker_ring]</th>
- </tr>
- <tr>
- <td>ringfile = /etc/oslo/matchmaker_ring.json</td>
- <td>(StrOpt) Matchmaker ring file (JSON).</td>
- </tr>
- <tr>
- <th colspan="2">[upgrade_levels]</th>
- </tr>
- <tr>
- <td>baseapi = None</td>
- <td>(StrOpt) Set a version cap for messages sent to the base api in any service</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_rpc">
+ <caption>Description of configuration options for rpc</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>amqp_auto_delete = False</td>
+ <td>(BoolOpt) Auto-delete queues in amqp.</td>
+ </tr>
+ <tr>
+ <td>amqp_durable_queues = False</td>
+ <td>(BoolOpt) Use durable queues in amqp.</td>
+ </tr>
+ <tr>
+ <td>control_exchange = openstack</td>
+ <td>(StrOpt) AMQP exchange to connect to if using RabbitMQ or Qpid</td>
+ </tr>
+ <tr>
+ <td>matchmaker_heartbeat_freq = 300</td>
+ <td>(IntOpt) Heartbeat frequency.</td>
+ </tr>
+ <tr>
+ <td>matchmaker_heartbeat_ttl = 600</td>
+ <td>(IntOpt) Heartbeat time-to-live.</td>
+ </tr>
+ <tr>
+ <td>rpc_backend = nova.openstack.common.rpc.impl_kombu</td>
+ <td>(StrOpt) The messaging module to use, defaults to kombu.</td>
+ </tr>
+ <tr>
+ <td>rpc_cast_timeout = 30</td>
+ <td>(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq.</td>
+ </tr>
+ <tr>
+ <td>rpc_conn_pool_size = 30</td>
+ <td>(IntOpt) Size of RPC connection pool</td>
+ </tr>
+ <tr>
+ <td>rpc_response_timeout = 60</td>
+ <td>(IntOpt) Seconds to wait for a response from call or multicall</td>
+ </tr>
+ <tr>
+ <td>rpc_thread_pool_size = 64</td>
+ <td>(IntOpt) Size of RPC thread pool</td>
+ </tr>
+ <tr>
+ <th colspan="2">[cells]</th>
+ </tr>
+ <tr>
+ <td>rpc_driver_queue_base = cells.intercell</td>
+ <td>(StrOpt) Base queue name to use when communicating between cells. Various topics by message type will be appended to this.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[matchmaker_ring]</th>
+ </tr>
+ <tr>
+ <td>ringfile = /etc/oslo/matchmaker_ring.json</td>
+ <td>(StrOpt) Matchmaker ring file (JSON).</td>
+ </tr>
+ <tr>
+ <th colspan="2">[upgrade_levels]</th>
+ </tr>
+ <tr>
+ <td>baseapi = None</td>
+ <td>(StrOpt) Set a version cap for messages sent to the base api in any service</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-rpc_all.xml b/doc/common/tables/nova-rpc_all.xml
index 64d21a1ca5..7ada568052 100644
--- a/doc/common/tables/nova-rpc_all.xml
+++ b/doc/common/tables/nova-rpc_all.xml
@@ -1,220 +1,219 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_rpc_all">
- <caption>Description of configuration options for rpc_all</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>amqp_auto_delete = False</td>
- <td>(BoolOpt) Auto-delete queues in amqp.</td>
- </tr>
- <tr>
- <td>amqp_durable_queues = False</td>
- <td>(BoolOpt) Use durable queues in amqp.</td>
- </tr>
- <tr>
- <td>control_exchange = openstack</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>kombu_reconnect_delay = 1.0</td>
- <td>(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.</td>
- </tr>
- <tr>
- <td>kombu_ssl_ca_certs = </td>
- <td>(StrOpt) SSL certification authority file (valid only if SSL enabled).</td>
- </tr>
- <tr>
- <td>kombu_ssl_certfile = </td>
- <td>(StrOpt) SSL cert file (valid only if SSL enabled).</td>
- </tr>
- <tr>
- <td>kombu_ssl_keyfile = </td>
- <td>(StrOpt) SSL key file (valid only if SSL enabled).</td>
- </tr>
- <tr>
- <td>kombu_ssl_version = </td>
- <td>(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions.</td>
- </tr>
- <tr>
- <td>matchmaker_heartbeat_freq = 300</td>
- <td>(IntOpt) Heartbeat frequency.</td>
- </tr>
- <tr>
- <td>matchmaker_heartbeat_ttl = 600</td>
- <td>(IntOpt) Heartbeat time-to-live.</td>
- </tr>
- <tr>
- <td>qpid_heartbeat = 60</td>
- <td>(IntOpt) Seconds between connection keepalive heartbeats.</td>
- </tr>
- <tr>
- <td>qpid_hostname = localhost</td>
- <td>(StrOpt) Qpid broker hostname.</td>
- </tr>
- <tr>
- <td>qpid_hosts = $qpid_hostname:$qpid_port</td>
- <td>(ListOpt) Qpid HA cluster host:port pairs.</td>
- </tr>
- <tr>
- <td>qpid_password = </td>
- <td>(StrOpt) Password for Qpid connection.</td>
- </tr>
- <tr>
- <td>qpid_port = 5672</td>
- <td>(IntOpt) Qpid broker port.</td>
- </tr>
- <tr>
- <td>qpid_protocol = tcp</td>
- <td>(StrOpt) Transport to use, either 'tcp' or 'ssl'.</td>
- </tr>
- <tr>
- <td>qpid_sasl_mechanisms = </td>
- <td>(StrOpt) Space separated list of SASL mechanisms to use for auth.</td>
- </tr>
- <tr>
- <td>qpid_tcp_nodelay = True</td>
- <td>(BoolOpt) Whether to disable the Nagle algorithm.</td>
- </tr>
- <tr>
- <td>qpid_topology_version = 1</td>
- <td>(IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.</td>
- </tr>
- <tr>
- <td>qpid_username = </td>
- <td>(StrOpt) Username for Qpid connection.</td>
- </tr>
- <tr>
- <td>rabbit_ha_queues = False</td>
- <td>(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database.</td>
- </tr>
- <tr>
- <td>rabbit_host = localhost</td>
- <td>(StrOpt) The RabbitMQ broker address where a single node is used.</td>
- </tr>
- <tr>
- <td>rabbit_hosts = $rabbit_host:$rabbit_port</td>
- <td>(ListOpt) RabbitMQ HA cluster host:port pairs.</td>
- </tr>
- <tr>
- <td>rabbit_login_method = AMQPLAIN</td>
- <td>(StrOpt) the RabbitMQ login method</td>
- </tr>
- <tr>
- <td>rabbit_max_retries = 0</td>
- <td>(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).</td>
- </tr>
- <tr>
- <td>rabbit_password = guest</td>
- <td>(StrOpt) The RabbitMQ password.</td>
- </tr>
- <tr>
- <td>rabbit_port = 5672</td>
- <td>(IntOpt) The RabbitMQ broker port where a single node is used.</td>
- </tr>
- <tr>
- <td>rabbit_retry_backoff = 2</td>
- <td>(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.</td>
- </tr>
- <tr>
- <td>rabbit_retry_interval = 1</td>
- <td>(IntOpt) How frequently to retry connecting with RabbitMQ.</td>
- </tr>
- <tr>
- <td>rabbit_use_ssl = False</td>
- <td>(BoolOpt) Connect over SSL for RabbitMQ.</td>
- </tr>
- <tr>
- <td>rabbit_userid = guest</td>
- <td>(StrOpt) The RabbitMQ userid.</td>
- </tr>
- <tr>
- <td>rabbit_virtual_host = /</td>
- <td>(StrOpt) The RabbitMQ virtual host.</td>
- </tr>
- <tr>
- <td>rpc_backend = rabbit</td>
- <td>(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq.</td>
- </tr>
- <tr>
- <td>rpc_cast_timeout = 30</td>
- <td>(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq.</td>
- </tr>
- <tr>
- <td>rpc_conn_pool_size = 30</td>
- <td>(IntOpt) Size of RPC connection pool.</td>
- </tr>
- <tr>
- <td>rpc_response_timeout = 60</td>
- <td>(IntOpt) Seconds to wait for a response from a call.</td>
- </tr>
- <tr>
- <td>rpc_thread_pool_size = 64</td>
- <td>(IntOpt) Size of RPC greenthread pool.</td>
- </tr>
- <tr>
- <td>rpc_zmq_bind_address = *</td>
- <td>(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address.</td>
- </tr>
- <tr>
- <td>rpc_zmq_contexts = 1</td>
- <td>(IntOpt) Number of ZeroMQ contexts, defaults to 1.</td>
- </tr>
- <tr>
- <td>rpc_zmq_host = oslo</td>
- <td>(StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova.</td>
- </tr>
- <tr>
- <td>rpc_zmq_ipc_dir = /var/run/openstack</td>
- <td>(StrOpt) Directory for holding IPC sockets.</td>
- </tr>
- <tr>
- <td>rpc_zmq_matchmaker = oslo.messaging._drivers.matchmaker.MatchMakerLocalhost</td>
- <td>(StrOpt) MatchMaker driver.</td>
- </tr>
- <tr>
- <td>rpc_zmq_port = 9501</td>
- <td>(IntOpt) ZeroMQ receiver listening port.</td>
- </tr>
- <tr>
- <td>rpc_zmq_topic_backlog = None</td>
- <td>(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited.</td>
- </tr>
- <tr>
- <th colspan="2">[cells]</th>
- </tr>
- <tr>
- <td>rpc_driver_queue_base = cells.intercell</td>
- <td>(StrOpt) Base queue name to use when communicating between cells. Various topics by message type will be appended to this.</td>
- </tr>
- <tr>
- <th colspan="2">[matchmaker_ring]</th>
- </tr>
- <tr>
- <td>ringfile = /etc/oslo/matchmaker_ring.json</td>
- <td>(StrOpt) Matchmaker ring file (JSON).</td>
- </tr>
- <tr>
- <th colspan="2">[upgrade_levels]</th>
- </tr>
- <tr>
- <td>baseapi = None</td>
- <td>(StrOpt) Set a version cap for messages sent to the base api in any service</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_rpc_all">
+ <caption>Description of configuration options for rpc_all</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>amqp_auto_delete = False</td>
+ <td>(BoolOpt) Auto-delete queues in amqp.</td>
+ </tr>
+ <tr>
+ <td>amqp_durable_queues = False</td>
+ <td>(BoolOpt) Use durable queues in amqp.</td>
+ </tr>
+ <tr>
+ <td>control_exchange = openstack</td>
+ <td>(StrOpt) AMQP exchange to connect to if using RabbitMQ or Qpid</td>
+ </tr>
+ <tr>
+ <td>kombu_reconnect_delay = 1.0</td>
+ <td>(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.</td>
+ </tr>
+ <tr>
+ <td>kombu_ssl_ca_certs = </td>
+ <td>(StrOpt) SSL certification authority file (valid only if SSL enabled).</td>
+ </tr>
+ <tr>
+ <td>kombu_ssl_certfile = </td>
+ <td>(StrOpt) SSL cert file (valid only if SSL enabled).</td>
+ </tr>
+ <tr>
+ <td>kombu_ssl_keyfile = </td>
+ <td>(StrOpt) SSL key file (valid only if SSL enabled).</td>
+ </tr>
+ <tr>
+ <td>kombu_ssl_version = </td>
+ <td>(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions.</td>
+ </tr>
+ <tr>
+ <td>matchmaker_heartbeat_freq = 300</td>
+ <td>(IntOpt) Heartbeat frequency.</td>
+ </tr>
+ <tr>
+ <td>matchmaker_heartbeat_ttl = 600</td>
+ <td>(IntOpt) Heartbeat time-to-live.</td>
+ </tr>
+ <tr>
+ <td>qpid_heartbeat = 60</td>
+ <td>(IntOpt) Seconds between connection keepalive heartbeats.</td>
+ </tr>
+ <tr>
+ <td>qpid_hostname = localhost</td>
+ <td>(StrOpt) Qpid broker hostname.</td>
+ </tr>
+ <tr>
+ <td>qpid_hosts = $qpid_hostname:$qpid_port</td>
+ <td>(ListOpt) Qpid HA cluster host:port pairs.</td>
+ </tr>
+ <tr>
+ <td>qpid_password = </td>
+ <td>(StrOpt) Password for Qpid connection.</td>
+ </tr>
+ <tr>
+ <td>qpid_port = 5672</td>
+ <td>(IntOpt) Qpid broker port.</td>
+ </tr>
+ <tr>
+ <td>qpid_protocol = tcp</td>
+ <td>(StrOpt) Transport to use, either 'tcp' or 'ssl'.</td>
+ </tr>
+ <tr>
+ <td>qpid_sasl_mechanisms = </td>
+ <td>(StrOpt) Space separated list of SASL mechanisms to use for auth.</td>
+ </tr>
+ <tr>
+ <td>qpid_tcp_nodelay = True</td>
+ <td>(BoolOpt) Whether to disable the Nagle algorithm.</td>
+ </tr>
+ <tr>
+ <td>qpid_topology_version = 1</td>
+ <td>(IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.</td>
+ </tr>
+ <tr>
+ <td>qpid_username = </td>
+ <td>(StrOpt) Username for Qpid connection.</td>
+ </tr>
+ <tr>
+ <td>rabbit_ha_queues = False</td>
+ <td>(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database.</td>
+ </tr>
+ <tr>
+ <td>rabbit_host = localhost</td>
+ <td>(StrOpt) The RabbitMQ broker address where a single node is used.</td>
+ </tr>
+ <tr>
+ <td>rabbit_hosts = $rabbit_host:$rabbit_port</td>
+ <td>(ListOpt) RabbitMQ HA cluster host:port pairs.</td>
+ </tr>
+ <tr>
+ <td>rabbit_login_method = AMQPLAIN</td>
+ <td>(StrOpt) the RabbitMQ login method</td>
+ </tr>
+ <tr>
+ <td>rabbit_max_retries = 0</td>
+ <td>(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).</td>
+ </tr>
+ <tr>
+ <td>rabbit_password = guest</td>
+ <td>(StrOpt) The RabbitMQ password.</td>
+ </tr>
+ <tr>
+ <td>rabbit_port = 5672</td>
+ <td>(IntOpt) The RabbitMQ broker port where a single node is used.</td>
+ </tr>
+ <tr>
+ <td>rabbit_retry_backoff = 2</td>
+ <td>(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.</td>
+ </tr>
+ <tr>
+ <td>rabbit_retry_interval = 1</td>
+ <td>(IntOpt) How frequently to retry connecting with RabbitMQ.</td>
+ </tr>
+ <tr>
+ <td>rabbit_use_ssl = False</td>
+ <td>(BoolOpt) Connect over SSL for RabbitMQ.</td>
+ </tr>
+ <tr>
+ <td>rabbit_userid = guest</td>
+ <td>(StrOpt) The RabbitMQ userid.</td>
+ </tr>
+ <tr>
+ <td>rabbit_virtual_host = /</td>
+ <td>(StrOpt) The RabbitMQ virtual host.</td>
+ </tr>
+ <tr>
+ <td>rpc_backend = nova.openstack.common.rpc.impl_kombu</td>
+ <td>(StrOpt) The messaging module to use, defaults to kombu.</td>
+ </tr>
+ <tr>
+ <td>rpc_cast_timeout = 30</td>
+ <td>(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq.</td>
+ </tr>
+ <tr>
+ <td>rpc_conn_pool_size = 30</td>
+ <td>(IntOpt) Size of RPC connection pool</td>
+ </tr>
+ <tr>
+ <td>rpc_response_timeout = 60</td>
+ <td>(IntOpt) Seconds to wait for a response from call or multicall</td>
+ </tr>
+ <tr>
+ <td>rpc_thread_pool_size = 64</td>
+ <td>(IntOpt) Size of RPC thread pool</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_bind_address = *</td>
+ <td>(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_contexts = 1</td>
+ <td>(IntOpt) Number of ZeroMQ contexts, defaults to 1.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_host = oslo</td>
+ <td>(StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_ipc_dir = /var/run/openstack</td>
+ <td>(StrOpt) Directory for holding IPC sockets.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_matchmaker = oslo.messaging._drivers.matchmaker.MatchMakerLocalhost</td>
+ <td>(StrOpt) MatchMaker driver.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_port = 9501</td>
+ <td>(IntOpt) ZeroMQ receiver listening port.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_topic_backlog = None</td>
+ <td>(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[cells]</th>
+ </tr>
+ <tr>
+ <td>rpc_driver_queue_base = cells.intercell</td>
+ <td>(StrOpt) Base queue name to use when communicating between cells. Various topics by message type will be appended to this.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[matchmaker_ring]</th>
+ </tr>
+ <tr>
+ <td>ringfile = /etc/oslo/matchmaker_ring.json</td>
+ <td>(StrOpt) Matchmaker ring file (JSON).</td>
+ </tr>
+ <tr>
+ <th colspan="2">[upgrade_levels]</th>
+ </tr>
+ <tr>
+ <td>baseapi = None</td>
+ <td>(StrOpt) Set a version cap for messages sent to the base api in any service</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-s3.xml b/doc/common/tables/nova-s3.xml
index b15130794b..51ff26409e 100644
--- a/doc/common/tables/nova-s3.xml
+++ b/doc/common/tables/nova-s3.xml
@@ -1,63 +1,62 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_s3">
- <caption>Description of configuration options for s3</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>buckets_path = $state_path/buckets</td>
- <td>(StrOpt) Path to S3 buckets</td>
- </tr>
- <tr>
- <td>image_decryption_dir = /tmp</td>
- <td>(StrOpt) Parent directory for tempdir used for image decryption</td>
- </tr>
- <tr>
- <td>s3_access_key = notchecked</td>
- <td>(StrOpt) Access key to use for S3 server for images</td>
- </tr>
- <tr>
- <td>s3_affix_tenant = False</td>
- <td>(BoolOpt) Whether to affix the tenant id to the access key when downloading from S3</td>
- </tr>
- <tr>
- <td>s3_host = $my_ip</td>
- <td>(StrOpt) Hostname or IP for OpenStack to use when accessing the S3 api</td>
- </tr>
- <tr>
- <td>s3_listen = 0.0.0.0</td>
- <td>(StrOpt) IP address for S3 API to listen</td>
- </tr>
- <tr>
- <td>s3_listen_port = 3333</td>
- <td>(IntOpt) Port for S3 API to listen</td>
- </tr>
- <tr>
- <td>s3_port = 3333</td>
- <td>(IntOpt) Port used when accessing the S3 api</td>
- </tr>
- <tr>
- <td>s3_secret_key = notchecked</td>
- <td>(StrOpt) Secret key to use for S3 server for images</td>
- </tr>
- <tr>
- <td>s3_use_ssl = False</td>
- <td>(BoolOpt) Whether to use SSL when talking to S3</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_s3">
+ <caption>Description of configuration options for s3</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>buckets_path = $state_path/buckets</td>
+ <td>(StrOpt) Path to S3 buckets</td>
+ </tr>
+ <tr>
+ <td>image_decryption_dir = /tmp</td>
+ <td>(StrOpt) Parent directory for tempdir used for image decryption</td>
+ </tr>
+ <tr>
+ <td>s3_access_key = notchecked</td>
+ <td>(StrOpt) Access key to use for S3 server for images</td>
+ </tr>
+ <tr>
+ <td>s3_affix_tenant = False</td>
+ <td>(BoolOpt) Whether to affix the tenant id to the access key when downloading from S3</td>
+ </tr>
+ <tr>
+ <td>s3_host = $my_ip</td>
+ <td>(StrOpt) Hostname or IP for OpenStack to use when accessing the S3 api</td>
+ </tr>
+ <tr>
+ <td>s3_listen = 0.0.0.0</td>
+ <td>(StrOpt) IP address for S3 API to listen</td>
+ </tr>
+ <tr>
+ <td>s3_listen_port = 3333</td>
+ <td>(IntOpt) Port for S3 API to listen</td>
+ </tr>
+ <tr>
+ <td>s3_port = 3333</td>
+ <td>(IntOpt) Port used when accessing the S3 api</td>
+ </tr>
+ <tr>
+ <td>s3_secret_key = notchecked</td>
+ <td>(StrOpt) Secret key to use for S3 server for images</td>
+ </tr>
+ <tr>
+ <td>s3_use_ssl = False</td>
+ <td>(BoolOpt) Whether to use SSL when talking to S3</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-scheduling.xml b/doc/common/tables/nova-scheduling.xml
index a1cb4c126e..23d8001329 100644
--- a/doc/common/tables/nova-scheduling.xml
+++ b/doc/common/tables/nova-scheduling.xml
@@ -1,161 +1,160 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_scheduling">
- <caption>Description of configuration options for scheduling</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>aggregate_image_properties_isolation_namespace = None</td>
- <td>(StrOpt) Force the filter to consider only keys matching the given namespace.</td>
- </tr>
- <tr>
- <td>aggregate_image_properties_isolation_separator = .</td>
- <td>(StrOpt) The separator used between the namespace and keys</td>
- </tr>
- <tr>
- <td>cpu_allocation_ratio = 16.0</td>
- <td>(FloatOpt) Virtual CPU to physical CPU allocation ratio which affects all CPU filters. This configuration specifies a global ratio for CoreFilter. For AggregateCoreFilter, it will fall back to this configuration value if no per-aggregate setting found.</td>
- </tr>
- <tr>
- <td>disk_allocation_ratio = 1.0</td>
- <td>(FloatOpt) Virtual disk to physical disk allocation ratio</td>
- </tr>
- <tr>
- <td>isolated_hosts = </td>
- <td>(ListOpt) Host reserved for specific images</td>
- </tr>
- <tr>
- <td>isolated_images = </td>
- <td>(ListOpt) Images to run on isolated host</td>
- </tr>
- <tr>
- <td>max_instances_per_host = 50</td>
- <td>(IntOpt) Ignore hosts that have too many instances</td>
- </tr>
- <tr>
- <td>max_io_ops_per_host = 8</td>
- <td>(IntOpt) Ignore hosts that have too many builds/resizes/snaps/migrations</td>
- </tr>
- <tr>
- <td>ram_allocation_ratio = 1.5</td>
- <td>(FloatOpt) Virtual ram to physical ram allocation ratio which affects all ram filters. This configuration specifies a global ratio for RamFilter. For AggregateRamFilter, it will fall back to this configuration value if no per-aggregate setting found.</td>
- </tr>
- <tr>
- <td>ram_weight_multiplier = 1.0</td>
- <td>(FloatOpt) Multiplier used for weighing ram. Negative numbers mean to stack vs spread.</td>
- </tr>
- <tr>
- <td>reserved_host_disk_mb = 0</td>
- <td>(IntOpt) Amount of disk in MB to reserve for the host</td>
- </tr>
- <tr>
- <td>reserved_host_memory_mb = 512</td>
- <td>(IntOpt) Amount of memory in MB to reserve for the host</td>
- </tr>
- <tr>
- <td>restrict_isolated_hosts_to_isolated_images = True</td>
- <td>(BoolOpt) Whether to force isolated hosts to run only isolated images</td>
- </tr>
- <tr>
- <td>scheduler_available_filters = ['nova.scheduler.filters.all_filters']</td>
- <td>(MultiStrOpt) Filter classes available to the scheduler which may be specified more than once. An entry of "nova.scheduler.filters.standard_filters" maps to all filters included with nova.</td>
- </tr>
- <tr>
- <td>scheduler_default_filters = RetryFilter, AvailabilityZoneFilter, RamFilter, ComputeFilter, ComputeCapabilitiesFilter, ImagePropertiesFilter, ServerGroupAntiAffinityFilter, ServerGroupAffinityFilter</td>
- <td>(ListOpt) Which filter class names to use for filtering hosts when not specified in the request.</td>
- </tr>
- <tr>
- <td>scheduler_driver = nova.scheduler.filter_scheduler.FilterScheduler</td>
- <td>(StrOpt) Default driver to use for the scheduler</td>
- </tr>
- <tr>
- <td>scheduler_driver_task_period = 60</td>
- <td>(IntOpt) How often (in seconds) to run periodic tasks in the scheduler driver of your choice. Please note this is likely to interact with the value of service_down_time, but exactly how they interact will depend on your choice of scheduler driver.</td>
- </tr>
- <tr>
- <td>scheduler_host_manager = nova.scheduler.host_manager.HostManager</td>
- <td>(StrOpt) The scheduler host manager class to use</td>
- </tr>
- <tr>
- <td>scheduler_host_subset_size = 1</td>
- <td>(IntOpt) New instances will be scheduled on a host chosen randomly from a subset of the N best hosts. This property defines the subset size that a host is chosen from. A value of 1 chooses the first host returned by the weighing functions. This value must be at least 1. Any value less than 1 will be ignored, and 1 will be used instead</td>
- </tr>
- <tr>
- <td>scheduler_json_config_location = </td>
- <td>(StrOpt) Absolute path to scheduler configuration JSON file.</td>
- </tr>
- <tr>
- <td>scheduler_manager = nova.scheduler.manager.SchedulerManager</td>
- <td>(StrOpt) Full class name for the Manager for scheduler</td>
- </tr>
- <tr>
- <td>scheduler_max_attempts = 3</td>
- <td>(IntOpt) Maximum number of attempts to schedule an instance</td>
- </tr>
- <tr>
- <td>scheduler_topic = scheduler</td>
- <td>(StrOpt) The topic scheduler nodes listen on</td>
- </tr>
- <tr>
- <td>scheduler_weight_classes = nova.scheduler.weights.all_weighers</td>
- <td>(ListOpt) Which weight class names to use for weighing hosts</td>
- </tr>
- <tr>
- <th colspan="2">[cells]</th>
- </tr>
- <tr>
- <td>ram_weight_multiplier = 10.0</td>
- <td>(FloatOpt) Multiplier used for weighing ram. Negative numbers mean to stack vs spread.</td>
- </tr>
- <tr>
- <td>scheduler_filter_classes = nova.cells.filters.all_filters</td>
- <td>(ListOpt) Filter classes the cells scheduler should use. An entry of "nova.cells.filters.all_filters" maps to all cells filters included with nova.</td>
- </tr>
- <tr>
- <td>scheduler_retries = 10</td>
- <td>(IntOpt) How many retries when no cells are available.</td>
- </tr>
- <tr>
- <td>scheduler_retry_delay = 2</td>
- <td>(IntOpt) How often to retry in seconds when no cells are available.</td>
- </tr>
- <tr>
- <td>scheduler_weight_classes = nova.cells.weights.all_weighers</td>
- <td>(ListOpt) Weigher classes the cells scheduler should use. An entry of "nova.cells.weights.all_weighers" maps to all cell weighers included with nova.</td>
- </tr>
- <tr>
- <th colspan="2">[metrics]</th>
- </tr>
- <tr>
- <td>required = True</td>
- <td>(BoolOpt) How to treat the unavailable metrics. When a metric is NOT available for a host, if it is set to be True, it would raise an exception, so it is recommended to use the scheduler filter MetricFilter to filter out those hosts. If it is set to be False, the unavailable metric would be treated as a negative factor in weighing process, the returned value would be set by the option weight_of_unavailable.</td>
- </tr>
- <tr>
- <td>weight_multiplier = 1.0</td>
- <td>(FloatOpt) Multiplier used for weighing metrics.</td>
- </tr>
- <tr>
- <td>weight_of_unavailable = -10000.0</td>
- <td>(FloatOpt) The final weight value to be returned if required is set to False and any one of the metrics set by weight_setting is unavailable.</td>
- </tr>
- <tr>
- <td>weight_setting = </td>
- <td>(ListOpt) How the metrics are going to be weighed. This should be in the form of "<name1>=<ratio1>, <name2>=<ratio2>, ...", where <nameX> is one of the metrics to be weighed, and <ratioX> is the corresponding ratio. So for "name1=1.0, name2=-1.0" The final weight would be name1.value * 1.0 + name2.value * -1.0.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_scheduling">
+ <caption>Description of configuration options for scheduling</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>aggregate_image_properties_isolation_namespace = None</td>
+ <td>(StrOpt) Force the filter to consider only keys matching the given namespace.</td>
+ </tr>
+ <tr>
+ <td>aggregate_image_properties_isolation_separator = .</td>
+ <td>(StrOpt) The separator used between the namespace and keys</td>
+ </tr>
+ <tr>
+ <td>cpu_allocation_ratio = 16.0</td>
+ <td>(FloatOpt) Virtual CPU to physical CPU allocation ratio which affects all CPU filters. This configuration specifies a global ratio for CoreFilter. For AggregateCoreFilter, it will fall back to this configuration value if no per-aggregate setting found.</td>
+ </tr>
+ <tr>
+ <td>disk_allocation_ratio = 1.0</td>
+ <td>(FloatOpt) Virtual disk to physical disk allocation ratio</td>
+ </tr>
+ <tr>
+ <td>isolated_hosts = </td>
+ <td>(ListOpt) Host reserved for specific images</td>
+ </tr>
+ <tr>
+ <td>isolated_images = </td>
+ <td>(ListOpt) Images to run on isolated host</td>
+ </tr>
+ <tr>
+ <td>max_instances_per_host = 50</td>
+ <td>(IntOpt) Ignore hosts that have too many instances</td>
+ </tr>
+ <tr>
+ <td>max_io_ops_per_host = 8</td>
+ <td>(IntOpt) Tells filters to ignore hosts that have this many or more instances currently in build, resize, snapshot, migrate, rescue or unshelve task states</td>
+ </tr>
+ <tr>
+ <td>ram_allocation_ratio = 1.5</td>
+ <td>(FloatOpt) Virtual ram to physical ram allocation ratio which affects all ram filters. This configuration specifies a global ratio for RamFilter. For AggregateRamFilter, it will fall back to this configuration value if no per-aggregate setting found.</td>
+ </tr>
+ <tr>
+ <td>ram_weight_multiplier = 1.0</td>
+ <td>(FloatOpt) Multiplier used for weighing ram. Negative numbers mean to stack vs spread.</td>
+ </tr>
+ <tr>
+ <td>reserved_host_disk_mb = 0</td>
+ <td>(IntOpt) Amount of disk in MB to reserve for the host</td>
+ </tr>
+ <tr>
+ <td>reserved_host_memory_mb = 512</td>
+ <td>(IntOpt) Amount of memory in MB to reserve for the host</td>
+ </tr>
+ <tr>
+ <td>restrict_isolated_hosts_to_isolated_images = True</td>
+ <td>(BoolOpt) Whether to force isolated hosts to run only isolated images</td>
+ </tr>
+ <tr>
+ <td>scheduler_available_filters = ['nova.scheduler.filters.all_filters']</td>
+ <td>(MultiStrOpt) Filter classes available to the scheduler which may be specified more than once. An entry of "nova.scheduler.filters.standard_filters" maps to all filters included with nova.</td>
+ </tr>
+ <tr>
+ <td>scheduler_default_filters = RetryFilter, AvailabilityZoneFilter, RamFilter, ComputeFilter, ComputeCapabilitiesFilter, ImagePropertiesFilter, ServerGroupAntiAffinityFilter, ServerGroupAffinityFilter</td>
+ <td>(ListOpt) Which filter class names to use for filtering hosts when not specified in the request.</td>
+ </tr>
+ <tr>
+ <td>scheduler_driver = nova.scheduler.filter_scheduler.FilterScheduler</td>
+ <td>(StrOpt) Default driver to use for the scheduler</td>
+ </tr>
+ <tr>
+ <td>scheduler_driver_task_period = 60</td>
+ <td>(IntOpt) How often (in seconds) to run periodic tasks in the scheduler driver of your choice. Please note this is likely to interact with the value of service_down_time, but exactly how they interact will depend on your choice of scheduler driver.</td>
+ </tr>
+ <tr>
+ <td>scheduler_host_manager = nova.scheduler.host_manager.HostManager</td>
+ <td>(StrOpt) The scheduler host manager class to use</td>
+ </tr>
+ <tr>
+ <td>scheduler_host_subset_size = 1</td>
+ <td>(IntOpt) New instances will be scheduled on a host chosen randomly from a subset of the N best hosts. This property defines the subset size that a host is chosen from. A value of 1 chooses the first host returned by the weighing functions. This value must be at least 1. Any value less than 1 will be ignored, and 1 will be used instead</td>
+ </tr>
+ <tr>
+ <td>scheduler_json_config_location = </td>
+ <td>(StrOpt) Absolute path to scheduler configuration JSON file.</td>
+ </tr>
+ <tr>
+ <td>scheduler_manager = nova.scheduler.manager.SchedulerManager</td>
+ <td>(StrOpt) Full class name for the Manager for scheduler</td>
+ </tr>
+ <tr>
+ <td>scheduler_max_attempts = 3</td>
+ <td>(IntOpt) Maximum number of attempts to schedule an instance</td>
+ </tr>
+ <tr>
+ <td>scheduler_topic = scheduler</td>
+ <td>(StrOpt) The topic scheduler nodes listen on</td>
+ </tr>
+ <tr>
+ <td>scheduler_weight_classes = nova.scheduler.weights.all_weighers</td>
+ <td>(ListOpt) Which weight class names to use for weighing hosts</td>
+ </tr>
+ <tr>
+ <th colspan="2">[cells]</th>
+ </tr>
+ <tr>
+ <td>ram_weight_multiplier = 10.0</td>
+ <td>(FloatOpt) Multiplier used for weighing ram. Negative numbers mean to stack vs spread.</td>
+ </tr>
+ <tr>
+ <td>scheduler_filter_classes = nova.cells.filters.all_filters</td>
+ <td>(ListOpt) Filter classes the cells scheduler should use. An entry of "nova.cells.filters.all_filters" maps to all cells filters included with nova.</td>
+ </tr>
+ <tr>
+ <td>scheduler_retries = 10</td>
+ <td>(IntOpt) How many retries when no cells are available.</td>
+ </tr>
+ <tr>
+ <td>scheduler_retry_delay = 2</td>
+ <td>(IntOpt) How often to retry in seconds when no cells are available.</td>
+ </tr>
+ <tr>
+ <td>scheduler_weight_classes = nova.cells.weights.all_weighers</td>
+ <td>(ListOpt) Weigher classes the cells scheduler should use. An entry of "nova.cells.weights.all_weighers" maps to all cell weighers included with nova.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[metrics]</th>
+ </tr>
+ <tr>
+ <td>required = True</td>
+ <td>(BoolOpt) How to treat the unavailable metrics. When a metric is NOT available for a host, if it is set to be True, it would raise an exception, so it is recommended to use the scheduler filter MetricFilter to filter out those hosts. If it is set to be False, the unavailable metric would be treated as a negative factor in weighing process, the returned value would be set by the option weight_of_unavailable.</td>
+ </tr>
+ <tr>
+ <td>weight_multiplier = 1.0</td>
+ <td>(FloatOpt) Multiplier used for weighing metrics.</td>
+ </tr>
+ <tr>
+ <td>weight_of_unavailable = -10000.0</td>
+ <td>(FloatOpt) The final weight value to be returned if required is set to False and any one of the metrics set by weight_setting is unavailable.</td>
+ </tr>
+ <tr>
+ <td>weight_setting = </td>
+ <td>(ListOpt) How the metrics are going to be weighed. This should be in the form of "<name1>=<ratio1>, <name2>=<ratio2>, ...", where <nameX> is one of the metrics to be weighed, and <ratioX> is the corresponding ratio. So for "name1=1.0, name2=-1.0" The final weight would be name1.value * 1.0 + name2.value * -1.0.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-spice.xml b/doc/common/tables/nova-spice.xml
index df5f9261b8..9db7a4e0dc 100644
--- a/doc/common/tables/nova-spice.xml
+++ b/doc/common/tables/nova-spice.xml
@@ -1,47 +1,46 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_spice">
- <caption>Description of configuration options for spice</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">[spice]</th>
- </tr>
- <tr>
- <td>agent_enabled = True</td>
- <td>(BoolOpt) Enable spice guest agent support</td>
- </tr>
- <tr>
- <td>enabled = False</td>
- <td>(BoolOpt) Enable spice related features</td>
- </tr>
- <tr>
- <td>html5proxy_base_url = http://127.0.0.1:6082/spice_auto.html</td>
- <td>(StrOpt) Location of spice HTML5 console proxy, in the form "http://127.0.0.1:6082/spice_auto.html"</td>
- </tr>
- <tr>
- <td>keymap = en-us</td>
- <td>(StrOpt) Keymap for spice</td>
- </tr>
- <tr>
- <td>server_listen = 127.0.0.1</td>
- <td>(StrOpt) IP address on which instance spice server should listen</td>
- </tr>
- <tr>
- <td>server_proxyclient_address = 127.0.0.1</td>
- <td>(StrOpt) The address to which proxy clients (like nova-spicehtml5proxy) should connect</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_spice">
+ <caption>Description of configuration options for spice</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">[spice]</th>
+ </tr>
+ <tr>
+ <td>agent_enabled = True</td>
+ <td>(BoolOpt) Enable spice guest agent support</td>
+ </tr>
+ <tr>
+ <td>enabled = False</td>
+ <td>(BoolOpt) Enable spice related features</td>
+ </tr>
+ <tr>
+ <td>html5proxy_base_url = http://127.0.0.1:6082/spice_auto.html</td>
+ <td>(StrOpt) Location of spice HTML5 console proxy, in the form "http://127.0.0.1:6082/spice_auto.html"</td>
+ </tr>
+ <tr>
+ <td>keymap = en-us</td>
+ <td>(StrOpt) Keymap for spice</td>
+ </tr>
+ <tr>
+ <td>server_listen = 127.0.0.1</td>
+ <td>(StrOpt) IP address on which instance spice server should listen</td>
+ </tr>
+ <tr>
+ <td>server_proxyclient_address = 127.0.0.1</td>
+ <td>(StrOpt) The address to which proxy clients (like nova-spicehtml5proxy) should connect</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-testing.xml b/doc/common/tables/nova-testing.xml
index 6bf08c684b..a07559213e 100644
--- a/doc/common/tables/nova-testing.xml
+++ b/doc/common/tables/nova-testing.xml
@@ -1,51 +1,50 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_testing">
- <caption>Description of configuration options for testing</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>allowed_rpc_exception_modules = oslo.messaging.exceptions, nova.exception, cinder.exception, exceptions</td>
- <td>(ListOpt) Modules of exceptions that are permitted to be recreated upon receiving exception data from an rpc call.</td>
- </tr>
- <tr>
- <td>backdoor_port = None</td>
- <td>(StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port> and <start>:<end>, where 0 results in listening on a random tcp port number, <port> results in listening on the specified port number and not enabling backdoorif it is in use and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.</td>
- </tr>
- <tr>
- <td>fake_call = False</td>
- <td>(BoolOpt) If True, skip using the queue and make local calls</td>
- </tr>
- <tr>
- <td>fake_network = False</td>
- <td>(BoolOpt) If passed, use fake network devices and addresses</td>
- </tr>
- <tr>
- <td>fake_rabbit = False</td>
- <td>(BoolOpt) If passed, use a fake RabbitMQ provider.</td>
- </tr>
- <tr>
- <td>monkey_patch = False</td>
- <td>(BoolOpt) Whether to log monkey patching</td>
- </tr>
- <tr>
- <td>monkey_patch_modules = nova.api.ec2.cloud:nova.notifications.notify_decorator, nova.compute.api:nova.notifications.notify_decorator</td>
- <td>(ListOpt) List of modules/decorators to monkey patch</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_testing">
+ <caption>Description of configuration options for testing</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>allowed_rpc_exception_modules = nova.exception, cinder.exception, exceptions</td>
+ <td>(ListOpt) Modules of exceptions that are permitted to be recreatedupon receiving exception data from an rpc call.</td>
+ </tr>
+ <tr>
+ <td>backdoor_port = None</td>
+ <td>(StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.</td>
+ </tr>
+ <tr>
+ <td>fake_call = False</td>
+ <td>(BoolOpt) If True, skip using the queue and make local calls</td>
+ </tr>
+ <tr>
+ <td>fake_network = False</td>
+ <td>(BoolOpt) If passed, use fake network devices and addresses</td>
+ </tr>
+ <tr>
+ <td>fake_rabbit = False</td>
+ <td>(BoolOpt) If passed, use a fake RabbitMQ provider</td>
+ </tr>
+ <tr>
+ <td>monkey_patch = False</td>
+ <td>(BoolOpt) Whether to log monkey patching</td>
+ </tr>
+ <tr>
+ <td>monkey_patch_modules = nova.api.ec2.cloud:nova.notifications.notify_decorator, nova.compute.api:nova.notifications.notify_decorator</td>
+ <td>(ListOpt) List of modules/decorators to monkey patch</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-tilera.xml b/doc/common/tables/nova-tilera.xml
index 8ef8e27cf5..42548eaae0 100644
--- a/doc/common/tables/nova-tilera.xml
+++ b/doc/common/tables/nova-tilera.xml
@@ -1,47 +1,46 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_tilera">
- <caption>Description of configuration options for tilera</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">[baremetal]</th>
- </tr>
- <tr>
- <td>tile_pdu_ip = 10.0.100.1</td>
- <td>(StrOpt) IP address of tilera pdu</td>
- </tr>
- <tr>
- <td>tile_pdu_mgr = /tftpboot/pdu_mgr</td>
- <td>(StrOpt) Management script for tilera pdu</td>
- </tr>
- <tr>
- <td>tile_pdu_off = 2</td>
- <td>(IntOpt) Power status of tilera PDU is OFF</td>
- </tr>
- <tr>
- <td>tile_pdu_on = 1</td>
- <td>(IntOpt) Power status of tilera PDU is ON</td>
- </tr>
- <tr>
- <td>tile_pdu_status = 9</td>
- <td>(IntOpt) Power status of tilera PDU</td>
- </tr>
- <tr>
- <td>tile_power_wait = 9</td>
- <td>(IntOpt) Wait time in seconds until check the result after tilera power operations</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_tilera">
+ <caption>Description of configuration options for tilera</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">[baremetal]</th>
+ </tr>
+ <tr>
+ <td>tile_pdu_ip = 10.0.100.1</td>
+ <td>(StrOpt) IP address of tilera pdu</td>
+ </tr>
+ <tr>
+ <td>tile_pdu_mgr = /tftpboot/pdu_mgr</td>
+ <td>(StrOpt) Management script for tilera pdu</td>
+ </tr>
+ <tr>
+ <td>tile_pdu_off = 2</td>
+ <td>(IntOpt) Power status of tilera PDU is OFF</td>
+ </tr>
+ <tr>
+ <td>tile_pdu_on = 1</td>
+ <td>(IntOpt) Power status of tilera PDU is ON</td>
+ </tr>
+ <tr>
+ <td>tile_pdu_status = 9</td>
+ <td>(IntOpt) Power status of tilera PDU</td>
+ </tr>
+ <tr>
+ <td>tile_power_wait = 9</td>
+ <td>(IntOpt) Wait time in seconds until check the result after tilera power operations</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-trustedcomputing.xml b/doc/common/tables/nova-trustedcomputing.xml
index a2e158236c..54e9ec08c6 100644
--- a/doc/common/tables/nova-trustedcomputing.xml
+++ b/doc/common/tables/nova-trustedcomputing.xml
@@ -1,47 +1,46 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_trustedcomputing">
- <caption>Description of configuration options for trustedcomputing</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">[trusted_computing]</th>
- </tr>
- <tr>
- <td>attestation_api_url = /OpenAttestationWebServices/V1.0</td>
- <td>(StrOpt) Attestation web API URL</td>
- </tr>
- <tr>
- <td>attestation_auth_blob = None</td>
- <td>(StrOpt) Attestation authorization blob - must change</td>
- </tr>
- <tr>
- <td>attestation_auth_timeout = 60</td>
- <td>(IntOpt) Attestation status cache valid period length</td>
- </tr>
- <tr>
- <td>attestation_port = 8443</td>
- <td>(StrOpt) Attestation server port</td>
- </tr>
- <tr>
- <td>attestation_server = None</td>
- <td>(StrOpt) Attestation server HTTP</td>
- </tr>
- <tr>
- <td>attestation_server_ca_file = None</td>
- <td>(StrOpt) Attestation server Cert file for Identity verification</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_trustedcomputing">
+ <caption>Description of configuration options for trustedcomputing</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">[trusted_computing]</th>
+ </tr>
+ <tr>
+ <td>attestation_api_url = /OpenAttestationWebServices/V1.0</td>
+ <td>(StrOpt) Attestation web API URL</td>
+ </tr>
+ <tr>
+ <td>attestation_auth_blob = None</td>
+ <td>(StrOpt) Attestation authorization blob - must change</td>
+ </tr>
+ <tr>
+ <td>attestation_auth_timeout = 60</td>
+ <td>(IntOpt) Attestation status cache valid period length</td>
+ </tr>
+ <tr>
+ <td>attestation_port = 8443</td>
+ <td>(StrOpt) Attestation server port</td>
+ </tr>
+ <tr>
+ <td>attestation_server = None</td>
+ <td>(StrOpt) Attestation server HTTP</td>
+ </tr>
+ <tr>
+ <td>attestation_server_ca_file = None</td>
+ <td>(StrOpt) Attestation server Cert file for Identity verification</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-upgrade_levels.xml b/doc/common/tables/nova-upgrade_levels.xml
index 3c6d8b5df2..04f944a011 100644
--- a/doc/common/tables/nova-upgrade_levels.xml
+++ b/doc/common/tables/nova-upgrade_levels.xml
@@ -1,66 +1,65 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_upgrade_levels">
- <caption>Description of configuration options for upgrade_levels</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">[cells]</th>
- </tr>
- <tr>
- <td>scheduler = nova.cells.scheduler.CellsScheduler</td>
- <td>(StrOpt) Cells scheduler to use</td>
- </tr>
- <tr>
- <th colspan="2">[upgrade_levels]</th>
- </tr>
- <tr>
- <td>cells = None</td>
- <td>(StrOpt) Set a version cap for messages sent to local cells services</td>
- </tr>
- <tr>
- <td>cert = None</td>
- <td>(StrOpt) Set a version cap for messages sent to cert services</td>
- </tr>
- <tr>
- <td>compute = None</td>
- <td>(StrOpt) Set a version cap for messages sent to compute services. If you plan to do a live upgrade from havana to icehouse, you should set this option to "icehouse-compat" before beginning the live upgrade procedure.</td>
- </tr>
- <tr>
- <td>conductor = None</td>
- <td>(StrOpt) Set a version cap for messages sent to conductor services</td>
- </tr>
- <tr>
- <td>console = None</td>
- <td>(StrOpt) Set a version cap for messages sent to console services</td>
- </tr>
- <tr>
- <td>consoleauth = None</td>
- <td>(StrOpt) Set a version cap for messages sent to consoleauth services</td>
- </tr>
- <tr>
- <td>intercell = None</td>
- <td>(StrOpt) Set a version cap for messages sent between cells services</td>
- </tr>
- <tr>
- <td>network = None</td>
- <td>(StrOpt) Set a version cap for messages sent to network services</td>
- </tr>
- <tr>
- <td>scheduler = None</td>
- <td>(StrOpt) Set a version cap for messages sent to scheduler services</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_upgrade_levels">
+ <caption>Description of configuration options for upgrade_levels</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">[cells]</th>
+ </tr>
+ <tr>
+ <td>scheduler = nova.cells.scheduler.CellsScheduler</td>
+ <td>(StrOpt) Cells scheduler to use</td>
+ </tr>
+ <tr>
+ <th colspan="2">[upgrade_levels]</th>
+ </tr>
+ <tr>
+ <td>cells = None</td>
+ <td>(StrOpt) Set a version cap for messages sent to local cells services</td>
+ </tr>
+ <tr>
+ <td>cert = None</td>
+ <td>(StrOpt) Set a version cap for messages sent to cert services</td>
+ </tr>
+ <tr>
+ <td>compute = None</td>
+ <td>(StrOpt) Set a version cap for messages sent to compute services. If you plan to do a live upgrade from havana to icehouse, you should set this option to "icehouse-compat" before beginning the live upgrade procedure.</td>
+ </tr>
+ <tr>
+ <td>conductor = None</td>
+ <td>(StrOpt) Set a version cap for messages sent to conductor services</td>
+ </tr>
+ <tr>
+ <td>console = None</td>
+ <td>(StrOpt) Set a version cap for messages sent to console services</td>
+ </tr>
+ <tr>
+ <td>consoleauth = None</td>
+ <td>(StrOpt) Set a version cap for messages sent to consoleauth services</td>
+ </tr>
+ <tr>
+ <td>intercell = None</td>
+ <td>(StrOpt) Set a version cap for messages sent between cells services</td>
+ </tr>
+ <tr>
+ <td>network = None</td>
+ <td>(StrOpt) Set a version cap for messages sent to network services</td>
+ </tr>
+ <tr>
+ <td>scheduler = None</td>
+ <td>(StrOpt) Set a version cap for messages sent to scheduler services</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-vmware.xml b/doc/common/tables/nova-vmware.xml
index 920260ca87..727217fc37 100644
--- a/doc/common/tables/nova-vmware.xml
+++ b/doc/common/tables/nova-vmware.xml
@@ -1,67 +1,70 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_vmware">
- <caption>Description of configuration options for vmware</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>api_retry_count = 10</td>
- <td>(IntOpt) The number of times we retry on failures, e.g., socket error, etc.</td>
- </tr>
- <tr>
- <td>cluster_name = None</td>
- <td>(MultiStrOpt) Name of a VMware Cluster ComputeResource. Used only if compute_driver is vmwareapi.VMwareVCDriver.</td>
- </tr>
- <tr>
- <td>datastore_regex = None</td>
- <td>(StrOpt) Regex to match the name of a datastore.</td>
- </tr>
- <tr>
- <td>host_ip = None</td>
- <td>(StrOpt) Hostname or IP address for connection to VMware ESX/VC host.</td>
- </tr>
- <tr>
- <td>host_password = None</td>
- <td>(StrOpt) Password for connection to VMware ESX/VC host.</td>
- </tr>
- <tr>
- <td>host_username = None</td>
- <td>(StrOpt) Username for connection to VMware ESX/VC host.</td>
- </tr>
- <tr>
- <td>integration_bridge = br-int</td>
- <td>(StrOpt) Name of Integration Bridge</td>
- </tr>
- <tr>
- <td>maximum_objects = 100</td>
- <td>(IntOpt) The maximum number of ObjectContent data objects that should be returned in a single result. A positive value will cause the operation to suspend the retrieval when the count of objects reaches the specified maximum. The server may still limit the count to something less than the configured value. Any remaining objects may be retrieved with additional requests.</td>
- </tr>
- <tr>
- <td>task_poll_interval = 0.5</td>
- <td>(FloatOpt) The interval used for polling of remote tasks.</td>
- </tr>
- <tr>
- <td>use_linked_clone = True</td>
- <td>(BoolOpt) Whether to use linked clone</td>
- </tr>
- <tr>
- <td>wsdl_location = None</td>
- <td>(StrOpt) Optional VIM Service WSDL Location e.g http://<server>/vimService.wsdl. Optional over-ride to default location for bug work-arounds</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_vmware">
+ <caption>Description of configuration options for vmware</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>api_retry_count = 10</td>
+ <td>(IntOpt) The number of times we retry on failures, e.g., socket error, etc.</td>
+ </tr>
+ <tr>
+ <td>cluster_name = None</td>
+ <td>(MultiStrOpt) Name of a VMware Cluster ComputeResource. Used only if compute_driver is vmwareapi.VMwareVCDriver.</td>
+ </tr>
+ <tr>
+ <td>datastore_regex = None</td>
+ <td>(StrOpt) Regex to match the name of a datastore.</td>
+ </tr>
+ <tr>
+ <td>host_ip = None</td>
+ <td>(StrOpt) Hostname or IP address for connection to VMware ESX/VC host.</td>
+ </tr>
+ <tr>
+ <td>host_password = None</td>
+ <td>(StrOpt) Password for connection to VMware ESX/VC host.</td>
+ </tr>
+ <tr>
+ <td>host_port = 443</td>
+ <td>(IntOpt) Port for connection to VMware ESX/VC host.</td>
+ </tr>
+ <tr>
+ <td>host_username = None</td>
+ <td>(StrOpt) Username for connection to VMware ESX/VC host.</td>
+ </tr>
+ <tr>
+ <td>integration_bridge = br-int</td>
+ <td>(StrOpt) Name of Integration Bridge</td>
+ </tr>
+ <tr>
+ <td>maximum_objects = 100</td>
+ <td>(IntOpt) The maximum number of ObjectContent data objects that should be returned in a single result. A positive value will cause the operation to suspend the retrieval when the count of objects reaches the specified maximum. The server may still limit the count to something less than the configured value. Any remaining objects may be retrieved with additional requests.</td>
+ </tr>
+ <tr>
+ <td>task_poll_interval = 0.5</td>
+ <td>(FloatOpt) The interval used for polling of remote tasks.</td>
+ </tr>
+ <tr>
+ <td>use_linked_clone = True</td>
+ <td>(BoolOpt) Whether to use linked clone</td>
+ </tr>
+ <tr>
+ <td>wsdl_location = None</td>
+ <td>(StrOpt) Optional VIM Service WSDL Location e.g http://<server>/vimService.wsdl. Optional over-ride to default location for bug work-arounds</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-vnc.xml b/doc/common/tables/nova-vnc.xml
index 6c24d261b7..e2038cc0c6 100644
--- a/doc/common/tables/nova-vnc.xml
+++ b/doc/common/tables/nova-vnc.xml
@@ -1,54 +1,53 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_vnc">
- <caption>Description of configuration options for vnc</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>novncproxy_base_url = http://127.0.0.1:6080/vnc_auto.html</td>
- <td>(StrOpt) Location of VNC console proxy, in the form "http://127.0.0.1:6080/vnc_auto.html"</td>
- </tr>
- <tr>
- <td>vnc_enabled = True</td>
- <td>(BoolOpt) Enable VNC related features</td>
- </tr>
- <tr>
- <td>vnc_keymap = en-us</td>
- <td>(StrOpt) Keymap for VNC</td>
- </tr>
- <tr>
- <td>vncserver_listen = 127.0.0.1</td>
- <td>(StrOpt) IP address on which instance vncservers should listen</td>
- </tr>
- <tr>
- <td>vncserver_proxyclient_address = 127.0.0.1</td>
- <td>(StrOpt) The address to which proxy clients (like nova-xvpvncproxy) should connect</td>
- </tr>
- <tr>
- <th colspan="2">[vmware]</th>
- </tr>
- <tr>
- <td>vnc_port = 5900</td>
- <td>(IntOpt) VNC starting port</td>
- </tr>
- <tr>
- <td>vnc_port_total = 10000</td>
- <td>(IntOpt) Total number of VNC ports</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_vnc">
+ <caption>Description of configuration options for vnc</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>novncproxy_base_url = http://127.0.0.1:6080/vnc_auto.html</td>
+ <td>(StrOpt) Location of VNC console proxy, in the form "http://127.0.0.1:6080/vnc_auto.html"</td>
+ </tr>
+ <tr>
+ <td>vnc_enabled = True</td>
+ <td>(BoolOpt) Enable VNC related features</td>
+ </tr>
+ <tr>
+ <td>vnc_keymap = en-us</td>
+ <td>(StrOpt) Keymap for VNC</td>
+ </tr>
+ <tr>
+ <td>vncserver_listen = 127.0.0.1</td>
+ <td>(StrOpt) IP address on which instance vncservers should listen</td>
+ </tr>
+ <tr>
+ <td>vncserver_proxyclient_address = 127.0.0.1</td>
+ <td>(StrOpt) The address to which proxy clients (like nova-xvpvncproxy) should connect</td>
+ </tr>
+ <tr>
+ <th colspan="2">[vmware]</th>
+ </tr>
+ <tr>
+ <td>vnc_port = 5900</td>
+ <td>(IntOpt) VNC starting port</td>
+ </tr>
+ <tr>
+ <td>vnc_port_total = 10000</td>
+ <td>(IntOpt) Total number of VNC ports</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-volumes.xml b/doc/common/tables/nova-volumes.xml
index 88f2eaadae..8e73a475b3 100644
--- a/doc/common/tables/nova-volumes.xml
+++ b/doc/common/tables/nova-volumes.xml
@@ -1,139 +1,142 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_volumes">
- <caption>Description of configuration options for volumes</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>cinder_api_insecure = False</td>
- <td>(BoolOpt) Allow to perform insecure SSL requests to cinder</td>
- </tr>
- <tr>
- <td>cinder_ca_certificates_file = None</td>
- <td>(StrOpt) Location of ca certificates file to use for cinder client requests.</td>
- </tr>
- <tr>
- <td>cinder_catalog_info = volume:cinder:publicURL</td>
- <td>(StrOpt) Info to match when looking for cinder in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:<endpoint_type></td>
- </tr>
- <tr>
- <td>cinder_cross_az_attach = True</td>
- <td>(BoolOpt) Allow attach between instance and volume in different availability zones.</td>
- </tr>
- <tr>
- <td>cinder_endpoint_template = None</td>
- <td>(StrOpt) Override service catalog lookup with template for cinder endpoint e.g. http://localhost:8776/v1/%(project_id)s</td>
- </tr>
- <tr>
- <td>cinder_http_retries = 3</td>
- <td>(IntOpt) Number of cinderclient retries on failed http calls</td>
- </tr>
- <tr>
- <td>os_region_name = None</td>
- <td>(StrOpt) Region name of this node</td>
- </tr>
- <tr>
- <td>volume_api_class = nova.volume.cinder.API</td>
- <td>(StrOpt) The full class name of the volume API class to use</td>
- </tr>
- <tr>
- <td>volume_usage_poll_interval = 0</td>
- <td>(IntOpt) Interval in seconds for gathering volume usages</td>
- </tr>
- <tr>
- <th colspan="2">[baremetal]</th>
- </tr>
- <tr>
- <td>iscsi_iqn_prefix = iqn.2010-10.org.openstack.baremetal</td>
- <td>(StrOpt) The iSCSI IQN prefix used in baremetal volume connections.</td>
- </tr>
- <tr>
- <td>volume_driver = nova.virt.baremetal.volume_driver.LibvirtVolumeDriver</td>
- <td>(StrOpt) Baremetal volume driver.</td>
- </tr>
- <tr>
- <th colspan="2">[hyperv]</th>
- </tr>
- <tr>
- <td>force_volumeutils_v1 = False</td>
- <td>(BoolOpt) Force V1 volume utility class</td>
- </tr>
- <tr>
- <td>volume_attach_retry_count = 10</td>
- <td>(IntOpt) The number of times to retry to attach a volume</td>
- </tr>
- <tr>
- <td>volume_attach_retry_interval = 5</td>
- <td>(IntOpt) Interval between volume attachment attempts, in seconds</td>
- </tr>
- <tr>
- <th colspan="2">[libvirt]</th>
- </tr>
- <tr>
- <td>glusterfs_mount_point_base = $state_path/mnt</td>
- <td>(StrOpt) Directory where the glusterfs volume is mounted on the compute node</td>
- </tr>
- <tr>
- <td>nfs_mount_options = None</td>
- <td>(StrOpt) Mount options passedf to the NFS client. See section of the nfs man page for details</td>
- </tr>
- <tr>
- <td>nfs_mount_point_base = $state_path/mnt</td>
- <td>(StrOpt) Directory where the NFS volume is mounted on the compute node</td>
- </tr>
- <tr>
- <td>num_aoe_discover_tries = 3</td>
- <td>(IntOpt) Number of times to rediscover AoE target to find volume</td>
- </tr>
- <tr>
- <td>num_iscsi_scan_tries = 5</td>
- <td>(IntOpt) Number of times to rescan iSCSI target to find volume</td>
- </tr>
- <tr>
- <td>num_iser_scan_tries = 5</td>
- <td>(IntOpt) Number of times to rescan iSER target to find volume</td>
- </tr>
- <tr>
- <td>qemu_allowed_storage_drivers = </td>
- <td>(ListOpt) Protocols listed here will be accessed directly from QEMU. Currently supported protocols: [gluster]</td>
- </tr>
- <tr>
- <td>rbd_secret_uuid = None</td>
- <td>(StrOpt) The libvirt UUID of the secret for the rbd_uservolumes</td>
- </tr>
- <tr>
- <td>rbd_user = None</td>
- <td>(StrOpt) The RADOS client name for accessing rbd volumes</td>
- </tr>
- <tr>
- <td>scality_sofs_config = None</td>
- <td>(StrOpt) Path or URL to Scality SOFS configuration file</td>
- </tr>
- <tr>
- <td>scality_sofs_mount_point = $state_path/scality</td>
- <td>(StrOpt) Base dir where Scality SOFS shall be mounted</td>
- </tr>
- <tr>
- <th colspan="2">[xenserver]</th>
- </tr>
- <tr>
- <td>block_device_creation_timeout = 10</td>
- <td>(IntOpt) Time to wait for a block device to be created</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_volumes">
+ <caption>Description of configuration options for volumes</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>cinder_api_insecure = False</td>
+ <td>(BoolOpt) Allow to perform insecure SSL requests to cinder</td>
+ </tr>
+ <tr>
+ <td>cinder_ca_certificates_file = None</td>
+ <td>(StrOpt) Location of ca certificates file to use for cinder client requests.</td>
+ </tr>
+ <tr>
+ <td>cinder_catalog_info = volume:cinder:publicURL</td>
+ <td>(StrOpt) Info to match when looking for cinder in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:<endpoint_type></td>
+ </tr>
+ <tr>
+ <td>cinder_cross_az_attach = True</td>
+ <td>(BoolOpt) Allow attach between instance and volume in different availability zones.</td>
+ </tr>
+ <tr>
+ <td>cinder_endpoint_template = None</td>
+ <td>(StrOpt) Override service catalog lookup with template for cinder endpoint e.g. http://localhost:8776/v1/%(project_id)s</td>
+ </tr>
+ <tr>
+ <td>cinder_http_retries = 3</td>
+ <td>(IntOpt) Number of cinderclient retries on failed http calls</td>
+ </tr>
+ <tr>
+ <td>cinder_http_timeout = None</td>
+ <td>(IntOpt) HTTP inactivity timeout (in seconds)</td>
+ </tr>
+ <tr>
+ <td>os_region_name = None</td>
+ <td>(StrOpt) Region name of this node</td>
+ </tr>
+ <tr>
+ <td>volume_api_class = nova.volume.cinder.API</td>
+ <td>(StrOpt) The full class name of the volume API class to use</td>
+ </tr>
+ <tr>
+ <td>volume_usage_poll_interval = 0</td>
+ <td>(IntOpt) Interval in seconds for gathering volume usages</td>
+ </tr>
+ <tr>
+ <th colspan="2">[baremetal]</th>
+ </tr>
+ <tr>
+ <td>iscsi_iqn_prefix = iqn.2010-10.org.openstack.baremetal</td>
+ <td>(StrOpt) The iSCSI IQN prefix used in baremetal volume connections.</td>
+ </tr>
+ <tr>
+ <td>volume_driver = nova.virt.baremetal.volume_driver.LibvirtVolumeDriver</td>
+ <td>(StrOpt) Baremetal volume driver.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[hyperv]</th>
+ </tr>
+ <tr>
+ <td>force_volumeutils_v1 = False</td>
+ <td>(BoolOpt) Force V1 volume utility class</td>
+ </tr>
+ <tr>
+ <td>volume_attach_retry_count = 10</td>
+ <td>(IntOpt) The number of times to retry to attach a volume</td>
+ </tr>
+ <tr>
+ <td>volume_attach_retry_interval = 5</td>
+ <td>(IntOpt) Interval between volume attachment attempts, in seconds</td>
+ </tr>
+ <tr>
+ <th colspan="2">[libvirt]</th>
+ </tr>
+ <tr>
+ <td>glusterfs_mount_point_base = $state_path/mnt</td>
+ <td>(StrOpt) Directory where the glusterfs volume is mounted on the compute node</td>
+ </tr>
+ <tr>
+ <td>nfs_mount_options = None</td>
+ <td>(StrOpt) Mount options passedf to the NFS client. See section of the nfs man page for details</td>
+ </tr>
+ <tr>
+ <td>nfs_mount_point_base = $state_path/mnt</td>
+ <td>(StrOpt) Directory where the NFS volume is mounted on the compute node</td>
+ </tr>
+ <tr>
+ <td>num_aoe_discover_tries = 3</td>
+ <td>(IntOpt) Number of times to rediscover AoE target to find volume</td>
+ </tr>
+ <tr>
+ <td>num_iscsi_scan_tries = 5</td>
+ <td>(IntOpt) Number of times to rescan iSCSI target to find volume</td>
+ </tr>
+ <tr>
+ <td>num_iser_scan_tries = 5</td>
+ <td>(IntOpt) Number of times to rescan iSER target to find volume</td>
+ </tr>
+ <tr>
+ <td>qemu_allowed_storage_drivers = </td>
+ <td>(ListOpt) Protocols listed here will be accessed directly from QEMU. Currently supported protocols: [gluster]</td>
+ </tr>
+ <tr>
+ <td>rbd_secret_uuid = None</td>
+ <td>(StrOpt) The libvirt UUID of the secret for the rbd_uservolumes</td>
+ </tr>
+ <tr>
+ <td>rbd_user = None</td>
+ <td>(StrOpt) The RADOS client name for accessing rbd volumes</td>
+ </tr>
+ <tr>
+ <td>scality_sofs_config = None</td>
+ <td>(StrOpt) Path or URL to Scality SOFS configuration file</td>
+ </tr>
+ <tr>
+ <td>scality_sofs_mount_point = $state_path/scality</td>
+ <td>(StrOpt) Base dir where Scality SOFS shall be mounted</td>
+ </tr>
+ <tr>
+ <th colspan="2">[xenserver]</th>
+ </tr>
+ <tr>
+ <td>block_device_creation_timeout = 10</td>
+ <td>(IntOpt) Time to wait for a block device to be created</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-vpn.xml b/doc/common/tables/nova-vpn.xml
index 8555743798..8f8a9cc004 100644
--- a/doc/common/tables/nova-vpn.xml
+++ b/doc/common/tables/nova-vpn.xml
@@ -1,59 +1,58 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_vpn">
- <caption>Description of configuration options for vpn</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>boot_script_template = $pybasedir/nova/cloudpipe/bootscript.template</td>
- <td>(StrOpt) Template for cloudpipe instance boot script</td>
- </tr>
- <tr>
- <td>dmz_cidr = </td>
- <td>(ListOpt) A list of dmz range that should be accepted</td>
- </tr>
- <tr>
- <td>dmz_mask = 255.255.255.0</td>
- <td>(StrOpt) Netmask to push into openvpn config</td>
- </tr>
- <tr>
- <td>dmz_net = 10.0.0.0</td>
- <td>(StrOpt) Network to push into openvpn config</td>
- </tr>
- <tr>
- <td>vpn_flavor = m1.tiny</td>
- <td>(StrOpt) Flavor for vpn instances</td>
- </tr>
- <tr>
- <td>vpn_image_id = 0</td>
- <td>(StrOpt) Image ID used when starting up a cloudpipe vpn server</td>
- </tr>
- <tr>
- <td>vpn_ip = $my_ip</td>
- <td>(StrOpt) Public IP for the cloudpipe VPN servers</td>
- </tr>
- <tr>
- <td>vpn_key_suffix = -vpn</td>
- <td>(StrOpt) Suffix to add to project name for vpn key and secgroups</td>
- </tr>
- <tr>
- <td>vpn_start = 1000</td>
- <td>(IntOpt) First Vpn port for private networks</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_vpn">
+ <caption>Description of configuration options for vpn</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>boot_script_template = $pybasedir/nova/cloudpipe/bootscript.template</td>
+ <td>(StrOpt) Template for cloudpipe instance boot script</td>
+ </tr>
+ <tr>
+ <td>dmz_cidr = </td>
+ <td>(ListOpt) A list of dmz range that should be accepted</td>
+ </tr>
+ <tr>
+ <td>dmz_mask = 255.255.255.0</td>
+ <td>(StrOpt) Netmask to push into openvpn config</td>
+ </tr>
+ <tr>
+ <td>dmz_net = 10.0.0.0</td>
+ <td>(StrOpt) Network to push into openvpn config</td>
+ </tr>
+ <tr>
+ <td>vpn_flavor = m1.tiny</td>
+ <td>(StrOpt) Flavor for vpn instances</td>
+ </tr>
+ <tr>
+ <td>vpn_image_id = 0</td>
+ <td>(StrOpt) Image ID used when starting up a cloudpipe vpn server</td>
+ </tr>
+ <tr>
+ <td>vpn_ip = $my_ip</td>
+ <td>(StrOpt) Public IP for the cloudpipe VPN servers</td>
+ </tr>
+ <tr>
+ <td>vpn_key_suffix = -vpn</td>
+ <td>(StrOpt) Suffix to add to project name for vpn key and secgroups</td>
+ </tr>
+ <tr>
+ <td>vpn_start = 1000</td>
+ <td>(IntOpt) First Vpn port for private networks</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-wsgi.xml b/doc/common/tables/nova-wsgi.xml
index 8627ee254b..e4c93fe9a8 100644
--- a/doc/common/tables/nova-wsgi.xml
+++ b/doc/common/tables/nova-wsgi.xml
@@ -1,51 +1,50 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_wsgi">
- <caption>Description of configuration options for wsgi</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>api_paste_config = api-paste.ini</td>
- <td>(StrOpt) File name for the paste.deploy config for nova-api</td>
- </tr>
- <tr>
- <td>ssl_ca_file = None</td>
- <td>(StrOpt) CA certificate file to use to verify connecting clients</td>
- </tr>
- <tr>
- <td>ssl_cert_file = None</td>
- <td>(StrOpt) SSL certificate of API server</td>
- </tr>
- <tr>
- <td>ssl_key_file = None</td>
- <td>(StrOpt) SSL private key of API server</td>
- </tr>
- <tr>
- <td>tcp_keepidle = 600</td>
- <td>(IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X.</td>
- </tr>
- <tr>
- <td>wsgi_default_pool_size = 1000</td>
- <td>(IntOpt) Size of the pool of greenthreads used by wsgi</td>
- </tr>
- <tr>
- <td>wsgi_log_format = %(client_ip)s "%(request_line)s" status: %(status_code)s len: %(body_length)s time: %(wall_seconds).7f</td>
- <td>(StrOpt) A python format string that is used as the template to generate log lines. The following values can be formatted into it: client_ip, date_time, request_line, status_code, body_length, wall_seconds.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_wsgi">
+ <caption>Description of configuration options for wsgi</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>api_paste_config = api-paste.ini</td>
+ <td>(StrOpt) File name for the paste.deploy config for nova-api</td>
+ </tr>
+ <tr>
+ <td>ssl_ca_file = None</td>
+ <td>(StrOpt) CA certificate file to use to verify connecting clients</td>
+ </tr>
+ <tr>
+ <td>ssl_cert_file = None</td>
+ <td>(StrOpt) SSL certificate of API server</td>
+ </tr>
+ <tr>
+ <td>ssl_key_file = None</td>
+ <td>(StrOpt) SSL private key of API server</td>
+ </tr>
+ <tr>
+ <td>tcp_keepidle = 600</td>
+ <td>(IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X.</td>
+ </tr>
+ <tr>
+ <td>wsgi_default_pool_size = 1000</td>
+ <td>(IntOpt) Size of the pool of greenthreads used by wsgi</td>
+ </tr>
+ <tr>
+ <td>wsgi_log_format = %(client_ip)s "%(request_line)s" status: %(status_code)s len: %(body_length)s time: %(wall_seconds).7f</td>
+ <td>(StrOpt) A python format string that is used as the template to generate log lines. The following values can be formatted into it: client_ip, date_time, request_line, status_code, body_length, wall_seconds.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-xen.xml b/doc/common/tables/nova-xen.xml
index c60c890f6d..2bd5b2d028 100644
--- a/doc/common/tables/nova-xen.xml
+++ b/doc/common/tables/nova-xen.xml
@@ -1,245 +1,244 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_xen">
- <caption>Description of configuration options for xen</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>console_driver = nova.console.xvp.XVPConsoleProxy</td>
- <td>(StrOpt) Driver to use for the console proxy</td>
- </tr>
- <tr>
- <td>console_vmrc_error_retries = 10</td>
- <td>(IntOpt) Number of retries for retrieving VMRC information</td>
- </tr>
- <tr>
- <td>console_vmrc_port = 443</td>
- <td>(IntOpt) Port for VMware VMRC connections</td>
- </tr>
- <tr>
- <td>console_xvp_conf = /etc/xvp.conf</td>
- <td>(StrOpt) Generated XVP conf file</td>
- </tr>
- <tr>
- <td>console_xvp_conf_template = $pybasedir/nova/console/xvp.conf.template</td>
- <td>(StrOpt) XVP conf template</td>
- </tr>
- <tr>
- <td>console_xvp_log = /var/log/xvp.log</td>
- <td>(StrOpt) XVP log file</td>
- </tr>
- <tr>
- <td>console_xvp_multiplex_port = 5900</td>
- <td>(IntOpt) Port for XVP to multiplex VNC connections on</td>
- </tr>
- <tr>
- <td>console_xvp_pid = /var/run/xvp.pid</td>
- <td>(StrOpt) XVP master process pid file</td>
- </tr>
- <tr>
- <td>stub_compute = False</td>
- <td>(BoolOpt) Stub calls to compute worker for tests</td>
- </tr>
- <tr>
- <th colspan="2">[libvirt]</th>
- </tr>
- <tr>
- <td>xen_hvmloader_path = /usr/lib/xen/boot/hvmloader</td>
- <td>(StrOpt) Location where the Xen hvmloader is kept</td>
- </tr>
- <tr>
- <th colspan="2">[xenserver]</th>
- </tr>
- <tr>
- <td>agent_path = usr/sbin/xe-update-networking</td>
- <td>(StrOpt) Specifies the path in which the XenAPI guest agent should be located. If the agent is present, network configuration is not injected into the image. Used if compute_driver=xenapi.XenAPIDriver and flat_injected=True</td>
- </tr>
- <tr>
- <td>agent_resetnetwork_timeout = 60</td>
- <td>(IntOpt) Number of seconds to wait for agent reply to resetnetwork request</td>
- </tr>
- <tr>
- <td>agent_timeout = 30</td>
- <td>(IntOpt) Number of seconds to wait for agent reply</td>
- </tr>
- <tr>
- <td>agent_version_timeout = 300</td>
- <td>(IntOpt) Number of seconds to wait for agent to be fully operational</td>
- </tr>
- <tr>
- <td>cache_images = all</td>
- <td>(StrOpt) Cache glance images locally. `all` will cache all images, `some` will only cache images that have the image_property `cache_in_nova=True`, and `none` turns off caching entirely</td>
- </tr>
- <tr>
- <td>check_host = True</td>
- <td>(BoolOpt) Ensure compute service is running on host XenAPI connects to.</td>
- </tr>
- <tr>
- <td>connection_concurrent = 5</td>
- <td>(IntOpt) Maximum number of concurrent XenAPI connections. Used only if compute_driver=xenapi.XenAPIDriver</td>
- </tr>
- <tr>
- <td>connection_password = None</td>
- <td>(StrOpt) Password for connection to XenServer/Xen Cloud Platform. Used only if compute_driver=xenapi.XenAPIDriver</td>
- </tr>
- <tr>
- <td>connection_url = None</td>
- <td>(StrOpt) URL for connection to XenServer/Xen Cloud Platform. A special value of unix://local can be used to connect to the local unix socket. Required if compute_driver=xenapi.XenAPIDriver</td>
- </tr>
- <tr>
- <td>connection_username = root</td>
- <td>(StrOpt) Username for connection to XenServer/Xen Cloud Platform. Used only if compute_driver=xenapi.XenAPIDriver</td>
- </tr>
- <tr>
- <td>default_os_type = linux</td>
- <td>(StrOpt) Default OS type</td>
- </tr>
- <tr>
- <td>disable_agent = False</td>
- <td>(BoolOpt) Disables the use of the XenAPI agent in any image regardless of what image properties are present.</td>
- </tr>
- <tr>
- <td>image_compression_level = None</td>
- <td>(IntOpt) Compression level for images, e.g., 9 for gzip -9. Range is 1-9, 9 being most compressed but most CPU intensive on dom0.</td>
- </tr>
- <tr>
- <td>image_upload_handler = nova.virt.xenapi.image.glance.GlanceStore</td>
- <td>(StrOpt) Dom0 plugin driver used to handle image uploads.</td>
- </tr>
- <tr>
- <td>introduce_vdi_retry_wait = 20</td>
- <td>(IntOpt) Number of seconds to wait for an SR to settle if the VDI does not exist when first introduced</td>
- </tr>
- <tr>
- <td>ipxe_boot_menu_url = None</td>
- <td>(StrOpt) URL to the iPXE boot menu</td>
- </tr>
- <tr>
- <td>ipxe_mkisofs_cmd = mkisofs</td>
- <td>(StrOpt) Name and optionally path of the tool used for ISO image creation</td>
- </tr>
- <tr>
- <td>ipxe_network_name = None</td>
- <td>(StrOpt) Name of network to use for booting iPXE ISOs</td>
- </tr>
- <tr>
- <td>iqn_prefix = iqn.2010-10.org.openstack</td>
- <td>(StrOpt) IQN Prefix</td>
- </tr>
- <tr>
- <td>login_timeout = 10</td>
- <td>(IntOpt) Timeout in seconds for XenAPI login.</td>
- </tr>
- <tr>
- <td>max_kernel_ramdisk_size = 16777216</td>
- <td>(IntOpt) Maximum size in bytes of kernel or ramdisk images</td>
- </tr>
- <tr>
- <td>num_vbd_unplug_retries = 10</td>
- <td>(IntOpt) Maximum number of retries to unplug VBD</td>
- </tr>
- <tr>
- <td>ovs_integration_bridge = xapi1</td>
- <td>(StrOpt) Name of Integration Bridge used by Open vSwitch</td>
- </tr>
- <tr>
- <td>remap_vbd_dev = False</td>
- <td>(BoolOpt) Used to enable the remapping of VBD dev (Works around an issue in Ubuntu Maverick)</td>
- </tr>
- <tr>
- <td>remap_vbd_dev_prefix = sd</td>
- <td>(StrOpt) Specify prefix to remap VBD dev to (ex. /dev/xvdb -> /dev/sdb)</td>
- </tr>
- <tr>
- <td>running_timeout = 60</td>
- <td>(IntOpt) Number of seconds to wait for instance to go to running state</td>
- </tr>
- <tr>
- <td>sparse_copy = True</td>
- <td>(BoolOpt) Whether to use sparse_copy for copying data on a resize down (False will use standard dd). This speeds up resizes down considerably since large runs of zeros won't have to be rsynced</td>
- </tr>
- <tr>
- <td>sr_base_path = /var/run/sr-mount</td>
- <td>(StrOpt) Base path to the storage repository</td>
- </tr>
- <tr>
- <td>sr_matching_filter = default-sr:true</td>
- <td>(StrOpt) Filter for finding the SR to be used to install guest instances on. To use the Local Storage in default XenServer/XCP installations set this flag to other-config:i18n-key=local-storage. To select an SR with a different matching criteria, you could set it to other-config:my_favorite_sr=true. On the other hand, to fall back on the Default SR, as displayed by XenCenter, set this flag to: default-sr:true</td>
- </tr>
- <tr>
- <td>target_host = None</td>
- <td>(StrOpt) The iSCSI Target Host</td>
- </tr>
- <tr>
- <td>target_port = 3260</td>
- <td>(StrOpt) The iSCSI Target Port, default is port 3260</td>
- </tr>
- <tr>
- <td>torrent_base_url = None</td>
- <td>(StrOpt) Base URL for torrent files.</td>
- </tr>
- <tr>
- <td>torrent_download_stall_cutoff = 600</td>
- <td>(IntOpt) Number of seconds a download can remain at the same progress percentage w/o being considered a stall</td>
- </tr>
- <tr>
- <td>torrent_images = none</td>
- <td>(StrOpt) Whether or not to download images via Bit Torrent (all|some|none).</td>
- </tr>
- <tr>
- <td>torrent_listen_port_end = 6891</td>
- <td>(IntOpt) End of port range to listen on</td>
- </tr>
- <tr>
- <td>torrent_listen_port_start = 6881</td>
- <td>(IntOpt) Beginning of port range to listen on</td>
- </tr>
- <tr>
- <td>torrent_max_last_accessed = 86400</td>
- <td>(IntOpt) Cached torrent files not accessed within this number of seconds can be reaped</td>
- </tr>
- <tr>
- <td>torrent_max_seeder_processes_per_host = 1</td>
- <td>(IntOpt) Maximum number of seeder processes to run concurrently within a given dom0. (-1 = no limit)</td>
- </tr>
- <tr>
- <td>torrent_seed_chance = 1.0</td>
- <td>(FloatOpt) Probability that peer will become a seeder. (1.0 = 100%)</td>
- </tr>
- <tr>
- <td>torrent_seed_duration = 3600</td>
- <td>(IntOpt) Number of seconds after downloading an image via BitTorrent that it should be seeded for other peers.</td>
- </tr>
- <tr>
- <td>use_agent_default = False</td>
- <td>(BoolOpt) Determines if the XenAPI agent should be used when the image used does not contain a hint to declare if the agent is present or not. The hint is a glance property "xenapi_use_agent" that has the value "True" or "False". Note that waiting for the agent when it is not present will significantly increase server boot times.</td>
- </tr>
- <tr>
- <td>use_join_force = True</td>
- <td>(BoolOpt) To use for hosts with different CPUs</td>
- </tr>
- <tr>
- <td>vhd_coalesce_max_attempts = 20</td>
- <td>(IntOpt) Max number of times to poll for VHD to coalesce. Used only if compute_driver=xenapi.XenAPIDriver</td>
- </tr>
- <tr>
- <td>vhd_coalesce_poll_interval = 5.0</td>
- <td>(FloatOpt) The interval used for polling of coalescing vhds. Used only if compute_driver=xenapi.XenAPIDriver</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_xen">
+ <caption>Description of configuration options for xen</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>console_driver = nova.console.xvp.XVPConsoleProxy</td>
+ <td>(StrOpt) Driver to use for the console proxy</td>
+ </tr>
+ <tr>
+ <td>console_vmrc_error_retries = 10</td>
+ <td>(IntOpt) Number of retries for retrieving VMRC information</td>
+ </tr>
+ <tr>
+ <td>console_vmrc_port = 443</td>
+ <td>(IntOpt) Port for VMware VMRC connections</td>
+ </tr>
+ <tr>
+ <td>console_xvp_conf = /etc/xvp.conf</td>
+ <td>(StrOpt) Generated XVP conf file</td>
+ </tr>
+ <tr>
+ <td>console_xvp_conf_template = $pybasedir/nova/console/xvp.conf.template</td>
+ <td>(StrOpt) XVP conf template</td>
+ </tr>
+ <tr>
+ <td>console_xvp_log = /var/log/xvp.log</td>
+ <td>(StrOpt) XVP log file</td>
+ </tr>
+ <tr>
+ <td>console_xvp_multiplex_port = 5900</td>
+ <td>(IntOpt) Port for XVP to multiplex VNC connections on</td>
+ </tr>
+ <tr>
+ <td>console_xvp_pid = /var/run/xvp.pid</td>
+ <td>(StrOpt) XVP master process pid file</td>
+ </tr>
+ <tr>
+ <td>stub_compute = False</td>
+ <td>(BoolOpt) Stub calls to compute worker for tests</td>
+ </tr>
+ <tr>
+ <th colspan="2">[libvirt]</th>
+ </tr>
+ <tr>
+ <td>xen_hvmloader_path = /usr/lib/xen/boot/hvmloader</td>
+ <td>(StrOpt) Location where the Xen hvmloader is kept</td>
+ </tr>
+ <tr>
+ <th colspan="2">[xenserver]</th>
+ </tr>
+ <tr>
+ <td>agent_path = usr/sbin/xe-update-networking</td>
+ <td>(StrOpt) Specifies the path in which the XenAPI guest agent should be located. If the agent is present, network configuration is not injected into the image. Used if compute_driver=xenapi.XenAPIDriver and flat_injected=True</td>
+ </tr>
+ <tr>
+ <td>agent_resetnetwork_timeout = 60</td>
+ <td>(IntOpt) Number of seconds to wait for agent reply to resetnetwork request</td>
+ </tr>
+ <tr>
+ <td>agent_timeout = 30</td>
+ <td>(IntOpt) Number of seconds to wait for agent reply</td>
+ </tr>
+ <tr>
+ <td>agent_version_timeout = 300</td>
+ <td>(IntOpt) Number of seconds to wait for agent to be fully operational</td>
+ </tr>
+ <tr>
+ <td>cache_images = all</td>
+ <td>(StrOpt) Cache glance images locally. `all` will cache all images, `some` will only cache images that have the image_property `cache_in_nova=True`, and `none` turns off caching entirely</td>
+ </tr>
+ <tr>
+ <td>check_host = True</td>
+ <td>(BoolOpt) Ensure compute service is running on host XenAPI connects to.</td>
+ </tr>
+ <tr>
+ <td>connection_concurrent = 5</td>
+ <td>(IntOpt) Maximum number of concurrent XenAPI connections. Used only if compute_driver=xenapi.XenAPIDriver</td>
+ </tr>
+ <tr>
+ <td>connection_password = None</td>
+ <td>(StrOpt) Password for connection to XenServer/Xen Cloud Platform. Used only if compute_driver=xenapi.XenAPIDriver</td>
+ </tr>
+ <tr>
+ <td>connection_url = None</td>
+ <td>(StrOpt) URL for connection to XenServer/Xen Cloud Platform. A special value of unix://local can be used to connect to the local unix socket. Required if compute_driver=xenapi.XenAPIDriver</td>
+ </tr>
+ <tr>
+ <td>connection_username = root</td>
+ <td>(StrOpt) Username for connection to XenServer/Xen Cloud Platform. Used only if compute_driver=xenapi.XenAPIDriver</td>
+ </tr>
+ <tr>
+ <td>default_os_type = linux</td>
+ <td>(StrOpt) Default OS type</td>
+ </tr>
+ <tr>
+ <td>disable_agent = False</td>
+ <td>(BoolOpt) Disables the use of the XenAPI agent in any image regardless of what image properties are present.</td>
+ </tr>
+ <tr>
+ <td>image_compression_level = None</td>
+ <td>(IntOpt) Compression level for images, e.g., 9 for gzip -9. Range is 1-9, 9 being most compressed but most CPU intensive on dom0.</td>
+ </tr>
+ <tr>
+ <td>image_upload_handler = nova.virt.xenapi.image.glance.GlanceStore</td>
+ <td>(StrOpt) Dom0 plugin driver used to handle image uploads.</td>
+ </tr>
+ <tr>
+ <td>introduce_vdi_retry_wait = 20</td>
+ <td>(IntOpt) Number of seconds to wait for an SR to settle if the VDI does not exist when first introduced</td>
+ </tr>
+ <tr>
+ <td>ipxe_boot_menu_url = None</td>
+ <td>(StrOpt) URL to the iPXE boot menu</td>
+ </tr>
+ <tr>
+ <td>ipxe_mkisofs_cmd = mkisofs</td>
+ <td>(StrOpt) Name and optionally path of the tool used for ISO image creation</td>
+ </tr>
+ <tr>
+ <td>ipxe_network_name = None</td>
+ <td>(StrOpt) Name of network to use for booting iPXE ISOs</td>
+ </tr>
+ <tr>
+ <td>iqn_prefix = iqn.2010-10.org.openstack</td>
+ <td>(StrOpt) IQN Prefix</td>
+ </tr>
+ <tr>
+ <td>login_timeout = 10</td>
+ <td>(IntOpt) Timeout in seconds for XenAPI login.</td>
+ </tr>
+ <tr>
+ <td>max_kernel_ramdisk_size = 16777216</td>
+ <td>(IntOpt) Maximum size in bytes of kernel or ramdisk images</td>
+ </tr>
+ <tr>
+ <td>num_vbd_unplug_retries = 10</td>
+ <td>(IntOpt) Maximum number of retries to unplug VBD</td>
+ </tr>
+ <tr>
+ <td>ovs_integration_bridge = xapi1</td>
+ <td>(StrOpt) Name of Integration Bridge used by Open vSwitch</td>
+ </tr>
+ <tr>
+ <td>remap_vbd_dev = False</td>
+ <td>(BoolOpt) Used to enable the remapping of VBD dev (Works around an issue in Ubuntu Maverick)</td>
+ </tr>
+ <tr>
+ <td>remap_vbd_dev_prefix = sd</td>
+ <td>(StrOpt) Specify prefix to remap VBD dev to (ex. /dev/xvdb -> /dev/sdb)</td>
+ </tr>
+ <tr>
+ <td>running_timeout = 60</td>
+ <td>(IntOpt) Number of seconds to wait for instance to go to running state</td>
+ </tr>
+ <tr>
+ <td>sparse_copy = True</td>
+ <td>(BoolOpt) Whether to use sparse_copy for copying data on a resize down (False will use standard dd). This speeds up resizes down considerably since large runs of zeros won't have to be rsynced</td>
+ </tr>
+ <tr>
+ <td>sr_base_path = /var/run/sr-mount</td>
+ <td>(StrOpt) Base path to the storage repository</td>
+ </tr>
+ <tr>
+ <td>sr_matching_filter = default-sr:true</td>
+ <td>(StrOpt) Filter for finding the SR to be used to install guest instances on. To use the Local Storage in default XenServer/XCP installations set this flag to other-config:i18n-key=local-storage. To select an SR with a different matching criteria, you could set it to other-config:my_favorite_sr=true. On the other hand, to fall back on the Default SR, as displayed by XenCenter, set this flag to: default-sr:true</td>
+ </tr>
+ <tr>
+ <td>target_host = None</td>
+ <td>(StrOpt) The iSCSI Target Host</td>
+ </tr>
+ <tr>
+ <td>target_port = 3260</td>
+ <td>(StrOpt) The iSCSI Target Port, default is port 3260</td>
+ </tr>
+ <tr>
+ <td>torrent_base_url = None</td>
+ <td>(StrOpt) Base URL for torrent files.</td>
+ </tr>
+ <tr>
+ <td>torrent_download_stall_cutoff = 600</td>
+ <td>(IntOpt) Number of seconds a download can remain at the same progress percentage w/o being considered a stall</td>
+ </tr>
+ <tr>
+ <td>torrent_images = none</td>
+ <td>(StrOpt) Whether or not to download images via Bit Torrent (all|some|none).</td>
+ </tr>
+ <tr>
+ <td>torrent_listen_port_end = 6891</td>
+ <td>(IntOpt) End of port range to listen on</td>
+ </tr>
+ <tr>
+ <td>torrent_listen_port_start = 6881</td>
+ <td>(IntOpt) Beginning of port range to listen on</td>
+ </tr>
+ <tr>
+ <td>torrent_max_last_accessed = 86400</td>
+ <td>(IntOpt) Cached torrent files not accessed within this number of seconds can be reaped</td>
+ </tr>
+ <tr>
+ <td>torrent_max_seeder_processes_per_host = 1</td>
+ <td>(IntOpt) Maximum number of seeder processes to run concurrently within a given dom0. (-1 = no limit)</td>
+ </tr>
+ <tr>
+ <td>torrent_seed_chance = 1.0</td>
+ <td>(FloatOpt) Probability that peer will become a seeder. (1.0 = 100%)</td>
+ </tr>
+ <tr>
+ <td>torrent_seed_duration = 3600</td>
+ <td>(IntOpt) Number of seconds after downloading an image via BitTorrent that it should be seeded for other peers.</td>
+ </tr>
+ <tr>
+ <td>use_agent_default = False</td>
+ <td>(BoolOpt) Determines if the XenAPI agent should be used when the image used does not contain a hint to declare if the agent is present or not. The hint is a glance property "xenapi_use_agent" that has the value "True" or "False". Note that waiting for the agent when it is not present will significantly increase server boot times.</td>
+ </tr>
+ <tr>
+ <td>use_join_force = True</td>
+ <td>(BoolOpt) To use for hosts with different CPUs</td>
+ </tr>
+ <tr>
+ <td>vhd_coalesce_max_attempts = 20</td>
+ <td>(IntOpt) Max number of times to poll for VHD to coalesce. Used only if compute_driver=xenapi.XenAPIDriver</td>
+ </tr>
+ <tr>
+ <td>vhd_coalesce_poll_interval = 5.0</td>
+ <td>(FloatOpt) The interval used for polling of coalescing vhds. Used only if compute_driver=xenapi.XenAPIDriver</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-xvpnvncproxy.xml b/doc/common/tables/nova-xvpnvncproxy.xml
index f6e6915912..e87b429b44 100644
--- a/doc/common/tables/nova-xvpnvncproxy.xml
+++ b/doc/common/tables/nova-xvpnvncproxy.xml
@@ -1,35 +1,34 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_xvpnvncproxy">
- <caption>Description of configuration options for xvpnvncproxy</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>xvpvncproxy_base_url = http://127.0.0.1:6081/console</td>
- <td>(StrOpt) Location of nova xvp VNC console proxy, in the form "http://127.0.0.1:6081/console"</td>
- </tr>
- <tr>
- <td>xvpvncproxy_host = 0.0.0.0</td>
- <td>(StrOpt) Address that the XCP VNC proxy should bind to</td>
- </tr>
- <tr>
- <td>xvpvncproxy_port = 6081</td>
- <td>(IntOpt) Port that the XCP VNC proxy should bind to</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_xvpnvncproxy">
+ <caption>Description of configuration options for xvpnvncproxy</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>xvpvncproxy_base_url = http://127.0.0.1:6081/console</td>
+ <td>(StrOpt) Location of nova xvp VNC console proxy, in the form "http://127.0.0.1:6081/console"</td>
+ </tr>
+ <tr>
+ <td>xvpvncproxy_host = 0.0.0.0</td>
+ <td>(StrOpt) Address that the XCP VNC proxy should bind to</td>
+ </tr>
+ <tr>
+ <td>xvpvncproxy_port = 6081</td>
+ <td>(IntOpt) Port that the XCP VNC proxy should bind to</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-zeromq.xml b/doc/common/tables/nova-zeromq.xml
index 94e818666d..fd56304c65 100644
--- a/doc/common/tables/nova-zeromq.xml
+++ b/doc/common/tables/nova-zeromq.xml
@@ -1,51 +1,50 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_zeromq">
- <caption>Description of configuration options for zeromq</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>rpc_zmq_bind_address = *</td>
- <td>(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address.</td>
- </tr>
- <tr>
- <td>rpc_zmq_contexts = 1</td>
- <td>(IntOpt) Number of ZeroMQ contexts, defaults to 1.</td>
- </tr>
- <tr>
- <td>rpc_zmq_host = oslo</td>
- <td>(StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova.</td>
- </tr>
- <tr>
- <td>rpc_zmq_ipc_dir = /var/run/openstack</td>
- <td>(StrOpt) Directory for holding IPC sockets.</td>
- </tr>
- <tr>
- <td>rpc_zmq_matchmaker = oslo.messaging._drivers.matchmaker.MatchMakerLocalhost</td>
- <td>(StrOpt) MatchMaker driver.</td>
- </tr>
- <tr>
- <td>rpc_zmq_port = 9501</td>
- <td>(IntOpt) ZeroMQ receiver listening port.</td>
- </tr>
- <tr>
- <td>rpc_zmq_topic_backlog = None</td>
- <td>(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_zeromq">
+ <caption>Description of configuration options for zeromq</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>rpc_zmq_bind_address = *</td>
+ <td>(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_contexts = 1</td>
+ <td>(IntOpt) Number of ZeroMQ contexts, defaults to 1.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_host = oslo</td>
+ <td>(StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_ipc_dir = /var/run/openstack</td>
+ <td>(StrOpt) Directory for holding IPC sockets.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_matchmaker = oslo.messaging._drivers.matchmaker.MatchMakerLocalhost</td>
+ <td>(StrOpt) MatchMaker driver.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_port = 9501</td>
+ <td>(IntOpt) ZeroMQ receiver listening port.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_topic_backlog = None</td>
+ <td>(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/nova-zookeeper.xml b/doc/common/tables/nova-zookeeper.xml
index a22d3ba5fd..5e19ad8caa 100644
--- a/doc/common/tables/nova-zookeeper.xml
+++ b/doc/common/tables/nova-zookeeper.xml
@@ -1,39 +1,38 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_nova_zookeeper">
- <caption>Description of configuration options for zookeeper</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">[zookeeper]</th>
- </tr>
- <tr>
- <td>address = None</td>
- <td>(StrOpt) The ZooKeeper addresses for servicegroup service in the format of host1:port,host2:port,host3:port</td>
- </tr>
- <tr>
- <td>recv_timeout = 4000</td>
- <td>(IntOpt) The recv_timeout parameter for the zk session</td>
- </tr>
- <tr>
- <td>sg_prefix = /servicegroups</td>
- <td>(StrOpt) The prefix used in ZooKeeper to store ephemeral nodes</td>
- </tr>
- <tr>
- <td>sg_retry_interval = 5</td>
- <td>(IntOpt) Number of seconds to wait until retrying to join the session</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?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_nova_zookeeper">
+ <caption>Description of configuration options for zookeeper</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">[zookeeper]</th>
+ </tr>
+ <tr>
+ <td>address = None</td>
+ <td>(StrOpt) The ZooKeeper addresses for servicegroup service in the format of host1:port,host2:port,host3:port</td>
+ </tr>
+ <tr>
+ <td>recv_timeout = 4000</td>
+ <td>(IntOpt) The recv_timeout parameter for the zk session</td>
+ </tr>
+ <tr>
+ <td>sg_prefix = /servicegroups</td>
+ <td>(StrOpt) The prefix used in ZooKeeper to store ephemeral nodes</td>
+ </tr>
+ <tr>
+ <td>sg_retry_interval = 5</td>
+ <td>(IntOpt) Number of seconds to wait until retrying to join the session</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/swift-account-server-DEFAULT.xml b/doc/common/tables/swift-account-server-DEFAULT.xml
index daf57f9b31..8b665b79d8 100644
--- a/doc/common/tables/swift-account-server-DEFAULT.xml
+++ b/doc/common/tables/swift-account-server-DEFAULT.xml
@@ -1,51 +1,115 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[DEFAULT]</literal> in <literal>account-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[DEFAULT]</literal> in <literal>account-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>bind_ip = 0.0.0.0</td><td>IP Address for server to bind to</td>
- </tr>
- <tr>
- <td>bind_port = 6002</td><td>Port for server to bind to</td>
- </tr>
- <tr>
- <td>bind_timeout = 30</td><td>Seconds to attempt bind before giving up</td>
- </tr>
- <tr>
- <td>backlog = 4096</td><td>Maximum number of allowed pending TCP connections</td>
- </tr>
- <tr>
- <td>user = swift</td><td>User to run as</td>
- </tr>
- <tr>
- <td>swift_dir = /etc/swift</td><td>Swift configuration directory</td>
- </tr>
- <tr>
- <td>devices = /srv/node</td><td>Parent directory of where devices are mounted</td>
- </tr>
- <tr>
- <td>mount_check = true</td><td>Whether or not check if the devices are mounted to prevent accidentally writing to the root device</td>
- </tr>
- <tr>
- <td>disable_fallocate = false</td><td>Disable "fast fail" fallocate checks if the underlying filesystem does not support it.</td>
- </tr>
- <tr>
- <td>workers = auto</td><td>a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests.</td>
- </tr>
- <tr>
- <td>max_clients = 1024</td><td>Maximum number of clients one worker can process simultaneously
+ <tr>
+ <td>backlog = 4096</td>
+ <td>Maximum number of allowed pending TCP connections</td>
+ </tr>
+ <tr>
+ <td>bind_ip = 0.0.0.0</td>
+ <td>IP Address for server to bind to</td>
+ </tr>
+ <tr>
+ <td>bind_port = 6002</td>
+ <td>Port for server to bind to</td>
+ </tr>
+ <tr>
+ <td>bind_timeout = 30</td>
+ <td>Seconds to attempt bind before giving up</td>
+ </tr>
+ <tr>
+ <td>db_preallocation = off</td>
+ <td>If you don't mind the extra disk space usage in overhead, you can turn this on to preallocate disk space with SQLite databases to decrease fragmentation. underlying filesystem does not support it. to setup custom log handlers. bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. server. For most cases, this should be `egg:swift#account`. replication passes account can be reclaimed</td>
+ </tr>
+ <tr>
+ <td>devices = /srv/node</td>
+ <td>Parent directory of where devices are mounted</td>
+ </tr>
+ <tr>
+ <td>disable_fallocate = false</td>
+ <td>Disable "fast fail" fallocate checks if the underlying filesystem does not support it.</td>
+ </tr>
+ <tr>
+ <td>eventlet_debug = false</td>
+ <td>If true, turn on debug logging for eventlet</td>
+ </tr>
+ <tr>
+ <td>fallocate_reserve = 0</td>
+ <td>You can set fallocate_reserve to the number of bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. server. For most cases, this should be `egg:swift#object`.</td>
+ </tr>
+ <tr>
+ <td>log_address = /dev/log</td>
+ <td>Location where syslog sends the logs to</td>
+ </tr>
+ <tr>
+ <td>log_custom_handlers = </td>
+ <td>Comma-separated list of functions to call to setup custom log handlers.</td>
+ </tr>
+ <tr>
+ <td>log_facility = LOG_LOCAL0</td>
+ <td>Syslog log facility</td>
+ </tr>
+ <tr>
+ <td>log_level = INFO</td>
+ <td>Logging level</td>
+ </tr>
+ <tr>
+ <td>log_max_line_length = 0</td>
+ <td>Caps the length of log lines to the value given; no limit if set to 0, the default.</td>
+ </tr>
+ <tr>
+ <td>log_name = swift</td>
+ <td>Label used when logging</td>
+ </tr>
+ <tr>
+ <td>log_statsd_default_sample_rate = 1.0</td>
+ <td>Defines the probability of sending a sample for any given event or
+ timing measurement.</td>
+ </tr>
+ <tr>
+ <td>log_statsd_host = localhost</td>
+ <td>If not set, the StatsD feature is disabled.</td>
+ </tr>
+ <tr>
+ <td>log_statsd_metric_prefix = </td>
+ <td>Value will be prepended to every metric sent to the StatsD server.</td>
+ </tr>
+ <tr>
+ <td>log_statsd_port = 8125</td>
+ <td>Port value for the StatsD server.</td>
+ </tr>
+ <tr>
+ <td>log_statsd_sample_rate_factor = 1.0</td>
+ <td>Not recommended to set this to a value less than 1.0, if frequency
+ of logging is too high, tune the
+ log_statsd_default_sample_rate instead.</td>
+ </tr>
+ <tr>
+ <td>log_udp_host = </td>
+ <td>If not set, the UDB receiver for syslog is disabled.</td>
+ </tr>
+ <tr>
+ <td>log_udp_port = 514</td>
+ <td>Port value for UDB receiver, if enabled.</td>
+ </tr>
+ <tr>
+ <td>max_clients = 1024</td>
+ <td>Maximum number of clients one worker can process simultaneously
Lowering the number of clients handled per worker, and raising the
number of workers can lessen the impact that a CPU intensive, or
blocking, request can have on other requests served by the same
@@ -53,55 +117,23 @@ worker. If the maximum number of clients is set to one, then a given worker
will not perform another call while processing, allowing
other workers a chance to process it.
</td>
- </tr>
- <tr>
- <td>log_name = swift</td><td>Label used when logging</td>
- </tr>
- <tr>
- <td>log_facility = LOG_LOCAL0</td><td>Syslog log facility</td>
- </tr>
- <tr>
- <td>log_level = INFO</td><td>Logging level</td>
- </tr>
- <tr>
- <td>log_address = /dev/log</td><td>Location where syslog sends the logs to</td>
- </tr>
- <tr>
- <td>log_custom_handlers = </td><td>Comma-separated list of functions to call to setup custom log handlers.</td>
- </tr>
- <tr>
- <td>log_udp_host = </td><td>If not set, the UDB receiver for syslog is disabled.</td>
- </tr>
- <tr>
- <td>log_udp_port = 514</td><td>Port value for UDB receiver, if enabled.</td>
- </tr>
- <tr>
- <td>log_statsd_host = localhost</td><td>If not set, the StatsD feature is disabled.</td>
- </tr>
- <tr>
- <td>log_statsd_port = 8125</td><td>Port value for the StatsD server.</td>
- </tr>
- <tr>
- <td>log_statsd_default_sample_rate = 1.0</td><td>Defines the probability of sending a sample for any given event or
- timing measurement.</td>
- </tr>
- <tr>
- <td>log_statsd_sample_rate_factor = 1.0</td><td>Not recommended to set this to a value less than 1.0, if frequency
- of logging is too high, tune the
- log_statsd_default_sample_rate instead.</td>
- </tr>
- <tr>
- <td>log_statsd_metric_prefix = </td><td>Value will be prepended to every metric sent to the StatsD server.</td>
- </tr>
- <tr>
- <td>db_preallocation = off</td><td>If you don't mind the extra disk space usage in overhead, you can turn this on to preallocate disk space with SQLite databases to decrease fragmentation. underlying filesystem does not support it. to setup custom log handlers. bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. server. For most cases, this should be `egg:swift#account`. replication passes account can be reclaimed</td>
- </tr>
- <tr>
- <td>eventlet_debug = false</td><td>If true, turn on debug logging for eventlet</td>
- </tr>
- <tr>
- <td>fallocate_reserve = 0</td><td>You can set fallocate_reserve to the number of bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. server. For most cases, this should be `egg:swift#object`.</td>
- </tr>
+ </tr>
+ <tr>
+ <td>mount_check = true</td>
+ <td>Whether or not check if the devices are mounted to prevent accidentally writing to the root device</td>
+ </tr>
+ <tr>
+ <td>swift_dir = /etc/swift</td>
+ <td>Swift configuration directory</td>
+ </tr>
+ <tr>
+ <td>user = swift</td>
+ <td>User to run as</td>
+ </tr>
+ <tr>
+ <td>workers = auto</td>
+ <td>a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests.</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-account-server-account-auditor.xml b/doc/common/tables/swift-account-server-account-auditor.xml
index 6119fd8acb..39f33b7d4e 100644
--- a/doc/common/tables/swift-account-server-account-auditor.xml
+++ b/doc/common/tables/swift-account-server-account-auditor.xml
@@ -1,46 +1,49 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[account-auditor]</literal> in <literal>account-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[account-auditor]</literal> in <literal>account-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>log_name = account-auditor</td><td>Label used when logging</td>
- </tr>
- <tr>
- <td>log_facility = LOG_LOCAL0</td><td>Syslog log facility</td>
- </tr>
- <tr>
- <td>log_level = INFO</td><td>Logging level</td>
- </tr>
- <tr>
- <td>log_address = /dev/log</td><td>Location where syslog sends the logs to</td>
- </tr>
- <tr>
- <td>interval = 1800</td><td>Minimum time for a pass to take</td>
- </tr>
- <tr>
- <td>log_facility = LOG_LOCAL0</td><td>Syslog log facility</td>
- </tr>
- <tr>
- <td>log_level = INFO</td><td>Logging level</td>
- </tr>
- <tr>
- <td>accounts_per_second = 200</td><td>Maximum accounts audited per second. Should be tuned according to individual system specs. 0 is unlimited.</td>
- </tr>
- <tr>
- <td>recon_cache_path = /var/cache/swift</td><td>Directory where stats for a few items will be stored</td>
- </tr>
+ <tr>
+ <td>accounts_per_second = 200</td>
+ <td>Maximum accounts audited per second. Should be tuned according to individual system specs. 0 is unlimited.</td>
+ </tr>
+ <tr>
+ <td>interval = 1800</td>
+ <td>Minimum time for a pass to take</td>
+ </tr>
+ <tr>
+ <td>log_address = /dev/log</td>
+ <td>Location where syslog sends the logs to</td>
+ </tr>
+ <tr>
+ <td>log_facility = LOG_LOCAL0</td>
+ <td>Syslog log facility</td>
+ </tr>
+ <tr>
+ <td>log_level = INFO</td>
+ <td>Logging level</td>
+ </tr>
+ <tr>
+ <td>log_name = account-auditor</td>
+ <td>Label used when logging</td>
+ </tr>
+ <tr>
+ <td>recon_cache_path = /var/cache/swift</td>
+ <td>Directory where stats for a few items will be stored</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-account-server-account-reaper.xml b/doc/common/tables/swift-account-server-account-reaper.xml
index 994f9cceca..0ee94aa6c4 100644
--- a/doc/common/tables/swift-account-server-account-reaper.xml
+++ b/doc/common/tables/swift-account-server-account-reaper.xml
@@ -1,49 +1,61 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[account-reaper]</literal> in <literal>account-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[account-reaper]</literal> in <literal>account-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>log_name = account-reaper</td><td>Label used when logging</td>
- </tr>
- <tr>
- <td>log_facility = LOG_LOCAL0</td><td>Syslog log facility</td>
- </tr>
- <tr>
- <td>log_level = INFO</td><td>Logging level</td>
- </tr>
- <tr>
- <td>log_address = /dev/log</td><td>Location where syslog sends the logs to</td>
- </tr>
- <tr>
- <td>concurrency = 25</td><td>Number of replication workers to spawn</td>
- </tr>
- <tr>
- <td>interval = 3600</td><td>Minimum time for a pass to take</td>
- </tr>
- <tr>
- <td>node_timeout = 10</td><td>Request timeout to external services</td>
- </tr>
- <tr>
- <td>conn_timeout = 0.5</td><td>Connection timeout to external services</td>
- </tr>
- <tr>
- <td>delay_reaping = 0</td><td>Normally, the reaper begins deleting account information for deleted accounts immediately; you can set this to delay its work however. The value is in seconds, 2592000 = 30 days, for example. bind to giving up worker can process simultaneously (it will actually accept(2) N + 1). Setting this to one (1) will only handle one request at a time, without accepting another request concurrently. By increasing the number of workers to a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests.</td>
- </tr>
- <tr>
- <td>reap_warn_after = 2592000</td><td>No help text available for this option.</td>
- </tr>
+ <tr>
+ <td>concurrency = 25</td>
+ <td>Number of replication workers to spawn</td>
+ </tr>
+ <tr>
+ <td>conn_timeout = 0.5</td>
+ <td>Connection timeout to external services</td>
+ </tr>
+ <tr>
+ <td>delay_reaping = 0</td>
+ <td>Normally, the reaper begins deleting account information for deleted accounts immediately; you can set this to delay its work however. The value is in seconds, 2592000 = 30 days, for example. bind to giving up worker can process simultaneously (it will actually accept(2) N + 1). Setting this to one (1) will only handle one request at a time, without accepting another request concurrently. By increasing the number of workers to a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests.</td>
+ </tr>
+ <tr>
+ <td>interval = 3600</td>
+ <td>Minimum time for a pass to take</td>
+ </tr>
+ <tr>
+ <td>log_address = /dev/log</td>
+ <td>Location where syslog sends the logs to</td>
+ </tr>
+ <tr>
+ <td>log_facility = LOG_LOCAL0</td>
+ <td>Syslog log facility</td>
+ </tr>
+ <tr>
+ <td>log_level = INFO</td>
+ <td>Logging level</td>
+ </tr>
+ <tr>
+ <td>log_name = account-reaper</td>
+ <td>Label used when logging</td>
+ </tr>
+ <tr>
+ <td>node_timeout = 10</td>
+ <td>Request timeout to external services</td>
+ </tr>
+ <tr>
+ <td>reap_warn_after = 2592000</td>
+ <td>No help text available for this option.</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-account-server-account-replicator.xml b/doc/common/tables/swift-account-server-account-replicator.xml
index b45ccfc32e..cb83636d2c 100644
--- a/doc/common/tables/swift-account-server-account-replicator.xml
+++ b/doc/common/tables/swift-account-server-account-replicator.xml
@@ -1,67 +1,85 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[account-replicator]</literal> in <literal>account-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[account-replicator]</literal> in <literal>account-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>log_name = account-replicator</td><td>Label used when logging</td>
- </tr>
- <tr>
- <td>log_facility = LOG_LOCAL0</td><td>Syslog log facility</td>
- </tr>
- <tr>
- <td>log_level = INFO</td><td>Logging level</td>
- </tr>
- <tr>
- <td>log_address = /dev/log</td><td>Location where syslog sends the logs to</td>
- </tr>
- <tr>
- <td>vm_test_mode = no</td><td>Indicates that you are using a VM environment</td>
- </tr>
- <tr>
- <td>per_diff = 1000</td><td>Limit number of items to get per diff</td>
- </tr>
- <tr>
- <td>max_diffs = 100</td><td>Caps how long the replicator spends trying to sync a database per pass</td>
- </tr>
- <tr>
- <td>concurrency = 8</td><td>Number of replication workers to spawn</td>
- </tr>
- <tr>
- <td>interval = 30</td><td>Minimum time for a pass to take</td>
- </tr>
- <tr>
- <td>error_suppression_interval = 60</td><td>Time in seconds that must elapse since the last error for a node to be considered no longer error limited</td>
- </tr>
- <tr>
- <td>error_suppression_limit = 10</td><td>Error count to consider a node error limited</td>
- </tr>
- <tr>
- <td>node_timeout = 10</td><td>Request timeout to external services</td>
- </tr>
- <tr>
- <td>conn_timeout = 0.5</td><td>Connection timeout to external services</td>
- </tr>
- <tr>
- <td>reclaim_age = 604800</td><td>Time elapsed in seconds before an object can be reclaimed</td>
- </tr>
- <tr>
- <td>run_pause = 30</td><td>Time in seconds to wait between replication passes</td>
- </tr>
- <tr>
- <td>recon_cache_path = /var/cache/swift</td><td>Directory where stats for a few items will be stored</td>
- </tr>
+ <tr>
+ <td>concurrency = 8</td>
+ <td>Number of replication workers to spawn</td>
+ </tr>
+ <tr>
+ <td>conn_timeout = 0.5</td>
+ <td>Connection timeout to external services</td>
+ </tr>
+ <tr>
+ <td>error_suppression_interval = 60</td>
+ <td>Time in seconds that must elapse since the last error for a node to be considered no longer error limited</td>
+ </tr>
+ <tr>
+ <td>error_suppression_limit = 10</td>
+ <td>Error count to consider a node error limited</td>
+ </tr>
+ <tr>
+ <td>interval = 30</td>
+ <td>Minimum time for a pass to take</td>
+ </tr>
+ <tr>
+ <td>log_address = /dev/log</td>
+ <td>Location where syslog sends the logs to</td>
+ </tr>
+ <tr>
+ <td>log_facility = LOG_LOCAL0</td>
+ <td>Syslog log facility</td>
+ </tr>
+ <tr>
+ <td>log_level = INFO</td>
+ <td>Logging level</td>
+ </tr>
+ <tr>
+ <td>log_name = account-replicator</td>
+ <td>Label used when logging</td>
+ </tr>
+ <tr>
+ <td>max_diffs = 100</td>
+ <td>Caps how long the replicator spends trying to sync a database per pass</td>
+ </tr>
+ <tr>
+ <td>node_timeout = 10</td>
+ <td>Request timeout to external services</td>
+ </tr>
+ <tr>
+ <td>per_diff = 1000</td>
+ <td>Limit number of items to get per diff</td>
+ </tr>
+ <tr>
+ <td>reclaim_age = 604800</td>
+ <td>Time elapsed in seconds before an object can be reclaimed</td>
+ </tr>
+ <tr>
+ <td>recon_cache_path = /var/cache/swift</td>
+ <td>Directory where stats for a few items will be stored</td>
+ </tr>
+ <tr>
+ <td>run_pause = 30</td>
+ <td>Time in seconds to wait between replication passes</td>
+ </tr>
+ <tr>
+ <td>vm_test_mode = no</td>
+ <td>Indicates that you are using a VM environment</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-account-server-app-account-server.xml b/doc/common/tables/swift-account-server-app-account-server.xml
index 8e91285cf5..33b5270e4c 100644
--- a/doc/common/tables/swift-account-server-app-account-server.xml
+++ b/doc/common/tables/swift-account-server-app-account-server.xml
@@ -1,43 +1,53 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[app:account-server]</literal> in <literal>account-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[app-account-server]</literal> in <literal>account-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>use = egg:swift#account</td><td>Entry point of paste.deploy in the server</td>
- </tr>
- <tr>
- <td>set log_name = account-server</td><td>Label to use when logging</td>
- </tr>
- <tr>
- <td>set log_facility = LOG_LOCAL0</td><td>Syslog log facility</td>
- </tr>
- <tr>
- <td>set log_level = INFO</td><td>Log level</td>
- </tr>
- <tr>
- <td>set log_requests = true</td><td>Whether or not to log requests</td>
- </tr>
- <tr>
- <td>set log_address = /dev/log</td><td>Location where syslog sends the logs to</td>
- </tr>
- <tr>
- <td>auto_create_account_prefix = .</td><td>Prefix to use when automatically creating accounts</td>
- </tr>
- <tr>
- <td>replication_server = false</td><td>If defined, tells server how to handle replication verbs in requests. When set to True (or 1), only replication verbs will be accepted. When set to False, replication verbs will be rejected. When undefined, server will accept any verb in the request.</td>
- </tr>
+ <tr>
+ <td>auto_create_account_prefix = .</td>
+ <td>Prefix to use when automatically creating accounts</td>
+ </tr>
+ <tr>
+ <td>replication_server = false</td>
+ <td>If defined, tells server how to handle replication verbs in requests. When set to True (or 1), only replication verbs will be accepted. When set to False, replication verbs will be rejected. When undefined, server will accept any verb in the request.</td>
+ </tr>
+ <tr>
+ <td>set log_address = /dev/log</td>
+ <td>Location where syslog sends the logs to</td>
+ </tr>
+ <tr>
+ <td>set log_facility = LOG_LOCAL0</td>
+ <td>Syslog log facility</td>
+ </tr>
+ <tr>
+ <td>set log_level = INFO</td>
+ <td>Log level</td>
+ </tr>
+ <tr>
+ <td>set log_name = account-server</td>
+ <td>Label to use when logging</td>
+ </tr>
+ <tr>
+ <td>set log_requests = true</td>
+ <td>Whether or not to log requests</td>
+ </tr>
+ <tr>
+ <td>use = egg:swift#account</td>
+ <td>Entry point of paste.deploy in the server</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-account-server-filter-healthcheck.xml b/doc/common/tables/swift-account-server-filter-healthcheck.xml
index a657fa53c3..dbf8ae6bad 100644
--- a/doc/common/tables/swift-account-server-filter-healthcheck.xml
+++ b/doc/common/tables/swift-account-server-filter-healthcheck.xml
@@ -1,25 +1,29 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[filter:healthcheck]</literal> in <literal>account-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[filter-healthcheck]</literal> in <literal>account-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>use = egg:swift#healthcheck</td><td>Entry point of paste.deploy in the server</td>
- </tr>
- <tr>
- <td>disable_path = </td><td>No help text available for this option.</td>
- </tr>
+ <tr>
+ <td>disable_path = </td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>use = egg:swift#healthcheck</td>
+ <td>Entry point of paste.deploy in the server</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-account-server-filter-recon.xml b/doc/common/tables/swift-account-server-filter-recon.xml
index 99e830c502..29647f9593 100644
--- a/doc/common/tables/swift-account-server-filter-recon.xml
+++ b/doc/common/tables/swift-account-server-filter-recon.xml
@@ -1,25 +1,29 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[filter:recon]</literal> in <literal>account-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[filter-recon]</literal> in <literal>account-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>use = egg:swift#recon</td><td>Entry point of paste.deploy in the server</td>
- </tr>
- <tr>
- <td>recon_cache_path = /var/cache/swift</td><td>Directory where stats for a few items will be stored</td>
- </tr>
+ <tr>
+ <td>recon_cache_path = /var/cache/swift</td>
+ <td>Directory where stats for a few items will be stored</td>
+ </tr>
+ <tr>
+ <td>use = egg:swift#recon</td>
+ <td>Entry point of paste.deploy in the server</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-account-server-filter-xprofile.xml b/doc/common/tables/swift-account-server-filter-xprofile.xml
new file mode 100644
index 0000000000..197c085668
--- /dev/null
+++ b/doc/common/tables/swift-account-server-filter-xprofile.xml
@@ -0,0 +1,53 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[filter-xprofile]</literal> in <literal>account-server.conf</literal>
+ </caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>dump_interval = 5.0</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>dump_timestamp = false</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>flush_at_shutdown = false</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>log_filename_prefix = /tmp/log/swift/profile/default.profile</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>path = /__profile__</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>profile_module = eventlet.green.profile</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>unwind = false</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>use = egg:swift#xprofile</td>
+ <td>Entry point of paste.deploy in the server</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/swift-account-server-pipeline-main.xml b/doc/common/tables/swift-account-server-pipeline-main.xml
index d4bd419d0d..d19bd6ef31 100644
--- a/doc/common/tables/swift-account-server-pipeline-main.xml
+++ b/doc/common/tables/swift-account-server-pipeline-main.xml
@@ -1,22 +1,25 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[pipeline:main]</literal> in <literal>account-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[pipeline-main]</literal> in <literal>account-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>pipeline = healthcheck recon account-server</td><td>No help text available for this option.</td>
- </tr>
+ <tr>
+ <td>pipeline = healthcheck recon account-server</td>
+ <td>No help text available for this option.</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-container-reconciler-DEFAULT.xml b/doc/common/tables/swift-container-reconciler-DEFAULT.xml
new file mode 100644
index 0000000000..024e32db3f
--- /dev/null
+++ b/doc/common/tables/swift-container-reconciler-DEFAULT.xml
@@ -0,0 +1,80 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[DEFAULT]</literal> in <literal>container-reconciler.conf</literal>
+ </caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>log_address = /dev/log</td>
+ <td>Location where syslog sends the logs to</td>
+ </tr>
+ <tr>
+ <td>log_custom_handlers = </td>
+ <td>Comma-separated list of functions to call to setup custom log handlers.</td>
+ </tr>
+ <tr>
+ <td>log_facility = LOG_LOCAL0</td>
+ <td>Syslog log facility</td>
+ </tr>
+ <tr>
+ <td>log_level = INFO</td>
+ <td>Logging level</td>
+ </tr>
+ <tr>
+ <td>log_name = swift</td>
+ <td>Label used when logging</td>
+ </tr>
+ <tr>
+ <td>log_statsd_default_sample_rate = 1.0</td>
+ <td>Defines the probability of sending a sample for any given event or
+ timing measurement.</td>
+ </tr>
+ <tr>
+ <td>log_statsd_host = localhost</td>
+ <td>If not set, the StatsD feature is disabled.</td>
+ </tr>
+ <tr>
+ <td>log_statsd_metric_prefix = </td>
+ <td>Value will be prepended to every metric sent to the StatsD server.</td>
+ </tr>
+ <tr>
+ <td>log_statsd_port = 8125</td>
+ <td>Port value for the StatsD server.</td>
+ </tr>
+ <tr>
+ <td>log_statsd_sample_rate_factor = 1.0</td>
+ <td>Not recommended to set this to a value less than 1.0, if frequency
+ of logging is too high, tune the
+ log_statsd_default_sample_rate instead.</td>
+ </tr>
+ <tr>
+ <td>log_udp_host = </td>
+ <td>If not set, the UDB receiver for syslog is disabled.</td>
+ </tr>
+ <tr>
+ <td>log_udp_port = 514</td>
+ <td>Port value for UDB receiver, if enabled.</td>
+ </tr>
+ <tr>
+ <td>swift_dir = /etc/swift</td>
+ <td>Swift configuration directory</td>
+ </tr>
+ <tr>
+ <td>user = swift</td>
+ <td>User to run as</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/swift-container-reconciler-app-proxy-server.xml b/doc/common/tables/swift-container-reconciler-app-proxy-server.xml
new file mode 100644
index 0000000000..cc63b04606
--- /dev/null
+++ b/doc/common/tables/swift-container-reconciler-app-proxy-server.xml
@@ -0,0 +1,25 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[app-proxy-server]</literal> in <literal>container-reconciler.conf</literal>
+ </caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>use = egg:swift#proxy</td>
+ <td>Entry point of paste.deploy in the server</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/swift-container-reconciler-container-reconciler.xml b/doc/common/tables/swift-container-reconciler-container-reconciler.xml
new file mode 100644
index 0000000000..3ed6ed4e3f
--- /dev/null
+++ b/doc/common/tables/swift-container-reconciler-container-reconciler.xml
@@ -0,0 +1,33 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[container-reconciler]</literal> in <literal>container-reconciler.conf</literal>
+ </caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>interval = 300</td>
+ <td>Minimum time for a pass to take</td>
+ </tr>
+ <tr>
+ <td>reclaim_age = 604800</td>
+ <td>Time elapsed in seconds before an object can be reclaimed</td>
+ </tr>
+ <tr>
+ <td>request_tries = 3</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/swift-container-reconciler-filter-cache.xml b/doc/common/tables/swift-container-reconciler-filter-cache.xml
new file mode 100644
index 0000000000..e443bb0fbb
--- /dev/null
+++ b/doc/common/tables/swift-container-reconciler-filter-cache.xml
@@ -0,0 +1,25 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[filter-cache]</literal> in <literal>container-reconciler.conf</literal>
+ </caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>use = egg:swift#memcache</td>
+ <td>Entry point of paste.deploy in the server</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/swift-container-reconciler-filter-catch_errors.xml b/doc/common/tables/swift-container-reconciler-filter-catch_errors.xml
new file mode 100644
index 0000000000..45b7b2aedc
--- /dev/null
+++ b/doc/common/tables/swift-container-reconciler-filter-catch_errors.xml
@@ -0,0 +1,25 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[filter-catch_errors]</literal> in <literal>container-reconciler.conf</literal>
+ </caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>use = egg:swift#catch_errors</td>
+ <td>Entry point of paste.deploy in the server</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/swift-container-reconciler-filter-proxy-logging.xml b/doc/common/tables/swift-container-reconciler-filter-proxy-logging.xml
new file mode 100644
index 0000000000..14c78ecd1a
--- /dev/null
+++ b/doc/common/tables/swift-container-reconciler-filter-proxy-logging.xml
@@ -0,0 +1,25 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[filter-proxy-logging]</literal> in <literal>container-reconciler.conf</literal>
+ </caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>use = egg:swift#proxy_logging</td>
+ <td>Entry point of paste.deploy in the server</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/swift-container-reconciler-pipeline-main.xml b/doc/common/tables/swift-container-reconciler-pipeline-main.xml
new file mode 100644
index 0000000000..09e42c6758
--- /dev/null
+++ b/doc/common/tables/swift-container-reconciler-pipeline-main.xml
@@ -0,0 +1,25 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[pipeline-main]</literal> in <literal>container-reconciler.conf</literal>
+ </caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>pipeline = catch_errors proxy-logging cache proxy-server</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/swift-container-server-DEFAULT.xml b/doc/common/tables/swift-container-server-DEFAULT.xml
index 6d380bcab7..8b04919a54 100644
--- a/doc/common/tables/swift-container-server-DEFAULT.xml
+++ b/doc/common/tables/swift-container-server-DEFAULT.xml
@@ -1,51 +1,119 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[DEFAULT]</literal> in <literal>container-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[DEFAULT]</literal> in <literal>container-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>bind_ip = 0.0.0.0</td><td>IP Address for server to bind to</td>
- </tr>
- <tr>
- <td>bind_port = 6001</td><td>Port for server to bind to</td>
- </tr>
- <tr>
- <td>bind_timeout = 30</td><td>Seconds to attempt bind before giving up</td>
- </tr>
- <tr>
- <td>backlog = 4096</td><td>Maximum number of allowed pending TCP connections</td>
- </tr>
- <tr>
- <td>user = swift</td><td>User to run as</td>
- </tr>
- <tr>
- <td>swift_dir = /etc/swift</td><td>Swift configuration directory</td>
- </tr>
- <tr>
- <td>devices = /srv/node</td><td>Parent directory of where devices are mounted</td>
- </tr>
- <tr>
- <td>mount_check = true</td><td>Whether or not check if the devices are mounted to prevent accidentally writing to the root device</td>
- </tr>
- <tr>
- <td>disable_fallocate = false</td><td>Disable "fast fail" fallocate checks if the underlying filesystem does not support it.</td>
- </tr>
- <tr>
- <td>workers = auto</td><td>a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests.</td>
- </tr>
- <tr>
- <td>max_clients = 1024</td><td>Maximum number of clients one worker can process simultaneously
+ <tr>
+ <td>allowed_sync_hosts = 127.0.0.1</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>backlog = 4096</td>
+ <td>Maximum number of allowed pending TCP connections</td>
+ </tr>
+ <tr>
+ <td>bind_ip = 0.0.0.0</td>
+ <td>IP Address for server to bind to</td>
+ </tr>
+ <tr>
+ <td>bind_port = 6001</td>
+ <td>Port for server to bind to</td>
+ </tr>
+ <tr>
+ <td>bind_timeout = 30</td>
+ <td>Seconds to attempt bind before giving up</td>
+ </tr>
+ <tr>
+ <td>db_preallocation = off</td>
+ <td>If you don't mind the extra disk space usage in overhead, you can turn this on to preallocate disk space with SQLite databases to decrease fragmentation. underlying filesystem does not support it. to setup custom log handlers. bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. server. For most cases, this should be `egg:swift#account`. replication passes account can be reclaimed</td>
+ </tr>
+ <tr>
+ <td>devices = /srv/node</td>
+ <td>Parent directory of where devices are mounted</td>
+ </tr>
+ <tr>
+ <td>disable_fallocate = false</td>
+ <td>Disable "fast fail" fallocate checks if the underlying filesystem does not support it.</td>
+ </tr>
+ <tr>
+ <td>eventlet_debug = false</td>
+ <td>If true, turn on debug logging for eventlet</td>
+ </tr>
+ <tr>
+ <td>fallocate_reserve = 0</td>
+ <td>You can set fallocate_reserve to the number of bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. server. For most cases, this should be `egg:swift#object`.</td>
+ </tr>
+ <tr>
+ <td>log_address = /dev/log</td>
+ <td>Location where syslog sends the logs to</td>
+ </tr>
+ <tr>
+ <td>log_custom_handlers = </td>
+ <td>Comma-separated list of functions to call to setup custom log handlers.</td>
+ </tr>
+ <tr>
+ <td>log_facility = LOG_LOCAL0</td>
+ <td>Syslog log facility</td>
+ </tr>
+ <tr>
+ <td>log_level = INFO</td>
+ <td>Logging level</td>
+ </tr>
+ <tr>
+ <td>log_max_line_length = 0</td>
+ <td>Caps the length of log lines to the value given; no limit if set to 0, the default.</td>
+ </tr>
+ <tr>
+ <td>log_name = swift</td>
+ <td>Label used when logging</td>
+ </tr>
+ <tr>
+ <td>log_statsd_default_sample_rate = 1.0</td>
+ <td>Defines the probability of sending a sample for any given event or
+ timing measurement.</td>
+ </tr>
+ <tr>
+ <td>log_statsd_host = localhost</td>
+ <td>If not set, the StatsD feature is disabled.</td>
+ </tr>
+ <tr>
+ <td>log_statsd_metric_prefix = </td>
+ <td>Value will be prepended to every metric sent to the StatsD server.</td>
+ </tr>
+ <tr>
+ <td>log_statsd_port = 8125</td>
+ <td>Port value for the StatsD server.</td>
+ </tr>
+ <tr>
+ <td>log_statsd_sample_rate_factor = 1.0</td>
+ <td>Not recommended to set this to a value less than 1.0, if frequency
+ of logging is too high, tune the
+ log_statsd_default_sample_rate instead.</td>
+ </tr>
+ <tr>
+ <td>log_udp_host = </td>
+ <td>If not set, the UDB receiver for syslog is disabled.</td>
+ </tr>
+ <tr>
+ <td>log_udp_port = 514</td>
+ <td>Port value for UDB receiver, if enabled.</td>
+ </tr>
+ <tr>
+ <td>max_clients = 1024</td>
+ <td>Maximum number of clients one worker can process simultaneously
Lowering the number of clients handled per worker, and raising the
number of workers can lessen the impact that a CPU intensive, or
blocking, request can have on other requests served by the same
@@ -53,58 +121,23 @@ worker. If the maximum number of clients is set to one, then a given worker
will not perform another call while processing, allowing
other workers a chance to process it.
</td>
- </tr>
- <tr>
- <td>allowed_sync_hosts = 127.0.0.1</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>log_name = swift</td><td>Label used when logging</td>
- </tr>
- <tr>
- <td>log_facility = LOG_LOCAL0</td><td>Syslog log facility</td>
- </tr>
- <tr>
- <td>log_level = INFO</td><td>Logging level</td>
- </tr>
- <tr>
- <td>log_address = /dev/log</td><td>Location where syslog sends the logs to</td>
- </tr>
- <tr>
- <td>log_custom_handlers = </td><td>Comma-separated list of functions to call to setup custom log handlers.</td>
- </tr>
- <tr>
- <td>log_udp_host = </td><td>If not set, the UDB receiver for syslog is disabled.</td>
- </tr>
- <tr>
- <td>log_udp_port = 514</td><td>Port value for UDB receiver, if enabled.</td>
- </tr>
- <tr>
- <td>log_statsd_host = localhost</td><td>If not set, the StatsD feature is disabled.</td>
- </tr>
- <tr>
- <td>log_statsd_port = 8125</td><td>Port value for the StatsD server.</td>
- </tr>
- <tr>
- <td>log_statsd_default_sample_rate = 1.0</td><td>Defines the probability of sending a sample for any given event or
- timing measurement.</td>
- </tr>
- <tr>
- <td>log_statsd_sample_rate_factor = 1.0</td><td>Not recommended to set this to a value less than 1.0, if frequency
- of logging is too high, tune the
- log_statsd_default_sample_rate instead.</td>
- </tr>
- <tr>
- <td>log_statsd_metric_prefix = </td><td>Value will be prepended to every metric sent to the StatsD server.</td>
- </tr>
- <tr>
- <td>db_preallocation = off</td><td>If you don't mind the extra disk space usage in overhead, you can turn this on to preallocate disk space with SQLite databases to decrease fragmentation. underlying filesystem does not support it. to setup custom log handlers. bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. server. For most cases, this should be `egg:swift#account`. replication passes account can be reclaimed</td>
- </tr>
- <tr>
- <td>eventlet_debug = false</td><td>If true, turn on debug logging for eventlet</td>
- </tr>
- <tr>
- <td>fallocate_reserve = 0</td><td>You can set fallocate_reserve to the number of bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. server. For most cases, this should be `egg:swift#object`.</td>
- </tr>
+ </tr>
+ <tr>
+ <td>mount_check = true</td>
+ <td>Whether or not check if the devices are mounted to prevent accidentally writing to the root device</td>
+ </tr>
+ <tr>
+ <td>swift_dir = /etc/swift</td>
+ <td>Swift configuration directory</td>
+ </tr>
+ <tr>
+ <td>user = swift</td>
+ <td>User to run as</td>
+ </tr>
+ <tr>
+ <td>workers = auto</td>
+ <td>a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests.</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-container-server-app-container-server.xml b/doc/common/tables/swift-container-server-app-container-server.xml
index 5cdd509c39..3993e0c37d 100644
--- a/doc/common/tables/swift-container-server-app-container-server.xml
+++ b/doc/common/tables/swift-container-server-app-container-server.xml
@@ -1,52 +1,65 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[app:container-server]</literal> in <literal>container-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[app-container-server]</literal> in <literal>container-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>use = egg:swift#container</td><td>Entry point of paste.deploy in the server</td>
- </tr>
- <tr>
- <td>set log_name = container-server</td><td>Label to use when logging</td>
- </tr>
- <tr>
- <td>set log_facility = LOG_LOCAL0</td><td>Syslog log facility</td>
- </tr>
- <tr>
- <td>set log_level = INFO</td><td>Log level</td>
- </tr>
- <tr>
- <td>set log_requests = true</td><td>Whether or not to log requests</td>
- </tr>
- <tr>
- <td>set log_address = /dev/log</td><td>Location where syslog sends the logs to</td>
- </tr>
- <tr>
- <td>node_timeout = 3</td><td>Request timeout to external services</td>
- </tr>
- <tr>
- <td>conn_timeout = 0.5</td><td>Connection timeout to external services</td>
- </tr>
- <tr>
- <td>allow_versions = false</td><td>Enable/Disable object versioning feature</td>
- </tr>
- <tr>
- <td>auto_create_account_prefix = .</td><td>Prefix to use when automatically creating accounts</td>
- </tr>
- <tr>
- <td>replication_server = false</td><td>If defined, tells server how to handle replication verbs in requests. When set to True (or 1), only replication verbs will be accepted. When set to False, replication verbs will be rejected. When undefined, server will accept any verb in the request.</td>
- </tr>
+ <tr>
+ <td>allow_versions = false</td>
+ <td>Enable/Disable object versioning feature</td>
+ </tr>
+ <tr>
+ <td>auto_create_account_prefix = .</td>
+ <td>Prefix to use when automatically creating accounts</td>
+ </tr>
+ <tr>
+ <td>conn_timeout = 0.5</td>
+ <td>Connection timeout to external services</td>
+ </tr>
+ <tr>
+ <td>node_timeout = 3</td>
+ <td>Request timeout to external services</td>
+ </tr>
+ <tr>
+ <td>replication_server = false</td>
+ <td>If defined, tells server how to handle replication verbs in requests. When set to True (or 1), only replication verbs will be accepted. When set to False, replication verbs will be rejected. When undefined, server will accept any verb in the request.</td>
+ </tr>
+ <tr>
+ <td>set log_address = /dev/log</td>
+ <td>Location where syslog sends the logs to</td>
+ </tr>
+ <tr>
+ <td>set log_facility = LOG_LOCAL0</td>
+ <td>Syslog log facility</td>
+ </tr>
+ <tr>
+ <td>set log_level = INFO</td>
+ <td>Log level</td>
+ </tr>
+ <tr>
+ <td>set log_name = container-server</td>
+ <td>Label to use when logging</td>
+ </tr>
+ <tr>
+ <td>set log_requests = true</td>
+ <td>Whether or not to log requests</td>
+ </tr>
+ <tr>
+ <td>use = egg:swift#container</td>
+ <td>Entry point of paste.deploy in the server</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-container-server-container-auditor.xml b/doc/common/tables/swift-container-server-container-auditor.xml
index 4f3b69fd63..e2c2d2ca3f 100644
--- a/doc/common/tables/swift-container-server-container-auditor.xml
+++ b/doc/common/tables/swift-container-server-container-auditor.xml
@@ -1,40 +1,49 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[container-auditor]</literal> in <literal>container-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[container-auditor]</literal> in <literal>container-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>log_name = container-auditor</td><td>Label used when logging</td>
- </tr>
- <tr>
- <td>log_facility = LOG_LOCAL0</td><td>Syslog log facility</td>
- </tr>
- <tr>
- <td>log_level = INFO</td><td>Logging level</td>
- </tr>
- <tr>
- <td>log_address = /dev/log</td><td>Location where syslog sends the logs to</td>
- </tr>
- <tr>
- <td>interval = 1800</td><td>Minimum time for a pass to take</td>
- </tr>
- <tr>
- <td>containers_per_second = 200</td><td>Maximum containers audited per second. Should be tuned according to individual system specs. 0 is unlimited. mounted to prevent accidentally writing to the root device process simultaneously (it will actually accept(2) N + 1). Setting this to one (1) will only handle one request at a time, without accepting another request concurrently. By increasing the number of workers to a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests.</td>
- </tr>
- <tr>
- <td>recon_cache_path = /var/cache/swift</td><td>Directory where stats for a few items will be stored</td>
- </tr>
+ <tr>
+ <td>containers_per_second = 200</td>
+ <td>Maximum containers audited per second. Should be tuned according to individual system specs. 0 is unlimited. mounted to prevent accidentally writing to the root device process simultaneously (it will actually accept(2) N + 1). Setting this to one (1) will only handle one request at a time, without accepting another request concurrently. By increasing the number of workers to a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests.</td>
+ </tr>
+ <tr>
+ <td>interval = 1800</td>
+ <td>Minimum time for a pass to take</td>
+ </tr>
+ <tr>
+ <td>log_address = /dev/log</td>
+ <td>Location where syslog sends the logs to</td>
+ </tr>
+ <tr>
+ <td>log_facility = LOG_LOCAL0</td>
+ <td>Syslog log facility</td>
+ </tr>
+ <tr>
+ <td>log_level = INFO</td>
+ <td>Logging level</td>
+ </tr>
+ <tr>
+ <td>log_name = container-auditor</td>
+ <td>Label used when logging</td>
+ </tr>
+ <tr>
+ <td>recon_cache_path = /var/cache/swift</td>
+ <td>Directory where stats for a few items will be stored</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-container-server-container-replicator.xml b/doc/common/tables/swift-container-server-container-replicator.xml
index f3ffcce529..f832ac19ed 100644
--- a/doc/common/tables/swift-container-server-container-replicator.xml
+++ b/doc/common/tables/swift-container-server-container-replicator.xml
@@ -1,61 +1,77 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[container-replicator]</literal> in <literal>container-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[container-replicator]</literal> in <literal>container-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>log_name = container-replicator</td><td>Label used when logging</td>
- </tr>
- <tr>
- <td>log_facility = LOG_LOCAL0</td><td>Syslog log facility</td>
- </tr>
- <tr>
- <td>log_level = INFO</td><td>Logging level</td>
- </tr>
- <tr>
- <td>log_address = /dev/log</td><td>Location where syslog sends the logs to</td>
- </tr>
- <tr>
- <td>vm_test_mode = no</td><td>Indicates that you are using a VM environment</td>
- </tr>
- <tr>
- <td>per_diff = 1000</td><td>Limit number of items to get per diff</td>
- </tr>
- <tr>
- <td>max_diffs = 100</td><td>Caps how long the replicator spends trying to sync a database per pass</td>
- </tr>
- <tr>
- <td>concurrency = 8</td><td>Number of replication workers to spawn</td>
- </tr>
- <tr>
- <td>interval = 30</td><td>Minimum time for a pass to take</td>
- </tr>
- <tr>
- <td>node_timeout = 10</td><td>Request timeout to external services</td>
- </tr>
- <tr>
- <td>conn_timeout = 0.5</td><td>Connection timeout to external services</td>
- </tr>
- <tr>
- <td>reclaim_age = 604800</td><td>Time elapsed in seconds before an object can be reclaimed</td>
- </tr>
- <tr>
- <td>run_pause = 30</td><td>Time in seconds to wait between replication passes</td>
- </tr>
- <tr>
- <td>recon_cache_path = /var/cache/swift</td><td>Directory where stats for a few items will be stored</td>
- </tr>
+ <tr>
+ <td>concurrency = 8</td>
+ <td>Number of replication workers to spawn</td>
+ </tr>
+ <tr>
+ <td>conn_timeout = 0.5</td>
+ <td>Connection timeout to external services</td>
+ </tr>
+ <tr>
+ <td>interval = 30</td>
+ <td>Minimum time for a pass to take</td>
+ </tr>
+ <tr>
+ <td>log_address = /dev/log</td>
+ <td>Location where syslog sends the logs to</td>
+ </tr>
+ <tr>
+ <td>log_facility = LOG_LOCAL0</td>
+ <td>Syslog log facility</td>
+ </tr>
+ <tr>
+ <td>log_level = INFO</td>
+ <td>Logging level</td>
+ </tr>
+ <tr>
+ <td>log_name = container-replicator</td>
+ <td>Label used when logging</td>
+ </tr>
+ <tr>
+ <td>max_diffs = 100</td>
+ <td>Caps how long the replicator spends trying to sync a database per pass</td>
+ </tr>
+ <tr>
+ <td>node_timeout = 10</td>
+ <td>Request timeout to external services</td>
+ </tr>
+ <tr>
+ <td>per_diff = 1000</td>
+ <td>Limit number of items to get per diff</td>
+ </tr>
+ <tr>
+ <td>reclaim_age = 604800</td>
+ <td>Time elapsed in seconds before an object can be reclaimed</td>
+ </tr>
+ <tr>
+ <td>recon_cache_path = /var/cache/swift</td>
+ <td>Directory where stats for a few items will be stored</td>
+ </tr>
+ <tr>
+ <td>run_pause = 30</td>
+ <td>Time in seconds to wait between replication passes</td>
+ </tr>
+ <tr>
+ <td>vm_test_mode = no</td>
+ <td>Indicates that you are using a VM environment</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-container-server-container-sync.xml b/doc/common/tables/swift-container-server-container-sync.xml
index f5bac3e056..460337e7d4 100644
--- a/doc/common/tables/swift-container-server-container-sync.xml
+++ b/doc/common/tables/swift-container-server-container-sync.xml
@@ -1,40 +1,49 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[container-sync]</literal> in <literal>container-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[container-sync]</literal> in <literal>container-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>log_name = container-sync</td><td>Label used when logging</td>
- </tr>
- <tr>
- <td>log_facility = LOG_LOCAL0</td><td>Syslog log facility</td>
- </tr>
- <tr>
- <td>log_level = INFO</td><td>Logging level</td>
- </tr>
- <tr>
- <td>log_address = /dev/log</td><td>Location where syslog sends the logs to</td>
- </tr>
- <tr>
- <td>sync_proxy = http://10.1.1.1:8888,http://10.1.1.2:8888</td><td>If you need to use an HTTP proxy, set it here. Defaults to no proxy.</td>
- </tr>
- <tr>
- <td>interval = 300</td><td>Minimum time for a pass to take</td>
- </tr>
- <tr>
- <td>container_time = 60</td><td>Maximum amount of time to spend syncing each container</td>
- </tr>
+ <tr>
+ <td>container_time = 60</td>
+ <td>Maximum amount of time to spend syncing each container</td>
+ </tr>
+ <tr>
+ <td>interval = 300</td>
+ <td>Minimum time for a pass to take</td>
+ </tr>
+ <tr>
+ <td>log_address = /dev/log</td>
+ <td>Location where syslog sends the logs to</td>
+ </tr>
+ <tr>
+ <td>log_facility = LOG_LOCAL0</td>
+ <td>Syslog log facility</td>
+ </tr>
+ <tr>
+ <td>log_level = INFO</td>
+ <td>Logging level</td>
+ </tr>
+ <tr>
+ <td>log_name = container-sync</td>
+ <td>Label used when logging</td>
+ </tr>
+ <tr>
+ <td>sync_proxy = http://10.1.1.1:8888,http://10.1.1.2:8888</td>
+ <td>If you need to use an HTTP proxy, set it here. Defaults to no proxy.</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-container-server-container-updater.xml b/doc/common/tables/swift-container-server-container-updater.xml
index 4ef01b3018..75b58870ad 100644
--- a/doc/common/tables/swift-container-server-container-updater.xml
+++ b/doc/common/tables/swift-container-server-container-updater.xml
@@ -1,53 +1,66 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[container-updater]</literal> in <literal>container-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[container-updater]</literal> in <literal>container-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>log_name = container-updater</td><td>Label used when logging</td>
- </tr>
- <tr>
- <td>log_facility = LOG_LOCAL0</td><td>Syslog log facility</td>
- </tr>
- <tr>
- <td>log_level = INFO</td><td>Logging level</td>
- </tr>
- <tr>
- <td>log_address = /dev/log</td><td>Location where syslog sends the logs to</td>
- </tr>
- <tr>
- <td>interval = 300</td><td>Minimum time for a pass to take</td>
- </tr>
- <tr>
- <td>concurrency = 4</td><td>Number of replication workers to spawn</td>
- </tr>
- <tr>
- <td>node_timeout = 3</td><td>Request timeout to external services</td>
- </tr>
- <tr>
- <td>conn_timeout = 0.5</td><td>Connection timeout to external services</td>
- </tr>
- <tr>
- <td>slowdown = 0.01</td><td>Time in seconds to wait between objects</td>
- </tr>
- <tr>
- <td>account_suppression_time = 60</td><td>Seconds to suppress updating an account that has generated an
+ <tr>
+ <td>account_suppression_time = 60</td>
+ <td>Seconds to suppress updating an account that has generated an
error (timeout, not yet found, etc.)</td>
- </tr>
- <tr>
- <td>recon_cache_path = /var/cache/swift</td><td>Directory where stats for a few items will be stored</td>
- </tr>
+ </tr>
+ <tr>
+ <td>concurrency = 4</td>
+ <td>Number of replication workers to spawn</td>
+ </tr>
+ <tr>
+ <td>conn_timeout = 0.5</td>
+ <td>Connection timeout to external services</td>
+ </tr>
+ <tr>
+ <td>interval = 300</td>
+ <td>Minimum time for a pass to take</td>
+ </tr>
+ <tr>
+ <td>log_address = /dev/log</td>
+ <td>Location where syslog sends the logs to</td>
+ </tr>
+ <tr>
+ <td>log_facility = LOG_LOCAL0</td>
+ <td>Syslog log facility</td>
+ </tr>
+ <tr>
+ <td>log_level = INFO</td>
+ <td>Logging level</td>
+ </tr>
+ <tr>
+ <td>log_name = container-updater</td>
+ <td>Label used when logging</td>
+ </tr>
+ <tr>
+ <td>node_timeout = 3</td>
+ <td>Request timeout to external services</td>
+ </tr>
+ <tr>
+ <td>recon_cache_path = /var/cache/swift</td>
+ <td>Directory where stats for a few items will be stored</td>
+ </tr>
+ <tr>
+ <td>slowdown = 0.01</td>
+ <td>Time in seconds to wait between objects</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-container-server-filter-healthcheck.xml b/doc/common/tables/swift-container-server-filter-healthcheck.xml
index eb62d5a51d..e8b81d2b11 100644
--- a/doc/common/tables/swift-container-server-filter-healthcheck.xml
+++ b/doc/common/tables/swift-container-server-filter-healthcheck.xml
@@ -1,25 +1,29 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[filter:healthcheck]</literal> in <literal>container-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[filter-healthcheck]</literal> in <literal>container-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>use = egg:swift#healthcheck</td><td>Entry point of paste.deploy in the server</td>
- </tr>
- <tr>
- <td>disable_path = </td><td>No help text available for this option.</td>
- </tr>
+ <tr>
+ <td>disable_path = </td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>use = egg:swift#healthcheck</td>
+ <td>Entry point of paste.deploy in the server</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-container-server-filter-recon.xml b/doc/common/tables/swift-container-server-filter-recon.xml
index 7e3a1a6390..ba0a5a2182 100644
--- a/doc/common/tables/swift-container-server-filter-recon.xml
+++ b/doc/common/tables/swift-container-server-filter-recon.xml
@@ -1,25 +1,29 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[filter:recon]</literal> in <literal>container-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[filter-recon]</literal> in <literal>container-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>use = egg:swift#recon</td><td>Entry point of paste.deploy in the server</td>
- </tr>
- <tr>
- <td>recon_cache_path = /var/cache/swift</td><td>Directory where stats for a few items will be stored</td>
- </tr>
+ <tr>
+ <td>recon_cache_path = /var/cache/swift</td>
+ <td>Directory where stats for a few items will be stored</td>
+ </tr>
+ <tr>
+ <td>use = egg:swift#recon</td>
+ <td>Entry point of paste.deploy in the server</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-container-server-filter-xprofile.xml b/doc/common/tables/swift-container-server-filter-xprofile.xml
new file mode 100644
index 0000000000..3cf2c5cf92
--- /dev/null
+++ b/doc/common/tables/swift-container-server-filter-xprofile.xml
@@ -0,0 +1,53 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[filter-xprofile]</literal> in <literal>container-server.conf</literal>
+ </caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>dump_interval = 5.0</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>dump_timestamp = false</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>flush_at_shutdown = false</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>log_filename_prefix = /tmp/log/swift/profile/default.profile</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>path = /__profile__</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>profile_module = eventlet.green.profile</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>unwind = false</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>use = egg:swift#xprofile</td>
+ <td>Entry point of paste.deploy in the server</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/swift-container-server-pipeline-main.xml b/doc/common/tables/swift-container-server-pipeline-main.xml
index 5cf1dc2ecd..318229a7cb 100644
--- a/doc/common/tables/swift-container-server-pipeline-main.xml
+++ b/doc/common/tables/swift-container-server-pipeline-main.xml
@@ -1,22 +1,25 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[pipeline:main]</literal> in <literal>container-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[pipeline-main]</literal> in <literal>container-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>pipeline = healthcheck recon container-server</td><td>No help text available for this option.</td>
- </tr>
+ <tr>
+ <td>pipeline = healthcheck recon container-server</td>
+ <td>No help text available for this option.</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-container-sync-realms-DEFAULT.xml b/doc/common/tables/swift-container-sync-realms-DEFAULT.xml
index cf0d9d6dce..f48ca084c2 100644
--- a/doc/common/tables/swift-container-sync-realms-DEFAULT.xml
+++ b/doc/common/tables/swift-container-sync-realms-DEFAULT.xml
@@ -1,22 +1,25 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[DEFAULT]</literal> in <literal>container-sync-realms.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[DEFAULT]</literal> in <literal>container-sync-realms.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>mtime_check_interval = 300</td><td>No help text available for this option.</td>
- </tr>
+ <tr>
+ <td>mtime_check_interval = 300</td>
+ <td>No help text available for this option.</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-container-sync-realms-realm1.xml b/doc/common/tables/swift-container-sync-realms-realm1.xml
index 8ee5a3aede..94db9c0bcc 100644
--- a/doc/common/tables/swift-container-sync-realms-realm1.xml
+++ b/doc/common/tables/swift-container-sync-realms-realm1.xml
@@ -1,31 +1,37 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[realm1]</literal> in <literal>container-sync-realms.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[realm1]</literal> in <literal>container-sync-realms.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>key = realm1key</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>key2 = realm1key2</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>cluster_name1 = https://host1/v1/</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>cluster_name2 = https://host2/v1/</td><td>No help text available for this option.</td>
- </tr>
+ <tr>
+ <td>cluster_name1 = https://host1/v1/</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>cluster_name2 = https://host2/v1/</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>key = realm1key</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>key2 = realm1key2</td>
+ <td>No help text available for this option.</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-container-sync-realms-realm2.xml b/doc/common/tables/swift-container-sync-realms-realm2.xml
index 22c583fe25..cab87db254 100644
--- a/doc/common/tables/swift-container-sync-realms-realm2.xml
+++ b/doc/common/tables/swift-container-sync-realms-realm2.xml
@@ -1,31 +1,37 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[realm2]</literal> in <literal>container-sync-realms.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[realm2]</literal> in <literal>container-sync-realms.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>key = realm2key</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>key2 = realm2key2</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>cluster_name3 = https://host3/v1/</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>cluster_name4 = https://host4/v1/</td><td>No help text available for this option.</td>
- </tr>
+ <tr>
+ <td>cluster_name3 = https://host3/v1/</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>cluster_name4 = https://host4/v1/</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>key = realm2key</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>key2 = realm2key2</td>
+ <td>No help text available for this option.</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-dispersion-dispersion.xml b/doc/common/tables/swift-dispersion-dispersion.xml
index 9fca47d431..6e6d537cd8 100644
--- a/doc/common/tables/swift-dispersion-dispersion.xml
+++ b/doc/common/tables/swift-dispersion-dispersion.xml
@@ -1,73 +1,81 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[dispersion]</literal> in <literal>dispersion.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[dispersion]</literal> in <literal>dispersion.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>auth_url = http://localhost:8080/auth/v1.0</td><td>Endpoint for auth server, such as keystone</td>
- </tr>
- <tr>
- <td>auth_user = test:tester</td><td>Default user for dispersion in this context</td>
- </tr>
- <tr>
- <td>auth_key = testing</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>auth_url = http://localhost:5000/v2.0/</td><td>Endpoint for auth server, such as keystone</td>
- </tr>
- <tr>
- <td>auth_user = tenant:user</td><td>Default user for dispersion in this context</td>
- </tr>
- <tr>
- <td>auth_key = password</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>auth_version = 2.0</td><td>Indicates which version of auth</td>
- </tr>
- <tr>
- <td>endpoint_type = publicURL</td><td>Indicates whether endpoint for auth is public or internal</td>
- </tr>
- <tr>
- <td>keystone_api_insecure = no</td><td>Allow accessing insecure keystone server. The keystone's certificate will not be verified.</td>
- </tr>
- <tr>
- <td>swift_dir = /etc/swift</td><td>Swift configuration directory</td>
- </tr>
- <tr>
- <td>dispersion_coverage = 1.0</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>retries = 5</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>concurrency = 25</td><td>Number of replication workers to spawn</td>
- </tr>
- <tr>
- <td>container_populate = yes</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>object_populate = yes</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>container_report = yes</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>object_report = yes</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>dump_json = no</td><td>No help text available for this option.</td>
- </tr>
+ <tr>
+ <td>auth_key = testing</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>auth_url = http://localhost:8080/auth/v1.0</td>
+ <td>Endpoint for auth server, such as keystone</td>
+ </tr>
+ <tr>
+ <td>auth_user = test:tester</td>
+ <td>Default user for dispersion in this context</td>
+ </tr>
+ <tr>
+ <td>auth_version = 2.0</td>
+ <td>Indicates which version of auth</td>
+ </tr>
+ <tr>
+ <td>concurrency = 25</td>
+ <td>Number of replication workers to spawn</td>
+ </tr>
+ <tr>
+ <td>container_populate = yes</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>container_report = yes</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>dispersion_coverage = 1.0</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>dump_json = no</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>endpoint_type = publicURL</td>
+ <td>Indicates whether endpoint for auth is public or internal</td>
+ </tr>
+ <tr>
+ <td>keystone_api_insecure = no</td>
+ <td>Allow accessing insecure keystone server. The keystone's certificate will not be verified.</td>
+ </tr>
+ <tr>
+ <td>object_populate = yes</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>object_report = yes</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>retries = 5</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>swift_dir = /etc/swift</td>
+ <td>Swift configuration directory</td>
+ </tr>
</tbody>
- </table>
- </para>
+ </table>
+</para>
diff --git a/doc/common/tables/swift-drive-audit-drive-audit.xml b/doc/common/tables/swift-drive-audit-drive-audit.xml
index 6688e956b7..9849bc59f2 100644
--- a/doc/common/tables/swift-drive-audit-drive-audit.xml
+++ b/doc/common/tables/swift-drive-audit-drive-audit.xml
@@ -1,43 +1,57 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[drive-audit]</literal> in <literal>drive-audit.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[drive-audit]</literal> in <literal>drive-audit.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>device_dir = /srv/node</td><td>Directory devices are mounted under</td>
- </tr>
- <tr>
- <td>log_facility = LOG_LOCAL0</td><td>Syslog log facility</td>
- </tr>
- <tr>
- <td>log_level = INFO</td><td>Logging level</td>
- </tr>
- <tr>
- <td>log_address = /dev/log</td><td>Location where syslog sends the logs to</td>
- </tr>
- <tr>
- <td>minutes = 60</td><td>Number of minutes to look back in `/var/log/kern.log`</td>
- </tr>
- <tr>
- <td>error_limit = 1</td><td>Number of errors to find before a device is unmounted</td>
- </tr>
- <tr>
- <td>log_file_pattern = /var/log/kern*</td><td>Location of the log file with globbing pattern to check against device errors locate device blocks with errors in the log file</td>
- </tr>
- <tr>
- <td>regex_pattern_1 = \berror\b.*\b(dm-[0-9]{1,2}\d?)\b</td><td>No help text available for this option.</td>
- </tr>
+ <tr>
+ <td>device_dir = /srv/node</td>
+ <td>Directory devices are mounted under</td>
+ </tr>
+ <tr>
+ <td>error_limit = 1</td>
+ <td>Number of errors to find before a device is unmounted</td>
+ </tr>
+ <tr>
+ <td>log_address = /dev/log</td>
+ <td>Location where syslog sends the logs to</td>
+ </tr>
+ <tr>
+ <td>log_facility = LOG_LOCAL0</td>
+ <td>Syslog log facility</td>
+ </tr>
+ <tr>
+ <td>log_file_pattern = /var/log/kern*</td>
+ <td>Location of the log file with globbing pattern to check against device errors locate device blocks with errors in the log file</td>
+ </tr>
+ <tr>
+ <td>log_level = INFO</td>
+ <td>Logging level</td>
+ </tr>
+ <tr>
+ <td>log_max_line_length = 0</td>
+ <td>Caps the length of log lines to the value given; no limit if set to 0, the default.</td>
+ </tr>
+ <tr>
+ <td>minutes = 60</td>
+ <td>Number of minutes to look back in `/var/log/kern.log`</td>
+ </tr>
+ <tr>
+ <td>regex_pattern_1 = \berror\b.*\b(dm-[0-9]{1,2}\d?)\b</td>
+ <td>No help text available for this option.</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-memcache-memcache.xml b/doc/common/tables/swift-memcache-memcache.xml
index ea3eed5fb1..05416a08d3 100644
--- a/doc/common/tables/swift-memcache-memcache.xml
+++ b/doc/common/tables/swift-memcache-memcache.xml
@@ -1,28 +1,33 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[memcache]</literal> in <literal>memcache.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[memcache]</literal> in <literal>memcache.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>memcache_servers = 127.0.0.1:11211</td><td>Comma separated list of memcached servers ip:port services</td>
- </tr>
- <tr>
- <td>memcache_serialization_support = 2</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>memcache_max_connections = 2</td><td>Max number of connections to each memcached server per worker services</td>
- </tr>
+ <tr>
+ <td>memcache_max_connections = 2</td>
+ <td>Max number of connections to each memcached server per worker services</td>
+ </tr>
+ <tr>
+ <td>memcache_serialization_support = 2</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>memcache_servers = 127.0.0.1:11211</td>
+ <td>Comma separated list of memcached servers ip:port services</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-object-expirer-DEFAULT.xml b/doc/common/tables/swift-object-expirer-DEFAULT.xml
index f62dcda176..336eea70c7 100644
--- a/doc/common/tables/swift-object-expirer-DEFAULT.xml
+++ b/doc/common/tables/swift-object-expirer-DEFAULT.xml
@@ -1,64 +1,84 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[DEFAULT]</literal> in <literal>object-expirer.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[DEFAULT]</literal> in <literal>object-expirer.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>swift_dir = /etc/swift</td><td>Swift configuration directory</td>
- </tr>
- <tr>
- <td>user = swift</td><td>User to run as</td>
- </tr>
- <tr>
- <td>log_name = swift</td><td>Label used when logging</td>
- </tr>
- <tr>
- <td>log_facility = LOG_LOCAL0</td><td>Syslog log facility</td>
- </tr>
- <tr>
- <td>log_level = INFO</td><td>Logging level</td>
- </tr>
- <tr>
- <td>log_address = /dev/log</td><td>Location where syslog sends the logs to</td>
- </tr>
- <tr>
- <td>log_custom_handlers = </td><td>Comma-separated list of functions to call to setup custom log handlers.</td>
- </tr>
- <tr>
- <td>log_udp_host = </td><td>If not set, the UDB receiver for syslog is disabled.</td>
- </tr>
- <tr>
- <td>log_udp_port = 514</td><td>Port value for UDB receiver, if enabled.</td>
- </tr>
- <tr>
- <td>log_statsd_host = localhost</td><td>If not set, the StatsD feature is disabled.</td>
- </tr>
- <tr>
- <td>log_statsd_port = 8125</td><td>Port value for the StatsD server.</td>
- </tr>
- <tr>
- <td>log_statsd_default_sample_rate = 1.0</td><td>Defines the probability of sending a sample for any given event or
+ <tr>
+ <td>log_address = /dev/log</td>
+ <td>Location where syslog sends the logs to</td>
+ </tr>
+ <tr>
+ <td>log_custom_handlers = </td>
+ <td>Comma-separated list of functions to call to setup custom log handlers.</td>
+ </tr>
+ <tr>
+ <td>log_facility = LOG_LOCAL0</td>
+ <td>Syslog log facility</td>
+ </tr>
+ <tr>
+ <td>log_level = INFO</td>
+ <td>Logging level</td>
+ </tr>
+ <tr>
+ <td>log_max_line_length = 0</td>
+ <td>Caps the length of log lines to the value given; no limit if set to 0, the default.</td>
+ </tr>
+ <tr>
+ <td>log_name = swift</td>
+ <td>Label used when logging</td>
+ </tr>
+ <tr>
+ <td>log_statsd_default_sample_rate = 1.0</td>
+ <td>Defines the probability of sending a sample for any given event or
timing measurement.</td>
- </tr>
- <tr>
- <td>log_statsd_sample_rate_factor = 1.0</td><td>Not recommended to set this to a value less than 1.0, if frequency
+ </tr>
+ <tr>
+ <td>log_statsd_host = localhost</td>
+ <td>If not set, the StatsD feature is disabled.</td>
+ </tr>
+ <tr>
+ <td>log_statsd_metric_prefix = </td>
+ <td>Value will be prepended to every metric sent to the StatsD server.</td>
+ </tr>
+ <tr>
+ <td>log_statsd_port = 8125</td>
+ <td>Port value for the StatsD server.</td>
+ </tr>
+ <tr>
+ <td>log_statsd_sample_rate_factor = 1.0</td>
+ <td>Not recommended to set this to a value less than 1.0, if frequency
of logging is too high, tune the
log_statsd_default_sample_rate instead.</td>
- </tr>
- <tr>
- <td>log_statsd_metric_prefix = </td><td>Value will be prepended to every metric sent to the StatsD server.</td>
- </tr>
+ </tr>
+ <tr>
+ <td>log_udp_host = </td>
+ <td>If not set, the UDB receiver for syslog is disabled.</td>
+ </tr>
+ <tr>
+ <td>log_udp_port = 514</td>
+ <td>Port value for UDB receiver, if enabled.</td>
+ </tr>
+ <tr>
+ <td>swift_dir = /etc/swift</td>
+ <td>Swift configuration directory</td>
+ </tr>
+ <tr>
+ <td>user = swift</td>
+ <td>User to run as</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-object-expirer-app-proxy-server.xml b/doc/common/tables/swift-object-expirer-app-proxy-server.xml
index 8a4e9035e5..893a127f85 100644
--- a/doc/common/tables/swift-object-expirer-app-proxy-server.xml
+++ b/doc/common/tables/swift-object-expirer-app-proxy-server.xml
@@ -1,22 +1,25 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[app:proxy-server]</literal> in <literal>object-expirer.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[app-proxy-server]</literal> in <literal>object-expirer.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>use = egg:swift#proxy</td><td>Entry point of paste.deploy in the server</td>
- </tr>
+ <tr>
+ <td>use = egg:swift#proxy</td>
+ <td>Entry point of paste.deploy in the server</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-object-expirer-filter-cache.xml b/doc/common/tables/swift-object-expirer-filter-cache.xml
index b41053f4b2..3143c46ed4 100644
--- a/doc/common/tables/swift-object-expirer-filter-cache.xml
+++ b/doc/common/tables/swift-object-expirer-filter-cache.xml
@@ -1,22 +1,25 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[filter:cache]</literal> in <literal>object-expirer.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[filter-cache]</literal> in <literal>object-expirer.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>use = egg:swift#memcache</td><td>Entry point of paste.deploy in the server</td>
- </tr>
+ <tr>
+ <td>use = egg:swift#memcache</td>
+ <td>Entry point of paste.deploy in the server</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-object-expirer-filter-catch_errors.xml b/doc/common/tables/swift-object-expirer-filter-catch_errors.xml
index 906492016d..f2d6f1e53d 100644
--- a/doc/common/tables/swift-object-expirer-filter-catch_errors.xml
+++ b/doc/common/tables/swift-object-expirer-filter-catch_errors.xml
@@ -1,22 +1,25 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[filter:catch_errors]</literal> in <literal>object-expirer.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[filter-catch_errors]</literal> in <literal>object-expirer.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>use = egg:swift#catch_errors</td><td>Entry point of paste.deploy in the server</td>
- </tr>
+ <tr>
+ <td>use = egg:swift#catch_errors</td>
+ <td>Entry point of paste.deploy in the server</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-object-expirer-object-expirer.xml b/doc/common/tables/swift-object-expirer-object-expirer.xml
index 23b5319ff3..0079dc2d5f 100644
--- a/doc/common/tables/swift-object-expirer-object-expirer.xml
+++ b/doc/common/tables/swift-object-expirer-object-expirer.xml
@@ -1,42 +1,55 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[object-expirer]</literal> in <literal>object-expirer.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[object-expirer]</literal> in <literal>object-expirer.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>interval = 300</td><td>Minimum time for a pass to take</td>
- </tr>
- <tr>
- <td>auto_create_account_prefix = .</td><td>Prefix to use when automatically creating accounts</td>
- </tr>
- <tr>
- <td>expiring_objects_account_name = expiring_objects</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>report_interval = 300</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>concurrency = 1</td><td>Number of replication workers to spawn</td>
- </tr>
- <tr>
- <td>processes = 0</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>process = 0</td><td>(it will actually accept(2) N + 1). Setting this to one (1) will
+ <tr>
+ <td>auto_create_account_prefix = .</td>
+ <td>Prefix to use when automatically creating accounts</td>
+ </tr>
+ <tr>
+ <td>concurrency = 1</td>
+ <td>Number of replication workers to spawn</td>
+ </tr>
+ <tr>
+ <td>expiring_objects_account_name = expiring_objects</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>interval = 300</td>
+ <td>Minimum time for a pass to take</td>
+ </tr>
+ <tr>
+ <td>process = 0</td>
+ <td>(it will actually accept(2) N + 1). Setting this to one (1) will
only handle one request at a time, without
accepting another request concurrently.</td>
- </tr>
+ </tr>
+ <tr>
+ <td>processes = 0</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>reclaim_age = 604800</td>
+ <td>Time elapsed in seconds before an object can be reclaimed</td>
+ </tr>
+ <tr>
+ <td>report_interval = 300</td>
+ <td>No help text available for this option.</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-object-expirer-pipeline-main.xml b/doc/common/tables/swift-object-expirer-pipeline-main.xml
index e9c17c4da9..f7051f5fd9 100644
--- a/doc/common/tables/swift-object-expirer-pipeline-main.xml
+++ b/doc/common/tables/swift-object-expirer-pipeline-main.xml
@@ -1,22 +1,25 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[pipeline:main]</literal> in <literal>object-expirer.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[pipeline-main]</literal> in <literal>object-expirer.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>pipeline = catch_errors cache proxy-server</td><td>No help text available for this option.</td>
- </tr>
+ <tr>
+ <td>pipeline = catch_errors cache proxy-server</td>
+ <td>No help text available for this option.</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-object-server-DEFAULT.xml b/doc/common/tables/swift-object-server-DEFAULT.xml
index 2a46729763..ced8a98787 100644
--- a/doc/common/tables/swift-object-server-DEFAULT.xml
+++ b/doc/common/tables/swift-object-server-DEFAULT.xml
@@ -1,57 +1,131 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[DEFAULT]</literal> in <literal>object-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[DEFAULT]</literal> in <literal>object-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>bind_ip = 0.0.0.0</td><td>IP Address for server to bind to</td>
- </tr>
- <tr>
- <td>bind_port = 6000</td><td>Port for server to bind to</td>
- </tr>
- <tr>
- <td>bind_timeout = 30</td><td>Seconds to attempt bind before giving up</td>
- </tr>
- <tr>
- <td>backlog = 4096</td><td>Maximum number of allowed pending TCP connections</td>
- </tr>
- <tr>
- <td>user = swift</td><td>User to run as</td>
- </tr>
- <tr>
- <td>swift_dir = /etc/swift</td><td>Swift configuration directory</td>
- </tr>
- <tr>
- <td>devices = /srv/node</td><td>Parent directory of where devices are mounted</td>
- </tr>
- <tr>
- <td>mount_check = true</td><td>Whether or not check if the devices are mounted to prevent accidentally writing to the root device</td>
- </tr>
- <tr>
- <td>disable_fallocate = false</td><td>Disable "fast fail" fallocate checks if the underlying filesystem does not support it.</td>
- </tr>
- <tr>
- <td>expiring_objects_container_divisor = 86400</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>expiring_objects_account_name = expiring_objects</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>workers = auto</td><td>a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests.</td>
- </tr>
- <tr>
- <td>max_clients = 1024</td><td>Maximum number of clients one worker can process simultaneously
+ <tr>
+ <td>backlog = 4096</td>
+ <td>Maximum number of allowed pending TCP connections</td>
+ </tr>
+ <tr>
+ <td>bind_ip = 0.0.0.0</td>
+ <td>IP Address for server to bind to</td>
+ </tr>
+ <tr>
+ <td>bind_port = 6000</td>
+ <td>Port for server to bind to</td>
+ </tr>
+ <tr>
+ <td>bind_timeout = 30</td>
+ <td>Seconds to attempt bind before giving up</td>
+ </tr>
+ <tr>
+ <td>client_timeout = 60</td>
+ <td>Timeout to read one chunk from a client external services</td>
+ </tr>
+ <tr>
+ <td>conn_timeout = 0.5</td>
+ <td>Connection timeout to external services</td>
+ </tr>
+ <tr>
+ <td>devices = /srv/node</td>
+ <td>Parent directory of where devices are mounted</td>
+ </tr>
+ <tr>
+ <td>disable_fallocate = false</td>
+ <td>Disable "fast fail" fallocate checks if the underlying filesystem does not support it.</td>
+ </tr>
+ <tr>
+ <td>disk_chunk_size = 65536</td>
+ <td>Size of chunks to read/write to disk</td>
+ </tr>
+ <tr>
+ <td>eventlet_debug = false</td>
+ <td>If true, turn on debug logging for eventlet</td>
+ </tr>
+ <tr>
+ <td>expiring_objects_account_name = expiring_objects</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>expiring_objects_container_divisor = 86400</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>fallocate_reserve = 0</td>
+ <td>You can set fallocate_reserve to the number of bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. server. For most cases, this should be `egg:swift#object`.</td>
+ </tr>
+ <tr>
+ <td>log_address = /dev/log</td>
+ <td>Location where syslog sends the logs to</td>
+ </tr>
+ <tr>
+ <td>log_custom_handlers = </td>
+ <td>Comma-separated list of functions to call to setup custom log handlers.</td>
+ </tr>
+ <tr>
+ <td>log_facility = LOG_LOCAL0</td>
+ <td>Syslog log facility</td>
+ </tr>
+ <tr>
+ <td>log_level = INFO</td>
+ <td>Logging level</td>
+ </tr>
+ <tr>
+ <td>log_max_line_length = 0</td>
+ <td>Caps the length of log lines to the value given; no limit if set to 0, the default.</td>
+ </tr>
+ <tr>
+ <td>log_name = swift</td>
+ <td>Label used when logging</td>
+ </tr>
+ <tr>
+ <td>log_statsd_default_sample_rate = 1.0</td>
+ <td>Defines the probability of sending a sample for any given event or
+ timing measurement.</td>
+ </tr>
+ <tr>
+ <td>log_statsd_host = localhost</td>
+ <td>If not set, the StatsD feature is disabled.</td>
+ </tr>
+ <tr>
+ <td>log_statsd_metric_prefix = </td>
+ <td>Value will be prepended to every metric sent to the StatsD server.</td>
+ </tr>
+ <tr>
+ <td>log_statsd_port = 8125</td>
+ <td>Port value for the StatsD server.</td>
+ </tr>
+ <tr>
+ <td>log_statsd_sample_rate_factor = 1.0</td>
+ <td>Not recommended to set this to a value less than 1.0, if frequency
+ of logging is too high, tune the
+ log_statsd_default_sample_rate instead.</td>
+ </tr>
+ <tr>
+ <td>log_udp_host = </td>
+ <td>If not set, the UDB receiver for syslog is disabled.</td>
+ </tr>
+ <tr>
+ <td>log_udp_port = 514</td>
+ <td>Port value for UDB receiver, if enabled.</td>
+ </tr>
+ <tr>
+ <td>max_clients = 1024</td>
+ <td>Maximum number of clients one worker can process simultaneously
Lowering the number of clients handled per worker, and raising the
number of workers can lessen the impact that a CPU intensive, or
blocking, request can have on other requests served by the same
@@ -59,67 +133,31 @@ worker. If the maximum number of clients is set to one, then a given worker
will not perform another call while processing, allowing
other workers a chance to process it.
</td>
- </tr>
- <tr>
- <td>log_name = swift</td><td>Label used when logging</td>
- </tr>
- <tr>
- <td>log_facility = LOG_LOCAL0</td><td>Syslog log facility</td>
- </tr>
- <tr>
- <td>log_level = INFO</td><td>Logging level</td>
- </tr>
- <tr>
- <td>log_address = /dev/log</td><td>Location where syslog sends the logs to</td>
- </tr>
- <tr>
- <td>log_custom_handlers = </td><td>Comma-separated list of functions to call to setup custom log handlers.</td>
- </tr>
- <tr>
- <td>log_udp_host = </td><td>If not set, the UDB receiver for syslog is disabled.</td>
- </tr>
- <tr>
- <td>log_udp_port = 514</td><td>Port value for UDB receiver, if enabled.</td>
- </tr>
- <tr>
- <td>log_statsd_host = localhost</td><td>If not set, the StatsD feature is disabled.</td>
- </tr>
- <tr>
- <td>log_statsd_port = 8125</td><td>Port value for the StatsD server.</td>
- </tr>
- <tr>
- <td>log_statsd_default_sample_rate = 1.0</td><td>Defines the probability of sending a sample for any given event or
- timing measurement.</td>
- </tr>
- <tr>
- <td>log_statsd_sample_rate_factor = 1.0</td><td>Not recommended to set this to a value less than 1.0, if frequency
- of logging is too high, tune the
- log_statsd_default_sample_rate instead.</td>
- </tr>
- <tr>
- <td>log_statsd_metric_prefix = </td><td>Value will be prepended to every metric sent to the StatsD server.</td>
- </tr>
- <tr>
- <td>eventlet_debug = false</td><td>If true, turn on debug logging for eventlet</td>
- </tr>
- <tr>
- <td>fallocate_reserve = 0</td><td>You can set fallocate_reserve to the number of bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. server. For most cases, this should be `egg:swift#object`.</td>
- </tr>
- <tr>
- <td>conn_timeout = 0.5</td><td>Connection timeout to external services</td>
- </tr>
- <tr>
- <td>node_timeout = 3</td><td>Request timeout to external services</td>
- </tr>
- <tr>
- <td>client_timeout = 60</td><td>Timeout to read one chunk from a client external services</td>
- </tr>
- <tr>
- <td>network_chunk_size = 65536</td><td>Size of chunks to read/write over the network</td>
- </tr>
- <tr>
- <td>disk_chunk_size = 65536</td><td>Size of chunks to read/write to disk</td>
- </tr>
+ </tr>
+ <tr>
+ <td>mount_check = true</td>
+ <td>Whether or not check if the devices are mounted to prevent accidentally writing to the root device</td>
+ </tr>
+ <tr>
+ <td>network_chunk_size = 65536</td>
+ <td>Size of chunks to read/write over the network</td>
+ </tr>
+ <tr>
+ <td>node_timeout = 3</td>
+ <td>Request timeout to external services</td>
+ </tr>
+ <tr>
+ <td>swift_dir = /etc/swift</td>
+ <td>Swift configuration directory</td>
+ </tr>
+ <tr>
+ <td>user = swift</td>
+ <td>User to run as</td>
+ </tr>
+ <tr>
+ <td>workers = auto</td>
+ <td>a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests.</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-object-server-app-object-server.xml b/doc/common/tables/swift-object-server-app-object-server.xml
index 91d14a48d5..75090b4880 100644
--- a/doc/common/tables/swift-object-server-app-object-server.xml
+++ b/doc/common/tables/swift-object-server-app-object-server.xml
@@ -1,79 +1,101 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[app:object-server]</literal> in <literal>object-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[app-object-server]</literal> in <literal>object-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>use = egg:swift#object</td><td>Entry point of paste.deploy in the server</td>
- </tr>
- <tr>
- <td>set log_name = object-server</td><td>Label to use when logging</td>
- </tr>
- <tr>
- <td>set log_facility = LOG_LOCAL0</td><td>Syslog log facility</td>
- </tr>
- <tr>
- <td>set log_level = INFO</td><td>Log level</td>
- </tr>
- <tr>
- <td>set log_requests = true</td><td>Whether or not to log requests</td>
- </tr>
- <tr>
- <td>set log_address = /dev/log</td><td>Location where syslog sends the logs to</td>
- </tr>
- <tr>
- <td>max_upload_time = 86400</td><td>Maximum time allowed to upload an object</td>
- </tr>
- <tr>
- <td>slow = 0</td><td>If > 0, Minimum time in seconds for a PUT or DELETE request to complete</td>
- </tr>
- <tr>
- <td>keep_cache_size = 5424880</td><td>Largest object size to keep in buffer cache</td>
- </tr>
- <tr>
- <td>keep_cache_private = false</td><td>Allow non-public objects to stay in kernel's buffer cache</td>
- </tr>
- <tr>
- <td>mb_per_sync = 512</td><td>On PUT requests, sync file every n MB</td>
- </tr>
- <tr>
- <td>allowed_headers = Content-Disposition, Content-Encoding, X-Delete-At, X-Object-Manifest, X-Static-Large-Object</td><td>Comma-separated list of headers that can be set in metadata of an object</td>
- </tr>
- <tr>
- <td>auto_create_account_prefix = .</td><td>Prefix to use when automatically creating accounts</td>
- </tr>
- <tr>
- <td>threads_per_disk = 0</td><td>Size of the per-disk thread pool used for performing disk I/O. The default of 0 means to not use a per-disk thread pool. It is recommended to keep this value small, as large values can result in high read latencies due to large queue depths. A good starting point is 4 threads per disk.</td>
- </tr>
- <tr>
- <td>replication_server = false</td><td>If defined, tells server how to handle replication verbs in requests. When set to True (or 1), only replication verbs will be accepted. When set to False, replication verbs will be rejected. When undefined, server will accept any verb in the request.</td>
- </tr>
- <tr>
- <td>replication_concurrency = 4</td><td>Set to restrict the number of concurrent incoming REPLICATION requests; set to 0 for unlimited</td>
- </tr>
- <tr>
- <td>replication_one_per_device = True</td><td>Restricts incoming REPLICATION requests to one per device, replication_currency above allowing. This can help control I/O to each device, but you may wish to set this to False to allow multiple REPLICATION requests (up to the above replication_concurrency setting) per device.</td>
- </tr>
- <tr>
- <td>replication_lock_timeout = 15</td><td>Number of seconds to wait for an existing replication device lock before giving up.</td>
- </tr>
- <tr>
- <td>replication_failure_threshold = 100</td><td>The number of subrequest failures before the replication_failure_ratio is checked</td>
- </tr>
- <tr>
- <td>replication_failure_ratio = 1.0</td><td>If the value of failures / successes of REPLICATION subrequests exceeds this ratio, the overall REPLICATION request will be aborted</td>
- </tr>
+ <tr>
+ <td>allowed_headers = Content-Disposition, Content-Encoding, X-Delete-At, X-Object-Manifest, X-Static-Large-Object</td>
+ <td>Comma-separated list of headers that can be set in metadata of an object</td>
+ </tr>
+ <tr>
+ <td>auto_create_account_prefix = .</td>
+ <td>Prefix to use when automatically creating accounts</td>
+ </tr>
+ <tr>
+ <td>keep_cache_private = false</td>
+ <td>Allow non-public objects to stay in kernel's buffer cache</td>
+ </tr>
+ <tr>
+ <td>keep_cache_size = 5424880</td>
+ <td>Largest object size to keep in buffer cache</td>
+ </tr>
+ <tr>
+ <td>max_upload_time = 86400</td>
+ <td>Maximum time allowed to upload an object</td>
+ </tr>
+ <tr>
+ <td>mb_per_sync = 512</td>
+ <td>On PUT requests, sync file every n MB</td>
+ </tr>
+ <tr>
+ <td>replication_concurrency = 4</td>
+ <td>Set to restrict the number of concurrent incoming REPLICATION requests; set to 0 for unlimited</td>
+ </tr>
+ <tr>
+ <td>replication_failure_ratio = 1.0</td>
+ <td>If the value of failures / successes of REPLICATION subrequests exceeds this ratio, the overall REPLICATION request will be aborted</td>
+ </tr>
+ <tr>
+ <td>replication_failure_threshold = 100</td>
+ <td>The number of subrequest failures before the replication_failure_ratio is checked</td>
+ </tr>
+ <tr>
+ <td>replication_lock_timeout = 15</td>
+ <td>Number of seconds to wait for an existing replication device lock before giving up.</td>
+ </tr>
+ <tr>
+ <td>replication_one_per_device = True</td>
+ <td>Restricts incoming REPLICATION requests to one per device, replication_currency above allowing. This can help control I/O to each device, but you may wish to set this to False to allow multiple REPLICATION requests (up to the above replication_concurrency setting) per device.</td>
+ </tr>
+ <tr>
+ <td>replication_server = false</td>
+ <td>If defined, tells server how to handle replication verbs in requests. When set to True (or 1), only replication verbs will be accepted. When set to False, replication verbs will be rejected. When undefined, server will accept any verb in the request.</td>
+ </tr>
+ <tr>
+ <td>set log_address = /dev/log</td>
+ <td>Location where syslog sends the logs to</td>
+ </tr>
+ <tr>
+ <td>set log_facility = LOG_LOCAL0</td>
+ <td>Syslog log facility</td>
+ </tr>
+ <tr>
+ <td>set log_level = INFO</td>
+ <td>Log level</td>
+ </tr>
+ <tr>
+ <td>set log_name = object-server</td>
+ <td>Label to use when logging</td>
+ </tr>
+ <tr>
+ <td>set log_requests = true</td>
+ <td>Whether or not to log requests</td>
+ </tr>
+ <tr>
+ <td>slow = 0</td>
+ <td>If > 0, Minimum time in seconds for a PUT or DELETE request to complete</td>
+ </tr>
+ <tr>
+ <td>threads_per_disk = 0</td>
+ <td>Size of the per-disk thread pool used for performing disk I/O. The default of 0 means to not use a per-disk thread pool. It is recommended to keep this value small, as large values can result in high read latencies due to large queue depths. A good starting point is 4 threads per disk.</td>
+ </tr>
+ <tr>
+ <td>use = egg:swift#object</td>
+ <td>Entry point of paste.deploy in the server</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-object-server-filter-healthcheck.xml b/doc/common/tables/swift-object-server-filter-healthcheck.xml
index b3d0ae52e8..570d658759 100644
--- a/doc/common/tables/swift-object-server-filter-healthcheck.xml
+++ b/doc/common/tables/swift-object-server-filter-healthcheck.xml
@@ -1,25 +1,29 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[filter:healthcheck]</literal> in <literal>object-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[filter-healthcheck]</literal> in <literal>object-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>use = egg:swift#healthcheck</td><td>Entry point of paste.deploy in the server</td>
- </tr>
- <tr>
- <td>disable_path = </td><td>No help text available for this option.</td>
- </tr>
+ <tr>
+ <td>disable_path = </td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>use = egg:swift#healthcheck</td>
+ <td>Entry point of paste.deploy in the server</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-object-server-filter-recon.xml b/doc/common/tables/swift-object-server-filter-recon.xml
index be878b7372..c8cfe14acc 100644
--- a/doc/common/tables/swift-object-server-filter-recon.xml
+++ b/doc/common/tables/swift-object-server-filter-recon.xml
@@ -1,28 +1,33 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[filter:recon]</literal> in <literal>object-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[filter-recon]</literal> in <literal>object-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>use = egg:swift#recon</td><td>Entry point of paste.deploy in the server</td>
- </tr>
- <tr>
- <td>recon_cache_path = /var/cache/swift</td><td>Directory where stats for a few items will be stored</td>
- </tr>
- <tr>
- <td>recon_lock_path = /var/lock</td><td>No help text available for this option.</td>
- </tr>
+ <tr>
+ <td>recon_cache_path = /var/cache/swift</td>
+ <td>Directory where stats for a few items will be stored</td>
+ </tr>
+ <tr>
+ <td>recon_lock_path = /var/lock</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>use = egg:swift#recon</td>
+ <td>Entry point of paste.deploy in the server</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-object-server-filter-xprofile.xml b/doc/common/tables/swift-object-server-filter-xprofile.xml
new file mode 100644
index 0000000000..8fa5996d6d
--- /dev/null
+++ b/doc/common/tables/swift-object-server-filter-xprofile.xml
@@ -0,0 +1,53 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[filter-xprofile]</literal> in <literal>object-server.conf</literal>
+ </caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>dump_interval = 5.0</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>dump_timestamp = false</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>flush_at_shutdown = false</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>log_filename_prefix = /tmp/log/swift/profile/default.profile</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>path = /__profile__</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>profile_module = eventlet.green.profile</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>unwind = false</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>use = egg:swift#xprofile</td>
+ <td>Entry point of paste.deploy in the server</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/swift-object-server-object-auditor.xml b/doc/common/tables/swift-object-server-object-auditor.xml
index b8630e83b8..43f55126f9 100644
--- a/doc/common/tables/swift-object-server-object-auditor.xml
+++ b/doc/common/tables/swift-object-server-object-auditor.xml
@@ -1,49 +1,61 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[object-auditor]</literal> in <literal>object-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[object-auditor]</literal> in <literal>object-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>log_name = object-auditor</td><td>Label used when logging</td>
- </tr>
- <tr>
- <td>log_facility = LOG_LOCAL0</td><td>Syslog log facility</td>
- </tr>
- <tr>
- <td>log_level = INFO</td><td>Logging level</td>
- </tr>
- <tr>
- <td>log_address = /dev/log</td><td>Location where syslog sends the logs to</td>
- </tr>
- <tr>
- <td>files_per_second = 20</td><td>Maximum files audited per second. Should be tuned according to individual system specs. 0 is unlimited.</td>
- </tr>
- <tr>
- <td>bytes_per_second = 10000000</td><td>Maximum bytes audited per second. Should be tuned according to individual system specs. 0 is unlimited. mounted to prevent accidentally writing to the root device process simultaneously (it will actually accept(2) N + 1). Setting this to one (1) will only handle one request at a time, without accepting another request concurrently. By increasing the number of workers to a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests. underlying filesystem does not support it. to setup custom log handlers. bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. container server. For most cases, this should be `egg:swift#container`.</td>
- </tr>
- <tr>
- <td>log_time = 3600</td><td>Frequency of status logs in seconds.</td>
- </tr>
- <tr>
- <td>zero_byte_files_per_second = 50</td><td>Maximum zero byte files audited per second.</td>
- </tr>
- <tr>
- <td>recon_cache_path = /var/cache/swift</td><td>Directory where stats for a few items will be stored</td>
- </tr>
- <tr>
- <td>object_size_stats = </td><td>No help text available for this option.</td>
- </tr>
+ <tr>
+ <td>bytes_per_second = 10000000</td>
+ <td>Maximum bytes audited per second. Should be tuned according to individual system specs. 0 is unlimited. mounted to prevent accidentally writing to the root device process simultaneously (it will actually accept(2) N + 1). Setting this to one (1) will only handle one request at a time, without accepting another request concurrently. By increasing the number of workers to a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests. underlying filesystem does not support it. to setup custom log handlers. bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. container server. For most cases, this should be `egg:swift#container`.</td>
+ </tr>
+ <tr>
+ <td>files_per_second = 20</td>
+ <td>Maximum files audited per second. Should be tuned according to individual system specs. 0 is unlimited.</td>
+ </tr>
+ <tr>
+ <td>log_address = /dev/log</td>
+ <td>Location where syslog sends the logs to</td>
+ </tr>
+ <tr>
+ <td>log_facility = LOG_LOCAL0</td>
+ <td>Syslog log facility</td>
+ </tr>
+ <tr>
+ <td>log_level = INFO</td>
+ <td>Logging level</td>
+ </tr>
+ <tr>
+ <td>log_name = object-auditor</td>
+ <td>Label used when logging</td>
+ </tr>
+ <tr>
+ <td>log_time = 3600</td>
+ <td>Frequency of status logs in seconds.</td>
+ </tr>
+ <tr>
+ <td>object_size_stats = </td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>recon_cache_path = /var/cache/swift</td>
+ <td>Directory where stats for a few items will be stored</td>
+ </tr>
+ <tr>
+ <td>zero_byte_files_per_second = 50</td>
+ <td>Maximum zero byte files audited per second.</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-object-server-object-replicator.xml b/doc/common/tables/swift-object-server-object-replicator.xml
index 71e8ed8cc0..207146e27c 100644
--- a/doc/common/tables/swift-object-server-object-replicator.xml
+++ b/doc/common/tables/swift-object-server-object-replicator.xml
@@ -1,85 +1,109 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[object-replicator]</literal> in <literal>object-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[object-replicator]</literal> in <literal>object-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>log_name = object-replicator</td><td>Label used when logging</td>
- </tr>
- <tr>
- <td>log_facility = LOG_LOCAL0</td><td>Syslog log facility</td>
- </tr>
- <tr>
- <td>log_level = INFO</td><td>Logging level</td>
- </tr>
- <tr>
- <td>log_address = /dev/log</td><td>Location where syslog sends the logs to</td>
- </tr>
- <tr>
- <td>vm_test_mode = no</td><td>Indicates that you are using a VM environment</td>
- </tr>
- <tr>
- <td>daemonize = on</td><td>Whether or not to run replication as a daemon</td>
- </tr>
- <tr>
- <td>run_pause = 30</td><td>Time in seconds to wait between replication passes</td>
- </tr>
- <tr>
- <td>concurrency = 1</td><td>Number of replication workers to spawn</td>
- </tr>
- <tr>
- <td>stats_interval = 300</td><td>Interval in seconds between logging replication statistics</td>
- </tr>
- <tr>
- <td>sync_method = rsync</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>rsync_timeout = 900</td><td>Max duration (seconds) of a partition rsync</td>
- </tr>
- <tr>
- <td>rsync_bwlimit = 0</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>rsync_io_timeout = 30</td><td>Passed to rsync for a max duration (seconds) of an I/O op</td>
- </tr>
- <tr>
- <td>node_timeout = <whatever's in the DEFAULT section or 10></td><td>Request timeout to external services</td>
- </tr>
- <tr>
- <td>http_timeout = 60</td><td>Maximum duration for an HTTP request</td>
- </tr>
- <tr>
- <td>lockup_timeout = 1800</td><td>Attempts to kill all workers if nothing replications for lockup_timeout seconds</td>
- </tr>
- <tr>
- <td>reclaim_age = 604800</td><td>Time elapsed in seconds before an object can be reclaimed</td>
- </tr>
- <tr>
- <td>ring_check_interval = 15</td><td>How often (in seconds) to check the ring</td>
- </tr>
- <tr>
- <td>recon_cache_path = /var/cache/swift</td><td>Directory where stats for a few items will be stored</td>
- </tr>
- <tr>
- <td>rsync_error_log_line_length = 0</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>handoffs_first = False</td><td>If set to True, partitions that are not supposed to be on the node will be replicated first. The default setting should not be changed, except for extreme situations.</td>
- </tr>
- <tr>
- <td>handoff_delete = auto</td><td>By default handoff partitions will be removed when it has successfully replicated to all the canonical nodes. If set to an integer n, it will remove the partition if it is successfully replicated to n nodes. The default setting should not be changed, except for extremem situations. This uses what's set here, or what's set in the DEFAULT section, or 10 (though other sections use 3 as the final default).</td>
- </tr>
+ <tr>
+ <td>concurrency = 1</td>
+ <td>Number of replication workers to spawn</td>
+ </tr>
+ <tr>
+ <td>daemonize = on</td>
+ <td>Whether or not to run replication as a daemon</td>
+ </tr>
+ <tr>
+ <td>handoff_delete = auto</td>
+ <td>By default handoff partitions will be removed when it has successfully replicated to all the canonical nodes. If set to an integer n, it will remove the partition if it is successfully replicated to n nodes. The default setting should not be changed, except for extremem situations. This uses what's set here, or what's set in the DEFAULT section, or 10 (though other sections use 3 as the final default).</td>
+ </tr>
+ <tr>
+ <td>handoffs_first = False</td>
+ <td>If set to True, partitions that are not supposed to be on the node will be replicated first. The default setting should not be changed, except for extreme situations.</td>
+ </tr>
+ <tr>
+ <td>http_timeout = 60</td>
+ <td>Maximum duration for an HTTP request</td>
+ </tr>
+ <tr>
+ <td>lockup_timeout = 1800</td>
+ <td>Attempts to kill all workers if nothing replications for lockup_timeout seconds</td>
+ </tr>
+ <tr>
+ <td>log_address = /dev/log</td>
+ <td>Location where syslog sends the logs to</td>
+ </tr>
+ <tr>
+ <td>log_facility = LOG_LOCAL0</td>
+ <td>Syslog log facility</td>
+ </tr>
+ <tr>
+ <td>log_level = INFO</td>
+ <td>Logging level</td>
+ </tr>
+ <tr>
+ <td>log_name = object-replicator</td>
+ <td>Label used when logging</td>
+ </tr>
+ <tr>
+ <td>node_timeout = <whatever's in the DEFAULT section or 10></td>
+ <td>Request timeout to external services</td>
+ </tr>
+ <tr>
+ <td>reclaim_age = 604800</td>
+ <td>Time elapsed in seconds before an object can be reclaimed</td>
+ </tr>
+ <tr>
+ <td>recon_cache_path = /var/cache/swift</td>
+ <td>Directory where stats for a few items will be stored</td>
+ </tr>
+ <tr>
+ <td>ring_check_interval = 15</td>
+ <td>How often (in seconds) to check the ring</td>
+ </tr>
+ <tr>
+ <td>rsync_bwlimit = 0</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>rsync_error_log_line_length = 0</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>rsync_io_timeout = 30</td>
+ <td>Passed to rsync for a max duration (seconds) of an I/O op</td>
+ </tr>
+ <tr>
+ <td>rsync_timeout = 900</td>
+ <td>Max duration (seconds) of a partition rsync</td>
+ </tr>
+ <tr>
+ <td>run_pause = 30</td>
+ <td>Time in seconds to wait between replication passes</td>
+ </tr>
+ <tr>
+ <td>stats_interval = 300</td>
+ <td>Interval in seconds between logging replication statistics</td>
+ </tr>
+ <tr>
+ <td>sync_method = rsync</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>vm_test_mode = no</td>
+ <td>Indicates that you are using a VM environment</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-object-server-object-updater.xml b/doc/common/tables/swift-object-server-object-updater.xml
index cfd52b8a98..6bff95d120 100644
--- a/doc/common/tables/swift-object-server-object-updater.xml
+++ b/doc/common/tables/swift-object-server-object-updater.xml
@@ -1,46 +1,57 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[object-updater]</literal> in <literal>object-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[object-updater]</literal> in <literal>object-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>log_name = object-updater</td><td>Label used when logging</td>
- </tr>
- <tr>
- <td>log_facility = LOG_LOCAL0</td><td>Syslog log facility</td>
- </tr>
- <tr>
- <td>log_level = INFO</td><td>Logging level</td>
- </tr>
- <tr>
- <td>log_address = /dev/log</td><td>Location where syslog sends the logs to</td>
- </tr>
- <tr>
- <td>interval = 300</td><td>Minimum time for a pass to take</td>
- </tr>
- <tr>
- <td>concurrency = 1</td><td>Number of replication workers to spawn</td>
- </tr>
- <tr>
- <td>node_timeout = <whatever's in the DEFAULT section or 10></td><td>Request timeout to external services</td>
- </tr>
- <tr>
- <td>slowdown = 0.01</td><td>Time in seconds to wait between objects</td>
- </tr>
- <tr>
- <td>recon_cache_path = /var/cache/swift</td><td>Directory where stats for a few items will be stored</td>
- </tr>
+ <tr>
+ <td>concurrency = 1</td>
+ <td>Number of replication workers to spawn</td>
+ </tr>
+ <tr>
+ <td>interval = 300</td>
+ <td>Minimum time for a pass to take</td>
+ </tr>
+ <tr>
+ <td>log_address = /dev/log</td>
+ <td>Location where syslog sends the logs to</td>
+ </tr>
+ <tr>
+ <td>log_facility = LOG_LOCAL0</td>
+ <td>Syslog log facility</td>
+ </tr>
+ <tr>
+ <td>log_level = INFO</td>
+ <td>Logging level</td>
+ </tr>
+ <tr>
+ <td>log_name = object-updater</td>
+ <td>Label used when logging</td>
+ </tr>
+ <tr>
+ <td>node_timeout = <whatever's in the DEFAULT section or 10></td>
+ <td>Request timeout to external services</td>
+ </tr>
+ <tr>
+ <td>recon_cache_path = /var/cache/swift</td>
+ <td>Directory where stats for a few items will be stored</td>
+ </tr>
+ <tr>
+ <td>slowdown = 0.01</td>
+ <td>Time in seconds to wait between objects</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-object-server-pipeline-main.xml b/doc/common/tables/swift-object-server-pipeline-main.xml
index 5b229c13af..2864da5ab8 100644
--- a/doc/common/tables/swift-object-server-pipeline-main.xml
+++ b/doc/common/tables/swift-object-server-pipeline-main.xml
@@ -1,22 +1,25 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[pipeline:main]</literal> in <literal>object-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[pipeline-main]</literal> in <literal>object-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>pipeline = healthcheck recon object-server</td><td>No help text available for this option.</td>
- </tr>
+ <tr>
+ <td>pipeline = healthcheck recon object-server</td>
+ <td>No help text available for this option.</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-proxy-server-DEFAULT.xml b/doc/common/tables/swift-proxy-server-DEFAULT.xml
index 342d827b39..e67ab114a3 100644
--- a/doc/common/tables/swift-proxy-server-DEFAULT.xml
+++ b/doc/common/tables/swift-proxy-server-DEFAULT.xml
@@ -1,51 +1,139 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[DEFAULT]</literal> in <literal>proxy-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[DEFAULT]</literal> in <literal>proxy-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>bind_ip = 0.0.0.0</td><td>IP Address for server to bind to</td>
- </tr>
- <tr>
- <td>bind_port = 80</td><td>Port for server to bind to</td>
- </tr>
- <tr>
- <td>bind_timeout = 30</td><td>Seconds to attempt bind before giving up</td>
- </tr>
- <tr>
- <td>backlog = 4096</td><td>Maximum number of allowed pending TCP connections</td>
- </tr>
- <tr>
- <td>swift_dir = /etc/swift</td><td>Swift configuration directory</td>
- </tr>
- <tr>
- <td>user = swift</td><td>User to run as</td>
- </tr>
- <tr>
- <td>expose_info = true</td><td>Enables exposing configuration settings via HTTP GET /info.</td>
- </tr>
- <tr>
- <td>admin_key = secret_admin_key</td><td>to use for admin calls that are HMAC signed. Default is empty, which will disable admin calls to /info. the proxy server. For most cases, this should be `egg:swift#proxy`. request whenever it has to failover to a handoff node</td>
- </tr>
- <tr>
- <td>disallowed_sections = container_quotas, tempurl</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>workers = auto</td><td>a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests.</td>
- </tr>
- <tr>
- <td>max_clients = 1024</td><td>Maximum number of clients one worker can process simultaneously
+ <tr>
+ <td>admin_key = secret_admin_key</td>
+ <td>to use for admin calls that are HMAC signed. Default is empty, which will disable admin calls to /info. the proxy server. For most cases, this should be `egg:swift#proxy`. request whenever it has to failover to a handoff node</td>
+ </tr>
+ <tr>
+ <td>backlog = 4096</td>
+ <td>Maximum number of allowed pending TCP connections</td>
+ </tr>
+ <tr>
+ <td>bind_ip = 0.0.0.0</td>
+ <td>IP Address for server to bind to</td>
+ </tr>
+ <tr>
+ <td>bind_port = 80</td>
+ <td>Port for server to bind to</td>
+ </tr>
+ <tr>
+ <td>bind_timeout = 30</td>
+ <td>Seconds to attempt bind before giving up</td>
+ </tr>
+ <tr>
+ <td>cert_file = /etc/swift/proxy.crt</td>
+ <td>to the ssl .crt. This should be enabled for testing purposes only.</td>
+ </tr>
+ <tr>
+ <td>client_timeout = 60</td>
+ <td>Timeout to read one chunk from a client external services</td>
+ </tr>
+ <tr>
+ <td>cors_allow_origin = </td>
+ <td>is a list of hosts that are included with any CORS request by default and returned with the Access-Control-Allow-Origin header in addition to what the container has set. to call to setup custom log handlers. for eventlet the proxy server. For most cases, this should be `egg:swift#proxy`. request whenever it has to failover to a handoff node</td>
+ </tr>
+ <tr>
+ <td>disallowed_sections = container_quotas, tempurl, bulk_delete.max_failed_deletes</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>eventlet_debug = false</td>
+ <td>If true, turn on debug logging for eventlet</td>
+ </tr>
+ <tr>
+ <td>expiring_objects_account_name = expiring_objects</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>expiring_objects_container_divisor = 86400</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>expose_info = true</td>
+ <td>Enables exposing configuration settings via HTTP GET /info.</td>
+ </tr>
+ <tr>
+ <td>key_file = /etc/swift/proxy.key</td>
+ <td>to the ssl .key. This should be enabled for testing purposes only.</td>
+ </tr>
+ <tr>
+ <td>log_address = /dev/log</td>
+ <td>Location where syslog sends the logs to</td>
+ </tr>
+ <tr>
+ <td>log_custom_handlers = </td>
+ <td>Comma-separated list of functions to call to setup custom log handlers.</td>
+ </tr>
+ <tr>
+ <td>log_facility = LOG_LOCAL0</td>
+ <td>Syslog log facility</td>
+ </tr>
+ <tr>
+ <td>log_headers = false</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>log_level = INFO</td>
+ <td>Logging level</td>
+ </tr>
+ <tr>
+ <td>log_max_line_length = 0</td>
+ <td>Caps the length of log lines to the value given; no limit if set to 0, the default.</td>
+ </tr>
+ <tr>
+ <td>log_name = swift</td>
+ <td>Label used when logging</td>
+ </tr>
+ <tr>
+ <td>log_statsd_default_sample_rate = 1.0</td>
+ <td>Defines the probability of sending a sample for any given event or
+ timing measurement.</td>
+ </tr>
+ <tr>
+ <td>log_statsd_host = localhost</td>
+ <td>If not set, the StatsD feature is disabled.</td>
+ </tr>
+ <tr>
+ <td>log_statsd_metric_prefix = </td>
+ <td>Value will be prepended to every metric sent to the StatsD server.</td>
+ </tr>
+ <tr>
+ <td>log_statsd_port = 8125</td>
+ <td>Port value for the StatsD server.</td>
+ </tr>
+ <tr>
+ <td>log_statsd_sample_rate_factor = 1.0</td>
+ <td>Not recommended to set this to a value less than 1.0, if frequency
+ of logging is too high, tune the
+ log_statsd_default_sample_rate instead.</td>
+ </tr>
+ <tr>
+ <td>log_udp_host = </td>
+ <td>If not set, the UDB receiver for syslog is disabled.</td>
+ </tr>
+ <tr>
+ <td>log_udp_port = 514</td>
+ <td>Port value for UDB receiver, if enabled.</td>
+ </tr>
+ <tr>
+ <td>max_clients = 1024</td>
+ <td>Maximum number of clients one worker can process simultaneously
Lowering the number of clients handled per worker, and raising the
number of workers can lessen the impact that a CPU intensive, or
blocking, request can have on other requests served by the same
@@ -53,73 +141,23 @@ worker. If the maximum number of clients is set to one, then a given worker
will not perform another call while processing, allowing
other workers a chance to process it.
</td>
- </tr>
- <tr>
- <td>cert_file = /etc/swift/proxy.crt</td><td>to the ssl .crt. This should be enabled for testing purposes only.</td>
- </tr>
- <tr>
- <td>key_file = /etc/swift/proxy.key</td><td>to the ssl .key. This should be enabled for testing purposes only.</td>
- </tr>
- <tr>
- <td>expiring_objects_container_divisor = 86400</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>expiring_objects_account_name = expiring_objects</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>log_name = swift</td><td>Label used when logging</td>
- </tr>
- <tr>
- <td>log_facility = LOG_LOCAL0</td><td>Syslog log facility</td>
- </tr>
- <tr>
- <td>log_level = INFO</td><td>Logging level</td>
- </tr>
- <tr>
- <td>log_headers = false</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>log_address = /dev/log</td><td>Location where syslog sends the logs to</td>
- </tr>
- <tr>
- <td>trans_id_suffix = </td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>log_custom_handlers = </td><td>Comma-separated list of functions to call to setup custom log handlers.</td>
- </tr>
- <tr>
- <td>log_udp_host = </td><td>If not set, the UDB receiver for syslog is disabled.</td>
- </tr>
- <tr>
- <td>log_udp_port = 514</td><td>Port value for UDB receiver, if enabled.</td>
- </tr>
- <tr>
- <td>log_statsd_host = localhost</td><td>If not set, the StatsD feature is disabled.</td>
- </tr>
- <tr>
- <td>log_statsd_port = 8125</td><td>Port value for the StatsD server.</td>
- </tr>
- <tr>
- <td>log_statsd_default_sample_rate = 1.0</td><td>Defines the probability of sending a sample for any given event or
- timing measurement.</td>
- </tr>
- <tr>
- <td>log_statsd_sample_rate_factor = 1.0</td><td>Not recommended to set this to a value less than 1.0, if frequency
- of logging is too high, tune the
- log_statsd_default_sample_rate instead.</td>
- </tr>
- <tr>
- <td>log_statsd_metric_prefix = </td><td>Value will be prepended to every metric sent to the StatsD server.</td>
- </tr>
- <tr>
- <td>cors_allow_origin = </td><td>is a list of hosts that are included with any CORS request by default and returned with the Access-Control-Allow-Origin header in addition to what the container has set. to call to setup custom log handlers. for eventlet the proxy server. For most cases, this should be `egg:swift#proxy`. request whenever it has to failover to a handoff node</td>
- </tr>
- <tr>
- <td>client_timeout = 60</td><td>Timeout to read one chunk from a client external services</td>
- </tr>
- <tr>
- <td>eventlet_debug = false</td><td>If true, turn on debug logging for eventlet</td>
- </tr>
+ </tr>
+ <tr>
+ <td>swift_dir = /etc/swift</td>
+ <td>Swift configuration directory</td>
+ </tr>
+ <tr>
+ <td>trans_id_suffix = </td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>user = swift</td>
+ <td>User to run as</td>
+ </tr>
+ <tr>
+ <td>workers = auto</td>
+ <td>a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests.</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-proxy-server-app-proxy-server.xml b/doc/common/tables/swift-proxy-server-app-proxy-server.xml
index f8bb6682e8..f301b8a2ab 100644
--- a/doc/common/tables/swift-proxy-server-app-proxy-server.xml
+++ b/doc/common/tables/swift-proxy-server-app-proxy-server.xml
@@ -1,121 +1,149 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[app:proxy-server]</literal> in <literal>proxy-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[app-proxy-server]</literal> in <literal>proxy-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>use = egg:swift#proxy</td><td>Entry point of paste.deploy in the server</td>
- </tr>
- <tr>
- <td>set log_name = proxy-server</td><td>Label to use when logging</td>
- </tr>
- <tr>
- <td>set log_facility = LOG_LOCAL0</td><td>Syslog log facility</td>
- </tr>
- <tr>
- <td>set log_level = INFO</td><td>Log level</td>
- </tr>
- <tr>
- <td>set log_address = /dev/log</td><td>Location where syslog sends the logs to</td>
- </tr>
- <tr>
- <td>log_handoffs = true</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>recheck_account_existence = 60</td><td>Cache timeout in seconds to send memcached for account existence</td>
- </tr>
- <tr>
- <td>recheck_container_existence = 60</td><td>Cache timeout in seconds to send memcached for container existence</td>
- </tr>
- <tr>
- <td>object_chunk_size = 8192</td><td>Chunk size to read from object servers</td>
- </tr>
- <tr>
- <td>client_chunk_size = 8192</td><td>Chunk size to read from clients</td>
- </tr>
- <tr>
- <td>node_timeout = 10</td><td>Request timeout to external services</td>
- </tr>
- <tr>
- <td>recoverable_node_timeout = node_timeout</td><td>Request timeout to external services for requests that, on failure, can be recovered from. For example, object GET. from a client external services</td>
- </tr>
- <tr>
- <td>conn_timeout = 0.5</td><td>Connection timeout to external services</td>
- </tr>
- <tr>
- <td>post_quorum_timeout = 0.5</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>error_suppression_interval = 60</td><td>Time in seconds that must elapse since the last error for a node to be considered no longer error limited</td>
- </tr>
- <tr>
- <td>error_suppression_limit = 10</td><td>Error count to consider a node error limited</td>
- </tr>
- <tr>
- <td>allow_account_management = false</td><td>Whether account PUTs and DELETEs are even callable</td>
- </tr>
- <tr>
- <td>object_post_as_copy = true</td><td>Set object_post_as_copy = false to turn on fast posts where only the metadata changes are stored anew and the original data file is kept in place. This makes for quicker posts; but since the container metadata isn't updated in this mode, features like container sync won't be able to sync posts.</td>
- </tr>
- <tr>
- <td>account_autocreate = false</td><td>If set to 'true' authorized accounts that do not yet exist within the Swift cluster will be automatically created.</td>
- </tr>
- <tr>
- <td>max_containers_per_account = 0</td><td>If set to a positive value, trying to create a container when the account already has at least this maximum containers will result in a 403 Forbidden. Note: This is a soft limit, meaning a user might exceed the cap for recheck_account_existence before the 403s kick in.</td>
- </tr>
- <tr>
- <td>max_containers_whitelist = </td><td>is a comma separated list of account names that ignore the max_containers_per_account cap.</td>
- </tr>
- <tr>
- <td>deny_host_headers = </td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>auto_create_account_prefix = .</td><td>Prefix to use when automatically creating accounts</td>
- </tr>
- <tr>
- <td>put_queue_depth = 10</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>sorting_method = shuffle</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>timing_expiry = 300</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>max_large_object_get_time = 86400</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>request_node_count = 2 * replicas</td><td>* replicas Set to the number of nodes to contact for a normal request. You can use '* replicas' at the end to have it use the number given times the number of replicas for the ring being used for the request. conf file for values will only be shown to the list of swift_owners. The exact default definition of a swift_owner is headers> up to the auth system in use, but usually indicates administrative responsibilities. paste.deploy to use for auth. To use tempauth set to: `egg:swift#tempauth` each request</td>
- </tr>
- <tr>
- <td>read_affinity = r1z1=100, r1z2=200, r2=300</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>read_affinity = </td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>write_affinity = r1, r2</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>write_affinity = </td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>write_affinity_node_count = 2 * replicas</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>swift_owner_headers = x-container-read, x-container-write, x-container-sync-key, x-container-sync-to, x-account-meta-temp-url-key, x-account-meta-temp-url-key-2, x-account-access-control</td><td>the sample These are the headers whose conf file for values will only be shown to the list of swift_owners. The exact default definition of a swift_owner is headers> up to the auth system in use, but usually indicates administrative responsibilities. paste.deploy to use for auth. To use tempauth set to: `egg:swift#tempauth` each request</td>
- </tr>
+ <tr>
+ <td>account_autocreate = false</td>
+ <td>If set to 'true' authorized accounts that do not yet exist within the Swift cluster will be automatically created.</td>
+ </tr>
+ <tr>
+ <td>allow_account_management = false</td>
+ <td>Whether account PUTs and DELETEs are even callable</td>
+ </tr>
+ <tr>
+ <td>auto_create_account_prefix = .</td>
+ <td>Prefix to use when automatically creating accounts</td>
+ </tr>
+ <tr>
+ <td>client_chunk_size = 8192</td>
+ <td>Chunk size to read from clients</td>
+ </tr>
+ <tr>
+ <td>conn_timeout = 0.5</td>
+ <td>Connection timeout to external services</td>
+ </tr>
+ <tr>
+ <td>deny_host_headers = </td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>error_suppression_interval = 60</td>
+ <td>Time in seconds that must elapse since the last error for a node to be considered no longer error limited</td>
+ </tr>
+ <tr>
+ <td>error_suppression_limit = 10</td>
+ <td>Error count to consider a node error limited</td>
+ </tr>
+ <tr>
+ <td>log_handoffs = true</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>max_containers_per_account = 0</td>
+ <td>If set to a positive value, trying to create a container when the account already has at least this maximum containers will result in a 403 Forbidden. Note: This is a soft limit, meaning a user might exceed the cap for recheck_account_existence before the 403s kick in.</td>
+ </tr>
+ <tr>
+ <td>max_containers_whitelist = </td>
+ <td>is a comma separated list of account names that ignore the max_containers_per_account cap.</td>
+ </tr>
+ <tr>
+ <td>max_large_object_get_time = 86400</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>node_timeout = 10</td>
+ <td>Request timeout to external services</td>
+ </tr>
+ <tr>
+ <td>object_chunk_size = 8192</td>
+ <td>Chunk size to read from object servers</td>
+ </tr>
+ <tr>
+ <td>object_post_as_copy = true</td>
+ <td>Set object_post_as_copy = false to turn on fast posts where only the metadata changes are stored anew and the original data file is kept in place. This makes for quicker posts; but since the container metadata isn't updated in this mode, features like container sync won't be able to sync posts.</td>
+ </tr>
+ <tr>
+ <td>post_quorum_timeout = 0.5</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>put_queue_depth = 10</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>read_affinity = r1z1=100, r1z2=200, r2=300</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>recheck_account_existence = 60</td>
+ <td>Cache timeout in seconds to send memcached for account existence</td>
+ </tr>
+ <tr>
+ <td>recheck_container_existence = 60</td>
+ <td>Cache timeout in seconds to send memcached for container existence</td>
+ </tr>
+ <tr>
+ <td>recoverable_node_timeout = node_timeout</td>
+ <td>Request timeout to external services for requests that, on failure, can be recovered from. For example, object GET. from a client external services</td>
+ </tr>
+ <tr>
+ <td>request_node_count = 2 * replicas</td>
+ <td>* replicas Set to the number of nodes to contact for a normal request. You can use '* replicas' at the end to have it use the number given times the number of replicas for the ring being used for the request. conf file for values will only be shown to the list of swift_owners. The exact default definition of a swift_owner is headers> up to the auth system in use, but usually indicates administrative responsibilities. paste.deploy to use for auth. To use tempauth set to: `egg:swift#tempauth` each request</td>
+ </tr>
+ <tr>
+ <td>set log_address = /dev/log</td>
+ <td>Location where syslog sends the logs to</td>
+ </tr>
+ <tr>
+ <td>set log_facility = LOG_LOCAL0</td>
+ <td>Syslog log facility</td>
+ </tr>
+ <tr>
+ <td>set log_level = INFO</td>
+ <td>Log level</td>
+ </tr>
+ <tr>
+ <td>set log_name = proxy-server</td>
+ <td>Label to use when logging</td>
+ </tr>
+ <tr>
+ <td>sorting_method = shuffle</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>swift_owner_headers = x-container-read, x-container-write, x-container-sync-key, x-container-sync-to, x-account-meta-temp-url-key, x-account-meta-temp-url-key-2, x-account-access-control</td>
+ <td>the sample These are the headers whose conf file for values will only be shown to the list of swift_owners. The exact default definition of a swift_owner is headers> up to the auth system in use, but usually indicates administrative responsibilities. paste.deploy to use for auth. To use tempauth set to: `egg:swift#tempauth` each request</td>
+ </tr>
+ <tr>
+ <td>timing_expiry = 300</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>use = egg:swift#proxy</td>
+ <td>Entry point of paste.deploy in the server</td>
+ </tr>
+ <tr>
+ <td>write_affinity = r1, r2</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>write_affinity_node_count = 2 * replicas</td>
+ <td>No help text available for this option.</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-proxy-server-filter-account-quotas.xml b/doc/common/tables/swift-proxy-server-filter-account-quotas.xml
index 3a41a37816..49abeda964 100644
--- a/doc/common/tables/swift-proxy-server-filter-account-quotas.xml
+++ b/doc/common/tables/swift-proxy-server-filter-account-quotas.xml
@@ -1,22 +1,25 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[filter:account-quotas]</literal> in <literal>proxy-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[filter-account-quotas]</literal> in <literal>proxy-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>use = egg:swift#account_quotas</td><td>Entry point of paste.deploy in the server</td>
- </tr>
+ <tr>
+ <td>use = egg:swift#account_quotas</td>
+ <td>Entry point of paste.deploy in the server</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-proxy-server-filter-authtoken.xml b/doc/common/tables/swift-proxy-server-filter-authtoken.xml
index faef622c9e..08428ea83e 100644
--- a/doc/common/tables/swift-proxy-server-filter-authtoken.xml
+++ b/doc/common/tables/swift-proxy-server-filter-authtoken.xml
@@ -1,49 +1,61 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[filter:authtoken]</literal> in <literal>proxy-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[filter-authtoken]</literal> in <literal>proxy-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>auth_host = keystonehost</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>auth_port = 35357</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>auth_protocol = http</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>auth_uri = http://keystonehost:5000/</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>admin_tenant_name = service</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>admin_user = swift</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>admin_password = password</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>delay_auth_decision = 1</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>cache = swift.cache</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>include_service_catalog = False</td><td>No help text available for this option.</td>
- </tr>
+ <tr>
+ <td>admin_password = password</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>admin_tenant_name = service</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>admin_user = swift</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>auth_host = keystonehost</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>auth_port = 35357</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>auth_protocol = http</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>auth_uri = http://keystonehost:5000/</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>cache = swift.cache</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>delay_auth_decision = 1</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>include_service_catalog = False</td>
+ <td>No help text available for this option.</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-proxy-server-filter-bulk.xml b/doc/common/tables/swift-proxy-server-filter-bulk.xml
index 57096ccc15..2251ee9e66 100644
--- a/doc/common/tables/swift-proxy-server-filter-bulk.xml
+++ b/doc/common/tables/swift-proxy-server-filter-bulk.xml
@@ -1,40 +1,49 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[filter:bulk]</literal> in <literal>proxy-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[filter-bulk]</literal> in <literal>proxy-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>use = egg:swift#bulk</td><td>Entry point of paste.deploy in the server</td>
- </tr>
- <tr>
- <td>max_containers_per_extraction = 10000</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>max_failed_extractions = 1000</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>max_deletes_per_request = 10000</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>max_failed_deletes = 1000</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>yield_frequency = 10</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>delete_container_retry_count = 0</td><td>No help text available for this option.</td>
- </tr>
+ <tr>
+ <td>delete_container_retry_count = 0</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>max_containers_per_extraction = 10000</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>max_deletes_per_request = 10000</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>max_failed_deletes = 1000</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>max_failed_extractions = 1000</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>use = egg:swift#bulk</td>
+ <td>Entry point of paste.deploy in the server</td>
+ </tr>
+ <tr>
+ <td>yield_frequency = 10</td>
+ <td>No help text available for this option.</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-proxy-server-filter-cache.xml b/doc/common/tables/swift-proxy-server-filter-cache.xml
index 6bbad95303..17e7f81f57 100644
--- a/doc/common/tables/swift-proxy-server-filter-cache.xml
+++ b/doc/common/tables/swift-proxy-server-filter-cache.xml
@@ -1,46 +1,57 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[filter:cache]</literal> in <literal>proxy-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[filter-cache]</literal> in <literal>proxy-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>use = egg:swift#memcache</td><td>Entry point of paste.deploy in the server</td>
- </tr>
- <tr>
- <td>set log_name = cache</td><td>Label to use when logging</td>
- </tr>
- <tr>
- <td>set log_facility = LOG_LOCAL0</td><td>Syslog log facility</td>
- </tr>
- <tr>
- <td>set log_level = INFO</td><td>Log level</td>
- </tr>
- <tr>
- <td>set log_headers = false</td><td>If True, log headers in each request</td>
- </tr>
- <tr>
- <td>set log_address = /dev/log</td><td>Location where syslog sends the logs to</td>
- </tr>
- <tr>
- <td>memcache_servers = 127.0.0.1:11211</td><td>Comma separated list of memcached servers ip:port services</td>
- </tr>
- <tr>
- <td>memcache_serialization_support = 2</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>memcache_max_connections = 2</td><td>Max number of connections to each memcached server per worker services</td>
- </tr>
+ <tr>
+ <td>memcache_max_connections = 2</td>
+ <td>Max number of connections to each memcached server per worker services</td>
+ </tr>
+ <tr>
+ <td>memcache_serialization_support = 2</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>memcache_servers = 127.0.0.1:11211</td>
+ <td>Comma separated list of memcached servers ip:port services</td>
+ </tr>
+ <tr>
+ <td>set log_address = /dev/log</td>
+ <td>Location where syslog sends the logs to</td>
+ </tr>
+ <tr>
+ <td>set log_facility = LOG_LOCAL0</td>
+ <td>Syslog log facility</td>
+ </tr>
+ <tr>
+ <td>set log_headers = false</td>
+ <td>If True, log headers in each request</td>
+ </tr>
+ <tr>
+ <td>set log_level = INFO</td>
+ <td>Log level</td>
+ </tr>
+ <tr>
+ <td>set log_name = cache</td>
+ <td>Label to use when logging</td>
+ </tr>
+ <tr>
+ <td>use = egg:swift#memcache</td>
+ <td>Entry point of paste.deploy in the server</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-proxy-server-filter-catch_errors.xml b/doc/common/tables/swift-proxy-server-filter-catch_errors.xml
index f75f32bc2c..bdd7a5ca81 100644
--- a/doc/common/tables/swift-proxy-server-filter-catch_errors.xml
+++ b/doc/common/tables/swift-proxy-server-filter-catch_errors.xml
@@ -1,37 +1,45 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[filter:catch_errors]</literal> in <literal>proxy-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[filter-catch_errors]</literal> in <literal>proxy-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>use = egg:swift#catch_errors</td><td>Entry point of paste.deploy in the server</td>
- </tr>
- <tr>
- <td>set log_name = catch_errors</td><td>Label to use when logging</td>
- </tr>
- <tr>
- <td>set log_facility = LOG_LOCAL0</td><td>Syslog log facility</td>
- </tr>
- <tr>
- <td>set log_level = INFO</td><td>Log level</td>
- </tr>
- <tr>
- <td>set log_headers = false</td><td>If True, log headers in each request</td>
- </tr>
- <tr>
- <td>set log_address = /dev/log</td><td>Location where syslog sends the logs to</td>
- </tr>
+ <tr>
+ <td>set log_address = /dev/log</td>
+ <td>Location where syslog sends the logs to</td>
+ </tr>
+ <tr>
+ <td>set log_facility = LOG_LOCAL0</td>
+ <td>Syslog log facility</td>
+ </tr>
+ <tr>
+ <td>set log_headers = false</td>
+ <td>If True, log headers in each request</td>
+ </tr>
+ <tr>
+ <td>set log_level = INFO</td>
+ <td>Log level</td>
+ </tr>
+ <tr>
+ <td>set log_name = catch_errors</td>
+ <td>Label to use when logging</td>
+ </tr>
+ <tr>
+ <td>use = egg:swift#catch_errors</td>
+ <td>Entry point of paste.deploy in the server</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-proxy-server-filter-cname_lookup.xml b/doc/common/tables/swift-proxy-server-filter-cname_lookup.xml
index e9b7363199..3804c068e7 100644
--- a/doc/common/tables/swift-proxy-server-filter-cname_lookup.xml
+++ b/doc/common/tables/swift-proxy-server-filter-cname_lookup.xml
@@ -1,44 +1,54 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[filter:cname_lookup]</literal> in <literal>proxy-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[filter-cname_lookup]</literal> in <literal>proxy-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>use = egg:swift#cname_lookup</td><td>Entry point of paste.deploy in the server</td>
- </tr>
- <tr>
- <td>set log_name = cname_lookup</td><td>Label to use when logging</td>
- </tr>
- <tr>
- <td>set log_facility = LOG_LOCAL0</td><td>Syslog log facility</td>
- </tr>
- <tr>
- <td>set log_level = INFO</td><td>Log level</td>
- </tr>
- <tr>
- <td>set log_headers = false</td><td>If True, log headers in each request</td>
- </tr>
- <tr>
- <td>set log_address = /dev/log</td><td>Location where syslog sends the logs to</td>
- </tr>
- <tr>
- <td>storage_domain = example.com</td><td>Domain that matches your cloud. Multiple domains can be specified using a comma-separated
+ <tr>
+ <td>lookup_depth = 1</td>
+ <td>Because CNAMES can be recursive, specifies the number of levels through which to search.</td>
+ </tr>
+ <tr>
+ <td>set log_address = /dev/log</td>
+ <td>Location where syslog sends the logs to</td>
+ </tr>
+ <tr>
+ <td>set log_facility = LOG_LOCAL0</td>
+ <td>Syslog log facility</td>
+ </tr>
+ <tr>
+ <td>set log_headers = false</td>
+ <td>If True, log headers in each request</td>
+ </tr>
+ <tr>
+ <td>set log_level = INFO</td>
+ <td>Log level</td>
+ </tr>
+ <tr>
+ <td>set log_name = cname_lookup</td>
+ <td>Label to use when logging</td>
+ </tr>
+ <tr>
+ <td>storage_domain = example.com</td>
+ <td>Domain that matches your cloud. Multiple domains can be specified using a comma-separated
list.</td>
- </tr>
- <tr>
- <td>lookup_depth = 1</td><td>Because CNAMES can be recursive, specifies the number of levels through which to search.</td>
- </tr>
+ </tr>
+ <tr>
+ <td>use = egg:swift#cname_lookup</td>
+ <td>Entry point of paste.deploy in the server</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-proxy-server-filter-container-quotas.xml b/doc/common/tables/swift-proxy-server-filter-container-quotas.xml
index bb76f10df0..fd2befad06 100644
--- a/doc/common/tables/swift-proxy-server-filter-container-quotas.xml
+++ b/doc/common/tables/swift-proxy-server-filter-container-quotas.xml
@@ -1,22 +1,25 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[filter:container-quotas]</literal> in <literal>proxy-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[filter-container-quotas]</literal> in <literal>proxy-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>use = egg:swift#container_quotas</td><td>Entry point of paste.deploy in the server</td>
- </tr>
+ <tr>
+ <td>use = egg:swift#container_quotas</td>
+ <td>Entry point of paste.deploy in the server</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-proxy-server-filter-container_sync.xml b/doc/common/tables/swift-proxy-server-filter-container_sync.xml
index eb1d50e5e1..5d9270ca66 100644
--- a/doc/common/tables/swift-proxy-server-filter-container_sync.xml
+++ b/doc/common/tables/swift-proxy-server-filter-container_sync.xml
@@ -1,25 +1,33 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[filter:container_sync]</literal> in <literal>proxy-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[filter-container_sync]</literal> in <literal>proxy-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>use = egg:swift#container_sync</td><td>Entry point of paste.deploy in the server</td>
- </tr>
- <tr>
- <td>allow_full_urls = true</td><td>No help text available for this option.</td>
- </tr>
+ <tr>
+ <td>allow_full_urls = true</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>current = //REALM/CLUSTER</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>use = egg:swift#container_sync</td>
+ <td>Entry point of paste.deploy in the server</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-proxy-server-filter-dlo.xml b/doc/common/tables/swift-proxy-server-filter-dlo.xml
index 913436ff8c..9e87a71e3e 100644
--- a/doc/common/tables/swift-proxy-server-filter-dlo.xml
+++ b/doc/common/tables/swift-proxy-server-filter-dlo.xml
@@ -1,31 +1,37 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[filter:dlo]</literal> in <literal>proxy-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[filter-dlo]</literal> in <literal>proxy-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>use = egg:swift#dlo</td><td>Entry point of paste.deploy in the server</td>
- </tr>
- <tr>
- <td>rate_limit_after_segment = 10</td><td>Rate limit the download of large object segments after this segment is downloaded.</td>
- </tr>
- <tr>
- <td>rate_limit_segments_per_sec = 1</td><td>Rate limit large object downloads at this rate. contact for a normal request. You can use '* replicas' at the end to have it use the number given times the number of replicas for the ring being used for the request. paste.deploy to use for auth. To use tempauth set to: `egg:swift#tempauth` each request</td>
- </tr>
- <tr>
- <td>max_get_time = 86400</td><td>No help text available for this option.</td>
- </tr>
+ <tr>
+ <td>max_get_time = 86400</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>rate_limit_after_segment = 10</td>
+ <td>Rate limit the download of large object segments after this segment is downloaded.</td>
+ </tr>
+ <tr>
+ <td>rate_limit_segments_per_sec = 1</td>
+ <td>Rate limit large object downloads at this rate. contact for a normal request. You can use '* replicas' at the end to have it use the number given times the number of replicas for the ring being used for the request. paste.deploy to use for auth. To use tempauth set to: `egg:swift#tempauth` each request</td>
+ </tr>
+ <tr>
+ <td>use = egg:swift#dlo</td>
+ <td>Entry point of paste.deploy in the server</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-proxy-server-filter-domain_remap.xml b/doc/common/tables/swift-proxy-server-filter-domain_remap.xml
index 3a14f49512..66ad6b6620 100644
--- a/doc/common/tables/swift-proxy-server-filter-domain_remap.xml
+++ b/doc/common/tables/swift-proxy-server-filter-domain_remap.xml
@@ -1,47 +1,58 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[filter:domain_remap]</literal> in <literal>proxy-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[filter-domain_remap]</literal> in <literal>proxy-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>use = egg:swift#domain_remap</td><td>Entry point of paste.deploy in the server</td>
- </tr>
- <tr>
- <td>set log_name = domain_remap</td><td>Label to use when logging</td>
- </tr>
- <tr>
- <td>set log_facility = LOG_LOCAL0</td><td>Syslog log facility</td>
- </tr>
- <tr>
- <td>set log_level = INFO</td><td>Log level</td>
- </tr>
- <tr>
- <td>set log_headers = false</td><td>If True, log headers in each request</td>
- </tr>
- <tr>
- <td>set log_address = /dev/log</td><td>Location where syslog sends the logs to</td>
- </tr>
- <tr>
- <td>storage_domain = example.com</td><td>Domain that matches your cloud. Multiple domains can be specified using a comma-separated
+ <tr>
+ <td>path_root = v1</td>
+ <td>Root path</td>
+ </tr>
+ <tr>
+ <td>reseller_prefixes = AUTH</td>
+ <td>Reseller prefix</td>
+ </tr>
+ <tr>
+ <td>set log_address = /dev/log</td>
+ <td>Location where syslog sends the logs to</td>
+ </tr>
+ <tr>
+ <td>set log_facility = LOG_LOCAL0</td>
+ <td>Syslog log facility</td>
+ </tr>
+ <tr>
+ <td>set log_headers = false</td>
+ <td>If True, log headers in each request</td>
+ </tr>
+ <tr>
+ <td>set log_level = INFO</td>
+ <td>Log level</td>
+ </tr>
+ <tr>
+ <td>set log_name = domain_remap</td>
+ <td>Label to use when logging</td>
+ </tr>
+ <tr>
+ <td>storage_domain = example.com</td>
+ <td>Domain that matches your cloud. Multiple domains can be specified using a comma-separated
list.</td>
- </tr>
- <tr>
- <td>path_root = v1</td><td>Root path</td>
- </tr>
- <tr>
- <td>reseller_prefixes = AUTH</td><td>Reseller prefix</td>
- </tr>
+ </tr>
+ <tr>
+ <td>use = egg:swift#domain_remap</td>
+ <td>Entry point of paste.deploy in the server</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-proxy-server-filter-formpost.xml b/doc/common/tables/swift-proxy-server-filter-formpost.xml
index 530e590142..49fd41eb6f 100644
--- a/doc/common/tables/swift-proxy-server-filter-formpost.xml
+++ b/doc/common/tables/swift-proxy-server-filter-formpost.xml
@@ -1,22 +1,25 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[filter:formpost]</literal> in <literal>proxy-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[filter-formpost]</literal> in <literal>proxy-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>use = egg:swift#formpost</td><td>Entry point of paste.deploy in the server</td>
- </tr>
+ <tr>
+ <td>use = egg:swift#formpost</td>
+ <td>Entry point of paste.deploy in the server</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-proxy-server-filter-gatekeeper.xml b/doc/common/tables/swift-proxy-server-filter-gatekeeper.xml
index c689b77b2e..e362e6783d 100644
--- a/doc/common/tables/swift-proxy-server-filter-gatekeeper.xml
+++ b/doc/common/tables/swift-proxy-server-filter-gatekeeper.xml
@@ -1,37 +1,45 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[filter:gatekeeper]</literal> in <literal>proxy-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[filter-gatekeeper]</literal> in <literal>proxy-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>use = egg:swift#gatekeeper</td><td>Entry point of paste.deploy in the server</td>
- </tr>
- <tr>
- <td>set log_name = gatekeeper</td><td>Label to use when logging</td>
- </tr>
- <tr>
- <td>set log_facility = LOG_LOCAL0</td><td>Syslog log facility</td>
- </tr>
- <tr>
- <td>set log_level = INFO</td><td>Log level</td>
- </tr>
- <tr>
- <td>set log_headers = false</td><td>If True, log headers in each request</td>
- </tr>
- <tr>
- <td>set log_address = /dev/log</td><td>Location where syslog sends the logs to</td>
- </tr>
+ <tr>
+ <td>set log_address = /dev/log</td>
+ <td>Location where syslog sends the logs to</td>
+ </tr>
+ <tr>
+ <td>set log_facility = LOG_LOCAL0</td>
+ <td>Syslog log facility</td>
+ </tr>
+ <tr>
+ <td>set log_headers = false</td>
+ <td>If True, log headers in each request</td>
+ </tr>
+ <tr>
+ <td>set log_level = INFO</td>
+ <td>Log level</td>
+ </tr>
+ <tr>
+ <td>set log_name = gatekeeper</td>
+ <td>Label to use when logging</td>
+ </tr>
+ <tr>
+ <td>use = egg:swift#gatekeeper</td>
+ <td>Entry point of paste.deploy in the server</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-proxy-server-filter-healthcheck.xml b/doc/common/tables/swift-proxy-server-filter-healthcheck.xml
index b387afb0de..3583712625 100644
--- a/doc/common/tables/swift-proxy-server-filter-healthcheck.xml
+++ b/doc/common/tables/swift-proxy-server-filter-healthcheck.xml
@@ -1,25 +1,29 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[filter:healthcheck]</literal> in <literal>proxy-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[filter-healthcheck]</literal> in <literal>proxy-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>use = egg:swift#healthcheck</td><td>Entry point of paste.deploy in the server</td>
- </tr>
- <tr>
- <td>disable_path = </td><td>No help text available for this option.</td>
- </tr>
+ <tr>
+ <td>disable_path = </td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>use = egg:swift#healthcheck</td>
+ <td>Entry point of paste.deploy in the server</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-proxy-server-filter-keystoneauth.xml b/doc/common/tables/swift-proxy-server-filter-keystoneauth.xml
index 1d8d9b9bdb..c0ddd50d69 100644
--- a/doc/common/tables/swift-proxy-server-filter-keystoneauth.xml
+++ b/doc/common/tables/swift-proxy-server-filter-keystoneauth.xml
@@ -1,28 +1,33 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[filter:keystoneauth]</literal> in <literal>proxy-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[filter-keystoneauth]</literal> in <literal>proxy-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>use = egg:swift#keystoneauth</td><td>Entry point of paste.deploy in the server</td>
- </tr>
- <tr>
- <td>operator_roles = admin, swiftoperator</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>reseller_admin_role = ResellerAdmin</td><td>No help text available for this option.</td>
- </tr>
+ <tr>
+ <td>operator_roles = admin, swiftoperator</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>reseller_admin_role = ResellerAdmin</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>use = egg:swift#keystoneauth</td>
+ <td>Entry point of paste.deploy in the server</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-proxy-server-filter-list-endpoints.xml b/doc/common/tables/swift-proxy-server-filter-list-endpoints.xml
index b0dbe9df4a..1a36b989fa 100644
--- a/doc/common/tables/swift-proxy-server-filter-list-endpoints.xml
+++ b/doc/common/tables/swift-proxy-server-filter-list-endpoints.xml
@@ -1,25 +1,29 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[filter:list-endpoints]</literal> in <literal>proxy-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[filter-list-endpoints]</literal> in <literal>proxy-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>use = egg:swift#list_endpoints</td><td>Entry point of paste.deploy in the server</td>
- </tr>
- <tr>
- <td>list_endpoints_path = /endpoints/</td><td>No help text available for this option.</td>
- </tr>
+ <tr>
+ <td>list_endpoints_path = /endpoints/</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>use = egg:swift#list_endpoints</td>
+ <td>Entry point of paste.deploy in the server</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-proxy-server-filter-name_check.xml b/doc/common/tables/swift-proxy-server-filter-name_check.xml
index 4a8f28268b..a2bd1b9202 100644
--- a/doc/common/tables/swift-proxy-server-filter-name_check.xml
+++ b/doc/common/tables/swift-proxy-server-filter-name_check.xml
@@ -1,31 +1,37 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[filter:name_check]</literal> in <literal>proxy-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[filter-name_check]</literal> in <literal>proxy-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>use = egg:swift#name_check</td><td>Entry point of paste.deploy in the server</td>
- </tr>
- <tr>
- <td>forbidden_chars = '"`<></td><td>Characters that are not allowed in a name</td>
- </tr>
- <tr>
- <td>maximum_length = 255</td><td>Maximum length of a name</td>
- </tr>
- <tr>
- <td>forbidden_regexp = /\./|/\.\./|/\.$|/\.\.$</td><td>Substrings to forbid, using regular expression syntax</td>
- </tr>
+ <tr>
+ <td>forbidden_chars = '"`<></td>
+ <td>Characters that are not allowed in a name</td>
+ </tr>
+ <tr>
+ <td>forbidden_regexp = /\./|/\.\./|/\.$|/\.\.$</td>
+ <td>Substrings to forbid, using regular expression syntax</td>
+ </tr>
+ <tr>
+ <td>maximum_length = 255</td>
+ <td>Maximum length of a name</td>
+ </tr>
+ <tr>
+ <td>use = egg:swift#name_check</td>
+ <td>Entry point of paste.deploy in the server</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-proxy-server-filter-proxy-logging.xml b/doc/common/tables/swift-proxy-server-filter-proxy-logging.xml
index 8715045a7f..61b65ca17a 100644
--- a/doc/common/tables/swift-proxy-server-filter-proxy-logging.xml
+++ b/doc/common/tables/swift-proxy-server-filter-proxy-logging.xml
@@ -1,78 +1,97 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[filter:proxy-logging]</literal> in <literal>proxy-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[filter-proxy-logging]</literal> in <literal>proxy-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>use = egg:swift#proxy_logging</td><td>Entry point of paste.deploy in the server</td>
- </tr>
- <tr>
- <td>access_log_name = swift</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>access_log_facility = LOG_LOCAL0</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>access_log_level = INFO</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>access_log_address = /dev/log</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>access_log_udp_host = </td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>access_log_udp_port = 514</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>access_log_statsd_host = localhost</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>access_log_statsd_port = 8125</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>access_log_statsd_default_sample_rate = 1.0</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>access_log_statsd_sample_rate_factor = 1.0</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>access_log_statsd_metric_prefix = </td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>access_log_headers = false</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>access_log_headers_only = </td><td>If access_log_headers is True and access_log_headers_only is set only
+ <tr>
+ <td>access_log_address = /dev/log</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>access_log_facility = LOG_LOCAL0</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>access_log_headers = false</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>access_log_headers_only = </td>
+ <td>If access_log_headers is True and access_log_headers_only is set only
these headers are logged. Multiple headers can be defined as comma separated list like this:
access_log_headers_only = Host, X-Object-Meta-Mtime</td>
- </tr>
- <tr>
- <td>logged with access_log_headers = True.</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>reveal_sensitive_prefix = 8192</td><td>
+ </tr>
+ <tr>
+ <td>access_log_level = INFO</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>access_log_name = swift</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>access_log_statsd_default_sample_rate = 1.0</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>access_log_statsd_host = localhost</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>access_log_statsd_metric_prefix = </td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>access_log_statsd_port = 8125</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>access_log_statsd_sample_rate_factor = 1.0</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>access_log_udp_host = </td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>access_log_udp_port = 514</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>log_statsd_valid_http_methods = GET,HEAD,POST,PUT,DELETE,COPY,OPTIONS</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>logged with access_log_headers = True.</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>reveal_sensitive_prefix = 16</td>
+ <td>
The X-Auth-Token is sensitive data. If revealed to an unauthorised person,
they can now make requests against an account until the token expires.
Set reveal_sensitive_prefix to the number of characters of the token that are logged.
For example reveal_sensitive_prefix = 12 so only first 12 characters of the token are logged.
Or, set to 0 to completely remove the token.</td>
- </tr>
- <tr>
- <td>log_statsd_valid_http_methods = GET,HEAD,POST,PUT,DELETE,COPY,OPTIONS</td><td>No help text available for this option.</td>
- </tr>
+ </tr>
+ <tr>
+ <td>use = egg:swift#proxy_logging</td>
+ <td>Entry point of paste.deploy in the server</td>
+ </tr>
</tbody>
- </table>
- </para>
+ </table>
+</para>
diff --git a/doc/common/tables/swift-proxy-server-filter-ratelimit.xml b/doc/common/tables/swift-proxy-server-filter-ratelimit.xml
index 5b59aa219d..dbd3c6657b 100644
--- a/doc/common/tables/swift-proxy-server-filter-ratelimit.xml
+++ b/doc/common/tables/swift-proxy-server-filter-ratelimit.xml
@@ -1,79 +1,101 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[filter:ratelimit]</literal> in <literal>proxy-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[filter-ratelimit]</literal> in <literal>proxy-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>use = egg:swift#ratelimit</td><td>Entry point of paste.deploy in the server</td>
- </tr>
- <tr>
- <td>set log_name = ratelimit</td><td>Label to use when logging</td>
- </tr>
- <tr>
- <td>set log_facility = LOG_LOCAL0</td><td>Syslog log facility</td>
- </tr>
- <tr>
- <td>set log_level = INFO</td><td>Log level</td>
- </tr>
- <tr>
- <td>set log_headers = false</td><td>If True, log headers in each request</td>
- </tr>
- <tr>
- <td>set log_address = /dev/log</td><td>Location where syslog sends the logs to</td>
- </tr>
- <tr>
- <td>clock_accuracy = 1000</td><td>Represents how accurate the proxy servers' system clocks are with each other. 1000 means that all the proxies' clock are accurate to each other within 1 millisecond. No ratelimit should be higher than the clock accuracy.</td>
- </tr>
- <tr>
- <td>max_sleep_time_seconds = 60</td><td>App will immediately return a 498 response if the necessary sleep time ever exceeds the given max_sleep_time_seconds.</td>
- </tr>
- <tr>
- <td>log_sleep_time_seconds = 0</td><td>To allow visibility into rate limiting set this value > 0 and all sleeps greater than the number will be logged.</td>
- </tr>
- <tr>
- <td>rate_buffer_seconds = 5</td><td>Number of seconds the rate counter can drop and be allowed to catch up (at a faster than listed rate). A larger number will result in larger spikes in rate but better average accuracy.</td>
- </tr>
- <tr>
- <td>account_ratelimit = 0</td><td>If set, will limit PUT and DELETE requests to /account_name/container_name. Number is in requests per second.</td>
- </tr>
- <tr>
- <td>account_whitelist = a,b</td><td>Comma separated lists of account names that will not be rate limited.</td>
- </tr>
- <tr>
- <td>account_blacklist = c,d</td><td>Comma separated lists of account names that will not be allowed. Returns a 497 response. r: for containers of size x, limit requests per second to r. Will limit PUT, DELETE, and POST requests to /a/c/o. container_listing_ratelimit_x = r: for containers of size x, limit listing requests per second to r. Will limit GET requests to /a/c.</td>
- </tr>
- <tr>
- <td>with container_limit_x = r</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>container_ratelimit_0 = 100</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>container_ratelimit_10 = 50</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>container_ratelimit_50 = 20</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>container_listing_ratelimit_0 = 100</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>container_listing_ratelimit_10 = 50</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>container_listing_ratelimit_50 = 20</td><td>No help text available for this option.</td>
- </tr>
+ <tr>
+ <td>account_blacklist = c,d</td>
+ <td>Comma separated lists of account names that will not be allowed. Returns a 497 response. r: for containers of size x, limit requests per second to r. Will limit PUT, DELETE, and POST requests to /a/c/o. container_listing_ratelimit_x = r: for containers of size x, limit listing requests per second to r. Will limit GET requests to /a/c.</td>
+ </tr>
+ <tr>
+ <td>account_ratelimit = 0</td>
+ <td>If set, will limit PUT and DELETE requests to /account_name/container_name. Number is in requests per second.</td>
+ </tr>
+ <tr>
+ <td>account_whitelist = a,b</td>
+ <td>Comma separated lists of account names that will not be rate limited.</td>
+ </tr>
+ <tr>
+ <td>clock_accuracy = 1000</td>
+ <td>Represents how accurate the proxy servers' system clocks are with each other. 1000 means that all the proxies' clock are accurate to each other within 1 millisecond. No ratelimit should be higher than the clock accuracy.</td>
+ </tr>
+ <tr>
+ <td>container_listing_ratelimit_0 = 100</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>container_listing_ratelimit_10 = 50</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>container_listing_ratelimit_50 = 20</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>container_ratelimit_0 = 100</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>container_ratelimit_10 = 50</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>container_ratelimit_50 = 20</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>log_sleep_time_seconds = 0</td>
+ <td>To allow visibility into rate limiting set this value > 0 and all sleeps greater than the number will be logged.</td>
+ </tr>
+ <tr>
+ <td>max_sleep_time_seconds = 60</td>
+ <td>App will immediately return a 498 response if the necessary sleep time ever exceeds the given max_sleep_time_seconds.</td>
+ </tr>
+ <tr>
+ <td>rate_buffer_seconds = 5</td>
+ <td>Number of seconds the rate counter can drop and be allowed to catch up (at a faster than listed rate). A larger number will result in larger spikes in rate but better average accuracy.</td>
+ </tr>
+ <tr>
+ <td>set log_address = /dev/log</td>
+ <td>Location where syslog sends the logs to</td>
+ </tr>
+ <tr>
+ <td>set log_facility = LOG_LOCAL0</td>
+ <td>Syslog log facility</td>
+ </tr>
+ <tr>
+ <td>set log_headers = false</td>
+ <td>If True, log headers in each request</td>
+ </tr>
+ <tr>
+ <td>set log_level = INFO</td>
+ <td>Log level</td>
+ </tr>
+ <tr>
+ <td>set log_name = ratelimit</td>
+ <td>Label to use when logging</td>
+ </tr>
+ <tr>
+ <td>use = egg:swift#ratelimit</td>
+ <td>Entry point of paste.deploy in the server</td>
+ </tr>
+ <tr>
+ <td>with container_limit_x = r</td>
+ <td>No help text available for this option.</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-proxy-server-filter-slo.xml b/doc/common/tables/swift-proxy-server-filter-slo.xml
index a886c4e776..366391dd20 100644
--- a/doc/common/tables/swift-proxy-server-filter-slo.xml
+++ b/doc/common/tables/swift-proxy-server-filter-slo.xml
@@ -1,40 +1,49 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[filter:slo]</literal> in <literal>proxy-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[filter-slo]</literal> in <literal>proxy-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>use = egg:swift#slo</td><td>Entry point of paste.deploy in the server</td>
- </tr>
- <tr>
- <td>max_manifest_segments = 1000</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>max_manifest_size = 2097152</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>min_segment_size = 1048576</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>rate_limit_after_segment = 10</td><td>Rate limit the download of large object segments after this segment is downloaded.</td>
- </tr>
- <tr>
- <td>rate_limit_segments_per_sec = 0</td><td>Rate limit large object downloads at this rate. contact for a normal request. You can use '* replicas' at the end to have it use the number given times the number of replicas for the ring being used for the request. paste.deploy to use for auth. To use tempauth set to: `egg:swift#tempauth` each request</td>
- </tr>
- <tr>
- <td>max_get_time = 86400</td><td>No help text available for this option.</td>
- </tr>
+ <tr>
+ <td>max_get_time = 86400</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>max_manifest_segments = 1000</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>max_manifest_size = 2097152</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>min_segment_size = 1048576</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>rate_limit_after_segment = 10</td>
+ <td>Rate limit the download of large object segments after this segment is downloaded.</td>
+ </tr>
+ <tr>
+ <td>rate_limit_segments_per_sec = 0</td>
+ <td>Rate limit large object downloads at this rate. contact for a normal request. You can use '* replicas' at the end to have it use the number given times the number of replicas for the ring being used for the request. paste.deploy to use for auth. To use tempauth set to: `egg:swift#tempauth` each request</td>
+ </tr>
+ <tr>
+ <td>use = egg:swift#slo</td>
+ <td>Entry point of paste.deploy in the server</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-proxy-server-filter-staticweb.xml b/doc/common/tables/swift-proxy-server-filter-staticweb.xml
index 0c2e6c704a..b1c7cfefd8 100644
--- a/doc/common/tables/swift-proxy-server-filter-staticweb.xml
+++ b/doc/common/tables/swift-proxy-server-filter-staticweb.xml
@@ -1,22 +1,25 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[filter:staticweb]</literal> in <literal>proxy-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[filter-staticweb]</literal> in <literal>proxy-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>use = egg:swift#staticweb</td><td>Entry point of paste.deploy in the server</td>
- </tr>
+ <tr>
+ <td>use = egg:swift#staticweb</td>
+ <td>Entry point of paste.deploy in the server</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-proxy-server-filter-tempauth.xml b/doc/common/tables/swift-proxy-server-filter-tempauth.xml
index 3cb2a4fb0b..f94ce288d8 100644
--- a/doc/common/tables/swift-proxy-server-filter-tempauth.xml
+++ b/doc/common/tables/swift-proxy-server-filter-tempauth.xml
@@ -1,64 +1,81 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[filter:tempauth]</literal> in <literal>proxy-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[filter-tempauth]</literal> in <literal>proxy-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>use = egg:swift#tempauth</td><td>Entry point of paste.deploy in the server</td>
- </tr>
- <tr>
- <td>set log_name = tempauth</td><td>Label to use when logging</td>
- </tr>
- <tr>
- <td>set log_facility = LOG_LOCAL0</td><td>Syslog log facility</td>
- </tr>
- <tr>
- <td>set log_level = INFO</td><td>Log level</td>
- </tr>
- <tr>
- <td>set log_headers = false</td><td>If True, log headers in each request</td>
- </tr>
- <tr>
- <td>set log_address = /dev/log</td><td>Location where syslog sends the logs to</td>
- </tr>
- <tr>
- <td>reseller_prefix = AUTH</td><td>The naming scope for the auth service. Swift</td>
- </tr>
- <tr>
- <td>auth_prefix = /auth/</td><td>The HTTP request path prefix for the auth service. Swift itself reserves anything beginning with the letter `v`.</td>
- </tr>
- <tr>
- <td>token_life = 86400</td><td>The number of seconds a token is valid.</td>
- </tr>
- <tr>
- <td>allow_overrides = true</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>storage_url_scheme = default</td><td>Scheme to return with storage urls: http, https, or default (chooses based on what the server is running as) This can be useful with an SSL load balancer in front of a non-SSL server.</td>
- </tr>
- <tr>
- <td>user_admin_admin = admin .admin .reseller_admin</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>user_test_tester = testing .admin</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>user_test2_tester2 = testing2 .admin</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>user_test_tester3 = testing3</td><td>No help text available for this option.</td>
- </tr>
+ <tr>
+ <td>allow_overrides = true</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>auth_prefix = /auth/</td>
+ <td>The HTTP request path prefix for the auth service. Swift itself reserves anything beginning with the letter `v`.</td>
+ </tr>
+ <tr>
+ <td>reseller_prefix = AUTH</td>
+ <td>The naming scope for the auth service. Swift</td>
+ </tr>
+ <tr>
+ <td>set log_address = /dev/log</td>
+ <td>Location where syslog sends the logs to</td>
+ </tr>
+ <tr>
+ <td>set log_facility = LOG_LOCAL0</td>
+ <td>Syslog log facility</td>
+ </tr>
+ <tr>
+ <td>set log_headers = false</td>
+ <td>If True, log headers in each request</td>
+ </tr>
+ <tr>
+ <td>set log_level = INFO</td>
+ <td>Log level</td>
+ </tr>
+ <tr>
+ <td>set log_name = tempauth</td>
+ <td>Label to use when logging</td>
+ </tr>
+ <tr>
+ <td>storage_url_scheme = default</td>
+ <td>Scheme to return with storage urls: http, https, or default (chooses based on what the server is running as) This can be useful with an SSL load balancer in front of a non-SSL server.</td>
+ </tr>
+ <tr>
+ <td>token_life = 86400</td>
+ <td>The number of seconds a token is valid.</td>
+ </tr>
+ <tr>
+ <td>use = egg:swift#tempauth</td>
+ <td>Entry point of paste.deploy in the server</td>
+ </tr>
+ <tr>
+ <td>user_admin_admin = admin .admin .reseller_admin</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>user_test2_tester2 = testing2 .admin</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>user_test_tester = testing .admin</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>user_test_tester3 = testing3</td>
+ <td>No help text available for this option.</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-proxy-server-filter-tempurl.xml b/doc/common/tables/swift-proxy-server-filter-tempurl.xml
index 3bb0193cf0..bc3d6b4876 100644
--- a/doc/common/tables/swift-proxy-server-filter-tempurl.xml
+++ b/doc/common/tables/swift-proxy-server-filter-tempurl.xml
@@ -1,43 +1,51 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[filter:tempurl]</literal> in <literal>proxy-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[filter-tempurl]</literal> in <literal>proxy-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>use = egg:swift#tempurl</td><td>Entry point of paste.deploy in the server</td>
- </tr>
- <tr>
- <td>methods = GET HEAD PUT</td><td>HTTP methods allowed with Temporary URLs</td>
- </tr>
- <tr>
- <td>incoming_remove_headers = x-timestamp</td><td>Headers to remove from incoming requests. Simply a whitespace delimited list of header names and
- names can optionally end with '*' to indicate a prefix match.</td>
- </tr>
- <tr>
- <td>incoming_allow_headers = </td><td>Headers allowed as exceptions to incoming_remove_headers. Simply a whitespace
+ <tr>
+ <td>incoming_allow_headers = </td>
+ <td>Headers allowed as exceptions to incoming_remove_headers. Simply a whitespace
delimited list of header names and names can optionally end with '*' to indicate
a prefix match.</td>
- </tr>
- <tr>
- <td>outgoing_remove_headers = x-object-meta-*</td><td>Headers to remove from outgoing responses. Simply a whitespace delimited list of
+ </tr>
+ <tr>
+ <td>incoming_remove_headers = x-timestamp</td>
+ <td>Headers to remove from incoming requests. Simply a whitespace delimited list of header names and
+ names can optionally end with '*' to indicate a prefix match.</td>
+ </tr>
+ <tr>
+ <td>methods = GET HEAD PUT</td>
+ <td>HTTP methods allowed with Temporary URLs</td>
+ </tr>
+ <tr>
+ <td>outgoing_allow_headers = x-object-meta-public-*</td>
+ <td>Headers allowed as exceptions to outgoing_allow_headers. Simply a whitespace delimited list of
+ header names and names can optionally end with '*' to indicate a prefix match.</td>
+ </tr>
+ <tr>
+ <td>outgoing_remove_headers = x-object-meta-*</td>
+ <td>Headers to remove from outgoing responses. Simply a whitespace delimited list of
header names and names can optionally end with '*' to indicate a prefix
match.</td>
- </tr>
- <tr>
- <td>outgoing_allow_headers = x-object-meta-public-*</td><td>Headers allowed as exceptions to outgoing_allow_headers. Simply a whitespace delimited list of
- header names and names can optionally end with '*' to indicate a prefix match.</td>
- </tr>
+ </tr>
+ <tr>
+ <td>use = egg:swift#tempurl</td>
+ <td>Entry point of paste.deploy in the server</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-proxy-server-filter-xprofile.xml b/doc/common/tables/swift-proxy-server-filter-xprofile.xml
new file mode 100644
index 0000000000..94bb2ea5c5
--- /dev/null
+++ b/doc/common/tables/swift-proxy-server-filter-xprofile.xml
@@ -0,0 +1,53 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[filter-xprofile]</literal> in <literal>proxy-server.conf</literal>
+ </caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>dump_interval = 5.0</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>dump_timestamp = false</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>flush_at_shutdown = false</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>log_filename_prefix = /tmp/log/swift/profile/default.profile</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>path = /__profile__</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>profile_module = eventlet.green.profile</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>unwind = false</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>use = egg:swift#xprofile</td>
+ <td>Entry point of paste.deploy in the server</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/swift-proxy-server-pipeline-main.xml b/doc/common/tables/swift-proxy-server-pipeline-main.xml
index e6afc880f2..cf11da5661 100644
--- a/doc/common/tables/swift-proxy-server-pipeline-main.xml
+++ b/doc/common/tables/swift-proxy-server-pipeline-main.xml
@@ -1,22 +1,25 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[pipeline:main]</literal> in <literal>proxy-server.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[pipeline-main]</literal> in <literal>proxy-server.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>pipeline = catch_errors gatekeeper healthcheck proxy-logging cache container_sync bulk tempurl slo dlo ratelimit tempauth container-quotas account-quotas proxy-logging proxy-server</td><td>No help text available for this option.</td>
- </tr>
+ <tr>
+ <td>pipeline = catch_errors gatekeeper healthcheck proxy-logging cache container_sync bulk tempurl ratelimit tempauth container-quotas account-quotas slo dlo proxy-logging proxy-server</td>
+ <td>No help text available for this option.</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-rsyncd-account.xml b/doc/common/tables/swift-rsyncd-account.xml
index 13a4d8bb7b..d5cb13c569 100644
--- a/doc/common/tables/swift-rsyncd-account.xml
+++ b/doc/common/tables/swift-rsyncd-account.xml
@@ -1,31 +1,37 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[account]</literal> in <literal>rsyncd.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[account]</literal> in <literal>rsyncd.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>max connections = 2</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>path = /srv/node</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>read only = false</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>lock file = /var/lock/account.lock</td><td>No help text available for this option.</td>
- </tr>
+ <tr>
+ <td>lock file = /var/lock/account.lock</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>max connections = 2</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>path = /srv/node</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>read only = false</td>
+ <td>No help text available for this option.</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-rsyncd-container.xml b/doc/common/tables/swift-rsyncd-container.xml
index 8b2a071fba..d11e2bcb61 100644
--- a/doc/common/tables/swift-rsyncd-container.xml
+++ b/doc/common/tables/swift-rsyncd-container.xml
@@ -1,31 +1,37 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[container]</literal> in <literal>rsyncd.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[container]</literal> in <literal>rsyncd.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>max connections = 4</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>path = /srv/node</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>read only = false</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>lock file = /var/lock/container.lock</td><td>No help text available for this option.</td>
- </tr>
+ <tr>
+ <td>lock file = /var/lock/container.lock</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>max connections = 4</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>path = /srv/node</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>read only = false</td>
+ <td>No help text available for this option.</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-rsyncd-object.xml b/doc/common/tables/swift-rsyncd-object.xml
index ab5dc5d003..cbfdc7aaf7 100644
--- a/doc/common/tables/swift-rsyncd-object.xml
+++ b/doc/common/tables/swift-rsyncd-object.xml
@@ -1,31 +1,37 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[object]</literal> in <literal>rsyncd.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[object]</literal> in <literal>rsyncd.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>max connections = 8</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>path = /srv/node</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>read only = false</td><td>No help text available for this option.</td>
- </tr>
- <tr>
- <td>lock file = /var/lock/object.lock</td><td>No help text available for this option.</td>
- </tr>
+ <tr>
+ <td>lock file = /var/lock/object.lock</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>max connections = 8</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>path = /srv/node</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>read only = false</td>
+ <td>No help text available for this option.</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-swift-storage-policy-0.xml b/doc/common/tables/swift-swift-storage-policy-0.xml
new file mode 100644
index 0000000000..9da7ed239b
--- /dev/null
+++ b/doc/common/tables/swift-swift-storage-policy-0.xml
@@ -0,0 +1,29 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[storage-policy-0]</literal> in <literal>swift.conf</literal>
+ </caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>default = yes</td>
+ <td>0 means to not use a per-disk thread pool. It is recommended to keep this value small, as large values can result in high read latencies due to large queue depths. A good starting point is 4 threads per disk.</td>
+ </tr>
+ <tr>
+ <td>name = Policy-0</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/swift-swift-storage-policy-1.xml b/doc/common/tables/swift-swift-storage-policy-1.xml
new file mode 100644
index 0000000000..73332b2163
--- /dev/null
+++ b/doc/common/tables/swift-swift-storage-policy-1.xml
@@ -0,0 +1,25 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[storage-policy-1]</literal> in <literal>swift.conf</literal>
+ </caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>name = silver</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/swift-swift-swift-constraints.xml b/doc/common/tables/swift-swift-swift-constraints.xml
index 1bcf0295f8..d6753c3b1f 100644
--- a/doc/common/tables/swift-swift-swift-constraints.xml
+++ b/doc/common/tables/swift-swift-swift-constraints.xml
@@ -1,74 +1,65 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[swift-constraints]</literal> in <literal>swift.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[swift-constraints]</literal> in <literal>swift.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>max_file_size = 5368709122</td><td>The largest normal object that can be
- saved in the cluster. This is also the
- limit on the size of each segment of a
- large object when using the large object
- manifest support. This value is set in
- bytes. Setting it to lower than 1MiB will
- cause some tests to fail. It is STRONGLY
- recommended to leave this value at the
- default (5 * 2**30 + 2).</td>
- </tr>
- <tr>
- <td>max_meta_name_length = 128</td><td>The maximum number of bytes in the utf8
- encoding of the name portion of a metadata
- header.</td>
- </tr>
- <tr>
- <td>max_meta_value_length = 256</td><td>The max number of bytes in the utf8
- encoding of a metadata value.</td>
- </tr>
- <tr>
- <td>max_meta_count = 90</td><td>The maximum number of metadata keys that can
- be stored on a single account, container,
- or object.</td>
- </tr>
- <tr>
- <td>max_meta_overall_size = 4096</td><td>The maximum number of bytes in the utf8
- encoding of the metadata (keys +
- values).</td>
- </tr>
- <tr>
- <td>max_header_size = 8192</td><td>The maximum number of bytes in the utf8
- encoding of each header.</td>
- </tr>
- <tr>
- <td>max_object_name_length = 1024</td><td>The maximum number of bytes in the utf8
- encoding of an object name.</td>
- </tr>
- <tr>
- <td>container_listing_limit = 10000</td><td>The default (and maximum) number of items
- returned for a container listing
- request.</td>
- </tr>
- <tr>
- <td>account_listing_limit = 10000</td><td>The default (and maximum) number of items
- returned for an account listing request.</td>
- </tr>
- <tr>
- <td>max_account_name_length = 256</td><td>The maximum number of bytes in the utf8
- encoding of an account name.</td>
- </tr>
- <tr>
- <td>max_container_name_length = 256</td><td>The maximum number of bytes in the utf8
- encoding of a container name.</td>
- </tr>
+ <tr>
+ <td>account_listing_limit = 10000</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>container_listing_limit = 10000</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>max_account_name_length = 256</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>max_container_name_length = 256</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>max_file_size = 5368709122</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>max_header_size = 8192</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>max_meta_count = 90</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>max_meta_name_length = 128</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>max_meta_overall_size = 4096</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>max_meta_value_length = 256</td>
+ <td>No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>max_object_name_length = 1024</td>
+ <td>No help text available for this option.</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/swift-swift-swift-hash.xml b/doc/common/tables/swift-swift-swift-hash.xml
index d6198630f3..cc36f1d510 100644
--- a/doc/common/tables/swift-swift-swift-hash.xml
+++ b/doc/common/tables/swift-swift-swift-hash.xml
@@ -1,32 +1,24 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- The tool that generated this table lives in the
- openstack-doc-tools repository. The editions made in
- this file will *not* be lost if you run the script again. -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all">
- <caption>Description of configuration options for <literal>[swift-hash]</literal> in <literal>swift.conf-sample</literal></caption>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- The tool that generated this table lives in the
+ openstack-doc-tools repository. The editions made in
+ this file will *not* be lost if you run the script again. -->
+ <table rules="all">
+ <caption>Description of configuration options for
+ <literal>[swift-hash]</literal> in <literal>swift.conf</literal>
+ </caption>
<col width="50%"/>
<col width="50%"/>
<thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
</thead>
<tbody>
- <tr>
- <td>swift_hash_path_suffix = changeme</td><td>
- A suffix used by hash_path to offer a bit more security when generating hashes for
- paths. It simply appends this value to all paths; if someone knows this suffix,
- it's easier for them to guess the hash a path will end up with.
- New installations are advised to set this parameter to a random secret,
- which would not be disclosed ouside the organization.
- The same secret needs to be used by all swift servers of the same cluster.
-
- Existing installations should set this parameter to an empty string.</td>
- </tr>
- <tr>
- <td>swift_hash_path_prefix = changeme</td><td>
+ <tr>
+ <td>swift_hash_path_prefix = changeme</td>
+ <td>
A prefix used by hash_path to offer a bit more security when generating hashes for
paths. It simply appends this value to all paths; if someone knows this suffix,
it's easier for them to guess the hash a path will end up with.
@@ -35,7 +27,19 @@
The same secret needs to be used by all swift servers of the same cluster.
Existing installations should set this parameter to an empty string.</td>
- </tr>
+ </tr>
+ <tr>
+ <td>swift_hash_path_suffix = changeme</td>
+ <td>
+ A suffix used by hash_path to offer a bit more security when generating hashes for
+ paths. It simply appends this value to all paths; if someone knows this suffix,
+ it's easier for them to guess the hash a path will end up with.
+ New installations are advised to set this parameter to a random secret,
+ which would not be disclosed ouside the organization.
+ The same secret needs to be used by all swift servers of the same cluster.
+
+ Existing installations should set this parameter to an empty string.</td>
+ </tr>
</tbody>
- </table>
- </para>
\ No newline at end of file
+ </table>
+</para>
diff --git a/doc/common/tables/trove-amqp.xml b/doc/common/tables/trove-amqp.xml
index 0e63f61db8..2a49c825a9 100644
--- a/doc/common/tables/trove-amqp.xml
+++ b/doc/common/tables/trove-amqp.xml
@@ -1,71 +1,70 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_trove_amqp">
- <caption>Description of configuration options for amqp</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>amqp_auto_delete = False</td>
- <td>(BoolOpt) Auto-delete queues in amqp.</td>
- </tr>
- <tr>
- <td>amqp_durable_queues = False</td>
- <td>(BoolOpt) Use durable queues in amqp.</td>
- </tr>
- <tr>
- <td>conductor_queue = trove-conductor</td>
- <td>(StrOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>control_exchange = openstack</td>
- <td>(StrOpt) AMQP exchange to connect to if using RabbitMQ or Qpid</td>
- </tr>
- <tr>
- <td>fake_rabbit = False</td>
- <td>(BoolOpt) If passed, use a fake RabbitMQ provider</td>
- </tr>
- <tr>
- <td>kombu_ssl_ca_certs = </td>
- <td>(StrOpt) SSL certification authority file (valid only if SSL enabled)</td>
- </tr>
- <tr>
- <td>kombu_ssl_certfile = </td>
- <td>(StrOpt) SSL cert file (valid only if SSL enabled)</td>
- </tr>
- <tr>
- <td>kombu_ssl_keyfile = </td>
- <td>(StrOpt) SSL key file (valid only if SSL enabled)</td>
- </tr>
- <tr>
- <td>kombu_ssl_version = </td>
- <td>(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions</td>
- </tr>
- <tr>
- <td>notification_driver = []</td>
- <td>(MultiStrOpt) Driver or drivers to handle sending notifications</td>
- </tr>
- <tr>
- <td>notification_service_id = {'couchbase': 'fa62fe68-74d9-4779-a24e-36f19602c415', 'mongodb': 'c8c907af-7375-456f-b929-b637ff9209ee', 'cassandra': '459a230d-4e97-4344-9067-2a54a310b0ed', 'redis': 'b216ffc5-1947-456c-a4cf-70f94c05f7d0', 'mysql': '2f3ff068-2bfb-4f70-9a9d-a6bb65bc084b'}</td>
- <td>(DictOpt) Unique ID to tag notification events.</td>
- </tr>
- <tr>
- <td>notification_topics = notifications</td>
- <td>(ListOpt) AMQP topic used for openstack notifications</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_trove_amqp">
+ <caption>Description of configuration options for amqp</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>amqp_auto_delete = False</td>
+ <td>(BoolOpt) Auto-delete queues in amqp.</td>
+ </tr>
+ <tr>
+ <td>amqp_durable_queues = False</td>
+ <td>(BoolOpt) Use durable queues in amqp.</td>
+ </tr>
+ <tr>
+ <td>conductor_queue = trove-conductor</td>
+ <td>(StrOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>control_exchange = openstack</td>
+ <td>(StrOpt) AMQP exchange to connect to if using RabbitMQ or Qpid</td>
+ </tr>
+ <tr>
+ <td>fake_rabbit = False</td>
+ <td>(BoolOpt) If passed, use a fake RabbitMQ provider</td>
+ </tr>
+ <tr>
+ <td>kombu_ssl_ca_certs = </td>
+ <td>(StrOpt) SSL certification authority file (valid only if SSL enabled)</td>
+ </tr>
+ <tr>
+ <td>kombu_ssl_certfile = </td>
+ <td>(StrOpt) SSL cert file (valid only if SSL enabled)</td>
+ </tr>
+ <tr>
+ <td>kombu_ssl_keyfile = </td>
+ <td>(StrOpt) SSL key file (valid only if SSL enabled)</td>
+ </tr>
+ <tr>
+ <td>kombu_ssl_version = </td>
+ <td>(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions</td>
+ </tr>
+ <tr>
+ <td>notification_driver = []</td>
+ <td>(MultiStrOpt) Driver or drivers to handle sending notifications</td>
+ </tr>
+ <tr>
+ <td>notification_service_id = {'couchbase': 'fa62fe68-74d9-4779-a24e-36f19602c415', 'mongodb': 'c8c907af-7375-456f-b929-b637ff9209ee', 'cassandra': '459a230d-4e97-4344-9067-2a54a310b0ed', 'redis': 'b216ffc5-1947-456c-a4cf-70f94c05f7d0', 'mysql': '2f3ff068-2bfb-4f70-9a9d-a6bb65bc084b'}</td>
+ <td>(DictOpt) Unique ID to tag notification events.</td>
+ </tr>
+ <tr>
+ <td>notification_topics = notifications</td>
+ <td>(ListOpt) AMQP topic used for openstack notifications</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/trove-api.xml b/doc/common/tables/trove-api.xml
index 758b3c67fd..e2513254ca 100644
--- a/doc/common/tables/trove-api.xml
+++ b/doc/common/tables/trove-api.xml
@@ -1,107 +1,114 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_trove_api">
- <caption>Description of configuration options for api</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>admin_roles = admin</td>
- <td>(ListOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>api_extensions_path = trove/extensions/routes</td>
- <td>(StrOpt) Path to extensions.</td>
- </tr>
- <tr>
- <td>api_paste_config = api-paste.ini</td>
- <td>(StrOpt) File name for the paste.deploy config for trove-api.</td>
- </tr>
- <tr>
- <td>bind_port = 8779</td>
- <td>(IntOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>db_api_implementation = trove.db.sqlalchemy.api</td>
- <td>(StrOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>hostname_require_ipv4 = True</td>
- <td>(BoolOpt) Require user hostnames to be IPv4 addresses.</td>
- </tr>
- <tr>
- <td>http_delete_rate = 200</td>
- <td>(IntOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>http_get_rate = 200</td>
- <td>(IntOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>http_post_rate = 200</td>
- <td>(IntOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>http_put_rate = 200</td>
- <td>(IntOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>instances_page_size = 20</td>
- <td>(IntOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>max_header_line = 16384</td>
- <td>(IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs</td>
- </tr>
- <tr>
- <td>region = LOCAL_DEV</td>
- <td>(StrOpt) The region this service is located.</td>
- </tr>
- <tr>
- <td>tcp_keepidle = 600</td>
- <td>(IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X.</td>
- </tr>
- <tr>
- <td>trove_api_workers = None</td>
- <td>(IntOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>trove_auth_url = http://0.0.0.0:5000/v2.0</td>
- <td>(StrOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>trove_conductor_workers = 1</td>
- <td>(IntOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>trove_security_group_name_prefix = SecGroup</td>
- <td>(StrOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>trove_security_group_rule_cidr = 0.0.0.0/0</td>
- <td>(StrOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>trove_security_groups_support = True</td>
- <td>(BoolOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>users_page_size = 20</td>
- <td>(IntOpt) No help text available for this option.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_trove_api">
+ <caption>Description of configuration options for api</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>admin_roles = admin</td>
+ <td>(ListOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>api_extensions_path = $pybasedir/extensions/routes</td>
+ <td>(StrOpt) Path to extensions.</td>
+ </tr>
+ <tr>
+ <td>api_paste_config = api-paste.ini</td>
+ <td>(StrOpt) File name for the paste.deploy config for trove-api.</td>
+ </tr>
+ <tr>
+ <td>bind_port = 8779</td>
+ <td>(IntOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>db_api_implementation = trove.db.sqlalchemy.api</td>
+ <td>(StrOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>hostname_require_ipv4 = True</td>
+ <td>(BoolOpt) Require user hostnames to be IPv4 addresses.</td>
+ </tr>
+ <tr>
+ <td>http_delete_rate = 200</td>
+ <td>(IntOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>http_get_rate = 200</td>
+ <td>(IntOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>http_mgmt_post_rate = 200</td>
+ <td>(IntOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>http_post_rate = 200</td>
+ <td>(IntOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>http_put_rate = 200</td>
+ <td>(IntOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>instances_page_size = 20</td>
+ <td>(IntOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>max_header_line = 16384</td>
+ <td>(IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs).</td>
+ </tr>
+ <tr>
+ <td>os_region_name = None</td>
+ <td>(StrOpt) Region name of this node. Used when searching catalog.</td>
+ </tr>
+ <tr>
+ <td>region = LOCAL_DEV</td>
+ <td>(StrOpt) The region this service is located.</td>
+ </tr>
+ <tr>
+ <td>tcp_keepidle = 600</td>
+ <td>(IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X.</td>
+ </tr>
+ <tr>
+ <td>trove_api_workers = None</td>
+ <td>(IntOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>trove_auth_url = http://0.0.0.0:5000/v2.0</td>
+ <td>(StrOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>trove_conductor_workers = 1</td>
+ <td>(IntOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>trove_security_group_name_prefix = SecGroup</td>
+ <td>(StrOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>trove_security_group_rule_cidr = 0.0.0.0/0</td>
+ <td>(StrOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>trove_security_groups_support = True</td>
+ <td>(BoolOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>users_page_size = 20</td>
+ <td>(IntOpt) No help text available for this option.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/trove-auth_token.xml b/doc/common/tables/trove-auth_token.xml
index 975c31a7fe..9412dd9be8 100644
--- a/doc/common/tables/trove-auth_token.xml
+++ b/doc/common/tables/trove-auth_token.xml
@@ -1,134 +1,145 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_trove_auth_token">
- <caption>Description of configuration options for auth_token</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>memcached_servers = None</td>
- <td>(ListOpt) Memcached servers or None for in process cache.</td>
- </tr>
- <tr>
- <th colspan="2">[keystone_authtoken]</th>
- </tr>
- <tr>
- <td>admin_password = None</td>
- <td>(StrOpt) Keystone account password</td>
- </tr>
- <tr>
- <td>admin_tenant_name = admin</td>
- <td>(StrOpt) Keystone service account tenant name to validate user tokens</td>
- </tr>
- <tr>
- <td>admin_token = None</td>
- <td>(StrOpt) Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process.</td>
- </tr>
- <tr>
- <td>admin_user = None</td>
- <td>(StrOpt) Keystone account username</td>
- </tr>
- <tr>
- <td>auth_admin_prefix = </td>
- <td>(StrOpt) Prefix to prepend at the beginning of the path</td>
- </tr>
- <tr>
- <td>auth_host = 127.0.0.1</td>
- <td>(StrOpt) Host providing the admin Identity API endpoint</td>
- </tr>
- <tr>
- <td>auth_port = 35357</td>
- <td>(IntOpt) Port of the admin Identity API endpoint</td>
- </tr>
- <tr>
- <td>auth_protocol = https</td>
- <td>(StrOpt) Protocol of the admin Identity API endpoint(http or https)</td>
- </tr>
- <tr>
- <td>auth_uri = None</td>
- <td>(StrOpt) Complete public Identity API endpoint</td>
- </tr>
- <tr>
- <td>auth_version = None</td>
- <td>(StrOpt) API version of the admin Identity API endpoint</td>
- </tr>
- <tr>
- <td>cache = None</td>
- <td>(StrOpt) Env key for the swift cache</td>
- </tr>
- <tr>
- <td>cafile = None</td>
- <td>(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.</td>
- </tr>
- <tr>
- <td>certfile = None</td>
- <td>(StrOpt) Required if Keystone server requires client certificate</td>
- </tr>
- <tr>
- <td>delay_auth_decision = False</td>
- <td>(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components</td>
- </tr>
- <tr>
- <td>enforce_token_bind = permissive</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>http_connect_timeout = None</td>
- <td>(BoolOpt) Request timeout value for communicating with Identity API server.</td>
- </tr>
- <tr>
- <td>http_request_max_retries = 3</td>
- <td>(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server.</td>
- </tr>
- <tr>
- <td>include_service_catalog = True</td>
- <td>(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.</td>
- </tr>
- <tr>
- <td>insecure = False</td>
- <td>(BoolOpt) Verify HTTPS connections.</td>
- </tr>
- <tr>
- <td>keyfile = None</td>
- <td>(StrOpt) Required if Keystone server requires client certificate</td>
- </tr>
- <tr>
- <td>memcache_secret_key = None</td>
- <td>(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation.</td>
- </tr>
- <tr>
- <td>memcache_security_strategy = None</td>
- <td>(StrOpt) (optional) if defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.</td>
- </tr>
- <tr>
- <td>memcached_servers = None</td>
- <td>(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.</td>
- </tr>
- <tr>
- <td>revocation_cache_time = 300</td>
- <td>(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.</td>
- </tr>
- <tr>
- <td>signing_dir = None</td>
- <td>(StrOpt) Directory used to cache files related to PKI tokens</td>
- </tr>
- <tr>
- <td>token_cache_time = 300</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>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_trove_auth_token">
+ <caption>Description of configuration options for auth_token</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>memcached_servers = None</td>
+ <td>(ListOpt) Memcached servers or None for in process cache.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[keystone_authtoken]</th>
+ </tr>
+ <tr>
+ <td>admin_password = None</td>
+ <td>(StrOpt) Keystone account password</td>
+ </tr>
+ <tr>
+ <td>admin_tenant_name = admin</td>
+ <td>(StrOpt) Keystone service account tenant name to validate user tokens</td>
+ </tr>
+ <tr>
+ <td>admin_token = None</td>
+ <td>(StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead.</td>
+ </tr>
+ <tr>
+ <td>admin_user = None</td>
+ <td>(StrOpt) Keystone account username</td>
+ </tr>
+ <tr>
+ <td>auth_admin_prefix = </td>
+ <td>(StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri.</td>
+ </tr>
+ <tr>
+ <td>auth_host = 127.0.0.1</td>
+ <td>(StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri.</td>
+ </tr>
+ <tr>
+ <td>auth_port = 35357</td>
+ <td>(IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri.</td>
+ </tr>
+ <tr>
+ <td>auth_protocol = https</td>
+ <td>(StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri.</td>
+ </tr>
+ <tr>
+ <td>auth_uri = None</td>
+ <td>(StrOpt) Complete public Identity API endpoint</td>
+ </tr>
+ <tr>
+ <td>auth_version = None</td>
+ <td>(StrOpt) API version of the admin Identity API endpoint</td>
+ </tr>
+ <tr>
+ <td>cache = None</td>
+ <td>(StrOpt) Env key for the swift cache</td>
+ </tr>
+ <tr>
+ <td>cafile = None</td>
+ <td>(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.</td>
+ </tr>
+ <tr>
+ <td>certfile = None</td>
+ <td>(StrOpt) Required if Keystone server requires client certificate</td>
+ </tr>
+ <tr>
+ <td>check_revocations_for_cached = False</td>
+ <td>(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the Keystone server.</td>
+ </tr>
+ <tr>
+ <td>delay_auth_decision = False</td>
+ <td>(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components</td>
+ </tr>
+ <tr>
+ <td>enforce_token_bind = permissive</td>
+ <td>(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens.</td>
+ </tr>
+ <tr>
+ <td>hash_algorithms = md5</td>
+ <td>(ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance.</td>
+ </tr>
+ <tr>
+ <td>http_connect_timeout = None</td>
+ <td>(BoolOpt) Request timeout value for communicating with Identity API server.</td>
+ </tr>
+ <tr>
+ <td>http_request_max_retries = 3</td>
+ <td>(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server.</td>
+ </tr>
+ <tr>
+ <td>identity_uri = None</td>
+ <td>(StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/</td>
+ </tr>
+ <tr>
+ <td>include_service_catalog = True</td>
+ <td>(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.</td>
+ </tr>
+ <tr>
+ <td>insecure = False</td>
+ <td>(BoolOpt) Verify HTTPS connections.</td>
+ </tr>
+ <tr>
+ <td>keyfile = None</td>
+ <td>(StrOpt) Required if Keystone server requires client certificate</td>
+ </tr>
+ <tr>
+ <td>memcache_secret_key = None</td>
+ <td>(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation.</td>
+ </tr>
+ <tr>
+ <td>memcache_security_strategy = None</td>
+ <td>(StrOpt) (optional) if defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.</td>
+ </tr>
+ <tr>
+ <td>memcached_servers = None</td>
+ <td>(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.</td>
+ </tr>
+ <tr>
+ <td>revocation_cache_time = 10</td>
+ <td>(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.</td>
+ </tr>
+ <tr>
+ <td>signing_dir = None</td>
+ <td>(StrOpt) Directory used to cache files related to PKI tokens</td>
+ </tr>
+ <tr>
+ <td>token_cache_time = 300</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>
diff --git a/doc/common/tables/trove-backup.xml b/doc/common/tables/trove-backup.xml
index 6cb78522bf..1d5713b9ca 100644
--- a/doc/common/tables/trove-backup.xml
+++ b/doc/common/tables/trove-backup.xml
@@ -1,75 +1,74 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_trove_backup">
- <caption>Description of configuration options for backup</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>backup_aes_cbc_key = default_aes_cbc_key</td>
- <td>(StrOpt) Default OpenSSL aes_cbc key.</td>
- </tr>
- <tr>
- <td>backup_chunk_size = 65536</td>
- <td>(IntOpt) Chunk size to stream to swift container. This should be in multiples of 128 bytes, since this is the size of an md5 digest block allowing the process to update the file checksum during streaming. See: http://stackoverflow.com/questions/1131220/</td>
- </tr>
- <tr>
- <td>backup_incremental_strategy = {'InnoBackupEx': 'InnoBackupExIncremental'}</td>
- <td>(DictOpt) Incremental Backup Runner Based off of the default strategy. For strategies that do not implement an incremental the runner will use the default full backup.</td>
- </tr>
- <tr>
- <td>backup_namespace = trove.guestagent.strategies.backup.mysql_impl</td>
- <td>(StrOpt) Namespace to load backup strategies from.</td>
- </tr>
- <tr>
- <td>backup_runner = trove.guestagent.backup.backup_types.InnoBackupEx</td>
- <td>(StrOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>backup_runner_options = {}</td>
- <td>(DictOpt) Additional options to be passed to the backup runner.</td>
- </tr>
- <tr>
- <td>backup_segment_max_size = 2147483648</td>
- <td>(IntOpt) Maximum size of each segment of the backup file.</td>
- </tr>
- <tr>
- <td>backup_strategy = InnoBackupEx</td>
- <td>(StrOpt) Default strategy to perform backups.</td>
- </tr>
- <tr>
- <td>backup_swift_container = database_backups</td>
- <td>(StrOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>backup_use_gzip_compression = True</td>
- <td>(BoolOpt) Compress backups using gzip.</td>
- </tr>
- <tr>
- <td>backup_use_openssl_encryption = True</td>
- <td>(BoolOpt) Encrypt backups using OpenSSL.</td>
- </tr>
- <tr>
- <td>backup_use_snet = False</td>
- <td>(BoolOpt) Send backup files over snet.</td>
- </tr>
- <tr>
- <td>backups_page_size = 20</td>
- <td>(IntOpt) No help text available for this option.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_trove_backup">
+ <caption>Description of configuration options for backup</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>backup_aes_cbc_key = default_aes_cbc_key</td>
+ <td>(StrOpt) Default OpenSSL aes_cbc key.</td>
+ </tr>
+ <tr>
+ <td>backup_chunk_size = 65536</td>
+ <td>(IntOpt) Chunk size to stream to swift container. This should be in multiples of 128 bytes, since this is the size of an md5 digest block allowing the process to update the file checksum during streaming. See: http://stackoverflow.com/questions/1131220/</td>
+ </tr>
+ <tr>
+ <td>backup_incremental_strategy = {'InnoBackupEx': 'InnoBackupExIncremental'}</td>
+ <td>(DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup.</td>
+ </tr>
+ <tr>
+ <td>backup_namespace = trove.guestagent.strategies.backup.mysql_impl</td>
+ <td>(StrOpt) Namespace to load backup strategies from.</td>
+ </tr>
+ <tr>
+ <td>backup_runner = trove.guestagent.backup.backup_types.InnoBackupEx</td>
+ <td>(StrOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>backup_runner_options = {}</td>
+ <td>(DictOpt) Additional options to be passed to the backup runner.</td>
+ </tr>
+ <tr>
+ <td>backup_segment_max_size = 2147483648</td>
+ <td>(IntOpt) Maximum size of each segment of the backup file.</td>
+ </tr>
+ <tr>
+ <td>backup_strategy = InnoBackupEx</td>
+ <td>(StrOpt) Default strategy to perform backups.</td>
+ </tr>
+ <tr>
+ <td>backup_swift_container = database_backups</td>
+ <td>(StrOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>backup_use_gzip_compression = True</td>
+ <td>(BoolOpt) Compress backups using gzip.</td>
+ </tr>
+ <tr>
+ <td>backup_use_openssl_encryption = True</td>
+ <td>(BoolOpt) Encrypt backups using OpenSSL.</td>
+ </tr>
+ <tr>
+ <td>backup_use_snet = False</td>
+ <td>(BoolOpt) Send backup files over snet.</td>
+ </tr>
+ <tr>
+ <td>backups_page_size = 20</td>
+ <td>(IntOpt) No help text available for this option.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/trove-common.xml b/doc/common/tables/trove-common.xml
index 163e6d1c31..2cb00160dd 100644
--- a/doc/common/tables/trove-common.xml
+++ b/doc/common/tables/trove-common.xml
@@ -1,79 +1,78 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_trove_common">
- <caption>Description of configuration options for common</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>configurations_page_size = 20</td>
- <td>(IntOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>databases_page_size = 20</td>
- <td>(IntOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>default_datastore = None</td>
- <td>(StrOpt) The default datastore id or name to use if one is not provided by the user. If the default value is None, the field becomes required in the instance-create request.</td>
- </tr>
- <tr>
- <td>default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, iso8601=WARN</td>
- <td>(ListOpt) list of logger=LEVEL pairs</td>
- </tr>
- <tr>
- <td>default_neutron_networks = </td>
- <td>(ListOpt) List of network IDs which should be attached to instance when networks are not specified in API call.</td>
- </tr>
- <tr>
- <td>default_notification_level = INFO</td>
- <td>(StrOpt) Default notification level for outgoing notifications</td>
- </tr>
- <tr>
- <td>default_password_length = 36</td>
- <td>(IntOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>default_publisher_id = $host</td>
- <td>(StrOpt) Default publisher_id for outgoing notifications</td>
- </tr>
- <tr>
- <td>expected_filetype_suffixes = json</td>
- <td>(ListOpt) Filetype endings not to be reattached to an id by the utils method correct_id_with_req.</td>
- </tr>
- <tr>
- <td>lock_path = None</td>
- <td>(StrOpt) Directory to use for lock files.</td>
- </tr>
- <tr>
- <td>pybasedir = /usr/lib/python/site-packages/trove</td>
- <td>(StrOpt) Directory where the trove python module is installed.</td>
- </tr>
- <tr>
- <td>pydev_path = None</td>
- <td>(StrOpt) Set path to pydevd library, used if pydevd is not found in python sys.path.</td>
- </tr>
- <tr>
- <td>taskmanager_queue = taskmanager</td>
- <td>(StrOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>template_path = /etc/trove/templates/</td>
- <td>(StrOpt) Path which leads to datastore templates.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_trove_common">
+ <caption>Description of configuration options for common</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>configurations_page_size = 20</td>
+ <td>(IntOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>databases_page_size = 20</td>
+ <td>(IntOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>default_datastore = None</td>
+ <td>(StrOpt) The default datastore id or name to use if one is not provided by the user. If the default value is None, the field becomes required in the instance-create request.</td>
+ </tr>
+ <tr>
+ <td>default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, iso8601=WARN</td>
+ <td>(ListOpt) list of logger=LEVEL pairs</td>
+ </tr>
+ <tr>
+ <td>default_neutron_networks = </td>
+ <td>(ListOpt) List of network IDs which should be attached to instance when networks are not specified in API call.</td>
+ </tr>
+ <tr>
+ <td>default_notification_level = INFO</td>
+ <td>(StrOpt) Default notification level for outgoing notifications</td>
+ </tr>
+ <tr>
+ <td>default_password_length = 36</td>
+ <td>(IntOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>default_publisher_id = $host</td>
+ <td>(StrOpt) Default publisher_id for outgoing notifications</td>
+ </tr>
+ <tr>
+ <td>expected_filetype_suffixes = json</td>
+ <td>(ListOpt) Filetype endings not to be reattached to an ID by the utils method correct_id_with_req.</td>
+ </tr>
+ <tr>
+ <td>lock_path = None</td>
+ <td>(StrOpt) Directory to use for lock files.</td>
+ </tr>
+ <tr>
+ <td>pybasedir = /usr/lib/python/site-packages/sources/trove/trove</td>
+ <td>(StrOpt) Directory where the trove python module is installed.</td>
+ </tr>
+ <tr>
+ <td>pydev_path = None</td>
+ <td>(StrOpt) Set path to pydevd library, used if pydevd is not found in python sys.path.</td>
+ </tr>
+ <tr>
+ <td>taskmanager_queue = taskmanager</td>
+ <td>(StrOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>template_path = /etc/trove/templates/</td>
+ <td>(StrOpt) Path which leads to datastore templates.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/trove-compute.xml b/doc/common/tables/trove-compute.xml
index ea1ade0887..cdde818abd 100644
--- a/doc/common/tables/trove-compute.xml
+++ b/doc/common/tables/trove-compute.xml
@@ -1,39 +1,42 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_trove_compute">
- <caption>Description of configuration options for compute</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>ip_regex = None</td>
- <td>(StrOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>nova_compute_url = http://localhost:8774/v2</td>
- <td>(StrOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>root_grant = ALL</td>
- <td>(ListOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>root_grant_option = True</td>
- <td>(BoolOpt) No help text available for this option.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_trove_compute">
+ <caption>Description of configuration options for compute</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>ip_regex = None</td>
+ <td>(StrOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>nova_compute_service_type = compute</td>
+ <td>(StrOpt) Service type to use when searching catalog.</td>
+ </tr>
+ <tr>
+ <td>nova_compute_url = None</td>
+ <td>(StrOpt) URL without the tenant segment.</td>
+ </tr>
+ <tr>
+ <td>root_grant = ALL</td>
+ <td>(ListOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>root_grant_option = True</td>
+ <td>(BoolOpt) No help text available for this option.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/trove-database.xml b/doc/common/tables/trove-database.xml
index 7b05e0467c..2ff4555d2e 100644
--- a/doc/common/tables/trove-database.xml
+++ b/doc/common/tables/trove-database.xml
@@ -1,39 +1,38 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_trove_database">
- <caption>Description of configuration options for database</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>sql_connection = sqlite:///trove_test.sqlite</td>
- <td>(StrOpt) SQL Connection.</td>
- </tr>
- <tr>
- <td>sql_idle_timeout = 3600</td>
- <td>(IntOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>sql_query_log = False</td>
- <td>(BoolOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>sql_query_logging = False</td>
- <td>(BoolOpt) Allow insecure logging while executing queries through SQLAlchemy.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_trove_database">
+ <caption>Description of configuration options for database</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>sql_connection = sqlite:///trove_test.sqlite</td>
+ <td>(StrOpt) SQL Connection.</td>
+ </tr>
+ <tr>
+ <td>sql_idle_timeout = 3600</td>
+ <td>(IntOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>sql_query_log = False</td>
+ <td>(BoolOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>sql_query_logging = False</td>
+ <td>(BoolOpt) Allow insecure logging while executing queries through SQLAlchemy.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/trove-db_cassandra.xml b/doc/common/tables/trove-db_cassandra.xml
index 7a7198863e..8ec9b6e187 100644
--- a/doc/common/tables/trove-db_cassandra.xml
+++ b/doc/common/tables/trove-db_cassandra.xml
@@ -1,43 +1,42 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_trove_db_cassandra">
- <caption>Description of configuration options for db_cassandra</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[cassandra]</th>
- </tr>
- <tr>
- <td>backup_strategy = None</td>
- <td>(StrOpt) Default strategy to perform backups.</td>
- </tr>
- <tr>
- <td>mount_point = /var/lib/cassandra</td>
- <td>(StrOpt) Filesystem path for mounting volumes if volume support is enabled</td>
- </tr>
- <tr>
- <td>tcp_ports = 7000, 7001, 9042, 9160</td>
- <td>(ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True)</td>
- </tr>
- <tr>
- <td>udp_ports = </td>
- <td>(ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True)</td>
- </tr>
- <tr>
- <td>usage_timeout = 600</td>
- <td>(IntOpt) Timeout to wait for a guest to become active.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_trove_db_cassandra">
+ <caption>Description of configuration options for db_cassandra</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[cassandra]</th>
+ </tr>
+ <tr>
+ <td>backup_strategy = None</td>
+ <td>(StrOpt) Default strategy to perform backups.</td>
+ </tr>
+ <tr>
+ <td>mount_point = /var/lib/cassandra</td>
+ <td>(StrOpt) Filesystem path for mounting volumes if volume support is enabled.</td>
+ </tr>
+ <tr>
+ <td>tcp_ports = 7000, 7001, 9042, 9160</td>
+ <td>(ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).</td>
+ </tr>
+ <tr>
+ <td>udp_ports = </td>
+ <td>(ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).</td>
+ </tr>
+ <tr>
+ <td>usage_timeout = 600</td>
+ <td>(IntOpt) Timeout to wait for a guest to become active.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/trove-db_couchbase.xml b/doc/common/tables/trove-db_couchbase.xml
index e54928a029..8cb901de13 100644
--- a/doc/common/tables/trove-db_couchbase.xml
+++ b/doc/common/tables/trove-db_couchbase.xml
@@ -1,43 +1,46 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_trove_db_couchbase">
- <caption>Description of configuration options for db_couchbase</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[couchbase]</th>
- </tr>
- <tr>
- <td>backup_strategy = None</td>
- <td>(StrOpt) Default strategy to perform backups.</td>
- </tr>
- <tr>
- <td>mount_point = /var/lib/couchbase</td>
- <td>(StrOpt) Filesystem path for mounting volumes if volume support is enabled</td>
- </tr>
- <tr>
- <td>tcp_ports = 8091, 8092, 4369, 11209-11211, 21100-21199</td>
- <td>(ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True)</td>
- </tr>
- <tr>
- <td>udp_ports = </td>
- <td>(ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True)</td>
- </tr>
- <tr>
- <td>usage_timeout = 450</td>
- <td>(IntOpt) Timeout to wait for a guest to become active.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_trove_db_couchbase">
+ <caption>Description of configuration options for db_couchbase</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[couchbase]</th>
+ </tr>
+ <tr>
+ <td>backup_strategy = None</td>
+ <td>(StrOpt) Default strategy to perform backups.</td>
+ </tr>
+ <tr>
+ <td>mount_point = /var/lib/couchbase</td>
+ <td>(StrOpt) Filesystem path for mounting volumes if volume support is enabled.</td>
+ </tr>
+ <tr>
+ <td>root_on_create = True</td>
+ <td>(BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the 'password' field.</td>
+ </tr>
+ <tr>
+ <td>tcp_ports = 8091, 8092, 4369, 11209-11211, 21100-21199</td>
+ <td>(ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).</td>
+ </tr>
+ <tr>
+ <td>udp_ports = </td>
+ <td>(ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).</td>
+ </tr>
+ <tr>
+ <td>usage_timeout = 450</td>
+ <td>(IntOpt) Timeout to wait for a guest to become active.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/trove-db_mongodb.xml b/doc/common/tables/trove-db_mongodb.xml
index c7efcdef50..474447e8d3 100644
--- a/doc/common/tables/trove-db_mongodb.xml
+++ b/doc/common/tables/trove-db_mongodb.xml
@@ -1,43 +1,42 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_trove_db_mongodb">
- <caption>Description of configuration options for db_mongodb</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[mongodb]</th>
- </tr>
- <tr>
- <td>backup_strategy = None</td>
- <td>(StrOpt) Default strategy to perform backups.</td>
- </tr>
- <tr>
- <td>mount_point = /var/lib/mongodb</td>
- <td>(StrOpt) Filesystem path for mounting volumes if volume support is enabled</td>
- </tr>
- <tr>
- <td>tcp_ports = 2500, 27017</td>
- <td>(ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True)</td>
- </tr>
- <tr>
- <td>udp_ports = </td>
- <td>(ListOpt) List of UPD ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True)</td>
- </tr>
- <tr>
- <td>usage_timeout = 450</td>
- <td>(IntOpt) Timeout to wait for a guest to become active.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_trove_db_mongodb">
+ <caption>Description of configuration options for db_mongodb</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[mongodb]</th>
+ </tr>
+ <tr>
+ <td>backup_strategy = None</td>
+ <td>(StrOpt) Default strategy to perform backups.</td>
+ </tr>
+ <tr>
+ <td>mount_point = /var/lib/mongodb</td>
+ <td>(StrOpt) Filesystem path for mounting volumes if volume support is enabled.</td>
+ </tr>
+ <tr>
+ <td>tcp_ports = 2500, 27017</td>
+ <td>(ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).</td>
+ </tr>
+ <tr>
+ <td>udp_ports = </td>
+ <td>(ListOpt) List of UPD ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).</td>
+ </tr>
+ <tr>
+ <td>usage_timeout = 450</td>
+ <td>(IntOpt) Timeout to wait for a guest to become active.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/trove-db_mysql.xml b/doc/common/tables/trove-db_mysql.xml
index 3553963e6b..d9235ab88f 100644
--- a/doc/common/tables/trove-db_mysql.xml
+++ b/doc/common/tables/trove-db_mysql.xml
@@ -1,47 +1,46 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_trove_db_mysql">
- <caption>Description of configuration options for db_mysql</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[mysql]</th>
- </tr>
- <tr>
- <td>backup_strategy = InnoBackupEx</td>
- <td>(StrOpt) Default strategy to perform backups.</td>
- </tr>
- <tr>
- <td>mount_point = /var/lib/mysql</td>
- <td>(StrOpt) Filesystem path for mounting volumes if volume support is enabled</td>
- </tr>
- <tr>
- <td>root_on_create = False</td>
- <td>(BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the 'password' field.</td>
- </tr>
- <tr>
- <td>tcp_ports = 3306</td>
- <td>(ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True)</td>
- </tr>
- <tr>
- <td>udp_ports = </td>
- <td>(ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True)</td>
- </tr>
- <tr>
- <td>usage_timeout = 400</td>
- <td>(IntOpt) Timeout to wait for a guest to become active.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_trove_db_mysql">
+ <caption>Description of configuration options for db_mysql</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[mysql]</th>
+ </tr>
+ <tr>
+ <td>backup_strategy = InnoBackupEx</td>
+ <td>(StrOpt) Default strategy to perform backups.</td>
+ </tr>
+ <tr>
+ <td>mount_point = /var/lib/mysql</td>
+ <td>(StrOpt) Filesystem path for mounting volumes if volume support is enabled.</td>
+ </tr>
+ <tr>
+ <td>root_on_create = False</td>
+ <td>(BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the 'password' field.</td>
+ </tr>
+ <tr>
+ <td>tcp_ports = 3306</td>
+ <td>(ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).</td>
+ </tr>
+ <tr>
+ <td>udp_ports = </td>
+ <td>(ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).</td>
+ </tr>
+ <tr>
+ <td>usage_timeout = 400</td>
+ <td>(IntOpt) Timeout to wait for a guest to become active.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/trove-db_percona.xml b/doc/common/tables/trove-db_percona.xml
index 1179d38ea2..0c55d6e10e 100644
--- a/doc/common/tables/trove-db_percona.xml
+++ b/doc/common/tables/trove-db_percona.xml
@@ -1,47 +1,46 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_trove_db_percona">
- <caption>Description of configuration options for db_percona</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[percona]</th>
- </tr>
- <tr>
- <td>backup_strategy = InnoBackupEx</td>
- <td>(StrOpt) Default strategy to perform backups.</td>
- </tr>
- <tr>
- <td>mount_point = /var/lib/mysql</td>
- <td>(StrOpt) Filesystem path for mounting volumes if volume support is enabled</td>
- </tr>
- <tr>
- <td>root_on_create = False</td>
- <td>(BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the 'password' field.</td>
- </tr>
- <tr>
- <td>tcp_ports = 3306</td>
- <td>(ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True)</td>
- </tr>
- <tr>
- <td>udp_ports = </td>
- <td>(ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True)</td>
- </tr>
- <tr>
- <td>usage_timeout = 450</td>
- <td>(IntOpt) Timeout to wait for a guest to become active.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_trove_db_percona">
+ <caption>Description of configuration options for db_percona</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[percona]</th>
+ </tr>
+ <tr>
+ <td>backup_strategy = InnoBackupEx</td>
+ <td>(StrOpt) Default strategy to perform backups.</td>
+ </tr>
+ <tr>
+ <td>mount_point = /var/lib/mysql</td>
+ <td>(StrOpt) Filesystem path for mounting volumes if volume support is enabled.</td>
+ </tr>
+ <tr>
+ <td>root_on_create = False</td>
+ <td>(BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the 'password' field.</td>
+ </tr>
+ <tr>
+ <td>tcp_ports = 3306</td>
+ <td>(ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).</td>
+ </tr>
+ <tr>
+ <td>udp_ports = </td>
+ <td>(ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).</td>
+ </tr>
+ <tr>
+ <td>usage_timeout = 450</td>
+ <td>(IntOpt) Timeout to wait for a guest to become active.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/trove-db_redis.xml b/doc/common/tables/trove-db_redis.xml
index 777d5d3289..876e2f244c 100644
--- a/doc/common/tables/trove-db_redis.xml
+++ b/doc/common/tables/trove-db_redis.xml
@@ -1,43 +1,42 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_trove_db_redis">
- <caption>Description of configuration options for db_redis</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[redis]</th>
- </tr>
- <tr>
- <td>backup_strategy = None</td>
- <td>(StrOpt) Default strategy to perform backups.</td>
- </tr>
- <tr>
- <td>mount_point = /var/lib/redis</td>
- <td>(StrOpt) Filesystem path for mounting volumes if volume support is enabled</td>
- </tr>
- <tr>
- <td>tcp_ports = 6379</td>
- <td>(ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True)</td>
- </tr>
- <tr>
- <td>udp_ports = </td>
- <td>(ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True)</td>
- </tr>
- <tr>
- <td>usage_timeout = 450</td>
- <td>(IntOpt) Timeout to wait for a guest to become active.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_trove_db_redis">
+ <caption>Description of configuration options for db_redis</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[redis]</th>
+ </tr>
+ <tr>
+ <td>backup_strategy = None</td>
+ <td>(StrOpt) Default strategy to perform backups.</td>
+ </tr>
+ <tr>
+ <td>mount_point = /var/lib/redis</td>
+ <td>(StrOpt) Filesystem path for mounting volumes if volume support is enabled.</td>
+ </tr>
+ <tr>
+ <td>tcp_ports = 6379</td>
+ <td>(ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).</td>
+ </tr>
+ <tr>
+ <td>udp_ports = </td>
+ <td>(ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).</td>
+ </tr>
+ <tr>
+ <td>usage_timeout = 450</td>
+ <td>(IntOpt) Timeout to wait for a guest to become active.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/trove-debug.xml b/doc/common/tables/trove-debug.xml
index 1a9de57368..5be83998d1 100644
--- a/doc/common/tables/trove-debug.xml
+++ b/doc/common/tables/trove-debug.xml
@@ -1,83 +1,82 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_trove_debug">
- <caption>Description of configuration options for debug</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>backdoor_port = None</td>
- <td>(StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.</td>
- </tr>
- <tr>
- <td>backlog = 4096</td>
- <td>(IntOpt) Number of backlog requests to configure the socket with</td>
- </tr>
- <tr>
- <td>debug = False</td>
- <td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).</td>
- </tr>
- <tr>
- <td>disable_process_locking = False</td>
- <td>(BoolOpt) Whether to disable inter-process locks</td>
- </tr>
- <tr>
- <td>fatal_deprecations = False</td>
- <td>(BoolOpt) make deprecations fatal</td>
- </tr>
- <tr>
- <td>pydev_debug = disabled</td>
- <td>(StrOpt) Enable or disable pydev remote debugging. If value is 'auto' tries to connect to remote debugger server, but in case of error continues running with debugging disabled.</td>
- </tr>
- <tr>
- <td>pydev_debug_host = None</td>
- <td>(StrOpt) Pydev debug server host (localhost by default).</td>
- </tr>
- <tr>
- <td>pydev_debug_port = None</td>
- <td>(IntOpt) Pydev debug server port (5678 by default).</td>
- </tr>
- <tr>
- <td>remote_cinder_client = trove.common.remote.cinder_client</td>
- <td>(StrOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>remote_dns_client = trove.common.remote.dns_client</td>
- <td>(StrOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>remote_guest_client = trove.common.remote.guest_client</td>
- <td>(StrOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>remote_heat_client = trove.common.remote.heat_client</td>
- <td>(StrOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>remote_nova_client = trove.common.remote.nova_client</td>
- <td>(StrOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>remote_swift_client = trove.common.remote.swift_client</td>
- <td>(StrOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>verbose = False</td>
- <td>(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_trove_debug">
+ <caption>Description of configuration options for debug</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>backdoor_port = None</td>
+ <td>(StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.</td>
+ </tr>
+ <tr>
+ <td>backlog = 4096</td>
+ <td>(IntOpt) Number of backlog requests to configure the socket with</td>
+ </tr>
+ <tr>
+ <td>debug = False</td>
+ <td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).</td>
+ </tr>
+ <tr>
+ <td>disable_process_locking = False</td>
+ <td>(BoolOpt) Whether to disable inter-process locks</td>
+ </tr>
+ <tr>
+ <td>fatal_deprecations = False</td>
+ <td>(BoolOpt) make deprecations fatal</td>
+ </tr>
+ <tr>
+ <td>pydev_debug = disabled</td>
+ <td>(StrOpt) Enable or disable pydev remote debugging. If value is 'auto' tries to connect to remote debugger server, but in case of error continues running with debugging disabled.</td>
+ </tr>
+ <tr>
+ <td>pydev_debug_host = None</td>
+ <td>(StrOpt) Pydev debug server host (localhost by default).</td>
+ </tr>
+ <tr>
+ <td>pydev_debug_port = None</td>
+ <td>(IntOpt) Pydev debug server port (5678 by default).</td>
+ </tr>
+ <tr>
+ <td>remote_cinder_client = trove.common.remote.cinder_client</td>
+ <td>(StrOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>remote_dns_client = trove.common.remote.dns_client</td>
+ <td>(StrOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>remote_guest_client = trove.common.remote.guest_client</td>
+ <td>(StrOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>remote_heat_client = trove.common.remote.heat_client</td>
+ <td>(StrOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>remote_nova_client = trove.common.remote.nova_client</td>
+ <td>(StrOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>remote_swift_client = trove.common.remote.swift_client</td>
+ <td>(StrOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>verbose = False</td>
+ <td>(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/trove-dns.xml b/doc/common/tables/trove-dns.xml
index 61ef6d0aaa..84043ecac3 100644
--- a/doc/common/tables/trove-dns.xml
+++ b/doc/common/tables/trove-dns.xml
@@ -1,87 +1,86 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_trove_dns">
- <caption>Description of configuration options for dns</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>dns_account_id = </td>
- <td>(StrOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>dns_auth_url = </td>
- <td>(StrOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>dns_domain_id = </td>
- <td>(StrOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>dns_domain_name = </td>
- <td>(StrOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>dns_driver = trove.dns.driver.DnsDriver</td>
- <td>(StrOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>dns_endpoint_url = 0.0.0.0</td>
- <td>(StrOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>dns_hostname = </td>
- <td>(StrOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>dns_instance_entry_factory = trove.dns.driver.DnsInstanceEntryFactory</td>
- <td>(StrOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>dns_management_base_url = </td>
- <td>(StrOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>dns_passkey = </td>
- <td>(StrOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>dns_region = </td>
- <td>(StrOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>dns_service_type = </td>
- <td>(StrOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>dns_time_out = 120</td>
- <td>(IntOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>dns_ttl = 300</td>
- <td>(IntOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>dns_username = </td>
- <td>(StrOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>trove_dns_support = False</td>
- <td>(BoolOpt) No help text available for this option.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_trove_dns">
+ <caption>Description of configuration options for dns</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>dns_account_id = </td>
+ <td>(StrOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>dns_auth_url = </td>
+ <td>(StrOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>dns_domain_id = </td>
+ <td>(StrOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>dns_domain_name = </td>
+ <td>(StrOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>dns_driver = trove.dns.driver.DnsDriver</td>
+ <td>(StrOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>dns_endpoint_url = 0.0.0.0</td>
+ <td>(StrOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>dns_hostname = </td>
+ <td>(StrOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>dns_instance_entry_factory = trove.dns.driver.DnsInstanceEntryFactory</td>
+ <td>(StrOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>dns_management_base_url = </td>
+ <td>(StrOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>dns_passkey = </td>
+ <td>(StrOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>dns_region = </td>
+ <td>(StrOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>dns_service_type = </td>
+ <td>(StrOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>dns_time_out = 120</td>
+ <td>(IntOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>dns_ttl = 300</td>
+ <td>(IntOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>dns_username = </td>
+ <td>(StrOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>trove_dns_support = False</td>
+ <td>(BoolOpt) No help text available for this option.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/trove-guestagent.xml b/doc/common/tables/trove-guestagent.xml
index 37e56baa12..ba48d4838a 100644
--- a/doc/common/tables/trove-guestagent.xml
+++ b/doc/common/tables/trove-guestagent.xml
@@ -1,71 +1,70 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_trove_guestagent">
- <caption>Description of configuration options for guestagent</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>agent_call_high_timeout = 60</td>
- <td>(IntOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>agent_call_low_timeout = 5</td>
- <td>(IntOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>agent_heartbeat_time = 10</td>
- <td>(IntOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>guest_config = $pybasedir/etc/trove/trove-guestagent.conf.sample</td>
- <td>(StrOpt) Path to guestagent config file.</td>
- </tr>
- <tr>
- <td>guest_id = None</td>
- <td>(StrOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>ignore_dbs = lost+found, mysql, information_schema</td>
- <td>(ListOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>ignore_users = os_admin, root</td>
- <td>(ListOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>mount_options = defaults,noatime</td>
- <td>(StrOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>restore_namespace = trove.guestagent.strategies.restore.mysql_impl</td>
- <td>(StrOpt) Namespace to load restore strategies from.</td>
- </tr>
- <tr>
- <td>storage_namespace = trove.guestagent.strategies.storage.swift</td>
- <td>(StrOpt) Namespace to load the default storage strategy from.</td>
- </tr>
- <tr>
- <td>storage_strategy = SwiftStorage</td>
- <td>(StrOpt) Default strategy to store backups.</td>
- </tr>
- <tr>
- <td>usage_sleep_time = 5</td>
- <td>(IntOpt) Time to sleep during the check active guest.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_trove_guestagent">
+ <caption>Description of configuration options for guestagent</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>agent_call_high_timeout = 60</td>
+ <td>(IntOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>agent_call_low_timeout = 5</td>
+ <td>(IntOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>agent_heartbeat_time = 10</td>
+ <td>(IntOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>guest_config = $pybasedir/etc/trove/trove-guestagent.conf.sample</td>
+ <td>(StrOpt) Path to guestagent config file.</td>
+ </tr>
+ <tr>
+ <td>guest_id = None</td>
+ <td>(StrOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>ignore_dbs = lost+found, mysql, information_schema</td>
+ <td>(ListOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>ignore_users = os_admin, root</td>
+ <td>(ListOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>mount_options = defaults,noatime</td>
+ <td>(StrOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>restore_namespace = trove.guestagent.strategies.restore.mysql_impl</td>
+ <td>(StrOpt) Namespace to load restore strategies from.</td>
+ </tr>
+ <tr>
+ <td>storage_namespace = trove.guestagent.strategies.storage.swift</td>
+ <td>(StrOpt) Namespace to load the default storage strategy from.</td>
+ </tr>
+ <tr>
+ <td>storage_strategy = SwiftStorage</td>
+ <td>(StrOpt) Default strategy to store backups.</td>
+ </tr>
+ <tr>
+ <td>usage_sleep_time = 5</td>
+ <td>(IntOpt) Time to sleep during the check active guest.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/trove-heat.xml b/doc/common/tables/trove-heat.xml
index a435f9c65f..8e07596be4 100644
--- a/doc/common/tables/trove-heat.xml
+++ b/doc/common/tables/trove-heat.xml
@@ -1,31 +1,34 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_trove_heat">
- <caption>Description of configuration options for heat</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>heat_time_out = 60</td>
- <td>(IntOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>heat_url = http://localhost:8004/v1</td>
- <td>(StrOpt) No help text available for this option.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_trove_heat">
+ <caption>Description of configuration options for heat</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>heat_service_type = orchestration</td>
+ <td>(StrOpt) Service type to use when searching catalog.</td>
+ </tr>
+ <tr>
+ <td>heat_time_out = 60</td>
+ <td>(IntOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>heat_url = None</td>
+ <td>(StrOpt) URL without the tenant segment.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/trove-logging.xml b/doc/common/tables/trove-logging.xml
index dccf339f3c..42740a6195 100644
--- a/doc/common/tables/trove-logging.xml
+++ b/doc/common/tables/trove-logging.xml
@@ -1,91 +1,90 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_trove_logging">
- <caption>Description of configuration options for logging</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>format_options = -m 5</td>
- <td>(StrOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>instance_format = "[instance: %(uuid)s] "</td>
- <td>(StrOpt) If an instance is passed with the log message, format it like this</td>
- </tr>
- <tr>
- <td>instance_uuid_format = "[instance: %(uuid)s] "</td>
- <td>(StrOpt) If an instance UUID is passed with the log message, format it like this</td>
- </tr>
- <tr>
- <td>log_config_append = None</td>
- <td>(StrOpt) The name of logging configuration file. It does not disable existing loggers, but just appends specified logging configuration to any other existing logging options. Please see the Python logging module documentation for details on logging configuration files.</td>
- </tr>
- <tr>
- <td>log_date_format = %Y-%m-%d %H:%M:%S</td>
- <td>(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s</td>
- </tr>
- <tr>
- <td>log_dir = None</td>
- <td>(StrOpt) (Optional) The base directory used for relative --log-file paths</td>
- </tr>
- <tr>
- <td>log_file = None</td>
- <td>(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.</td>
- </tr>
- <tr>
- <td>log_format = None</td>
- <td>(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.</td>
- </tr>
- <tr>
- <td>logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s</td>
- <td>(StrOpt) format string to use for log messages with context</td>
- </tr>
- <tr>
- <td>logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d</td>
- <td>(StrOpt) data to append to log format when level is DEBUG</td>
- </tr>
- <tr>
- <td>logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s</td>
- <td>(StrOpt) format string to use for log messages without context</td>
- </tr>
- <tr>
- <td>logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s</td>
- <td>(StrOpt) prefix each line of exception output with this format</td>
- </tr>
- <tr>
- <td>network_label_regex = ^private$</td>
- <td>(StrOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>publish_errors = False</td>
- <td>(BoolOpt) publish error events</td>
- </tr>
- <tr>
- <td>syslog_log_facility = LOG_USER</td>
- <td>(StrOpt) syslog facility to receive log lines</td>
- </tr>
- <tr>
- <td>use_stderr = True</td>
- <td>(BoolOpt) Log output to standard error</td>
- </tr>
- <tr>
- <td>use_syslog = False</td>
- <td>(BoolOpt) Use syslog for logging.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_trove_logging">
+ <caption>Description of configuration options for logging</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>format_options = -m 5</td>
+ <td>(StrOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>instance_format = "[instance: %(uuid)s] "</td>
+ <td>(StrOpt) If an instance is passed with the log message, format it like this</td>
+ </tr>
+ <tr>
+ <td>instance_uuid_format = "[instance: %(uuid)s] "</td>
+ <td>(StrOpt) If an instance UUID is passed with the log message, format it like this</td>
+ </tr>
+ <tr>
+ <td>log_config_append = None</td>
+ <td>(StrOpt) The name of logging configuration file. It does not disable existing loggers, but just appends specified logging configuration to any other existing logging options. Please see the Python logging module documentation for details on logging configuration files.</td>
+ </tr>
+ <tr>
+ <td>log_date_format = %Y-%m-%d %H:%M:%S</td>
+ <td>(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s</td>
+ </tr>
+ <tr>
+ <td>log_dir = None</td>
+ <td>(StrOpt) (Optional) The base directory used for relative --log-file paths</td>
+ </tr>
+ <tr>
+ <td>log_file = None</td>
+ <td>(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.</td>
+ </tr>
+ <tr>
+ <td>log_format = None</td>
+ <td>(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.</td>
+ </tr>
+ <tr>
+ <td>logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s</td>
+ <td>(StrOpt) format string to use for log messages with context</td>
+ </tr>
+ <tr>
+ <td>logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d</td>
+ <td>(StrOpt) data to append to log format when level is DEBUG</td>
+ </tr>
+ <tr>
+ <td>logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s</td>
+ <td>(StrOpt) format string to use for log messages without context</td>
+ </tr>
+ <tr>
+ <td>logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s</td>
+ <td>(StrOpt) prefix each line of exception output with this format</td>
+ </tr>
+ <tr>
+ <td>network_label_regex = ^private$</td>
+ <td>(StrOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>publish_errors = False</td>
+ <td>(BoolOpt) publish error events</td>
+ </tr>
+ <tr>
+ <td>syslog_log_facility = LOG_USER</td>
+ <td>(StrOpt) syslog facility to receive log lines</td>
+ </tr>
+ <tr>
+ <td>use_stderr = True</td>
+ <td>(BoolOpt) Log output to standard error</td>
+ </tr>
+ <tr>
+ <td>use_syslog = False</td>
+ <td>(BoolOpt) Use syslog for logging.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/trove-nova.xml b/doc/common/tables/trove-nova.xml
index c3c8069e09..1572307406 100644
--- a/doc/common/tables/trove-nova.xml
+++ b/doc/common/tables/trove-nova.xml
@@ -1,35 +1,34 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_trove_nova">
- <caption>Description of configuration options for nova</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>nova_proxy_admin_pass = </td>
- <td>(StrOpt) Admin password used to connect to nova,</td>
- </tr>
- <tr>
- <td>nova_proxy_admin_tenant_name = </td>
- <td>(StrOpt) Admin tenant used to connect to nova.</td>
- </tr>
- <tr>
- <td>nova_proxy_admin_user = </td>
- <td>(StrOpt) Admin username used to connect to nova.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_trove_nova">
+ <caption>Description of configuration options for nova</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>nova_proxy_admin_pass = </td>
+ <td>(StrOpt) Admin password used to connect to nova,</td>
+ </tr>
+ <tr>
+ <td>nova_proxy_admin_tenant_name = </td>
+ <td>(StrOpt) Admin tenant used to connect to nova.</td>
+ </tr>
+ <tr>
+ <td>nova_proxy_admin_user = </td>
+ <td>(StrOpt) Admin username used to connect to nova.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/trove-qpid.xml b/doc/common/tables/trove-qpid.xml
index b1848b766a..91cd5d9000 100644
--- a/doc/common/tables/trove-qpid.xml
+++ b/doc/common/tables/trove-qpid.xml
@@ -1,59 +1,58 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_trove_qpid">
- <caption>Description of configuration options for qpid</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>qpid_heartbeat = 60</td>
- <td>(IntOpt) Seconds between connection keepalive heartbeats</td>
- </tr>
- <tr>
- <td>qpid_hostname = localhost</td>
- <td>(StrOpt) Qpid broker hostname</td>
- </tr>
- <tr>
- <td>qpid_hosts = $qpid_hostname:$qpid_port</td>
- <td>(ListOpt) Qpid HA cluster host:port pairs</td>
- </tr>
- <tr>
- <td>qpid_password = </td>
- <td>(StrOpt) Password for qpid connection</td>
- </tr>
- <tr>
- <td>qpid_port = 5672</td>
- <td>(IntOpt) Qpid broker port</td>
- </tr>
- <tr>
- <td>qpid_protocol = tcp</td>
- <td>(StrOpt) Transport to use, either 'tcp' or 'ssl'</td>
- </tr>
- <tr>
- <td>qpid_sasl_mechanisms = </td>
- <td>(StrOpt) Space separated list of SASL mechanisms to use for auth</td>
- </tr>
- <tr>
- <td>qpid_tcp_nodelay = True</td>
- <td>(BoolOpt) Disable Nagle algorithm</td>
- </tr>
- <tr>
- <td>qpid_username = </td>
- <td>(StrOpt) Username for qpid connection</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_trove_qpid">
+ <caption>Description of configuration options for qpid</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>qpid_heartbeat = 60</td>
+ <td>(IntOpt) Seconds between connection keepalive heartbeats</td>
+ </tr>
+ <tr>
+ <td>qpid_hostname = localhost</td>
+ <td>(StrOpt) Qpid broker hostname</td>
+ </tr>
+ <tr>
+ <td>qpid_hosts = $qpid_hostname:$qpid_port</td>
+ <td>(ListOpt) Qpid HA cluster host:port pairs</td>
+ </tr>
+ <tr>
+ <td>qpid_password = </td>
+ <td>(StrOpt) Password for qpid connection</td>
+ </tr>
+ <tr>
+ <td>qpid_port = 5672</td>
+ <td>(IntOpt) Qpid broker port</td>
+ </tr>
+ <tr>
+ <td>qpid_protocol = tcp</td>
+ <td>(StrOpt) Transport to use, either 'tcp' or 'ssl'</td>
+ </tr>
+ <tr>
+ <td>qpid_sasl_mechanisms = </td>
+ <td>(StrOpt) Space separated list of SASL mechanisms to use for auth</td>
+ </tr>
+ <tr>
+ <td>qpid_tcp_nodelay = True</td>
+ <td>(BoolOpt) Disable Nagle algorithm</td>
+ </tr>
+ <tr>
+ <td>qpid_username = </td>
+ <td>(StrOpt) Username for qpid connection</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/trove-quota.xml b/doc/common/tables/trove-quota.xml
index 74d3a6eb04..f1876e8bb4 100644
--- a/doc/common/tables/trove-quota.xml
+++ b/doc/common/tables/trove-quota.xml
@@ -1,43 +1,42 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_trove_quota">
- <caption>Description of configuration options for quota</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>max_accepted_volume_size = 5</td>
- <td>(IntOpt) Default maximum volume size for an instance.</td>
- </tr>
- <tr>
- <td>max_backups_per_user = 50</td>
- <td>(IntOpt) Default maximum number of backups created by a tenant.</td>
- </tr>
- <tr>
- <td>max_instances_per_user = 5</td>
- <td>(IntOpt) Default maximum number of instances per tenant.</td>
- </tr>
- <tr>
- <td>max_volumes_per_user = 20</td>
- <td>(IntOpt) Default maximum volume capacity (in GB) spanning across all trove volumes per tenant</td>
- </tr>
- <tr>
- <td>quota_driver = trove.quota.quota.DbQuotaDriver</td>
- <td>(StrOpt) Default driver to use for quota checks.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_trove_quota">
+ <caption>Description of configuration options for quota</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>max_accepted_volume_size = 5</td>
+ <td>(IntOpt) Default maximum volume size for an instance.</td>
+ </tr>
+ <tr>
+ <td>max_backups_per_user = 50</td>
+ <td>(IntOpt) Default maximum number of backups created by a tenant.</td>
+ </tr>
+ <tr>
+ <td>max_instances_per_user = 5</td>
+ <td>(IntOpt) Default maximum number of instances per tenant.</td>
+ </tr>
+ <tr>
+ <td>max_volumes_per_user = 20</td>
+ <td>(IntOpt) Default maximum volume capacity (in GB) spanning across all trove volumes per tenant.</td>
+ </tr>
+ <tr>
+ <td>quota_driver = trove.quota.quota.DbQuotaDriver</td>
+ <td>(StrOpt) Default driver to use for quota checks.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/trove-rabbitmq.xml b/doc/common/tables/trove-rabbitmq.xml
index 747fb41461..2f1d9372e1 100644
--- a/doc/common/tables/trove-rabbitmq.xml
+++ b/doc/common/tables/trove-rabbitmq.xml
@@ -1,67 +1,66 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_trove_rabbitmq">
- <caption>Description of configuration options for rabbitmq</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>rabbit_ha_queues = False</td>
- <td>(BoolOpt) use H/A queues in RabbitMQ (x-ha-policy: all).You need to wipe RabbitMQ database when changing this option.</td>
- </tr>
- <tr>
- <td>rabbit_host = localhost</td>
- <td>(StrOpt) The RabbitMQ broker address where a single node is used</td>
- </tr>
- <tr>
- <td>rabbit_hosts = $rabbit_host:$rabbit_port</td>
- <td>(ListOpt) RabbitMQ HA cluster host:port pairs</td>
- </tr>
- <tr>
- <td>rabbit_max_retries = 0</td>
- <td>(IntOpt) maximum retries with trying to connect to RabbitMQ (the default of 0 implies an infinite retry count)</td>
- </tr>
- <tr>
- <td>rabbit_password = guest</td>
- <td>(StrOpt) the RabbitMQ password</td>
- </tr>
- <tr>
- <td>rabbit_port = 5672</td>
- <td>(IntOpt) The RabbitMQ broker port where a single node is used</td>
- </tr>
- <tr>
- <td>rabbit_retry_backoff = 2</td>
- <td>(IntOpt) how long to backoff for between retries when connecting to RabbitMQ</td>
- </tr>
- <tr>
- <td>rabbit_retry_interval = 1</td>
- <td>(IntOpt) how frequently to retry connecting with RabbitMQ</td>
- </tr>
- <tr>
- <td>rabbit_use_ssl = False</td>
- <td>(BoolOpt) connect over SSL for RabbitMQ</td>
- </tr>
- <tr>
- <td>rabbit_userid = guest</td>
- <td>(StrOpt) the RabbitMQ userid</td>
- </tr>
- <tr>
- <td>rabbit_virtual_host = /</td>
- <td>(StrOpt) the RabbitMQ virtual host</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_trove_rabbitmq">
+ <caption>Description of configuration options for rabbitmq</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>rabbit_ha_queues = False</td>
+ <td>(BoolOpt) use H/A queues in RabbitMQ (x-ha-policy: all).You need to wipe RabbitMQ database when changing this option.</td>
+ </tr>
+ <tr>
+ <td>rabbit_host = localhost</td>
+ <td>(StrOpt) The RabbitMQ broker address where a single node is used</td>
+ </tr>
+ <tr>
+ <td>rabbit_hosts = $rabbit_host:$rabbit_port</td>
+ <td>(ListOpt) RabbitMQ HA cluster host:port pairs</td>
+ </tr>
+ <tr>
+ <td>rabbit_max_retries = 0</td>
+ <td>(IntOpt) maximum retries with trying to connect to RabbitMQ (the default of 0 implies an infinite retry count)</td>
+ </tr>
+ <tr>
+ <td>rabbit_password = guest</td>
+ <td>(StrOpt) the RabbitMQ password</td>
+ </tr>
+ <tr>
+ <td>rabbit_port = 5672</td>
+ <td>(IntOpt) The RabbitMQ broker port where a single node is used</td>
+ </tr>
+ <tr>
+ <td>rabbit_retry_backoff = 2</td>
+ <td>(IntOpt) how long to backoff for between retries when connecting to RabbitMQ</td>
+ </tr>
+ <tr>
+ <td>rabbit_retry_interval = 1</td>
+ <td>(IntOpt) how frequently to retry connecting with RabbitMQ</td>
+ </tr>
+ <tr>
+ <td>rabbit_use_ssl = False</td>
+ <td>(BoolOpt) connect over SSL for RabbitMQ</td>
+ </tr>
+ <tr>
+ <td>rabbit_userid = guest</td>
+ <td>(StrOpt) the RabbitMQ userid</td>
+ </tr>
+ <tr>
+ <td>rabbit_virtual_host = /</td>
+ <td>(StrOpt) the RabbitMQ virtual host</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/trove-redis.xml b/doc/common/tables/trove-redis.xml
index c8132ab780..57754e951c 100644
--- a/doc/common/tables/trove-redis.xml
+++ b/doc/common/tables/trove-redis.xml
@@ -1,42 +1,41 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_trove_redis">
- <caption>Description of configuration options for redis</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[matchmaker_redis]</th>
- </tr>
- <tr>
- <td>host = 127.0.0.1</td>
- <td>(StrOpt) Host to locate redis</td>
- </tr>
- <tr>
- <td>password = None</td>
- <td>(StrOpt) Password for Redis server. (optional)</td>
- </tr>
- <tr>
- <td>port = 6379</td>
- <td>(IntOpt) Use this port to connect to redis host.</td>
- </tr>
- <tr>
- <th colspan="2">[matchmaker_ring]</th>
- </tr>
- <tr>
- <td>ringfile = /etc/oslo/matchmaker_ring.json</td>
- <td>(StrOpt) Matchmaker ring file (JSON)</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_trove_redis">
+ <caption>Description of configuration options for redis</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[matchmaker_redis]</th>
+ </tr>
+ <tr>
+ <td>host = 127.0.0.1</td>
+ <td>(StrOpt) Host to locate redis</td>
+ </tr>
+ <tr>
+ <td>password = None</td>
+ <td>(StrOpt) Password for Redis server. (optional)</td>
+ </tr>
+ <tr>
+ <td>port = 6379</td>
+ <td>(IntOpt) Use this port to connect to redis host.</td>
+ </tr>
+ <tr>
+ <th colspan="2">[matchmaker_ring]</th>
+ </tr>
+ <tr>
+ <td>ringfile = /etc/oslo/matchmaker_ring.json</td>
+ <td>(StrOpt) Matchmaker ring file (JSON)</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/trove-rpc.xml b/doc/common/tables/trove-rpc.xml
index e26c13beed..0177ecee1b 100644
--- a/doc/common/tables/trove-rpc.xml
+++ b/doc/common/tables/trove-rpc.xml
@@ -1,105 +1,104 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_trove_rpc">
- <caption>Description of configuration options for rpc</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>allowed_rpc_exception_modules = nova.exception, cinder.exception, exceptions</td>
- <td>(ListOpt) Modules of exceptions that are permitted to be recreatedupon receiving exception data from an rpc call.</td>
- </tr>
- <tr>
- <td>host = 0.0.0.0</td>
- <td>(StrOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>matchmaker_heartbeat_freq = 300</td>
- <td>(IntOpt) Heartbeat frequency</td>
- </tr>
- <tr>
- <td>matchmaker_heartbeat_ttl = 600</td>
- <td>(IntOpt) Heartbeat time-to-live.</td>
- </tr>
- <tr>
- <td>num_tries = 3</td>
- <td>(IntOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>periodic_interval = 60</td>
- <td>(IntOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>report_interval = 10</td>
- <td>(IntOpt) The interval in seconds which periodic tasks are run.</td>
- </tr>
- <tr>
- <td>rpc_backend = trove.openstack.common.rpc.impl_kombu</td>
- <td>(StrOpt) The messaging module to use, defaults to kombu.</td>
- </tr>
- <tr>
- <td>rpc_cast_timeout = 30</td>
- <td>(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq.</td>
- </tr>
- <tr>
- <td>rpc_conn_pool_size = 30</td>
- <td>(IntOpt) Size of RPC connection pool</td>
- </tr>
- <tr>
- <td>rpc_response_timeout = 60</td>
- <td>(IntOpt) Seconds to wait for a response from call or multicall</td>
- </tr>
- <tr>
- <td>rpc_thread_pool_size = 64</td>
- <td>(IntOpt) Size of RPC thread pool</td>
- </tr>
- <tr>
- <th colspan="2">[rpc_notifier2]</th>
- </tr>
- <tr>
- <td>topics = notifications</td>
- <td>(ListOpt) AMQP topic(s) used for openstack notifications</td>
- </tr>
- <tr>
- <th colspan="2">[secure_messages]</th>
- </tr>
- <tr>
- <td>enabled = True</td>
- <td>(BoolOpt) Whether Secure Messaging (Signing) is enabled, defaults to enabled</td>
- </tr>
- <tr>
- <td>encrypt = False</td>
- <td>(BoolOpt) Whether Secure Messaging (Encryption) is enabled, defaults to not enabled</td>
- </tr>
- <tr>
- <td>enforced = False</td>
- <td>(BoolOpt) Whether Secure Messaging (Signing) is enforced, defaults to not enforced</td>
- </tr>
- <tr>
- <td>kds_endpoint = None</td>
- <td>(StrOpt) KDS endpoint (ex: http://kds.example.com:35357/v3)</td>
- </tr>
- <tr>
- <td>secret_key = None</td>
- <td>(MultiStrOpt) A list of keys: (ex: name:<base64 encoded key>), ignored if secret_keys_file is set</td>
- </tr>
- <tr>
- <td>secret_keys_file = None</td>
- <td>(StrOpt) Path to the file containing the keys, takes precedence over secret_key</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_trove_rpc">
+ <caption>Description of configuration options for rpc</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>allowed_rpc_exception_modules = nova.exception, cinder.exception, exceptions</td>
+ <td>(ListOpt) Modules of exceptions that are permitted to be recreatedupon receiving exception data from an rpc call.</td>
+ </tr>
+ <tr>
+ <td>host = 0.0.0.0</td>
+ <td>(StrOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>matchmaker_heartbeat_freq = 300</td>
+ <td>(IntOpt) Heartbeat frequency</td>
+ </tr>
+ <tr>
+ <td>matchmaker_heartbeat_ttl = 600</td>
+ <td>(IntOpt) Heartbeat time-to-live.</td>
+ </tr>
+ <tr>
+ <td>num_tries = 3</td>
+ <td>(IntOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>periodic_interval = 60</td>
+ <td>(IntOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>report_interval = 10</td>
+ <td>(IntOpt) The interval in seconds which periodic tasks are run.</td>
+ </tr>
+ <tr>
+ <td>rpc_backend = trove.openstack.common.rpc.impl_kombu</td>
+ <td>(StrOpt) The messaging module to use, defaults to kombu.</td>
+ </tr>
+ <tr>
+ <td>rpc_cast_timeout = 30</td>
+ <td>(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq.</td>
+ </tr>
+ <tr>
+ <td>rpc_conn_pool_size = 30</td>
+ <td>(IntOpt) Size of RPC connection pool</td>
+ </tr>
+ <tr>
+ <td>rpc_response_timeout = 60</td>
+ <td>(IntOpt) Seconds to wait for a response from call or multicall</td>
+ </tr>
+ <tr>
+ <td>rpc_thread_pool_size = 64</td>
+ <td>(IntOpt) Size of RPC thread pool</td>
+ </tr>
+ <tr>
+ <th colspan="2">[rpc_notifier2]</th>
+ </tr>
+ <tr>
+ <td>topics = notifications</td>
+ <td>(ListOpt) AMQP topic(s) used for openstack notifications</td>
+ </tr>
+ <tr>
+ <th colspan="2">[secure_messages]</th>
+ </tr>
+ <tr>
+ <td>enabled = True</td>
+ <td>(BoolOpt) Whether Secure Messaging (Signing) is enabled, defaults to enabled</td>
+ </tr>
+ <tr>
+ <td>encrypt = False</td>
+ <td>(BoolOpt) Whether Secure Messaging (Encryption) is enabled, defaults to not enabled</td>
+ </tr>
+ <tr>
+ <td>enforced = False</td>
+ <td>(BoolOpt) Whether Secure Messaging (Signing) is enforced, defaults to not enforced</td>
+ </tr>
+ <tr>
+ <td>kds_endpoint = None</td>
+ <td>(StrOpt) KDS endpoint (ex: http://kds.example.com:35357/v3)</td>
+ </tr>
+ <tr>
+ <td>secret_key = None</td>
+ <td>(MultiStrOpt) A list of keys: (ex: name:<base64 encoded key>), ignored if secret_keys_file is set</td>
+ </tr>
+ <tr>
+ <td>secret_keys_file = None</td>
+ <td>(StrOpt) Path to the file containing the keys, takes precedence over secret_key</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/trove-ssl.xml b/doc/common/tables/trove-ssl.xml
index 784368d927..a026b1eb43 100644
--- a/doc/common/tables/trove-ssl.xml
+++ b/doc/common/tables/trove-ssl.xml
@@ -1,35 +1,34 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_trove_ssl">
- <caption>Description of configuration options for ssl</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[ssl]</th>
- </tr>
- <tr>
- <td>ca_file = None</td>
- <td>(StrOpt) CA certificate file to use to verify connecting clients</td>
- </tr>
- <tr>
- <td>cert_file = None</td>
- <td>(StrOpt) Certificate file to use when starting the server securely</td>
- </tr>
- <tr>
- <td>key_file = None</td>
- <td>(StrOpt) Private key file to use when starting the server securely</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_trove_ssl">
+ <caption>Description of configuration options for ssl</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[ssl]</th>
+ </tr>
+ <tr>
+ <td>ca_file = None</td>
+ <td>(StrOpt) CA certificate file to use to verify connecting clients</td>
+ </tr>
+ <tr>
+ <td>cert_file = None</td>
+ <td>(StrOpt) Certificate file to use when starting the server securely</td>
+ </tr>
+ <tr>
+ <td>key_file = None</td>
+ <td>(StrOpt) Private key file to use when starting the server securely</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/trove-swift.xml b/doc/common/tables/trove-swift.xml
index 351edd5728..af6e1377ff 100644
--- a/doc/common/tables/trove-swift.xml
+++ b/doc/common/tables/trove-swift.xml
@@ -1,27 +1,30 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_trove_swift">
- <caption>Description of configuration options for swift</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>swift_url = http://localhost:8080/v1/AUTH_</td>
- <td>(StrOpt) No help text available for this option.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_trove_swift">
+ <caption>Description of configuration options for swift</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>swift_service_type = object-store</td>
+ <td>(StrOpt) Service type to use when searching catalog.</td>
+ </tr>
+ <tr>
+ <td>swift_url = None</td>
+ <td>(StrOpt) URL ending in AUTH_.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/trove-taskmanager.xml b/doc/common/tables/trove-taskmanager.xml
index df9ead30d6..4e987714b6 100644
--- a/doc/common/tables/trove-taskmanager.xml
+++ b/doc/common/tables/trove-taskmanager.xml
@@ -1,83 +1,82 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_trove_taskmanager">
- <caption>Description of configuration options for taskmanager</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>cloudinit_location = /etc/trove/cloudinit</td>
- <td>(StrOpt) Path to folder with cloudinit scripts.</td>
- </tr>
- <tr>
- <td>datastore_manager = None</td>
- <td>(StrOpt) Manager class in guestagent, setup by taskmanager on instance provision.</td>
- </tr>
- <tr>
- <td>datastore_registry_ext = {}</td>
- <td>(DictOpt) Extension for default datastore managers. Allows to use custom managers for each of datastore supported in trove.</td>
- </tr>
- <tr>
- <td>exists_notification_ticks = 360</td>
- <td>(IntOpt) Number of report_intervals to wait between pushing events (see report_interval).</td>
- </tr>
- <tr>
- <td>exists_notification_transformer = None</td>
- <td>(StrOpt) Transformer for exists notifications.</td>
- </tr>
- <tr>
- <td>reboot_time_out = 120</td>
- <td>(IntOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>resize_time_out = 600</td>
- <td>(IntOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>revert_time_out = 600</td>
- <td>(IntOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>server_delete_time_out = 60</td>
- <td>(IntOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>state_change_wait_time = 180</td>
- <td>(IntOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>update_status_on_fail = False</td>
- <td>(BoolOpt) If instance fails to become active, taskmanager updates statuses, service status = FAILED_TIMEOUT_GUESTAGENT, instance task status = BUILDING_ERROR_TIMEOUT_GA.</td>
- </tr>
- <tr>
- <td>usage_sleep_time = 5</td>
- <td>(IntOpt) Time to sleep during the check active guest.</td>
- </tr>
- <tr>
- <td>use_heat = False</td>
- <td>(BoolOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>use_nova_server_volume = False</td>
- <td>(BoolOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>verify_swift_checksum_on_restore = True</td>
- <td>(BoolOpt) Enable verification of swift checksum before starting restore; makes sure the checksum of original backup matches checksum of the swift backup file.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_trove_taskmanager">
+ <caption>Description of configuration options for taskmanager</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>cloudinit_location = /etc/trove/cloudinit</td>
+ <td>(StrOpt) Path to folder with cloudinit scripts.</td>
+ </tr>
+ <tr>
+ <td>datastore_manager = None</td>
+ <td>(StrOpt) Manager class in guestagent, setup by taskmanager on instance provision.</td>
+ </tr>
+ <tr>
+ <td>datastore_registry_ext = {}</td>
+ <td>(DictOpt) Extension for default datastore managers. Allows to use custom managers for each of datastore supported in trove.</td>
+ </tr>
+ <tr>
+ <td>exists_notification_ticks = 360</td>
+ <td>(IntOpt) Number of report_intervals to wait between pushing events (see report_interval).</td>
+ </tr>
+ <tr>
+ <td>exists_notification_transformer = None</td>
+ <td>(StrOpt) Transformer for exists notifications.</td>
+ </tr>
+ <tr>
+ <td>reboot_time_out = 120</td>
+ <td>(IntOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>resize_time_out = 600</td>
+ <td>(IntOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>revert_time_out = 600</td>
+ <td>(IntOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>server_delete_time_out = 60</td>
+ <td>(IntOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>state_change_wait_time = 180</td>
+ <td>(IntOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>update_status_on_fail = False</td>
+ <td>(BoolOpt) If instance fails to become active, taskmanager updates statuses, service status = FAILED_TIMEOUT_GUESTAGENT, instance task status = BUILDING_ERROR_TIMEOUT_GA.</td>
+ </tr>
+ <tr>
+ <td>usage_sleep_time = 5</td>
+ <td>(IntOpt) Time to sleep during the check active guest.</td>
+ </tr>
+ <tr>
+ <td>use_heat = False</td>
+ <td>(BoolOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>use_nova_server_volume = False</td>
+ <td>(BoolOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>verify_swift_checksum_on_restore = True</td>
+ <td>(BoolOpt) Enable verification of swift checksum before starting restore; makes sure the checksum of original backup matches checksum of the swift backup file.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/trove-volume.xml b/doc/common/tables/trove-volume.xml
index 6a198aa48b..bc757fc2ce 100644
--- a/doc/common/tables/trove-volume.xml
+++ b/doc/common/tables/trove-volume.xml
@@ -1,51 +1,54 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_trove_volume">
- <caption>Description of configuration options for volume</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>block_device_mapping = vdb</td>
- <td>(StrOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>cinder_url = http://localhost:8776/v2</td>
- <td>(StrOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>device_path = /dev/vdb</td>
- <td>(StrOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>trove_volume_support = True</td>
- <td>(BoolOpt) Whether to provision a cinder volume for datadir.</td>
- </tr>
- <tr>
- <td>volume_format_timeout = 120</td>
- <td>(IntOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>volume_fstype = ext3</td>
- <td>(StrOpt) No help text available for this option.</td>
- </tr>
- <tr>
- <td>volume_time_out = 60</td>
- <td>(IntOpt) No help text available for this option.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_trove_volume">
+ <caption>Description of configuration options for volume</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>block_device_mapping = vdb</td>
+ <td>(StrOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>cinder_service_type = volumev2</td>
+ <td>(StrOpt) Service type to use when searching catalog.</td>
+ </tr>
+ <tr>
+ <td>cinder_url = None</td>
+ <td>(StrOpt) URL without the tenant segment.</td>
+ </tr>
+ <tr>
+ <td>device_path = /dev/vdb</td>
+ <td>(StrOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>trove_volume_support = True</td>
+ <td>(BoolOpt) Whether to provision a cinder volume for datadir.</td>
+ </tr>
+ <tr>
+ <td>volume_format_timeout = 120</td>
+ <td>(IntOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>volume_fstype = ext3</td>
+ <td>(StrOpt) No help text available for this option.</td>
+ </tr>
+ <tr>
+ <td>volume_time_out = 60</td>
+ <td>(IntOpt) No help text available for this option.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/common/tables/trove-zeromq.xml b/doc/common/tables/trove-zeromq.xml
index acd75dd1d3..c98d0cd316 100644
--- a/doc/common/tables/trove-zeromq.xml
+++ b/doc/common/tables/trove-zeromq.xml
@@ -1,51 +1,50 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!-- Warning: Do not edit this file. It is automatically
- generated and your changes will be overwritten.
- The tool to do so lives in the tools directory of this
- repository -->
- <para xmlns="http://docbook.org/ns/docbook" version="5.0">
- <table rules="all" xml:id="config_table_trove_zeromq">
- <caption>Description of configuration options for zeromq</caption>
- <col width="50%"/>
- <col width="50%"/>
- <thead>
- <tr>
- <th>Configuration option = Default value</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <th colspan="2">[DEFAULT]</th>
- </tr>
- <tr>
- <td>rpc_zmq_bind_address = *</td>
- <td>(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address.</td>
- </tr>
- <tr>
- <td>rpc_zmq_contexts = 1</td>
- <td>(IntOpt) Number of ZeroMQ contexts, defaults to 1</td>
- </tr>
- <tr>
- <td>rpc_zmq_host = oslo</td>
- <td>(StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova.</td>
- </tr>
- <tr>
- <td>rpc_zmq_ipc_dir = /var/run/openstack</td>
- <td>(StrOpt) Directory for holding IPC sockets</td>
- </tr>
- <tr>
- <td>rpc_zmq_matchmaker = trove.openstack.common.rpc.matchmaker.MatchMakerLocalhost</td>
- <td>(StrOpt) MatchMaker driver</td>
- </tr>
- <tr>
- <td>rpc_zmq_port = 9501</td>
- <td>(IntOpt) ZeroMQ receiver listening port</td>
- </tr>
- <tr>
- <td>rpc_zmq_topic_backlog = None</td>
- <td>(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited.</td>
- </tr>
- </tbody>
- </table>
- </para>
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <!-- Warning: Do not edit this file. It is automatically
+ generated and your changes will be overwritten.
+ The tool to do so lives in openstack-doc-tools repository. -->
+ <table rules="all" xml:id="config_table_trove_zeromq">
+ <caption>Description of configuration options for zeromq</caption>
+ <col width="50%"/>
+ <col width="50%"/>
+ <thead>
+ <tr>
+ <th>Configuration option = Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <th colspan="2">[DEFAULT]</th>
+ </tr>
+ <tr>
+ <td>rpc_zmq_bind_address = *</td>
+ <td>(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_contexts = 1</td>
+ <td>(IntOpt) Number of ZeroMQ contexts, defaults to 1</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_host = oslo</td>
+ <td>(StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova.</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_ipc_dir = /var/run/openstack</td>
+ <td>(StrOpt) Directory for holding IPC sockets</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_matchmaker = trove.openstack.common.rpc.matchmaker.MatchMakerLocalhost</td>
+ <td>(StrOpt) MatchMaker driver</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_port = 9501</td>
+ <td>(IntOpt) ZeroMQ receiver listening port</td>
+ </tr>
+ <tr>
+ <td>rpc_zmq_topic_backlog = None</td>
+ <td>(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited.</td>
+ </tr>
+ </tbody>
+ </table>
+</para>
diff --git a/doc/config-reference/block-storage/section_misc.xml b/doc/config-reference/block-storage/section_misc.xml
index 2425e84cce..8b1a97fd31 100644
--- a/doc/config-reference/block-storage/section_misc.xml
+++ b/doc/config-reference/block-storage/section_misc.xml
@@ -11,7 +11,6 @@
</para>
<xi:include href="../../common/tables/cinder-auth_token.xml"/>
- <xi:include href="../../common/tables/cinder-connection.xml"/>
<xi:include href="../../common/tables/cinder-huawei.xml"/>
<xi:include href="../../common/tables/cinder-nas.xml"/>
<xi:include href="../../common/tables/cinder-hpmsa.xml"/>
diff --git a/doc/config-reference/ch_identityconfigure.xml b/doc/config-reference/ch_identityconfigure.xml
index dd33aab39c..206a4c2f08 100644
--- a/doc/config-reference/ch_identityconfigure.xml
+++ b/doc/config-reference/ch_identityconfigure.xml
@@ -69,7 +69,6 @@ options. For installation prerequisites and step-by-step walkthroughs, see the
<xi:include href="../common/tables/keystone-logging.xml"/>
<xi:include href="../common/tables/keystone-memcache.xml"/>
<xi:include href="../common/tables/keystone-misc.xml"/>
- <xi:include href="../common/tables/keystone-notification.xml"/>
<xi:include href="../common/tables/keystone-oauth.xml"/>
<xi:include href="../common/tables/keystone-os_inherit.xml"/>
<xi:include href="../common/tables/keystone-policy.xml"/>
diff --git a/doc/config-reference/ch_imageservice.xml b/doc/config-reference/ch_imageservice.xml
index 0bc4b2d4f9..de3c7a65b0 100644
--- a/doc/config-reference/ch_imageservice.xml
+++ b/doc/config-reference/ch_imageservice.xml
@@ -25,7 +25,7 @@
The following tables provide a comprehensive list.</para>
<xi:include href="../common/tables/glance-auth_token.xml"/>
<xi:include href="../common/tables/glance-common.xml"/>
- <xi:include href="../common/tables/glance-db.xml"/>
+ <xi:include href="../common/tables/glance-database.xml"/>
<xi:include href="../common/tables/glance-imagecache.xml"/>
<xi:include href="../common/tables/glance-logging.xml"/>
<xi:include href="../common/tables/glance-matchmaker.xml"/>
diff --git a/doc/config-reference/ch_telemetryconfigure.xml b/doc/config-reference/ch_telemetryconfigure.xml
index 5e49295c26..7c11ac40ef 100644
--- a/doc/config-reference/ch_telemetryconfigure.xml
+++ b/doc/config-reference/ch_telemetryconfigure.xml
@@ -19,7 +19,7 @@
<xi:include href="../common/tables/ceilometer-amqp.xml"/>
<xi:include href="../common/tables/ceilometer-api.xml"/>
<xi:include href="../common/tables/ceilometer-auth.xml"/>
- <xi:include href="../common/tables/ceilometer-cells.xml"/>
+ <xi:include href="../common/tables/ceilometer-auth_token.xml"/>
<xi:include href="../common/tables/ceilometer-collector.xml"/>
<xi:include href="../common/tables/ceilometer-common.xml"/>
<xi:include href="../common/tables/ceilometer-database.xml"/>
@@ -31,7 +31,6 @@
<xi:include href="../common/tables/ceilometer-rabbitmq.xml"/>
<xi:include href="../common/tables/ceilometer-redis.xml"/>
<xi:include href="../common/tables/ceilometer-rpc.xml"/>
- <xi:include href="../common/tables/ceilometer-ssl.xml"/>
<xi:include href="../common/tables/ceilometer-swift.xml"/>
<xi:include href="../common/tables/ceilometer-vmware.xml"/>
diff --git a/doc/config-reference/compute/section_compute-configure-db.xml b/doc/config-reference/compute/section_compute-configure-db.xml
index a9bc3ec1d8..51668d557e 100644
--- a/doc/config-reference/compute/section_compute-configure-db.xml
+++ b/doc/config-reference/compute/section_compute-configure-db.xml
@@ -19,6 +19,6 @@
service, although all services must be able to update
entries in the database.</para>
<para>In either case, use the configuration option settings documented in
- <xref linkend="config_table_nova_db"/> to configure the connection
+ <xref linkend="config_table_nova_database"/> to configure the connection
string for the nova database.</para>
</section>
diff --git a/doc/config-reference/compute/section_compute-options-reference.xml b/doc/config-reference/compute/section_compute-options-reference.xml
index 4eaa77b9cc..40452e9f82 100644
--- a/doc/config-reference/compute/section_compute-options-reference.xml
+++ b/doc/config-reference/compute/section_compute-options-reference.xml
@@ -20,7 +20,7 @@
<xi:include href="../../common/tables/nova-conductor.xml"/>
<xi:include href="../../common/tables/nova-configdrive.xml"/>
<xi:include href="../../common/tables/nova-console.xml"/>
- <xi:include href="../../common/tables/nova-db.xml"/>
+ <xi:include href="../../common/tables/nova-database.xml"/>
<xi:include href="../../common/tables/nova-ec2.xml"/>
<xi:include href="../../common/tables/nova-fping.xml"/>
<xi:include href="../../common/tables/nova-glance.xml"/>
diff --git a/doc/config-reference/networking/section_networking-options-reference.xml b/doc/config-reference/networking/section_networking-options-reference.xml
index 242a874636..44eb498991 100644
--- a/doc/config-reference/networking/section_networking-options-reference.xml
+++ b/doc/config-reference/networking/section_networking-options-reference.xml
@@ -33,12 +33,6 @@
<xi:include href="../../common/tables/neutron-auth_token.xml"/>
</section>
-<section xml:id="networking-options-cadf">
-<title>CADF</title>
-<para>Use the following options to alter Cloud Audit Data Federation (CADF) settings.</para>
-<xi:include href="../../common/tables/neutron-cadf.xml"/>
-</section>
-
<section xml:id="networking-options-compute">
<title>Compute</title>
<para>Use the following options to alter Compute-related settings.</para>
@@ -48,7 +42,7 @@
<section xml:id="networking-options-db">
<title>Database</title>
<para>Use the following options to alter Database-related settings.</para>
-<xi:include href="../../common/tables/neutron-db.xml"/>
+<xi:include href="../../common/tables/neutron-database.xml"/>
</section>
<section xml:id="networking-options-dhcp">
@@ -83,6 +77,9 @@ Loadbalancer-as-a-Service related settings.</para>
<para>Use the following options in the <filename>lbaas_agent.ini</filename>
file for the LbaaS agent.</para>
<xi:include href="../../common/tables/neutron-lbaas.xml"/>
+<xi:include href="../../common/tables/neutron-lbaas_haproxy.xml"/>
+<xi:include href="../../common/tables/neutron-lbaas_netscalar.xml"/>
+<xi:include href="../../common/tables/neutron-lbaas_radware.xml"/>
</section>
<section xml:id="networking-options-logging">
diff --git a/doc/config-reference/networking/section_networking-plugins-ml2.xml b/doc/config-reference/networking/section_networking-plugins-ml2.xml
index 0cf9181f02..5c62c6d898 100644
--- a/doc/config-reference/networking/section_networking-plugins-ml2.xml
+++ b/doc/config-reference/networking/section_networking-plugins-ml2.xml
@@ -82,6 +82,16 @@
options</title>
<xi:include href="../../common/tables/neutron-ml2_cisco.xml"/>
</section>
+ <section xml:id="networking-plugin-ml2_cisco_apic">
+ <title>Modular Layer 2 (ml2) Cisco APIC Mechanism configuration
+ options</title>
+ <xi:include href="../../common/tables/neutron-ml2_cisco_apic.xml"/>
+ </section>
+ <section xml:id="networking-plugin-ml2_fslsdn">
+ <title>Modular Layer 2 (ml2) Freescale SDN Mechanism configuration
+ options</title>
+ <xi:include href="../../common/tables/neutron-ml2_fslsdn.xml"/>
+ </section>
<section xml:id="networking-plugin-ml2_mlnx">
<title>Modular Layer 2 (ml2) Mellanox Mechanism configuration
options</title>
diff --git a/tools/autogenerate-config-flagmappings/ceilometer.flagmappings b/tools/autogenerate-config-flagmappings/ceilometer.flagmappings
index bd36b47e5e..83e8a2df09 100644
--- a/tools/autogenerate-config-flagmappings/ceilometer.flagmappings
+++ b/tools/autogenerate-config-flagmappings/ceilometer.flagmappings
@@ -1,7 +1,7 @@
allowed_rpc_exception_modules rpc
amqp_auto_delete amqp
amqp_durable_queues amqp
-auth_strategy auth
+api_paste_config api
backdoor_port common
cinder_control_exchange exchange
collector_workers collector
@@ -9,20 +9,21 @@ control_exchange exchange
database_connection database
debug logging
default_log_levels logging
-default_notification_level logging
-default_publisher_id exchange
disable_process_locking common
dispatcher rpc
-enable_v1_api api
+enable_new_services nova_import
fake_rabbit rabbitmq
fatal_deprecations common
+fatal_exception_format_errors common
glance_control_exchange exchange
heat_control_exchange exchange
host redis
http_control_exchanges exchange
hypervisor_inspector inspector
instance_format logging
+instance_name_template nova_import
instance_uuid_format logging
+kombu_reconnect_delay rabbitmq
kombu_ssl_ca_certs rabbitmq
kombu_ssl_certfile rabbitmq
kombu_ssl_keyfile rabbitmq
@@ -43,15 +44,17 @@ matchmaker_heartbeat_freq redis
matchmaker_heartbeat_ttl redis
max_request_body_size api
memcached_servers common
-mysql_engine database
+network_api_class nova_import
neutron_control_exchange exchange
notification_driver amqp
notification_topics amqp
notification_workers common
nova_control_exchange exchange
+password rpc
pipeline_cfg_file api
policy_default_rule api
policy_file api
+port rpc
publish_errors logging
qpid_heartbeat qpid
qpid_hostname qpid
@@ -66,6 +69,7 @@ qpid_username qpid
rabbit_ha_queues rabbitmq
rabbit_host rabbitmq
rabbit_hosts rabbitmq
+rabbit_login_method rabbitmq
rabbit_max_retries rabbitmq
rabbit_password rabbitmq
rabbit_port rabbitmq
@@ -90,9 +94,9 @@ rpc_zmq_matchmaker rpc
rpc_zmq_port rpc
rpc_zmq_topic_backlog rpc
sample_source exchange
-sqlite_db database
-sqlite_synchronous database
+snapshot_name_template nova_import
syslog_log_facility logging
+transport_url rpc
use_stderr logging
use_syslog logging
use_syslog_rfc_format logging
@@ -105,75 +109,80 @@ alarm/record_history alarm
alarm/rest_notifier_certificate_file alarm
alarm/rest_notifier_certificate_key alarm
alarm/rest_notifier_ssl_verify alarm
+api/enable_reverse_dns_lookup api
api/host api
api/port api
-audit/api_audit_map logging
-audit/namespace logging
-cells/bandwidth_update_interval cells
-cells/call_timeout cells
-cells/capabilities cells
-cells/cell_type cells
-cells/enable cells
-cells/manager cells
-cells/mute_child_interval cells
-cells/name cells
-cells/reserve_percent cells
-cells/topic cells
-collector/udp_address collector
-collector/udp_port collector
+cells/bandwidth_update_interval nova_cells
+cells/call_timeout nova_cells
+cells/capabilities nova_cells
+cells/cell_type nova_cells
+cells/enable nova_cells
+cells/manager nova_cells
+cells/mute_child_interval nova_cells
+cells/name nova_cells
+cells/reserve_percent nova_cells
+cells/topic nova_cells
database/backend database
database/connection database
database/connection_debug database
database/connection_trace database
+database/db_inc_retry_interval database
+database/db_max_retries database
+database/db_max_retry_interval database
+database/db_retry_interval database
database/idle_timeout database
database/max_overflow database
database/max_pool_size database
database/max_retries database
database/min_pool_size database
+database/mysql_sql_mode database
database/pool_timeout database
database/retry_interval database
-database/slave_connection database
+database/sqlite_db database
+database/sqlite_synchronous database
database/time_to_live database
+database/use_db_reconnect database
+database/use_tpool database
dispatcher_file/backup_count collector
dispatcher_file/file_path collector
dispatcher_file/max_bytes collector
event/definitions_cfg_file events
event/drop_unmatched_notifications events
-keystone_authtoken/admin_password auth
-keystone_authtoken/admin_tenant_name auth
-keystone_authtoken/admin_token auth
-keystone_authtoken/admin_user auth
-keystone_authtoken/auth_admin_prefix auth
-keystone_authtoken/auth_host auth
-keystone_authtoken/auth_port auth
-keystone_authtoken/auth_protocol auth
-keystone_authtoken/auth_uri auth
-keystone_authtoken/auth_version auth
-keystone_authtoken/cache auth
-keystone_authtoken/cafile auth
-keystone_authtoken/certfile auth
-keystone_authtoken/delay_auth_decision auth
-keystone_authtoken/enforce_token_bind auth
-keystone_authtoken/http_connect_timeout auth
-keystone_authtoken/http_request_max_retries auth
-keystone_authtoken/include_service_catalog auth
-keystone_authtoken/insecure auth
-keystone_authtoken/keyfile auth
-keystone_authtoken/memcache_secret_key auth
-keystone_authtoken/memcache_security_strategy auth
-keystone_authtoken/memcached_servers auth
-keystone_authtoken/revocation_cache_time auth
-keystone_authtoken/signing_dir auth
-keystone_authtoken/token_cache_time auth
-matchmaker_redis/host redis
-matchmaker_redis/password redis
-matchmaker_redis/port redis
+keystone_authtoken/admin_password auth_token
+keystone_authtoken/admin_tenant_name auth_token
+keystone_authtoken/admin_token auth_token
+keystone_authtoken/admin_user auth_token
+keystone_authtoken/auth_admin_prefix auth_token
+keystone_authtoken/auth_host auth_token
+keystone_authtoken/auth_port auth_token
+keystone_authtoken/auth_protocol auth_token
+keystone_authtoken/auth_uri auth_token
+keystone_authtoken/auth_version auth_token
+keystone_authtoken/cache auth_token
+keystone_authtoken/cafile auth_token
+keystone_authtoken/certfile auth_token
+keystone_authtoken/check_revocations_for_cached auth_token
+keystone_authtoken/delay_auth_decision auth_token
+keystone_authtoken/enforce_token_bind auth_token
+keystone_authtoken/hash_algorithms auth_token
+keystone_authtoken/http_connect_timeout auth_token
+keystone_authtoken/http_request_max_retries auth_token
+keystone_authtoken/identity_uri auth_token
+keystone_authtoken/include_service_catalog auth_token
+keystone_authtoken/insecure auth_token
+keystone_authtoken/keyfile auth_token
+keystone_authtoken/memcache_secret_key auth_token
+keystone_authtoken/memcache_security_strategy auth_token
+keystone_authtoken/memcached_servers auth_token
+keystone_authtoken/revocation_cache_time auth_token
+keystone_authtoken/signing_dir auth_token
+keystone_authtoken/token_cache_time auth_token
matchmaker_ring/ringfile redis
notification/ack_on_event_error events
+notification/messaging_urls rpc
notification/store_events events
publisher/metering_secret rpc
publisher_rpc/metering_topic rpc
-rpc_notifier2/topics rpc
service_credentials/insecure auth
service_credentials/os_auth_url auth
service_credentials/os_cacert auth
@@ -183,11 +192,10 @@ service_credentials/os_region_name auth
service_credentials/os_tenant_id auth
service_credentials/os_tenant_name auth
service_credentials/os_username auth
-ssl/ca_file ssl
-ssl/cert_file ssl
-ssl/key_file ssl
+upgrade_levels/cells nova_cells
vmware/api_retry_count vmware
vmware/host_ip vmware
vmware/host_password vmware
vmware/host_username vmware
vmware/task_poll_interval vmware
+vmware/wsdl_location vmware
diff --git a/tools/autogenerate-config-flagmappings/cinder.flagmappings b/tools/autogenerate-config-flagmappings/cinder.flagmappings
index d976ae81cc..8ab521b556 100644
--- a/tools/autogenerate-config-flagmappings/cinder.flagmappings
+++ b/tools/autogenerate-config-flagmappings/cinder.flagmappings
@@ -7,6 +7,7 @@ api_paste_config api
api_rate_limit api
auth_strategy auth
available_devices block-device
+az_cache_duration api
backdoor_port api
backup_api_class backups
backup_ceph_chunk_size backups_ceph
@@ -71,6 +72,7 @@ glance_api_insecure images
glance_api_servers images
glance_api_ssl_compression images
glance_api_version images
+glance_core_properties images
glance_host images
glance_num_retries images
glance_port images
@@ -86,6 +88,8 @@ gpfs_mount_point_base storage_gpfs
gpfs_sparse_volumes storage_gpfs
gpfs_storage_pool storage_gpfs
hds_cinder_config_file hds-hus
+hds_hnas_iscsi_config_file hds-hus
+hds_hnas_nfs_config_file hds-hus
host common
hp3par_api_url hp3par
hp3par_cpg hp3par
@@ -214,7 +218,6 @@ osapi_volume_ext_list api
osapi_volume_extension api
osapi_volume_listen api
osapi_volume_listen_port api
-osapi_volume_workers api
password rpc
periodic_fuzzy_delay common
periodic_interval common
@@ -253,6 +256,7 @@ rbd_flatten_volume_from_snapshot storage_ceph
rbd_max_clone_depth storage_ceph
rbd_pool storage_ceph
rbd_secret_uuid storage_ceph
+rbd_store_chunk_size storage_ceph
rbd_user storage_ceph
report_interval common
reservation_expire quota
@@ -299,8 +303,7 @@ sf_api_port solidfire
sf_emulate_512 solidfire
snapshot_name_template backups
snapshot_same_host backups
-sqlite_db common
-sqlite_synchronous common
+sqlite_clean_db database
ssh_conn_timeout san
ssh_max_pool_conn san
ssh_min_pool_conn san
@@ -324,6 +327,9 @@ storwize_svc_vol_rsize storwize
storwize_svc_vol_warning storwize
storwize_svc_volpool_name storwize
syslog_log_facility common
+tcp_keepalive common
+tcp_keepalive_count common
+tcp_keepalive_interval common
tcp_keepidle common
thres_avl_size_perc_start netapp_7mode_nfs netapp_cdot_nfs
thres_avl_size_perc_stop netapp_7mode_nfs netapp_cdot_nfs
@@ -352,6 +358,8 @@ volume_backend_name storage
volume_clear storage
volume_clear_ionice storage
volume_clear_size storage
+volume_copy_blkio_cgroup_name storage
+volume_copy_bps_limit storage
volume_dd_blocksize storage
volume_driver storage
volume_group lvm
@@ -394,17 +402,26 @@ BRCD_FABRIC_EXAMPLE/principal_switch_wwn zoning_fabric
BRCD_FABRIC_EXAMPLE/zone_activate zoning_fabric
BRCD_FABRIC_EXAMPLE/zone_name_prefix zoning_fabric
BRCD_FABRIC_EXAMPLE/zoning_policy zoning_fabric
-database/backend storage
-database/connection connection
-database/connection_debug connection
-database/connection_trace connection
-database/idle_timeout common
-database/max_overflow storage
-database/max_pool_size storage
-database/max_retries storage
-database/min_pool_size storage
-database/retry_interval common
-database/use_tpool common
+database/backend database
+database/connection database
+database/connection_debug database
+database/connection_trace database
+database/db_inc_retry_interval database
+database/db_max_retries database
+database/db_max_retry_interval database
+database/db_retry_interval database
+database/idle_timeout database
+database/max_overflow database
+database/max_pool_size database
+database/max_retries database
+database/min_pool_size database
+database/mysql_sql_mode database
+database/pool_timeout database
+database/retry_interval database
+database/sqlite_db database
+database/sqlite_synchronous database
+database/use_db_reconnect database
+database/use_tpool database
fc-zone-manager/brcd_sb_connector zoning_manager
fc-zone-manager/fc_fabric_names zoning
fc-zone-manager/fc_san_lookup_service zoning_manager
@@ -425,10 +442,13 @@ keystone_authtoken/auth_version auth_token
keystone_authtoken/cache auth_token
keystone_authtoken/cafile auth_token
keystone_authtoken/certfile auth_token
+keystone_authtoken/check_revocations_for_cached auth_token
keystone_authtoken/delay_auth_decision auth_token
keystone_authtoken/enforce_token_bind auth_token
+keystone_authtoken/hash_algorithms auth_token
keystone_authtoken/http_connect_timeout auth_token
keystone_authtoken/http_request_max_retries auth_token
+keystone_authtoken/identity_uri auth_token
keystone_authtoken/include_service_catalog auth_token
keystone_authtoken/insecure auth_token
keystone_authtoken/keyfile auth_token
diff --git a/tools/autogenerate-config-flagmappings/glance.flagmappings b/tools/autogenerate-config-flagmappings/glance.flagmappings
index 2f5970f595..2024dfc0d6 100644
--- a/tools/autogenerate-config-flagmappings/glance.flagmappings
+++ b/tools/autogenerate-config-flagmappings/glance.flagmappings
@@ -11,7 +11,6 @@ api_limit_max common
auth_region registry
auth_strategy registry
auth_url registry
-backdoor_port wsgi
backlog common
bind_host common
bind_port common
@@ -28,8 +27,8 @@ control_exchange rabbitmq
data_api common
debug logging
default_log_levels logging
-default_publisher_id api
default_store api
+default_swift_reference api
delayed_delete imagecache
disable_process_locking common
enable_v1_api api
@@ -146,8 +145,11 @@ s3_store_bucket s3
s3_store_bucket_url_format s3
s3_store_create_bucket_on_put s3
s3_store_host s3
+s3_store_large_object_chunk_size s3
+s3_store_large_object_size s3
s3_store_object_buffer_dir s3
s3_store_secret_key s3
+s3_store_thread_pools s3
scrub_time imagecache
scrubber_datadir imagecache
send_identity_headers api
@@ -161,6 +163,7 @@ swift_store_admin_tenants swift
swift_store_auth_address swift
swift_store_auth_insecure swift
swift_store_auth_version swift
+swift_store_config_file swift
swift_store_container swift
swift_store_create_container_on_put swift
swift_store_endpoint_type swift
@@ -192,25 +195,25 @@ vmware_server_username vmware
vmware_store_image_dir vmware
vmware_task_poll_interval vmware
workers common
-database/backend db
-database/connection db
-database/connection_debug db
-database/connection_trace db
-database/db_inc_retry_interval db
-database/db_max_retries db
-database/db_max_retry_interval db
-database/db_retry_interval db
-database/idle_timeout db
-database/max_overflow db
-database/max_pool_size db
-database/max_retries db
-database/min_pool_size db
-database/mysql_sql_mode db
-database/pool_timeout db
-database/retry_interval db
-database/sqlite_db db
-database/sqlite_synchronous db
-database/use_db_reconnect db
+database/backend database
+database/connection database
+database/connection_debug database
+database/connection_trace database
+database/db_inc_retry_interval database
+database/db_max_retries database
+database/db_max_retry_interval database
+database/db_retry_interval database
+database/idle_timeout database
+database/max_overflow database
+database/max_pool_size database
+database/max_retries database
+database/min_pool_size database
+database/mysql_sql_mode database
+database/pool_timeout database
+database/retry_interval database
+database/sqlite_db database
+database/sqlite_synchronous database
+database/use_db_reconnect database
image_format/container_formats common
image_format/disk_formats common
keystone_authtoken/admin_password auth_token
@@ -226,10 +229,13 @@ keystone_authtoken/auth_version auth_token
keystone_authtoken/cache auth_token
keystone_authtoken/cafile auth_token
keystone_authtoken/certfile auth_token
+keystone_authtoken/check_revocations_for_cached auth_token
keystone_authtoken/delay_auth_decision auth_token
keystone_authtoken/enforce_token_bind auth_token
+keystone_authtoken/hash_algorithms auth_token
keystone_authtoken/http_connect_timeout auth_token
keystone_authtoken/http_request_max_retries auth_token
+keystone_authtoken/identity_uri auth_token
keystone_authtoken/include_service_catalog auth_token
keystone_authtoken/insecure auth_token
keystone_authtoken/keyfile auth_token
diff --git a/tools/autogenerate-config-flagmappings/heat.flagmappings b/tools/autogenerate-config-flagmappings/heat.flagmappings
index a7ece26b2b..e466b31c9b 100644
--- a/tools/autogenerate-config-flagmappings/heat.flagmappings
+++ b/tools/autogenerate-config-flagmappings/heat.flagmappings
@@ -5,7 +5,6 @@ auth_encryption_key crypt
backdoor_port debug
cloud_backend clients_backends
control_exchange amqp
-db_backend database
debug debug
default_log_levels logging
default_notification_level amqp
@@ -29,6 +28,7 @@ instance_format logging
instance_user common
instance_uuid_format logging
keystone_backend common
+kombu_reconnect_delay rabbitmq
kombu_ssl_ca_certs rabbitmq
kombu_ssl_certfile rabbitmq
kombu_ssl_keyfile rabbitmq
@@ -56,11 +56,14 @@ max_template_size quota
memcached_servers auth_token
notification_driver amqp
notification_topics amqp
+num_engine_workers api
onready notification
+password rpc
periodic_interval common
plugin_dirs common
policy_default_rule api
policy_file api
+port rpc
publish_errors notification
qpid_heartbeat qpid
qpid_hostname qpid
@@ -75,6 +78,7 @@ qpid_username qpid
rabbit_ha_queues rabbitmq
rabbit_host rabbitmq
rabbit_hosts rabbitmq
+rabbit_login_method rabbitmq
rabbit_max_retries rabbitmq
rabbit_password rabbitmq
rabbit_port rabbitmq
@@ -97,16 +101,16 @@ rpc_zmq_matchmaker zeromq
rpc_zmq_port zeromq
rpc_zmq_topic_backlog zeromq
secure_proxy_ssl_header api
-sqlite_db database
-sqlite_synchronous database
stack_action_timeout api
stack_domain_admin api
stack_domain_admin_password api
stack_user_domain api
syslog_log_facility logging
+transport_url rpc
trusts_delegated_roles api
use_stderr logging
use_syslog logging
+use_syslog_rfc_format logging
verbose logging
auth_password/allowed_auth_uris api
auth_password/multi_cloud api
@@ -125,6 +129,11 @@ clients_cinder/cert_file clients_cinder
clients_cinder/endpoint_type clients_cinder
clients_cinder/insecure clients_cinder
clients_cinder/key_file clients_cinder
+clients_glance/ca_file clients_glance
+clients_glance/cert_file clients_glance
+clients_glance/endpoint_type clients_glance
+clients_glance/insecure clients_glance
+clients_glance/key_file clients_glance
clients_heat/ca_file clients_heat
clients_heat/cert_file clients_heat
clients_heat/endpoint_type clients_heat
@@ -144,6 +153,7 @@ clients_neutron/key_file clients_neutron
clients_nova/ca_file clients_nova
clients_nova/cert_file clients_nova
clients_nova/endpoint_type clients_nova
+clients_nova/http_log_debug clients_nova
clients_nova/insecure clients_nova
clients_nova/key_file clients_nova
clients_swift/ca_file clients_swift
@@ -160,14 +170,21 @@ database/backend database
database/connection database
database/connection_debug database
database/connection_trace database
+database/db_inc_retry_interval database
+database/db_max_retries database
+database/db_max_retry_interval database
+database/db_retry_interval database
database/idle_timeout database
database/max_overflow database
database/max_pool_size database
database/max_retries database
database/min_pool_size database
+database/mysql_sql_mode database
database/pool_timeout database
database/retry_interval database
-database/slave_connection database
+database/sqlite_db database
+database/sqlite_synchronous database
+database/use_db_reconnect database
ec2authtoken/allowed_auth_uris api
ec2authtoken/auth_uri api
ec2authtoken/multi_cloud api
@@ -205,10 +222,13 @@ keystone_authtoken/auth_version auth_token
keystone_authtoken/cache auth_token
keystone_authtoken/cafile auth_token
keystone_authtoken/certfile auth_token
+keystone_authtoken/check_revocations_for_cached auth_token
keystone_authtoken/delay_auth_decision auth_token
keystone_authtoken/enforce_token_bind auth_token
+keystone_authtoken/hash_algorithms auth_token
keystone_authtoken/http_connect_timeout auth_token
keystone_authtoken/http_request_max_retries auth_token
+keystone_authtoken/identity_uri auth_token
keystone_authtoken/include_service_catalog auth_token
keystone_authtoken/insecure auth_token
keystone_authtoken/keyfile auth_token
@@ -218,14 +238,10 @@ keystone_authtoken/memcached_servers auth_token
keystone_authtoken/revocation_cache_time auth_token
keystone_authtoken/signing_dir auth_token
keystone_authtoken/token_cache_time auth_token
-matchmaker_redis/host redis
-matchmaker_redis/password redis
-matchmaker_redis/port redis
matchmaker_ring/ringfile rpc
paste_deploy/api_paste_config api
paste_deploy/flavor api
revision/heat_revision common
-rpc_notifier2/topics rpc
ssl/ca_file api cfn_api cloudwatch_api
ssl/cert_file api cfn_api cloudwatch_api
ssl/key_file api cfn_api cloudwatch_api
diff --git a/tools/autogenerate-config-flagmappings/keystone.flagmappings b/tools/autogenerate-config-flagmappings/keystone.flagmappings
index b0c779bb1d..b701fde6f6 100644
--- a/tools/autogenerate-config-flagmappings/keystone.flagmappings
+++ b/tools/autogenerate-config-flagmappings/keystone.flagmappings
@@ -2,6 +2,7 @@ admin_bind_host api
admin_endpoint api
admin_port api
admin_token api
+admin_workers api
allowed_rpc_exception_modules rpc
amqp_auto_delete amqp
amqp_durable_queues amqp
@@ -50,7 +51,6 @@ member_role_name api
memcached_servers auth_token
notification_driver amqp
notification_topics amqp
-onready notification
password redis
policy_default_rule policy
policy_file policy
@@ -58,6 +58,7 @@ port redis
public_bind_host api
public_endpoint api
public_port api
+public_workers api
publish_errors debug
pydev_debug_host debug
pydev_debug_port debug
@@ -96,6 +97,7 @@ rpc_zmq_matchmaker zeromq
rpc_zmq_port zeromq
rpc_zmq_topic_backlog zeromq
standard_threads debug
+strict_password_check api
syslog_log_facility logging
tcp_keepalive api
tcp_keepidle api
@@ -141,6 +143,7 @@ database/min_pool_size database
database/mysql_sql_mode database
database/pool_timeout database
database/retry_interval database
+database/slave_connection database
database/sqlite_db database
database/sqlite_synchronous database
database/use_db_reconnect database
@@ -168,10 +171,13 @@ keystone_authtoken/auth_version auth_token
keystone_authtoken/cache auth_token
keystone_authtoken/cafile auth_token
keystone_authtoken/certfile auth_token
+keystone_authtoken/check_revocations_for_cached auth_token
keystone_authtoken/delay_auth_decision auth_token
keystone_authtoken/enforce_token_bind auth_token
+keystone_authtoken/hash_algorithms auth_token
keystone_authtoken/http_connect_timeout auth_token
keystone_authtoken/http_request_max_retries auth_token
+keystone_authtoken/identity_uri auth_token
keystone_authtoken/include_service_catalog auth_token
keystone_authtoken/insecure auth_token
keystone_authtoken/keyfile auth_token
@@ -188,6 +194,7 @@ kvs/enable_key_mangler kvs
ldap/alias_dereferencing ldap
ldap/allow_subtree_delete ldap
ldap/chase_referrals ldap
+ldap/debug_level ldap
ldap/dumb_member ldap
ldap/group_additional_attribute_mapping ldap
ldap/group_allow_create ldap
@@ -203,6 +210,22 @@ ldap/group_objectclass ldap
ldap/group_tree_dn ldap
ldap/page_size ldap
ldap/password ldap
+ldap/project_additional_attribute_mapping ldap
+ldap/project_allow_create ldap
+ldap/project_allow_delete ldap
+ldap/project_allow_update ldap
+ldap/project_attribute_ignore ldap
+ldap/project_desc_attribute ldap
+ldap/project_domain_id_attribute ldap
+ldap/project_enabled_attribute ldap
+ldap/project_enabled_emulation ldap
+ldap/project_enabled_emulation_dn ldap
+ldap/project_filter ldap
+ldap/project_id_attribute ldap
+ldap/project_member_attribute ldap
+ldap/project_name_attribute ldap
+ldap/project_objectclass ldap
+ldap/project_tree_dn ldap
ldap/query_scope ldap
ldap/role_additional_attribute_mapping ldap
ldap/role_allow_create ldap
@@ -216,22 +239,6 @@ ldap/role_name_attribute ldap
ldap/role_objectclass ldap
ldap/role_tree_dn ldap
ldap/suffix ldap
-ldap/tenant_additional_attribute_mapping ldap
-ldap/tenant_allow_create ldap
-ldap/tenant_allow_delete ldap
-ldap/tenant_allow_update ldap
-ldap/tenant_attribute_ignore ldap
-ldap/tenant_desc_attribute ldap
-ldap/tenant_domain_id_attribute ldap
-ldap/tenant_enabled_attribute ldap
-ldap/tenant_enabled_emulation ldap
-ldap/tenant_enabled_emulation_dn ldap
-ldap/tenant_filter ldap
-ldap/tenant_id_attribute ldap
-ldap/tenant_member_attribute ldap
-ldap/tenant_name_attribute ldap
-ldap/tenant_objectclass ldap
-ldap/tenant_tree_dn ldap
ldap/tls_cacertdir ldap
ldap/tls_cacertfile ldap
ldap/tls_req_cert ldap
@@ -294,6 +301,7 @@ token/caching token
token/driver token
token/enforce_token_bind token
token/expiration token
+token/hash_algorithm token
token/provider token
token/revocation_cache_time token
token/revoke_by_id token
diff --git a/tools/autogenerate-config-flagmappings/neutron.flagmappings b/tools/autogenerate-config-flagmappings/neutron.flagmappings
index 9614edb2e9..a8b7e8cfb1 100644
--- a/tools/autogenerate-config-flagmappings/neutron.flagmappings
+++ b/tools/autogenerate-config-flagmappings/neutron.flagmappings
@@ -32,8 +32,6 @@ default_interface_name vmware
default_l2_gw_service_uuid vmware
default_l3_gw_service_uuid vmware
default_log_levels logging
-default_notification_level notifier
-default_publisher_id notifier
default_service_cluster_uuid vmware
default_tz_uuid vmware
device_driver lbaas
@@ -66,10 +64,11 @@ instance_format logging
instance_uuid_format logging
interface_driver common
ip_lib_force_root common
-kombu_ssl_ca_certs kombu
-kombu_ssl_certfile kombu
-kombu_ssl_keyfile kombu
-kombu_ssl_version kombu
+kombu_reconnect_delay rabbitmq
+kombu_ssl_ca_certs rabbitmq
+kombu_ssl_certfile rabbitmq
+kombu_ssl_keyfile rabbitmq
+kombu_ssl_version rabbitmq
loadbalancer_pool_scheduler_driver lbaas
lock_path common
log_config_append logging
@@ -109,8 +108,14 @@ nova_admin_auth_url compute
nova_admin_password compute
nova_admin_tenant_id compute
nova_admin_username compute
+nova_api_insecure compute
+nova_ca_certificates_file compute
+nova_client_cert compute
+nova_client_priv_key compute
+nova_metadata_insecure metadata
nova_metadata_ip metadata
nova_metadata_port metadata
+nova_metadata_protocol metadata
nova_region_name compute
nova_url compute
nsx_controllers vmware
@@ -124,9 +129,11 @@ ovs_integration_bridge openvswitch_agent
ovs_use_veth openvswitch_agent
ovs_vsctl_timeout openvswitch_agent
pagination_max_limit api
+password rpc
periodic_fuzzy_delay common
periodic_interval common
policy_file policy
+port rpc
publish_errors logging
qpid_heartbeat qpid
qpid_hostname qpid
@@ -141,6 +148,7 @@ qpid_username qpid
rabbit_ha_queues rabbitmq
rabbit_host rabbitmq
rabbit_hosts rabbitmq
+rabbit_login_method rabbitmq
rabbit_max_retries rabbitmq
rabbit_password rabbitmq
rabbit_port rabbitmq
@@ -177,19 +185,21 @@ run_external_periodic_tasks api
send_arp_for_ha l3_agent
send_events_interval compute
service_plugins api
-sqlite_db db
-sqlite_synchronous db
ssl_ca_file ssl
ssl_cert_file ssl
ssl_key_file ssl
state_path common
syslog_log_facility logging
tcp_keepidle wsgi
+transport_url rpc
use_namespaces dhcp_agent
use_ssl logging
use_stderr logging
use_syslog logging
+use_syslog_rfc_format logging
verbose logging
+AGENT/arp_responder openvswitch_agent
+AGENT/dont_fragment openvswitch_agent ml2_ofa
AGENT/enable_metrics_collection hyperv_agent
AGENT/get_datapath_retry_times ml2_ofa
AGENT/integration_bridge nvsd
@@ -218,6 +228,7 @@ CISCO_N1K/bridge_mappings cisco
CISCO_N1K/default_network_profile cisco
CISCO_N1K/default_policy_profile cisco
CISCO_N1K/enable_tunneling cisco
+CISCO_N1K/http_pool_size cisco
CISCO_N1K/integration_bridge cisco
CISCO_N1K/local_ip openvswitch_agent
CISCO_N1K/network_node_policy_profile cisco
@@ -319,6 +330,7 @@ OVS/tunnel_ip ryu
OVS/tunnel_key_max ryu
OVS/tunnel_key_min ryu
OVS/tunnel_type openvswitch_agent
+OVS/use_veth_interconnection openvswitch_agent
PHYSICAL_INTERFACE/physical_interface brocade
PROVIDER/default_router_provider nec
PROVIDER/router_providers nec
@@ -406,30 +418,31 @@ VXLAN/local_ip linuxbridge_agent
VXLAN/tos linuxbridge_agent
VXLAN/ttl linuxbridge_agent
VXLAN/vxlan_group linuxbridge_agent
-audit/api_audit_map cadf
-audit/namespace cadf
cisco_csr_ipsec/status_check_interval cisco
-database/backend db
-database/connection db
-database/connection_debug db
-database/connection_trace db
-database/db_inc_retry_interval db
-database/db_max_retries db
-database/db_max_retry_interval db
-database/db_retry_interval db
-database/idle_timeout db
-database/max_overflow db
-database/max_pool_size db
-database/max_retries db
-database/min_pool_size db
-database/pool_timeout db
-database/retry_interval db
-database/slave_connection db
-database/use_db_reconnect db
+database/backend database
+database/connection database
+database/connection_debug database
+database/connection_trace database
+database/db_inc_retry_interval database
+database/db_max_retries database
+database/db_max_retry_interval database
+database/db_retry_interval database
+database/idle_timeout database
+database/max_overflow database
+database/max_pool_size database
+database/max_retries database
+database/min_pool_size database
+database/mysql_sql_mode database
+database/pool_timeout database
+database/retry_interval database
+database/sqlite_db database
+database/sqlite_synchronous database
+database/use_db_reconnect database
fwaas/driver nec
fwaas/enabled fwaas
-haproxy/loadbalancer_state_path lbaas
-haproxy/user_group lbaas
+haproxy/loadbalancer_state_path lbaas_haproxy
+haproxy/send_gratuitous_arp lbaas_haproxy
+haproxy/user_group lbaas_haproxy
heleos/admin_password common
heleos/admin_username embrane
heleos/async_requests embrane
@@ -468,10 +481,13 @@ keystone_authtoken/auth_version auth_token
keystone_authtoken/cache auth_token
keystone_authtoken/cafile auth_token
keystone_authtoken/certfile auth_token
+keystone_authtoken/check_revocations_for_cached auth_token
keystone_authtoken/delay_auth_decision auth_token
keystone_authtoken/enforce_token_bind auth_token
+keystone_authtoken/hash_algorithms auth_token
keystone_authtoken/http_connect_timeout auth_token
keystone_authtoken/http_request_max_retries auth_token
+keystone_authtoken/identity_uri auth_token
keystone_authtoken/include_service_catalog auth_token
keystone_authtoken/insecure auth_token
keystone_authtoken/keyfile auth_token
@@ -482,9 +498,6 @@ keystone_authtoken/revocation_cache_time auth_token
keystone_authtoken/signing_dir auth_token
keystone_authtoken/token_cache_time auth_token
l2pop/agent_boot_time ml2_l2pop
-matchmaker_redis/host redis
-matchmaker_redis/password redis
-matchmaker_redis/port redis
matchmaker_ring/ringfile rpc
ml2/mechanism_drivers ml2
ml2/tenant_network_types ml2
@@ -503,6 +516,28 @@ ml2_brocade/username ml2_brocade
ml2_cisco/managed_physical_network ml2_cisco
ml2_cisco/svi_round_robin cisco
ml2_cisco/vlan_name_prefix cisco
+ml2_cisco_apic/apic_clear_node_profiles ml2_cisco_apic
+ml2_cisco_apic/apic_entity_profile ml2_cisco_apic
+ml2_cisco_apic/apic_function_profile ml2_cisco_apic
+ml2_cisco_apic/apic_host ml2_cisco_apic
+ml2_cisco_apic/apic_node_profile ml2_cisco_apic
+ml2_cisco_apic/apic_password ml2_cisco_apic
+ml2_cisco_apic/apic_port ml2_cisco_apic
+ml2_cisco_apic/apic_username ml2_cisco_apic
+ml2_cisco_apic/apic_vlan_ns_name ml2_cisco_apic
+ml2_cisco_apic/apic_vlan_range ml2_cisco_apic
+ml2_cisco_apic/apic_vmm_domain ml2_cisco_apic
+ml2_cisco_apic/apic_vmm_provider ml2_cisco_apic
+ml2_fslsdn/crd_api_insecure ml2_fslsdn
+ml2_fslsdn/crd_auth_strategy ml2_fslsdn
+ml2_fslsdn/crd_auth_url ml2_fslsdn
+ml2_fslsdn/crd_ca_certificates_file ml2_fslsdn
+ml2_fslsdn/crd_password ml2_fslsdn
+ml2_fslsdn/crd_region_name ml2_fslsdn
+ml2_fslsdn/crd_tenant_name ml2_fslsdn
+ml2_fslsdn/crd_url ml2_fslsdn
+ml2_fslsdn/crd_url_timeout ml2_fslsdn
+ml2_fslsdn/crd_user_name ml2_fslsdn
ml2_ncs/password ml2_ncs
ml2_ncs/timeout ml2_ncs
ml2_ncs/url ml2_ncs
@@ -517,9 +552,9 @@ ml2_type_gre/tunnel_id_ranges ml2_gre
ml2_type_vlan/network_vlan_ranges ml2_vlan
ml2_type_vxlan/vni_ranges ml2_vxlan
ml2_type_vxlan/vxlan_group ml2_vxlan
-netscaler_driver/netscaler_ncc_password lbaas
-netscaler_driver/netscaler_ncc_uri lbaas
-netscaler_driver/netscaler_ncc_username lbaas
+netscaler_driver/netscaler_ncc_password lbaas_netscalar
+netscaler_driver/netscaler_ncc_uri lbaas_netscalar
+netscaler_driver/netscaler_ncc_username lbaas_netscalar
nvsd/nvsd_ip nvsd
nvsd/nvsd_passwd nvsd
nvsd/nvsd_port nvsd
@@ -530,29 +565,30 @@ openswan/ipsec_config_template vpn
openswan/ipsec_secret_template vpn
plumgriddirector/director_server plumgrid
plumgriddirector/director_server_port plumgrid
+plumgriddirector/driver plumgrid
plumgriddirector/password plumgrid
plumgriddirector/servertimeout plumgrid
plumgriddirector/username plumgrid
-radware/actions_to_skip lbaas
-radware/l2_l3_ctor_params lbaas
-radware/l2_l3_setup_params lbaas
-radware/l2_l3_workflow_name lbaas
-radware/l4_action_name lbaas
-radware/l4_workflow_name lbaas
-radware/service_adc_type lbaas
-radware/service_adc_version lbaas
-radware/service_cache lbaas
-radware/service_compression_throughput lbaas
-radware/service_ha_pair lbaas
-radware/service_isl_vlan lbaas
-radware/service_resource_pool_ids lbaas
-radware/service_session_mirroring_enabled lbaas
-radware/service_ssl_throughput lbaas
-radware/service_throughput lbaas
-radware/vdirect_address lbaas
-radware/vdirect_password lbaas
-radware/vdirect_user lbaas
-rpc_notifier2/topics rpc
+radware/actions_to_skip lbaas_radware
+radware/ha_secondary_address lbaas_radware
+radware/l2_l3_ctor_params lbaas_radware
+radware/l2_l3_setup_params lbaas_radware
+radware/l2_l3_workflow_name lbaas_radware
+radware/l4_action_name lbaas_radware
+radware/l4_workflow_name lbaas_radware
+radware/service_adc_type lbaas_radware
+radware/service_adc_version lbaas_radware
+radware/service_cache lbaas_radware
+radware/service_compression_throughput lbaas_radware
+radware/service_ha_pair lbaas_radware
+radware/service_isl_vlan lbaas_radware
+radware/service_resource_pool_ids lbaas_radware
+radware/service_session_mirroring_enabled lbaas_radware
+radware/service_ssl_throughput lbaas_radware
+radware/service_throughput lbaas_radware
+radware/vdirect_address lbaas_radware
+radware/vdirect_password lbaas_radware
+radware/vdirect_user lbaas_radware
service_providers/service_provider api
ssl/ca_file ssl
ssl/cert_file ssl
diff --git a/tools/autogenerate-config-flagmappings/nova.flagmappings b/tools/autogenerate-config-flagmappings/nova.flagmappings
index 370dd07657..55c8246b4c 100644
--- a/tools/autogenerate-config-flagmappings/nova.flagmappings
+++ b/tools/autogenerate-config-flagmappings/nova.flagmappings
@@ -4,7 +4,6 @@ allow_instance_snapshots policy
allow_migrate_to_same_host policy
allow_resize_to_same_host policy
allow_same_net_traffic network
-allowed_direct_url_schemes glance
allowed_rpc_exception_modules testing
amqp_auto_delete rpc rpc_all
amqp_durable_queues rpc rpc_all
@@ -27,6 +26,7 @@ cinder_catalog_info volumes
cinder_cross_az_attach volumes
cinder_endpoint_template volumes
cinder_http_retries volumes
+cinder_http_timeout volumes
cnt_vpn_clients network
compute_available_monitors compute
compute_driver compute
@@ -56,7 +56,7 @@ control_exchange rpc rpc_all
cpu_allocation_ratio scheduling
create_unique_mac_address_attempts network
crl_file ca
-db_driver db
+db_driver database
debug logging
default_access_ip_network_name network
default_availability_zone availabilityzones
@@ -117,18 +117,11 @@ forward_bridge_interface network
fping_path fping
gateway network
gateway_v6 ipv6
-glance_api_insecure glance
-glance_api_servers glance
-glance_host glance
-glance_num_retries glance
-glance_port glance
-glance_protocol glance
heal_instance_info_cache_interval compute
host common
image_cache_manager_interval compute
image_cache_subdirectory_name compute
image_decryption_dir s3
-image_handlers compute
injected_network_template network
instance_build_timeout compute
instance_delete_interval compute
@@ -212,21 +205,8 @@ network_manager network
network_size network
network_topic network
networks_path network
-neutron_admin_auth_url neutron
-neutron_admin_password neutron
-neutron_admin_tenant_id neutron
-neutron_admin_tenant_name neutron
-neutron_admin_username neutron
-neutron_api_insecure neutron
-neutron_auth_strategy neutron
-neutron_ca_certificates_file neutron
neutron_default_tenant_id neutron
-neutron_extension_sync_interval neutron
neutron_metadata_proxy_shared_secret neutron
-neutron_ovs_bridge neutron
-neutron_region_name neutron
-neutron_url neutron
-neutron_url_timeout neutron
non_inheritable_image_properties api
notification_driver common
notification_topics common
@@ -277,7 +257,7 @@ quota_driver quota
quota_fixed_ips quota
quota_floating_ips quota
quota_injected_file_content_bytes quota
-quota_injected_file_path_bytes quota
+quota_injected_file_path_length quota
quota_injected_files quota
quota_instances quota
quota_key_pairs quota
@@ -450,7 +430,7 @@ cells/call_timeout cells
cells/capabilities cells
cells/cell_type cells
cells/cells_config cells
-cells/db_check_interval db
+cells/db_check_interval cells
cells/driver cells
cells/enable cells
cells/instance_update_num_instances cells
@@ -475,26 +455,34 @@ conductor/manager conductor
conductor/topic conductor
conductor/use_local conductor
conductor/workers conductor
-database/backend db
-database/connection db
-database/connection_debug db
-database/connection_trace db
-database/db_inc_retry_interval db
-database/db_max_retries db
-database/db_max_retry_interval db
-database/db_retry_interval db
-database/idle_timeout db
-database/max_overflow db
-database/max_pool_size db
-database/max_retries db
-database/min_pool_size db
-database/mysql_sql_mode db
-database/pool_timeout db
-database/retry_interval db
-database/slave_connection db
-database/sqlite_db db
-database/sqlite_synchronous db
-database/use_db_reconnect db
+database/backend database
+database/connection database
+database/connection_debug database
+database/connection_trace database
+database/db_inc_retry_interval database
+database/db_max_retries database
+database/db_max_retry_interval database
+database/db_retry_interval database
+database/idle_timeout database
+database/max_overflow database
+database/max_pool_size database
+database/max_retries database
+database/min_pool_size database
+database/mysql_sql_mode database
+database/pool_timeout database
+database/retry_interval database
+database/slave_connection database
+database/sqlite_db database
+database/sqlite_synchronous database
+database/use_db_reconnect database
+database/use_tpool database
+glance/allowed_direct_url_schemes glance
+glance/api_insecure glance
+glance/api_servers glance
+glance/host glance
+glance/num_retries glance
+glance/port glance
+glance/protocol glance
hyperv/config_drive_cdrom configdrive
hyperv/config_drive_inject_password configdrive
hyperv/dynamic_memory_ratio hyperv
@@ -525,10 +513,13 @@ keystone_authtoken/auth_version auth_token
keystone_authtoken/cache auth_token
keystone_authtoken/cafile auth_token
keystone_authtoken/certfile auth_token
+keystone_authtoken/check_revocations_for_cached auth_token
keystone_authtoken/delay_auth_decision auth_token
keystone_authtoken/enforce_token_bind auth_token
+keystone_authtoken/hash_algorithms auth_token
keystone_authtoken/http_connect_timeout auth_token
keystone_authtoken/http_request_max_retries auth_token
+keystone_authtoken/identity_uri auth_token
keystone_authtoken/include_service_catalog auth_token
keystone_authtoken/insecure auth_token
keystone_authtoken/keyfile auth_token
@@ -594,6 +585,19 @@ metrics/required scheduling
metrics/weight_multiplier scheduling
metrics/weight_of_unavailable scheduling
metrics/weight_setting scheduling
+neutron/admin_auth_url neutron
+neutron/admin_password neutron
+neutron/admin_tenant_id neutron
+neutron/admin_tenant_name neutron
+neutron/admin_username neutron
+neutron/api_insecure neutron
+neutron/auth_strategy neutron
+neutron/ca_certificates_file neutron
+neutron/extension_sync_interval neutron
+neutron/ovs_bridge neutron
+neutron/region_name neutron
+neutron/url neutron
+neutron/url_timeout neutron
osapi_v3/enabled apiv3
osapi_v3/extensions_blacklist apiv3
osapi_v3/extensions_whitelist apiv3
@@ -629,6 +633,7 @@ vmware/cluster_name vmware
vmware/datastore_regex vmware
vmware/host_ip vmware
vmware/host_password vmware
+vmware/host_port vmware
vmware/host_username vmware
vmware/integration_bridge vmware
vmware/maximum_objects vmware
diff --git a/tools/autogenerate-config-flagmappings/trove.flagmappings b/tools/autogenerate-config-flagmappings/trove.flagmappings
index 9955823b42..0c039fa487 100644
--- a/tools/autogenerate-config-flagmappings/trove.flagmappings
+++ b/tools/autogenerate-config-flagmappings/trove.flagmappings
@@ -24,6 +24,7 @@ backup_use_snet backup
backups_page_size backup
bind_port api
block_device_mapping volume
+cinder_service_type volume
cinder_url volume
cloudinit_location taskmanager
conductor_queue amqp
@@ -65,12 +66,14 @@ fatal_deprecations debug
format_options logging
guest_config guestagent
guest_id guestagent
+heat_service_type heat
heat_time_out heat
heat_url heat
host rpc
hostname_require_ipv4 api
http_delete_rate api
http_get_rate api
+http_mgmt_post_rate api
http_post_rate api
http_put_rate api
ignore_dbs guestagent
@@ -106,11 +109,13 @@ network_label_regex logging
notification_driver amqp
notification_service_id amqp
notification_topics amqp
+nova_compute_service_type compute
nova_compute_url compute
nova_proxy_admin_pass nova
nova_proxy_admin_tenant_name nova
nova_proxy_admin_user nova
num_tries rpc
+os_region_name api
periodic_interval rpc
publish_errors logging
pybasedir common
@@ -173,6 +178,7 @@ sql_query_logging database
state_change_wait_time taskmanager
storage_namespace guestagent
storage_strategy guestagent
+swift_service_type swift
swift_url swift
syslog_log_facility logging
taskmanager_queue common
@@ -205,6 +211,7 @@ cassandra/udp_ports db_cassandra
cassandra/usage_timeout db_cassandra
couchbase/backup_strategy db_couchbase
couchbase/mount_point db_couchbase
+couchbase/root_on_create db_couchbase
couchbase/tcp_ports db_couchbase
couchbase/udp_ports db_couchbase
couchbase/usage_timeout db_couchbase
@@ -221,10 +228,13 @@ keystone_authtoken/auth_version auth_token
keystone_authtoken/cache auth_token
keystone_authtoken/cafile auth_token
keystone_authtoken/certfile auth_token
+keystone_authtoken/check_revocations_for_cached auth_token
keystone_authtoken/delay_auth_decision auth_token
keystone_authtoken/enforce_token_bind auth_token
+keystone_authtoken/hash_algorithms auth_token
keystone_authtoken/http_connect_timeout auth_token
keystone_authtoken/http_request_max_retries auth_token
+keystone_authtoken/identity_uri auth_token
keystone_authtoken/include_service_catalog auth_token
keystone_authtoken/insecure auth_token
keystone_authtoken/keyfile auth_token