openstack
/
openstack-manuals
Code Issues Proposed changes

Update the config reference tables 

Include the new tables in the documentation.

Fix the cinder-prophetstor_dpl.xml filename and the xiv category.

Manually fix those files for niceness test:
- glance-logging.xml (lines 34, 38), fixed in oslo-incubator
- trove-logging.xml (lines 26, 30), fixed in oslo-incubator
- neutron-openvswitch_agent.xml (line 45), to be fixed in neutron

Closes-Bug: #1340858
Closes-Bug: #1344231
Closes-Bug: #1345956
Closes-Bug: #1346711
Closes-Bug: #1347978
Partial-Bug: #1348329
Closes-Bug: #1352074
Partial-Bug: #1353417
Closes-Bug: #1354622
Closes-Bug: #1339754
Closes-Bug: #1358598
Closes-Bug: #1358259
Closes-Bug: #1357865
Partial-Bug: #1357457
Closes-Bug: #1357421
Change-Id: Id2da7d7762ca954bd552dbf89a9ff28b144efb68
This commit is contained in:
Gauvain Pocentek 2014-08-19 11:22:22 +02:00
parent d1dd2505f3
commit 8b2016b5d0
141 changed files with 1530 additions and 485 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -21,10 +21,6 @@
<td>evaluation_interval = 60</td> <td>evaluation_interval = 60</td>
<td>(IntOpt) Period of evaluation cycle, should be &gt;= than configured pipeline interval for collection of underlying metrics.</td> <td>(IntOpt) Period of evaluation cycle, should be &gt;= than configured pipeline interval for collection of underlying metrics.</td>
</tr> </tr>
<tr>
<td>evaluation_service = ceilometer.alarm.service.SingletonAlarmService</td>
<td>(StrOpt) Class to launch as alarm evaluation service.</td>
</tr>
<tr> <tr>
<td>notifier_rpc_topic = alarm_notifier</td> <td>notifier_rpc_topic = alarm_notifier</td>
<td>(StrOpt) The topic that ceilometer uses for alarm notifier messages.</td> <td>(StrOpt) The topic that ceilometer uses for alarm notifier messages.</td>
@ -45,6 +41,10 @@
<td>rest_notifier_certificate_key = </td> <td>rest_notifier_certificate_key = </td>
<td>(StrOpt) SSL Client private key for REST notifier.</td> <td>(StrOpt) SSL Client private key for REST notifier.</td>
</tr> </tr>
<tr>
<td>rest_notifier_max_retries = 0</td>
<td>(IntOpt) Number of retries for REST notifier</td>
</tr>
<tr> <tr>
<td>rest_notifier_ssl_verify = True</td> <td>rest_notifier_ssl_verify = True</td>
<td>(BoolOpt) Whether to verify the SSL Server certificate when calling alarm action.</td> <td>(BoolOpt) Whether to verify the SSL Server certificate when calling alarm action.</td>

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

@ -21,6 +21,17 @@
<td>collector_workers = 1</td> <td>collector_workers = 1</td>
<td>(IntOpt) Number of workers for collector service. A single collector is enabled by default.</td> <td>(IntOpt) Number of workers for collector service. A single collector is enabled by default.</td>
</tr> </tr>
<tr>
<th colspan="2">[collector]</th>
</tr>
<tr>
<td>udp_address = 0.0.0.0</td>
<td>(StrOpt) Address to which the UDP socket is bound. Set to an empty string to disable.</td>
</tr>
<tr>
<td>udp_port = 4952</td>
<td>(IntOpt) Port to which the UDP socket is bound.</td>
</tr>
<tr> <tr>
<th colspan="2">[dispatcher_file]</th> <th colspan="2">[dispatcher_file]</th>
</tr> </tr>

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

@ -29,10 +29,6 @@
<td>fatal_deprecations = False</td> <td>fatal_deprecations = False</td>
<td>(BoolOpt) Enables or disables fatal status of deprecations.</td> <td>(BoolOpt) Enables or disables fatal status of deprecations.</td>
</tr> </tr>
<tr>
<td>fatal_exception_format_errors = False</td>
<td>(BoolOpt) Make exception message format errors fatal</td>
</tr>
<tr> <tr>
<td>lock_path = None</td> <td>lock_path = None</td>
<td>(StrOpt) Directory to use for lock files.</td> <td>(StrOpt) Directory to use for lock files.</td>

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

@ -24,6 +24,10 @@
<tr> <tr>
<th colspan="2">[database]</th> <th colspan="2">[database]</th>
</tr> </tr>
<tr>
<td>alarm_connection = None</td>
<td>(StrOpt) The connection string used to connect to the alarm database. (if unset, connection is used)</td>
</tr>
<tr> <tr>
<td>backend = sqlalchemy</td> <td>backend = sqlalchemy</td>
<td>(StrOpt) The backend to use for db</td> <td>(StrOpt) The backend to use for db</td>
@ -72,6 +76,10 @@
<td>max_retries = 10</td> <td>max_retries = 10</td>
<td>(IntOpt) Maximum db connection retries during startup. (setting -1 implies an infinite retry count)</td> <td>(IntOpt) Maximum db connection retries during startup. (setting -1 implies an infinite retry count)</td>
</tr> </tr>
<tr>
<td>metering_connection = None</td>
<td>(StrOpt) The connection string used to connect to the meteting database. (if unset, connection is used)</td>
</tr>
<tr> <tr>
<td>min_pool_size = 1</td> <td>min_pool_size = 1</td>
<td>(IntOpt) Minimum number of SQL connections to keep open in a pool</td> <td>(IntOpt) Minimum number of SQL connections to keep open in a pool</td>
@ -104,10 +112,6 @@
<td>use_db_reconnect = False</td> <td>use_db_reconnect = False</td>
<td>(BoolOpt) Enable the experimental use of database reconnect on connection lost</td> <td>(BoolOpt) Enable the experimental use of database reconnect on connection lost</td>
</tr> </tr>
<tr>
<td>use_tpool = False</td>
<td>(BoolOpt) Enable the experimental use of thread pooling for all DB API calls</td>
</tr>
</tbody> </tbody>
</table> </table>
</para> </para>

26
doc/common/tables/ceilometer-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_ceilometer_debug">
<caption>Description of configuration options for debug</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>nova_http_log_debug = False</td>
<td>(BoolOpt) Allow novaclient's debug log output.</td>
</tr>
</tbody>
</table>
</para>

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

@ -23,7 +23,7 @@
</tr> </tr>
<tr> <tr>
<td>control_exchange = openstack</td> <td>control_exchange = openstack</td>
<td>(StrOpt) AMQP exchange to connect to if using RabbitMQ or Qpid</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>
<tr> <tr>
<td>glance_control_exchange = glance</td> <td>glance_control_exchange = glance</td>
@ -37,6 +37,14 @@
<td>http_control_exchanges = ['nova', 'glance', 'neutron', 'cinder']</td> <td>http_control_exchanges = ['nova', 'glance', 'neutron', 'cinder']</td>
<td>(MultiStrOpt) Exchanges name to listen for notifications.</td> <td>(MultiStrOpt) Exchanges name to listen for notifications.</td>
</tr> </tr>
<tr>
<td>ironic_exchange = ironic</td>
<td>(StrOpt) Exchange name for Ironic notifications.</td>
</tr>
<tr>
<td>keystone_control_exchange = keystone</td>
<td>(StrOpt) Exchange name for Keystone notifications.</td>
</tr>
<tr> <tr>
<td>neutron_control_exchange = neutron</td> <td>neutron_control_exchange = neutron</td>
<td>(StrOpt) Exchange name for Neutron notifications.</td> <td>(StrOpt) Exchange name for Neutron notifications.</td>
@ -45,6 +53,10 @@
<td>nova_control_exchange = nova</td> <td>nova_control_exchange = nova</td>
<td>(StrOpt) Exchange name for Nova notifications.</td> <td>(StrOpt) Exchange name for Nova notifications.</td>
</tr> </tr>
<tr>
<td>sahara_control_exchange = sahara</td>
<td>(StrOpt) Exchange name for Data Processing notifications</td>
</tr>
<tr> <tr>
<td>sample_source = openstack</td> <td>sample_source = openstack</td>
<td>(StrOpt) Source for samples emitted on this instance.</td> <td>(StrOpt) Source for samples emitted on this instance.</td>

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

@ -0,0 +1,26 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_ceilometer_glance">
<caption>Description of configuration options for glance</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>glance_page_size = 0</td>
<td>(IntOpt) Number of items to request in each paginated Glance API request (parameter used by glancecelient). If this is less than or equal to 0, page size is not specified (default value in glanceclient is used).</td>
</tr>
</tbody>
</table>
</para>

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

@ -22,16 +22,16 @@
<td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).</td> <td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).</td>
</tr> </tr>
<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>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> <td>(ListOpt) List of logger=LEVEL pairs.</td>
</tr> </tr>
<tr> <tr>
<td>instance_format = "[instance: %(uuid)s] "</td> <td>instance_format = "[instance: %(uuid)s] "</td>
<td>(StrOpt) The format for an instance that is passed with the log message. </td> <td>(StrOpt) The format for an instance that is passed with the log message.</td>
</tr> </tr>
<tr> <tr>
<td>instance_uuid_format = "[instance: %(uuid)s] "</td> <td>instance_uuid_format = "[instance: %(uuid)s] "</td>
<td>(StrOpt) The format for an instance UUID that is passed with the log message. </td> <td>(StrOpt) The format for an instance UUID that is passed with the log message.</td>
</tr> </tr>
<tr> <tr>
<td>log_config_append = None</td> <td>log_config_append = None</td>

7
doc/common/tables/ceilometer-nova_cells.xml
View File

@ -57,13 +57,6 @@
<td>topic = cells</td> <td>topic = cells</td>
<td>(StrOpt) The topic cells nodes listen on</td> <td>(StrOpt) The topic cells nodes listen on</td>
</tr> </tr>
<tr>
<th colspan="2">[upgrade_levels]</th>
</tr>
<tr>
<td>cells = None</td>
<td>(StrOpt) Set a version cap for messages sent to local cells services</td>
</tr>
</tbody> </tbody>
</table> </table>
</para> </para>

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

@ -19,7 +19,7 @@
</tr> </tr>
<tr> <tr>
<td>fake_rabbit = False</td> <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> </tr>
<tr> <tr>
<td>kombu_reconnect_delay = 1.0</td> <td>kombu_reconnect_delay = 1.0</td>

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

@ -18,7 +18,7 @@
<th colspan="2">[DEFAULT]</th> <th colspan="2">[DEFAULT]</th>
</tr> </tr>
<tr> <tr>
<td>host = oslo</td> <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> <td>(StrOpt) Name of this node, which must be valid in an AMQP key. Can be an opaque identifier. For ZeroMQ only, must be a valid host name, FQDN, or IP address.</td>
</tr> </tr>
<tr> <tr>
@ -29,6 +29,21 @@
<td>matchmaker_heartbeat_ttl = 600</td> <td>matchmaker_heartbeat_ttl = 600</td>
<td>(IntOpt) Heartbeat time-to-live.</td> <td>(IntOpt) Heartbeat time-to-live.</td>
</tr> </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> <tr>
<th colspan="2">[matchmaker_ring]</th> <th colspan="2">[matchmaker_ring]</th>
</tr> </tr>

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

@ -17,25 +17,13 @@
<tr> <tr>
<th colspan="2">[DEFAULT]</th> <th colspan="2">[DEFAULT]</th>
</tr> </tr>
<tr>
<td>allowed_rpc_exception_modules = nova.exception, cinder.exception, exceptions</td>
<td>(ListOpt) Modules of exceptions that are permitted to be recreated upon receiving exception data from an rpc call.</td>
</tr>
<tr> <tr>
<td>dispatcher = ['database']</td> <td>dispatcher = ['database']</td>
<td>(MultiStrOpt) Dispatcher to process data.</td> <td>(MultiStrOpt) Dispatcher to process data.</td>
</tr> </tr>
<tr> <tr>
<td>password = None</td> <td>rpc_backend = rabbit</td>
<td>(StrOpt) Password for Redis server (optional).</td> <td>(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq.</td>
</tr>
<tr>
<td>port = 6379</td>
<td>(IntOpt) Use this port to connect to redis host.</td>
</tr>
<tr>
<td>rpc_backend = ceilometer.openstack.common.rpc.impl_kombu</td>
<td>(StrOpt) The messaging module to use, defaults to kombu.</td>
</tr> </tr>
<tr> <tr>
<td>rpc_cast_timeout = 30</td> <td>rpc_cast_timeout = 30</td>
@ -43,15 +31,15 @@
</tr> </tr>
<tr> <tr>
<td>rpc_conn_pool_size = 30</td> <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>
<tr> <tr>
<td>rpc_response_timeout = 60</td> <td>rpc_response_timeout = 60</td>
<td>(IntOpt) Seconds to wait for a response from call or multicall</td> <td>(IntOpt) Seconds to wait for a response from a call.</td>
</tr> </tr>
<tr> <tr>
<td>rpc_thread_pool_size = 64</td> <td>rpc_thread_pool_size = 64</td>
<td>(IntOpt) Size of RPC thread pool</td> <td>(IntOpt) Size of RPC greenthread pool.</td>
</tr> </tr>
<tr> <tr>
<td>rpc_zmq_bind_address = *</td> <td>rpc_zmq_bind_address = *</td>
@ -62,7 +50,7 @@
<td>(IntOpt) Number of ZeroMQ contexts, defaults to 1.</td> <td>(IntOpt) Number of ZeroMQ contexts, defaults to 1.</td>
</tr> </tr>
<tr> <tr>
<td>rpc_zmq_host = oslo</td> <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> <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>
<tr> <tr>

34
doc/common/tables/ceilometer-tripleo.xml Normal file
View File

@ -0,0 +1,34 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_ceilometer_tripleo">
<caption>Description of configuration options for tripleo</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[hardware]</th>
</tr>
<tr>
<td>readonly_user_name = ro_snmp_user</td>
<td>(StrOpt) SNMPd user name of all nodes running in the cloud.</td>
</tr>
<tr>
<td>readonly_user_password = password</td>
<td>(StrOpt) SNMPd password of all the nodes running in the cloud</td>
</tr>
<tr>
<td>url_scheme = snmp://</td>
<td>(StrOpt) URL scheme to use for hardware nodes</td>
</tr>
</tbody>
</table>
</para>

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

@ -30,7 +30,7 @@
<td>(StrOpt) Default availability zone for new volumes. If not set, the storage_availability_zone option value is used as the default for new volumes.</td> <td>(StrOpt) Default availability zone for new volumes. If not set, the storage_availability_zone option value is used as the default for new volumes.</td>
</tr> </tr>
<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>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</td>
<td>(ListOpt) List of logger=LEVEL pairs.</td> <td>(ListOpt) List of logger=LEVEL pairs.</td>
</tr> </tr>
<tr> <tr>
@ -51,7 +51,7 @@
</tr> </tr>
<tr> <tr>
<td>fatal_exception_format_errors = False</td> <td>fatal_exception_format_errors = False</td>
<td>(BoolOpt) make exception message format errors fatal</td> <td>(BoolOpt) Make exception message format errors fatal.</td>
</tr> </tr>
<tr> <tr>
<td>host = localhost</td> <td>host = localhost</td>

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

@ -92,6 +92,10 @@
<td>retry_interval = 10</td> <td>retry_interval = 10</td>
<td>(IntOpt) Interval between retries of opening a SQL connection.</td> <td>(IntOpt) Interval between retries of opening a SQL connection.</td>
</tr> </tr>
<tr>
<td>slave_connection = None</td>
<td>(StrOpt) The SQLAlchemy connection string to use to connect to the slave database.</td>
</tr>
<tr> <tr>
<td>sqlite_db = oslo.sqlite</td> <td>sqlite_db = oslo.sqlite</td>
<td>(StrOpt) The file name to use with SQLite.</td> <td>(StrOpt) The file name to use with SQLite.</td>

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

@ -22,16 +22,36 @@
<td>(StrOpt) The configuration file for the Cinder EMC driver</td> <td>(StrOpt) The configuration file for the Cinder EMC driver</td>
</tr> </tr>
<tr> <tr>
<td>max_luns_per_storage_group = 256</td> <td>destroy_empty_storage_group = False</td>
<td>(IntOpt) Default max number of LUNs in a storage group</td> <td>(BoolOpt) To destroy storage group when the last LUN is removed from it. By default, the value is False.</td>
</tr>
<tr>
<td>initiator_auto_registration = False</td>
<td>(BoolOpt) Automatically register initiators. By default, the value is False.</td>
</tr>
<tr>
<td>iscsi_initiators = </td>
<td>(StrOpt) Mapping between hostname and its iSCSI initiator IP addresses.</td>
</tr>
<tr>
<td>max_luns_per_storage_group = 255</td>
<td>(IntOpt) Default max number of LUNs in a storage group. By default, the value is 255.</td>
</tr> </tr>
<tr> <tr>
<td>naviseccli_path = </td> <td>naviseccli_path = </td>
<td>(StrOpt) Naviseccli Path</td> <td>(StrOpt) Naviseccli Path.</td>
</tr>
<tr>
<td>storage_vnx_authentication_type = global</td>
<td>(StrOpt) VNX authentication scope type.</td>
</tr> </tr>
<tr> <tr>
<td>storage_vnx_pool_name = None</td> <td>storage_vnx_pool_name = None</td>
<td>(StrOpt) ISCSI pool name</td> <td>(StrOpt) Storage pool name.</td>
</tr>
<tr>
<td>storage_vnx_security_file_dir = None</td>
<td>(StrOpt) Directory path that contains the VNX security file. Make sure the security file is generated first.</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>

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

@ -19,11 +19,11 @@
</tr> </tr>
<tr> <tr>
<td>hds_hnas_iscsi_config_file = /opt/hds/hnas/cinder_iscsi_conf.xml</td> <td>hds_hnas_iscsi_config_file = /opt/hds/hnas/cinder_iscsi_conf.xml</td>
<td>(StrOpt) configuration file for HDS iSCSI cinder plugin</td> <td>(StrOpt) Configuration file for HDS iSCSI cinder plugin</td>
</tr> </tr>
<tr> <tr>
<td>hds_hnas_nfs_config_file = /opt/hds/hnas/cinder_nfs_conf.xml</td> <td>hds_hnas_nfs_config_file = /opt/hds/hnas/cinder_nfs_conf.xml</td>
<td>(StrOpt) configuration file for HDS NFS cinder plugin</td> <td>(StrOpt) Configuration file for HDS NFS cinder plugin</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>

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

@ -33,6 +33,10 @@
<td>hp3par_debug = False</td> <td>hp3par_debug = False</td>
<td>(BoolOpt) Enable HTTP debugging to 3PAR</td> <td>(BoolOpt) Enable HTTP debugging to 3PAR</td>
</tr> </tr>
<tr>
<td>hp3par_iscsi_chap_enabled = False</td>
<td>(BoolOpt) Enable CHAP authentication for iSCSI connections.</td>
</tr>
<tr> <tr>
<td>hp3par_iscsi_ips = </td> <td>hp3par_iscsi_ips = </td>
<td>(ListOpt) List of target iSCSI addresses to use.</td> <td>(ListOpt) List of target iSCSI addresses to use.</td>

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

@ -21,6 +21,14 @@
<td>api_class = cinder.keymgr.conf_key_mgr.ConfKeyManager</td> <td>api_class = cinder.keymgr.conf_key_mgr.ConfKeyManager</td>
<td>(StrOpt) The full class name of the key manager API class</td> <td>(StrOpt) The full class name of the key manager API class</td>
</tr> </tr>
<tr>
<td>encryption_api_url = http://localhost:9311/v1</td>
<td>(StrOpt) Url for encryption service.</td>
</tr>
<tr>
<td>encryption_auth_url = http://localhost:5000/v2.0</td>
<td>(StrOpt) Authentication url for encryption service.</td>
</tr>
<tr> <tr>
<td>fixed_key = None</td> <td>fixed_key = None</td>
<td>(StrOpt) Fixed key returned by key manager, specified in hex</td> <td>(StrOpt) Fixed key returned by key manager, specified in hex</td>

30
doc/common/tables/cinder-nimble.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_nimble">
<caption>Description of configuration options for nimble</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>nimble_pool_name = default</td>
<td>(StrOpt) Nimble Controller pool name</td>
</tr>
<tr>
<td>nimble_subnet_label = *</td>
<td>(StrOpt) Nimble Subnet Label</td>
</tr>
</tbody>
</table>
</para>

46
doc/common/tables/cinder-prophetstor_dpl.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_prophetstor_dpl">
<caption>Description of configuration options for prophetstor_dpl</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>dpl_pool = </td>
<td>(StrOpt) DPL pool uuid in which DPL volumes are stored.</td>
</tr>
<tr>
<td>dpl_port = 8357</td>
<td>(IntOpt) DPL port number.</td>
</tr>
<tr>
<td>san_ip = </td>
<td>(StrOpt) IP address of SAN controller</td>
</tr>
<tr>
<td>san_login = admin</td>
<td>(StrOpt) Username for SAN controller</td>
</tr>
<tr>
<td>san_password = </td>
<td>(StrOpt) Password for SAN controller</td>
</tr>
<tr>
<td>san_thin_provision = True</td>
<td>(BoolOpt) Use thin provisioning for SAN volumes?</td>
</tr>
</tbody>
</table>
</para>

47
doc/common/tables/cinder-prophststor_dpl.xml
View File

@ -1,47 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all" xml:id="config_table_cinder_prophetstor_dpl">
<caption>Description of configuration options for ProphetStor storage</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>san_ip = </td>
<td>(StrOpt) IP address of SAN controller.</td>
</tr>
<tr>
<td>san_login = </td>
<td>(StrOpt) Username for SAN controller.</td>
</tr>
<tr>
<td>san_password = </td>
<td>(StrOpt) Password for SAN controller.</td>
</tr>
<tr>
<td>san_thin_provision = True</td>
<td>(BoolOpt) Use thin provisioning for SAN volumes.</td>
</tr>
<tr>
<td>dpl_port = 8357</td>
<td>(IntOpt) Port number of ProphetStor DPL storage server.</td>
</tr>
<tr>
<td>dpl_pool = </td>
<td>(StrOpt) Pool id of ProphetStor DPL storage server.</td>
</tr>
</tbody>
</table>
</para>

26
doc/common/tables/cinder-pure.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_pure">
<caption>Description of configuration options for pure</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>pure_api_token = None</td>
<td>(StrOpt) REST API authorization token.</td>
</tr>
</tbody>
</table>
</para>

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

@ -17,10 +17,6 @@
<tr> <tr>
<th colspan="2">[DEFAULT]</th> <th colspan="2">[DEFAULT]</th>
</tr> </tr>
<tr>
<td>allowed_rpc_exception_modules = oslo.messaging.exceptions, nova.exception, cinder.exception, exceptions</td>
<td>(ListOpt) Modules of exceptions that are permitted to be recreated upon receiving exception data from an rpc call.</td>
</tr>
<tr> <tr>
<td>amqp_auto_delete = False</td> <td>amqp_auto_delete = False</td>
<td>(BoolOpt) Auto-delete queues in amqp.</td> <td>(BoolOpt) Auto-delete queues in amqp.</td>
@ -34,8 +30,8 @@
<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) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.</td>
</tr> </tr>
<tr> <tr>
<td>default_timeout = 20</td> <td>default_timeout = 525600</td>
<td>(IntOpt) Default Time Out For CLI operations in minutes</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>
<tr> <tr>
<td>fake_rabbit = False</td> <td>fake_rabbit = False</td>
@ -77,14 +73,6 @@
<td>notification_topics = notifications</td> <td>notification_topics = notifications</td>
<td>(ListOpt) AMQP topic used for OpenStack notifications.</td> <td>(ListOpt) AMQP topic used for OpenStack notifications.</td>
</tr> </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> <tr>
<td>publish_errors = False</td> <td>publish_errors = False</td>
<td>(BoolOpt) Enables or disables publication of error events.</td> <td>(BoolOpt) Enables or disables publication of error events.</td>
@ -233,6 +221,21 @@
<td>volume_topic = cinder-volume</td> <td>volume_topic = cinder-volume</td>
<td>(StrOpt) The topic that volume nodes listen on</td> <td>(StrOpt) The topic that volume nodes listen on</td>
</tr> </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> <tr>
<th colspan="2">[matchmaker_ring]</th> <th colspan="2">[matchmaker_ring]</th>
</tr> </tr>

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

@ -41,6 +41,10 @@
<td>san_private_key = </td> <td>san_private_key = </td>
<td>(StrOpt) Filename of private key to use for SSH authentication</td> <td>(StrOpt) Filename of private key to use for SSH authentication</td>
</tr> </tr>
<tr>
<td>san_secondary_ip = None</td>
<td>(StrOpt) VNX secondary SP IP Address.</td>
</tr>
<tr> <tr>
<td>san_ssh_port = 22</td> <td>san_ssh_port = 22</td>
<td>(IntOpt) SSH port to use with SAN</td> <td>(IntOpt) SSH port to use with SAN</td>

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

@ -53,6 +53,10 @@
<td>iscsi_target_prefix = iqn.2010-10.org.openstack:</td> <td>iscsi_target_prefix = iqn.2010-10.org.openstack:</td>
<td>(StrOpt) Prefix for iSCSI volumes</td> <td>(StrOpt) Prefix for iSCSI volumes</td>
</tr> </tr>
<tr>
<td>iscsi_write_cache = on</td>
<td>(StrOpt) Sets the behavior of the iSCSI target to either perform write-back(on) or write-through(off). This parameter is valid if iscsi_helper is set to tgtadm or iseradm.</td>
</tr>
<tr> <tr>
<td>iser_helper = tgtadm</td> <td>iser_helper = tgtadm</td>
<td>(StrOpt) The name of the iSER target user-land tool to use</td> <td>(StrOpt) The name of the iSER target user-land tool to use</td>

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

@ -37,6 +37,10 @@
<td>storwize_svc_multipath_enabled = False</td> <td>storwize_svc_multipath_enabled = False</td>
<td>(BoolOpt) Connect with multipath (FC only; iSCSI multipath is controlled by Nova)</td> <td>(BoolOpt) Connect with multipath (FC only; iSCSI multipath is controlled by Nova)</td>
</tr> </tr>
<tr>
<td>storwize_svc_npiv_compatibility_mode = False</td>
<td>(BoolOpt) Indicate whether svc driver is compatible for NPIV setup. If it is compatible, it will allow no wwpns being returned on get_conn_fc_wwpns during initialize_connection</td>
</tr>
<tr> <tr>
<td>storwize_svc_vol_autoexpand = True</td> <td>storwize_svc_vol_autoexpand = True</td>
<td>(BoolOpt) Storage system autoexpand parameter for volumes (True/False)</td> <td>(BoolOpt) Storage system autoexpand parameter for volumes (True/False)</td>

30
doc/common/tables/cinder-swift.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_swift">
<caption>Description of configuration options for swift</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>backup_swift_auth_version = 1</td>
<td>(StrOpt) Swift authentication version. Specify "1" for auth 1.0, or "2" for auth 2.0</td>
</tr>
<tr>
<td>backup_swift_tenant = None</td>
<td>(StrOpt) Swift tenant/account name. Required when connecting to an auth 2.0 system</td>
</tr>
</tbody>
</table>
</para>

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

@ -46,8 +46,8 @@
<td>(IntOpt) Max number of objects to be retrieved per batch. Query results will be obtained in batches from the server and not in one shot. Server may still limit the count to something less than the configured value.</td> <td>(IntOpt) Max number of objects to be retrieved per batch. Query results will be obtained in batches from the server and not in one shot. Server may still limit the count to something less than the configured value.</td>
</tr> </tr>
<tr> <tr>
<td>vmware_task_poll_interval = 5</td> <td>vmware_task_poll_interval = 0.5</td>
<td>(IntOpt) The interval (in seconds) for polling remote tasks invoked on VMware ESX/VC server.</td> <td>(FloatOpt) The interval (in seconds) for polling remote tasks invoked on VMware ESX/VC server.</td>
</tr> </tr>
<tr> <tr>
<td>vmware_volume_folder = cinder-volumes</td> <td>vmware_volume_folder = cinder-volumes</td>

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

@ -25,6 +25,10 @@
<td>allow_anonymous_access = False</td> <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> <td>(BoolOpt) Allow unauthenticated users to access the API with read-only privileges. This only applies when using ContextMiddleware.</td>
</tr> </tr>
<tr>
<td>default_publisher_id = image.localhost</td>
<td>(StrOpt) Default publisher_id for outgoing notifications.</td>
</tr>
<tr> <tr>
<td>default_store = file</td> <td>default_store = file</td>
<td>(StrOpt) Default scheme to use to store image data. The scheme must be registered by one of the stores defined by the 'known_stores' config option.</td> <td>(StrOpt) Default scheme to use to store image data. The scheme must be registered by one of the stores defined by the 'known_stores' config option.</td>
@ -67,7 +71,7 @@
</tr> </tr>
<tr> <tr>
<td>send_identity_headers = False</td> <td>send_identity_headers = False</td>
<td>(BoolOpt) Whether to pass through headers containing user and tenant information when making requests to the registry. This allows the registry to use the context middleware without the keystoneclients' auth_token middleware, removing calls to the keystone auth service. It is recommended that when using this option, secure communication between glance api and glance registry is ensured by means other than auth_token middleware.</td> <td>(BoolOpt) Whether to pass through headers containing user and tenant information when making requests to the registry. This allows the registry to use the context middleware without keystonemiddleware's auth_token middleware, removing calls to the keystone auth service. It is recommended that when using this option, secure communication between glance api and glance registry is ensured by means other than auth_token middleware.</td>
</tr> </tr>
<tr> <tr>
<td>show_multiple_locations = False</td> <td>show_multiple_locations = False</td>

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

@ -43,7 +43,7 @@
</tr> </tr>
<tr> <tr>
<td>disable_process_locking = False</td> <td>disable_process_locking = False</td>
<td>(BoolOpt) Whether to disable inter-process locks</td> <td>(BoolOpt) Enables or disables inter-process locks.</td>
</tr> </tr>
<tr> <tr>
<td>image_location_quota = 10</td> <td>image_location_quota = 10</td>
@ -73,10 +73,6 @@
<td>metadata_encryption_key = None</td> <td>metadata_encryption_key = None</td>
<td>(StrOpt) Key used for encrypting sensitive metadata while talking to the registry or database.</td> <td>(StrOpt) Key used for encrypting sensitive metadata while talking to the registry or database.</td>
</tr> </tr>
<tr>
<td>notifier_strategy = default</td>
<td>(StrOpt) Notifications can be sent when images are create, updated or deleted. There are three methods of sending notifications, logging (via the log_file directive), rabbit (via a rabbitmq queue), qpid (via a Qpid message queue), or noop (no notifications sent, the default).</td>
</tr>
<tr> <tr>
<td>os_region_name = None</td> <td>os_region_name = None</td>
<td>(StrOpt) Region name of this node.</td> <td>(StrOpt) Region name of this node.</td>
@ -98,8 +94,8 @@
<td>(StrOpt) Set a system wide quota for every user. This value is the total capacity that a user can use across all storage systems. A value of 0 means unlimited.Optional unit can be specified for the value. Accepted units are B, KB, MB, GB and TB representing Bytes, KiloBytes, MegaBytes, GigaBytes and TeraBytesrespectively. If no unit is specified then Bytes is assumed. Note that there should not be any space between value and unit and units are case sensitive.</td> <td>(StrOpt) Set a system wide quota for every user. This value is the total capacity that a user can use across all storage systems. A value of 0 means unlimited.Optional unit can be specified for the value. Accepted units are B, KB, MB, GB and TB representing Bytes, KiloBytes, MegaBytes, GigaBytes and TeraBytesrespectively. If no unit is specified then Bytes is assumed. Note that there should not be any space between value and unit and units are case sensitive.</td>
</tr> </tr>
<tr> <tr>
<td>workers = 1</td> <td>workers = 4</td>
<td>(IntOpt) The number of child process workers that will be created to service API requests.</td> <td>(IntOpt) The number of child process workers that will be created to service requests. The default will be equal to the number of CPUs available.</td>
</tr> </tr>
<tr> <tr>
<th colspan="2">[image_format]</th> <th colspan="2">[image_format]</th>

42
doc/common/tables/glance-database.xml
View File

@ -19,55 +19,55 @@
</tr> </tr>
<tr> <tr>
<td>backend = sqlalchemy</td> <td>backend = sqlalchemy</td>
<td>(StrOpt) The backend to use for db</td> <td>(StrOpt) The back end to use for the database.</td>
</tr> </tr>
<tr> <tr>
<td>connection = None</td> <td>connection = None</td>
<td>(StrOpt) The SQLAlchemy connection string used to connect to the database</td> <td>(StrOpt) The SQLAlchemy connection string to use to connect to the database.</td>
</tr> </tr>
<tr> <tr>
<td>connection_debug = 0</td> <td>connection_debug = 0</td>
<td>(IntOpt) Verbosity of SQL debugging information. 0=None, 100=Everything</td> <td>(IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything.</td>
</tr> </tr>
<tr> <tr>
<td>connection_trace = False</td> <td>connection_trace = False</td>
<td>(BoolOpt) Add python stack traces to SQL as comment strings</td> <td>(BoolOpt) Add Python stack traces to SQL as comment strings.</td>
</tr> </tr>
<tr> <tr>
<td>db_inc_retry_interval = True</td> <td>db_inc_retry_interval = True</td>
<td>(BoolOpt) Whether to increase interval between db connection retries, up to db_max_retry_interval</td> <td>(BoolOpt) If True, increases the interval between database connection retries up to db_max_retry_interval.</td>
</tr> </tr>
<tr> <tr>
<td>db_max_retries = 20</td> <td>db_max_retries = 20</td>
<td>(IntOpt) maximum db connection retries before error is raised. (setting -1 implies an infinite retry count)</td> <td>(IntOpt) Maximum database connection retries before error is raised. Set to -1 to specify an infinite retry count.</td>
</tr> </tr>
<tr> <tr>
<td>db_max_retry_interval = 10</td> <td>db_max_retry_interval = 10</td>
<td>(IntOpt) max seconds between db connection retries, if db_inc_retry_interval is enabled</td> <td>(IntOpt) If db_inc_retry_interval is set, the maximum seconds between database connection retries.</td>
</tr> </tr>
<tr> <tr>
<td>db_retry_interval = 1</td> <td>db_retry_interval = 1</td>
<td>(IntOpt) seconds between db connection retries</td> <td>(IntOpt) Seconds between database connection retries.</td>
</tr> </tr>
<tr> <tr>
<td>idle_timeout = 3600</td> <td>idle_timeout = 3600</td>
<td>(IntOpt) Timeout before idle sql connections are reaped</td> <td>(IntOpt) Timeout before idle SQL connections are reaped.</td>
</tr> </tr>
<tr> <tr>
<td>max_overflow = None</td> <td>max_overflow = None</td>
<td>(IntOpt) If set, use this value for max_overflow with sqlalchemy</td> <td>(IntOpt) If set, use this value for max_overflow with SQLAlchemy.</td>
</tr> </tr>
<tr> <tr>
<td>max_pool_size = None</td> <td>max_pool_size = None</td>
<td>(IntOpt) Maximum number of SQL connections to keep open in a pool</td> <td>(IntOpt) Maximum number of SQL connections to keep open in a pool.</td>
</tr> </tr>
<tr> <tr>
<td>max_retries = 10</td> <td>max_retries = 10</td>
<td>(IntOpt) Maximum db connection retries during startup. (setting -1 implies an infinite retry count)</td> <td>(IntOpt) Maximum db connection retries during startup. Set to -1 to specify an infinite retry count.</td>
</tr> </tr>
<tr> <tr>
<td>min_pool_size = 1</td> <td>min_pool_size = 1</td>
<td>(IntOpt) Minimum number of SQL connections to keep open in a pool</td> <td>(IntOpt) Minimum number of SQL connections to keep open in a pool.</td>
</tr> </tr>
<tr> <tr>
<td>mysql_sql_mode = TRADITIONAL</td> <td>mysql_sql_mode = TRADITIONAL</td>
@ -75,23 +75,27 @@
</tr> </tr>
<tr> <tr>
<td>pool_timeout = None</td> <td>pool_timeout = None</td>
<td>(IntOpt) If set, use this value for pool_timeout with sqlalchemy</td> <td>(IntOpt) If set, use this value for pool_timeout with SQLAlchemy.</td>
</tr> </tr>
<tr> <tr>
<td>retry_interval = 10</td> <td>retry_interval = 10</td>
<td>(IntOpt) Interval between retries of opening a sql connection</td> <td>(IntOpt) Interval between retries of opening a SQL connection.</td>
</tr> </tr>
<tr> <tr>
<td>sqlite_db = glance.sqlite</td> <td>slave_connection = None</td>
<td>(StrOpt) The file name to use with SQLite</td> <td>(StrOpt) The SQLAlchemy connection string to use to connect to the slave database.</td>
</tr>
<tr>
<td>sqlite_db = oslo.sqlite</td>
<td>(StrOpt) The file name to use with SQLite.</td>
</tr> </tr>
<tr> <tr>
<td>sqlite_synchronous = True</td> <td>sqlite_synchronous = True</td>
<td>(BoolOpt) If True, SQLite uses synchronous mode</td> <td>(BoolOpt) If True, SQLite uses synchronous mode.</td>
</tr> </tr>
<tr> <tr>
<td>use_db_reconnect = False</td> <td>use_db_reconnect = False</td>
<td>(BoolOpt) Enable the experimental use of database reconnect on connection lost</td> <td>(BoolOpt) Enable the experimental use of database reconnect on connection lost.</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>

6
doc/common/tables/glance-logging.xml
View File

@ -31,11 +31,11 @@
</tr> </tr>
<tr> <tr>
<td>instance_format = "[instance: %(uuid)s] "</td> <td>instance_format = "[instance: %(uuid)s] "</td>
<td>(StrOpt) The format for an instance that is passed with the log message. </td> <td>(StrOpt) The format for an instance that is passed with the log message.</td>
</tr> </tr>
<tr> <tr>
<td>instance_uuid_format = "[instance: %(uuid)s] "</td> <td>instance_uuid_format = "[instance: %(uuid)s] "</td>
<td>(StrOpt) The format for an instance UUID that is passed with the log message. </td> <td>(StrOpt) The format for an instance UUID that is passed with the log message.</td>
</tr> </tr>
<tr> <tr>
<td>log_config_append = None</td> <td>log_config_append = None</td>
@ -87,7 +87,7 @@
</tr> </tr>
<tr> <tr>
<td>use_syslog = False</td> <td>use_syslog = False</td>
<td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will chang in J to honor RFC5424.</td> <td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424.</td>
</tr> </tr>
<tr> <tr>
<td>use_syslog_rfc_format = False</td> <td>use_syslog_rfc_format = False</td>

30
doc/common/tables/glance-profiler.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_glance_profiler">
<caption>Description of configuration options for profiler</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[profiler]</th>
</tr>
<tr>
<td>enabled = True</td>
<td>(BoolOpt) If False fully disable profiling feature.</td>
</tr>
<tr>
<td>trace_sqlalchemy = True</td>
<td>(BoolOpt) If False doesn't trace SQL requests.</td>
</tr>
</tbody>
</table>
</para>

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

@ -15,7 +15,7 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<th colspan="2">[DEFAULT]</th> <th colspan="2">[matchmaker_redis]</th>
</tr> </tr>
<tr> <tr>
<td>host = 127.0.0.1</td> <td>host = 127.0.0.1</td>

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

@ -30,7 +30,7 @@
<td>(IntOpt) Number of ZeroMQ contexts, defaults to 1.</td> <td>(IntOpt) Number of ZeroMQ contexts, defaults to 1.</td>
</tr> </tr>
<tr> <tr>
<td>rpc_zmq_host = oslo</td> <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> <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>
<tr> <tr>

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

@ -27,7 +27,7 @@
</tr> </tr>
<tr> <tr>
<td>control_exchange = openstack</td> <td>control_exchange = openstack</td>
<td>(StrOpt) AMQP exchange to connect to if using RabbitMQ or Qpid</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>
<tr> <tr>
<td>default_notification_level = INFO</td> <td>default_notification_level = INFO</td>
@ -39,7 +39,7 @@
</tr> </tr>
<tr> <tr>
<td>fake_rabbit = False</td> <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> </tr>
<tr> <tr>
<td>list_notifier_drivers = None</td> <td>list_notifier_drivers = None</td>

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

@ -17,6 +17,10 @@
<tr> <tr>
<th colspan="2">[DEFAULT]</th> <th colspan="2">[DEFAULT]</th>
</tr> </tr>
<tr>
<td>action_retry_limit = 5</td>
<td>(IntOpt) Number of times to retry to bring a resource to a non-error state. Set to 0 to disable retries.</td>
</tr>
<tr> <tr>
<td>heat_metadata_server_url = </td> <td>heat_metadata_server_url = </td>
<td>(StrOpt) URL of the Heat metadata server.</td> <td>(StrOpt) URL of the Heat metadata server.</td>
@ -66,8 +70,12 @@
<td>(StrOpt) Keystone password for stack_domain_admin user.</td> <td>(StrOpt) Keystone password for stack_domain_admin user.</td>
</tr> </tr>
<tr> <tr>
<td>stack_user_domain = None</td> <td>stack_user_domain_id = None</td>
<td>(StrOpt) Keystone domain ID which contains heat template-defined users.</td> <td>(StrOpt) Keystone domain ID which contains heat template-defined users. If this option is set, stack_user_domain_name option will be ignored.</td>
</tr>
<tr>
<td>stack_user_domain_name = None</td>
<td>(StrOpt) Keystone domain name which contains heat template-defined users. If `stack_user_domain_id` option is set, this option is ignored.</td>
</tr> </tr>
<tr> <tr>
<td>trusts_delegated_roles = heat_stack_owner</td> <td>trusts_delegated_roles = heat_stack_owner</td>

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

@ -29,6 +29,10 @@
<td>endpoint_type = publicURL</td> <td>endpoint_type = publicURL</td>
<td>(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.</td> <td>(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.</td>
</tr> </tr>
<tr>
<td>http_log_debug = False</td>
<td>(BoolOpt) Allow client's debug log output.</td>
</tr>
<tr> <tr>
<td>insecure = False</td> <td>insecure = False</td>
<td>(BoolOpt) If set, then the server's certificate will not be verified.</td> <td>(BoolOpt) If set, then the server's certificate will not be verified.</td>

42
doc/common/tables/heat-database.xml
View File

@ -19,55 +19,55 @@
</tr> </tr>
<tr> <tr>
<td>backend = sqlalchemy</td> <td>backend = sqlalchemy</td>
<td>(StrOpt) The backend to use for db</td> <td>(StrOpt) The back end to use for the database.</td>
</tr> </tr>
<tr> <tr>
<td>connection = None</td> <td>connection = None</td>
<td>(StrOpt) The SQLAlchemy connection string used to connect to the database</td> <td>(StrOpt) The SQLAlchemy connection string to use to connect to the database.</td>
</tr> </tr>
<tr> <tr>
<td>connection_debug = 0</td> <td>connection_debug = 0</td>
<td>(IntOpt) Verbosity of SQL debugging information. 0=None, 100=Everything</td> <td>(IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything.</td>
</tr> </tr>
<tr> <tr>
<td>connection_trace = False</td> <td>connection_trace = False</td>
<td>(BoolOpt) Add python stack traces to SQL as comment strings</td> <td>(BoolOpt) Add Python stack traces to SQL as comment strings.</td>
</tr> </tr>
<tr> <tr>
<td>db_inc_retry_interval = True</td> <td>db_inc_retry_interval = True</td>
<td>(BoolOpt) Whether to increase interval between db connection retries, up to db_max_retry_interval</td> <td>(BoolOpt) If True, increases the interval between database connection retries up to db_max_retry_interval.</td>
</tr> </tr>
<tr> <tr>
<td>db_max_retries = 20</td> <td>db_max_retries = 20</td>
<td>(IntOpt) maximum db connection retries before error is raised. (setting -1 implies an infinite retry count)</td> <td>(IntOpt) Maximum database connection retries before error is raised. Set to -1 to specify an infinite retry count.</td>
</tr> </tr>
<tr> <tr>
<td>db_max_retry_interval = 10</td> <td>db_max_retry_interval = 10</td>
<td>(IntOpt) max seconds between db connection retries, if db_inc_retry_interval is enabled</td> <td>(IntOpt) If db_inc_retry_interval is set, the maximum seconds between database connection retries.</td>
</tr> </tr>
<tr> <tr>
<td>db_retry_interval = 1</td> <td>db_retry_interval = 1</td>
<td>(IntOpt) seconds between db connection retries</td> <td>(IntOpt) Seconds between database connection retries.</td>
</tr> </tr>
<tr> <tr>
<td>idle_timeout = 3600</td> <td>idle_timeout = 3600</td>
<td>(IntOpt) Timeout before idle sql connections are reaped</td> <td>(IntOpt) Timeout before idle SQL connections are reaped.</td>
</tr> </tr>
<tr> <tr>
<td>max_overflow = None</td> <td>max_overflow = None</td>
<td>(IntOpt) If set, use this value for max_overflow with sqlalchemy</td> <td>(IntOpt) If set, use this value for max_overflow with SQLAlchemy.</td>
</tr> </tr>
<tr> <tr>
<td>max_pool_size = None</td> <td>max_pool_size = None</td>
<td>(IntOpt) Maximum number of SQL connections to keep open in a pool</td> <td>(IntOpt) Maximum number of SQL connections to keep open in a pool.</td>
</tr> </tr>
<tr> <tr>
<td>max_retries = 10</td> <td>max_retries = 10</td>
<td>(IntOpt) Maximum db connection retries during startup. (setting -1 implies an infinite retry count)</td> <td>(IntOpt) Maximum db connection retries during startup. Set to -1 to specify an infinite retry count.</td>
</tr> </tr>
<tr> <tr>
<td>min_pool_size = 1</td> <td>min_pool_size = 1</td>
<td>(IntOpt) Minimum number of SQL connections to keep open in a pool</td> <td>(IntOpt) Minimum number of SQL connections to keep open in a pool.</td>
</tr> </tr>
<tr> <tr>
<td>mysql_sql_mode = TRADITIONAL</td> <td>mysql_sql_mode = TRADITIONAL</td>
@ -75,23 +75,27 @@
</tr> </tr>
<tr> <tr>
<td>pool_timeout = None</td> <td>pool_timeout = None</td>
<td>(IntOpt) If set, use this value for pool_timeout with sqlalchemy</td> <td>(IntOpt) If set, use this value for pool_timeout with SQLAlchemy.</td>
</tr> </tr>
<tr> <tr>
<td>retry_interval = 10</td> <td>retry_interval = 10</td>
<td>(IntOpt) Interval between retries of opening a sql connection</td> <td>(IntOpt) Interval between retries of opening a SQL connection.</td>
</tr> </tr>
<tr> <tr>
<td>sqlite_db = heat.sqlite</td> <td>slave_connection = None</td>
<td>(StrOpt) The file name to use with SQLite</td> <td>(StrOpt) The SQLAlchemy connection string to use to connect to the slave database.</td>
</tr>
<tr>
<td>sqlite_db = oslo.sqlite</td>
<td>(StrOpt) The file name to use with SQLite.</td>
</tr> </tr>
<tr> <tr>
<td>sqlite_synchronous = True</td> <td>sqlite_synchronous = True</td>
<td>(BoolOpt) If True, SQLite uses synchronous mode</td> <td>(BoolOpt) If True, SQLite uses synchronous mode.</td>
</tr> </tr>
<tr> <tr>
<td>use_db_reconnect = False</td> <td>use_db_reconnect = False</td>
<td>(BoolOpt) Enable the experimental use of database reconnect on connection lost</td> <td>(BoolOpt) Enable the experimental use of database reconnect on connection lost.</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>

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

@ -19,7 +19,7 @@
</tr> </tr>
<tr> <tr>
<td>onready = None</td> <td>onready = None</td>
<td>(StrOpt) onready allows you to send a notification when the heat processes are ready to serve. This is either a module with the notify() method or a shell command. To enable notifications with systemd, one may use the 'systemd-notify --ready' shell command or the 'heat.common.systemd' notification module.</td> <td>(StrOpt) Deprecated.</td>
</tr> </tr>
<tr> <tr>
<td>publish_errors = False</td> <td>publish_errors = False</td>

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

@ -18,9 +18,24 @@
<th colspan="2">[DEFAULT]</th> <th colspan="2">[DEFAULT]</th>
</tr> </tr>
<tr> <tr>
<td>host = oslo</td> <td>host = localhost</td>
<td>(StrOpt) Name of the engine node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address.</td> <td>(StrOpt) Name of the engine node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address.</td>
</tr> </tr>
<tr>
<th colspan="2">[matchmaker_redis]</th>
</tr>
<tr>
<td>host = 127.0.0.1</td>
<td>(StrOpt) Host to locate redis.</td>
</tr>
<tr>
<td>password = None</td>
<td>(StrOpt) Password for Redis server (optional).</td>
</tr>
<tr>
<td>port = 6379</td>
<td>(IntOpt) Use this port to connect to redis host.</td>
</tr>
</tbody> </tbody>
</table> </table>
</para> </para>

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

@ -17,10 +17,6 @@
<tr> <tr>
<th colspan="2">[DEFAULT]</th> <th colspan="2">[DEFAULT]</th>
</tr> </tr>
<tr>
<td>allowed_rpc_exception_modules = nova.exception, cinder.exception, exceptions</td>
<td>(ListOpt) Modules of exceptions that are permitted to be recreated upon receiving exception data from an rpc call.</td>
</tr>
<tr> <tr>
<td>engine_life_check_timeout = 2</td> <td>engine_life_check_timeout = 2</td>
<td>(IntOpt) RPC timeout for the engine liveness check that is used for stack locking.</td> <td>(IntOpt) RPC timeout for the engine liveness check that is used for stack locking.</td>
@ -34,16 +30,8 @@
<td>(IntOpt) Heartbeat time-to-live.</td> <td>(IntOpt) Heartbeat time-to-live.</td>
</tr> </tr>
<tr> <tr>
<td>password = None</td> <td>rpc_backend = rabbit</td>
<td>(StrOpt) Password for Redis server (optional).</td> <td>(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq.</td>
</tr>
<tr>
<td>port = 6379</td>
<td>(IntOpt) Use this port to connect to redis host.</td>
</tr>
<tr>
<td>rpc_backend = heat.openstack.common.rpc.impl_kombu</td>
<td>(StrOpt) The messaging module to use, defaults to kombu.</td>
</tr> </tr>
<tr> <tr>
<td>rpc_cast_timeout = 30</td> <td>rpc_cast_timeout = 30</td>
@ -51,15 +39,15 @@
</tr> </tr>
<tr> <tr>
<td>rpc_conn_pool_size = 30</td> <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>
<tr> <tr>
<td>rpc_response_timeout = 60</td> <td>rpc_response_timeout = 60</td>
<td>(IntOpt) Seconds to wait for a response from call or multicall</td> <td>(IntOpt) Seconds to wait for a response from a call.</td>
</tr> </tr>
<tr> <tr>
<td>rpc_thread_pool_size = 64</td> <td>rpc_thread_pool_size = 64</td>
<td>(IntOpt) Size of RPC thread pool</td> <td>(IntOpt) Size of RPC greenthread pool.</td>
</tr> </tr>
<tr> <tr>
<td>transport_url = None</td> <td>transport_url = None</td>

2
doc/common/tables/heat-zeromq.xml
View File

@ -26,7 +26,7 @@
<td>(IntOpt) Number of ZeroMQ contexts, defaults to 1.</td> <td>(IntOpt) Number of ZeroMQ contexts, defaults to 1.</td>
</tr> </tr>
<tr> <tr>
<td>rpc_zmq_host = oslo</td> <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> <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>
<tr> <tr>

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

@ -26,8 +26,8 @@
<td>(BoolOpt) Use durable queues in amqp.</td> <td>(BoolOpt) Use durable queues in amqp.</td>
</tr> </tr>
<tr> <tr>
<td>control_exchange = openstack</td> <td>control_exchange = keystone</td>
<td>(StrOpt) AMQP exchange to connect to if using RabbitMQ or Qpid</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>
<tr> <tr>
<td>default_publisher_id = None</td> <td>default_publisher_id = None</td>
@ -42,8 +42,8 @@
<td>(ListOpt) AMQP topic used for OpenStack notifications.</td> <td>(ListOpt) AMQP topic used for OpenStack notifications.</td>
</tr> </tr>
<tr> <tr>
<td>rpc_backend = keystone.openstack.common.rpc.impl_kombu</td> <td>rpc_backend = rabbit</td>
<td>(StrOpt) The messaging module to use, defaults to kombu.</td> <td>(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq.</td>
</tr> </tr>
<tr> <tr>
<td>rpc_cast_timeout = 30</td> <td>rpc_cast_timeout = 30</td>
@ -51,15 +51,15 @@
</tr> </tr>
<tr> <tr>
<td>rpc_conn_pool_size = 30</td> <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>
<tr> <tr>
<td>rpc_response_timeout = 60</td> <td>rpc_response_timeout = 60</td>
<td>(IntOpt) Seconds to wait for a response from call or multicall</td> <td>(IntOpt) Seconds to wait for a response from a call.</td>
</tr> </tr>
<tr> <tr>
<td>rpc_thread_pool_size = 64</td> <td>rpc_thread_pool_size = 64</td>
<td>(IntOpt) Size of RPC thread pool</td> <td>(IntOpt) Size of RPC greenthread pool.</td>
</tr> </tr>
<tr> <tr>
<td>transport_url = None</td> <td>transport_url = None</td>

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

@ -39,7 +39,7 @@
</tr> </tr>
<tr> <tr>
<td>compute_port = 8774</td> <td>compute_port = 8774</td>
<td>(IntOpt) The port which the OpenStack Compute service listens on.</td> <td>(IntOpt) (Deprecated) The port which the OpenStack Compute service listens on. This option was only used for string replacement in the templated catalog backend. Templated catalogs should replace the "$(compute_port)s" substitution with the static port of the compute service. As of Juno, this option is deprecated and will be removed in the L release.</td>
</tr> </tr>
<tr> <tr>
<td>domain_id_immutable = True</td> <td>domain_id_immutable = True</td>

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

@ -45,10 +45,6 @@
<td>proxies = </td> <td>proxies = </td>
<td>(ListOpt) Proxy classes to import that will affect the way the dogpile.cache backend functions. See the dogpile.cache documentation on changing-backend-behavior.</td> <td>(ListOpt) Proxy classes to import that will affect the way the dogpile.cache backend functions. See the dogpile.cache documentation on changing-backend-behavior.</td>
</tr> </tr>
<tr>
<td>use_key_mangler = True</td>
<td>(BoolOpt) Use a key-mangling function (sha1) to ensure fixed length cache-keys. This is toggle-able for debugging purposes, it is highly recommended to always leave this set to true.</td>
</tr>
</tbody> </tbody>
</table> </table>
</para> </para>

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

@ -17,6 +17,14 @@
<tr> <tr>
<th colspan="2">[catalog]</th> <th colspan="2">[catalog]</th>
</tr> </tr>
<tr>
<td>cache_time = None</td>
<td>(IntOpt) Time to cache catalog data (in seconds). This has no effect unless global and catalog caching are enabled.</td>
</tr>
<tr>
<td>caching = True</td>
<td>(BoolOpt) Toggle for catalog caching. This has no effect unless global caching is enabled.</td>
</tr>
<tr> <tr>
<td>driver = keystone.catalog.backends.sql.Catalog</td> <td>driver = keystone.catalog.backends.sql.Catalog</td>
<td>(StrOpt) Catalog backend driver.</td> <td>(StrOpt) Catalog backend driver.</td>

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

@ -25,10 +25,6 @@
<td>debug = False</td> <td>debug = False</td>
<td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).</td> <td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).</td>
</tr> </tr>
<tr>
<td>disable_process_locking = False</td>
<td>(BoolOpt) Enables or disables inter-process locks.</td>
</tr>
<tr> <tr>
<td>fatal_deprecations = False</td> <td>fatal_deprecations = False</td>
<td>(BoolOpt) Enables or disables fatal status of deprecations.</td> <td>(BoolOpt) Enables or disables fatal status of deprecations.</td>

46
doc/common/tables/keystone-ec2.xml
View File

@ -14,29 +14,6 @@
</tr> </tr>
</thead> </thead>
<tbody> <tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>keystone_ec2_cafile = None</td>
<td>(StrOpt) A PEM encoded certificate authority to use when verifying HTTPS connections. Defaults to the system CAs.</td>
</tr>
<tr>
<td>keystone_ec2_certfile = None</td>
<td>(StrOpt) Client certificate key filename. Required if EC2 server requires client certificate.</td>
</tr>
<tr>
<td>keystone_ec2_insecure = False</td>
<td>(BoolOpt) Disable SSL certificate verification.</td>
</tr>
<tr>
<td>keystone_ec2_keyfile = None</td>
<td>(StrOpt) Required if EC2 server requires client certificate.</td>
</tr>
<tr>
<td>keystone_ec2_url = http://localhost:5000/v2.0/ec2tokens</td>
<td>(StrOpt) URL to get token from ec2 request.</td>
</tr>
<tr> <tr>
<th colspan="2">[ec2]</th> <th colspan="2">[ec2]</th>
</tr> </tr>
@ -44,6 +21,29 @@
<td>driver = keystone.contrib.ec2.backends.kvs.Ec2</td> <td>driver = keystone.contrib.ec2.backends.kvs.Ec2</td>
<td>(StrOpt) EC2Credential backend driver.</td> <td>(StrOpt) EC2Credential backend driver.</td>
</tr> </tr>
<tr>
<th colspan="2">[keystone_ec2_token]</th>
</tr>
<tr>
<td>cafile = None</td>
<td>(StrOpt) A PEM encoded certificate authority to use when verifying HTTPS connections. Defaults to the system CAs.</td>
</tr>
<tr>
<td>certfile = None</td>
<td>(StrOpt) Client certificate key filename. Required if EC2 server requires client certificate.</td>
</tr>
<tr>
<td>insecure = False</td>
<td>(BoolOpt) Disable SSL certificate verification.</td>
</tr>
<tr>
<td>keyfile = None</td>
<td>(StrOpt) Required if EC2 server requires client certificate.</td>
</tr>
<tr>
<td>url = http://localhost:5000/v2.0/ec2tokens</td>
<td>(StrOpt) URL to get token from ec2 request.</td>
</tr>
</tbody> </tbody>
</table> </table>
</para> </para>

38
doc/common/tables/keystone-ldap.xml
View File

@ -25,6 +25,14 @@
<td>allow_subtree_delete = False</td> <td>allow_subtree_delete = False</td>
<td>(BoolOpt) Delete subtrees using the subtree delete control. Only enable this option if your LDAP server supports subtree deletion.</td> <td>(BoolOpt) Delete subtrees using the subtree delete control. Only enable this option if your LDAP server supports subtree deletion.</td>
</tr> </tr>
<tr>
<td>auth_pool_connection_lifetime = 60</td>
<td>(IntOpt) End user auth connection lifetime in seconds.</td>
</tr>
<tr>
<td>auth_pool_size = 100</td>
<td>(IntOpt) End user auth connection pool size.</td>
</tr>
<tr> <tr>
<td>chase_referrals = None</td> <td>chase_referrals = None</td>
<td>(BoolOpt) Override the system's default referral chasing behavior for queries.</td> <td>(BoolOpt) Override the system's default referral chasing behavior for queries.</td>
@ -93,6 +101,26 @@
<td>password = None</td> <td>password = None</td>
<td>(StrOpt) Password for the BindDN to query the LDAP server.</td> <td>(StrOpt) Password for the BindDN to query the LDAP server.</td>
</tr> </tr>
<tr>
<td>pool_connection_lifetime = 600</td>
<td>(IntOpt) Connection lifetime in seconds.</td>
</tr>
<tr>
<td>pool_connection_timeout = -1</td>
<td>(IntOpt) Connector timeout in seconds. Value -1 indicates indefinite wait for response.</td>
</tr>
<tr>
<td>pool_retry_delay = 0.1</td>
<td>(FloatOpt) Time span in seconds to wait between two reconnect trials.</td>
</tr>
<tr>
<td>pool_retry_max = 3</td>
<td>(IntOpt) Maximum count of reconnect trials.</td>
</tr>
<tr>
<td>pool_size = 10</td>
<td>(IntOpt) Connection pool size.</td>
</tr>
<tr> <tr>
<td>project_additional_attribute_mapping = </td> <td>project_additional_attribute_mapping = </td>
<td>(ListOpt) Additional attribute mappings for projects. Attribute mapping format is &lt;ldap_attr&gt;:&lt;user_attr&gt;, where ldap_attr is the attribute in the LDAP entry and user_attr is the Identity API attribute.</td> <td>(ListOpt) Additional attribute mappings for projects. Attribute mapping format is &lt;ldap_attr&gt;:&lt;user_attr&gt;, where ldap_attr is the attribute in the LDAP entry and user_attr is the Identity API attribute.</td>
@ -225,10 +253,18 @@
<td>url = ldap://localhost</td> <td>url = ldap://localhost</td>
<td>(StrOpt) URL for connecting to the LDAP server.</td> <td>(StrOpt) URL for connecting to the LDAP server.</td>
</tr> </tr>
<tr>
<td>use_auth_pool = False</td>
<td>(BoolOpt) Enable LDAP connection pooling for end user authentication. If use_pool is disabled, then this setting is meaningless and is not used at all.</td>
</tr>
<tr> <tr>
<td>use_dumb_member = False</td> <td>use_dumb_member = False</td>
<td>(BoolOpt) If true, will add a dummy member to groups. This is required if the objectclass for groups requires the "member" attribute.</td> <td>(BoolOpt) If true, will add a dummy member to groups. This is required if the objectclass for groups requires the "member" attribute.</td>
</tr> </tr>
<tr>
<td>use_pool = False</td>
<td>(BoolOpt) Enable LDAP connection pooling.</td>
</tr>
<tr> <tr>
<td>use_tls = False</td> <td>use_tls = False</td>
<td>(BoolOpt) Enable TLS for communicating with LDAP servers.</td> <td>(BoolOpt) Enable TLS for communicating with LDAP servers.</td>
@ -290,7 +326,7 @@
<td>(StrOpt) LDAP attribute mapped to user id.</td> <td>(StrOpt) LDAP attribute mapped to user id.</td>
</tr> </tr>
<tr> <tr>
<td>user_mail_attribute = email</td> <td>user_mail_attribute = mail</td>
<td>(StrOpt) LDAP attribute mapped to user email.</td> <td>(StrOpt) LDAP attribute mapped to user email.</td>
</tr> </tr>
<tr> <tr>

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

@ -18,16 +18,16 @@
<th colspan="2">[DEFAULT]</th> <th colspan="2">[DEFAULT]</th>
</tr> </tr>
<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>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</td>
<td>(ListOpt) List of logger=LEVEL pairs.</td> <td>(ListOpt) List of logger=LEVEL pairs.</td>
</tr> </tr>
<tr> <tr>
<td>instance_format = "[instance: %(uuid)s] "</td> <td>instance_format = "[instance: %(uuid)s] "</td>
<td>(StrOpt) The format for an instance that is passed with the log message. </td> <td>(StrOpt) The format for an instance that is passed with the log message.</td>
</tr> </tr>
<tr> <tr>
<td>instance_uuid_format = "[instance: %(uuid)s] "</td> <td>instance_uuid_format = "[instance: %(uuid)s] "</td>
<td>(StrOpt) The format for an instance UUID that is passed with the log message. </td> <td>(StrOpt) The format for an instance UUID that is passed with the log message.</td>
</tr> </tr>
<tr> <tr>
<td>log_config_append = None</td> <td>log_config_append = None</td>
@ -75,7 +75,7 @@
</tr> </tr>
<tr> <tr>
<td>use_syslog = False</td> <td>use_syslog = False</td>
<td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will chang in J to honor RFC5424.</td> <td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424.</td>
</tr> </tr>
<tr> <tr>
<td>use_syslog_rfc_format = False</td> <td>use_syslog_rfc_format = False</td>

34
doc/common/tables/keystone-mapping.xml Normal file
View File

@ -0,0 +1,34 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_keystone_mapping">
<caption>Description of configuration options for mapping</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[identity_mapping]</th>
</tr>
<tr>
<td>backward_compatible_ids = True</td>
<td>(BoolOpt) The format of user and group IDs changed in Juno for backends that do not generate UUIDs (e.g. LDAP), with keystone providing a hash mapping to the underlying attribute in LDAP. By default this mapping is disabled, which ensures that existing IDs will not change. Even when the mapping is enabled by using domain specific drivers, any users and groups from the default domain being handled by LDAP will still not be mapped to ensure their IDs remain backward compatible. Setting this value to False will enable the mapping for even the default LDAP driver. It is only safe to do this if you do not already have assignments for users and groups from the default LDAP domain, and it is acceptable for Keystone to provide the different IDs to clients than it did previously. Typically this means that the only time you can set this value to False is when configuring a fresh installation.</td>
</tr>
<tr>
<td>driver = keystone.identity.mapping_backends.sql.Mapping</td>
<td>(StrOpt) Keystone Identity Mapping backend driver.</td>
</tr>
<tr>
<td>generator = keystone.identity.id_generators.sha256.Generator</td>
<td>(StrOpt) Public ID generator for user and group entities. The Keystone identity mapper only supports generators that produce no more than 64 characters.</td>
</tr>
</tbody>
</table>
</para>

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

@ -19,7 +19,7 @@
</tr> </tr>
<tr> <tr>
<td>fake_rabbit = False</td> <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> </tr>
<tr> <tr>
<td>kombu_reconnect_delay = 1.0</td> <td>kombu_reconnect_delay = 1.0</td>

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

@ -17,10 +17,6 @@
<tr> <tr>
<th colspan="2">[DEFAULT]</th> <th colspan="2">[DEFAULT]</th>
</tr> </tr>
<tr>
<td>host = 127.0.0.1</td>
<td>(StrOpt) Host to locate redis.</td>
</tr>
<tr> <tr>
<td>matchmaker_heartbeat_freq = 300</td> <td>matchmaker_heartbeat_freq = 300</td>
<td>(IntOpt) Heartbeat frequency.</td> <td>(IntOpt) Heartbeat frequency.</td>
@ -29,6 +25,13 @@
<td>matchmaker_heartbeat_ttl = 600</td> <td>matchmaker_heartbeat_ttl = 600</td>
<td>(IntOpt) Heartbeat time-to-live.</td> <td>(IntOpt) Heartbeat time-to-live.</td>
</tr> </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> <tr>
<td>password = None</td> <td>password = None</td>
<td>(StrOpt) Password for Redis server (optional).</td> <td>(StrOpt) Password for Redis server (optional).</td>

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

@ -30,7 +30,7 @@
<td>(BoolOpt) Toggle for token system cacheing. This has no effect unless global caching is enabled.</td> <td>(BoolOpt) Toggle for token system cacheing. This has no effect unless global caching is enabled.</td>
</tr> </tr>
<tr> <tr>
<td>driver = keystone.token.backends.sql.Token</td> <td>driver = keystone.token.persistence.backends.sql.Token</td>
<td>(StrOpt) Token persistence backend driver.</td> <td>(StrOpt) Token persistence backend driver.</td>
</tr> </tr>
<tr> <tr>

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

@ -26,7 +26,7 @@
<td>(IntOpt) Number of ZeroMQ contexts, defaults to 1.</td> <td>(IntOpt) Number of ZeroMQ contexts, defaults to 1.</td>
</tr> </tr>
<tr> <tr>
<td>rpc_zmq_host = oslo</td> <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> <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>
<tr> <tr>

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

@ -33,10 +33,22 @@
<td>node_override_vif_bridge = </td> <td>node_override_vif_bridge = </td>
<td>(ListOpt) Nova compute nodes to manually set VIF type to bridge</td> <td>(ListOpt) Nova compute nodes to manually set VIF type to bridge</td>
</tr> </tr>
<tr>
<td>node_override_vif_distributed = </td>
<td>(ListOpt) Nova compute nodes to manually set VIF type to distributed</td>
</tr>
<tr>
<td>node_override_vif_dvs = </td>
<td>(ListOpt) Nova compute nodes to manually set VIF type to dvs</td>
</tr>
<tr> <tr>
<td>node_override_vif_hostdev = </td> <td>node_override_vif_hostdev = </td>
<td>(ListOpt) Nova compute nodes to manually set VIF type to hostdev</td> <td>(ListOpt) Nova compute nodes to manually set VIF type to hostdev</td>
</tr> </tr>
<tr>
<td>node_override_vif_hw_veb = </td>
<td>(ListOpt) Nova compute nodes to manually set VIF type to hw_veb</td>
</tr>
<tr> <tr>
<td>node_override_vif_hyperv = </td> <td>node_override_vif_hyperv = </td>
<td>(ListOpt) Nova compute nodes to manually set VIF type to hyperv</td> <td>(ListOpt) Nova compute nodes to manually set VIF type to hyperv</td>
@ -65,12 +77,16 @@
<td>node_override_vif_unbound = </td> <td>node_override_vif_unbound = </td>
<td>(ListOpt) Nova compute nodes to manually set VIF type to unbound</td> <td>(ListOpt) Nova compute nodes to manually set VIF type to unbound</td>
</tr> </tr>
<tr>
<td>node_override_vif_vrouter = </td>
<td>(ListOpt) Nova compute nodes to manually set VIF type to vrouter</td>
</tr>
<tr> <tr>
<td>vif_type = ovs</td> <td>vif_type = ovs</td>
<td>(StrOpt) Virtual interface type to configure on Nova compute nodes</td> <td>(StrOpt) Virtual interface type to configure on Nova compute nodes</td>
</tr> </tr>
<tr> <tr>
<td>vif_types = unbound, binding_failed, ovs, ivs, bridge, 802.1qbg, 802.1qbh, hyperv, midonet, mlnx_direct, hostdev, other</td> <td>vif_types = unbound, binding_failed, ovs, ivs, bridge, 802.1qbg, 802.1qbh, hyperv, midonet, mlnx_direct, hostdev, hw_veb, dvs, other, distributed, vrouter</td>
<td>(ListOpt) List of allowed vif_type values.</td> <td>(ListOpt) List of allowed vif_type values.</td>
</tr> </tr>
<tr> <tr>
@ -93,7 +109,7 @@
<td>(IntOpt) Time between verifications that the backend controller database is consistent with Neutron. (0 to disable)</td> <td>(IntOpt) Time between verifications that the backend controller database is consistent with Neutron. (0 to disable)</td>
</tr> </tr>
<tr> <tr>
<td>neutron_id = neutron-oslo</td> <td>neutron_id = neutron-shock</td>
<td>(StrOpt) User defined identifier for this Neutron deployment</td> <td>(StrOpt) User defined identifier for this Neutron deployment</td>
</tr> </tr>
<tr> <tr>

38
doc/common/tables/neutron-cfg_agent.xml Normal file
View File

@ -0,0 +1,38 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_neutron_cfg_agent">
<caption>Description of configuration options for cfg_agent</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>device_connection_timeout = 30</td>
<td>(IntOpt) Time in seconds for connecting to a hosting device</td>
</tr>
<tr>
<td>hosting_device_dead_timeout = 300</td>
<td>(IntOpt) The time in seconds until a backlogged hosting device is presumed dead. This value should be set up high enough to recover from a period of connectivity loss or high load when the device may not be responding.</td>
</tr>
<tr>
<td>routing_svc_helper_class = neutron.plugins.cisco.cfg_agent.service_helpers.routing_svc_helper.RoutingServiceHelper</td>
<td>(StrOpt) Path of the routing service helper class.</td>
</tr>
<tr>
<td>rpc_loop_interval = 10</td>
<td>(IntOpt) Interval when the process_services() loop executes in seconds. This is when the config agent lets each service helper to process its neutron resources.</td>
</tr>
</tbody>
</table>
</para>

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

@ -72,6 +72,10 @@
<td>http_pool_size = 4</td> <td>http_pool_size = 4</td>
<td>(IntOpt) Number of threads to use to make HTTP requests</td> <td>(IntOpt) Number of threads to use to make HTTP requests</td>
</tr> </tr>
<tr>
<td>http_timeout = 15</td>
<td>(IntOpt) N1K http timeout duration in seconds</td>
</tr>
<tr> <tr>
<td>integration_bridge = br-int</td> <td>integration_bridge = br-int</td>
<td>(StrOpt) N1K Integration Bridge</td> <td>(StrOpt) N1K Integration Bridge</td>

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

@ -33,10 +33,6 @@
<td>agent_down_time = 75</td> <td>agent_down_time = 75</td>
<td>(IntOpt) Seconds to regard the agent is down; should be at least twice report_interval, to be sure the agent is down for good.</td> <td>(IntOpt) Seconds to regard the agent is down; should be at least twice report_interval, to be sure the agent is down for good.</td>
</tr> </tr>
<tr>
<td>allowed_rpc_exception_modules = nova.exception, cinder.exception, exceptions</td>
<td>(ListOpt) Modules of exceptions that are permitted to be recreated upon receiving exception data from an rpc call.</td>
</tr>
<tr> <tr>
<td>api_workers = 0</td> <td>api_workers = 0</td>
<td>(IntOpt) Number of separate worker processes for service</td> <td>(IntOpt) Number of separate worker processes for service</td>
@ -126,8 +122,8 @@
<td>(StrOpt) Network service endpoint type to pull from the keystone catalog</td> <td>(StrOpt) Network service endpoint type to pull from the keystone catalog</td>
</tr> </tr>
<tr> <tr>
<td>force_gateway_on_subnet = False</td> <td>force_gateway_on_subnet = True</td>
<td>(BoolOpt) Ensure that configured gateway is on subnet</td> <td>(BoolOpt) Ensure that configured gateway is on subnet. For IPv6, validate only if gateway is not a link local address. Deprecated, to be removed during the K release, at which point the check will be mandatory.</td>
</tr> </tr>
<tr> <tr>
<td>interface_driver = None</td> <td>interface_driver = None</td>
@ -145,6 +141,10 @@
<td>mac_generation_retries = 16</td> <td>mac_generation_retries = 16</td>
<td>(IntOpt) How many times Neutron will retry MAC generation</td> <td>(IntOpt) How many times Neutron will retry MAC generation</td>
</tr> </tr>
<tr>
<td>max_allowed_address_pair = 10</td>
<td>(IntOpt) Maximum number of allowed address pairs</td>
</tr>
<tr> <tr>
<td>max_dns_nameservers = 5</td> <td>max_dns_nameservers = 5</td>
<td>(IntOpt) Maximum number of DNS nameservers</td> <td>(IntOpt) Maximum number of DNS nameservers</td>

50
doc/common/tables/neutron-database.xml
View File

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

30
doc/common/tables/neutron-dvr.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_dvr">
<caption>Description of configuration options for dvr</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>dvr_base_mac = fa:16:3f:00:00:00</td>
<td>(StrOpt) The base mac address used for unique DVR instances by Neutron</td>
</tr>
<tr>
<td>router_distributed = False</td>
<td>(BoolOpt) System-wide flag to determine the type of router that tenants can create. Only admin can override.</td>
</tr>
</tbody>
</table>
</para>

26
doc/common/tables/neutron-ipv6_ra.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_neutron_ipv6_ra">
<caption>Description of configuration options for ipv6_ra</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>ra_confs = $state_path/ra</td>
<td>(StrOpt) Location to store IPv6 RA config files</td>
</tr>
</tbody>
</table>
</para>

8
doc/common/tables/neutron-l3_agent.xml
View File

@ -17,6 +17,14 @@
<tr> <tr>
<th colspan="2">[DEFAULT]</th> <th colspan="2">[DEFAULT]</th>
</tr> </tr>
<tr>
<td>agent_mode = legacy</td>
<td>(StrOpt) The working mode for the agent. Allowed modes are: 'legacy' - this preserves the existing behavior where the L3 agent is deployed on a centralized networking node to provide L3 services like DNAT, and SNAT. Use this mode if you do not want to adopt DVR. 'dvr' - this mode enables DVR functionality and must be used for an L3 agent that runs on a compute host. 'dvr_snat' - this enables centralized SNAT support in conjunction with DVR. This mode must be used for an L3 agent running on a centralized node (or in single-host deployments, e.g. devstack)</td>
</tr>
<tr>
<td>allow_automatic_l3agent_failover = False</td>
<td>(BoolOpt) Automatically reschedule routers from offline L3 agents to online L3 agents.</td>
</tr>
<tr> <tr>
<td>enable_metadata_proxy = True</td> <td>enable_metadata_proxy = True</td>
<td>(BoolOpt) Allow running metadata proxy.</td> <td>(BoolOpt) Allow running metadata proxy.</td>

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

@ -33,10 +33,22 @@
<td>node_override_vif_bridge = </td> <td>node_override_vif_bridge = </td>
<td>(ListOpt) Nova compute nodes to manually set VIF type to bridge</td> <td>(ListOpt) Nova compute nodes to manually set VIF type to bridge</td>
</tr> </tr>
<tr>
<td>node_override_vif_distributed = </td>
<td>(ListOpt) Nova compute nodes to manually set VIF type to distributed</td>
</tr>
<tr>
<td>node_override_vif_dvs = </td>
<td>(ListOpt) Nova compute nodes to manually set VIF type to dvs</td>
</tr>
<tr> <tr>
<td>node_override_vif_hostdev = </td> <td>node_override_vif_hostdev = </td>
<td>(ListOpt) Nova compute nodes to manually set VIF type to hostdev</td> <td>(ListOpt) Nova compute nodes to manually set VIF type to hostdev</td>
</tr> </tr>
<tr>
<td>node_override_vif_hw_veb = </td>
<td>(ListOpt) Nova compute nodes to manually set VIF type to hw_veb</td>
</tr>
<tr> <tr>
<td>node_override_vif_hyperv = </td> <td>node_override_vif_hyperv = </td>
<td>(ListOpt) Nova compute nodes to manually set VIF type to hyperv</td> <td>(ListOpt) Nova compute nodes to manually set VIF type to hyperv</td>
@ -65,12 +77,16 @@
<td>node_override_vif_unbound = </td> <td>node_override_vif_unbound = </td>
<td>(ListOpt) Nova compute nodes to manually set VIF type to unbound</td> <td>(ListOpt) Nova compute nodes to manually set VIF type to unbound</td>
</tr> </tr>
<tr>
<td>node_override_vif_vrouter = </td>
<td>(ListOpt) Nova compute nodes to manually set VIF type to vrouter</td>
</tr>
<tr> <tr>
<td>vif_type = ovs</td> <td>vif_type = ovs</td>
<td>(StrOpt) Virtual interface type to configure on Nova compute nodes</td> <td>(StrOpt) Virtual interface type to configure on Nova compute nodes</td>
</tr> </tr>
<tr> <tr>
<td>vif_types = unbound, binding_failed, ovs, ivs, bridge, 802.1qbg, 802.1qbh, hyperv, midonet, mlnx_direct, hostdev, other</td> <td>vif_types = unbound, binding_failed, ovs, ivs, bridge, 802.1qbg, 802.1qbh, hyperv, midonet, mlnx_direct, hostdev, hw_veb, dvs, other, distributed, vrouter</td>
<td>(ListOpt) List of allowed vif_type values.</td> <td>(ListOpt) List of allowed vif_type values.</td>
</tr> </tr>
<tr> <tr>
@ -93,7 +109,7 @@
<td>(IntOpt) Time between verifications that the backend controller database is consistent with Neutron. (0 to disable)</td> <td>(IntOpt) Time between verifications that the backend controller database is consistent with Neutron. (0 to disable)</td>
</tr> </tr>
<tr> <tr>
<td>neutron_id = neutron-oslo</td> <td>neutron_id = neutron-shock</td>
<td>(StrOpt) User defined identifier for this Neutron deployment</td> <td>(StrOpt) User defined identifier for this Neutron deployment</td>
</tr> </tr>
<tr> <tr>

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

@ -23,7 +23,11 @@
</tr> </tr>
<tr> <tr>
<td>ostype = NOS</td> <td>ostype = NOS</td>
<td>(StrOpt) Unused</td> <td>(StrOpt) OS Type of the switch</td>
</tr>
<tr>
<td>osversion = 4.0.0</td>
<td>(StrOpt) OS Version number</td>
</tr> </tr>
<tr> <tr>
<td>password = password</td> <td>password = password</td>

30
doc/common/tables/neutron-ml2_sriov.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_ml2_sriov">
<caption>Description of configuration options for ml2_sriov</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[ml2_sriov]</th>
</tr>
<tr>
<td>agent_required = False</td>
<td>(BoolOpt) SRIOV neutron agent is required for port binding</td>
</tr>
<tr>
<td>supported_pci_vendor_devs = 15b3:1004, 8086:10c9</td>
<td>(ListOpt) Supported PCI vendor devices, defined by vendor_id:product_id according to the PCI ID Repository. Default enables support for Intel and Mellanox SR-IOV capable NICs</td>
</tr>
</tbody>
</table>
</para>

30
doc/common/tables/neutron-opencontrail.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_opencontrail">
<caption>Description of configuration options for opencontrail</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[CONTRAIL]</th>
</tr>
<tr>
<td>api_server_ip = 127.0.0.1</td>
<td>(StrOpt) IP address to connect to opencontrail controller</td>
</tr>
<tr>
<td>api_server_port = 8082</td>
<td>(IntOpt) Port to connect to opencontrail controller</td>
</tr>
</tbody>
</table>
</para>

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

@ -40,6 +40,10 @@
<td>dont_fragment = True</td> <td>dont_fragment = True</td>
<td>(BoolOpt) Set or un-set the don't fragment (DF) bit on outgoing IP packet carrying GRE/VXLAN tunnel</td> <td>(BoolOpt) Set or un-set the don't fragment (DF) bit on outgoing IP packet carrying GRE/VXLAN tunnel</td>
</tr> </tr>
<tr>
<td>enable_distributed_routing = False</td>
<td>(BoolOpt) Make the l2 agent run in DVR mode</td>
</tr>
<tr> <tr>
<td>l2_population = False</td> <td>l2_population = False</td>
<td>(BoolOpt) Use ml2 l2population mechanism driver to learn remote mac and IPs and improve tunnel scalability</td> <td>(BoolOpt) Use ml2 l2population mechanism driver to learn remote mac and IPs and improve tunnel scalability</td>

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

@ -41,7 +41,7 @@
<td>(IntOpt) Number of firewall policies allowed per tenant. A negative value means unlimited.</td> <td>(IntOpt) Number of firewall policies allowed per tenant. A negative value means unlimited.</td>
</tr> </tr>
<tr> <tr>
<td>quota_firewall_rule = -1</td> <td>quota_firewall_rule = 100</td>
<td>(IntOpt) Number of firewall rules allowed per tenant. A negative value means unlimited.</td> <td>(IntOpt) Number of firewall rules allowed per tenant. A negative value means unlimited.</td>
</tr> </tr>
<tr> <tr>

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

@ -18,9 +18,24 @@
<th colspan="2">[DEFAULT]</th> <th colspan="2">[DEFAULT]</th>
</tr> </tr>
<tr> <tr>
<td>host = oslo</td> <td>host = localhost</td>
<td>(StrOpt) The hostname Neutron is running on</td> <td>(StrOpt) The hostname Neutron is running on</td>
</tr> </tr>
<tr>
<th colspan="2">[matchmaker_redis]</th>
</tr>
<tr>
<td>host = 127.0.0.1</td>
<td>(StrOpt) Host to locate redis.</td>
</tr>
<tr>
<td>password = None</td>
<td>(StrOpt) Password for Redis server (optional).</td>
</tr>
<tr>
<td>port = 6379</td>
<td>(IntOpt) Use this port to connect to redis host.</td>
</tr>
</tbody> </tbody>
</table> </table>
</para> </para>

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

@ -26,8 +26,8 @@
<td>(BoolOpt) Use durable queues in amqp.</td> <td>(BoolOpt) Use durable queues in amqp.</td>
</tr> </tr>
<tr> <tr>
<td>control_exchange = openstack</td> <td>control_exchange = neutron</td>
<td>(StrOpt) AMQP exchange to connect to if using RabbitMQ or Qpid</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>
<tr> <tr>
<td>matchmaker_heartbeat_freq = 300</td> <td>matchmaker_heartbeat_freq = 300</td>
@ -38,16 +38,8 @@
<td>(IntOpt) Heartbeat time-to-live.</td> <td>(IntOpt) Heartbeat time-to-live.</td>
</tr> </tr>
<tr> <tr>
<td>password = None</td> <td>rpc_backend = rabbit</td>
<td>(StrOpt) Password for Redis server (optional).</td> <td>(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq.</td>
</tr>
<tr>
<td>port = 6379</td>
<td>(IntOpt) Use this port to connect to redis host.</td>
</tr>
<tr>
<td>rpc_backend = neutron.openstack.common.rpc.impl_kombu</td>
<td>(StrOpt) The messaging module to use, defaults to kombu.</td>
</tr> </tr>
<tr> <tr>
<td>rpc_cast_timeout = 30</td> <td>rpc_cast_timeout = 30</td>
@ -55,15 +47,15 @@
</tr> </tr>
<tr> <tr>
<td>rpc_conn_pool_size = 30</td> <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>
<tr> <tr>
<td>rpc_response_timeout = 60</td> <td>rpc_response_timeout = 60</td>
<td>(IntOpt) Seconds to wait for a response from call or multicall</td> <td>(IntOpt) Seconds to wait for a response from a call.</td>
</tr> </tr>
<tr> <tr>
<td>rpc_thread_pool_size = 64</td> <td>rpc_thread_pool_size = 64</td>
<td>(IntOpt) Size of RPC thread pool</td> <td>(IntOpt) Size of RPC greenthread pool.</td>
</tr> </tr>
<tr> <tr>
<td>rpc_workers = 0</td> <td>rpc_workers = 0</td>

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

@ -14,6 +14,17 @@
</tr> </tr>
</thead> </thead>
<tbody> <tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>wsapi_host = </td>
<td>(StrOpt) webapp listen host</td>
</tr>
<tr>
<td>wsapi_port = 8080</td>
<td>(IntOpt) webapp listen port</td>
</tr>
<tr> <tr>
<th colspan="2">[OVS]</th> <th colspan="2">[OVS]</th>
</tr> </tr>

30
doc/common/tables/neutron-sriov.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_sriov">
<caption>Description of configuration options for sriov</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[SRIOV_NIC]</th>
</tr>
<tr>
<td>exclude_devices = </td>
<td>(ListOpt) List of &lt;network_device&gt;:&lt;excluded_devices&gt; mapping network_device to the agent's node-specific list of virtual functions that should not be used for virtual networking. excluded_devices is a semicolon separated list of virtual functions (BDF format).to exclude from network_device. The network_device in the mapping should appear in the physical_device_mappings list.</td>
</tr>
<tr>
<td>physical_device_mappings = </td>
<td>(ListOpt) List of &lt;physical_network&gt;:&lt;network_device&gt; mapping physical network names to the agent's node-specific physical network device of SR-IOV physical function to be used for VLAN networks. All physical networks listed in network_vlan_ranges on the server should have mappings to appropriate interfaces on each agent</td>
</tr>
</tbody>
</table>
</para>

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

@ -23,7 +23,7 @@
</tr> </tr>
<tr> <tr>
<td>fake_rabbit = False</td> <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> </tr>
</tbody> </tbody>
</table> </table>

8
doc/common/tables/neutron-vmware.xml
View File

@ -38,7 +38,7 @@
<td>(StrOpt) This is uuid of the default NSX Transport zone that will be used for creating tunneled isolated "Neutron" networks. It needs to be created in NSX before starting Neutron with the nsx plugin.</td> <td>(StrOpt) This is uuid of the default NSX Transport zone that will be used for creating tunneled isolated "Neutron" networks. It needs to be created in NSX before starting Neutron with the nsx plugin.</td>
</tr> </tr>
<tr> <tr>
<td>http_timeout = 30</td> <td>http_timeout = 75</td>
<td>(IntOpt) Time before aborting a request</td> <td>(IntOpt) Time before aborting a request</td>
</tr> </tr>
<tr> <tr>
@ -57,10 +57,6 @@
<td>redirects = 2</td> <td>redirects = 2</td>
<td>(IntOpt) Number of times a redirect should be followed</td> <td>(IntOpt) Number of times a redirect should be followed</td>
</tr> </tr>
<tr>
<td>req_timeout = 30</td>
<td>(IntOpt) Total time limit for a cluster request</td>
</tr>
<tr> <tr>
<td>retries = 2</td> <td>retries = 2</td>
<td>(IntOpt) Number of time a request should be retried</td> <td>(IntOpt) Number of time a request should be retried</td>
@ -105,7 +101,7 @@
</tr> </tr>
<tr> <tr>
<td>replication_mode = service</td> <td>replication_mode = service</td>
<td>(StrOpt) The default option leverages service nodes to perform packet replication though one could set to this to 'source' to perform replication locally. This is useful if one does not want to deploy a service node(s).</td> <td>(StrOpt) The default option leverages service nodes to perform packet replication though one could set to this to 'source' to perform replication locally. This is useful if one does not want to deploy a service node(s). It must be set to 'service' for leveraging distributed routers.</td>
</tr> </tr>
<tr> <tr>
<th colspan="2">[NSX_DHCP]</th> <th colspan="2">[NSX_DHCP]</th>

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

@ -26,7 +26,7 @@
<td>(IntOpt) Number of ZeroMQ contexts, defaults to 1.</td> <td>(IntOpt) Number of ZeroMQ contexts, defaults to 1.</td>
</tr> </tr>
<tr> <tr>
<td>rpc_zmq_host = oslo</td> <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> <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>
<tr> <tr>

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

@ -125,13 +125,6 @@
<td>virtual_power_type = virsh</td> <td>virtual_power_type = virsh</td>
<td>(StrOpt) Base command to use for virtual power(vbox, virsh)</td> <td>(StrOpt) Base command to use for virtual power(vbox, virsh)</td>
</tr> </tr>
<tr>
<th colspan="2">[xenserver]</th>
</tr>
<tr>
<td>vif_driver = nova.virt.xenapi.vif.XenAPIBridgeDriver</td>
<td>(StrOpt) The XenAPI VIF driver using XenServer Network APIs.</td>
</tr>
</tbody> </tbody>
</table> </table>
</para> </para>

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

@ -18,7 +18,7 @@
<th colspan="2">[DEFAULT]</th> <th colspan="2">[DEFAULT]</th>
</tr> </tr>
<tr> <tr>
<td>bindir = /usr/local/local/bin</td> <td>bindir = /usr/local/bin</td>
<td>(StrOpt) Directory where nova binaries are installed</td> <td>(StrOpt) Directory where nova binaries are installed</td>
</tr> </tr>
<tr> <tr>
@ -35,10 +35,10 @@
</tr> </tr>
<tr> <tr>
<td>disable_process_locking = False</td> <td>disable_process_locking = False</td>
<td>(BoolOpt) Whether to disable inter-process locks</td> <td>(BoolOpt) Enables or disables inter-process locks.</td>
</tr> </tr>
<tr> <tr>
<td>host = oslo</td> <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> <td>(StrOpt) Name of this node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address. However, the node name must be valid within an AMQP key, and if using ZeroMQ, a valid hostname, FQDN, or IP address</td>
</tr> </tr>
<tr> <tr>
@ -70,11 +70,7 @@
<td>(StrOpt) If set, send compute.instance.update notifications on instance state changes. Valid values are None for no notifications, "vm_state" for notifications on VM state changes, or "vm_and_task_state" for notifications on VM and task state changes.</td> <td>(StrOpt) If set, send compute.instance.update notifications on instance state changes. Valid values are None for no notifications, "vm_state" for notifications on VM state changes, or "vm_and_task_state" for notifications on VM and task state changes.</td>
</tr> </tr>
<tr> <tr>
<td>port = 6379</td> <td>pybasedir = /usr/lib/python/site-packages/nova</td>
<td>(IntOpt) Use this port to connect to redis host.</td>
</tr>
<tr>
<td>pybasedir = /usr/lib/python/site-packages/sources/nova</td>
<td>(StrOpt) Directory where the nova python module is installed</td> <td>(StrOpt) Directory where the nova python module is installed</td>
</tr> </tr>
<tr> <tr>

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

@ -23,7 +23,7 @@
</tr> </tr>
<tr> <tr>
<td>compute_driver = None</td> <td>compute_driver = None</td>
<td>(StrOpt) Driver to use for controlling virtualization. Options include: libvirt.LibvirtDriver, xenapi.XenAPIDriver, fake.FakeDriver, baremetal.BareMetalDriver, vmwareapi.VMwareVCDriver</td> <td>(StrOpt) Driver to use for controlling virtualization. Options include: libvirt.LibvirtDriver, xenapi.XenAPIDriver, fake.FakeDriver, baremetal.BareMetalDriver, vmwareapi.VMwareVCDriver, hyperv.HyperVDriver</td>
</tr> </tr>
<tr> <tr>
<td>compute_manager = nova.compute.manager.ComputeManager</td> <td>compute_manager = nova.compute.manager.ComputeManager</td>
@ -33,12 +33,16 @@
<td>compute_monitors = </td> <td>compute_monitors = </td>
<td>(ListOpt) A list of monitors that can be used for getting compute metrics.</td> <td>(ListOpt) A list of monitors that can be used for getting compute metrics.</td>
</tr> </tr>
<tr>
<td>compute_resources = vcpu</td>
<td>(ListOpt) The names of the extra resources to track.</td>
</tr>
<tr> <tr>
<td>compute_stats_class = nova.compute.stats.Stats</td> <td>compute_stats_class = nova.compute.stats.Stats</td>
<td>(StrOpt) Class that will manage stats for the local compute host</td> <td>(StrOpt) Class that will manage stats for the local compute host</td>
</tr> </tr>
<tr> <tr>
<td>console_host = oslo</td> <td>console_host = localhost</td>
<td>(StrOpt) Console proxy host to use to connect to instances on this host.</td> <td>(StrOpt) Console proxy host to use to connect to instances on this host.</td>
</tr> </tr>
<tr> <tr>

2
doc/common/tables/nova-configdrive.xml
View File

@ -27,7 +27,7 @@
</tr> </tr>
<tr> <tr>
<td>config_drive_tempdir = None</td> <td>config_drive_tempdir = None</td>
<td>(StrOpt) Where to put temporary files associated with config drive creation</td> <td>(StrOpt) DEPRECATED (not needed any more): Where to put temporary files associated with config drive creation</td>
</tr> </tr>
<tr> <tr>
<td>force_config_drive = None</td> <td>force_config_drive = None</td>

2
doc/common/tables/nova-console.xml
View File

@ -18,7 +18,7 @@
<th colspan="2">[DEFAULT]</th> <th colspan="2">[DEFAULT]</th>
</tr> </tr>
<tr> <tr>
<td>console_public_hostname = oslo</td> <td>console_public_hostname = localhost</td>
<td>(StrOpt) Publicly visible name for this console host</td> <td>(StrOpt) Publicly visible name for this console host</td>
</tr> </tr>
<tr> <tr>

8
doc/common/tables/nova-libvirt.xml
View File

@ -52,6 +52,10 @@
<td>disk_prefix = None</td> <td>disk_prefix = None</td>
<td>(StrOpt) Override the default disk prefix for the devices attached to a server, which is dependent on virt_type. (valid options are: sd, xvd, uvd, vd)</td> <td>(StrOpt) Override the default disk prefix for the devices attached to a server, which is dependent on virt_type. (valid options are: sd, xvd, uvd, vd)</td>
</tr> </tr>
<tr>
<td>hw_machine_type = None</td>
<td>(ListOpt) For qemu or KVM guests, set this option to specify a default machine type per host architecture. You can find a list of supported machine types in your environment by checking the output of the "virsh capabilities"command. The format of the value for this config option is host-arch=machine-type. For example: x86_64=machinetype1,armv7l=machinetype2</td>
</tr>
<tr> <tr>
<td>image_info_filename_pattern = $instances_path/$image_cache_subdirectory_name/%(image)s.info</td> <td>image_info_filename_pattern = $instances_path/$image_cache_subdirectory_name/%(image)s.info</td>
<td>(StrOpt) Allows image information files to be stored in non-standard locations</td> <td>(StrOpt) Allows image information files to be stored in non-standard locations</td>
@ -72,10 +76,6 @@
<td>snapshots_directory = $instances_path/snapshots</td> <td>snapshots_directory = $instances_path/snapshots</td>
<td>(StrOpt) Location where libvirt driver will store snapshots before uploading them to image service</td> <td>(StrOpt) Location where libvirt driver will store snapshots before uploading them to image service</td>
</tr> </tr>
<tr>
<td>vif_driver = nova.virt.libvirt.vif.LibvirtGenericVIFDriver</td>
<td>(StrOpt) DEPRECATED. The libvirt VIF driver to configure the VIFs.This option is deprecated and will be removed in the Juno release.</td>
</tr>
<tr> <tr>
<td>virt_type = kvm</td> <td>virt_type = kvm</td>
<td>(StrOpt) Libvirt domain type (valid options are: kvm, lxc, qemu, uml, xen)</td> <td>(StrOpt) Libvirt domain type (valid options are: kvm, lxc, qemu, uml, xen)</td>

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

@ -22,7 +22,7 @@
<td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).</td> <td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).</td>
</tr> </tr>
<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>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</td>
<td>(ListOpt) List of logger=LEVEL pairs.</td> <td>(ListOpt) List of logger=LEVEL pairs.</td>
</tr> </tr>
<tr> <tr>
@ -35,11 +35,11 @@
</tr> </tr>
<tr> <tr>
<td>instance_format = "[instance: %(uuid)s] "</td> <td>instance_format = "[instance: %(uuid)s] "</td>
<td>(StrOpt) The format for an instance that is passed with the log message. </td> <td>(StrOpt) The format for an instance that is passed with the log message.</td>
</tr> </tr>
<tr> <tr>
<td>instance_uuid_format = "[instance: %(uuid)s] "</td> <td>instance_uuid_format = "[instance: %(uuid)s] "</td>
<td>(StrOpt) The format for an instance UUID that is passed with the log message. </td> <td>(StrOpt) The format for an instance UUID that is passed with the log message.</td>
</tr> </tr>
<tr> <tr>
<td>log_config_append = None</td> <td>log_config_append = None</td>

2
doc/common/tables/nova-network.xml
View File

@ -167,7 +167,7 @@
</tr> </tr>
<tr> <tr>
<td>network_device_mtu = None</td> <td>network_device_mtu = None</td>
<td>(IntOpt) MTU setting for network interface</td> <td>(IntOpt) DEPRECATED: THIS VALUE SHOULD BE SET WHEN CREATING THE NETWORK. MTU setting for network interface.</td>
</tr> </tr>
<tr> <tr>
<td>network_driver = nova.network.linux_net</td> <td>network_driver = nova.network.linux_net</td>

26
doc/common/tables/nova-neutron.xml
View File

@ -21,14 +21,6 @@
<td>neutron_default_tenant_id = default</td> <td>neutron_default_tenant_id = default</td>
<td>(StrOpt) Default tenant id when creating neutron networks</td> <td>(StrOpt) Default tenant id when creating neutron networks</td>
</tr> </tr>
<tr>
<td>neutron_metadata_proxy_shared_secret = </td>
<td>(StrOpt) Shared secret to validate proxies Neutron metadata requests</td>
</tr>
<tr>
<td>service_neutron_metadata_proxy = False</td>
<td>(BoolOpt) Set flag to indicate Neutron will proxy metadata requests and resolve instance ids.</td>
</tr>
<tr> <tr>
<th colspan="2">[neutron]</th> <th colspan="2">[neutron]</th>
</tr> </tr>
@ -46,12 +38,20 @@
</tr> </tr>
<tr> <tr>
<td>admin_tenant_name = None</td> <td>admin_tenant_name = None</td>
<td>(StrOpt) Tenant name for connecting to neutron in admin context. This option is mutually exclusive with admin_tenant_id. Note that with Keystone V3 tenant names are only unique within a domain.</td> <td>(StrOpt) Tenant name for connecting to neutron in admin context. This option will be ignored if neutron_admin_tenant_id is set. Note that with Keystone V3 tenant names are only unique within a domain.</td>
</tr>
<tr>
<td>admin_user_id = None</td>
<td>(StrOpt) User id for connecting to neutron in admin context</td>
</tr> </tr>
<tr> <tr>
<td>admin_username = None</td> <td>admin_username = None</td>
<td>(StrOpt) Username for connecting to neutron in admin context</td> <td>(StrOpt) Username for connecting to neutron in admin context</td>
</tr> </tr>
<tr>
<td>allow_duplicate_networks = False</td>
<td>(BoolOpt) Allow an instance to have multiple vNICs attached to the same Neutron network.</td>
</tr>
<tr> <tr>
<td>api_insecure = False</td> <td>api_insecure = False</td>
<td>(BoolOpt) If set, ignore any SSL validation issues</td> <td>(BoolOpt) If set, ignore any SSL validation issues</td>
@ -68,6 +68,10 @@
<td>extension_sync_interval = 600</td> <td>extension_sync_interval = 600</td>
<td>(IntOpt) Number of seconds before querying neutron for extensions</td> <td>(IntOpt) Number of seconds before querying neutron for extensions</td>
</tr> </tr>
<tr>
<td>metadata_proxy_shared_secret = </td>
<td>(StrOpt) Shared secret to validate proxies Neutron metadata requests</td>
</tr>
<tr> <tr>
<td>ovs_bridge = br-int</td> <td>ovs_bridge = br-int</td>
<td>(StrOpt) Name of Integration Bridge used by Open vSwitch</td> <td>(StrOpt) Name of Integration Bridge used by Open vSwitch</td>
@ -76,6 +80,10 @@
<td>region_name = None</td> <td>region_name = None</td>
<td>(StrOpt) Region name for connecting to neutron in admin context</td> <td>(StrOpt) Region name for connecting to neutron in admin context</td>
</tr> </tr>
<tr>
<td>service_metadata_proxy = False</td>
<td>(BoolOpt) Set flag to indicate Neutron will proxy metadata requests and resolve instance ids.</td>
</tr>
<tr> <tr>
<td>url = http://127.0.0.1:9696</td> <td>url = http://127.0.0.1:9696</td>
<td>(StrOpt) URL for connecting to neutron</td> <td>(StrOpt) URL for connecting to neutron</td>

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

@ -15,12 +15,20 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<th colspan="2">[DEFAULT]</th> <th colspan="2">[matchmaker_redis]</th>
</tr>
<tr>
<td>host = 127.0.0.1</td>
<td>(StrOpt) Host to locate redis.</td>
</tr> </tr>
<tr> <tr>
<td>password = None</td> <td>password = None</td>
<td>(StrOpt) Password for Redis server (optional).</td> <td>(StrOpt) Password for Redis server (optional).</td>
</tr> </tr>
<tr>
<td>port = 6379</td>
<td>(IntOpt) Use this port to connect to redis host.</td>
</tr>
</tbody> </tbody>
</table> </table>
</para> </para>

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

@ -27,7 +27,7 @@
</tr> </tr>
<tr> <tr>
<td>control_exchange = openstack</td> <td>control_exchange = openstack</td>
<td>(StrOpt) AMQP exchange to connect to if using RabbitMQ or Qpid</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>
<tr> <tr>
<td>matchmaker_heartbeat_freq = 300</td> <td>matchmaker_heartbeat_freq = 300</td>
@ -38,8 +38,8 @@
<td>(IntOpt) Heartbeat time-to-live.</td> <td>(IntOpt) Heartbeat time-to-live.</td>
</tr> </tr>
<tr> <tr>
<td>rpc_backend = nova.openstack.common.rpc.impl_kombu</td> <td>rpc_backend = rabbit</td>
<td>(StrOpt) The messaging module to use, defaults to kombu.</td> <td>(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq.</td>
</tr> </tr>
<tr> <tr>
<td>rpc_cast_timeout = 30</td> <td>rpc_cast_timeout = 30</td>
@ -47,15 +47,15 @@
</tr> </tr>
<tr> <tr>
<td>rpc_conn_pool_size = 30</td> <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>
<tr> <tr>
<td>rpc_response_timeout = 60</td> <td>rpc_response_timeout = 60</td>
<td>(IntOpt) Seconds to wait for a response from call or multicall</td> <td>(IntOpt) Seconds to wait for a response from a call.</td>
</tr> </tr>
<tr> <tr>
<td>rpc_thread_pool_size = 64</td> <td>rpc_thread_pool_size = 64</td>
<td>(IntOpt) Size of RPC thread pool</td> <td>(IntOpt) Size of RPC greenthread pool.</td>
</tr> </tr>
<tr> <tr>
<th colspan="2">[cells]</th> <th colspan="2">[cells]</th>

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

@ -27,7 +27,7 @@
</tr> </tr>
<tr> <tr>
<td>control_exchange = openstack</td> <td>control_exchange = openstack</td>
<td>(StrOpt) AMQP exchange to connect to if using RabbitMQ or Qpid</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>
<tr> <tr>
<td>kombu_reconnect_delay = 1.0</td> <td>kombu_reconnect_delay = 1.0</td>
@ -146,8 +146,8 @@
<td>(StrOpt) The RabbitMQ virtual host.</td> <td>(StrOpt) The RabbitMQ virtual host.</td>
</tr> </tr>
<tr> <tr>
<td>rpc_backend = nova.openstack.common.rpc.impl_kombu</td> <td>rpc_backend = rabbit</td>
<td>(StrOpt) The messaging module to use, defaults to kombu.</td> <td>(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq.</td>
</tr> </tr>
<tr> <tr>
<td>rpc_cast_timeout = 30</td> <td>rpc_cast_timeout = 30</td>
@ -155,15 +155,15 @@
</tr> </tr>
<tr> <tr>
<td>rpc_conn_pool_size = 30</td> <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>
<tr> <tr>
<td>rpc_response_timeout = 60</td> <td>rpc_response_timeout = 60</td>
<td>(IntOpt) Seconds to wait for a response from call or multicall</td> <td>(IntOpt) Seconds to wait for a response from a call.</td>
</tr> </tr>
<tr> <tr>
<td>rpc_thread_pool_size = 64</td> <td>rpc_thread_pool_size = 64</td>
<td>(IntOpt) Size of RPC thread pool</td> <td>(IntOpt) Size of RPC greenthread pool.</td>
</tr> </tr>
<tr> <tr>
<td>rpc_zmq_bind_address = *</td> <td>rpc_zmq_bind_address = *</td>
@ -174,7 +174,7 @@
<td>(IntOpt) Number of ZeroMQ contexts, defaults to 1.</td> <td>(IntOpt) Number of ZeroMQ contexts, defaults to 1.</td>
</tr> </tr>
<tr> <tr>
<td>rpc_zmq_host = oslo</td> <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> <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>
<tr> <tr>

8
doc/common/tables/nova-scheduling.xml
View File

@ -25,6 +25,10 @@
<td>aggregate_image_properties_isolation_separator = .</td> <td>aggregate_image_properties_isolation_separator = .</td>
<td>(StrOpt) The separator used between the namespace and keys</td> <td>(StrOpt) The separator used between the namespace and keys</td>
</tr> </tr>
<tr>
<td>baremetal_scheduler_default_filters = RetryFilter, AvailabilityZoneFilter, ComputeFilter, ComputeCapabilitiesFilter, ImagePropertiesFilter, ExactRamFilter, ExactDiskFilter, ExactCoreFilter</td>
<td>(ListOpt) Which filter class names to use for filtering baremetal hosts when not specified in the request.</td>
</tr>
<tr> <tr>
<td>cpu_allocation_ratio = 16.0</td> <td>cpu_allocation_ratio = 16.0</td>
<td>(FloatOpt) Virtual CPU to physical CPU allocation ratio which affects all CPU filters. This configuration specifies a global ratio for CoreFilter. For AggregateCoreFilter, it will fall back to this configuration value if no per-aggregate setting found.</td> <td>(FloatOpt) Virtual CPU to physical CPU allocation ratio which affects all CPU filters. This configuration specifies a global ratio for CoreFilter. For AggregateCoreFilter, it will fall back to this configuration value if no per-aggregate setting found.</td>
@ -109,6 +113,10 @@
<td>scheduler_topic = scheduler</td> <td>scheduler_topic = scheduler</td>
<td>(StrOpt) The topic scheduler nodes listen on</td> <td>(StrOpt) The topic scheduler nodes listen on</td>
</tr> </tr>
<tr>
<td>scheduler_use_baremetal_filters = False</td>
<td>(BoolOpt) Flag to decide whether to use baremetal_scheduler_default_filters or not.</td>
</tr>
<tr> <tr>
<td>scheduler_weight_classes = nova.scheduler.weights.all_weighers</td> <td>scheduler_weight_classes = nova.scheduler.weights.all_weighers</td>
<td>(ListOpt) Which weight class names to use for weighing hosts</td> <td>(ListOpt) Which weight class names to use for weighing hosts</td>

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

@ -17,10 +17,6 @@
<tr> <tr>
<th colspan="2">[DEFAULT]</th> <th colspan="2">[DEFAULT]</th>
</tr> </tr>
<tr>
<td>allowed_rpc_exception_modules = nova.exception, cinder.exception, exceptions</td>
<td>(ListOpt) Modules of exceptions that are permitted to be recreatedupon receiving exception data from an rpc call.</td>
</tr>
<tr> <tr>
<td>backdoor_port = None</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> <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>
@ -35,7 +31,7 @@
</tr> </tr>
<tr> <tr>
<td>fake_rabbit = False</td> <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> </tr>
<tr> <tr>
<td>monkey_patch = False</td> <td>monkey_patch = False</td>

10
doc/common/tables/nova-vmware.xml
View File

@ -23,7 +23,7 @@
</tr> </tr>
<tr> <tr>
<td>cluster_name = None</td> <td>cluster_name = None</td>
<td>(MultiStrOpt) Name of a VMware Cluster ComputeResource. Used only if compute_driver is vmwareapi.VMwareVCDriver.</td> <td>(MultiStrOpt) Name of a VMware Cluster ComputeResource.</td>
</tr> </tr>
<tr> <tr>
<td>datastore_regex = None</td> <td>datastore_regex = None</td>
@ -31,19 +31,19 @@
</tr> </tr>
<tr> <tr>
<td>host_ip = None</td> <td>host_ip = None</td>
<td>(StrOpt) Hostname or IP address for connection to VMware ESX/VC host.</td> <td>(StrOpt) Hostname or IP address for connection to VMware VC host.</td>
</tr> </tr>
<tr> <tr>
<td>host_password = None</td> <td>host_password = None</td>
<td>(StrOpt) Password for connection to VMware ESX/VC host.</td> <td>(StrOpt) Password for connection to VMware VC host.</td>
</tr> </tr>
<tr> <tr>
<td>host_port = 443</td> <td>host_port = 443</td>
<td>(IntOpt) Port for connection to VMware ESX/VC host.</td> <td>(IntOpt) Port for connection to VMware VC host.</td>
</tr> </tr>
<tr> <tr>
<td>host_username = None</td> <td>host_username = None</td>
<td>(StrOpt) Username for connection to VMware ESX/VC host.</td> <td>(StrOpt) Username for connection to VMware VC host.</td>
</tr> </tr>
<tr> <tr>
<td>integration_bridge = br-int</td> <td>integration_bridge = br-int</td>

8
doc/common/tables/nova-volumes.xml
View File

@ -17,6 +17,14 @@
<tr> <tr>
<th colspan="2">[DEFAULT]</th> <th colspan="2">[DEFAULT]</th>
</tr> </tr>
<tr>
<td>block_device_allocate_retries = 60</td>
<td>(IntOpt) Number of times to retry block device allocation on failures</td>
</tr>
<tr>
<td>block_device_allocate_retries_interval = 3</td>
<td>(IntOpt) Waiting time interval (seconds) between block device allocation retries on failures</td>
</tr>
<tr> <tr>
<td>cinder_api_insecure = False</td> <td>cinder_api_insecure = False</td>
<td>(BoolOpt) Allow to perform insecure SSL requests to cinder</td> <td>(BoolOpt) Allow to perform insecure SSL requests to cinder</td>

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

@ -239,6 +239,10 @@
<td>vhd_coalesce_poll_interval = 5.0</td> <td>vhd_coalesce_poll_interval = 5.0</td>
<td>(FloatOpt) The interval used for polling of coalescing vhds. Used only if compute_driver=xenapi.XenAPIDriver</td> <td>(FloatOpt) The interval used for polling of coalescing vhds. Used only if compute_driver=xenapi.XenAPIDriver</td>
</tr> </tr>
<tr>
<td>vif_driver = nova.virt.xenapi.vif.XenAPIBridgeDriver</td>
<td>(StrOpt) The XenAPI VIF driver using XenServer Network APIs.</td>
</tr>
</tbody> </tbody>
</table> </table>
</para> </para>

2
doc/common/tables/nova-zeromq.xml
View File

@ -26,7 +26,7 @@
<td>(IntOpt) Number of ZeroMQ contexts, defaults to 1.</td> <td>(IntOpt) Number of ZeroMQ contexts, defaults to 1.</td>
</tr> </tr>
<tr> <tr>
<td>rpc_zmq_host = oslo</td> <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> <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>
<tr> <tr>

2
doc/common/tables/swift-container-reconciler-container-reconciler.xml
View File

@ -17,7 +17,7 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>interval = 300</td> <td>interval = 30</td>
<td>Minimum time for a pass to take</td> <td>Minimum time for a pass to take</td>
</tr> </tr>
<tr> <tr>

2
doc/common/tables/swift-dispersion-dispersion.xml
View File

@ -29,7 +29,7 @@
<td>Default user for dispersion in this context</td> <td>Default user for dispersion in this context</td>
</tr> </tr>
<tr> <tr>
<td>auth_version = 2.0</td> <td>auth_version = 1.0</td>
<td>Indicates which version of auth</td> <td>Indicates which version of auth</td>
</tr> </tr>
<tr> <tr>

2
doc/common/tables/swift-drive-audit-drive-audit.xml
View File

@ -33,7 +33,7 @@
<td>Syslog log facility</td> <td>Syslog log facility</td>
</tr> </tr>
<tr> <tr>
<td>log_file_pattern = /var/log/kern*</td> <td>log_file_pattern = /var/log/kern.*[!.][!g][!z]</td>
<td>Location of the log file with globbing pattern to check against device errors locate device blocks with errors in the log file</td> <td>Location of the log file with globbing pattern to check against device errors locate device blocks with errors in the log file</td>
</tr> </tr>
<tr> <tr>

97
doc/common/tables/swift-object-expirer-filter-proxy-logging.xml Normal file
View File

@ -0,0 +1,97 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- The tool that generated this table lives in the
openstack-doc-tools repository. The editions made in
this file will *not* be lost if you run the script again. -->
<table rules="all">
<caption>Description of configuration options for
<literal>[filter-proxy-logging]</literal> in <literal>object-expirer.conf</literal>
</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>access_log_address = /dev/log</td>
<td>No help text available for this option.</td>
</tr>
<tr>
<td>access_log_facility = LOG_LOCAL0</td>
<td>No help text available for this option.</td>
</tr>
<tr>
<td>access_log_headers = false</td>
<td>No help text available for this option.</td>
</tr>
<tr>
<td>access_log_headers_only = </td>
<td>If access_log_headers is True and access_log_headers_only is set only
these headers are logged. Multiple headers can be defined as comma separated list like this:
access_log_headers_only = Host, X-Object-Meta-Mtime</td>
</tr>
<tr>
<td>access_log_level = INFO</td>
<td>No help text available for this option.</td>
</tr>
<tr>
<td>access_log_name = swift</td>
<td>No help text available for this option.</td>
</tr>
<tr>
<td>access_log_statsd_default_sample_rate = 1.0</td>
<td>No help text available for this option.</td>
</tr>
<tr>
<td>access_log_statsd_host = localhost</td>
<td>No help text available for this option.</td>
</tr>
<tr>
<td>access_log_statsd_metric_prefix = </td>
<td>No help text available for this option.</td>
</tr>
<tr>
<td>access_log_statsd_port = 8125</td>
<td>No help text available for this option.</td>
</tr>
<tr>
<td>access_log_statsd_sample_rate_factor = 1.0</td>
<td>No help text available for this option.</td>
</tr>
<tr>
<td>access_log_udp_host = </td>
<td>No help text available for this option.</td>
</tr>
<tr>
<td>access_log_udp_port = 514</td>
<td>No help text available for this option.</td>
</tr>
<tr>
<td>log_statsd_valid_http_methods = GET,HEAD,POST,PUT,DELETE,COPY,OPTIONS</td>
<td>No help text available for this option.</td>
</tr>
<tr>
<td>logged with access_log_headers = True.</td>
<td>No help text available for this option.</td>
</tr>
<tr>
<td>reveal_sensitive_prefix = 16</td>
<td>
The X-Auth-Token is sensitive data. If revealed to an unauthorised person,
they can now make requests against an account until the token expires.
Set reveal_sensitive_prefix to the number of characters of the token that are logged.
For example reveal_sensitive_prefix = 12 so only first 12 characters of the token are logged.
Or, set to 0 to completely remove the token.</td>
</tr>
<tr>
<td>use = egg:swift#proxy_logging</td>
<td>Entry point of paste.deploy in the server</td>
</tr>
</tbody>
</table>
</para>

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