openstack/openstack-manuals
Code Issues Proposed changes

Update flagmappings

Browse Source 
Just a quick run of the autogenerate tool to update the flagmappings and tables for
nova, cinder and neutron

Change-Id: Ic75b54480fc86780577521a7a6faec0335adf400
This commit is contained in:
Tom Fifield 2013-08-12 15:11:10 +00:00
parent d23f7d3124
commit 74fdfefd13
73 changed files with 1151 additions and 653 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
doc/src/docbkx/common/tables/glance-api.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for api</caption>
@ -13,39 +17,59 @@
<tbody>
<tr>
<td>admin_role=admin</td>
<td>(StrOpt)Role used to identify an authenticated user as administrator.</td>
<td>(StrOpt) Role used to identify an authenticated user as administrator.</td>
</tr>
<tr>
<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>
<td>db_auto_create=False</td>
<td>(BoolOpt)A boolean what determines if the database will be automatically created.</td>
<td>(BoolOpt) A boolean that determines if the database will be automatically created.</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>
<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>
</tr>
<tr>
<td>default_publisher_id=$host</td>
<td>(StrOpt) Default publisher_id for outgoing notifications</td>
</tr>
<tr>
<td>enable_v1_api=True</td>
<td>(BoolOpt)Deploy the v1 OpenStack Images API.</td>
<td>(BoolOpt) Deploy the v1 OpenStack Images API. </td>
</tr>
<tr>
<td>enable_v2_api=True</td>
<td>(BoolOpt)Deploy the v2 OpenStack Images API.</td>
<td>(BoolOpt) Deploy the v2 OpenStack Images API. </td>
</tr>
<tr>
<td>image_size_cap=1099511627776</td>
<td>(IntOpt)Maximum size of image a user can upload in bytes. Defaults to 1099511627776 bytes (1 TB).</td>
<td>(IntOpt) Maximum size of image a user can upload in bytes. Defaults to 1099511627776 bytes (1 TB).</td>
</tr>
<tr>
<td>known_stores=['glance.store.filesystem.Store', 'glance.store.http.Store', 'glance.store.rbd.Store', 'glance.store.s3.Store', 'glance.store.swift.Store']</td>
<td>(ListOpt)List of which store classes and store class locations are currently known to glance at startup.</td>
<td>known_stores=glance.store.filesystem.Store,glance.store.http.Store,glance.store.rbd.Store,glance.store.s3.Store,glance.store.swift.Store,glance.store.sheepdog.Store,glance.store.cinder.Store</td>
<td>(ListOpt) List of which store classes and store class locations are currently known to glance at startup.</td>
</tr>
<tr>
<td>notification_driver=[]</td>
<td>(MultiStrOpt) Driver or drivers to handle sending notifications</td>
</tr>
<tr>
<td>owner_is_tenant=True</td>
<td>(BoolOpt)When true, this option sets the owner of an image to be the tenant. Otherwise, the owner of the image will be the authenticated user issuing the request.</td>
<td>(BoolOpt) When true, this option sets the owner of an image to be the tenant. Otherwise, the owner of the image will be the authenticated user issuing the request.</td>
</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>
</tr>
<tr>
<td>show_multiple_locations=False</td>
<td>(BoolOpt) Whether to include the backend image locations in image properties. Revealing storage location can be a security risk, so use this setting with caution! The overrides show_image_direct_url.</td>
</tr>
<tr>
<td>use_user_token=True</td>
<td>(BoolOpt) Whether to pass through the user token when making requests to the registry.</td>
</tr>
</tbody>
</table>

30
doc/src/docbkx/common/tables/glance-common.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for common</caption>
@ -13,47 +17,51 @@
<tbody>
<tr>
<td>allow_additional_image_properties=True</td>
<td>(BoolOpt)Whether to allow users to specify image properties beyond what the image schema provides</td>
<td>(BoolOpt) Whether to allow users to specify image properties beyond what the image schema provides</td>
</tr>
<tr>
<td>api_limit_max=1000</td>
<td>(IntOpt)Maximum permissible number of items that could be returned by a request</td>
<td>(IntOpt) Maximum permissible number of items that could be returned by a request</td>
</tr>
<tr>
<td>backlog=4096</td>
<td>(IntOpt)The backlog value that will be used when creating the TCP listener socket.</td>
<td>(IntOpt) The backlog value that will be used when creating the TCP listener socket.</td>
</tr>
<tr>
<td>bind_host=0.0.0.0</td>
<td>(StrOpt)Address to bind the server. Useful when selecting a particular network interface.</td>
<td>(StrOpt) Address to bind the server. Useful when selecting a particular network interface.</td>
</tr>
<tr>
<td>bind_port=None</td>
<td>(IntOpt)The port on which the server will listen.</td>
<td>(IntOpt) The port on which the server will listen.</td>
</tr>
<tr>
<td>data_api=glance.db.sqlalchemy.api</td>
<td>(StrOpt)Python module path of data access API</td>
<td>(StrOpt) Python module path of data access API</td>
</tr>
<tr>
<td>limit_param_default=25</td>
<td>(IntOpt)Default value for the number of items returned by a request if not specified explicitly in the request</td>
<td>(IntOpt) Default value for the number of items returned by a request if not specified explicitly in the request</td>
</tr>
<tr>
<td>metadata_encryption_key=None</td>
<td>(StrOpt)Key used for encrypting sensitive metadata while talking to the registry or database.</td>
<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>
<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>
</tr>
<tr>
<td>show_image_direct_url=False</td>
<td>(BoolOpt)Whether to include the backend image storage location in image properties. Revealing storage location can be a security risk, so use this setting with caution!</td>
<td>(BoolOpt) Whether to include the backend image storage location in image properties. Revealing storage location can be a security risk, so use this setting with caution!</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>(IntOpt) The number of child process workers that will be created to service API requests.</td>
</tr>
</tbody>
</table>

16
doc/src/docbkx/common/tables/glance-db.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for db</caption>
@ -13,19 +17,23 @@
<tbody>
<tr>
<td>sql_connection=sqlite:///glance.sqlite</td>
<td>(StrOpt)A valid SQLAlchemy connection string for the registry database. Default: %(default)s</td>
<td>(StrOpt) A valid SQLAlchemy connection string for the registry database. Default: %(default)s</td>
</tr>
<tr>
<td>sql_idle_timeout=3600</td>
<td>(IntOpt)Period in seconds after which SQLAlchemy should reestablish its connection to the database.</td>
<td>(IntOpt) Period in seconds after which SQLAlchemy should reestablish its connection to the database.</td>
</tr>
<tr>
<td>sql_max_retries=60</td>
<td>(IntOpt)The number of times to retry a connection to the SQLserver.</td>
<td>(IntOpt) The number of times to retry a connection to the SQLserver.</td>
</tr>
<tr>
<td>sql_retry_interval=1</td>
<td>(IntOpt)The amount of time to wait before attempting to retry the SQL connection.</td>
<td>(IntOpt) The amount of time to wait (in seconds) before attempting to retry the SQL connection.</td>
</tr>
<tr>
<td>sqlalchemy_debug=False</td>
<td>(BoolOpt) Enable debug logging in sqlalchemy which prints every query and result</td>
</tr>
</tbody>
</table>

10
doc/src/docbkx/common/tables/glance-filesystem.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for filesystem</caption>
@ -13,7 +17,11 @@
<tbody>
<tr>
<td>filesystem_store_datadir=None</td>
<td>(StrOpt)Directory to which the Filesystem backend store writes images.</td>
<td>(StrOpt) Directory to which the Filesystem backend store writes images.</td>
</tr>
<tr>
<td>filesystem_store_metadata_file=None</td>
<td>(StrOpt) The path to a file which contains the metadata to be returned with any location associated with this store. The file must contain a valid JSON dict.</td>
</tr>
</tbody>
</table>

24
doc/src/docbkx/common/tables/glance-imagecache.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for imagecache</caption>
@ -13,43 +17,43 @@
<tbody>
<tr>
<td>cleanup_scrubber=False</td>
<td>(BoolOpt)A boolean that determines if the scrubber should clean up the files it uses for taking data. Only one server in your deployment should be designated the cleanup host.</td>
<td>(BoolOpt) A boolean that determines if the scrubber should clean up the files it uses for taking data. Only one server in your deployment should be designated the cleanup host.</td>
</tr>
<tr>
<td>cleanup_scrubber_time=86400</td>
<td>(IntOpt)Items must have a modified time that is older than this value in order to be candidates for cleanup.</td>
<td>(IntOpt) Items must have a modified time that is older than this value in order to be candidates for cleanup.</td>
</tr>
<tr>
<td>delayed_delete=False</td>
<td>(BoolOpt)Turn on/off delayed delete.</td>
<td>(BoolOpt) Turn on/off delayed delete.</td>
</tr>
<tr>
<td>image_cache_dir=None</td>
<td>(StrOpt)Base directory that the Image Cache uses.</td>
<td>(StrOpt) Base directory that the Image Cache uses.</td>
</tr>
<tr>
<td>image_cache_driver=sqlite</td>
<td>(StrOpt)The driver to use for image cache management.</td>
<td>(StrOpt) The driver to use for image cache management.</td>
</tr>
<tr>
<td>image_cache_max_size=10737418240</td>
<td>(IntOpt)The maximum size in bytes that the cache can use.</td>
<td>(IntOpt) The maximum size in bytes that the cache can use.</td>
</tr>
<tr>
<td>image_cache_sqlite_db=cache.db</td>
<td>(StrOpt)The path to the sqlite file database that will be used for image cache management.</td>
<td>(StrOpt) The path to the sqlite file database that will be used for image cache management.</td>
</tr>
<tr>
<td>image_cache_stall_time=86400</td>
<td>(IntOpt)The amount of time to let an image remain in the cache without being accessed</td>
<td>(IntOpt) The amount of time to let an image remain in the cache without being accessed</td>
</tr>
<tr>
<td>scrub_time=0</td>
<td>(IntOpt)The amount of time in seconds to delay before performing a delete.</td>
<td>(IntOpt) The amount of time in seconds to delay before performing a delete.</td>
</tr>
<tr>
<td>scrubber_datadir=/var/lib/glance/scrubber</td>
<td>(StrOpt)Directory that the scrubber will use to track information about what to delete. Make sure this is also set in glance-api.conf</td>
<td>(StrOpt) Directory that the scrubber will use to track information about what to delete. Make sure this is also set in glance-api.conf</td>
</tr>
</tbody>
</table>

62
doc/src/docbkx/common/tables/glance-logging.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for logging</caption>
@ -13,80 +17,84 @@
<tbody>
<tr>
<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>
<td>default_log_levels=amqplib=WARN,sqlalchemy=WARN,boto=WARN,suds=INFO,keystone=INFO,eventlet.wsgi.server=WARN</td>
<td>(ListOpt) list of logger=LEVEL pairs</td>
</tr>
<tr>
<td>default_notification_level=INFO</td>
<td>(StrOpt) Default notification level for outgoing notifications</td>
</tr>
<tr>
<td>fatal_deprecations=False</td>
<td>(BoolOpt)make deprecations fatal</td>
<td>(BoolOpt) make deprecations fatal</td>
</tr>
<tr>
<td>instance_format=[instance: %(uuid)s]</td>
<td>(StrOpt)If an instance is passed with the log message, format it like this</td>
<td>instance_format=[instance: %(uuid)s] </td>
<td>(StrOpt) If an instance is passed with the log message, format it like this</td>
</tr>
<tr>
<td>instance_uuid_format=[instance: %(uuid)s]</td>
<td>(StrOpt)If an instance UUID is passed with the log message, format it like this</td>
<td>instance_uuid_format=[instance: %(uuid)s] </td>
<td>(StrOpt) If an instance UUID is passed with the log message, format it like this</td>
</tr>
<tr>
<td>log_config=None</td>
<td>(StrOpt)If this option is specified, the logging configuration file specified is used and overrides any other logging options specified. Please see the Python logging module documentation for details on logging configuration files.</td>
<td>(StrOpt) If this option is specified, the logging configuration file specified is used and overrides any other logging options specified. Please see the Python logging module documentation for details on logging configuration files.</td>
</tr>
<tr>
<td>log_date_format=%Y-%m-%d %H:%M:%S</td>
<td>(StrOpt)Format string for %%(asctime)s in log records. Default: %(default)s</td>
<td>(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s</td>
</tr>
<tr>
<td>log_dir=None</td>
<td>(StrOpt)(Optional) The directory to keep log files in (will be prepended to --log-file)</td>
<td>(StrOpt) (Optional) The base directory used for relative --log-file paths</td>
</tr>
<tr>
<td>log_file=None</td>
<td>(StrOpt)(Optional) Name of log file to output to. If not set, logging will go to stdout.</td>
<td>(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.</td>
</tr>
<tr>
<td>log_format=%(asctime)s %(levelname)8s [%(name)s] %(message)s</td>
<td>(StrOpt)A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. Default: %(default)s</td>
<td>log_format=None</td>
<td>(StrOpt) 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>logfile_mode=0644</td>
<td>(StrOpt)Default file mode used when creating log files</td>
</tr>
<tr>
<td>logging_context_format_string=%(asctime)s.%(msecs)03d %(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)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>
<td>(BoolOpt)Log output to standard error</td>
<td>(BoolOpt) Log output to standard error</td>
</tr>
<tr>
<td>use_syslog=False</td>
<td>(BoolOpt)Use syslog for logging.</td>
<td>(BoolOpt) Use syslog for logging.</td>
</tr>
<tr>
<td>verbose=False</td>
<td>(BoolOpt)Print more verbose output (set logging level to INFO instead of default WARNING level).</td>
<td>(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).</td>
</tr>
</tbody>
</table>
</para>
</para>

8
doc/src/docbkx/common/tables/glance-paste.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for paste</caption>
@ -13,11 +17,11 @@
<tbody>
<tr>
<td>config_file=None</td>
<td>(StrOpt)Name of the paste configuration file.</td>
<td>(StrOpt) Name of the paste configuration file.</td>
</tr>
<tr>
<td>flavor=None</td>
<td>(StrOpt)Partial name of a pipeline in your paste configuration file with the service name removed. For example, if your paste section name is [pipeline:glance-api-keystone] use the value "keystone"</td>
<td>(StrOpt) Partial name of a pipeline in your paste configuration file with the service name removed. For example, if your paste section name is [pipeline:glance-api-keystone] use the value "keystone"</td>
</tr>
</tbody>
</table>

8
doc/src/docbkx/common/tables/glance-policy.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for policy</caption>
@ -13,11 +17,11 @@
<tbody>
<tr>
<td>policy_default_rule=default</td>
<td>(StrOpt)The default policy to use.</td>
<td>(StrOpt) The default policy to use.</td>
</tr>
<tr>
<td>policy_file=policy.json</td>
<td>(StrOpt)The location of the policy file.</td>
<td>(StrOpt) The location of the policy file.</td>
</tr>
</tbody>
</table>

34
doc/src/docbkx/common/tables/glance-qpid.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for qpid</caption>
@ -13,63 +17,63 @@
<tbody>
<tr>
<td>qpid_heartbeat=60</td>
<td>(IntOpt)Seconds between connection keepalive heartbeats</td>
<td>(IntOpt) Seconds between connection keepalive heartbeats</td>
</tr>
<tr>
<td>qpid_hostname=localhost</td>
<td>(StrOpt)Qpid broker hostname</td>
<td>(StrOpt) Qpid broker hostname</td>
</tr>
<tr>
<td>qpid_notification_exchange=glance</td>
<td>(StrOpt)Qpid exchange for notifications</td>
<td>(StrOpt) Qpid exchange for notifications</td>
</tr>
<tr>
<td>qpid_notification_topic=notifications</td>
<td>(StrOpt)Qpid topic for notifications</td>
<td>(StrOpt) Qpid topic for notifications</td>
</tr>
<tr>
<td>qpid_password=</td>
<td>(StrOpt)Password for qpid connection</td>
<td>(StrOpt) Password for qpid connection</td>
</tr>
<tr>
<td>qpid_port=5672</td>
<td>(StrOpt)Qpid broker port</td>
<td>(StrOpt) Qpid broker port</td>
</tr>
<tr>
<td>qpid_protocol=tcp</td>
<td>(StrOpt)Transport to use, either 'tcp' or 'ssl'</td>
<td>(StrOpt) Transport to use, either 'tcp' or 'ssl'</td>
</tr>
<tr>
<td>qpid_reconnect_interval=0</td>
<td>(IntOpt)Equivalent to setting max and min to the same value</td>
<td>(IntOpt) Equivalent to setting max and min to the same value</td>
</tr>
<tr>
<td>qpid_reconnect_interval_max=0</td>
<td>(IntOpt)Maximum seconds between reconnection attempts</td>
<td>(IntOpt) Maximum seconds between reconnection attempts</td>
</tr>
<tr>
<td>qpid_reconnect_interval_min=0</td>
<td>(IntOpt)Minimum seconds between reconnection attempts</td>
<td>(IntOpt) Minimum seconds between reconnection attempts</td>
</tr>
<tr>
<td>qpid_reconnect_limit=0</td>
<td>(IntOpt)Max reconnections before giving up</td>
<td>(IntOpt) Max reconnections before giving up</td>
</tr>
<tr>
<td>qpid_reconnect_timeout=0</td>
<td>(IntOpt)Reconnection timeout in seconds</td>
<td>(IntOpt) Reconnection timeout in seconds</td>
</tr>
<tr>
<td>qpid_sasl_mechanisms=</td>
<td>(StrOpt)Space separated list of SASL mechanisms to use for auth</td>
<td>(StrOpt) Space separated list of SASL mechanisms to use for auth</td>
</tr>
<tr>
<td>qpid_tcp_nodelay=True</td>
<td>(BoolOpt)Disable Nagle algorithm</td>
<td>(BoolOpt) Disable Nagle algorithm</td>
</tr>
<tr>
<td>qpid_username=</td>
<td>(StrOpt)Username for qpid connection</td>
<td>(StrOpt) Username for qpid connection</td>
</tr>
</tbody>
</table>

28
doc/src/docbkx/common/tables/glance-rabbitmq.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for rabbitmq</caption>
@ -13,51 +17,51 @@
<tbody>
<tr>
<td>rabbit_durable_queues=False</td>
<td>(BoolOpt)A boolean to determine if the queues used for messaging should be retained after a restart.</td>
<td>(BoolOpt) A boolean to determine if the queues used for messaging should be retained after a restart.</td>
</tr>
<tr>
<td>rabbit_host=localhost</td>
<td>(StrOpt)The host name of the rabbitmq server</td>
<td>(StrOpt) The host name of the rabbitmq server</td>
</tr>
<tr>
<td>rabbit_max_retries=0</td>
<td>(IntOpt)The maximum number of times to attempt to connect to the AMQP server.</td>
<td>(IntOpt) The maximum number of times to attempt to connect to the AMQP server.</td>
</tr>
<tr>
<td>rabbit_notification_exchange=glance</td>
<td>(StrOpt)Exchange name to use for connection when using rabbit strategy.</td>
<td>(StrOpt) Exchange name to use for connection when using rabbit strategy.</td>
</tr>
<tr>
<td>rabbit_notification_topic=notifications</td>
<td>(StrOpt)Topic to use for connection when using rabbit strategy.</td>
<td>(StrOpt) Topic to use for connection when using rabbit strategy.</td>
</tr>
<tr>
<td>rabbit_password=guest</td>
<td>(StrOpt)The password that will be used for authentication with the rabbitmq server.</td>
<td>(StrOpt) The password that will be used for authentication with the rabbitmq server.</td>
</tr>
<tr>
<td>rabbit_port=5672</td>
<td>(IntOpt)The port on which the rabbitmq server is listening</td>
<td>(IntOpt) The port on which the rabbitmq server is listening</td>
</tr>
<tr>
<td>rabbit_retry_backoff=2</td>
<td>(StrOpt)This value multiplied by the number of connection attempts gives the amount of time in seconds to sleep between connection attempts to the AMQP server.</td>
<td>(IntOpt) This value multiplied by the number of connection attempts gives the amount of time in seconds to sleep between connection attempts to the AMQP server.</td>
</tr>
<tr>
<td>rabbit_retry_max_backoff=30</td>
<td>(StrOpt)The maximum amount of time to wait between connection attempts. The delay time will be the smaller of this value and the value of &lt;rabbit_retry_backoff&gt; * &lt;the number of failed connection attempts so far&gt;.</td>
<td>(IntOpt) The maximum amount of time to wait between connection attempts. The delay time will be the smaller of this value and the value of &lt;rabbit_retry_backoff&gt; * &lt;the number of failed connection attempts so far&gt;.</td>
</tr>
<tr>
<td>rabbit_use_ssl=False</td>
<td>(BoolOpt)A boolean value indicating if the selected rabbitmq server uses SSL.</td>
<td>(BoolOpt) A boolean value indicating if the selected rabbitmq server uses SSL.</td>
</tr>
<tr>
<td>rabbit_userid=guest</td>
<td>(StrOpt)The user ID for authentication with rabbitmq.</td>
<td>(StrOpt) The user ID for authentication with rabbitmq.</td>
</tr>
<tr>
<td>rabbit_virtual_host=/</td>
<td>(StrOpt)The virtual host used in the rabbitmq connection.</td>
<td>(StrOpt) The virtual host used in the rabbitmq connection.</td>
</tr>
</tbody>
</table>

12
doc/src/docbkx/common/tables/glance-rbd.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for rbd</caption>
@ -13,19 +17,19 @@
<tbody>
<tr>
<td>rbd_store_ceph_conf=</td>
<td>(StrOpt)Ceph configuration file path.</td>
<td>(StrOpt) Ceph configuration file path.</td>
</tr>
<tr>
<td>rbd_store_chunk_size=4</td>
<td>(IntOpt)Images will be chunked into objects of this size (in megabytes). For best performance, this should be a power of two.</td>
<td>(IntOpt) Images will be chunked into objects of this size (in megabytes). For best performance, this should be a power of two.</td>
</tr>
<tr>
<td>rbd_store_pool=rbd</td>
<td>(StrOpt)RADOS pool in which images are stored.</td>
<td>(StrOpt) RADOS pool in which images are stored.</td>
</tr>
<tr>
<td>rbd_store_user=None</td>
<td>(StrOpt)RADOS user to authenticate as (only applicable if using cephx)</td>
<td>(StrOpt) RADOS user to authenticate as (only applicable if using cephx.)</td>
</tr>
</tbody>
</table>

32
doc/src/docbkx/common/tables/glance-registry.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for registry</caption>
@ -13,59 +17,59 @@
<tbody>
<tr>
<td>admin_password=None</td>
<td>(StrOpt)The administrators password.</td>
<td>(StrOpt) The administrators password.</td>
</tr>
<tr>
<td>admin_tenant_name=None</td>
<td>(StrOpt)The tenant name of the adminstrative user.</td>
<td>(StrOpt) The tenant name of the adminstrative user.</td>
</tr>
<tr>
<td>admin_user=None</td>
<td>(StrOpt)The administrators user name.</td>
<td>(StrOpt) The administrators user name.</td>
</tr>
<tr>
<td>auth_region=None</td>
<td>(StrOpt)The region for the authentication service.</td>
<td>(StrOpt) The region for the authentication service.</td>
</tr>
<tr>
<td>auth_strategy=noauth</td>
<td>(StrOpt)The strategy to use for authentication.</td>
<td>(StrOpt) The strategy to use for authentication.</td>
</tr>
<tr>
<td>auth_url=None</td>
<td>(StrOpt)The URL to the keystone service.</td>
<td>(StrOpt) The URL to the keystone service.</td>
</tr>
<tr>
<td>registry_client_ca_file=None</td>
<td>(StrOpt)The path to the certifying authority cert file to use in SSL connections to the registry server.</td>
<td>(StrOpt) The path to the certifying authority cert file to use in SSL connections to the registry server.</td>
</tr>
<tr>
<td>registry_client_cert_file=None</td>
<td>(StrOpt)The path to the cert file to use in SSL connections to the registry server.</td>
<td>(StrOpt) The path to the cert file to use in SSL connections to the registry server.</td>
</tr>
<tr>
<td>registry_client_insecure=False</td>
<td>(BoolOpt)When using SSL in connections to the registry server, do not require validation via a certifying authority.</td>
<td>(BoolOpt) When using SSL in connections to the registry server, do not require validation via a certifying authority.</td>
</tr>
<tr>
<td>registry_client_key_file=None</td>
<td>(StrOpt)The path to the key file to use in SSL connections to the registry server.</td>
<td>(StrOpt) The path to the key file to use in SSL connections to the registry server.</td>
</tr>
<tr>
<td>registry_client_protocol=http</td>
<td>(StrOpt)The protocol to use for communication with the registry server. Either http or https.</td>
<td>(StrOpt) The protocol to use for communication with the registry server. Either http or https.</td>
</tr>
<tr>
<td>registry_client_timeout=600</td>
<td>(IntOpt)The period of time, in seconds, that the API server will wait for a registry request to complete. A value of 0 implies no timeout.</td>
<td>(IntOpt) The period of time, in seconds, that the API server will wait for a registry request to complete. A value of 0 implies no timeout.</td>
</tr>
<tr>
<td>registry_host=0.0.0.0</td>
<td>(StrOpt)Address to find the registry server.</td>
<td>(StrOpt) Address to find the registry server.</td>
</tr>
<tr>
<td>registry_port=9191</td>
<td>(IntOpt)Port the registry server is listening on.</td>
<td>(IntOpt) Port the registry server is listening on.</td>
</tr>
</tbody>
</table>

18
doc/src/docbkx/common/tables/glance-s3.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for s3</caption>
@ -13,31 +17,31 @@
<tbody>
<tr>
<td>s3_store_access_key=None</td>
<td>(StrOpt)The S3 query token access key.</td>
<td>(StrOpt) The S3 query token access key.</td>
</tr>
<tr>
<td>s3_store_bucket=None</td>
<td>(StrOpt)The S3 bucket to be used to store the Glance data.</td>
<td>(StrOpt) The S3 bucket to be used to store the Glance data.</td>
</tr>
<tr>
<td>s3_store_bucket_url_format=subdomain</td>
<td>(StrOpt)The S3 calling format used to determine the bucket. Either subdomain or path can be used.</td>
<td>(StrOpt) The S3 calling format used to determine the bucket. Either subdomain or path can be used.</td>
</tr>
<tr>
<td>s3_store_create_bucket_on_put=False</td>
<td>(BoolOpt)A boolean to determine if the S3 bucket should be created on upload if it does not exist or if an error should be returned to the user.</td>
<td>(BoolOpt) A boolean to determine if the S3 bucket should be created on upload if it does not exist or if an error should be returned to the user.</td>
</tr>
<tr>
<td>s3_store_host=None</td>
<td>(StrOpt)The host where the S3 server is listening.</td>
<td>(StrOpt) The host where the S3 server is listening.</td>
</tr>
<tr>
<td>s3_store_object_buffer_dir=None</td>
<td>(StrOpt)The local directory where uploads will be staged before they are transfered into S3.</td>
<td>(StrOpt) The local directory where uploads will be staged before they are transfered into S3.</td>
</tr>
<tr>
<td>s3_store_secret_key=None</td>
<td>(StrOpt)The S3 query token secret key.</td>
<td>(StrOpt) The S3 query token secret key.</td>
</tr>
</tbody>
</table>

10
doc/src/docbkx/common/tables/glance-ssl.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for ssl</caption>
@ -13,15 +17,15 @@
<tbody>
<tr>
<td>ca_file=None</td>
<td>(StrOpt)CA certificate file to use to verify connecting clients.</td>
<td>(StrOpt) CA certificate file to use to verify connecting clients.</td>
</tr>
<tr>
<td>cert_file=None</td>
<td>(StrOpt)Certificate file to use when starting API server securely.</td>
<td>(StrOpt) Certificate file to use when starting API server securely.</td>
</tr>
<tr>
<td>key_file=None</td>
<td>(StrOpt)Private key file to use when starting API server securely.</td>
<td>(StrOpt) Private key file to use when starting API server securely.</td>
</tr>
</tbody>
</table>

38
doc/src/docbkx/common/tables/glance-swift.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for swift</caption>
@ -13,59 +17,63 @@
<tbody>
<tr>
<td>swift_enable_snet=False</td>
<td>(BoolOpt)Whether to use ServiceNET to communicate with the Swift storage servers.</td>
<td>(BoolOpt) Whether to use ServiceNET to communicate with the Swift storage servers.</td>
</tr>
<tr>
<td>swift_store_admin_tenants=[]</td>
<td>(ListOpt)A list of tenants that will be granted read/write access on all Swift containers created by Glance in multi-tenant mode.</td>
<td>swift_store_admin_tenants=</td>
<td>(ListOpt) A list of tenants that will be granted read/write access on all Swift containers created by Glance in multi-tenant mode.</td>
</tr>
<tr>
<td>swift_store_auth_address=None</td>
<td>(StrOpt)The address where the Swift authentication service is listening.</td>
<td>(StrOpt) The address where the Swift authentication service is listening.</td>
</tr>
<tr>
<td>swift_store_auth_insecure=False</td>
<td>(BoolOpt) If True, swiftclient won't check for a valid SSL certificate when authenticating.</td>
</tr>
<tr>
<td>swift_store_auth_version=2</td>
<td>(StrOpt)Version of the authentication service to use. Valid versions are 2 for keystone and 1 for swauth and rackspace</td>
<td>(StrOpt) Version of the authentication service to use. Valid versions are 2 for keystone and 1 for swauth and rackspace</td>
</tr>
<tr>
<td>swift_store_container=glance</td>
<td>(StrOpt)Container within the account that the account should use for storing images in Swift.</td>
<td>(StrOpt) Container within the account that the account should use for storing images in Swift.</td>
</tr>
<tr>
<td>swift_store_create_container_on_put=False</td>
<td>(BoolOpt)A boolean value that determines if we create the container if it does not exist.</td>
<td>(BoolOpt) A boolean value that determines if we create the container if it does not exist.</td>
</tr>
<tr>
<td>swift_store_endpoint_type=publicURL</td>
<td>(StrOpt)A string giving the endpoint type of the swift service to use (publicURL, adminURL or internalURL). This setting is only used if swift_store_auth_version is 2.</td>
<td>(StrOpt) A string giving the endpoint type of the swift service to use (publicURL, adminURL or internalURL). This setting is only used if swift_store_auth_version is 2.</td>
</tr>
<tr>
<td>swift_store_key=None</td>
<td>(StrOpt)Auth key for the user authenticating against the Swift authentication service.</td>
<td>(StrOpt) Auth key for the user authenticating against the Swift authentication service.</td>
</tr>
<tr>
<td>swift_store_large_object_chunk_size=200</td>
<td>(IntOpt)The amount of data written to a temporary disk buffer during the process of chunking the image file.</td>
<td>(IntOpt) The amount of data written to a temporary disk buffer during the process of chunking the image file.</td>
</tr>
<tr>
<td>swift_store_large_object_size=5120</td>
<td>(IntOpt)The size, in MB, that Glance will start chunking image files and do a large object manifest in Swift</td>
<td>(IntOpt) The size, in MB, that Glance will start chunking image files and do a large object manifest in Swift</td>
</tr>
<tr>
<td>swift_store_multi_tenant=False</td>
<td>(BoolOpt)If set to True enables multi-tenant storage mode which causes Glance images to be stored in tenant specific Swift accounts.</td>
<td>(BoolOpt) If set to True, enables multi-tenant storage mode which causes Glance images to be stored in tenant specific Swift accounts.</td>
</tr>
<tr>
<td>swift_store_region=None</td>
<td>(StrOpt)The region of the swift endpoint to be used for single tenant. This setting is only necessary if the tenant has multiple swift endpoints.</td>
<td>(StrOpt) The region of the swift endpoint to be used for single tenant. This setting is only necessary if the tenant has multiple swift endpoints.</td>
</tr>
<tr>
<td>swift_store_service_type=object-store</td>
<td>(StrOpt)A string giving the service type of the swift service to use. This setting is only used if swift_store_auth_version is ``2``.</td>
<td>(StrOpt) A string giving the service type of the swift service to use. This setting is only used if swift_store_auth_version is 2.</td>
</tr>
<tr>
<td>swift_store_user=None</td>
<td>(StrOpt)The user to authenticate against the Swift authentication service</td>
<td>(StrOpt) The user to authenticate against the Swift authentication service</td>
</tr>
</tbody>
</table>

8
doc/src/docbkx/common/tables/glance-testing.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for testing</caption>
@ -13,11 +17,11 @@
<tbody>
<tr>
<td>pydev_worker_debug_host=None</td>
<td>(StrOpt)The hostname/IP of the pydev process listening for debug connections</td>
<td>(StrOpt) The hostname/IP of the pydev process listening for debug connections</td>
</tr>
<tr>
<td>pydev_worker_debug_port=5678</td>
<td>(IntOpt)The port on which a pydev process is listening for connections.</td>
<td>(IntOpt) The port on which a pydev process is listening for connections.</td>
</tr>
</tbody>
</table>

14
doc/src/docbkx/common/tables/glance-wsgi.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for wsgi</caption>
@ -11,9 +15,17 @@
</tr>
</thead>
<tbody>
<tr>
<td>backdoor_port=None</td>
<td>(IntOpt) port for eventlet backdoor to listen</td>
</tr>
<tr>
<td>eventlet_hub=poll</td>
<td>(StrOpt) Name of eventlet hub to use. Traditionally, we have only supported 'poll', however 'selects' may be appropriate for some platforms. See http://eventlet.net/doc/hubs.html for more details.</td>
</tr>
<tr>
<td>tcp_keepidle=600</td>
<td>(IntOpt)The value for the socket option TCP_KEEPIDLE. This isthe time in seconds that the connection must be idle before TCP starts sending keepalive probes.</td>
<td>(IntOpt) The value for the socket option TCP_KEEPIDLE. This isthe time in seconds that the connection must be idle before TCP starts sending keepalive probes.</td>
</tr>
</tbody>
</table>

10
doc/src/docbkx/common/tables/neutron-agent.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for agent</caption>
@ -13,15 +17,15 @@
<tbody>
<tr>
<td>agent_down_time=5</td>
<td>(IntOpt)Seconds to regard the agent is down.</td>
<td>(IntOpt) Seconds to regard the agent is down.</td>
</tr>
<tr>
<td>external_pids=$state_path/external/pids</td>
<td>(StrOpt)Location to store child pid files</td>
<td>(StrOpt) Location to store child pid files</td>
</tr>
<tr>
<td>report_interval=4</td>
<td>(IntOpt)Seconds between nodes reporting state to server</td>
<td>(IntOpt) Seconds between nodes reporting state to server</td>
</tr>
</tbody>
</table>

28
doc/src/docbkx/common/tables/neutron-api.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for api</caption>
@ -13,31 +17,39 @@
<tbody>
<tr>
<td>allow_bulk=True</td>
<td>(BoolOpt)Allow the usage of the bulk API</td>
<td>(BoolOpt) Allow the usage of the bulk API</td>
</tr>
<tr>
<td>allow_pagination=False</td>
<td>(BoolOpt)Allow the usage of the pagination</td>
<td>(BoolOpt) Allow the usage of the pagination</td>
</tr>
<tr>
<td>allow_sorting=False</td>
<td>(BoolOpt)Allow the usage of the sorting</td>
<td>(BoolOpt) Allow the usage of the sorting</td>
</tr>
<tr>
<td>api_extensions_path=</td>
<td>(StrOpt)The path for API extensions</td>
<td>(StrOpt) The path for API extensions</td>
</tr>
<tr>
<td>api_paste_config=api-paste.ini</td>
<td>(StrOpt)The API paste config file to use</td>
<td>(StrOpt) The API paste config file to use</td>
</tr>
<tr>
<td>pagination_max_limit=-1</td>
<td>(StrOpt)The maximum number of items returned in a single response, value was 'infinite' or negative integer means no limit</td>
<td>(StrOpt) The maximum number of items returned in a single response, value was 'infinite' or negative integer means no limit</td>
</tr>
<tr>
<td>service_plugins=[]</td>
<td>(ListOpt)The service plugins Quantum will use</td>
<td>run_external_periodic_tasks=True</td>
<td>(BoolOpt) Some periodic tasks can be run in a separate process. Should we run them here?</td>
</tr>
<tr>
<td>service_plugins=</td>
<td>(ListOpt) The service plugins Neutron will use</td>
</tr>
<tr>
<td>service_provider=[]</td>
<td>(MultiStrOpt) Defines providers for advanced services using the format: &lt;service_type&gt;:&lt;name&gt;:&lt;driver&gt;[:default]</td>
</tr>
</tbody>
</table>

74
doc/src/docbkx/common/tables/neutron-bigswitch.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for bigswitch</caption>
@ -13,32 +17,84 @@
<tbody>
<tr>
<td>add_meta_server_route=True</td>
<td>(BoolOpt)Flag to decide if a route to the metadata server should be injected into the VM</td>
<td>(BoolOpt) Flag to decide if a route to the metadata server should be injected into the VM</td>
</tr>
<tr>
<td>neutron_id=Neutron-usagi</td>
<td>(StrOpt)User defined identifier for this Neutron deployment</td>
<td>max_router_rules=200</td>
<td>(IntOpt) Maximum number of router rules</td>
</tr>
<tr>
<td>neutron_id=neutron-docwork</td>
<td>(StrOpt) User defined identifier for this Neutron deployment</td>
</tr>
<tr>
<td>node_override_vif_802.1qbg=</td>
<td>(ListOpt) Nova compute nodes to manually set VIF type to 802.1qbg</td>
</tr>
<tr>
<td>node_override_vif_802.1qbh=</td>
<td>(ListOpt) Nova compute nodes to manually set VIF type to 802.1qbh</td>
</tr>
<tr>
<td>node_override_vif_binding_failed=</td>
<td>(ListOpt) Nova compute nodes to manually set VIF type to binding_failed</td>
</tr>
<tr>
<td>node_override_vif_bridge=</td>
<td>(ListOpt) Nova compute nodes to manually set VIF type to bridge</td>
</tr>
<tr>
<td>node_override_vif_hyperv=</td>
<td>(ListOpt) Nova compute nodes to manually set VIF type to hyperv</td>
</tr>
<tr>
<td>node_override_vif_ivs=</td>
<td>(ListOpt) Nova compute nodes to manually set VIF type to ivs</td>
</tr>
<tr>
<td>node_override_vif_other=</td>
<td>(ListOpt) Nova compute nodes to manually set VIF type to other</td>
</tr>
<tr>
<td>node_override_vif_ovs=</td>
<td>(ListOpt) Nova compute nodes to manually set VIF type to ovs</td>
</tr>
<tr>
<td>node_override_vif_unbound=</td>
<td>(ListOpt) Nova compute nodes to manually set VIF type to unbound</td>
</tr>
<tr>
<td>server_auth=username:password</td>
<td>(StrOpt)Server authentication</td>
<td>(StrOpt) The username and password for authenticating against the BigSwitch or Floodlight controller.</td>
</tr>
<tr>
<td>server_ssl=False</td>
<td>(BoolOpt)Use SSL to connect</td>
<td>(BoolOpt) If True, Use SSL when connecting to the BigSwitch or Floodlight controller.</td>
</tr>
<tr>
<td>server_timeout=10</td>
<td>(IntOpt)Maximum number of seconds to wait for proxy request to connect and complete.</td>
<td>(IntOpt) Maximum number of seconds to wait for proxy request to connect and complete.</td>
</tr>
<tr>
<td>servers=localhost:8800</td>
<td>(StrOpt)A comma separated list of servers and port numbers to proxy request to.</td>
<td>(StrOpt) 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. Note that only one server is needed per deployment, but you may wish to deploy multiple servers to support failover.</td>
</tr>
<tr>
<td>sync_data=False</td>
<td>(BoolOpt)Sync data on connect</td>
<td>(BoolOpt) Sync data on connect</td>
</tr>
<tr>
<td>tenant_default_router_rule=['*:any:any:permit']</td>
<td>(MultiStrOpt) The default router rules installed in new tenant routers. Repeat the config option for each rule. Format is &lt;tenant&gt;:&lt;source&gt;:&lt;destination&gt;:&lt;action&gt; Use an * to specify default for all tenants.</td>
</tr>
<tr>
<td>vif_type=ovs</td>
<td>(StrOpt) Virtual interface type to configure on Nova compute nodes</td>
</tr>
<tr>
<td>vif_types=unbound,binding_failed,ovs,ivs,bridge,802.1qbg,802.1qbh,hyperv,other</td>
<td>(ListOpt) List of allowed vif_type values.</td>
</tr>
</tbody>
</table>
</para>
</para>

36
doc/src/docbkx/common/tables/neutron-brocade.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for brocade</caption>
@ -13,43 +17,43 @@
<tbody>
<tr>
<td>address=</td>
<td>(StrOpt)No help text available for this option</td>
<td>(StrOpt) No help text available for this option</td>
</tr>
<tr>
<td>ostype=NOS</td>
<td>(StrOpt)No help text available for this option</td>
<td>(StrOpt) No help text available for this option</td>
</tr>
<tr>
<td>password=None</td>
<td>(StrOpt)Password for Redis server. (optional)</td>
</tr>
<tr>
<td>password=</td>
<td>(StrOpt)No help text available for this option</td>
<td>(StrOpt) Password for Redis server. (optional)</td>
</tr>
<tr>
<td>password=passw0rd</td>
<td>(StrOpt)MidoNet admin password.</td>
<td>(StrOpt) MidoNet admin password.</td>
</tr>
<tr>
<td>password=</td>
<td>(StrOpt) No help text available for this option</td>
</tr>
<tr>
<td>password=password</td>
<td>(StrOpt)PLUMgrid NOS admin password</td>
<td>(StrOpt) PLUMgrid Director admin password</td>
</tr>
<tr>
<td>physical_interface=eth0</td>
<td>(StrOpt)No help text available for this option</td>
</tr>
<tr>
<td>username=</td>
<td>(StrOpt)No help text available for this option</td>
<td>(StrOpt) No help text available for this option</td>
</tr>
<tr>
<td>username=admin</td>
<td>(StrOpt)MidoNet admin username.</td>
<td>(StrOpt) MidoNet admin username.</td>
</tr>
<tr>
<td>username=</td>
<td>(StrOpt) No help text available for this option</td>
</tr>
<tr>
<td>username=username</td>
<td>(StrOpt)PLUMgrid NOS admin username</td>
<td>(StrOpt) PLUMgrid Director admin username</td>
</tr>
</tbody>
</table>

66
doc/src/docbkx/common/tables/neutron-cisco.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for cisco</caption>
@ -12,65 +16,53 @@
</thead>
<tbody>
<tr>
<td>host=usagi</td>
<td>(StrOpt)The hostname Neutron is running on</td>
<td>host=docwork</td>
<td>(StrOpt) The hostname Neutron is running on</td>
</tr>
<tr>
<td>host=127.0.0.1</td>
<td>(StrOpt)Host to locate redis</td>
</tr>
<tr>
<td>host=None</td>
<td>(StrOpt)Cisco test host option.</td>
<td>(StrOpt) Host to locate redis</td>
</tr>
<tr>
<td>host=127.0.0.1</td>
<td>(StrOpt)Host to connect to</td>
</tr>
<tr>
<td>manager_class=neutron.plugins.cisco.segmentation.l2network_vlan_mgr_v2.L2NetworkVLANMgr</td>
<td>(StrOpt)Manager Class</td>
</tr>
<tr>
<td>max_networks=65568</td>
<td>(StrOpt)Maximum Network value</td>
</tr>
<tr>
<td>max_port_profiles=65568</td>
<td>(StrOpt)Maximum Port Profile value</td>
</tr>
<tr>
<td>max_ports=100</td>
<td>(StrOpt)Maximum Port value</td>
<td>(StrOpt) Host to connect to</td>
</tr>
<tr>
<td>model_class=neutron.plugins.cisco.models.virt_phy_sw_v2.VirtualPhysicalSwitchModelV2</td>
<td>(StrOpt)Model Class</td>
<td>(StrOpt) Model Class</td>
</tr>
<tr>
<td>nexus_driver=neutron.plugins.cisco.tests.unit.v2.nexus.fake_nexus_driver.CiscoNEXUSFakeDriver</td>
<td>(StrOpt)Nexus Driver Name</td>
<td>nexus_driver=neutron.plugins.cisco.test.nexus.fake_nexus_driver.CiscoNEXUSFakeDriver</td>
<td>(StrOpt) Nexus Driver Name</td>
</tr>
<tr>
<td>nexus_plugin=neutron.plugins.cisco.nexus.cisco_nexus_plugin_v2.NexusPlugin</td>
<td>(StrOpt)Nexus Switch to use</td>
<td>(StrOpt) Nexus Switch to use</td>
</tr>
<tr>
<td>vlan_end=3000</td>
<td>(StrOpt)VLAN end value</td>
<td>provider_vlan_auto_create=True</td>
<td>(BoolOpt) Provider VLANs are automatically created as needed on the Nexus switch</td>
</tr>
<tr>
<td>provider_vlan_auto_trunk=True</td>
<td>(BoolOpt) Provider VLANs are automatically trunked as needed on the ports of the Nexus switch</td>
</tr>
<tr>
<td>provider_vlan_name_prefix=p-</td>
<td>(StrOpt) VLAN Name prefix for provider vlans</td>
</tr>
<tr>
<td>svi_round_robin=False</td>
<td>(BoolOpt) Distribute SVI interfaces over all switches</td>
</tr>
<tr>
<td>vlan_name_prefix=q-</td>
<td>(StrOpt)VLAN Name prefix</td>
</tr>
<tr>
<td>vlan_start=100</td>
<td>(StrOpt)VLAN start value</td>
<td>(StrOpt) VLAN Name prefix</td>
</tr>
<tr>
<td>vswitch_plugin=neutron.plugins.openvswitch.ovs_neutron_plugin.OVSNeutronPluginV2</td>
<td>(StrOpt)Virtual Switch to use</td>
<td>(StrOpt) Virtual Switch to use</td>
</tr>
</tbody>
</table>
</para>
</para>

92
doc/src/docbkx/common/tables/neutron-common.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for common</caption>
@ -13,136 +17,140 @@
<tbody>
<tr>
<td>admin_password=None</td>
<td>(StrOpt)Admin password</td>
<td>(StrOpt) Admin password</td>
</tr>
<tr>
<td>admin_tenant_name=None</td>
<td>(StrOpt)Admin tenant name</td>
<td>(StrOpt) Admin tenant name</td>
</tr>
<tr>
<td>admin_user=None</td>
<td>(StrOpt)Admin user</td>
<td>(StrOpt) Admin user</td>
</tr>
<tr>
<td>allowed_rpc_exception_modules=['neutron.openstack.common.exception', 'nova.exception', 'cinder.exception', 'exceptions']</td>
<td>(ListOpt)Modules of exceptions that are permitted to be recreatedupon receiving exception data from an rpc call.</td>
<td>allowed_rpc_exception_modules=neutron.openstack.common.exception,nova.exception,cinder.exception,exceptions</td>
<td>(ListOpt) Modules of exceptions that are permitted to be recreatedupon receiving exception data from an rpc call.</td>
</tr>
<tr>
<td>auth_region=None</td>
<td>(StrOpt)Authentication region</td>
<td>(StrOpt) Authentication region</td>
</tr>
<tr>
<td>auth_strategy=keystone</td>
<td>(StrOpt)The type of authentication to use</td>
<td>(StrOpt) The type of authentication to use</td>
</tr>
<tr>
<td>auth_strategy=keystone</td>
<td>(StrOpt)The type of authentication to use</td>
<td>(StrOpt) The type of authentication to use</td>
</tr>
<tr>
<td>auth_url=None</td>
<td>(StrOpt)Authentication URL</td>
<td>(StrOpt) Authentication URL</td>
</tr>
<tr>
<td>base_mac=fa:16:3e:00:00:00</td>
<td>(StrOpt)The base MAC address Neutron will use for VIFs</td>
<td>(StrOpt) The base MAC address Neutron will use for VIFs</td>
</tr>
<tr>
<td>bind_host=0.0.0.0</td>
<td>(StrOpt)The host IP to bind to</td>
<td>(StrOpt) The host IP to bind to</td>
</tr>
<tr>
<td>bind_port=9696</td>
<td>(IntOpt)The port to bind to</td>
<td>(IntOpt) The port to bind to</td>
</tr>
<tr>
<td>core_plugin=None</td>
<td>(StrOpt)The core plugin Neutron will use</td>
<td>(StrOpt) The core plugin Neutron will use</td>
</tr>
<tr>
<td>dhcp_agent_notification=True</td>
<td>(BoolOpt)Allow sending resource operation notification to DHCP agent</td>
<td>(BoolOpt) Allow sending resource operation notification to DHCP agent</td>
</tr>
<tr>
<td>dhcp_lease_duration=120</td>
<td>(IntOpt)DHCP lease duration</td>
<td>(IntOpt) DHCP lease duration</td>
</tr>
<tr>
<td>disable_process_locking=False</td>
<td>(BoolOpt)Whether to disable inter-process locks</td>
<td>(BoolOpt) Whether to disable inter-process locks</td>
</tr>
<tr>
<td>force_gateway_on_subnet=False</td>
<td>(BoolOpt)Ensure that configured gateway is on subnet</td>
<td>(BoolOpt) Ensure that configured gateway is on subnet</td>
</tr>
<tr>
<td>host=usagi</td>
<td>(StrOpt)The hostname Neutron is running on</td>
<td>host=docwork</td>
<td>(StrOpt) The hostname Neutron is running on</td>
</tr>
<tr>
<td>host=127.0.0.1</td>
<td>(StrOpt)Host to locate redis</td>
</tr>
<tr>
<td>host=None</td>
<td>(StrOpt)Cisco test host option.</td>
<td>(StrOpt) Host to locate redis</td>
</tr>
<tr>
<td>host=127.0.0.1</td>
<td>(StrOpt)Host to connect to</td>
<td>(StrOpt) Host to connect to</td>
</tr>
<tr>
<td>lock_path=None</td>
<td>(StrOpt)Directory to use for lock files. Default to a temp directory</td>
<td>(StrOpt) Directory to use for lock files. Default to a temp directory</td>
</tr>
<tr>
<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>
<td>max_dns_nameservers=5</td>
<td>(IntOpt)Maximum number of DNS nameservers</td>
<td>(IntOpt) Maximum number of DNS nameservers</td>
</tr>
<tr>
<td>max_fixed_ips_per_port=5</td>
<td>(IntOpt)Maximum number of fixed ips per port</td>
<td>(IntOpt) Maximum number of fixed ips per port</td>
</tr>
<tr>
<td>max_subnet_host_routes=20</td>
<td>(IntOpt)Maximum number of host routes per subnet</td>
<td>(IntOpt) Maximum number of host routes per subnet</td>
</tr>
<tr>
<td>network_vlan_ranges=[]</td>
<td>(ListOpt)List of &lt;physical_network&gt;:&lt;vlan_min&gt;:&lt;vlan_max&gt; or &lt;physical_network&gt;</td>
<td>network_vlan_ranges=</td>
<td>(ListOpt) List of &lt;physical_network&gt;:&lt;vlan_min&gt;:&lt;vlan_max&gt; or &lt;physical_network&gt;</td>
</tr>
<tr>
<td>network_vlan_ranges=[]</td>
<td>(ListOpt)List of &lt;physical_network&gt;:&lt;vlan_min&gt;:&lt;vlan_max&gt; or &lt;physical_network&gt;</td>
<td>network_vlan_ranges=</td>
<td>(ListOpt) List of &lt;physical_network&gt;:&lt;vlan_min&gt;:&lt;vlan_max&gt; or &lt;physical_network&gt;</td>
</tr>
<tr>
<td>network_vlan_ranges=[]</td>
<td>(ListOpt)List of &lt;physical_network&gt;:&lt;vlan_min&gt;:&lt;vlan_max&gt; or &lt;physical_network&gt;</td>
<td>network_vlan_ranges=d,,,e,,,f,,,a,,,u,,,l,,,t,,,:,,,1,,,:,,,1,,,0,,,0,,,0</td>
<td>(ListOpt) List of &lt;physical_network&gt;:&lt;vlan_min&gt;:&lt;vlan_max&gt; or &lt;physical_network&gt;</td>
</tr>
<tr>
<td>network_vlan_ranges=</td>
<td>(ListOpt) List of &lt;physical_network&gt;:&lt;vlan_min&gt;:&lt;vlan_max&gt; or &lt;physical_network&gt;</td>
</tr>
<tr>
<td>network_vlan_ranges=</td>
<td>(ListOpt) List of &lt;physical_network&gt;:&lt;vlan_min&gt;:&lt;vlan_max&gt; or &lt;physical_network&gt; specifying physical_network names usable for VLAN provider and tenant networks, as well as ranges of VLAN tags on each available for allocation to tenant networks.</td>
</tr>
<tr>
<td>periodic_fuzzy_delay=5</td>
<td>(IntOpt)range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0)</td>
<td>(IntOpt) range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0)</td>
</tr>
<tr>
<td>periodic_interval=40</td>
<td>(IntOpt)Seconds between running periodic tasks</td>
<td>(IntOpt) Seconds between running periodic tasks</td>
</tr>
<tr>
<td>root_helper=sudo</td>
<td>(StrOpt)Root helper application.</td>
<td>(StrOpt) Root helper application.</td>
</tr>
<tr>
<td>root_helper=sudo</td>
<td>(StrOpt)Root helper application.</td>
<td>(StrOpt) Root helper application.</td>
</tr>
<tr>
<td>state_path=/var/lib/neutron</td>
<td>(StrOpt)No help text available for this option</td>
<td>(StrOpt) Where to store Neutron state files. This directory must be writable by the agent.</td>
</tr>
</tbody>
</table>
</para>
</para>

68
doc/src/docbkx/common/tables/neutron-db.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for db</caption>
@ -12,44 +16,68 @@
</thead>
<tbody>
<tr>
<td>description=</td>
<td>(StrOpt)Textual description for the default service type</td>
<td>backend=sqlalchemy</td>
<td>(StrOpt) The backend to use for db</td>
</tr>
<tr>
<td>reconnect_interval=2</td>
<td>(IntOpt)Database reconnection interval in seconds</td>
<td>connection=sqlite://</td>
<td>(StrOpt) The SQLAlchemy connection string used to connect to the database</td>
</tr>
<tr>
<td>service_definition=None</td>
<td>(MultiStrOpt)Defines a provider for an advanced service using the format: &lt;service&gt;:&lt;plugin&gt;[:&lt;driver&gt;]</td>
<td>connection_debug=0</td>
<td>(IntOpt) Verbosity of SQL debugging information. 0=None, 100=Everything</td>
</tr>
<tr>
<td>sql_connection=None</td>
<td>(StrOpt)The SQLAlchemy connection string used to connect to the database</td>
<td>connection_trace=False</td>
<td>(BoolOpt) Add python stack traces to SQL as comment strings</td>
</tr>
<tr>
<td>sql_dbpool_enable=False</td>
<td>(BoolOpt)Enable the use of eventlet's db_pool for MySQL</td>
<td>dhcp_agents_per_network=1</td>
<td>(IntOpt) Number of DHCP agents scheduled to host a network.</td>
</tr>
<tr>
<td>sql_idle_timeout=3600</td>
<td>(IntOpt)Timeout in seconds before idle sql connections are reaped</td>
<td>idle_timeout=3600</td>
<td>(IntOpt) timeout before idle sql connections are reaped</td>
</tr>
<tr>
<td>sql_max_pool_size=5</td>
<td>(IntOpt)Maximum number of SQL connections to keep open in a pool</td>
<td>max_overflow=20</td>
<td>(IntOpt) If set, use this value for max_overflow with sqlalchemy</td>
</tr>
<tr>
<td>sql_max_retries=-1</td>
<td>(IntOpt)Database reconnection retry times</td>
<td>max_pool_size=10</td>
<td>(IntOpt) Maximum number of SQL connections to keep open in a pool</td>
</tr>
<tr>
<td>sql_min_pool_size=1</td>
<td>(IntOpt)Minimum number of SQL connections to keep open in a pool</td>
<td>max_retries=10</td>
<td>(IntOpt) maximum db connection retries during startup. (setting -1 implies an infinite retry count)</td>
</tr>
<tr>
<td>sqlalchemy_pool_size=5</td>
<td>(IntOpt)Maximum number of SQL connections to keep open in a QueuePool in SQLAlchemy</td>
<td>min_pool_size=1</td>
<td>(IntOpt) Minimum number of SQL connections to keep open in a pool</td>
</tr>
<tr>
<td>pool_timeout=10</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>
</tr>
<tr>
<td>slave_connection=</td>
<td>(StrOpt) The SQLAlchemy connection string used to connect to the slave database</td>
</tr>
<tr>
<td>sqlite_db=</td>
<td>(StrOpt) the filename to use with sqlite</td>
</tr>
<tr>
<td>sqlite_synchronous=True</td>
<td>(BoolOpt) If true, use synchronous mode for sqlite</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>

42
doc/src/docbkx/common/tables/neutron-hyperv.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for hyperv</caption>
@ -13,39 +17,51 @@
<tbody>
<tr>
<td>local_network_vswitch=private</td>
<td>(StrOpt)Private vswitch name used for local networks</td>
<td>(StrOpt) Private vswitch name used for local networks</td>
</tr>
<tr>
<td>network_vlan_ranges=[]</td>
<td>(ListOpt)List of &lt;physical_network&gt;:&lt;vlan_min&gt;:&lt;vlan_max&gt; or &lt;physical_network&gt;</td>
<td>network_vlan_ranges=</td>
<td>(ListOpt) List of &lt;physical_network&gt;:&lt;vlan_min&gt;:&lt;vlan_max&gt; or &lt;physical_network&gt;</td>
</tr>
<tr>
<td>network_vlan_ranges=[]</td>
<td>(ListOpt)List of &lt;physical_network&gt;:&lt;vlan_min&gt;:&lt;vlan_max&gt; or &lt;physical_network&gt;</td>
<td>network_vlan_ranges=</td>
<td>(ListOpt) List of &lt;physical_network&gt;:&lt;vlan_min&gt;:&lt;vlan_max&gt; or &lt;physical_network&gt;</td>
</tr>
<tr>
<td>network_vlan_ranges=[]</td>
<td>(ListOpt)List of &lt;physical_network&gt;:&lt;vlan_min&gt;:&lt;vlan_max&gt; or &lt;physical_network&gt;</td>
<td>network_vlan_ranges=default:1:1000</td>
<td>(ListOpt) List of &lt;physical_network&gt;:&lt;vlan_min&gt;:&lt;vlan_max&gt; or &lt;physical_network&gt;</td>
</tr>
<tr>
<td>physical_network_vswitch_mappings=[]</td>
<td>(ListOpt)List of &lt;physical_network&gt;:&lt;vswitch&gt; where the physical networks can be expressed with wildcards, e.g.: ."*:external"</td>
<td>network_vlan_ranges=</td>
<td>(ListOpt) List of &lt;physical_network&gt;:&lt;vlan_min&gt;:&lt;vlan_max&gt; or &lt;physical_network&gt;</td>
</tr>
<tr>
<td>network_vlan_ranges=</td>
<td>(ListOpt) List of &lt;physical_network&gt;:&lt;vlan_min&gt;:&lt;vlan_max&gt; or &lt;physical_network&gt; specifying physical_network names usable for VLAN provider and tenant networks, as well as ranges of VLAN tags on each available for allocation to tenant networks.</td>
</tr>
<tr>
<td>physical_network_vswitch_mappings=</td>
<td>(ListOpt) List of &lt;physical_network&gt;:&lt;vswitch&gt; where the physical networks can be expressed with wildcards, e.g.: ."*:external"</td>
</tr>
<tr>
<td>polling_interval=2</td>
<td>(IntOpt)The number of seconds the agent will wait between polling for local device changes.</td>
<td>(IntOpt) The number of seconds the agent will wait between polling for local device changes.</td>
</tr>
<tr>
<td>tenant_network_type=local</td>
<td>(StrOpt)Network type for tenant networks (local, vlan, or none)</td>
<td>(StrOpt) Network type for tenant networks (local, flat, vlan or none)</td>
</tr>
<tr>
<td>tenant_network_type=local</td>
<td>(StrOpt)Network type for tenant networks (local, flat, vlan or none)</td>
<td>(StrOpt) Network type for tenant networks (local, vlan, or none)</td>
</tr>
<tr>
<td>tenant_network_type=vlan</td>
<td>(StrOpt) Network type for tenant networks (local, ib, vlan, or none)</td>
</tr>
<tr>
<td>tenant_network_type=local</td>
<td>(StrOpt)Network type for tenant networks (local, vlan, gre, or none)</td>
<td>(StrOpt) Network type for tenant networks (local, vlan, gre, vxlan, or none)</td>
</tr>
</tbody>
</table>

12
doc/src/docbkx/common/tables/neutron-kombu.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for kombu</caption>
@ -13,19 +17,19 @@
<tbody>
<tr>
<td>kombu_ssl_ca_certs=</td>
<td>(StrOpt)SSL certification authority file (valid only if SSL enabled)</td>
<td>(StrOpt) SSL certification authority file (valid only if SSL enabled)</td>
</tr>
<tr>
<td>kombu_ssl_certfile=</td>
<td>(StrOpt)SSL cert file (valid only if SSL enabled)</td>
<td>(StrOpt) SSL cert file (valid only if SSL enabled)</td>
</tr>
<tr>
<td>kombu_ssl_keyfile=</td>
<td>(StrOpt)SSL key file (valid only if SSL enabled)</td>
<td>(StrOpt) SSL key file (valid only if SSL enabled)</td>
</tr>
<tr>
<td>kombu_ssl_version=</td>
<td>(StrOpt)SSL version to use (valid only if SSL enabled)</td>
<td>(StrOpt) SSL version to use (valid only if SSL enabled)</td>
</tr>
</tbody>
</table>

22
doc/src/docbkx/common/tables/neutron-linuxbridge.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for linuxbridge</caption>
@ -12,20 +16,28 @@
</thead>
<tbody>
<tr>
<td>physical_interface_mappings=[]</td>
<td>(ListOpt)List of &lt;physical_network&gt;:&lt;physical_interface&gt;</td>
<td>physical_interface_mappings=</td>
<td>(ListOpt) List of &lt;physical_network&gt;:&lt;physical_interface&gt;</td>
</tr>
<tr>
<td>physical_interface_mappings=</td>
<td>(ListOpt) List of &lt;physical_network&gt;:&lt;physical_interface&gt;</td>
</tr>
<tr>
<td>tenant_network_type=local</td>
<td>(StrOpt)Network type for tenant networks (local, vlan, or none)</td>
<td>(StrOpt) Network type for tenant networks (local, flat, vlan or none)</td>
</tr>
<tr>
<td>tenant_network_type=local</td>
<td>(StrOpt)Network type for tenant networks (local, flat, vlan or none)</td>
<td>(StrOpt) Network type for tenant networks (local, vlan, or none)</td>
</tr>
<tr>
<td>tenant_network_type=vlan</td>
<td>(StrOpt) Network type for tenant networks (local, ib, vlan, or none)</td>
</tr>
<tr>
<td>tenant_network_type=local</td>
<td>(StrOpt)Network type for tenant networks (local, vlan, gre, or none)</td>
<td>(StrOpt) Network type for tenant networks (local, vlan, gre, vxlan, or none)</td>
</tr>
</tbody>
</table>

56
doc/src/docbkx/common/tables/neutron-logging.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for logging</caption>
@ -13,84 +17,80 @@
<tbody>
<tr>
<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>
<td>default_log_levels=amqplib=WARN,sqlalchemy=WARN,boto=WARN,suds=INFO,keystone=INFO,eventlet.wsgi.server=WARN</td>
<td>(ListOpt)list of logger=LEVEL pairs</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>instance_format=[instance: %(uuid)s]</td>
<td>(StrOpt)If an instance is passed with the log message, format it like this</td>
<td>instance_format=[instance: %(uuid)s] </td>
<td>(StrOpt) If an instance is passed with the log message, format it like this</td>
</tr>
<tr>
<td>instance_uuid_format=[instance: %(uuid)s]</td>
<td>(StrOpt)If an instance UUID is passed with the log message, format it like this</td>
<td>instance_uuid_format=[instance: %(uuid)s] </td>
<td>(StrOpt) If an instance UUID is passed with the log message, format it like this</td>
</tr>
<tr>
<td>log_config=None</td>
<td>(StrOpt)If this option is specified, the logging configuration file specified is used and overrides any other logging options specified. Please see the Python logging module documentation for details on logging configuration files.</td>
<td>(StrOpt) If this option is specified, the logging configuration file specified is used and overrides any other logging options specified. Please see the Python logging module documentation for details on logging configuration files.</td>
</tr>
<tr>
<td>log_date_format=%Y-%m-%d %H:%M:%S</td>
<td>(StrOpt)Format string for %%(asctime)s in log records. Default: %(default)s</td>
<td>(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s</td>
</tr>
<tr>
<td>log_dir=None</td>
<td>(StrOpt)(Optional) The base directory used for relative --log-file paths</td>
<td>(StrOpt) (Optional) The base directory used for relative --log-file paths</td>
</tr>
<tr>
<td>log_file=None</td>
<td>(StrOpt)(Optional) Name of log file to output to. If no default is set, logging will go to stdout.</td>
<td>(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.</td>
</tr>
<tr>
<td>log_format=%(asctime)s %(levelname)8s [%(name)s] %(message)s</td>
<td>(StrOpt)A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. Default: %(default)s</td>
<td>log_format=None</td>
<td>(StrOpt) 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>logfile_mode=0644</td>
<td>(StrOpt)Default file mode used when creating log files</td>
</tr>
<tr>
<td>logging_context_format_string=%(asctime)s.%(msecs)03d %(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)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>
<td>(BoolOpt)Log output to standard error</td>
<td>(BoolOpt) Log output to standard error</td>
</tr>
<tr>
<td>use_syslog=False</td>
<td>(BoolOpt)Use syslog for logging.</td>
<td>(BoolOpt) Use syslog for logging.</td>
</tr>
<tr>
<td>verbose=False</td>
<td>(BoolOpt)Print more verbose output (set logging level to INFO instead of default WARNING level).</td>
<td>(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).</td>
</tr>
</tbody>
</table>
</para>
</para>

16
doc/src/docbkx/common/tables/neutron-meta.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for meta</caption>
@ -13,27 +17,27 @@
<tbody>
<tr>
<td>default_flavor=</td>
<td>(StrOpt)Default flavor to use</td>
<td>(StrOpt) Default flavor to use</td>
</tr>
<tr>
<td>default_l3_flavor=</td>
<td>(StrOpt)Default L3 flavor to use</td>
<td>(StrOpt) Default L3 flavor to use</td>
</tr>
<tr>
<td>extension_map=</td>
<td>(StrOpt)A list of extensions, per plugin, to load.</td>
<td>(StrOpt) A list of extensions, per plugin, to load.</td>
</tr>
<tr>
<td>l3_plugin_list=</td>
<td>(StrOpt)List of L3 plugins to load</td>
<td>(StrOpt) List of L3 plugins to load</td>
</tr>
<tr>
<td>plugin_list=</td>
<td>(StrOpt)List of plugins to load</td>
<td>(StrOpt) List of plugins to load</td>
</tr>
<tr>
<td>supported_extension_aliases=</td>
<td>(StrOpt)Supported extension aliases</td>
<td>(StrOpt) Supported extension aliases</td>
</tr>
</tbody>
</table>

12
doc/src/docbkx/common/tables/neutron-metadata.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for metadata</caption>
@ -13,19 +17,19 @@
<tbody>
<tr>
<td>auth_strategy=keystone</td>
<td>(StrOpt)The type of authentication to use</td>
<td>(StrOpt) The type of authentication to use</td>
</tr>
<tr>
<td>auth_strategy=keystone</td>
<td>(StrOpt)The type of authentication to use</td>
<td>(StrOpt) The type of authentication to use</td>
</tr>
<tr>
<td>metadata_proxy_socket=$state_path/metadata_proxy</td>
<td>(StrOpt)Location of Metadata Proxy UNIX domain socket</td>
<td>(StrOpt) Location of Metadata Proxy UNIX domain socket</td>
</tr>
<tr>
<td>metadata_router_id=None</td>
<td>(StrOpt)Virtual metadata router ID.</td>
<td>(StrOpt) Virtual metadata router ID.</td>
</tr>
</tbody>
</table>

38
doc/src/docbkx/common/tables/neutron-midonet.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for midonet</caption>
@ -13,47 +17,47 @@
<tbody>
<tr>
<td>midonet_uri=http://localhost:8080/midonet-api</td>
<td>(StrOpt)MidoNet API server URI.</td>
<td>(StrOpt) MidoNet API server URI.</td>
</tr>
<tr>
<td>mode=dev</td>
<td>(StrOpt)Operational mode. Internal dev use only.</td>
<td>(StrOpt) Operational mode. Internal dev use only.</td>
</tr>
<tr>
<td>password=None</td>
<td>(StrOpt)Password for Redis server. (optional)</td>
</tr>
<tr>
<td>password=</td>
<td>(StrOpt)No help text available for this option</td>
<td>(StrOpt) Password for Redis server. (optional)</td>
</tr>
<tr>
<td>password=passw0rd</td>
<td>(StrOpt)MidoNet admin password.</td>
<td>(StrOpt) MidoNet admin password.</td>
</tr>
<tr>
<td>password=</td>
<td>(StrOpt) No help text available for this option</td>
</tr>
<tr>
<td>password=password</td>
<td>(StrOpt)PLUMgrid NOS admin password</td>
<td>(StrOpt) PLUMgrid Director admin password</td>
</tr>
<tr>
<td>project_id=77777777-7777-7777-7777-777777777777</td>
<td>(StrOpt)ID of the project that MidoNet admin userbelongs to.</td>
<td>(StrOpt) ID of the project that MidoNet admin userbelongs to.</td>
</tr>
<tr>
<td>provider_router_id=None</td>
<td>(StrOpt)Virtual provider router ID.</td>
</tr>
<tr>
<td>username=</td>
<td>(StrOpt)No help text available for this option</td>
<td>(StrOpt) Virtual provider router ID.</td>
</tr>
<tr>
<td>username=admin</td>
<td>(StrOpt)MidoNet admin username.</td>
<td>(StrOpt) MidoNet admin username.</td>
</tr>
<tr>
<td>username=</td>
<td>(StrOpt) No help text available for this option</td>
</tr>
<tr>
<td>username=username</td>
<td>(StrOpt)PLUMgrid NOS admin username</td>
<td>(StrOpt) PLUMgrid Director admin username</td>
</tr>
</tbody>
</table>

4
doc/src/docbkx/common/tables/neutron-ml2.xml
View File

@ -35,6 +35,10 @@
<td>type_drivers=local,flat,vlan,gre,vxlan</td>
<td>(ListOpt) List of network type driver entrypoints to be loaded from the neutron.ml2.type_drivers namespace.</td>
</tr>
<tr>
<td>vni_ranges=</td>
<td>(ListOpt) Comma-separated list of &lt;vni_min&gt;:&lt;vni_max&gt; tuples enumerating ranges of VXLAN VNI IDs that are available for tenant network allocation</td>
</tr>
</tbody>
</table>
</para>

30
doc/src/docbkx/common/tables/neutron-nec.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for nec</caption>
@ -13,47 +17,43 @@
<tbody>
<tr>
<td>cert_file=None</td>
<td>(StrOpt)Certificate file</td>
<td>(StrOpt) Certificate file</td>
</tr>
<tr>
<td>driver=trema</td>
<td>(StrOpt)Driver to use</td>
<td>(StrOpt) Driver to use</td>
</tr>
<tr>
<td>enable_packet_filter=True</td>
<td>(BoolOpt)Enable packet filter</td>
<td>(BoolOpt) Enable packet filter</td>
</tr>
<tr>
<td>host=usagi</td>
<td>(StrOpt)The hostname Quantum is running on</td>
<td>host=docwork</td>
<td>(StrOpt) The hostname Neutron is running on</td>
</tr>
<tr>
<td>host=127.0.0.1</td>
<td>(StrOpt)Host to locate redis</td>
</tr>
<tr>
<td>host=None</td>
<td>(StrOpt)Cisco test host option.</td>
<td>(StrOpt) Host to locate redis</td>
</tr>
<tr>
<td>host=127.0.0.1</td>
<td>(StrOpt)Host to connect to</td>
<td>(StrOpt) Host to connect to</td>
</tr>
<tr>
<td>port=6379</td>
<td>(IntOpt)Use this port to connect to redis host.</td>
<td>(IntOpt) Use this port to connect to redis host.</td>
</tr>
<tr>
<td>port=8888</td>
<td>(StrOpt)Port to connect to</td>
<td>(StrOpt) Port to connect to</td>
</tr>
<tr>
<td>use_ssl=False</td>
<td>(BoolOpt)Enable SSL on the API server</td>
<td>(BoolOpt) Enable SSL on the API server</td>
</tr>
<tr>
<td>use_ssl=False</td>
<td>(BoolOpt)Use SSL to connect</td>
<td>(BoolOpt) Use SSL to connect</td>
</tr>
</tbody>
</table>

70
doc/src/docbkx/common/tables/neutron-nicira.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for nicira</caption>
@ -13,31 +17,75 @@
<tbody>
<tr>
<td>concurrent_connections=5</td>
<td>(IntOpt)Maximum concurrent connections</td>
<td>(IntOpt) Maximum concurrent connections</td>
</tr>
<tr>
<td>default_cluster_name=None</td>
<td>(StrOpt)Default cluster name</td>
<td>default_interface_name=breth0</td>
<td>(StrOpt) Name of the interface on a L2 Gateway transport nodewhich should be used by default when setting up a network connection</td>
</tr>
<tr>
<td>default_l2_gw_service_uuid=None</td>
<td>(StrOpt) Unique identifier of the NVP L2 Gateway service which will be used by default for network gateways</td>
</tr>
<tr>
<td>default_l3_gw_service_uuid=None</td>
<td>(StrOpt) Unique identifier of the NVP L3 Gateway service which will be used for implementing routers and floating IPs</td>
</tr>
<tr>
<td>default_transport_type=stt</td>
<td>(StrOpt) The default network tranport type to use (stt, gre, bridge, ipsec_gre, or ipsec_stt)</td>
</tr>
<tr>
<td>default_tz_uuid=None</td>
<td>(StrOpt) This is uuid of the default NVP Transport zone that will be used for creating tunneled isolated "Neutron" networks. It needs to be created in NVP before starting Neutron with the nvp plugin.</td>
</tr>
<tr>
<td>enable_metadata_access_network=True</td>
<td>(BoolOpt) Enables dedicated connection to the metadata proxy for metadata server access via Neutron router</td>
</tr>
<tr>
<td>http_timeout=10</td>
<td>(IntOpt) Time before aborting a request</td>
</tr>
<tr>
<td>max_lp_per_bridged_ls=64</td>
<td>(IntOpt)Maximum number of ports of a logical switch on a bridged transport zone (default 64)</td>
<td>(IntOpt) Maximum number of ports of a logical switch on a bridged transport zone (default 64)</td>
</tr>
<tr>
<td>max_lp_per_overlay_ls=256</td>
<td>(IntOpt)Maximum number of ports of a logical switch on an overlay transport zone (default 64)</td>
</tr>
<tr>
<td>metadata_dhcp_host_route=False</td>
<td>(BoolOpt)No help text available for this option</td>
<td>(IntOpt) Maximum number of ports of a logical switch on an overlay transport zone (default 64)</td>
</tr>
<tr>
<td>metadata_mode=access_network</td>
<td>(StrOpt)If set to access_network this enables a dedicated connection to the metadata proxy for metadata server access via Quantum router. If set to dhcp_host_route this enables host route injection via the dhcp agent. This option is only useful if running on a host that does not support namespaces otherwise access_network should be used.</td>
<td>(StrOpt) If set to access_network this enables a dedicated connection to the metadata proxy for metadata server access via Neutron router. If set to dhcp_host_route this enables host route injection via the dhcp agent. This option is only useful if running on a host that does not support namespaces otherwise access_network should be used.</td>
</tr>
<tr>
<td>nvp_cluster_uuid=None</td>
<td>(StrOpt) Optional paramter identifying the UUID of the cluster in NVP. This can be retrieved from NVP management console "admin" section.</td>
</tr>
<tr>
<td>nvp_controllers=None</td>
<td>(ListOpt) Lists the NVP controllers in this cluster</td>
</tr>
<tr>
<td>nvp_gen_timeout=-1</td>
<td>(IntOpt)Number of seconds a generation id should be valid for (default -1 meaning do not time out)</td>
<td>(IntOpt) Number of seconds a generation id should be valid for (default -1 meaning do not time out)</td>
</tr>
<tr>
<td>nvp_password=admin</td>
<td>(StrOpt) Password for NVP controllers in this cluster</td>
</tr>
<tr>
<td>nvp_user=admin</td>
<td>(StrOpt) User name for NVP controllers in this cluster</td>
</tr>
<tr>
<td>redirects=2</td>
<td>(IntOpt) Number of times a redirect should be followed</td>
</tr>
<tr>
<td>retries=2</td>
<td>(IntOpt) Number of time a request should be retried</td>
</tr>
</tbody>
</table>

14
doc/src/docbkx/common/tables/neutron-notifier.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for notifier</caption>
@ -13,19 +17,19 @@
<tbody>
<tr>
<td>default_notification_level=INFO</td>
<td>(StrOpt)Default notification level for outgoing notifications</td>
<td>(StrOpt) Default notification level for outgoing notifications</td>
</tr>
<tr>
<td>default_publisher_id=$host</td>
<td>(StrOpt)Default publisher_id for outgoing notifications</td>
<td>(StrOpt) Default publisher_id for outgoing notifications</td>
</tr>
<tr>
<td>notification_driver=[]</td>
<td>(MultiStrOpt)Driver or drivers to handle sending notifications</td>
<td>(MultiStrOpt) Driver or drivers to handle sending notifications</td>
</tr>
<tr>
<td>notification_topics=['notifications']</td>
<td>(ListOpt)AMQP topic used for openstack notifications</td>
<td>notification_topics=notifications</td>
<td>(ListOpt) AMQP topic used for openstack notifications</td>
</tr>
</tbody>
</table>

70
doc/src/docbkx/common/tables/neutron-openvswitch.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for openvswitch</caption>
@ -12,60 +16,88 @@
</thead>
<tbody>
<tr>
<td>bridge_mappings=[]</td>
<td>(ListOpt)List of &lt;physical_network&gt;:&lt;bridge&gt;</td>
<td>bridge_mappings=</td>
<td>(ListOpt) List of &lt;physical_network&gt;:&lt;bridge&gt;</td>
</tr>
<tr>
<td>enable_tunneling=False</td>
<td>(BoolOpt)Enable tunneling support</td>
<td>(BoolOpt) Enable tunneling support</td>
</tr>
<tr>
<td>int_peer_patch_port=patch-tun</td>
<td>(StrOpt)Peer patch port in integration bridge for tunnel bridge</td>
<td>(StrOpt) Peer patch port in integration bridge for tunnel bridge</td>
</tr>
<tr>
<td>integration_bridge=br-int</td>
<td>(StrOpt)Integration bridge to use</td>
<td>(StrOpt) Integration bridge to use</td>
</tr>
<tr>
<td>local_ip=</td>
<td>(StrOpt)Local IP address of GRE tunnel endpoints.</td>
<td>(StrOpt) Local IP address of GRE tunnel endpoints.</td>
</tr>
<tr>
<td>network_vlan_ranges=[]</td>
<td>(ListOpt)List of &lt;physical_network&gt;:&lt;vlan_min&gt;:&lt;vlan_max&gt; or &lt;physical_network&gt;</td>
<td>network_vlan_ranges=</td>
<td>(ListOpt) List of &lt;physical_network&gt;:&lt;vlan_min&gt;:&lt;vlan_max&gt; or &lt;physical_network&gt;</td>
</tr>
<tr>
<td>network_vlan_ranges=[]</td>
<td>(ListOpt)List of &lt;physical_network&gt;:&lt;vlan_min&gt;:&lt;vlan_max&gt; or &lt;physical_network&gt;</td>
<td>network_vlan_ranges=</td>
<td>(ListOpt) List of &lt;physical_network&gt;:&lt;vlan_min&gt;:&lt;vlan_max&gt; or &lt;physical_network&gt;</td>
</tr>
<tr>
<td>network_vlan_ranges=[]</td>
<td>(ListOpt)List of &lt;physical_network&gt;:&lt;vlan_min&gt;:&lt;vlan_max&gt; or &lt;physical_network&gt;</td>
<td>network_vlan_ranges=d,e,f,a,u,l,t,:,1,:,1,0,0,0</td>
<td>(ListOpt) List of &lt;physical_network&gt;:&lt;vlan_min&gt;:&lt;vlan_max&gt; or &lt;physical_network&gt;</td>
</tr>
<tr>
<td>network_vlan_ranges=</td>
<td>(ListOpt) List of &lt;physical_network&gt;:&lt;vlan_min&gt;:&lt;vlan_max&gt; or &lt;physical_network&gt;</td>
</tr>
<tr>
<td>network_vlan_ranges=</td>
<td>(ListOpt) List of &lt;physical_network&gt;:&lt;vlan_min&gt;:&lt;vlan_max&gt; or &lt;physical_network&gt; specifying physical_network names usable for VLAN provider and tenant networks, as well as ranges of VLAN tags on each available for allocation to tenant networks.</td>
</tr>
<tr>
<td>tenant_network_type=local</td>
<td>(StrOpt)Network type for tenant networks (local, vlan, or none)</td>
<td>(StrOpt) Network type for tenant networks (local, flat, vlan or none)</td>
</tr>
<tr>
<td>tenant_network_type=local</td>
<td>(StrOpt)Network type for tenant networks (local, flat, vlan or none)</td>
<td>(StrOpt) Network type for tenant networks (local, vlan, or none)</td>
</tr>
<tr>
<td>tenant_network_type=vlan</td>
<td>(StrOpt) Network type for tenant networks (local, ib, vlan, or none)</td>
</tr>
<tr>
<td>tenant_network_type=local</td>
<td>(StrOpt)Network type for tenant networks (local, vlan, gre, or none)</td>
<td>(StrOpt) Network type for tenant networks (local, vlan, gre, vxlan, or none)</td>
</tr>
<tr>
<td>tun_peer_patch_port=patch-int</td>
<td>(StrOpt)Peer patch port in tunnel bridge for integration bridge</td>
<td>(StrOpt) Peer patch port in tunnel bridge for integration bridge</td>
</tr>
<tr>
<td>tunnel_bridge=br-tun</td>
<td>(StrOpt)Tunnel bridge to use</td>
<td>(StrOpt) Tunnel bridge to use</td>
</tr>
<tr>
<td>tunnel_id_ranges=[]</td>
<td>(ListOpt)List of &lt;tun_min&gt;:&lt;tun_max&gt;</td>
<td>tunnel_id_ranges=</td>
<td>(ListOpt) List of &lt;tun_min&gt;:&lt;tun_max&gt;</td>
</tr>
<tr>
<td>tunnel_id_ranges=</td>
<td>(ListOpt) Comma-separated list of &lt;tun_min&gt;:&lt;tun_max&gt; tuples enumerating ranges of GRE tunnel IDs that are available for tenant network allocation</td>
</tr>
<tr>
<td>tunnel_type=</td>
<td>(StrOpt) The type of tunnels to use when utilizing tunnels, either 'gre' or 'vxlan'</td>
</tr>
<tr>
<td>tunnel_types=</td>
<td>(ListOpt) Network types supported by the agent (gre and/or vxlan)</td>
</tr>
<tr>
<td>veth_mtu=None</td>
<td>(IntOpt) MTU size of veth interfaces</td>
</tr>
</tbody>
</table>

44
doc/src/docbkx/common/tables/neutron-plumgrid.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for plumgrid</caption>
@ -12,48 +16,44 @@
</thead>
<tbody>
<tr>
<td>nos_server=localhost</td>
<td>(StrOpt)PLUMgrid NOS server to connect to</td>
<td>director_server=localhost</td>
<td>(StrOpt) PLUMgrid Director server to connect to</td>
</tr>
<tr>
<td>nos_server_port=8080</td>
<td>(StrOpt)PLUMgrid NOS server port to connect to</td>
<td>director_server_port=8080</td>
<td>(StrOpt) PLUMgrid Director server port to connect to</td>
</tr>
<tr>
<td>password=None</td>
<td>(StrOpt)Password for Redis server. (optional)</td>
</tr>
<tr>
<td>password=</td>
<td>(StrOpt)No help text available for this option</td>
<td>(StrOpt) Password for Redis server. (optional)</td>
</tr>
<tr>
<td>password=passw0rd</td>
<td>(StrOpt)MidoNet admin password.</td>
<td>(StrOpt) MidoNet admin password.</td>
</tr>
<tr>
<td>password=</td>
<td>(StrOpt) No help text available for this option</td>
</tr>
<tr>
<td>password=password</td>
<td>(StrOpt)PLUMgrid NOS admin password</td>
<td>(StrOpt) PLUMgrid Director admin password</td>
</tr>
<tr>
<td>servertimeout=5</td>
<td>(IntOpt)PLUMgrid NOS server timeout</td>
</tr>
<tr>
<td>topologyname=t1</td>
<td>(IntOpt)PLUMgrid NOS topology name</td>
</tr>
<tr>
<td>username=</td>
<td>(StrOpt)No help text available for this option</td>
<td>(IntOpt) PLUMgrid Director server timeout</td>
</tr>
<tr>
<td>username=admin</td>
<td>(StrOpt)MidoNet admin username.</td>
<td>(StrOpt) MidoNet admin username.</td>
</tr>
<tr>
<td>username=</td>
<td>(StrOpt) No help text available for this option</td>
</tr>
<tr>
<td>username=username</td>
<td>(StrOpt)PLUMgrid NOS admin username</td>
<td>(StrOpt) PLUMgrid Director admin username</td>
</tr>
</tbody>
</table>

8
doc/src/docbkx/common/tables/neutron-policy.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for policy</caption>
@ -13,11 +17,11 @@
<tbody>
<tr>
<td>allow_overlapping_ips=False</td>
<td>(BoolOpt)Allow overlapping IP support in Quantum</td>
<td>(BoolOpt) Allow overlapping IP support in Neutron</td>
</tr>
<tr>
<td>policy_file=policy.json</td>
<td>(StrOpt)The policy file to use</td>
<td>(StrOpt) The policy file to use</td>
</tr>
</tbody>
</table>

24
doc/src/docbkx/common/tables/neutron-qpid.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for qpid</caption>
@ -13,39 +17,39 @@
<tbody>
<tr>
<td>qpid_heartbeat=60</td>
<td>(IntOpt)Seconds between connection keepalive heartbeats</td>
<td>(IntOpt) Seconds between connection keepalive heartbeats</td>
</tr>
<tr>
<td>qpid_hostname=localhost</td>
<td>(StrOpt)Qpid broker hostname</td>
<td>(StrOpt) Qpid broker hostname</td>
</tr>
<tr>
<td>qpid_hosts=['$qpid_hostname:$qpid_port']</td>
<td>(ListOpt)Qpid HA cluster host:port pairs</td>
<td>qpid_hosts=$qpid_hostname:$qpid_port</td>
<td>(ListOpt) Qpid HA cluster host:port pairs</td>
</tr>
<tr>
<td>qpid_password=</td>
<td>(StrOpt)Password for qpid connection</td>
<td>(StrOpt) Password for qpid connection</td>
</tr>
<tr>
<td>qpid_port=5672</td>
<td>(StrOpt)Qpid broker port</td>
<td>(IntOpt) Qpid broker port</td>
</tr>
<tr>
<td>qpid_protocol=tcp</td>
<td>(StrOpt)Transport to use, either 'tcp' or 'ssl'</td>
<td>(StrOpt) Transport to use, either 'tcp' or 'ssl'</td>
</tr>
<tr>
<td>qpid_sasl_mechanisms=</td>
<td>(StrOpt)Space separated list of SASL mechanisms to use for auth</td>
<td>(StrOpt) Space separated list of SASL mechanisms to use for auth</td>
</tr>
<tr>
<td>qpid_tcp_nodelay=True</td>
<td>(BoolOpt)Disable Nagle algorithm</td>
<td>(BoolOpt) Disable Nagle algorithm</td>
</tr>
<tr>
<td>qpid_username=</td>
<td>(StrOpt)Username for qpid connection</td>
<td>(StrOpt) Username for qpid connection</td>
</tr>
</tbody>
</table>

46
doc/src/docbkx/common/tables/neutron-quotas.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for quotas</caption>
@ -13,56 +17,68 @@
<tbody>
<tr>
<td>default_quota=-1</td>
<td>(IntOpt)Default number of resource allowed per tenant, minus for unlimited</td>
<td>(IntOpt) Default number of resource allowed per tenant, minus for unlimited</td>
</tr>
<tr>
<td>max_routes=30</td>
<td>(IntOpt)Maximum number of routes</td>
<td>(IntOpt) Maximum number of routes</td>
</tr>
<tr>
<td>quota_driver=neutron.quota.ConfDriver</td>
<td>(StrOpt)Default driver to use for quota checks</td>
<td>(StrOpt) Default driver to use for quota checks</td>
</tr>
<tr>
<td>quota_firewall=1</td>
<td>(IntOpt) Number of firewalls allowed per tenant, -1 for unlimited</td>
</tr>
<tr>
<td>quota_firewall_policy=1</td>
<td>(IntOpt) Number of firewall policies allowed per tenant, -1 for unlimited</td>
</tr>
<tr>
<td>quota_firewall_rule=-1</td>
<td>(IntOpt) Number of firewall rules allowed per tenant, -1 for unlimited</td>
</tr>
<tr>
<td>quota_floatingip=50</td>
<td>(IntOpt)Number of floating IPs allowed per tenant, -1 for unlimited</td>
<td>(IntOpt) Number of floating IPs allowed per tenant, -1 for unlimited</td>
</tr>
<tr>
<td>quota_items=['network', 'subnet', 'port']</td>
<td>(ListOpt)Resource name(s) that are supported in quota features</td>
<td>quota_items=network,subnet,port</td>
<td>(ListOpt) Resource name(s) that are supported in quota features</td>
</tr>
<tr>
<td>quota_network=10</td>
<td>(IntOpt)Number of networks allowed per tenant,minus for unlimited</td>
<td>(IntOpt) Number of networks allowed per tenant,minus for unlimited</td>
</tr>
<tr>
<td>quota_network_gateway=5</td>
<td>(IntOpt)number of network gateways allowed per tenant, -1 for unlimited</td>
<td>(IntOpt) number of network gateways allowed per tenant, -1 for unlimited</td>
</tr>
<tr>
<td>quota_packet_filter=100</td>
<td>(IntOpt)Number of packet_filters allowed per tenant, -1 for unlimited</td>
<td>(IntOpt) Number of packet_filters allowed per tenant, -1 for unlimited</td>
</tr>
<tr>
<td>quota_port=50</td>
<td>(IntOpt)number of ports allowed per tenant, minus for unlimited</td>
<td>(IntOpt) number of ports allowed per tenant, minus for unlimited</td>
</tr>
<tr>
<td>quota_router=10</td>
<td>(IntOpt)Number of routers allowed per tenant, -1 for unlimited</td>
<td>(IntOpt) Number of routers allowed per tenant, -1 for unlimited</td>
</tr>
<tr>
<td>quota_security_group=10</td>
<td>(IntOpt)Number of security groups allowed per tenant,-1 for unlimited</td>
<td>(IntOpt) Number of security groups allowed per tenant,-1 for unlimited</td>
</tr>
<tr>
<td>quota_security_group_rule=100</td>
<td>(IntOpt)Number of security rules allowed per tenant, -1 for unlimited</td>
<td>(IntOpt) Number of security rules allowed per tenant, -1 for unlimited</td>
</tr>
<tr>
<td>quota_subnet=10</td>
<td>(IntOpt)Number of subnets allowed per tenant, minus for unlimited</td>
<td>(IntOpt) Number of subnets allowed per tenant, minus for unlimited</td>
</tr>
</tbody>
</table>
</para>
</para>

30
doc/src/docbkx/common/tables/neutron-rabbitmq.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for rabbitmq</caption>
@ -13,51 +17,51 @@
<tbody>
<tr>
<td>rabbit_durable_queues=False</td>
<td>(BoolOpt)use durable queues in RabbitMQ</td>
<td>(BoolOpt) use durable queues in RabbitMQ</td>
</tr>
<tr>
<td>rabbit_ha_queues=False</td>
<td>(BoolOpt)use H/A queues in RabbitMQ (x-ha-policy: all).You need to wipe RabbitMQ database when changing this option.</td>
<td>(BoolOpt) use H/A queues in RabbitMQ (x-ha-policy: all).You need to wipe RabbitMQ database when changing this option.</td>
</tr>
<tr>
<td>rabbit_host=localhost</td>
<td>(StrOpt)The RabbitMQ broker address where a single node is used</td>
<td>(StrOpt) The RabbitMQ broker address where a single node is used</td>
</tr>
<tr>
<td>rabbit_hosts=['$rabbit_host:$rabbit_port']</td>
<td>(ListOpt)RabbitMQ HA cluster host:port pairs</td>
<td>rabbit_hosts=$rabbit_host:$rabbit_port</td>
<td>(ListOpt) RabbitMQ HA cluster host:port pairs</td>
</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 retries with trying to connect to RabbitMQ (the default of 0 implies an 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>
<td>(IntOpt)The RabbitMQ broker port where a single node is used</td>
<td>(IntOpt) The RabbitMQ broker port where a single node is used</td>
</tr>
<tr>
<td>rabbit_retry_backoff=2</td>
<td>(IntOpt)how long to backoff for between retries when connecting to RabbitMQ</td>
<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>

72
doc/src/docbkx/common/tables/neutron-rpc.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for rpc</caption>
@ -11,90 +15,86 @@
</tr>
</thead>
<tbody>
<tr>
<td>amqp_rpc_single_reply_queue=False</td>
<td>(BoolOpt)Enable a fast single reply queue if using AMQP based RPC like RabbitMQ or Qpid.</td>
</tr>
<tr>
<td>control_exchange=neutron</td>
<td>(StrOpt)AMQP exchange to connect to if using RabbitMQ or Qpid</td>
<td>(StrOpt) AMQP exchange to connect to if using RabbitMQ or Qpid</td>
</tr>
<tr>
<td>host=usagi</td>
<td>(StrOpt)The hostname Neutron is running on</td>
<td>host=docwork</td>
<td>(StrOpt) The hostname Neutron is running on</td>
</tr>
<tr>
<td>host=127.0.0.1</td>
<td>(StrOpt)Host to locate redis</td>
</tr>
<tr>
<td>host=None</td>
<td>(StrOpt)Cisco test host option.</td>
<td>(StrOpt) Host to locate redis</td>
</tr>
<tr>
<td>host=127.0.0.1</td>
<td>(StrOpt)Host to connect to</td>
<td>(StrOpt) Host to connect to</td>
</tr>
<tr>
<td>matchmaker_heartbeat_freq=300</td>
<td>(IntOpt)Heartbeat frequency</td>
<td>(IntOpt) Heartbeat frequency</td>
</tr>
<tr>
<td>matchmaker_heartbeat_ttl=600</td>
<td>(IntOpt)Heartbeat time-to-live.</td>
</tr>
<tr>
<td>matchmaker_ringfile=/etc/nova/matchmaker_ring.json</td>
<td>(StrOpt)Matchmaker ring file (JSON)</td>
<td>(IntOpt) Heartbeat time-to-live.</td>
</tr>
<tr>
<td>password=None</td>
<td>(StrOpt)Password for Redis server. (optional)</td>
</tr>
<tr>
<td>password=</td>
<td>(StrOpt)No help text available for this option</td>
<td>(StrOpt) Password for Redis server. (optional)</td>
</tr>
<tr>
<td>password=passw0rd</td>
<td>(StrOpt)MidoNet admin password.</td>
<td>(StrOpt) MidoNet admin password.</td>
</tr>
<tr>
<td>password=</td>
<td>(StrOpt) No help text available for this option</td>
</tr>
<tr>
<td>password=password</td>
<td>(StrOpt)PLUMgrid NOS admin password</td>
<td>(StrOpt) PLUMgrid Director admin password</td>
</tr>
<tr>
<td>port=6379</td>
<td>(IntOpt)Use this port to connect to redis host.</td>
<td>(IntOpt) Use this port to connect to redis host.</td>
</tr>
<tr>
<td>port=8888</td>
<td>(StrOpt)Port to connect to</td>
<td>(StrOpt) Port to connect to</td>
</tr>
<tr>
<td>ringfile=/etc/oslo/matchmaker_ring.json</td>
<td>(StrOpt) Matchmaker ring file (JSON)</td>
</tr>
<tr>
<td>rpc_backend=neutron.openstack.common.rpc.impl_kombu</td>
<td>(StrOpt)The messaging module to use, defaults to kombu.</td>
<td>(StrOpt) The messaging module to use, defaults to kombu.</td>
</tr>
<tr>
<td>rpc_cast_timeout=30</td>
<td>(IntOpt)Seconds to wait before a cast expires (TTL). Only supported by impl_zmq.</td>
<td>(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq.</td>
</tr>
<tr>
<td>rpc_conn_pool_size=30</td>
<td>(IntOpt)Size of RPC connection pool</td>
<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 call or multicall</td>
</tr>
<tr>
<td>rpc_support_old_agents=True</td>
<td>(BoolOpt) Enable server RPC compatibility with old agents</td>
</tr>
<tr>
<td>rpc_thread_pool_size=64</td>
<td>(IntOpt)Size of RPC thread pool</td>
<td>(IntOpt) Size of RPC thread pool</td>
</tr>
<tr>
<td>topics=['notifications']</td>
<td>(ListOpt)AMQP topic(s) used for openstack notifications</td>
<td>topics=notifications</td>
<td>(ListOpt) AMQP topic(s) used for openstack notifications</td>
</tr>
</tbody>
</table>
</para>
</para>

20
doc/src/docbkx/common/tables/neutron-ryu.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for ryu</caption>
@ -13,35 +17,35 @@
<tbody>
<tr>
<td>openflow_rest_api=127.0.0.1:8080</td>
<td>(StrOpt)OpenFlow REST API location</td>
<td>(StrOpt) OpenFlow REST API location</td>
</tr>
<tr>
<td>ovsdb_interface=None</td>
<td>(StrOpt)OVSDB interface to connect to</td>
<td>(StrOpt) OVSDB interface to connect to</td>
</tr>
<tr>
<td>ovsdb_ip=None</td>
<td>(StrOpt)OVSDB IP to connect to</td>
<td>(StrOpt) OVSDB IP to connect to</td>
</tr>
<tr>
<td>ovsdb_port=6634</td>
<td>(IntOpt)OVSDB port to connect to</td>
<td>(IntOpt) OVSDB port to connect to</td>
</tr>
<tr>
<td>tunnel_interface=None</td>
<td>(StrOpt)Tunnel interface to use</td>
<td>(StrOpt) Tunnel interface to use</td>
</tr>
<tr>
<td>tunnel_ip=None</td>
<td>(StrOpt)Tunnel IP to use</td>
<td>(StrOpt) Tunnel IP to use</td>
</tr>
<tr>
<td>tunnel_key_max=16777215</td>
<td>(IntOpt)Maximum tunnel ID to use</td>
<td>(IntOpt) Maximum tunnel ID to use</td>
</tr>
<tr>
<td>tunnel_key_min=1</td>
<td>(IntOpt)Minimum tunnel ID to use</td>
<td>(IntOpt) Minimum tunnel ID to use</td>
</tr>
</tbody>
</table>

14
doc/src/docbkx/common/tables/neutron-scheduler.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for scheduler</caption>
@ -13,20 +17,20 @@
<tbody>
<tr>
<td>network_auto_schedule=True</td>
<td>(BoolOpt)Allow auto scheduling networks to DHCP agent.</td>
<td>(BoolOpt) Allow auto scheduling networks to DHCP agent.</td>
</tr>
<tr>
<td>network_scheduler_driver=neutron.scheduler.dhcp_agent_scheduler.ChanceScheduler</td>
<td>(StrOpt)Driver to use for scheduling network to DHCP agent</td>
<td>(StrOpt) Driver to use for scheduling network to DHCP agent</td>
</tr>
<tr>
<td>router_auto_schedule=True</td>
<td>(BoolOpt)Allow auto scheduling routers to L3 agent.</td>
<td>(BoolOpt) Allow auto scheduling routers to L3 agent.</td>
</tr>
<tr>
<td>router_scheduler_driver=neutron.scheduler.l3_agent_scheduler.ChanceScheduler</td>
<td>(StrOpt)Driver to use for scheduling router to a default L3 agent</td>
<td>(StrOpt) Driver to use for scheduling router to a default L3 agent</td>
</tr>
</tbody>
</table>
</para>
</para>

8
doc/src/docbkx/common/tables/neutron-securitygroups.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for securitygroups</caption>
@ -13,8 +17,8 @@
<tbody>
<tr>
<td>firewall_driver=neutron.agent.firewall.NoopFirewallDriver</td>
<td>(StrOpt)No help text available for this option</td>
<td>(StrOpt) Driver for Security Groups Firewall</td>
</tr>
</tbody>
</table>
</para>
</para>

16
doc/src/docbkx/common/tables/neutron-ssl.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for ssl</caption>
@ -13,27 +17,27 @@
<tbody>
<tr>
<td>key_file=None</td>
<td>(StrOpt)Key file</td>
<td>(StrOpt) Key file</td>
</tr>
<tr>
<td>ssl_ca_file=None</td>
<td>(StrOpt)CA certificate file to use to verify connecting clients</td>
<td>(StrOpt) CA certificate file to use to verify connecting clients</td>
</tr>
<tr>
<td>ssl_cert_file=None</td>
<td>(StrOpt)Certificate file to use when starting the server securely</td>
<td>(StrOpt) Certificate file to use when starting the server securely</td>
</tr>
<tr>
<td>ssl_key_file=None</td>
<td>(StrOpt)Private key file to use when starting the server securely</td>
<td>(StrOpt) Private key file to use when starting the server securely</td>
</tr>
<tr>
<td>use_ssl=False</td>
<td>(BoolOpt)Enable SSL on the API server</td>
<td>(BoolOpt) Enable SSL on the API server</td>
</tr>
<tr>
<td>use_ssl=False</td>
<td>(BoolOpt)Use SSL to connect</td>
<td>(BoolOpt) Use SSL to connect</td>
</tr>
</tbody>
</table>

8
doc/src/docbkx/common/tables/neutron-testing.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for testing</caption>
@ -13,11 +17,11 @@
<tbody>
<tr>
<td>backdoor_port=None</td>
<td>(IntOpt)port for eventlet backdoor to listen</td>
<td>(IntOpt) port for eventlet backdoor to listen</td>
</tr>
<tr>
<td>fake_rabbit=False</td>
<td>(BoolOpt)If passed, use a fake RabbitMQ provider</td>
<td>(BoolOpt) If passed, use a fake RabbitMQ provider</td>
</tr>
</tbody>
</table>

10
doc/src/docbkx/common/tables/neutron-wsgi.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for wsgi</caption>
@ -13,15 +17,15 @@
<tbody>
<tr>
<td>backlog=4096</td>
<td>(IntOpt)Number of backlog requests to configure the socket with</td>
<td>(IntOpt) Number of backlog requests to configure the socket with</td>
</tr>
<tr>
<td>retry_until_window=30</td>
<td>(IntOpt)Number of seconds to keep retrying to listen</td>
<td>(IntOpt) Number of seconds to keep retrying to listen</td>
</tr>
<tr>
<td>tcp_keepidle=600</td>
<td>(IntOpt)Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X.</td>
<td>(IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X.</td>
</tr>
</tbody>
</table>

22
doc/src/docbkx/common/tables/neutron-zeromq.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for zeromq</caption>
@ -13,32 +17,32 @@
<tbody>
<tr>
<td>rpc_zmq_bind_address=*</td>
<td>(StrOpt)ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address.</td>
<td>(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address.</td>
</tr>
<tr>
<td>rpc_zmq_contexts=1</td>
<td>(IntOpt)Number of ZeroMQ contexts, defaults to 1</td>
<td>(IntOpt) Number of ZeroMQ contexts, defaults to 1</td>
</tr>
<tr>
<td>rpc_zmq_host=usagi</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>rpc_zmq_host=docwork</td>
<td>(StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova.</td>
</tr>
<tr>
<td>rpc_zmq_ipc_dir=/var/run/openstack</td>
<td>(StrOpt)Directory for holding IPC sockets</td>
<td>(StrOpt) Directory for holding IPC sockets</td>
</tr>
<tr>
<td>rpc_zmq_matchmaker=neutron.openstack.common.rpc.matchmaker.MatchMakerLocalhost</td>
<td>(StrOpt)MatchMaker driver</td>
<td>(StrOpt) MatchMaker driver</td>
</tr>
<tr>
<td>rpc_zmq_port=9501</td>
<td>(IntOpt)ZeroMQ receiver listening port</td>
<td>(IntOpt) ZeroMQ receiver listening port</td>
</tr>
<tr>
<td>rpc_zmq_topic_backlog=None</td>
<td>(IntOpt)Maximum number of ingress messages to locally buffer per topic. Default is unlimited.</td>
<td>(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited.</td>
</tr>
</tbody>
</table>
</para>
</para>

4
doc/src/docbkx/common/tables/nova-api.xml
View File

@ -83,6 +83,10 @@
<td>use_forwarded_for=False</td>
<td>(BoolOpt) Treat X-Forwarded-For as the canonical remote address. Only enable this if you have a sanitizing proxy.</td>
</tr>
<tr>
<td>use_tpool=False</td>
<td>(BoolOpt) Enable the experimental use of thread pooling for all DB API calls</td>
</tr>
</tbody>
</table>
</para>

2
doc/src/docbkx/common/tables/nova-authentication.xml
View File

@ -16,7 +16,7 @@
</thead>
<tbody>
<tr>
<td>api_rate_limit=True</td>
<td>api_rate_limit=False</td>
<td>(BoolOpt) whether to use per-user rate limiting for the api.</td>
</tr>
<tr>

8
doc/src/docbkx/common/tables/nova-baremetal.xml
View File

@ -15,10 +15,6 @@
</tr>
</thead>
<tbody>
<tr>
<td>db_backend=sqlalchemy</td>
<td>(StrOpt) The backend to use for db</td>
</tr>
<tr>
<td>db_backend=sqlalchemy</td>
<td>(StrOpt) The backend to use for bare-metal database</td>
@ -71,10 +67,6 @@
<td>pxe_network_config=False</td>
<td>(BoolOpt) If set, pass the network configuration details to the initramfs via cmdline.</td>
</tr>
<tr>
<td>sql_connection=sqlite:////home/ubuntu/nova/nova/openstack/common/db/$sqlite_db</td>
<td>(StrOpt) The SQLAlchemy connection string used to connect to the database</td>
</tr>
<tr>
<td>sql_connection=sqlite:///$state_path/baremetal_$sqlite_db</td>
<td>(StrOpt) The SQLAlchemy connection string used to connect to the bare-metal database</td>

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

@ -19,10 +19,18 @@
<td>ca_file=cacert.pem</td>
<td>(StrOpt) Filename of root CA</td>
</tr>
<tr>
<td>ca_file=None</td>
<td>(StrOpt) CA certificate file to use to verify connecting clients</td>
</tr>
<tr>
<td>ca_path=$state_path/CA</td>
<td>(StrOpt) Where we keep our root CA</td>
</tr>
<tr>
<td>cert_file=None</td>
<td>(StrOpt) Certificate file to use when starting the server securely</td>
</tr>
<tr>
<td>cert_manager=nova.cert.manager.CertManager</td>
<td>(StrOpt) full class name for the Manager for cert</td>
@ -39,6 +47,10 @@
<td>key_file=private/cakey.pem</td>
<td>(StrOpt) Filename of private key</td>
</tr>
<tr>
<td>key_file=None</td>
<td>(StrOpt) Private key file to use when starting the server securely</td>
</tr>
<tr>
<td>keys_path=$state_path/keys</td>
<td>(StrOpt) Where we keep our keys</td>

2
doc/src/docbkx/common/tables/nova-common.xml
View File

@ -45,7 +45,7 @@
</tr>
<tr>
<td>lock_path=None</td>
<td>(StrOpt) Directory to use for lock files. Default to a temp directory</td>
<td>(StrOpt) Directory to use for lock files.</td>
</tr>
<tr>
<td>memcached_servers=None</td>

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

@ -83,6 +83,10 @@
<td>instance_build_timeout=0</td>
<td>(IntOpt) Amount of time in seconds an instance can be in BUILD before going into ERROR status.Set to 0 to disable.</td>
</tr>
<tr>
<td>instance_delete_interval=300</td>
<td>(IntOpt) Interval in seconds for retrying failed instance file deletes</td>
</tr>
<tr>
<td>instance_usage_audit=False</td>
<td>(BoolOpt) Generate periodic compute.instance.exists notifications</td>
@ -95,6 +99,10 @@
<td>instances_path=$state_path/instances</td>
<td>(StrOpt) where instances are stored on disk</td>
</tr>
<tr>
<td>maximum_instance_delete_attempts=5</td>
<td>(IntOpt) The number of times to attempt to reap an instance's files.</td>
</tr>
<tr>
<td>reboot_timeout=0</td>
<td>(IntOpt) Automatically hard reboot an instance if it has been stuck in a rebooting state longer than N seconds. Set to 0 to disable.</td>

2
doc/src/docbkx/common/tables/nova-conductor.xml
View File

@ -37,4 +37,4 @@
</tr>
</tbody>
</table>
</para>
</para>

80
doc/src/docbkx/common/tables/nova-db.xml
View File

@ -16,9 +16,21 @@
</thead>
<tbody>
<tr>
<td>db_backend=sqlalchemy</td>
<td>backend=sqlalchemy</td>
<td>(StrOpt) The backend to use for db</td>
</tr>
<tr>
<td>connection_trace=False</td>
<td>(BoolOpt) Add python stack traces to SQL as comment strings</td>
</tr>
<tr>
<td>connection=sqlite:////home/ubuntu/nova/nova/openstack/common/db/$sqlite_db</td>
<td>(StrOpt) The SQLAlchemy connection string used 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>
</tr>
<tr>
<td>db_backend=sqlalchemy</td>
<td>(StrOpt) The backend to use for bare-metal database</td>
@ -32,56 +44,48 @@
<td>(StrOpt) driver to use for database access</td>
</tr>
<tr>
<td>dbapi_use_tpool=False</td>
<td>(BoolOpt) Enable the experimental use of thread pooling for all DB API calls</td>
<td>idle_timeout=3600</td>
<td>(IntOpt) timeout before idle sql connections are reaped</td>
</tr>
<tr>
<td>sql_connection=sqlite:////home/ubuntu/nova/nova/openstack/common/db/$sqlite_db</td>
<td>(StrOpt) The SQLAlchemy connection string used to connect to the database</td>
<td>max_pool_size=None</td>
<td>(IntOpt) Maximum number of SQL connections to keep open in a pool</td>
</tr>
<tr>
<td>max_overflow=None</td>
<td>(IntOpt) If set, use this value for max_overflow with sqlalchemy</td>
</tr>
<tr>
<td>max_retries=10</td>
<td>(IntOpt) maximum db connection retries during startup. (setting -1 implies 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>
</tr>
<tr>
<td>pool_timeout=None</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>
</tr>
<tr>
<td>slave_connection=</td>
<td>(StrOpt) The SQLAlchemy connection string used to connect to the slave database</td>
</tr>
<tr>
<td>sql_connection=sqlite:///$state_path/baremetal_$sqlite_db</td>
<td>(StrOpt) The SQLAlchemy connection string used to connect to the bare-metal database</td>
</tr>
<tr>
<td>sql_connection_debug=0</td>
<td>(IntOpt) Verbosity of SQL debugging information. 0=None, 100=Everything</td>
</tr>
<tr>
<td>sql_connection_trace=False</td>
<td>(BoolOpt) Add python stack traces to SQL as comment strings</td>
</tr>
<tr>
<td>sql_idle_timeout=3600</td>
<td>(IntOpt) timeout before idle sql connections are reaped</td>
</tr>
<tr>
<td>sql_max_overflow=None</td>
<td>(IntOpt) If set, use this value for max_overflow with sqlalchemy</td>
</tr>
<tr>
<td>sql_max_pool_size=5</td>
<td>(IntOpt) Maximum number of SQL connections to keep open in a pool</td>
</tr>
<tr>
<td>sql_max_retries=10</td>
<td>(IntOpt) maximum db connection retries during startup. (setting -1 implies an infinite retry count)</td>
</tr>
<tr>
<td>sql_min_pool_size=1</td>
<td>(IntOpt) Minimum number of SQL connections to keep open in a pool</td>
</tr>
<tr>
<td>sql_retry_interval=10</td>
<td>(IntOpt) interval between retries of opening a sql connection</td>
</tr>
<tr>
<td>sqlite_db=nova.sqlite</td>
<td>(StrOpt) the filename to use with sqlite</td>
</tr>
<tr>
<td>sqlite_synchronous=True</td>
<td>(BoolOpt) If passed, use synchronous mode for sqlite</td>
<td>(BoolOpt) If true, use synchronous mode for sqlite</td>
</tr>
</tbody>
</table>

4
doc/src/docbkx/common/tables/nova-glance.xml
View File

@ -19,6 +19,10 @@
<td>allowed_direct_url_schemes=</td>
<td>(ListOpt) A list of url scheme that can be downloaded directly via the direct_url. Currently supported schemes: [file].</td>
</tr>
<tr>
<td>filesystems=</td>
<td>(ListOpt) A list of filesystems that will be configured in this file under the sections image_file_url:&lt;list entry name&gt;</td>
</tr>
<tr>
<td>glance_api_insecure=False</td>
<td>(BoolOpt) Allow to perform insecure SSL (https) requests to glance</td>

2
doc/src/docbkx/common/tables/nova-kombu.xml
View File

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

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

@ -32,11 +32,11 @@
<td>(BoolOpt) make exception message format errors fatal</td>
</tr>
<tr>
<td>instance_format=[instance: %(uuid)s]</td>
<td>instance_format=[instance: %(uuid)s] </td>
<td>(StrOpt) If an instance is passed with the log message, format it like this</td>
</tr>
<tr>
<td>instance_uuid_format=[instance: %(uuid)s]</td>
<td>instance_uuid_format=[instance: %(uuid)s] </td>
<td>(StrOpt) If an instance UUID is passed with the log message, format it like this</td>
</tr>
<tr>
@ -97,4 +97,4 @@
</tr>
</tbody>
</table>
</para>
</para>

8
doc/src/docbkx/common/tables/nova-metadata.xml
View File

@ -39,6 +39,14 @@
<td>metadata_workers=None</td>
<td>(IntOpt) Number of workers for metadata service</td>
</tr>
<tr>
<td>vendordata_driver=nova.api.metadata.vendordata_json.JsonFileVendorData</td>
<td>(StrOpt) Driver to use for vendor data</td>
</tr>
<tr>
<td>vendordata_jsonfile_path=None</td>
<td>(StrOpt) File to load json formated vendor data from</td>
</tr>
</tbody>
</table>
</para>

6
doc/src/docbkx/common/tables/nova-network.xml
View File

@ -255,10 +255,14 @@
<td>vlan_interface=None</td>
<td>(StrOpt) vlans will bridge into this interface if set</td>
</tr>
<tr>
<td>vlan_interface=vmnic0</td>
<td>(StrOpt) Physical ethernet adapter name for vlan networking</td>
</tr>
<tr>
<td>vlan_start=100</td>
<td>(IntOpt) First VLAN for private networks</td>
</tr>
</tbody>
</table>
</para>
</para>

14
doc/src/docbkx/common/tables/nova-neutron.xml
View File

@ -1,4 +1,8 @@
<?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">
<caption>Description of configuration options for neutron</caption>
@ -35,6 +39,10 @@
<td>neutron_auth_strategy=keystone</td>
<td>(StrOpt) auth strategy for connecting to neutron in admin context</td>
</tr>
<tr>
<td>neutron_ca_certificates_file=None</td>
<td>(StrOpt) Location of ca certicates file to use for neutronclient requests.</td>
</tr>
<tr>
<td>neutron_default_tenant_id=default</td>
<td>(StrOpt) Default tenant id when creating neutron networks</td>
@ -63,6 +71,10 @@
<td>neutron_url_timeout=30</td>
<td>(IntOpt) timeout value for connecting to neutron in seconds</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>
</tbody>
</table>
</para>
</para>

5
doc/src/docbkx/common/tables/nova-quota.xml
View File

@ -25,8 +25,7 @@
</tr>
<tr>
<td>enable_network_quota=False</td>
<td>(BoolOpt) Enables or disables quota
checking of tenant networks <!-- Fix for source is at https://review.openstack.org/40271 --></td>
<td>(BoolOpt) Enables or disables quotaing of tenant networks</td>
</tr>
<tr>
<td>quota_cores=20</td>
@ -82,4 +81,4 @@
</tr>
</tbody>
</table>
</para>
</para>

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

@ -21,7 +21,7 @@
</tr>
<tr>
<td>backdoor_port=None</td>
<td>(IntOpt) port for eventlet backdoor to listen</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>

58
doc/src/docbkx/common/tables/nova-vmware.xml
View File

@ -15,44 +15,44 @@
</tr>
</thead>
<tbody>
<tr>
<td>api_retry_count=10</td>
<td>(IntOpt) The number of times we retry on failures, e.g., socket error, etc. Used only if compute_driver is vmwareapi.VMwareESXDriver or vmwareapi.VMwareVCDriver.</td>
</tr>
<tr>
<td>cluster_name=None</td>
<td>(StrOpt) Name of a VMware Cluster ComputeResource. Used only if compute_driver is vmwareapi.VMwareVCDriver.</td>
</tr>
<tr>
<td>host_ip=None</td>
<td>(StrOpt) URL for connection to VMware ESX/VC host. Required if compute_driver is vmwareapi.VMwareESXDriver or vmwareapi.VMwareVCDriver.</td>
</tr>
<tr>
<td>host_username=None</td>
<td>(StrOpt) Username for connection to VMware ESX/VC host. Used only if compute_driver is vmwareapi.VMwareESXDriver or vmwareapi.VMwareVCDriver.</td>
</tr>
<tr>
<td>host_password=None</td>
<td>(StrOpt) Password for connection to VMware ESX/VC host. Used only if compute_driver is vmwareapi.VMwareESXDriver or vmwareapi.VMwareVCDriver.</td>
</tr>
<tr>
<td>integration_bridge=br-int</td>
<td>(StrOpt) Name of Integration Bridge</td>
</tr>
<tr>
<td>maximum_objects=100</td>
<td>(IntOpt) The maximum number of ObjectContent data objects that should be returned in a single result. A positive value will cause the operation to suspend the retrieval when the count of objects reaches the specified maximum. The server may still limit the count to something less than the configured value. Any remaining objects may be retrieved with additional requests.</td>
</tr>
<tr>
<td>task_poll_interval=5.0</td>
<td>(FloatOpt) The interval used for polling of remote tasks. Used only if compute_driver is vmwareapi.VMwareESXDriver or vmwareapi.VMwareVCDriver.</td>
</tr>
<tr>
<td>use_linked_clone=True</td>
<td>(BoolOpt) Whether to use linked clone</td>
</tr>
<tr>
<td>vmwareapi_api_retry_count=10</td>
<td>(IntOpt) The number of times we retry on failures, e.g., socket error, etc. Used only if compute_driver is vmwareapi.VMwareESXDriver or vmwareapi.VMwareVCDriver.</td>
</tr>
<tr>
<td>vmwareapi_cluster_name=None</td>
<td>(StrOpt) Name of a VMware Cluster ComputeResource. Used only if compute_driver is vmwareapi.VMwareVCDriver.</td>
</tr>
<tr>
<td>vmwareapi_host_ip=None</td>
<td>(StrOpt) URL for connection to VMware ESX/VC host. Required if compute_driver is vmwareapi.VMwareESXDriver or vmwareapi.VMwareVCDriver.</td>
</tr>
<tr>
<td>vmwareapi_host_password=None</td>
<td>(StrOpt) Password for connection to VMware ESX/VC host. Used only if compute_driver is vmwareapi.VMwareESXDriver or vmwareapi.VMwareVCDriver.</td>
</tr>
<tr>
<td>vmwareapi_host_username=None</td>
<td>(StrOpt) Username for connection to VMware ESX/VC host. Used only if compute_driver is vmwareapi.VMwareESXDriver or vmwareapi.VMwareVCDriver.</td>
</tr>
<tr>
<td>vmwareapi_task_poll_interval=5.0</td>
<td>(FloatOpt) The interval used for polling of remote tasks. Used only if compute_driver is vmwareapi.VMwareESXDriver or vmwareapi.VMwareVCDriver.</td>
</tr>
<tr>
<td>vmwareapi_vlan_interface=vmnic0</td>
<td>(StrOpt) Physical ethernet adapter name for vlan networking</td>
</tr>
<tr>
<td>vmwareapi_wsdl_loc=None</td>
<td>wsdl_location=None</td>
<td>(StrOpt) Optional VIM Service WSDL Location e.g http://&lt;server&gt;/vimService.wsdl. Optional over-ride to default location for bug work-arounds</td>
</tr>
</tbody>

2
doc/src/docbkx/common/tables/nova-volumes.xml
View File

@ -45,7 +45,7 @@
</tr>
<tr>
<td>force_volumeutils_v1=False</td>
<td>(BoolOpt) Force volumeutils v1</td>
<td>(BoolOpt) Force V1 volume utility class</td>
</tr>
<tr>
<td>glusterfs_mount_point_base=$state_path/mnt</td>

4
doc/src/docbkx/common/tables/nova-wsgi.xml
View File

@ -17,7 +17,7 @@
<tbody>
<tr>
<td>api_paste_config=api-paste.ini</td>
<td>(StrOpt) File name for the paste.deploy config for <systemitem class="service">nova-api</systemitem></td>
<td>(StrOpt) File name for the paste.deploy config for nova-api</td>
</tr>
<tr>
<td>ssl_ca_file=None</td>
@ -41,4 +41,4 @@
</tr>
</tbody>
</table>
</para>
</para>

12
doc/src/docbkx/common/tables/nova-xen.xml
View File

@ -76,8 +76,8 @@
<td>(IntOpt) Maximum size in bytes of kernel or ramdisk images</td>
</tr>
<tr>
<td>sr_matching_filter=other-config:i18n-key=local-storage</td>
<td>(StrOpt) Filter for finding the SR to be used to install guest instances on. The default value is the Local Storage in default XenServer/XCP installations. To select an SR with a different matching criteria, you could set it to other-config:my_favorite_sr=true. On the other hand, to fall back on the Default SR, as displayed by XenCenter, set this flag to: default-sr:true</td>
<td>sr_matching_filter=default-sr:true</td>
<td>(StrOpt) Filter for finding the SR to be used to install guest instances on. To use the Local Storage in default XenServer/XCP installations set this flag to other-config:i18n-key=local-storage. To select an SR with a different matching criteria, you could set it to other-config:my_favorite_sr=true. On the other hand, to fall back on the Default SR, as displayed by XenCenter, set this flag to: default-sr:true</td>
</tr>
<tr>
<td>stub_compute=False</td>
@ -125,11 +125,11 @@
</tr>
<tr>
<td>xenapi_disable_agent=False</td>
<td>(BoolOpt) Disables the use of the XenAPI agent in any image regardless of what image properties are present.</td>
<td>(BoolOpt) Disables the use of the XenAPI agent in any image regardless of what image properties are present. </td>
</tr>
<tr>
<td>xenapi_image_upload_handler=nova.virt.xenapi.imageupload.glance.GlanceStore</td>
<td>(StrOpt) Object Store Driver used to handle image uploads.</td>
<td>xenapi_image_upload_handler=nova.virt.xenapi.image.glance.GlanceStore</td>
<td>(StrOpt) Dom0 plugin driver used to handle image uploads.</td>
</tr>
<tr>
<td>xenapi_login_timeout=10</td>
@ -217,4 +217,4 @@
</tr>
</tbody>
</table>
</para>
</para>

7
tools/autogenerate-config-docs/flagmappings/cinder.flagmappings
View File

@ -77,11 +77,17 @@ iscsi_ip_address storage
iscsi_num_targets storage
iscsi_port storage
iscsi_target_prefix storage
iser_target_prefix Unknown
kombu_ssl_ca_certs rpc
iser_port Unknown
kombu_ssl_certfile rpc
iser_num_targets Unknown
kombu_ssl_keyfile rpc
iser_ip_address Unknown
kombu_ssl_version rpc
keymgr_api_class Unknown
lio_initiator_iqns common
iser_helper Unknown
lock_path common
log_config common
log_date_format common
@ -139,6 +145,7 @@ no_snapshot_gb_quota common
notification_driver rpc
notification_topics rpc
num_iscsi_scan_tries common
num_iser_scan_tries Unknown
num_shell_tries common
osapi_max_limit api
osapi_max_request_body_size api

26
tools/autogenerate-config-docs/flagmappings/glance.flagmappings
View File

@ -4,28 +4,39 @@ admin_tenant_name registry
admin_user registry
allow_additional_image_properties common
allow_anonymous_access api
allowed_rpc_exception_modules rpc
api_limit_max common
auth_region registry
auth_strategy registry
auth_url registry
backdoor_port wsgi
backlog common
bind_host common
bind_port common
ca_file ssl
cert_file ssl
cinder_catalog_info cinder
cleanup_scrubber imagecache
cinder_ca_certificates_file cinder
cleanup_scrubber_time imagecache
cinder_http_retries cinder
config_file paste
cinder_endpoint_template cinder
data_api common
cinder_api_insecure cinder
db_auto_create api
debug logging
default_log_levels loggin
default_log_levels logging
default_notification_level logging
default_store api
default_publisher_id api
delayed_delete imagecache
enable_v1_api api
enable_v2_api api
eventlet_hub wsgi
fatal_deprecations logging
filesystem_store_datadir filesystem
filesystem_store_metadata_file filesystem
flavor paste
image_cache_dir imagecache
image_cache_driver imagecache
@ -43,15 +54,18 @@ log_date_format logging
log_dir logging
log_file logging
log_format logging
logfile_mode logging
logging_context_format_string logging
logging_debug_format_suffix logging
logging_default_format_string logging
logging_exception_prefix logging
metadata_encryption_key common
mongodb_store_uri gridfs
notifier_strategy common
notification_driver api
owner_is_tenant api
os_region_name common
policy_default_rule policy
mongodb_store_db gridfs
policy_file policy
publish_errors logging
pydev_worker_debug_host testing
@ -104,14 +118,21 @@ s3_store_object_buffer_dir s3
s3_store_secret_key s3
scrub_time imagecache
scrubber_datadir imagecache
send_identity_headers api
show_image_direct_url common
sheepdog_store_chunk_size sheepdog
sql_connection db
show_multiple_locations api
sql_idle_timeout db
sheepdog_store_address sheepdog
sql_max_retries db
sheepdog_store_port sheepdog
sql_retry_interval db
sqlalchemy_debug db
swift_enable_snet swift
swift_store_admin_tenants swift
swift_store_auth_address swift
swift_store_auth_insecure swift
swift_store_auth_version swift
swift_store_container swift
swift_store_create_container_on_put swift
@ -127,5 +148,6 @@ syslog_log_facility logging
tcp_keepidle wsgi
use_stderr logging
use_syslog logging
use_user_token api
verbose logging
workers common

7
tools/autogenerate-config-docs/flagmappings/neutron.flagmappings
View File

@ -157,7 +157,7 @@ port nec
port rpc
project_id midonet
provider_router_id midonet
provider_vlan_aiuto_create cisco
provider_vlan_auto_create cisco
provider_vlan_auto_trunk cisco
provider_vlan_name_prefix cisco
publish_errors logging
@ -201,7 +201,7 @@ report_interval agent
req_timeout ml2
request_timeout mlnx
retries nicira
retry_intervali db
retry_interval db
retry_until_window wsgi
ringfile rpc
root_helper common
@ -265,7 +265,10 @@ username brocade
username midonet
username plumgrid
verbose logging
veth_mtu openvswitch
vif_type bigswitch
vif_types bigswitch
vlan_name_prefix cisco
vni_ranges ml2
vnic_type mlnx
vswitch_plugin cisco

45
tools/autogenerate-config-docs/flagmappings/nova.flagmappings
View File

@ -11,6 +11,7 @@ allowed_direct_url_schemes glance
allowed_rpc_exception_modules testing
api_paste_config wsgi
api_rate_limit authentication
api_retry_count vmware
attestation_api_url trustedcomputing
attestation_auth_blob trustedcomputing
attestation_auth_timeout trustedcomputing
@ -20,6 +21,7 @@ attestation_server_ca_file trustedcomputing
auth_strategy authentication
auto_assign_floating_ip network
backdoor_port testing
backend db
bandwidth_poll_interval quota
bandwidth_update_interval quota
base_dir_name compute
@ -38,6 +40,7 @@ cell_type cells
cells upgrade_levels
cells_config cells
cert upgrade_levels
cert_file ca
cert_manager ca
cert_topic ca
checksum_base_images hypervisor
@ -48,6 +51,7 @@ cinder_catalog_info volumes
cinder_cross_az_attach volumes
cinder_endpoint_template volumes
cinder_http_retries volumes
cluster_name vmware
cnt_vpn_clients network
compute upgrade_levels
compute_api_class compute
@ -61,8 +65,11 @@ config_drive_format configdrive
config_drive_inject_password configdrive
config_drive_skip_versions configdrive
config_drive_tempdir configdrive
connection_trace db
console upgrade_levels
connection db
console_driver xen
connection_debug db
console_host compute
console_manager compute
console_public_hostname console
@ -86,7 +93,6 @@ db_backend baremetal
db_backend db
db_check_interval db
db_driver db
dbapi_use_tpool db
debug logging
default_access_ip_network_name network
default_availability_zone availabilityzones
@ -142,6 +148,7 @@ fake_network testing
fake_rabbit testing
fatal_deprecations logging
fatal_exception_format_errors logging
filesystems glance
firewall_driver network
fixed_ip_disassociate_timeout network
fixed_range network
@ -170,15 +177,20 @@ glusterfs_mount_point_base volumes
heal_instance_info_cache_interval compute
host common
host redis
host_ip vmware
host_state_interval compute
host_username vmware
html5proxy_base_url spice
idle_timeout db
image_cache_manager_interval compute
host_password vmware
image_decryption_dir s3
image_info_filename_pattern compute
inject_password hypervisor
injected_network_template network
injected_network_template network
instance_build_timeout compute
instance_delete_interval compute
instance_dns_domain network
instance_dns_manager network
instance_format logging
@ -273,13 +285,19 @@ max_hop_count cells
max_instances_per_host scheduling
max_io_ops_per_host scheduling
max_kernel_ramdisk_size xen
max_pool_size db
memcached_servers common
max_overflow db
metadata_host metadata
max_retries db
metadata_listen metadata
maximum_objects vmware
metadata_listen_port metadata
maximum_instance_delete_attempts compute
metadata_manager metadata
metadata_port metadata
metadata_workers metadata
min_pool_size db
mkisofs_cmd configdrive
monkey_patch testing
monkey_patch_modules testing
@ -306,6 +324,7 @@ neutron_admin_tenant_name neutron
neutron_admin_username neutron
neutron_api_insecure neutron
neutron_auth_strategy neutron
neutron_ca_certificates_file neutron
neutron_default_tenant_id neutron
neutron_extension_sync_interval neutron
neutron_metadata_proxy_shared_secret neutron
@ -343,6 +362,7 @@ periodic_enable periodic
periodic_fuzzy_delay periodic
policy_default_rule policy
policy_file policy
pool_timeout db
port redis
power_manager baremetal
powervm_img_local_path powervm
@ -418,6 +438,7 @@ reserved_host_disk_mb scheduling
reserved_host_memory_mb scheduling
resize_confirm_window compute
resume_guests_state_on_host_boot compute
retry_interval db
ringfile rpc
rootwrap_config common
routing_source_ip network
@ -475,18 +496,11 @@ sg_retry_interval zookeeper
share_dhcp_address network
shelved_offload_time compute
shelved_poll_interval compute
slave_connection db
snapshot_image_format hypervisor
snapshot_name_template api
sql_connection baremetal
sql_connection db
sql_connection_debug db
sql_connection_trace db
sql_idle_timeout db
sql_max_overflow db
sql_max_pool_size db
sql_max_retries db
sql_min_pool_size db
sql_retry_interval db
sqlite_db db
sqlite_synchronous db
sr_matching_filter xen
@ -499,6 +513,7 @@ sync_power_state_interval compute
syslog_log_facility logging
target_host xen
target_port xen
task_poll_interval vmware
tcp_keepidle wsgi
teardown_unused_network_gateway network
tempdir common
@ -530,11 +545,14 @@ use_project_ca ca
use_single_default_gateway network
use_stderr logging
use_syslog logging
use_tpool api
use_unsafe_iscsi baremetal
use_usb_tablet hypervisor
user_cert_subject ca
vcpu_pin_set hypervisor
vendordata_driver metadata
verbose logging
vendordata_jsonfile_path metadata
vif_driver baremetal
virt_mkfs hypervisor
virtual_power_host_key baremetal
@ -545,14 +563,6 @@ virtual_power_ssh_port baremetal
virtual_power_type baremetal
vlan_interface network
vlan_start network
vmwareapi_api_retry_count vmware
vmwareapi_cluster_name vmware
vmwareapi_host_ip vmware
vmwareapi_host_password vmware
vmwareapi_host_username vmware
vmwareapi_task_poll_interval vmware
vmwareapi_vlan_interface vmware
vmwareapi_wsdl_loc vmware
vnc_enabled vnc
vnc_keymap vnc
vnc_password vnc
@ -571,6 +581,7 @@ vpn_ip vpn
vpn_key_suffix vpn
vpn_start vpn
vswitch_name hyperv
wsdl_location vmware
wsgi_log_format wsgi
xen_hvmloader_path xen
xenapi_agent_path xen