openstack/openstack-manuals
Code Issues Proposed changes

config-reference: update tables and flagmappings

Browse Source 
Updated options using the autohelp.py script.

Change-Id: If973ba3bf1b9f65dddc1160da63b1ac9e4fc6497
This commit is contained in:
Gauvain Pocentek 2014-04-03 19:19:17 +02:00
parent 6d9ef96f6c
commit e2270f8ee5
10 changed files with 36 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -71,8 +71,8 @@
<td>(IntOpt) Minimum number of SQL connections to keep open in a pool</td>
</tr>
<tr>
<td>mysql_sql_mode = None</td>
<td>(StrOpt) The SQL mode to be used for MySQL sessions (default is empty, meaning do not override any server-side SQL mode setting)</td>
<td>mysql_sql_mode = TRADITIONAL</td>
<td>(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=</td>
</tr>
<tr>
<td>pool_timeout = None</td>

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

@ -83,7 +83,7 @@
</tr>
<tr>
<td>auto_sync_on_failure = True</td>
<td>(BoolOpt) If neutron fails to create a resource because the backend controller doesn't know of a dependency, automatically trigger a full data synchronization to the controller.</td>
<td>(BoolOpt) If neutron fails to create a resource because the backend controller doesn't know of a dependency, the plugin automatically triggers a full data synchronization to the controller.</td>
</tr>
<tr>
<td>cache_connections = True</td>
@ -103,11 +103,11 @@
</tr>
<tr>
<td>server_auth = None</td>
<td>(StrOpt) The username and password for authenticating against the BigSwitch or Floodlight controller.</td>
<td>(StrOpt) The username and password for authenticating against the Big Switch or Floodlight controller.</td>
</tr>
<tr>
<td>server_ssl = True</td>
<td>(BoolOpt) If True, Use SSL when connecting to the BigSwitch or Floodlight controller.</td>
<td>(BoolOpt) If True, Use SSL when connecting to the Big Switch or Floodlight controller.</td>
</tr>
<tr>
<td>server_timeout = 10</td>
@ -115,7 +115,7 @@
</tr>
<tr>
<td>servers = localhost:8800</td>
<td>(ListOpt) A comma separated list of BigSwitch or Floodlight servers and port numbers. The plugin proxies the requests to the BigSwitch/Floodlight server, which performs the networking configuration. Only oneserver is needed per deployment, but you may wish todeploy multiple servers to support failover.</td>
<td>(ListOpt) A comma separated list of Big Switch or Floodlight servers and port numbers. The plugin proxies the requests to the Big Switch/Floodlight server, which performs the networking configuration. Only oneserver is needed per deployment, but you may wish todeploy multiple servers to support failover.</td>
</tr>
<tr>
<td>ssl_cert_directory = /etc/neutron/plugins/bigswitch/ssl</td>

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

@ -32,7 +32,7 @@
</tr>
<tr>
<td>kombu_ssl_version = </td>
<td>(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions</td>
<td>(StrOpt) If SSL is enabled, the SSL version to use. Valid values are TLSv1, SSLv23 and SSLv3. SSLv2 might be available on some distributions.</td>
</tr>
</tbody>
</table>

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

@ -83,7 +83,7 @@
</tr>
<tr>
<td>auto_sync_on_failure = True</td>
<td>(BoolOpt) If neutron fails to create a resource because the backend controller doesn't know of a dependency, automatically trigger a full data synchronization to the controller.</td>
<td>(BoolOpt) If neutron fails to create a resource because the backend controller doesn't know of a dependency, the plugin automatically triggers a full data synchronization to the controller.</td>
</tr>
<tr>
<td>cache_connections = True</td>
@ -103,11 +103,11 @@
</tr>
<tr>
<td>server_auth = None</td>
<td>(StrOpt) The username and password for authenticating against the BigSwitch or Floodlight controller.</td>
<td>(StrOpt) The username and password for authenticating against the Big Switch or Floodlight controller.</td>
</tr>
<tr>
<td>server_ssl = True</td>
<td>(BoolOpt) If True, Use SSL when connecting to the BigSwitch or Floodlight controller.</td>
<td>(BoolOpt) If True, Use SSL when connecting to the Big Switch or Floodlight controller.</td>
</tr>
<tr>
<td>server_timeout = 10</td>
@ -115,7 +115,7 @@
</tr>
<tr>
<td>servers = localhost:8800</td>
<td>(ListOpt) A comma separated list of BigSwitch or Floodlight servers and port numbers. The plugin proxies the requests to the BigSwitch/Floodlight server, which performs the networking configuration. Only oneserver is needed per deployment, but you may wish todeploy multiple servers to support failover.</td>
<td>(ListOpt) A comma separated list of Big Switch or Floodlight servers and port numbers. The plugin proxies the requests to the Big Switch/Floodlight server, which performs the networking configuration. Only oneserver is needed per deployment, but you may wish todeploy multiple servers to support failover.</td>
</tr>
<tr>
<td>ssl_cert_directory = /etc/neutron/plugins/bigswitch/ssl</td>

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

@ -38,6 +38,10 @@
<td>host = 127.0.0.1</td>
<td>(StrOpt) Host to connect to</td>
</tr>
<tr>
<td>insecure_ssl = False</td>
<td>(BoolOpt) Disable SSL certificate verification</td>
</tr>
<tr>
<td>key_file = None</td>
<td>(StrOpt) Key file</td>

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

@ -20,7 +20,7 @@
</tr>
<tr>
<td>rabbit_ha_queues = False</td>
<td>(BoolOpt) use H/A queues in RabbitMQ (x-ha-policy: all).You need to wipe RabbitMQ database when changing this option.</td>
<td>(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database.</td>
</tr>
<tr>
<td>rabbit_host = localhost</td>
@ -32,11 +32,11 @@
</tr>
<tr>
<td>rabbit_max_retries = 0</td>
<td>(IntOpt) maximum retries with trying to connect to RabbitMQ (the default of 0 implies an infinite retry count)</td>
<td>(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count)</td>
</tr>
<tr>
<td>rabbit_password = guest</td>
<td>(StrOpt) the RabbitMQ password</td>
<td>(StrOpt) The RabbitMQ password</td>
</tr>
<tr>
<td>rabbit_port = 5672</td>
@ -44,23 +44,23 @@
</tr>
<tr>
<td>rabbit_retry_backoff = 2</td>
<td>(IntOpt) how long to backoff for between retries when connecting to RabbitMQ</td>
<td>(IntOpt) How long to backoff for between retries when connecting to RabbitMQ</td>
</tr>
<tr>
<td>rabbit_retry_interval = 1</td>
<td>(IntOpt) how frequently to retry connecting with RabbitMQ</td>
<td>(IntOpt) How frequently to retry connecting with RabbitMQ</td>
</tr>
<tr>
<td>rabbit_use_ssl = False</td>
<td>(BoolOpt) connect over SSL for RabbitMQ</td>
<td>(BoolOpt) Connect over SSL for RabbitMQ</td>
</tr>
<tr>
<td>rabbit_userid = guest</td>
<td>(StrOpt) the RabbitMQ userid</td>
<td>(StrOpt) The RabbitMQ userid</td>
</tr>
<tr>
<td>rabbit_virtual_host = /</td>
<td>(StrOpt) the RabbitMQ virtual host</td>
<td>(StrOpt) The RabbitMQ virtual host</td>
</tr>
</tbody>
</table>

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

@ -75,7 +75,7 @@
</tr>
<tr>
<td>vif_driver = nova.virt.libvirt.vif.LibvirtGenericVIFDriver</td>
<td>(StrOpt) The libvirt VIF driver to configure the VIFs.</td>
<td>(StrOpt) DEPRECATED. The libvirt VIF driver to configure the VIFs.This option is deprecated and will be removed in the Juno release.</td>
</tr>
<tr>
<td>virt_type = kvm</td>

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

@ -23,12 +23,12 @@
<td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).</td>
</tr>
<tr>
<td>default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN</td>
<td>(ListOpt) list of logger=LEVEL pairs</td>
<td>default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN</td>
<td>(ListOpt) List of logger=LEVEL pairs</td>
</tr>
<tr>
<td>fatal_deprecations = False</td>
<td>(BoolOpt) make deprecations fatal</td>
<td>(BoolOpt) Make deprecations fatal</td>
</tr>
<tr>
<td>fatal_exception_format_errors = False</td>
@ -63,28 +63,28 @@
<td>(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.</td>
</tr>
<tr>
<td>logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user)s %(tenant)s] %(instance)s%(message)s</td>
<td>(StrOpt) format string to use for log messages with context</td>
<td>logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s</td>
<td>(StrOpt) Format string to use for log messages with context</td>
</tr>
<tr>
<td>logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d</td>
<td>(StrOpt) data to append to log format when level is DEBUG</td>
<td>(StrOpt) Data to append to log format when level is DEBUG</td>
</tr>
<tr>
<td>logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s</td>
<td>(StrOpt) format string to use for log messages without context</td>
<td>(StrOpt) Format string to use for log messages without context</td>
</tr>
<tr>
<td>logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s</td>
<td>(StrOpt) prefix each line of exception output with this format</td>
<td>(StrOpt) Prefix each line of exception output with this format</td>
</tr>
<tr>
<td>publish_errors = False</td>
<td>(BoolOpt) publish error events</td>
<td>(BoolOpt) Publish error events</td>
</tr>
<tr>
<td>syslog-log-facility = LOG_USER</td>
<td>(StrOpt) syslog facility to receive log lines</td>
<td>(StrOpt) Syslog facility to receive log lines</td>
</tr>
<tr>
<td>use_stderr = True</td>

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

@ -24,7 +24,7 @@
</tr>
<tr>
<td>backdoor_port = None</td>
<td>(StrOpt) Enable eventlet backdoor. Acceptable values are 0, &lt;port&gt; and &lt;start&gt;:&lt;end&gt;, where 0 results in listening on a random tcp port number, &lt;port&gt; results in listening on the specified port number and not enabling backdoorif it 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>
</tr>
<tr>
<td>fake_call = False</td>

1
tools/autogenerate-config-flagmappings/neutron.flagmappings
View File

@ -294,6 +294,7 @@ OFC/cert_file nec
OFC/driver nec
OFC/enable_packet_filter nec
OFC/host nec
OFC/insecure_ssl nec
OFC/key_file nec
OFC/path_prefix nec
OFC/port nec