openstack
/
openstack-manuals
Code Issues Proposed changes

Rework the config reference tables 

Try to use the same categories for options found in multiple projects.

Change-Id: If582194081854b06542ca32335c6225ac94de013
Closes-Bug: #1363485
This commit is contained in:
Gauvain Pocentek 2014-10-03 08:35:58 +02:00
parent b878ba9ef1
commit a8e0a7f97d
119 changed files with 1255 additions and 1330 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -25,6 +25,10 @@
<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>notification_driver = []</td>
<td>(MultiStrOpt) Driver or drivers to handle sending notifications.</td>
@ -33,6 +37,10 @@
<td>notification_topics = notifications</td>
<td>(ListOpt) AMQP topic used for OpenStack notifications.</td>
</tr>
<tr>
<td>transport_url = None</td>
<td>(StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration.</td>
</tr>
</tbody>
</table>
</para>

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

@ -117,10 +117,6 @@
<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>

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

@ -17,14 +17,6 @@
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>backdoor_port = None</td>
<td>(StrOpt) Enable eventlet backdoor. Acceptable values are 0, &lt;port&gt;, and &lt;start&gt;:&lt;end&gt;, where 0 results in listening on a random tcp port number; &lt;port&gt; results in listening on the specified port number (and not enabling backdoor if that port is in use); and &lt;start&gt;:&lt;end&gt; results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.</td>
</tr>
<tr>
<td>disable_process_locking = False</td>
<td>(BoolOpt) Enables or disables inter-process locks.</td>
</tr>
<tr>
<td>host = localhost</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>
@ -70,6 +62,13 @@
<td>heartbeat = 1.0</td>
<td>(FloatOpt) Number of seconds between heartbeats for distributed coordination (float)</td>
</tr>
<tr>
<th colspan="2">[keystone_authtoken]</th>
</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>
</tbody>
</table>
</para>

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

@ -4,7 +4,7 @@
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_ceilometer_debug">
<caption>Description of debug configuration options</caption>
<caption>Description of logging configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
@ -18,8 +18,12 @@
<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>
<td>backdoor_port = None</td>
<td>(StrOpt) Enable eventlet backdoor. Acceptable values are 0, &lt;port&gt;, and &lt;start&gt;:&lt;end&gt;, where 0 results in listening on a random tcp port number; &lt;port&gt; results in listening on the specified port number (and not enabling backdoor if that port is in use); and &lt;start&gt;:&lt;end&gt; results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.</td>
</tr>
<tr>
<td>disable_process_locking = False</td>
<td>(BoolOpt) Enables or disables inter-process locks.</td>
</tr>
<tr>
<td>nova_http_log_debug = False</td>

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

@ -21,10 +21,6 @@
<td>cinder_control_exchange = cinder</td>
<td>(StrOpt) Exchange name for Cinder notifications.</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>glance_control_exchange = glance</td>
<td>(StrOpt) Exchange name for Glance notifications.</td>

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

@ -17,6 +17,10 @@
<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, urllib3.connectionpool=WARN, websocket=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN</td>
<td>(ListOpt) List of logger=LEVEL pairs.</td>

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

@ -17,10 +17,6 @@
<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>

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

@ -14,17 +14,6 @@
</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_redis]</th>
</tr>

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

@ -22,8 +22,16 @@
<td>(MultiStrOpt) Dispatcher to process data.</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>
<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 = 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>
@ -31,47 +39,15 @@
</tr>
<tr>
<td>rpc_conn_pool_size = 30</td>
<td>(IntOpt) Size of RPC connection pool.</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>
<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 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 = localhost</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>
<td>(IntOpt) Size of RPC thread pool</td>
</tr>
<tr>
<th colspan="2">[notification]</th>

12
doc/common/tables/neutron-notifier.xml → doc/common/tables/ceilometer-testing.xml
View File

@ -3,8 +3,8 @@
<!-- Warning: Do not edit this file. It is automatically
generated 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 notifier configuration options</caption>
<table rules="all" xml:id="config_table_ceilometer_testing">
<caption>Description of testing configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
@ -18,12 +18,8 @@
<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>
<td>fake_rabbit = False</td>
<td>(BoolOpt) If passed, use a fake RabbitMQ provider</td>
</tr>
</tbody>
</table>

50
doc/common/tables/ceilometer-zeromq.xml Normal file
View File

@ -0,0 +1,50 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_ceilometer_zeromq">
<caption>Description of ZeroMQ configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>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 = localhost</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>

46
doc/common/tables/cinder-amqp.xml Normal file
View File

@ -0,0 +1,46 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated 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_amqp">
<caption>Description of AMQP configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>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>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>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>

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

@ -30,8 +30,8 @@
<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, &lt;port&gt;, and &lt;start&gt;:&lt;end&gt;, where 0 results in listening on a random tcp port number; &lt;port&gt; results in listening on the specified port number (and not enabling backdoor if that port is in use); and &lt;start&gt;:&lt;end&gt; results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.</td>
<td>default_timeout = 525600</td>
<td>(IntOpt) Default timeout for CLI operations in minutes. For example, LUN migration is a typical long running operation, which depends on the LUN size and the load of the array. An upper bound in the specific deployment can be set to avoid unnecessary long wait. By default, it is 365 days long.</td>
</tr>
<tr>
<td>enable_v1_api = True</td>

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

@ -14,13 +14,6 @@
</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>
@ -124,10 +117,6 @@
<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>

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

@ -33,10 +33,6 @@
<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>
@ -57,6 +53,10 @@
<td>lock_path = None</td>
<td>(StrOpt) Directory to use for lock files. Default to a temp directory</td>
</tr>
<tr>
<td>memcached_servers = None</td>
<td>(ListOpt) Memcached servers or None for in process cache.</td>
</tr>
<tr>
<td>monkey_patch = False</td>
<td>(BoolOpt) Enable monkey patching</td>
@ -158,8 +158,11 @@
<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>
<th colspan="2">[keystone_authtoken]</th>
</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>
</tbody>
</table>

30
doc/common/tables/cinder-debug.xml Normal file
View File

@ -0,0 +1,30 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated 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_debug">
<caption>Description of logging configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>backdoor_port = None</td>
<td>(StrOpt) Enable eventlet backdoor. Acceptable values are 0, &lt;port&gt;, and &lt;start&gt;:&lt;end&gt;, where 0 results in listening on a random tcp port number; &lt;port&gt; results in listening on the specified port number (and not enabling backdoor if that port is in use); and &lt;start&gt;:&lt;end&gt; results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.</td>
</tr>
<tr>
<td>disable_process_locking = False</td>
<td>(BoolOpt) Whether to disable inter-process locks</td>
</tr>
</tbody>
</table>
</para>

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

@ -85,6 +85,10 @@
<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>

66
doc/common/tables/cinder-qpid.xml Normal file
View File

@ -0,0 +1,66 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated 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_qpid">
<caption>Description of Qpid configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[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_receiver_capacity = 1</td>
<td>(IntOpt) The number of prefetched messages held by receiver.</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>

90
doc/common/tables/cinder-rabbitmq.xml Normal file
View File

@ -0,0 +1,90 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated 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_rabbitmq">
<caption>Description of RabbitMQ configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[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>

18
doc/common/tables/glance-matchmaker.xml → doc/common/tables/cinder-redis.xml
View File

@ -3,8 +3,8 @@
<!-- Warning: Do not edit this file. It is automatically
generated 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 matchmaker configuration options</caption>
<table rules="all" xml:id="config_table_cinder_redis">
<caption>Description of Redis configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
@ -15,15 +15,19 @@
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
<th colspan="2">[matchmaker_redis]</th>
</tr>
<tr>
<td>matchmaker_heartbeat_freq = 300</td>
<td>(IntOpt) Heartbeat frequency.</td>
<td>host = 127.0.0.1</td>
<td>(StrOpt) Host to locate redis.</td>
</tr>
<tr>
<td>matchmaker_heartbeat_ttl = 600</td>
<td>(IntOpt) Heartbeat time-to-live.</td>
<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>

194
doc/common/tables/cinder-rpc.xml
View File

@ -17,46 +17,6 @@
<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_timeout = 525600</td>
<td>(IntOpt) Default timeout for CLI operations in minutes. For example, LUN migration is a typical long running operation, which depends on the LUN size and the load of the array. An upper bound in the specific deployment can be set to avoid unnecessary long wait. By default, it is 365 days long.</td>
</tr>
<tr>
<td>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>
@ -65,106 +25,6 @@
<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>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_receiver_capacity = 1</td>
<td>(IntOpt) The number of prefetched messages held by receiver.</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>
@ -185,64 +45,10 @@
<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 = localhost</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_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>

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

@ -31,7 +31,7 @@
</tr>
<tr>
<td>sf_emulate_512 = True</td>
<td>(BoolOpt) Set 512 byte emulation on volume creation; </td>
<td>(BoolOpt) Set 512 byte emulation on volume creation;</td>
</tr>
</tbody>
</table>

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

@ -0,0 +1,26 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_testing">
<caption>Description of testing configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>fake_rabbit = False</td>
<td>(BoolOpt) If passed, use a fake RabbitMQ provider.</td>
</tr>
</tbody>
</table>
</para>

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

@ -0,0 +1,50 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_zeromq">
<caption>Description of ZeroMQ configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>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 = localhost</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>

24
doc/common/tables/glance-amqp.xml
View File

@ -25,6 +25,14 @@
<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 = image.localhost</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>
@ -33,22 +41,6 @@
<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>

27
doc/common/tables/glance-api.xml
View File

@ -25,10 +25,6 @@
<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>enable_v1_api = True</td>
<td>(BoolOpt) Deploy the v1 OpenStack Images API.</td>
@ -45,6 +41,10 @@
<td>enable_v2_registry = True</td>
<td>(BoolOpt) Deploy the v2 OpenStack Registry API.</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>image_size_cap = 1099511627776</td>
<td>(IntOpt) Maximum size of image a user can upload in bytes. Defaults to 1099511627776 bytes (1 TB).</td>
@ -53,6 +53,10 @@
<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>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>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>
@ -65,6 +69,10 @@
<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>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>
<tr>
<td>use_user_token = True</td>
<td>(BoolOpt) Whether to pass through the user token when making requests to the registry.</td>
@ -80,6 +88,17 @@
<td>stores = file, http</td>
<td>(ListOpt) List of stores enabled</td>
</tr>
<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>
<tr>
<th colspan="2">[store_type_location_strategy]</th>
</tr>

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

@ -14,13 +14,6 @@
</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>
@ -124,10 +117,6 @@
<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>

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

@ -41,10 +41,6 @@
<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) Enables or disables 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>
@ -69,6 +65,10 @@
<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>metadata_encryption_key = None</td>
<td>(StrOpt) Key used for encrypting sensitive metadata while talking to the registry or database.</td>
@ -115,6 +115,13 @@
<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">[keystone_authtoken]</th>
</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>
<th colspan="2">[task]</th>
</tr>

26
doc/common/tables/glance-debug.xml Normal file
View File

@ -0,0 +1,26 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_glance_debug">
<caption>Description of logging configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>disable_process_locking = False</td>
<td>(BoolOpt) Enables or disables inter-process locks.</td>
</tr>
</tbody>
</table>
</para>

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

@ -1,30 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_glance_paste">
<caption>Description of paste configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[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>

8
doc/common/tables/glance-rabbitmq.xml
View File

@ -17,14 +17,6 @@
<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>

7
doc/common/tables/glance-redis.xml
View File

@ -29,6 +29,13 @@
<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>

28
doc/common/tables/glance-rpc.xml
View File

@ -21,6 +21,34 @@
<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>
<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>
</tbody>
</table>
</para>

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

@ -17,6 +17,10 @@
<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>pydev_worker_debug_host = None</td>
<td>(StrOpt) The hostname/IP of the pydev process listening for debug connections</td>

34
doc/common/tables/glance-wsgi.xml
View File

@ -1,34 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_glance_wsgi">
<caption>Description of WSGI configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>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>

4
doc/common/tables/glance-zeromq.xml
View File

@ -17,10 +17,6 @@
<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>

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

@ -27,7 +27,7 @@
</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>
<td>(StrOpt) AMQP exchange to connect to if using RabbitMQ or Qpid</td>
</tr>
<tr>
<td>default_notification_level = INFO</td>
@ -37,10 +37,6 @@
<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>
@ -53,6 +49,10 @@
<td>notification_topics = notifications</td>
<td>(ListOpt) AMQP topic used for OpenStack notifications.</td>
</tr>
<tr>
<td>transport_url = None</td>
<td>(StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration.</td>
</tr>
</tbody>
</table>
</para>

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

@ -14,13 +14,6 @@
</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>
@ -124,10 +117,6 @@
<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>

11
doc/common/tables/heat-common.xml
View File

@ -49,6 +49,10 @@
<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>periodic_interval = 60</td>
<td>(IntOpt) Seconds between running periodic tasks.</td>
@ -57,6 +61,13 @@
<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">[keystone_authtoken]</th>
</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>
<th colspan="2">[revision]</th>
</tr>

6
doc/common/tables/heat-debug.xml
View File

@ -4,7 +4,7 @@
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_heat_debug">
<caption>Description of debug configuration options</caption>
<caption>Description of logging configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
@ -21,10 +21,6 @@
<td>backdoor_port = None</td>
<td>(StrOpt) Enable eventlet backdoor. Acceptable values are 0, &lt;port&gt;, and &lt;start&gt;:&lt;end&gt;, where 0 results in listening on a random tcp port number; &lt;port&gt; results in listening on the specified port number (and not enabling backdoor if that port is in use); and &lt;start&gt;:&lt;end&gt; results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.</td>
</tr>
<tr>
<td>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>

8
doc/common/tables/heat-logging.xml
View File

@ -17,6 +17,10 @@
<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>
@ -69,6 +73,10 @@
<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>

4
doc/common/tables/heat-notification.xml
View File

@ -21,10 +21,6 @@
<td>onready = None</td>
<td>(StrOpt) Deprecated.</td>
</tr>
<tr>
<td>publish_errors = False</td>
<td>(BoolOpt) Enables or disables publication of error events.</td>
</tr>
</tbody>
</table>
</para>

7
doc/common/tables/heat-redis.xml
View File

@ -29,6 +29,13 @@
<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>

21
doc/common/tables/heat-rpc.xml
View File

@ -30,8 +30,8 @@
<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>
<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>
@ -39,26 +39,15 @@
</tr>
<tr>
<td>rpc_conn_pool_size = 30</td>
<td>(IntOpt) Size of RPC connection pool.</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>
<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 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>
<tr>
<th colspan="2">[matchmaker_ring]</th>
</tr>
<tr>
<td>ringfile = /etc/oslo/matchmaker_ring.json</td>
<td>(StrOpt) Matchmaker ring file (JSON).</td>
<td>(IntOpt) Size of RPC thread pool</td>
</tr>
</tbody>
</table>

8
doc/common/tables/keystone-misc.xml → doc/common/tables/heat-testing.xml
View File

@ -3,8 +3,8 @@
<!-- Warning: Do not edit this file. It is automatically
generated 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>
<table rules="all" xml:id="config_table_heat_testing">
<caption>Description of testing configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
@ -18,8 +18,8 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>lock_path = None</td>
<td>(StrOpt) Directory to use for lock files.</td>
<td>fake_rabbit = False</td>
<td>(BoolOpt) If passed, use a fake RabbitMQ provider</td>
</tr>
</tbody>
</table>

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

@ -41,26 +41,6 @@
<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>

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

@ -14,13 +14,6 @@
</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>
@ -124,10 +117,6 @@
<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>

15
doc/common/tables/neutron-wsgi.xml → doc/common/tables/keystone-common.xml
View File

@ -3,8 +3,8 @@
<!-- Warning: Do not edit this file. It is automatically
generated 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 WSGI configuration options</caption>
<table rules="all" xml:id="config_table_keystone_common">
<caption>Description of common configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
@ -18,16 +18,15 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>backlog = 4096</td>
<td>(IntOpt) Number of backlog requests to configure the socket with</td>
<td>memcached_servers = None</td>
<td>(ListOpt) Memcached servers or None for in process cache.</td>
</tr>
<tr>
<td>retry_until_window = 30</td>
<td>(IntOpt) Number of seconds to keep retrying to listen</td>
<th colspan="2">[keystone_authtoken]</th>
</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>
<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>
</tbody>
</table>

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

@ -4,7 +4,7 @@
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_keystone_debug">
<caption>Description of debug configuration options</caption>
<caption>Description of logging configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
@ -21,18 +21,6 @@
<td>backdoor_port = None</td>
<td>(StrOpt) Enable eventlet backdoor. Acceptable values are 0, &lt;port&gt;, and &lt;start&gt;:&lt;end&gt;, where 0 results in listening on a random tcp port number; &lt;port&gt; results in listening on the specified port number (and not enabling backdoor if that port is in use); and &lt;start&gt;:&lt;end&gt; results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.</td>
</tr>
<tr>
<td>debug = False</td>
<td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).</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>

12
doc/common/tables/keystone-logging.xml
View File

@ -17,10 +17,18 @@
<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, urllib3.connectionpool=WARN, websocket=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=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>
@ -65,6 +73,10 @@
<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>

4
doc/common/tables/keystone-rabbitmq.xml
View File

@ -17,10 +17,6 @@
<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>

11
doc/common/tables/keystone-redis.xml
View File

@ -14,17 +14,6 @@
</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_redis]</th>
</tr>

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

@ -4,7 +4,7 @@
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_keystone_rpc">
<caption>Description of configuration options for rpc</caption>
<caption>Description of RPC configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
@ -18,8 +18,32 @@
<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>
<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>
</tbody>
</table>

93
doc/common/tables/keystone-ssl.xml
View File

@ -1,93 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_keystone_ssl">
<caption>Description of SSL configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[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>

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

@ -0,0 +1,26 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_keystone_testing">
<caption>Description of testing configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>fake_rabbit = False</td>
<td>(BoolOpt) If passed, use a fake RabbitMQ provider.</td>
</tr>
</tbody>
</table>
</para>

46
doc/common/tables/neutron-amqp.xml Normal file
View File

@ -0,0 +1,46 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated 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_amqp">
<caption>Description of AMQP configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>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>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>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>

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

@ -37,6 +37,10 @@
<td>api_paste_config = api-paste.ini</td>
<td>(StrOpt) The API paste config file to use</td>
</tr>
<tr>
<td>backlog = 4096</td>
<td>(IntOpt) Number of backlog requests to configure the socket with</td>
</tr>
<tr>
<td>max_header_line = 16384</td>
<td>(IntOpt) Max header line to accommodate large tokens</td>
@ -49,6 +53,10 @@
<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>retry_until_window = 30</td>
<td>(IntOpt) Number of seconds to keep retrying to listen</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>
@ -57,6 +65,10 @@
<td>service_plugins = </td>
<td>(ListOpt) The service plugins Neutron will use</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>
<th colspan="2">[service_providers]</th>
</tr>

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

@ -14,13 +14,6 @@
</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>
@ -124,10 +117,6 @@
<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>

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

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

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

@ -125,10 +125,6 @@
<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 = publicURL</td>
<td>(StrOpt) Network service endpoint type to pull from the keystone catalog</td>
@ -173,6 +169,10 @@
<td>max_subnet_host_routes = 20</td>
<td>(IntOpt) Maximum number of host routes per subnet</td>
</tr>
<tr>
<td>memcached_servers = None</td>
<td>(ListOpt) Memcached servers or None for in process cache.</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>
@ -234,6 +234,13 @@
<td>admin_password = None</td>
<td>(StrOpt) ESM admin password.</td>
</tr>
<tr>
<th colspan="2">[keystone_authtoken]</th>
</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>
</tbody>
</table>
</para>

30
doc/common/tables/neutron-debug.xml Normal file
View File

@ -0,0 +1,30 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated 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_debug">
<caption>Description of logging configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>backdoor_port = None</td>
<td>(StrOpt) Enable eventlet backdoor. Acceptable values are 0, &lt;port&gt;, and &lt;start&gt;:&lt;end&gt;, where 0 results in listening on a random tcp port number; &lt;port&gt; results in listening on the specified port number (and not enabling backdoor if that port is in use); and &lt;start&gt;:&lt;end&gt; results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.</td>
</tr>
<tr>
<td>disable_process_locking = False</td>
<td>(BoolOpt) Whether to disable inter-process locks</td>
</tr>
</tbody>
</table>
</para>

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

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

7
doc/common/tables/neutron-redis.xml
View File

@ -29,6 +29,13 @@
<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>

33
doc/common/tables/neutron-rpc.xml
View File

@ -17,18 +17,6 @@
<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) 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>
@ -38,8 +26,8 @@
<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>
<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>
@ -47,24 +35,20 @@
</tr>
<tr>
<td>rpc_conn_pool_size = 30</td>
<td>(IntOpt) Size of RPC connection pool.</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>
<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 greenthread pool.</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>
@ -72,13 +56,6 @@
<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>

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

@ -17,13 +17,9 @@
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>backdoor_port = None</td>
<td>(StrOpt) Enable eventlet backdoor. Acceptable values are 0, &lt;port&gt;, and &lt;start&gt;:&lt;end&gt;, where 0 results in listening on a random tcp port number; &lt;port&gt; results in listening on the specified port number (and not enabling backdoor if that port is in use); and &lt;start&gt;:&lt;end&gt; results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.</td>
</tr>
<tr>
<td>fake_rabbit = False</td>
<td>(BoolOpt) If passed, use a fake RabbitMQ provider.</td>
<td>(BoolOpt) If passed, use a fake RabbitMQ provider</td>
</tr>
</tbody>
</table>

50
doc/common/tables/nova-amqp.xml Normal file
View File

@ -0,0 +1,50 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_nova_amqp">
<caption>Description of AMQP configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>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>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>

16
doc/common/tables/nova-api.xml
View File

@ -17,6 +17,10 @@
<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>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>
@ -89,10 +93,22 @@
<td>snapshot_name_template = snapshot-%s</td>
<td>(StrOpt) Template string to be used to generate snapshot names</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>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>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>

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

@ -117,10 +117,6 @@
<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>

12
doc/common/tables/nova-ca.xml
View File

@ -49,6 +49,18 @@
<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>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>use_project_ca = False</td>
<td>(BoolOpt) Should we use a CA for each project?</td>

19
doc/common/tables/nova-common.xml
View File

@ -33,10 +33,6 @@
<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) Enables or disables inter-process locks.</td>
</tr>
<tr>
<td>host = localhost</td>
<td>(StrOpt) Name of this node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address. However, the node name must be valid within an AMQP key, and if using ZeroMQ, a valid hostname, FQDN, or IP address</td>
@ -53,14 +49,6 @@
<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>
@ -94,8 +82,11 @@
<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>
<th colspan="2">[keystone_authtoken]</th>
</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>
</tbody>
</table>

4
doc/common/tables/nova-compute.xml
View File

@ -57,10 +57,6 @@
<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>

30
doc/common/tables/nova-debug.xml Normal file
View File

@ -0,0 +1,30 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated 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_debug">
<caption>Description of logging configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>backdoor_port = None</td>
<td>(StrOpt) Enable eventlet backdoor. Acceptable values are 0, &lt;port&gt;, and &lt;start&gt;:&lt;end&gt;, where 0 results in listening on a random tcp port number; &lt;port&gt; results in listening on the specified port number (and not enabling backdoor if that port is in use); and &lt;start&gt;:&lt;end&gt; results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.</td>
</tr>
<tr>
<td>disable_process_locking = False</td>
<td>(BoolOpt) Enables or disables inter-process locks.</td>
</tr>
</tbody>
</table>
</para>

42
doc/common/tables/nova-kombu.xml
View File

@ -1,42 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_nova_kombu">
<caption>Description of kombu configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>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>

20
doc/common/tables/nova-rabbitmq.xml
View File

@ -17,6 +17,26 @@
<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>

7
doc/common/tables/nova-redis.xml
View File

@ -29,6 +29,13 @@
<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>

19
doc/common/tables/nova-rpc.xml
View File

@ -17,18 +17,6 @@
<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>
@ -64,13 +52,6 @@
<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>

223
doc/common/tables/nova-rpc_all.xml
View File

@ -1,223 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_nova_rpc_all">
<caption>Description of all RPC configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>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_receiver_capacity = 1</td>
<td>(IntOpt) The number of prefetched messages held by receiver.</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 = localhost</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>

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

@ -17,10 +17,6 @@
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>backdoor_port = None</td>
<td>(StrOpt) Enable eventlet backdoor. Acceptable values are 0, &lt;port&gt;, and &lt;start&gt;:&lt;end&gt;, where 0 results in listening on a random tcp port number; &lt;port&gt; results in listening on the specified port number (and not enabling backdoor if that port is in use); and &lt;start&gt;:&lt;end&gt; results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.</td>
</tr>
<tr>
<td>fake_call = False</td>
<td>(BoolOpt) If True, skip using the queue and make local calls</td>

50
doc/common/tables/nova-wsgi.xml
View File

@ -1,50 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_nova_wsgi">
<caption>Description of WSGI configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>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>

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

@ -25,6 +25,10 @@
<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>notification_driver = []</td>
<td>(MultiStrOpt) Driver or drivers to handle sending notifications.</td>
@ -41,6 +45,10 @@
<td>notification_topics = notifications</td>
<td>(ListOpt) AMQP topic used for OpenStack notifications.</td>
</tr>
<tr>
<td>transport_url = None</td>
<td>(StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration.</td>
</tr>
</tbody>
</table>
</para>

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

@ -117,10 +117,6 @@
<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>

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

@ -30,10 +30,6 @@
compute2 /rack2
compute3 /rack2</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>detach_volume_timeout = 300</td>
<td>(IntOpt) Timeout for detaching volumes from instance (in seconds).</td>
@ -132,10 +128,6 @@
node2 /rack2
node3 /rack2</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>use_floating_ips = True</td>
<td>(BoolOpt) If set to True, Sahara will use floating IPs to communicate with instances. To make sure that all instances have floating IPs assigned in Nova Network set "auto_assign_floating_ip=True" in nova.conf. If Neutron is used for networking, make sure that all Node Groups have "floating_ip_pool" parameter defined.</td>
@ -159,6 +151,13 @@
<td>use_local = True</td>
<td>(BoolOpt) Perform sahara-conductor operations locally.</td>
</tr>
<tr>
<th colspan="2">[keystone_authtoken]</th>
</tr>
<tr>
<td>memcached_servers = None</td>
<td>(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.</td>
</tr>
</tbody>
</table>
</para>

10
doc/common/tables/sahara-debug.xml
View File

@ -4,7 +4,7 @@
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_sahara_debug">
<caption>Description of debug configuration options</caption>
<caption>Description of logging configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
@ -17,18 +17,10 @@
<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>disable_process_locking = False</td>
<td>(BoolOpt) Enables or disables inter-process locks.</td>
</tr>
<tr>
<td>fake_rabbit = False</td>
<td>(BoolOpt) If passed, use a fake RabbitMQ provider.</td>
</tr>
</tbody>
</table>
</para>

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

@ -17,6 +17,10 @@
<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 = amqplib=WARN, qpid.messaging=INFO, stevedore=INFO, eventlet.wsgi.server=WARN, sqlalchemy=WARN, boto=WARN, suds=INFO, keystone=INFO, paramiko=WARN, requests=WARN, iso8601=WARN</td>
<td>(ListOpt) List of logger=LEVEL pairs.</td>

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

@ -17,6 +17,26 @@
<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>

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

@ -17,26 +17,6 @@
<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>matchmaker_heartbeat_freq = 300</td>
<td>(IntOpt) Heartbeat frequency.</td>

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

@ -0,0 +1,26 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_sahara_testing">
<caption>Description of testing configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>fake_rabbit = False</td>
<td>(BoolOpt) If passed, use a fake RabbitMQ provider.</td>
</tr>
</tbody>
</table>
</para>

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

@ -38,24 +38,8 @@
<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>
<td>default_publisher_id = $host</td>
<td>(StrOpt) Default publisher_id for outgoing notifications</td>
</tr>
<tr>
<td>notification_driver = []</td>

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

@ -14,13 +14,6 @@
</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>
@ -124,10 +117,6 @@
<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>

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

@ -41,10 +41,6 @@
<td>default_password_length = 36</td>
<td>(IntOpt) Character length of generated passwords.</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>
@ -57,6 +53,10 @@
<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>pybasedir = /usr/lib/python/site-packages/trove/trove</td>
<td>(StrOpt) Directory where the Trove python module is installed.</td>
@ -77,6 +77,13 @@
<td>usage_timeout = 600</td>
<td>(IntOpt) Maximum time (in seconds) to wait for a Guest to become active.</td>
</tr>
<tr>
<th colspan="2">[keystone_authtoken]</th>
</tr>
<tr>
<td>memcached_servers = None</td>
<td>(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.</td>
</tr>
</tbody>
</table>
</para>

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

@ -4,7 +4,7 @@
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_trove_debug">
<caption>Description of debug configuration options</caption>
<caption>Description of logging configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
@ -25,10 +25,6 @@
<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>

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

@ -17,6 +17,10 @@
<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, urllib3.connectionpool=WARN, websocket=WARN</td>
<td>(ListOpt) List of logger=LEVEL pairs.</td>

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

@ -17,6 +17,22 @@
<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>

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

@ -0,0 +1,26 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_trove_testing">
<caption>Description of testing configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>fake_rabbit = False</td>
<td>(BoolOpt) If passed, use a fake RabbitMQ provider</td>
</tr>
</tbody>
</table>
</para>

7
doc/config-reference/block-storage/section_misc.xml
View File

@ -21,6 +21,11 @@
<xi:include href="../../common/tables/cinder-keymgr.xml"/>
<xi:include href="../../common/tables/cinder-storage.xml"/>
<xi:include href="../../common/tables/cinder-rpc.xml"/>
<xi:include href="../../common/tables/cinder-amqp.xml"/>
<xi:include href="../../common/tables/cinder-qpid.xml"/>
<xi:include href="../../common/tables/cinder-rabbitmq.xml"/>
<xi:include href="../../common/tables/cinder-redis.xml"/>
<xi:include href="../../common/tables/cinder-zeromq.xml"/>
<xi:include href="../../common/tables/cinder-san-solaris.xml"/>
<xi:include href="../../common/tables/cinder-rootwrap.xml"/>
<xi:include href="../../common/tables/cinder-ca.xml"/>
@ -41,6 +46,8 @@
<xi:include href="../../common/tables/cinder-quota.xml"/>
<xi:include href="../../common/tables/cinder-common.xml"/>
<xi:include href="../../common/tables/cinder-logging.xml"/>
<xi:include href="../../common/tables/cinder-debug.xml"/>
<xi:include href="../../common/tables/cinder-testing.xml"/>
<xi:include href="../../common/tables/cinder-profiler.xml"/>
<xi:include href="../../common/tables/cinder-fusionio.xml"/>
<xi:include href="../../common/tables/cinder-hitachi.xml"/>

1
doc/config-reference/ch_databaseserviceconfigure.xml
View File

@ -29,6 +29,7 @@
<xi:include href="../common/tables/trove-nova.xml"/>
<xi:include href="../common/tables/trove-quota.xml"/>
<xi:include href="../common/tables/trove-redis.xml"/>
<xi:include href="../common/tables/trove-testing.xml"/>
<xi:include href="../common/tables/trove-swift.xml"/>
<xi:include href="../common/tables/trove-taskmanager.xml"/>
<xi:include href="../common/tables/trove-volume.xml"/>

1
doc/config-reference/ch_dataprocessingserviceconfigure.xml
View File

@ -24,6 +24,7 @@
<xi:include href="../common/tables/sahara-rabbitmq.xml"/>
<xi:include href="../common/tables/sahara-redis.xml"/>
<xi:include href="../common/tables/sahara-rpc.xml"/>
<xi:include href="../common/tables/sahara-testing.xml"/>
<xi:include href="../common/tables/sahara-zeromq.xml"/>
</chapter>

4
doc/config-reference/ch_identityconfigure.xml
View File

@ -59,6 +59,7 @@ options. For installation prerequisites and step-by-step walkthroughs, see the
<xi:include href="../common/tables/keystone-auth_token.xml"/>
<xi:include href="../common/tables/keystone-ca.xml"/>
<xi:include href="../common/tables/keystone-catalog.xml"/>
<xi:include href="../common/tables/keystone-common.xml"/>
<xi:include href="../common/tables/keystone-credential.xml"/>
<xi:include href="../common/tables/keystone-database.xml"/>
<xi:include href="../common/tables/keystone-debug.xml"/>
@ -70,15 +71,14 @@ 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-mapping.xml"/>
<xi:include href="../common/tables/keystone-memcache.xml"/>
<xi:include href="../common/tables/keystone-misc.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"/>
<xi:include href="../common/tables/keystone-revoke.xml"/>
<xi:include href="../common/tables/keystone-saml.xml"/>
<xi:include href="../common/tables/keystone-security.xml"/>
<xi:include href="../common/tables/keystone-ssl.xml"/>
<xi:include href="../common/tables/keystone-stats.xml"/>
<xi:include href="../common/tables/keystone-testing.xml"/>
<xi:include href="../common/tables/keystone-token.xml"/>
<xi:include href="../common/tables/keystone-trust.xml"/>

2
doc/config-reference/ch_imageservice.xml
View File

@ -28,8 +28,6 @@
<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"/>
<xi:include href="../common/tables/glance-paste.xml"/>
<xi:include href="../common/tables/glance-policy.xml"/>
<xi:include href="../common/tables/glance-profiler.xml"/>
<xi:include href="../common/tables/glance-redis.xml"/>

1
doc/config-reference/ch_orchestrationconfigure.xml
View File

@ -25,6 +25,7 @@
<xi:include href="../common/tables/heat-logging.xml"/>
<xi:include href="../common/tables/heat-quota.xml"/>
<xi:include href="../common/tables/heat-redis.xml"/>
<xi:include href="../common/tables/heat-testing.xml"/>
<xi:include href="orchestration/section_orchestration-api.xml"/>
<xi:include href="orchestration/section_orchestration-clients.xml"/>
<xi:include href="orchestration/section_orchestration-rpc.xml"/>

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