Browse Source

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
changes/56/115256/2
Gauvain Pocentek 8 years ago
parent
commit
8b2016b5d0
  1. 8
      doc/common/tables/ceilometer-alarm.xml
  2. 11
      doc/common/tables/ceilometer-collector.xml
  3. 4
      doc/common/tables/ceilometer-common.xml
  4. 12
      doc/common/tables/ceilometer-database.xml
  5. 26
      doc/common/tables/ceilometer-debug.xml
  6. 14
      doc/common/tables/ceilometer-exchange.xml
  7. 26
      doc/common/tables/ceilometer-glance.xml
  8. 6
      doc/common/tables/ceilometer-logging.xml
  9. 7
      doc/common/tables/ceilometer-nova_cells.xml
  10. 2
      doc/common/tables/ceilometer-rabbitmq.xml
  11. 17
      doc/common/tables/ceilometer-redis.xml
  12. 24
      doc/common/tables/ceilometer-rpc.xml
  13. 34
      doc/common/tables/ceilometer-tripleo.xml
  14. 4
      doc/common/tables/cinder-common.xml
  15. 4
      doc/common/tables/cinder-database.xml
  16. 28
      doc/common/tables/cinder-emc.xml
  17. 4
      doc/common/tables/cinder-hds-hnas.xml
  18. 4
      doc/common/tables/cinder-hp3par.xml
  19. 8
      doc/common/tables/cinder-keymgr.xml
  20. 30
      doc/common/tables/cinder-nimble.xml
  21. 46
      doc/common/tables/cinder-prophetstor_dpl.xml
  22. 47
      doc/common/tables/cinder-prophststor_dpl.xml
  23. 26
      doc/common/tables/cinder-pure.xml
  24. 31
      doc/common/tables/cinder-rpc.xml
  25. 4
      doc/common/tables/cinder-san.xml
  26. 4
      doc/common/tables/cinder-storage.xml
  27. 4
      doc/common/tables/cinder-storwize.xml
  28. 30
      doc/common/tables/cinder-swift.xml
  29. 4
      doc/common/tables/cinder-vmware.xml
  30. 6
      doc/common/tables/glance-api.xml
  31. 10
      doc/common/tables/glance-common.xml
  32. 42
      doc/common/tables/glance-database.xml
  33. 6
      doc/common/tables/glance-logging.xml
  34. 30
      doc/common/tables/glance-profiler.xml
  35. 2
      doc/common/tables/glance-redis.xml
  36. 2
      doc/common/tables/glance-zmq.xml
  37. 4
      doc/common/tables/heat-amqp.xml
  38. 12
      doc/common/tables/heat-api.xml
  39. 4
      doc/common/tables/heat-clients_cinder.xml
  40. 42
      doc/common/tables/heat-database.xml
  41. 2
      doc/common/tables/heat-notification.xml
  42. 17
      doc/common/tables/heat-redis.xml
  43. 22
      doc/common/tables/heat-rpc.xml
  44. 2
      doc/common/tables/heat-zeromq.xml
  45. 14
      doc/common/tables/keystone-amqp.xml
  46. 2
      doc/common/tables/keystone-api.xml
  47. 4
      doc/common/tables/keystone-cache.xml
  48. 8
      doc/common/tables/keystone-catalog.xml
  49. 4
      doc/common/tables/keystone-debug.xml
  50. 26
      doc/common/tables/keystone-ec2.xml
  51. 38
      doc/common/tables/keystone-ldap.xml
  52. 8
      doc/common/tables/keystone-logging.xml
  53. 34
      doc/common/tables/keystone-mapping.xml
  54. 2
      doc/common/tables/keystone-rabbit.xml
  55. 11
      doc/common/tables/keystone-redis.xml
  56. 2
      doc/common/tables/keystone-token.xml
  57. 2
      doc/common/tables/keystone-zeromq.xml
  58. 20
      doc/common/tables/neutron-bigswitch.xml
  59. 38
      doc/common/tables/neutron-cfg_agent.xml
  60. 4
      doc/common/tables/neutron-cisco.xml
  61. 12
      doc/common/tables/neutron-common.xml
  62. 50
      doc/common/tables/neutron-database.xml
  63. 30
      doc/common/tables/neutron-dvr.xml
  64. 26
      doc/common/tables/neutron-ipv6_ra.xml
  65. 8
      doc/common/tables/neutron-l3_agent.xml
  66. 20
      doc/common/tables/neutron-ml2_bigswitch.xml
  67. 6
      doc/common/tables/neutron-ml2_brocade.xml
  68. 30
      doc/common/tables/neutron-ml2_sriov.xml
  69. 30
      doc/common/tables/neutron-opencontrail.xml
  70. 4
      doc/common/tables/neutron-openvswitch_agent.xml
  71. 2
      doc/common/tables/neutron-quotas.xml
  72. 17
      doc/common/tables/neutron-redis.xml
  73. 22
      doc/common/tables/neutron-rpc.xml
  74. 11
      doc/common/tables/neutron-ryu.xml
  75. 30
      doc/common/tables/neutron-sriov.xml
  76. 2
      doc/common/tables/neutron-testing.xml
  77. 8
      doc/common/tables/neutron-vmware.xml
  78. 2
      doc/common/tables/neutron-zeromq.xml
  79. 7
      doc/common/tables/nova-baremetal.xml
  80. 12
      doc/common/tables/nova-common.xml
  81. 8
      doc/common/tables/nova-compute.xml
  82. 2
      doc/common/tables/nova-configdrive.xml
  83. 2
      doc/common/tables/nova-console.xml
  84. 8
      doc/common/tables/nova-libvirt.xml
  85. 6
      doc/common/tables/nova-logging.xml
  86. 2
      doc/common/tables/nova-network.xml
  87. 26
      doc/common/tables/nova-neutron.xml
  88. 10
      doc/common/tables/nova-redis.xml
  89. 12
      doc/common/tables/nova-rpc.xml
  90. 14
      doc/common/tables/nova-rpc_all.xml
  91. 8
      doc/common/tables/nova-scheduling.xml
  92. 6
      doc/common/tables/nova-testing.xml
  93. 10
      doc/common/tables/nova-vmware.xml
  94. 8
      doc/common/tables/nova-volumes.xml
  95. 4
      doc/common/tables/nova-xen.xml
  96. 2
      doc/common/tables/nova-zeromq.xml
  97. 2
      doc/common/tables/swift-container-reconciler-container-reconciler.xml
  98. 2
      doc/common/tables/swift-dispersion-dispersion.xml
  99. 2
      doc/common/tables/swift-drive-audit-drive-audit.xml
  100. 97
      doc/common/tables/swift-object-expirer-filter-proxy-logging.xml
  101. Some files were not shown because too many files have changed in this diff Show More

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

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

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

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

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

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

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

@ -24,6 +24,10 @@
<tr>
<th colspan="2">[database]</th>
</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>
<td>backend = sqlalchemy</td>
<td>(StrOpt) The backend to use for db</td>
@ -72,6 +76,10 @@
<td>max_retries = 10</td>
<td>(IntOpt) Maximum db connection retries during startup. (setting -1 implies an infinite retry count)</td>
</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>
<td>min_pool_size = 1</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>(BoolOpt) Enable the experimental use of database reconnect on connection lost</td>
</tr>
<tr>
<td>use_tpool = False</td>
<td>(BoolOpt) Enable the experimental use of thread pooling for all DB API calls</td>
</tr>
</tbody>
</table>
</para>

26
doc/common/tables/ceilometer-debug.xml

@ -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

@ -23,7 +23,7 @@
</tr>
<tr>
<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>
<td>glance_control_exchange = glance</td>
@ -37,6 +37,14 @@
<td>http_control_exchanges = ['nova', 'glance', 'neutron', 'cinder']</td>
<td>(MultiStrOpt) Exchanges name to listen for notifications.</td>
</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>
<td>neutron_control_exchange = neutron</td>
<td>(StrOpt) Exchange name for Neutron notifications.</td>
@ -45,6 +53,10 @@
<td>nova_control_exchange = nova</td>
<td>(StrOpt) Exchange name for Nova notifications.</td>
</tr>
<tr>
<td>sahara_control_exchange = sahara</td>
<td>(StrOpt) Exchange name for Data Processing notifications</td>
</tr>
<tr>
<td>sample_source = openstack</td>
<td>(StrOpt) Source for samples emitted on this instance.</td>

26
doc/common/tables/ceilometer-glance.xml

@ -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

@ -22,16 +22,16 @@
<td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).</td>
</tr>
<tr>
<td>default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN</td>
<td>default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN</td>
<td>(ListOpt) List of logger=LEVEL pairs.</td>
</tr>
<tr>
<td>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>
<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>
<td>log_config_append = None</td>

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

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

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

@ -19,7 +19,7 @@
</tr>
<tr>
<td>fake_rabbit = False</td>
<td>(BoolOpt) If passed, use a fake RabbitMQ provider</td>
<td>(BoolOpt) If passed, use a fake RabbitMQ provider.</td>
</tr>
<tr>
<td>kombu_reconnect_delay = 1.0</td>

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

@ -18,7 +18,7 @@
<th colspan="2">[DEFAULT]</th>
</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>
</tr>
<tr>
@ -29,6 +29,21 @@
<td>matchmaker_heartbeat_ttl = 600</td>
<td>(IntOpt) Heartbeat time-to-live.</td>
</tr>
<tr>
<th colspan="2">[matchmaker_redis]</th>
</tr>
<tr>
<td>host = 127.0.0.1</td>
<td>(StrOpt) Host to locate redis.</td>
</tr>
<tr>
<td>password = None</td>
<td>(StrOpt) Password for Redis server (optional).</td>
</tr>
<tr>
<td>port = 6379</td>
<td>(IntOpt) Use this port to connect to redis host.</td>
</tr>
<tr>
<th colspan="2">[matchmaker_ring]</th>
</tr>

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

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

34
doc/common/tables/ceilometer-tripleo.xml

@ -0,0 +1,34 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_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

@ -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>
</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>
</tr>
<tr>
@ -51,7 +51,7 @@
</tr>
<tr>
<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>
<td>host = localhost</td>

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

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

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

@ -22,16 +22,36 @@
<td>(StrOpt) The configuration file for the Cinder EMC driver</td>
</tr>
<tr>
<td>max_luns_per_storage_group = 256</td>
<td>(IntOpt) Default max number of LUNs in a storage group</td>
<td>destroy_empty_storage_group = False</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>
<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>
<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>
</tbody>
</table>

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

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

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

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

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

@ -21,6 +21,14 @@
<td>api_class = cinder.keymgr.conf_key_mgr.ConfKeyManager</td>
<td>(StrOpt) The full class name of the key manager API class</td>
</tr>
<tr>
<td>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>
<td>fixed_key = None</td>
<td>(StrOpt) Fixed key returned by key manager, specified in hex</td>

30
doc/common/tables/cinder-nimble.xml

@ -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

@ -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

@ -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

@ -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

@ -17,10 +17,6 @@
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>allowed_rpc_exception_modules = oslo.messaging.exceptions, nova.exception, cinder.exception, exceptions</td>
<td>(ListOpt) Modules of exceptions that are permitted to be recreated upon receiving exception data from an rpc call.</td>
</tr>
<tr>
<td>amqp_auto_delete = False</td>
<td>(BoolOpt) Auto-delete queues in amqp.</td>
@ -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>
</tr>
<tr>
<td>default_timeout = 20</td>
<td>(IntOpt) Default Time Out For CLI operations in minutes</td>
<td>default_timeout = 525600</td>
<td>(IntOpt) Default timeout for CLI operations in minutes. For example, LUN migration is a typical long running operation, which depends on the LUN size and the load of the array. An upper bound in the specific deployment can be set to avoid unnecessary long wait. By default, it is 365 days long.</td>
</tr>
<tr>
<td>fake_rabbit = False</td>
@ -77,14 +73,6 @@
<td>notification_topics = notifications</td>
<td>(ListOpt) AMQP topic used for OpenStack notifications.</td>
</tr>
<tr>
<td>password = None</td>
<td>(StrOpt) Password for Redis server (optional).</td>
</tr>
<tr>
<td>port = 6379</td>
<td>(IntOpt) Use this port to connect to redis host.</td>
</tr>
<tr>
<td>publish_errors = False</td>
<td>(BoolOpt) Enables or disables publication of error events.</td>
@ -233,6 +221,21 @@
<td>volume_topic = cinder-volume</td>
<td>(StrOpt) The topic that volume nodes listen on</td>
</tr>
<tr>
<th colspan="2">[matchmaker_redis]</th>
</tr>
<tr>
<td>host = 127.0.0.1</td>
<td>(StrOpt) Host to locate redis.</td>
</tr>
<tr>
<td>password = None</td>
<td>(StrOpt) Password for Redis server (optional).</td>
</tr>
<tr>
<td>port = 6379</td>
<td>(IntOpt) Use this port to connect to redis host.</td>
</tr>
<tr>
<th colspan="2">[matchmaker_ring]</th>
</tr>

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

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

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

@ -53,6 +53,10 @@
<td>iscsi_target_prefix = iqn.2010-10.org.openstack:</td>
<td>(StrOpt) Prefix for iSCSI volumes</td>
</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>
<td>iser_helper = tgtadm</td>
<td>(StrOpt) The name of the iSER target user-land tool to use</td>

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

@ -37,6 +37,10 @@
<td>storwize_svc_multipath_enabled = False</td>
<td>(BoolOpt) Connect with multipath (FC only; iSCSI multipath is controlled by Nova)</td>
</tr>
<tr>
<td>storwize_svc_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>
<td>storwize_svc_vol_autoexpand = True</td>
<td>(BoolOpt) Storage system autoexpand parameter for volumes (True/False)</td>

30
doc/common/tables/cinder-swift.xml

@ -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

@ -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>
</tr>
<tr>
<td>vmware_task_poll_interval = 5</td>
<td>(IntOpt) The interval (in seconds) for polling remote tasks invoked on VMware ESX/VC server.</td>
<td>vmware_task_poll_interval = 0.5</td>
<td>(FloatOpt) The interval (in seconds) for polling remote tasks invoked on VMware ESX/VC server.</td>
</tr>
<tr>
<td>vmware_volume_folder = cinder-volumes</td>

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

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

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

@ -43,7 +43,7 @@
</tr>
<tr>
<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>
<td>image_location_quota = 10</td>
@ -73,10 +73,6 @@
<td>metadata_encryption_key = None</td>
<td>(StrOpt) Key used for encrypting sensitive metadata while talking to the registry or database.</td>
</tr>
<tr>
<td>notifier_strategy = default</td>
<td>(StrOpt) Notifications can be sent when images are create, updated or deleted. There are three methods of sending notifications, logging (via the log_file directive), rabbit (via a rabbitmq queue), qpid (via a Qpid message queue), or noop (no notifications sent, the default).</td>
</tr>
<tr>
<td>os_region_name = None</td>
<td>(StrOpt) Region name of this node.</td>
@ -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>
</tr>
<tr>
<td>workers = 1</td>
<td>(IntOpt) The number of child process workers that will be created to service API requests.</td>
<td>workers = 4</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>
<th colspan="2">[image_format]</th>

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

@ -19,55 +19,55 @@
</tr>
<tr>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<td>db_retry_interval = 1</td>
<td>(IntOpt) seconds between db connection retries</td>
<td>(IntOpt) Seconds between database connection retries.</td>
</tr>
<tr>
<td>idle_timeout = 3600</td>
<td>(IntOpt) Timeout before idle sql connections are reaped</td>
<td>(IntOpt) Timeout before idle SQL connections are reaped.</td>
</tr>
<tr>
<td>max_overflow = None</td>
<td>(IntOpt) If set, use this value for max_overflow with sqlalchemy</td>
<td>(IntOpt) If set, use this value for max_overflow with SQLAlchemy.</td>
</tr>
<tr>
<td>max_pool_size = None</td>
<td>(IntOpt) Maximum number of SQL connections to keep open in a pool</td>
<td>(IntOpt) Maximum number of SQL connections to keep open in a pool.</td>
</tr>
<tr>
<td>max_retries = 10</td>
<td>(IntOpt) Maximum db connection retries during startup. (setting -1 implies an infinite retry count)</td>
<td>(IntOpt) Maximum db connection retries during startup. Set to -1 to specify an infinite retry count.</td>
</tr>
<tr>
<td>min_pool_size = 1</td>
<td>(IntOpt) Minimum number of SQL connections to keep open in a pool</td>
<td>(IntOpt) Minimum number of SQL connections to keep open in a pool.</td>
</tr>
<tr>
<td>mysql_sql_mode = TRADITIONAL</td>
@ -75,23 +75,27 @@
</tr>
<tr>
<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>
<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>
<td>sqlite_db = glance.sqlite</td>
<td>(StrOpt) The file name to use with SQLite</td>
<td>slave_connection = None</td>
<td>(StrOpt) The SQLAlchemy connection string to use to connect to the slave database.</td>
</tr>
<tr>
<td>sqlite_db = oslo.sqlite</td>
<td>(StrOpt) The file name to use with SQLite.</td>
</tr>
<tr>
<td>sqlite_synchronous = True</td>
<td>(BoolOpt) If True, SQLite uses synchronous mode</td>
<td>(BoolOpt) If True, SQLite uses synchronous mode.</td>
</tr>
<tr>
<td>use_db_reconnect = False</td>
<td>(BoolOpt) Enable the experimental use of database reconnect on connection lost</td>
<td>(BoolOpt) Enable the experimental use of database reconnect on connection lost.</td>
</tr>
</tbody>
</table>

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

@ -31,11 +31,11 @@
</tr>
<tr>
<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>
<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>
<td>log_config_append = None</td>
@ -87,7 +87,7 @@
</tr>
<tr>
<td>use_syslog = False</td>
<td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will chang in J to honor RFC5424.</td>
<td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424.</td>
</tr>
<tr>
<td>use_syslog_rfc_format = False</td>

30
doc/common/tables/glance-profiler.xml

@ -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

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

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

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

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

@ -27,7 +27,7 @@
</tr>
<tr>
<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>
<td>default_notification_level = INFO</td>
@ -39,7 +39,7 @@
</tr>
<tr>
<td>fake_rabbit = False</td>
<td>(BoolOpt) If passed, use a fake RabbitMQ provider</td>
<td>(BoolOpt) If passed, use a fake RabbitMQ provider.</td>
</tr>
<tr>
<td>list_notifier_drivers = None</td>

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

@ -17,6 +17,10 @@
<tr>
<th colspan="2">[DEFAULT]</th>
</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>
<td>heat_metadata_server_url = </td>
<td>(StrOpt) URL of the Heat metadata server.</td>
@ -66,8 +70,12 @@
<td>(StrOpt) Keystone password for stack_domain_admin user.</td>
</tr>
<tr>
<td>stack_user_domain = None</td>
<td>(StrOpt) Keystone domain ID which contains heat template-defined users.</td>
<td>stack_user_domain_id = None</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>
<td>trusts_delegated_roles = heat_stack_owner</td>

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

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

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

@ -19,55 +19,55 @@
</tr>
<tr>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<td>db_retry_interval = 1</td>
<td>(IntOpt) seconds between db connection retries</td>
<td>(IntOpt) Seconds between database connection retries.</td>
</tr>
<tr>
<td>idle_timeout = 3600</td>
<td>(IntOpt) Timeout before idle sql connections are reaped</td>
<td>(IntOpt) Timeout before idle SQL connections are reaped.</td>
</tr>
<tr>
<td>max_overflow = None</td>
<td>(IntOpt) If set, use this value for max_overflow with sqlalchemy</td>
<td>(IntOpt) If set, use this value for max_overflow with SQLAlchemy.</td>
</tr>
<tr>
<td>max_pool_size = None</td>
<td>(IntOpt) Maximum number of SQL connections to keep open in a pool</td>
<td>(IntOpt) Maximum number of SQL connections to keep open in a pool.</td>
</tr>
<tr>
<td>max_retries = 10</td>
<td>(IntOpt) Maximum db connection retries during startup. (setting -1 implies an infinite retry count)</td>
<td>(IntOpt) Maximum db connection retries during startup. Set to -1 to specify an infinite retry count.</td>
</tr>
<tr>
<td>min_pool_size = 1</td>
<td>(IntOpt) Minimum number of SQL connections to keep open in a pool</td>
<td>(IntOpt) Minimum number of SQL connections to keep open in a pool.</td>
</tr>
<tr>
<td>mysql_sql_mode = TRADITIONAL</td>
@ -75,23 +75,27 @@
</tr>
<tr>
<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>
<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>
<td>sqlite_db = heat.sqlite</td>
<td>(StrOpt) The file name to use with SQLite</td>
<td>slave_connection = None</td>
<td>(StrOpt) The SQLAlchemy connection string to use to connect to the slave database.</td>
</tr>
<tr>
<td>sqlite_db = oslo.sqlite</td>
<td>(StrOpt) The file name to use with SQLite.</td>
</tr>
<tr>
<td>sqlite_synchronous = True</td>
<td>(BoolOpt) If True, SQLite uses synchronous mode</td>
<td>(BoolOpt) If True, SQLite uses synchronous mode.</td>
</tr>
<tr>
<td>use_db_reconnect = False</td>
<td>(BoolOpt) Enable the experimental use of database reconnect on connection lost</td>
<td>(BoolOpt) Enable the experimental use of database reconnect on connection lost.</td>
</tr>
</tbody>
</table>

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

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

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

@ -18,9 +18,24 @@
<th colspan="2">[DEFAULT]</th>
</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>
</tr>
<tr>
<th colspan="2">[matchmaker_redis]</th>
</tr>
<tr>
<td>host = 127.0.0.1</td>
<td>(StrOpt) Host to locate redis.</td>
</tr>
<tr>
<td>password = None</td>
<td>(StrOpt) Password for Redis server (optional).</td>
</tr>
<tr>
<td>port = 6379</td>
<td>(IntOpt) Use this port to connect to redis host.</td>
</tr>
</tbody>
</table>
</para>

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

@ -17,10 +17,6 @@
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>allowed_rpc_exception_modules = nova.exception, cinder.exception, exceptions</td>
<td>(ListOpt) Modules of exceptions that are permitted to be recreated upon receiving exception data from an rpc call.</td>
</tr>
<tr>
<td>engine_life_check_timeout = 2</td>
<td>(IntOpt) RPC timeout for the engine liveness check that is used for stack locking.</td>
@ -34,16 +30,8 @@