Skip to content

Commit

Permalink
Provide rootwrap configuration options
Browse files Browse the repository at this point in the history
Our tools now generate tables for the rootwrap.conf files. Include this
tables in the config-reference guide. The cinder-rootwrap.xml file is
not used ATM, because our cinder documentation doesn't provide a config
overview (see bug #1304172).

Revert some help strings for nova to what they are in icehouse (the
previous run of the tool accidentally picked up the juno options).

Change-Id: Id3a76cc5ae29b7cf45118958520126ec8f75853d
  • Loading branch information
Gauvain Pocentek committed Apr 8, 2014
1 parent 97185bc commit b670150
Show file tree
Hide file tree
Showing 8 changed files with 164 additions and 12 deletions.
43 changes: 43 additions & 0 deletions doc/common/tables/cinder-rootwrap.xml
@@ -0,0 +1,43 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all" xml:id="config_table_cinder_rootwrap">
<caption>Description of configuration options for rootwrap</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>filters_path = /etc/cinder/rootwrap.d,/usr/share/cinder/rootwrap</td>
<td>List of directories to load filter definitions from (separated by ','). These directories MUST all be only writeable by root !</td>
</tr>
<tr>
<td>exec_dirs = /sbin,/usr/sbin,/bin,/usr/bin</td>
<td>List of directories to search executables in, in case filters do not explicitely specify a full path (separated by ',') If not specified, defaults to system PATH environment variable. These directories MUST all be only writeable by root !</td>
</tr>
<tr>
<td>use_syslog = False</td>
<td>Enable logging to syslog Default value is False</td>
</tr>
<tr>
<td>syslog_log_facility = syslog</td>
<td>Which syslog facility to use. Valid values include auth, authpriv, syslog, local0, local1... Default value is 'syslog'</td>
</tr>
<tr>
<td>syslog_log_level = ERROR</td>
<td>Which messages to log. INFO means log all usage ERROR means only log unsuccessful attempts</td>
</tr>
</tbody>
</table>
</para>
58 changes: 58 additions & 0 deletions doc/common/tables/neutron-rootwrap.xml
@@ -0,0 +1,58 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all" xml:id="config_table_neutron_rootwrap">
<caption>Description of configuration options for rootwrap</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>filters_path = /etc/neutron/rootwrap.d,/usr/share/neutron/rootwrap,/etc/quantum/rootwrap.d,/usr/share/quantum/rootwrap</td>
<td>List of directories to load filter definitions from (separated by ','). These directories MUST all be only writeable by root !</td>
</tr>
<tr>
<td>exec_dirs = /sbin,/usr/sbin,/bin,/usr/bin</td>
<td>List of directories to search executables in, in case filters do not explicitely specify a full path (separated by ',') If not specified, defaults to system PATH environment variable. These directories MUST all be only writeable by root !</td>
</tr>
<tr>
<td>use_syslog = False</td>
<td>Enable logging to syslog Default value is False</td>
</tr>
<tr>
<td>syslog_log_facility = syslog</td>
<td>Which syslog facility to use. Valid values include auth, authpriv, syslog, local0, local1... Default value is 'syslog'</td>
</tr>
<tr>
<td>syslog_log_level = ERROR</td>
<td>Which messages to log. INFO means log all usage ERROR means only log unsuccessful attempts</td>
</tr>
<tr>
<th colspan="2">[xenapi]</th>
</tr>
<tr>
<td>xenapi_connection_url = &lt;None&gt;</td>
<td>XenAPI configuration is only required by the L2 agent if it is to target a XenServer/XCP compute host's dom0.</td>
</tr>
<tr>
<td>xenapi_connection_username = root</td>
<td>No help text available for this option.</td>
</tr>
<tr>
<td>xenapi_connection_password = &lt;None&gt;</td>
<td>No help text available for this option.</td>
</tr>
</tbody>
</table>
</para>
2 changes: 1 addition & 1 deletion doc/common/tables/nova-libvirt.xml
Expand Up @@ -75,7 +75,7 @@
</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>
<td>(StrOpt) The libvirt VIF driver to configure the VIFs.</td>
</tr>
<tr>
<td>virt_type = kvm</td>
Expand Down
20 changes: 10 additions & 10 deletions doc/common/tables/nova-logging.xml
Expand Up @@ -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, requests.packages.urllib3.connectionpool=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</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>
Expand Down Expand Up @@ -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_identity)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)s %(tenant)s] %(instance)s%(message)s</td>
<td>(StrOpt) format string to use for log messages with context</td>
</tr>
<tr>
<td>logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d</td>
<td>(StrOpt) Data to append to log format when level is DEBUG</td>
<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>
Expand Down
43 changes: 43 additions & 0 deletions doc/common/tables/nova-rootwrap.xml
@@ -0,0 +1,43 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all" xml:id="config_table_nova_rootwrap">
<caption>Description of configuration options for rootwrap</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>filters_path = /etc/nova/rootwrap.d,/usr/share/nova/rootwrap</td>
<td>List of directories to load filter definitions from (separated by ','). These directories MUST all be only writeable by root !</td>
</tr>
<tr>
<td>exec_dirs = /sbin,/usr/sbin,/bin,/usr/bin</td>
<td>List of directories to search executables in, in case filters do not explicitely specify a full path (separated by ',') If not specified, defaults to system PATH environment variable. These directories MUST all be only writeable by root !</td>
</tr>
<tr>
<td>use_syslog = False</td>
<td>Enable logging to syslog Default value is False</td>
</tr>
<tr>
<td>syslog_log_facility = syslog</td>
<td>Which syslog facility to use. Valid values include auth, authpriv, syslog, user0, user1... Default value is 'syslog'</td>
</tr>
<tr>
<td>syslog_log_level = ERROR</td>
<td>Which messages to log. INFO means log all usage ERROR means only log unsuccessful attempts</td>
</tr>
</tbody>
</table>
</para>
2 changes: 1 addition & 1 deletion doc/common/tables/nova-testing.xml
Expand Up @@ -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 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 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>
</tr>
<tr>
<td>fake_call = False</td>
Expand Down
Expand Up @@ -40,6 +40,7 @@
<xi:include href="../../common/tables/nova-quota.xml"/>
<xi:include href="../../common/tables/nova-rdp.xml"/>
<xi:include href="../../common/tables/nova-redis.xml"/>
<xi:include href="../../common/tables/nova-rootwrap.xml"/>
<xi:include href="../../common/tables/nova-rpc_all.xml"/>
<xi:include href="../../common/tables/nova-s3.xml"/>
<xi:include href="../../common/tables/nova-scheduling.xml"/>
Expand Down
Expand Up @@ -80,6 +80,13 @@
<xi:include href="../../common/tables/neutron-quotas.xml"/>
</section>

<section xml:id="networking-options-rootwrap">
<title>Rootwrap</title>
<para>Use the following options in the
<filename>neutron.conf</filename> file for the rootwrap settings</para>
<xi:include href="../../common/tables/neutron-rootwrap.xml"/>
</section>

<section xml:id="networking-options-scheduler">
<title>Scheduler</title>
<para>Use the following options in the
Expand Down

0 comments on commit b670150

Please sign in to comment.