openstack/openstack-manuals
Code Issues Proposed changes

config reference update for juno-1

Browse Source 
Generate the config tables with the autohelp script and include the new
tables in the config ref sections.

For consistency, use the 'database' and 'auth_token' keywords in all
projects.

Split the LBaaS tables.

Closes-Bug: #1327802
Closes-Bug: #1331180
Closes-Bug: #1331175
Closes-Bug: #1330279
Closes-Bug: #1323946
Closes-Bug: #1323437
Closes-Bug: #1322075
Closes-Bug: #1321621
Closes-Bug: #1319564
Closes-Bug: #1318081
Closes-Bug: #1311474
Change-Id: I5602dda76fdf929d9124f5aa67d31ca4ac17c6d5
This commit is contained in:
Gauvain Pocentek 2014-06-28 22:08:00 +02:00
parent 9d2c428124
commit b88212e062
421 changed files with 24158 additions and 22720 deletions
doc/common
section_rpc-for-networking.xml
tables
ceilometer-alarm.xmlceilometer-amqp.xmlceilometer-api.xmlceilometer-auth.xmlceilometer-auth_token.xmlceilometer-cells.xmlceilometer-collector.xmlceilometer-common.xmlceilometer-database.xmlceilometer-events.xmlceilometer-exchange.xmlceilometer-inspector.xmlceilometer-logging.xmlceilometer-nova_cells.xmlceilometer-nova_import.xmlceilometer-qpid.xmlceilometer-rabbitmq.xmlceilometer-redis.xmlceilometer-rpc.xmlceilometer-ssl.xmlceilometer-swift.xmlceilometer-vmware.xmlcinder-api.xmlcinder-auth.xmlcinder-auth_token.xmlcinder-backups.xmlcinder-backups_ceph.xmlcinder-backups_swift.xmlcinder-backups_tsm.xmlcinder-block-device.xmlcinder-common.xmlcinder-compute.xmlcinder-connection.xmlcinder-coraid.xmlcinder-database.xmlcinder-emc.xmlcinder-eqlx.xmlcinder-hds-hus.xmlcinder-hp3par.xmlcinder-hplefthand.xmlcinder-hpmsa.xmlcinder-huawei.xmlcinder-images.xmlcinder-keymgr.xmlcinder-lvm.xmlcinder-nas.xmlcinder-netapp_7mode_iscsi.xmlcinder-netapp_7mode_nfs.xmlcinder-netapp_cdot_iscsi.xmlcinder-netapp_cdot_nfs.xmlcinder-netapp_eseries_iscsi.xmlcinder-nexenta_iscsi.xmlcinder-nexenta_nfs.xmlcinder-quota.xmlcinder-rootwrap.xmlcinder-rpc.xmlcinder-san-solaris.xmlcinder-san.xmlcinder-scality.xmlcinder-scheduler.xmlcinder-solidfire.xmlcinder-ssl.xmlcinder-storage.xmlcinder-storage_ceph.xmlcinder-storage_glusterfs.xmlcinder-storage_gpfs.xmlcinder-storage_nfs.xmlcinder-storage_xen.xmlcinder-storwize.xmlcinder-vmware.xmlcinder-windows.xmlcinder-xiv.xmlcinder-zadara.xmlcinder-zones.xmlcinder-zoning.xmlcinder-zoning_fabric.xmlcinder-zoning_manager.xmlglance-amqp.xmlglance-api.xmlglance-auth_token.xmlglance-cinder.xmlglance-common.xmlglance-database.xmlglance-db.xmlglance-filesystem.xmlglance-gridfs.xmlglance-imagecache.xmlglance-logging.xmlglance-matchmaker.xmlglance-paste.xmlglance-policy.xmlglance-qpid.xmlglance-rabbitmq.xmlglance-rbd.xmlglance-redis.xmlglance-registry.xmlglance-rpc.xmlglance-s3.xmlglance-sheepdog.xml
Show More

1
doc/common/section_rpc-for-networking.xml

@ -40,7 +40,6 @@ rpc_backend=neutron.openstack.common.rpc.impl_kombu
<literal>neutron.notifier.rabbit_notifier</literal> in the
<filename>neutron.conf</filename> file:</para>
<xi:include href="tables/neutron-rabbitmq.xml"/>
<xi:include href="tables/neutron-kombu.xml"/>
</section>
<section xml:id="networking-configuration-qpid">
<title>Configure Qpid</title>

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

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_ceilometer_alarm">
<caption>Description of configuration options for alarm</caption>
<col width="50%"/>

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

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_ceilometer_amqp">
<caption>Description of configuration options for amqp</caption>
<col width="50%"/>
@ -28,11 +27,11 @@
</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>(ListOpt) AMQP topic used for OpenStack notifications.</td>
</tr>
</tbody>
</table>

21
doc/common/tables/ceilometer-api.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_ceilometer_api">
<caption>Description of configuration options for api</caption>
<col width="50%"/>
@ -19,12 +18,12 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>enable_v1_api = True</td>
<td>(BoolOpt) Deploy the deprecated v1 API.</td>
<td>api_paste_config = api_paste.ini</td>
<td>(StrOpt) Configuration file for WSGI definition of API.</td>
</tr>
<tr>
<td>max_request_body_size = 114688</td>
<td>(IntOpt) The maximum body size per request, in bytes</td>
<td>(IntOpt) The maximum body size for each request, in bytes.</td>
</tr>
<tr>
<td>pipeline_cfg_file = pipeline.yaml</td>
@ -32,11 +31,11 @@
</tr>
<tr>
<td>policy_default_rule = default</td>
<td>(StrOpt) Rule enforced when requested rule is not found</td>
<td>(StrOpt) Default rule. Enforced when a requested rule is not found.</td>
</tr>
<tr>
<td>policy_file = policy.json</td>
<td>(StrOpt) JSON file containing policy</td>
<td>(StrOpt) The JSON file that defines policies.</td>
</tr>
<tr>
<td>reserved_metadata_length = 256</td>
@ -49,6 +48,10 @@
<tr>
<th colspan="2">[api]</th>
</tr>
<tr>
<td>enable_reverse_dns_lookup = False</td>
<td>(BoolOpt) Set it to False if your environment does not need or have dns server, otherwise it will delay the response from api.</td>
</tr>
<tr>
<td>host = 0.0.0.0</td>
<td>(StrOpt) The listen IP for the ceilometer API server.</td>

121
doc/common/tables/ceilometer-auth.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_ceilometer_auth">
<caption>Description of configuration options for auth</caption>
<col width="50%"/>
@ -15,120 +14,6 @@
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>auth_strategy = keystone</td>
<td>(StrOpt) The strategy to use for auth: noauth or keystone.</td>
</tr>
<tr>
<th colspan="2">[keystone_authtoken]</th>
</tr>
<tr>
<td>admin_password = None</td>
<td>(StrOpt) Keystone account password</td>
</tr>
<tr>
<td>admin_tenant_name = admin</td>
<td>(StrOpt) Keystone service account tenant name to validate user tokens</td>
</tr>
<tr>
<td>admin_token = None</td>
<td>(StrOpt) Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process.</td>
</tr>
<tr>
<td>admin_user = None</td>
<td>(StrOpt) Keystone account username</td>
</tr>
<tr>
<td>auth_admin_prefix = </td>
<td>(StrOpt) Prefix to prepend at the beginning of the path</td>
</tr>
<tr>
<td>auth_host = 127.0.0.1</td>
<td>(StrOpt) Host providing the admin Identity API endpoint</td>
</tr>
<tr>
<td>auth_port = 35357</td>
<td>(IntOpt) Port of the admin Identity API endpoint</td>
</tr>
<tr>
<td>auth_protocol = https</td>
<td>(StrOpt) Protocol of the admin Identity API endpoint(http or https)</td>
</tr>
<tr>
<td>auth_uri = None</td>
<td>(StrOpt) Complete public Identity API endpoint</td>
</tr>
<tr>
<td>auth_version = None</td>
<td>(StrOpt) API version of the admin Identity API endpoint</td>
</tr>
<tr>
<td>cache = None</td>
<td>(StrOpt) Env key for the swift cache</td>
</tr>
<tr>
<td>cafile = None</td>
<td>(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.</td>
</tr>
<tr>
<td>certfile = None</td>
<td>(StrOpt) Required if Keystone server requires client certificate</td>
</tr>
<tr>
<td>delay_auth_decision = False</td>
<td>(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components</td>
</tr>
<tr>
<td>enforce_token_bind = permissive</td>
<td>(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens.</td>
</tr>
<tr>
<td>http_connect_timeout = None</td>
<td>(BoolOpt) Request timeout value for communicating with Identity API server.</td>
</tr>
<tr>
<td>http_request_max_retries = 3</td>
<td>(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server.</td>
</tr>
<tr>
<td>include_service_catalog = True</td>
<td>(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.</td>
</tr>
<tr>
<td>insecure = False</td>
<td>(BoolOpt) Verify HTTPS connections.</td>
</tr>
<tr>
<td>keyfile = None</td>
<td>(StrOpt) Required if Keystone server requires client certificate</td>
</tr>
<tr>
<td>memcache_secret_key = None</td>
<td>(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation.</td>
</tr>
<tr>
<td>memcache_security_strategy = None</td>
<td>(StrOpt) (optional) if defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.</td>
</tr>
<tr>
<td>memcached_servers = None</td>
<td>(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.</td>
</tr>
<tr>
<td>revocation_cache_time = 300</td>
<td>(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.</td>
</tr>
<tr>
<td>signing_dir = None</td>
<td>(StrOpt) Directory used to cache files related to PKI tokens</td>
</tr>
<tr>
<td>token_cache_time = 300</td>
<td>(IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely.</td>
</tr>
<tr>
<th colspan="2">[service_credentials]</th>
</tr>

138
doc/common/tables/ceilometer-auth_token.xml Normal file

@ -0,0 +1,138 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_ceilometer_auth_token">
<caption>Description of configuration options for auth_token</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[keystone_authtoken]</th>
</tr>
<tr>
<td>admin_password = None</td>
<td>(StrOpt) Keystone account password</td>
</tr>
<tr>
<td>admin_tenant_name = admin</td>
<td>(StrOpt) Keystone service account tenant name to validate user tokens</td>
</tr>
<tr>
<td>admin_token = None</td>
<td>(StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead.</td>
</tr>
<tr>
<td>admin_user = None</td>
<td>(StrOpt) Keystone account username</td>
</tr>
<tr>
<td>auth_admin_prefix = </td>
<td>(StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri.</td>
</tr>
<tr>
<td>auth_host = 127.0.0.1</td>
<td>(StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri.</td>
</tr>
<tr>
<td>auth_port = 35357</td>
<td>(IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri.</td>
</tr>
<tr>
<td>auth_protocol = https</td>
<td>(StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri.</td>
</tr>
<tr>
<td>auth_uri = None</td>
<td>(StrOpt) Complete public Identity API endpoint</td>
</tr>
<tr>
<td>auth_version = None</td>
<td>(StrOpt) API version of the admin Identity API endpoint</td>
</tr>
<tr>
<td>cache = None</td>
<td>(StrOpt) Env key for the swift cache</td>
</tr>
<tr>
<td>cafile = None</td>
<td>(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.</td>
</tr>
<tr>
<td>certfile = None</td>
<td>(StrOpt) Required if Keystone server requires client certificate</td>
</tr>
<tr>
<td>check_revocations_for_cached = False</td>
<td>(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the Keystone server.</td>
</tr>
<tr>
<td>delay_auth_decision = False</td>
<td>(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components</td>
</tr>
<tr>
<td>enforce_token_bind = permissive</td>
<td>(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens.</td>
</tr>
<tr>
<td>hash_algorithms = md5</td>
<td>(ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance.</td>
</tr>
<tr>
<td>http_connect_timeout = None</td>
<td>(BoolOpt) Request timeout value for communicating with Identity API server.</td>
</tr>
<tr>
<td>http_request_max_retries = 3</td>
<td>(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server.</td>
</tr>
<tr>
<td>identity_uri = None</td>
<td>(StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/</td>
</tr>
<tr>
<td>include_service_catalog = True</td>
<td>(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.</td>
</tr>
<tr>
<td>insecure = False</td>
<td>(BoolOpt) Verify HTTPS connections.</td>
</tr>
<tr>
<td>keyfile = None</td>
<td>(StrOpt) Required if Keystone server requires client certificate</td>
</tr>
<tr>
<td>memcache_secret_key = None</td>
<td>(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation.</td>
</tr>
<tr>
<td>memcache_security_strategy = None</td>
<td>(StrOpt) (optional) if defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.</td>
</tr>
<tr>
<td>memcached_servers = None</td>
<td>(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.</td>
</tr>
<tr>
<td>revocation_cache_time = 10</td>
<td>(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.</td>
</tr>
<tr>
<td>signing_dir = None</td>
<td>(StrOpt) Directory used to cache files related to PKI tokens</td>
</tr>
<tr>
<td>token_cache_time = 300</td>
<td>(IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely.</td>
</tr>
</tbody>
</table>
</para>

63
doc/common/tables/ceilometer-cells.xml

@ -1,63 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all" xml:id="config_table_ceilometer_cells">
<caption>Description of configuration options for cells</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[cells]</th>
</tr>
<tr>
<td>bandwidth_update_interval = 600</td>
<td>(IntOpt) Seconds between bandwidth updates for cells.</td>
</tr>
<tr>
<td>call_timeout = 60</td>
<td>(IntOpt) Seconds to wait for response from a call to a cell.</td>
</tr>
<tr>
<td>capabilities = hypervisor=xenserver;kvm, os=linux;windows</td>
<td>(ListOpt) Key/Multi-value list with the capabilities of the cell</td>
</tr>
<tr>
<td>cell_type = compute</td>
<td>(StrOpt) Type of cell: api or compute</td>
</tr>
<tr>
<td>enable = False</td>
<td>(BoolOpt) Enable cell functionality</td>
</tr>
<tr>
<td>manager = nova.cells.manager.CellsManager</td>
<td>(StrOpt) Manager for cells</td>
</tr>
<tr>
<td>mute_child_interval = 300</td>
<td>(IntOpt) Number of seconds after which a lack of capability and capacity updates signals the child cell is to be treated as a mute.</td>
</tr>
<tr>
<td>name = nova</td>
<td>(StrOpt) Name of this cell</td>
</tr>
<tr>
<td>reserve_percent = 10.0</td>
<td>(FloatOpt) Percentage of cell capacity to hold in reserve. Affects both memory and disk utilization</td>
</tr>
<tr>
<td>topic = cells</td>
<td>(StrOpt) The topic cells nodes listen on</td>
</tr>
</tbody>
</table>
</para>

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

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_ceilometer_collector">
<caption>Description of configuration options for collector</caption>
<col width="50%"/>
@ -22,17 +21,6 @@
<td>collector_workers = 1</td>
<td>(IntOpt) Number of workers for collector service. A single collector is enabled by default.</td>
</tr>
<tr>
<th colspan="2">[collector]</th>
</tr>
<tr>
<td>udp_address = 0.0.0.0</td>
<td>(StrOpt) Address to which the UDP socket is bound. Set to an empty string to disable.</td>
</tr>
<tr>
<td>udp_port = 4952</td>
<td>(IntOpt) Port to which the UDP socket is bound.</td>
</tr>
<tr>
<th colspan="2">[dispatcher_file]</th>
</tr>

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

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_ceilometer_common">
<caption>Description of configuration options for common</caption>
<col width="50%"/>
@ -24,11 +23,15 @@
</tr>
<tr>
<td>disable_process_locking = False</td>
<td>(BoolOpt) Whether to disable inter-process locks.</td>
<td>(BoolOpt) Enables or disables inter-process locks.</td>
</tr>
<tr>
<td>fatal_deprecations = False</td>
<td>(BoolOpt) Make deprecations fatal</td>
<td>(BoolOpt) Enables or disables fatal status of deprecations.</td>
</tr>
<tr>
<td>fatal_exception_format_errors = False</td>
<td>(BoolOpt) Make exception message format errors fatal</td>
</tr>
<tr>
<td>lock_path = None</td>

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

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_ceilometer_database">
<caption>Description of configuration options for database</caption>
<col width="50%"/>
@ -22,18 +21,6 @@
<td>database_connection = None</td>
<td>(StrOpt) DEPRECATED - Database connection string.</td>
</tr>
<tr>
<td>mysql_engine = InnoDB</td>
<td>(StrOpt) MySQL engine to use.</td>
</tr>
<tr>
<td>sqlite_db = ceilometer.sqlite</td>
<td>(StrOpt) The file name to use with SQLite</td>
</tr>
<tr>
<td>sqlite_synchronous = True</td>
<td>(BoolOpt) If True, SQLite uses synchronous mode</td>
</tr>
<tr>
<th colspan="2">[database]</th>
</tr>
@ -42,7 +29,7 @@
<td>(StrOpt) The backend to use for db</td>
</tr>
<tr>
<td>connection = sqlite:////usr/lib/python/site-packages/ceilometer/openstack/common/db/$sqlite_db</td>
<td>connection = None</td>
<td>(StrOpt) The SQLAlchemy connection string used to connect to the database</td>
</tr>
<tr>
@ -53,6 +40,22 @@
<td>connection_trace = False</td>
<td>(BoolOpt) Add python stack traces to SQL as comment strings</td>
</tr>
<tr>
<td>db_inc_retry_interval = True</td>
<td>(BoolOpt) Whether to increase interval between db connection retries, up to db_max_retry_interval</td>
</tr>
<tr>
<td>db_max_retries = 20</td>
<td>(IntOpt) maximum db connection retries before error is raised. (setting -1 implies an infinite retry count)</td>
</tr>
<tr>
<td>db_max_retry_interval = 10</td>
<td>(IntOpt) max seconds between db connection retries, if db_inc_retry_interval is enabled</td>
</tr>
<tr>
<td>db_retry_interval = 1</td>
<td>(IntOpt) seconds between db connection retries</td>
</tr>
<tr>
<td>idle_timeout = 3600</td>
<td>(IntOpt) Timeout before idle sql connections are reaped</td>
@ -73,6 +76,10 @@
<td>min_pool_size = 1</td>
<td>(IntOpt) Minimum number of SQL connections to keep open in a pool</td>
</tr>
<tr>
<td>mysql_sql_mode = TRADITIONAL</td>
<td>(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=</td>
</tr>
<tr>
<td>pool_timeout = None</td>
<td>(IntOpt) If set, use this value for pool_timeout with sqlalchemy</td>
@ -82,13 +89,25 @@
<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>
<td>sqlite_db = ceilometer.sqlite</td>
<td>(StrOpt) The file name to use with SQLite</td>
</tr>
<tr>
<td>sqlite_synchronous = True</td>
<td>(BoolOpt) If True, SQLite uses synchronous mode</td>
</tr>
<tr>
<td>time_to_live = -1</td>
<td>(IntOpt) Number of seconds that samples are kept in the database for (&lt;= 0 means forever).</td>
</tr>
<tr>
<td>use_db_reconnect = False</td>
<td>(BoolOpt) Enable the experimental use of database reconnect on connection lost</td>
</tr>
<tr>
<td>use_tpool = False</td>
<td>(BoolOpt) Enable the experimental use of thread pooling for all DB API calls</td>
</tr>
</tbody>
</table>
</para>

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

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_ceilometer_events">
<caption>Description of configuration options for events</caption>
<col width="50%"/>

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

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_ceilometer_exchange">
<caption>Description of configuration options for exchange</caption>
<col width="50%"/>
@ -26,10 +25,6 @@
<td>control_exchange = openstack</td>
<td>(StrOpt) AMQP exchange to connect to if using RabbitMQ or Qpid</td>
</tr>
<tr>
<td>default_publisher_id = None</td>
<td>(StrOpt) Default publisher_id for outgoing notifications</td>
</tr>
<tr>
<td>glance_control_exchange = glance</td>
<td>(StrOpt) Exchange name for Glance notifications.</td>

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

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_ceilometer_inspector">
<caption>Description of configuration options for inspector</caption>
<col width="50%"/>

54
doc/common/tables/ceilometer-logging.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_ceilometer_logging">
<caption>Description of configuration options for logging</caption>
<col width="50%"/>
@ -23,32 +22,28 @@
<td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).</td>
</tr>
<tr>
<td>default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=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>
<td>default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN</td>
<td>(ListOpt) List of logger=LEVEL pairs.</td>
</tr>
<tr>
<td>instance_format = "[instance: %(uuid)s] "</td>
<td>(StrOpt) If an instance is passed with the log message, format it like this</td>
<td>(StrOpt) The format for an instance that is passed with the log message. </td>
</tr>
<tr>
<td>instance_uuid_format = "[instance: %(uuid)s] "</td>
<td>(StrOpt) If an instance UUID is passed with the log message, format it like this</td>
<td>(StrOpt) The format for an instance UUID that is passed with the log message. </td>
</tr>
<tr>
<td>log_config_append = None</td>
<td>(StrOpt) The name of logging configuration file. It does not disable existing loggers, but just appends specified logging configuration to any other existing logging options. Please see the Python logging module documentation for details on logging configuration files.</td>
<td>(StrOpt) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation.</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>
@ -60,55 +55,44 @@
</tr>
<tr>
<td>logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s</td>
<td>(StrOpt) Format string to use for log messages with context</td>
<td>(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) Enables or disables publication of 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. Existing syslog format is DEPRECATED during I, and then will be changed in J to honor RFC5424</td>
<td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424.</td>
</tr>
<tr>
<td>use_syslog_rfc_format = False</td>
<td>(BoolOpt) (Optional) Use syslog rfc5424 format for logging. If enabled, will add APP-NAME (RFC5424) before the MSG part of the syslog message. The old format without APP-NAME is deprecated in I, and will be removed in J.</td>
<td>(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in I, and will be removed in J.</td>
</tr>
<tr>
<td>verbose = False</td>
<td>(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).</td>
</tr>
<tr>
<th colspan="2">[audit]</th>
</tr>
<tr>
<td>api_audit_map = api_audit_map.conf</td>
<td>(StrOpt) File containing mapping for api paths and service endpoints</td>
</tr>
<tr>
<td>namespace = openstack</td>
<td>(StrOpt) namespace prefix for generated id</td>
</tr>
</tbody>
</table>
</para>

69
doc/common/tables/ceilometer-nova_cells.xml Normal file

@ -0,0 +1,69 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_ceilometer_nova_cells">
<caption>Description of configuration options for nova_cells</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[cells]</th>
</tr>
<tr>
<td>bandwidth_update_interval = 600</td>
<td>(IntOpt) Seconds between bandwidth updates for cells.</td>
</tr>
<tr>
<td>call_timeout = 60</td>
<td>(IntOpt) Seconds to wait for response from a call to a cell.</td>
</tr>
<tr>
<td>capabilities = hypervisor=xenserver;kvm, os=linux;windows</td>
<td>(ListOpt) Key/Multi-value list with the capabilities of the cell</td>
</tr>
<tr>
<td>cell_type = compute</td>
<td>(StrOpt) Type of cell: api or compute</td>
</tr>
<tr>
<td>enable = False</td>
<td>(BoolOpt) Enable cell functionality</td>
</tr>
<tr>
<td>manager = nova.cells.manager.CellsManager</td>
<td>(StrOpt) Manager for cells</td>
</tr>
<tr>
<td>mute_child_interval = 300</td>
<td>(IntOpt) Number of seconds after which a lack of capability and capacity updates signals the child cell is to be treated as a mute.</td>
</tr>
<tr>
<td>name = nova</td>
<td>(StrOpt) Name of this cell</td>
</tr>
<tr>
<td>reserve_percent = 10.0</td>
<td>(FloatOpt) Percentage of cell capacity to hold in reserve. Affects both memory and disk utilization</td>
</tr>
<tr>
<td>topic = cells</td>
<td>(StrOpt) The topic cells nodes listen on</td>
</tr>
<tr>
<th colspan="2">[upgrade_levels]</th>
</tr>
<tr>
<td>cells = None</td>
<td>(StrOpt) Set a version cap for messages sent to local cells services</td>
</tr>
</tbody>
</table>
</para>

38
doc/common/tables/ceilometer-nova_import.xml Normal file

@ -0,0 +1,38 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_ceilometer_nova_import">
<caption>Description of configuration options for nova_import</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>enable_new_services = True</td>
<td>(BoolOpt) Services to be added to the available pool on create</td>
</tr>
<tr>
<td>instance_name_template = instance-%08x</td>
<td>(StrOpt) Template string to be used to generate instance names</td>
</tr>
<tr>
<td>network_api_class = nova.network.api.API</td>
<td>(StrOpt) The full class name of the network API class to use</td>
</tr>
<tr>
<td>snapshot_name_template = snapshot-%s</td>
<td>(StrOpt) Template string to be used to generate snapshot names</td>
</tr>
</tbody>
</table>
</para>

25
doc/common/tables/ceilometer-qpid.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_ceilometer_qpid">
<caption>Description of configuration options for qpid</caption>
<col width="50%"/>
@ -20,35 +19,35 @@
</tr>
<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>(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>(IntOpt) 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) Whether to disable the Nagle algorithm.</td>
</tr>
<tr>
<td>qpid_topology_version = 1</td>
@ -56,7 +55,7 @@
</tr>
<tr>
<td>qpid_username = </td>
<td>(StrOpt) Username for qpid connection</td>
<td>(StrOpt) Username for Qpid connection.</td>
</tr>
</tbody>
</table>

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

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_ceilometer_rabbitmq">
<caption>Description of configuration options for rabbitmq</caption>
<col width="50%"/>
@ -22,21 +21,25 @@
<td>fake_rabbit = False</td>
<td>(BoolOpt) If passed, use a fake RabbitMQ provider</td>
</tr>
<tr>
<td>kombu_reconnect_delay = 1.0</td>
<td>(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.</td>
</tr>
<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) If SSL is enabled, the SSL version to use. Valid values are TLSv1, SSLv23 and SSLv3. SSLv2 might be available on some distributions.</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>
<tr>
<td>rabbit_ha_queues = False</td>
@ -44,43 +47,47 @@
</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>(ListOpt) RabbitMQ HA cluster host:port pairs.</td>
</tr>
<tr>
<td>rabbit_login_method = AMQPLAIN</td>
<td>(StrOpt) the RabbitMQ login method</td>
</tr>
<tr>
<td>rabbit_max_retries = 0</td>
<td>(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count)</td>
<td>(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).</td>
</tr>
<tr>
<td>rabbit_password = guest</td>
<td>(StrOpt) The RabbitMQ password</td>
<td>(StrOpt) The RabbitMQ password.</td>
</tr>
<tr>
<td>rabbit_port = 5672</td>
<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>

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

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_ceilometer_redis">
<caption>Description of configuration options for redis</caption>
<col width="50%"/>
@ -24,33 +23,18 @@
</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>
<th colspan="2">[matchmaker_redis]</th>
</tr>
<tr>
<td>host = 127.0.0.1</td>
<td>(StrOpt) Host to locate redis</td>
</tr>
<tr>
<td>password = None</td>
<td>(StrOpt) Password for Redis server. (optional)</td>
</tr>
<tr>
<td>port = 6379</td>
<td>(IntOpt) Use this port to connect to redis host.</td>
</tr>
<tr>
<th colspan="2">[matchmaker_ring]</th>
</tr>
<tr>
<td>ringfile = /etc/oslo/matchmaker_ring.json</td>
<td>(StrOpt) Matchmaker ring file (JSON)</td>
<td>(StrOpt) Matchmaker ring file (JSON).</td>
</tr>
</tbody>
</table>

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

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_ceilometer_rpc">
<caption>Description of configuration options for rpc</caption>
<col width="50%"/>
@ -26,6 +25,14 @@
<td>dispatcher = ['database']</td>
<td>(MultiStrOpt) Dispatcher to process data.</td>
</tr>
<tr>
<td>password = None</td>
<td>(StrOpt) Password for Redis server (optional).</td>
</tr>
<tr>
<td>port = 6379</td>
<td>(IntOpt) Use this port to connect to redis host.</td>
</tr>
<tr>
<td>rpc_backend = ceilometer.openstack.common.rpc.impl_kombu</td>
<td>(StrOpt) The messaging module to use, defaults to kombu.</td>
@ -52,7 +59,7 @@
</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 = oslo</td>
@ -60,20 +67,31 @@
</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 = ceilometer.openstack.common.rpc.matchmaker.MatchMakerLocalhost</td>
<td>(StrOpt) MatchMaker driver</td>
<td>rpc_zmq_matchmaker = oslo.messaging._drivers.matchmaker.MatchMakerLocalhost</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>
</tr>
<tr>
<td>transport_url = None</td>
<td>(StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration.</td>
</tr>
<tr>
<th colspan="2">[notification]</th>
</tr>
<tr>
<td>messaging_urls = []</td>
<td>(MultiStrOpt) Messaging URLs to listen for notifications. Example: transport://user:pass@host1:port[,hostN:portN]/virtual_host (DEFAULT/transport_url is used if empty)</td>
</tr>
<tr>
<th colspan="2">[publisher]</th>
</tr>
@ -88,13 +106,6 @@
<td>metering_topic = metering</td>
<td>(StrOpt) The topic that ceilometer uses for metering messages.</td>
</tr>
<tr>
<th colspan="2">[rpc_notifier2]</th>
</tr>
<tr>
<td>topics = notifications</td>
<td>(ListOpt) AMQP topic(s) used for OpenStack notifications</td>
</tr>
</tbody>
</table>
</para>

35
doc/common/tables/ceilometer-ssl.xml

@ -1,35 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all" xml:id="config_table_ceilometer_ssl">
<caption>Description of configuration options for ssl</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[ssl]</th>
</tr>
<tr>
<td>ca_file = None</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 the server securely</td>
</tr>
<tr>
<td>key_file = None</td>
<td>(StrOpt) Private key file to use when starting the server securely</td>
</tr>
</tbody>
</table>
</para>

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

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_ceilometer_swift">
<caption>Description of configuration options for swift</caption>
<col width="50%"/>

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

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_ceilometer_vmware">
<caption>Description of configuration options for vmware</caption>
<col width="50%"/>
@ -38,6 +37,10 @@
<td>task_poll_interval = 0.5</td>
<td>(FloatOpt) Sleep time in seconds for polling an ongoing async task</td>
</tr>
<tr>
<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>
</table>
</para>

23
doc/common/tables/cinder-api.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_api">
<caption>Description of configuration options for api</caption>
<col width="50%"/>
@ -24,7 +23,11 @@
</tr>
<tr>
<td>api_rate_limit = True</td>
<td>(BoolOpt) whether to rate limit the api</td>
<td>(BoolOpt) Enables or disables rate limit of the API.</td>
</tr>
<tr>
<td>az_cache_duration = 3600</td>
<td>(IntOpt) Cache volume availability zones in memory for the provided duration in seconds</td>
</tr>
<tr>
<td>backdoor_port = None</td>
@ -48,7 +51,7 @@
</tr>
<tr>
<td>osapi_max_limit = 1000</td>
<td>(IntOpt) the maximum number of items returned in a single response from a collection resource</td>
<td>(IntOpt) The maximum number of items that a collection resource returns in a single response</td>
</tr>
<tr>
<td>osapi_max_request_body_size = 114688</td>
@ -68,15 +71,11 @@
</tr>
<tr>
<td>osapi_volume_listen = 0.0.0.0</td>
<td>(StrOpt) IP address for OpenStack Volume API to listen</td>
<td>(StrOpt) IP address on which OpenStack Volume API listens</td>
</tr>
<tr>
<td>osapi_volume_listen_port = 8776</td>
<td>(IntOpt) port for os volume api to listen</td>
</tr>
<tr>
<td>osapi_volume_workers = None</td>
<td>(IntOpt) Number of workers for OpenStack Volume API service</td>
<td>(IntOpt) Port on which OpenStack Volume API listens</td>
</tr>
<tr>
<td>transfer_api_class = cinder.transfer.api.API</td>

7
doc/common/tables/cinder-auth.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_auth">
<caption>Description of configuration options for auth</caption>
<col width="50%"/>

31
doc/common/tables/cinder-auth_token.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_auth_token">
<caption>Description of configuration options for auth_token</caption>
<col width="50%"/>
@ -35,7 +34,7 @@
</tr>
<tr>
<td>admin_token = None</td>
<td>(StrOpt) Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process.</td>
<td>(StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead.</td>
</tr>
<tr>
<td>admin_user = None</td>
@ -43,19 +42,19 @@
</tr>
<tr>
<td>auth_admin_prefix = </td>
<td>(StrOpt) Prefix to prepend at the beginning of the path</td>
<td>(StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri.</td>
</tr>
<tr>
<td>auth_host = 127.0.0.1</td>
<td>(StrOpt) Host providing the admin Identity API endpoint</td>
<td>(StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri.</td>
</tr>
<tr>
<td>auth_port = 35357</td>
<td>(IntOpt) Port of the admin Identity API endpoint</td>
<td>(IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri.</td>
</tr>
<tr>
<td>auth_protocol = https</td>
<td>(StrOpt) Protocol of the admin Identity API endpoint(http or https)</td>
<td>(StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri.</td>
</tr>
<tr>
<td>auth_uri = None</td>
@ -77,6 +76,10 @@
<td>certfile = None</td>
<td>(StrOpt) Required if Keystone server requires client certificate</td>
</tr>
<tr>
<td>check_revocations_for_cached = False</td>
<td>(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the Keystone server.</td>
</tr>
<tr>
<td>delay_auth_decision = False</td>
<td>(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components</td>
@ -85,6 +88,10 @@
<td>enforce_token_bind = permissive</td>
<td>(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens.</td>
</tr>
<tr>
<td>hash_algorithms = md5</td>
<td>(ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance.</td>
</tr>
<tr>
<td>http_connect_timeout = None</td>
<td>(BoolOpt) Request timeout value for communicating with Identity API server.</td>
@ -93,6 +100,10 @@
<td>http_request_max_retries = 3</td>
<td>(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server.</td>
</tr>
<tr>
<td>identity_uri = None</td>
<td>(StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/</td>
</tr>
<tr>
<td>include_service_catalog = True</td>
<td>(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.</td>
@ -118,7 +129,7 @@
<td>(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.</td>
</tr>
<tr>
<td>revocation_cache_time = 300</td>
<td>revocation_cache_time = 10</td>
<td>(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.</td>
</tr>
<tr>

11
doc/common/tables/cinder-backups.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_backups">
<caption>Description of configuration options for backups</caption>
<col width="50%"/>
@ -32,7 +31,7 @@
</tr>
<tr>
<td>backup_manager = cinder.backup.manager.BackupManager</td>
<td>(StrOpt) full class name for the Manager for volume backup</td>
<td>(StrOpt) Full class name for the Manager for volume backup</td>
</tr>
<tr>
<td>backup_metadata_version = 1</td>
@ -44,7 +43,7 @@
</tr>
<tr>
<td>backup_topic = cinder-backup</td>
<td>(StrOpt) the topic volume backup nodes listen on</td>
<td>(StrOpt) The topic that volume backup nodes listen on</td>
</tr>
<tr>
<td>snapshot_name_template = snapshot-%s</td>

7
doc/common/tables/cinder-backups_ceph.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_backups_ceph">
<caption>Description of configuration options for backups_ceph</caption>
<col width="50%"/>

7
doc/common/tables/cinder-backups_swift.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_backups_swift">
<caption>Description of configuration options for backups_swift</caption>
<col width="50%"/>

7
doc/common/tables/cinder-backups_tsm.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_backups_tsm">
<caption>Description of configuration options for backups_tsm</caption>
<col width="50%"/>

7
doc/common/tables/cinder-block-device.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_block-device">
<caption>Description of configuration options for block-device</caption>
<col width="50%"/>

88
doc/common/tables/cinder-common.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_common">
<caption>Description of configuration options for common</caption>
<col width="50%"/>
@ -28,15 +27,15 @@
</tr>
<tr>
<td>default_availability_zone = None</td>
<td>(StrOpt) default availability zone to use when creating a new volume. If this is not set then we use the value from the storage_availability_zone option as the default availability_zone for new volumes.</td>
<td>(StrOpt) Default availability zone for new volumes. If not set, the storage_availability_zone option value is used as the default for new volumes.</td>
</tr>
<tr>
<td>default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN</td>
<td>(ListOpt) List of logger=LEVEL pairs</td>
<td>(ListOpt) List of logger=LEVEL pairs.</td>
</tr>
<tr>
<td>default_volume_type = None</td>
<td>(StrOpt) default volume type to use</td>
<td>(StrOpt) Default volume type to use</td>
</tr>
<tr>
<td>disable_process_locking = False</td>
@ -48,7 +47,7 @@
</tr>
<tr>
<td>fatal_deprecations = False</td>
<td>(BoolOpt) Make deprecations fatal</td>
<td>(BoolOpt) Enables or disables fatal status of deprecations.</td>
</tr>
<tr>
<td>fatal_exception_format_errors = False</td>
@ -72,15 +71,15 @@
</tr>
<tr>
<td>log_config_append = None</td>
<td>(StrOpt) The name of logging configuration file. It does not disable existing loggers, but just appends specified logging configuration to any other existing logging options. Please see the Python logging module documentation for details on logging configuration files.</td>
<td>(StrOpt) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation.</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>
@ -92,19 +91,19 @@
</tr>
<tr>
<td>logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s</td>
<td>(StrOpt) Format string to use for log messages with context</td>
<td>(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>monkey_patch = False</td>
@ -116,7 +115,7 @@
</tr>
<tr>
<td>my_ip = 10.0.0.1</td>
<td>(StrOpt) ip address of this host</td>
<td>(StrOpt) IP address of this host</td>
</tr>
<tr>
<td>no_snapshot_gb_quota = False</td>
@ -124,15 +123,15 @@
</tr>
<tr>
<td>num_shell_tries = 3</td>
<td>(IntOpt) number of times to attempt to run flakey shell commands</td>
<td>(IntOpt) Number of times to attempt to run flakey shell commands</td>
</tr>
<tr>
<td>periodic_fuzzy_delay = 60</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, in seconds, to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0)</td>
</tr>
<tr>
<td>periodic_interval = 60</td>
<td>(IntOpt) seconds between running periodic tasks</td>
<td>(IntOpt) Interval, in seconds, between running periodic tasks</td>
</tr>
<tr>
<td>policy_default_rule = default</td>
@ -144,7 +143,7 @@
</tr>
<tr>
<td>report_interval = 10</td>
<td>(IntOpt) seconds between nodes reporting state to datastore</td>
<td>(IntOpt) Interval, in seconds, between nodes reporting state to datastore</td>
</tr>
<tr>
<td>reserved_percentage = 0</td>
@ -160,15 +159,7 @@
</tr>
<tr>
<td>service_down_time = 60</td>
<td>(IntOpt) maximum time since last check-in for up service</td>
</tr>
<tr>
<td>sqlite_db = cinder.sqlite</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>
<td>(IntOpt) Maximum time since last check-in for a service to be considered up</td>
</tr>
<tr>
<td>ssl_ca_file = None</td>
@ -188,11 +179,23 @@
</tr>
<tr>
<td>storage_availability_zone = nova</td>
<td>(StrOpt) availability zone of this node</td>
<td>(StrOpt) Availability zone of this node</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>tcp_keepalive = True</td>
<td>(BoolOpt) Sets the value of TCP_KEEPALIVE (True/False) for each server socket.</td>
</tr>
<tr>
<td>tcp_keepalive_count = None</td>
<td>(IntOpt) Sets the value of TCP_KEEPCNT for each server socket. Not supported on OS X.</td>
</tr>
<tr>
<td>tcp_keepalive_interval = None</td>
<td>(IntOpt) Sets the value of TCP_KEEPINTVL in seconds for each server socket. Not supported on OS X.</td>
</tr>
<tr>
<td>tcp_keepidle = 600</td>
@ -200,7 +203,7 @@
</tr>
<tr>
<td>until_refresh = 0</td>
<td>(IntOpt) count of reservations until usage is refreshed</td>
<td>(IntOpt) Count of reservations until usage is refreshed</td>
</tr>
<tr>
<td>use_forwarded_for = False</td>
@ -208,35 +211,20 @@
</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. Existing syslog format is DEPRECATED during I, and then will be changed in J to honor RFC5424</td>
<td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will chang in J to honor RFC5424.</td>
</tr>
<tr>
<td>use_syslog_rfc_format = False</td>
<td>(BoolOpt) (Optional) Use syslog rfc5424 format for logging. If enabled, will add APP-NAME (RFC5424) before the MSG part of the syslog message. The old format without APP-NAME is deprecated in I, and will be removed in J.</td>
<td>(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in I, and will be removed in J.</td>
</tr>
<tr>
<td>verbose = False</td>
<td>(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).</td>
</tr>
<tr>
<th colspan="2">[database]</th>
</tr>
<tr>
<td>idle_timeout = 3600</td>
<td>(IntOpt) timeout before idle sql connections are reaped</td>
</tr>
<tr>
<td>retry_interval = 10</td>
<td>(IntOpt) interval between retries of opening a sql connection</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>

11
doc/common/tables/cinder-compute.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_compute">
<caption>Description of configuration options for compute</caption>
<col width="50%"/>
@ -32,7 +31,7 @@
</tr>
<tr>
<td>nova_catalog_info = compute:nova:publicURL</td>
<td>(StrOpt) Info to match when looking for nova in the service catalog. Format is : separated values of the form: &lt;service_type&gt;:&lt;service_name&gt;:&lt;endpoint_type&gt;</td>
<td>(StrOpt) Match this value when searching for nova in the service catalog. Format is: separated values of the form: &lt;service_type&gt;:&lt;service_name&gt;:&lt;endpoint_type&gt;</td>
</tr>
<tr>
<td>nova_endpoint_admin_template = None</td>
@ -44,7 +43,7 @@
</tr>
<tr>
<td>os_region_name = None</td>
<td>(StrOpt) region name of this node</td>
<td>(StrOpt) Region name of this node</td>
</tr>
</tbody>
</table>

35
doc/common/tables/cinder-connection.xml

@ -1,35 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all" xml:id="config_table_cinder_connection">
<caption>Description of configuration options for connection</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[database]</th>
</tr>
<tr>
<td>connection = sqlite:///$state_path/$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>connection_trace = False</td>
<td>(BoolOpt) Add python stack traces to SQL as comment strings</td>
</tr>
</tbody>
</table>
</para>

7
doc/common/tables/cinder-coraid.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_coraid">
<caption>Description of configuration options for coraid</caption>
<col width="50%"/>

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

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_database">
<caption>Description of configuration options for database</caption>
<col width="50%"/>
@ -24,7 +23,94 @@
</tr>
<tr>
<td>db_driver = cinder.db</td>
<td>(StrOpt) driver to use for database access</td>
<td>(StrOpt) Driver to use for database access</td>
</tr>
<tr>
<td>sqlite_clean_db = clean.sqlite</td>
<td>(StrOpt) File name of clean sqlite db</td>
</tr>
<tr>
<th colspan="2">[database]</th>
</tr>
<tr>
<td>backend = sqlalchemy</td>
<td>(StrOpt) The backend to use for db</td>
</tr>
<tr>
<td>connection = sqlite:///$state_path/$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>connection_trace = False</td>
<td>(BoolOpt) Add python stack traces to SQL as comment strings</td>
</tr>
<tr>
<td>db_inc_retry_interval = True</td>
<td>(BoolOpt) Whether to increase interval between db connection retries, up to db_max_retry_interval</td>
</tr>
<tr>
<td>db_max_retries = 20</td>
<td>(IntOpt) maximum db connection retries before error is raised. (setting -1 implies an infinite retry count)</td>
</tr>
<tr>
<td>db_max_retry_interval = 10</td>
<td>(IntOpt) max seconds between db connection retries, if db_inc_retry_interval is enabled</td>
</tr>
<tr>
<td>db_retry_interval = 1</td>
<td>(IntOpt) seconds between db connection retries</td>
</tr>
<tr>
<td>idle_timeout = 3600</td>
<td>(IntOpt) Timeout before idle sql connections are reaped</td>
</tr>
<tr>
<td>max_overflow = None</td>
<td>(IntOpt) If set, use this value for max_overflow with sqlalchemy</td>
</tr>
<tr>
<td>max_pool_size = None</td>
<td>(IntOpt) Maximum number of SQL connections to keep open in a pool</td>
</tr>
<tr>
<td>max_retries = 10</td>
<td>(IntOpt) Maximum db connection retries during startup. (setting -1 implies an infinite retry count)</td>
</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>mysql_sql_mode = TRADITIONAL</td>
<td>(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=</td>
</tr>
<tr>
<td>pool_timeout = None</td>
<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>sqlite_db = cinder.sqlite</td>
<td>(StrOpt) The file name to use with SQLite</td>
</tr>
<tr>
<td>sqlite_synchronous = True</td>
<td>(BoolOpt) If True, SQLite uses synchronous mode</td>
</tr>
<tr>
<td>use_db_reconnect = False</td>
<td>(BoolOpt) Enable the experimental use of database reconnect on connection lost</td>
</tr>
<tr>
<td>use_tpool = False</td>
<td>(BoolOpt) Enable the experimental use of thread pooling for all DB API calls</td>
</tr>
</tbody>
</table>

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

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_emc">
<caption>Description of configuration options for emc</caption>
<col width="50%"/>
@ -20,7 +19,7 @@
</tr>
<tr>
<td>cinder_emc_config_file = /etc/cinder/cinder_emc_config.xml</td>
<td>(StrOpt) use this file for cinder emc plugin config data</td>
<td>(StrOpt) The configuration file for the Cinder EMC driver</td>
</tr>
<tr>
<td>max_luns_per_storage_group = 256</td>

7
doc/common/tables/cinder-eqlx.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_eqlx">
<caption>Description of configuration options for eqlx</caption>
<col width="50%"/>

17
doc/common/tables/cinder-hds-hus.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_hds-hus">
<caption>Description of configuration options for hds-hus</caption>
<col width="50%"/>
@ -20,7 +19,15 @@
</tr>
<tr>
<td>hds_cinder_config_file = /opt/hds/hus/cinder_hus_conf.xml</td>
<td>(StrOpt) configuration file for HDS cinder plugin for HUS</td>
<td>(StrOpt) The configuration file for the Cinder HDS driver for HUS</td>
</tr>
<tr>
<td>hds_hnas_iscsi_config_file = /opt/hds/hnas/cinder_iscsi_conf.xml</td>
<td>(StrOpt) configuration file for HDS iSCSI cinder plugin</td>
</tr>
<tr>
<td>hds_hnas_nfs_config_file = /opt/hds/hnas/cinder_nfs_conf.xml</td>
<td>(StrOpt) configuration file for HDS NFS cinder plugin</td>
</tr>
</tbody>
</table>

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

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_hp3par">
<caption>Description of configuration options for hp3par</caption>
<col width="50%"/>

7
doc/common/tables/cinder-hplefthand.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_hplefthand">
<caption>Description of configuration options for hplefthand</caption>
<col width="50%"/>

7
doc/common/tables/cinder-hpmsa.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_hpmsa">
<caption>Description of configuration options for hpmsa</caption>
<col width="50%"/>

9
doc/common/tables/cinder-huawei.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_huawei">
<caption>Description of configuration options for huawei</caption>
<col width="50%"/>
@ -20,7 +19,7 @@
</tr>
<tr>
<td>cinder_huawei_conf_file = /etc/cinder/cinder_huawei_conf.xml</td>
<td>(StrOpt) config data for cinder huawei plugin</td>
<td>(StrOpt) The configuration file for the Cinder Huawei driver</td>
</tr>
</tbody>
</table>

25
doc/common/tables/cinder-images.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_images">
<caption>Description of configuration options for images</caption>
<col width="50%"/>
@ -28,19 +27,23 @@
</tr>
<tr>
<td>glance_api_servers = $glance_host:$glance_port</td>
<td>(ListOpt) A list of the glance api servers available to cinder ([hostname|ip]:port)</td>
<td>(ListOpt) A list of the glance API servers available to cinder ([hostname|ip]:port)</td>
</tr>
<tr>
<td>glance_api_ssl_compression = False</td>
<td>(BoolOpt) Whether to attempt to negotiate SSL layer compression when using SSL (https) requests. Set to False to disable SSL layer compression. In some cases disabling this may improve data throughput, eg when high network bandwidth is available and you are using already compressed image formats such as qcow2 .</td>
<td>(BoolOpt) Enables or disables negotiation of SSL layer compression. In some cases disabling compression can improve data throughput, such as when high network bandwidth is available and you use compressed image formats like qcow2.</td>
</tr>
<tr>
<td>glance_api_version = 1</td>
<td>(IntOpt) Version of the glance api to use</td>
<td>(IntOpt) Version of the glance API to use</td>
</tr>
<tr>
<td>glance_core_properties = checksum, container_format, disk_format, image_name, image_id, min_disk, min_ram, name, size</td>
<td>(ListOpt) Default core properties of image</td>
</tr>
<tr>
<td>glance_host = $my_ip</td>
<td>(StrOpt) default glance hostname or ip</td>
<td>(StrOpt) Default glance host name or IP</td>
</tr>
<tr>
<td>glance_num_retries = 0</td>
@ -48,7 +51,7 @@
</tr>
<tr>
<td>glance_port = 9292</td>
<td>(IntOpt) default glance port</td>
<td>(IntOpt) Default glance port</td>
</tr>
<tr>
<td>glance_request_timeout = None</td>
@ -60,11 +63,11 @@
</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>(StrOpt) The format for an instance that is passed with the log message. </td>
</tr>
<tr>
<td>instance_uuid_format = "[instance: %(uuid)s] "</td>
<td>(StrOpt) If an instance UUID is passed with the log message, format it like this</td>
<td>(StrOpt) The format for an instance UUID that is passed with the log message. </td>
</tr>
<tr>
<td>use_multipath_for_image_xfer = False</td>

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

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_keymgr">
<caption>Description of configuration options for keymgr</caption>
<col width="50%"/>

7
doc/common/tables/cinder-lvm.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_lvm">
<caption>Description of configuration options for lvm</caption>
<col width="50%"/>

7
doc/common/tables/cinder-nas.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_nas">
<caption>Description of configuration options for nas</caption>
<col width="50%"/>

7
doc/common/tables/cinder-netapp_7mode_iscsi.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_netapp_7mode_iscsi">
<caption>Description of configuration options for netapp_7mode_iscsi</caption>
<col width="50%"/>

7
doc/common/tables/cinder-netapp_7mode_nfs.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_netapp_7mode_nfs">
<caption>Description of configuration options for netapp_7mode_nfs</caption>
<col width="50%"/>

7
doc/common/tables/cinder-netapp_cdot_iscsi.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_netapp_cdot_iscsi">
<caption>Description of configuration options for netapp_cdot_iscsi</caption>
<col width="50%"/>

7
doc/common/tables/cinder-netapp_cdot_nfs.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_netapp_cdot_nfs">
<caption>Description of configuration options for netapp_cdot_nfs</caption>
<col width="50%"/>

7
doc/common/tables/cinder-netapp_eseries_iscsi.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_netapp_eseries_iscsi">
<caption>Description of configuration options for netapp_eseries_iscsi</caption>
<col width="50%"/>

17
doc/common/tables/cinder-nexenta_iscsi.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_nexenta_iscsi">
<caption>Description of configuration options for nexenta_iscsi</caption>
<col width="50%"/>
@ -20,7 +19,7 @@
</tr>
<tr>
<td>nexenta_blocksize = </td>
<td>(StrOpt) block size for volumes (blank=default,8KB)</td>
<td>(StrOpt) Block size for volumes (default=blank means 8KB)</td>
</tr>
<tr>
<td>nexenta_host = </td>
@ -56,15 +55,15 @@
</tr>
<tr>
<td>nexenta_sparse = False</td>
<td>(BoolOpt) flag to create sparse volumes</td>
<td>(BoolOpt) Enables or disables the creation of sparse volumes</td>
</tr>
<tr>
<td>nexenta_sparsed_volumes = True</td>
<td>(BoolOpt) Create volumes as sparsed files which take no space.If set to False volume is created as regular file.In such case volume creation takes a lot of time.</td>
<td>(BoolOpt) Enables or disables the creation of volumes as sparsed files that take no space. If disabled (False), volume is created as a regular file, which takes a long time.</td>
</tr>
<tr>
<td>nexenta_target_group_prefix = cinder/</td>
<td>(StrOpt) prefix for iSCSI target groups on SA</td>
<td>(StrOpt) Prefix for iSCSI target groups on SA</td>
</tr>
<tr>
<td>nexenta_target_prefix = iqn.1986-03.com.sun:02:cinder-</td>
@ -76,7 +75,7 @@
</tr>
<tr>
<td>nexenta_volume = cinder</td>
<td>(StrOpt) pool on SA that will hold all volumes</td>
<td>(StrOpt) SA Pool that holds all volumes</td>
</tr>
</tbody>
</table>

9
doc/common/tables/cinder-nexenta_nfs.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_nexenta_nfs">
<caption>Description of configuration options for nexenta_nfs</caption>
<col width="50%"/>
@ -20,7 +19,7 @@
</tr>
<tr>
<td>nexenta_mount_point_base = $state_path/mnt</td>
<td>(StrOpt) Base dir containing mount points for nfs shares</td>
<td>(StrOpt) Base directory that contains NFS share mount points</td>
</tr>
<tr>
<td>nexenta_nms_cache_volroot = True</td>

21
doc/common/tables/cinder-quota.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_quota">
<caption>Description of configuration options for quota</caption>
<col width="50%"/>
@ -20,31 +19,31 @@
</tr>
<tr>
<td>max_age = 0</td>
<td>(IntOpt) number of seconds between subsequent usage refreshes</td>
<td>(IntOpt) Number of seconds between subsequent usage refreshes</td>
</tr>
<tr>
<td>quota_driver = cinder.quota.DbQuotaDriver</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_gigabytes = 1000</td>
<td>(IntOpt) number of volume gigabytes (snapshots are also included) allowed per project</td>
<td>(IntOpt) Total amount of storage, in gigabytes, allowed for volumes and snapshots per project</td>
</tr>
<tr>
<td>quota_snapshots = 10</td>
<td>(IntOpt) number of volume snapshots allowed per project</td>
<td>(IntOpt) Number of volume snapshots allowed per project</td>
</tr>
<tr>
<td>quota_volumes = 10</td>
<td>(IntOpt) number of volumes allowed per project</td>
<td>(IntOpt) Number of volumes allowed per project</td>
</tr>
<tr>
<td>reservation_expire = 86400</td>
<td>(IntOpt) number of seconds until a reservation expires</td>
<td>(IntOpt) Number of seconds until a reservation expires</td>
</tr>
<tr>
<td>use_default_quota_class = True</td>
<td>(BoolOpt) whether to use default quota class for default quota</td>
<td>(BoolOpt) Enables or disables use of default quota class with default quota.</td>
</tr>
</tbody>
</table>

7
doc/common/tables/cinder-rootwrap.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_rootwrap">
<caption>Description of configuration options for rootwrap</caption>
<col width="50%"/>

11
doc/common/tables/cinder-rpc.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_rpc">
<caption>Description of configuration options for rpc</caption>
<col width="50%"/>
@ -88,7 +87,7 @@
</tr>
<tr>
<td>publish_errors = False</td>
<td>(BoolOpt) Publish error events</td>
<td>(BoolOpt) Enables or disables publication of error events.</td>
</tr>
<tr>
<td>qpid_heartbeat = 60</td>
@ -232,7 +231,7 @@
</tr>
<tr>
<td>volume_topic = cinder-volume</td>
<td>(StrOpt) the topic volume nodes listen on</td>
<td>(StrOpt) The topic that volume nodes listen on</td>
</tr>
<tr>
<th colspan="2">[matchmaker_ring]</th>

7
doc/common/tables/cinder-san-solaris.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_san-solaris">
<caption>Description of configuration options for san-solaris</caption>
<col width="50%"/>

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

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_san">
<caption>Description of configuration options for san</caption>
<col width="50%"/>

7
doc/common/tables/cinder-scality.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_scality">
<caption>Description of configuration options for scality</caption>
<col width="50%"/>

11
doc/common/tables/cinder-scheduler.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_scheduler">
<caption>Description of configuration options for scheduler</caption>
<col width="50%"/>
@ -40,7 +39,7 @@
</tr>
<tr>
<td>scheduler_manager = cinder.scheduler.manager.SchedulerManager</td>
<td>(StrOpt) full class name for the Manager for scheduler</td>
<td>(StrOpt) Full class name for the Manager for scheduler</td>
</tr>
<tr>
<td>scheduler_max_attempts = 3</td>
@ -48,7 +47,7 @@
</tr>
<tr>
<td>scheduler_topic = cinder-scheduler</td>
<td>(StrOpt) the topic scheduler nodes listen on</td>
<td>(StrOpt) The topic that scheduler nodes listen on</td>
</tr>
</tbody>
</table>

7
doc/common/tables/cinder-solidfire.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_solidfire">
<caption>Description of configuration options for solidfire</caption>
<col width="50%"/>

7
doc/common/tables/cinder-ssl.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_ssl">
<caption>Description of configuration options for ssl</caption>
<col width="50%"/>

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

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_storage">
<caption>Description of configuration options for storage</caption>
<col width="50%"/>
@ -32,7 +31,7 @@
</tr>
<tr>
<td>iscsi_helper = tgtadm</td>
<td>(StrOpt) iscsi target user-land tool to use</td>
<td>(StrOpt) iSCSI target user-land tool to use</td>
</tr>
<tr>
<td>iscsi_iotype = fileio</td>
@ -44,7 +43,7 @@
</tr>
<tr>
<td>iscsi_num_targets = 100</td>
<td>(IntOpt) The maximum number of iscsi target ids per host</td>
<td>(IntOpt) The maximum number of iSCSI target IDs per host</td>
</tr>
<tr>
<td>iscsi_port = 3260</td>
@ -52,11 +51,11 @@
</tr>
<tr>
<td>iscsi_target_prefix = iqn.2010-10.org.openstack:</td>
<td>(StrOpt) prefix for iscsi volumes</td>
<td>(StrOpt) Prefix for iSCSI volumes</td>
</tr>
<tr>
<td>iser_helper = tgtadm</td>
<td>(StrOpt) iser target user-land tool to use</td>
<td>(StrOpt) The name of the iSER target user-land tool to use</td>
</tr>
<tr>
<td>iser_ip_address = $my_ip</td>
@ -64,7 +63,7 @@
</tr>
<tr>
<td>iser_num_targets = 100</td>
<td>(IntOpt) The maximum number of iser target ids per host</td>
<td>(IntOpt) The maximum number of iSER target IDs per host</td>
</tr>
<tr>
<td>iser_port = 3260</td>
@ -72,7 +71,7 @@
</tr>
<tr>
<td>iser_target_prefix = iqn.2010-10.org.iser.openstack:</td>
<td>(StrOpt) prefix for iser volumes</td>
<td>(StrOpt) Prefix for iSER volumes</td>
</tr>
<tr>
<td>max_gigabytes = 10000</td>
@ -96,7 +95,7 @@
</tr>
<tr>
<td>volume_clear = zero</td>
<td>(StrOpt) Method used to wipe old voumes (valid options are: none, zero, shred)</td>
<td>(StrOpt) Method used to wipe old volumes (valid options are: none, zero, shred)</td>
</tr>
<tr>
<td>volume_clear_ionice = None</td>
@ -106,6 +105,14 @@
<td>volume_clear_size = 0</td>
<td>(IntOpt) Size in MiB to wipe at start of old volumes. 0 =&gt; all</td>
</tr>
<tr>
<td>volume_copy_blkio_cgroup_name = cinder-volume-copy</td>
<td>(StrOpt) The blkio cgroup name to be used to limit bandwidth of volume copy</td>
</tr>
<tr>
<td>volume_copy_bps_limit = 0</td>
<td>(IntOpt) The upper limit of bandwidth of volume copy. 0 =&gt; unlimited</td>
</tr>
<tr>
<td>volume_dd_blocksize = 1M</td>
<td>(StrOpt) The default block size used when copying/clearing volumes</td>
@ -116,7 +123,7 @@
</tr>
<tr>
<td>volume_manager = cinder.volume.manager.VolumeManager</td>
<td>(StrOpt) full class name for the Manager for volume</td>
<td>(StrOpt) Full class name for the Manager for volume</td>
</tr>
<tr>
<td>volume_service_inithost_offload = False</td>
@ -124,35 +131,12 @@
</tr>
<tr>
<td>volume_usage_audit_period = month</td>
<td>(StrOpt) time period to generate volume usages for. Time period must be hour, day, month or year</td>
<td>(StrOpt) Time period for which to generate volume usages. The options are hour, day, month, or year.</td>
</tr>
<tr>
<td>volumes_dir = $state_path/volumes</td>
<td>(StrOpt) Volume configuration file storage directory</td>
</tr>
<tr>
<th colspan="2">[database]</th>
</tr>
<tr>
<td>backend = sqlalchemy</td>
<td>(StrOpt) The backend to use for db</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_pool_size = 5</td>
<td>(IntOpt) Maximum number of SQL connections to keep open in a pool</td>
</tr>
<tr>
<td>max_retries = 10</td>
<td>(IntOpt) maximum db connection retries during startup. (setting -1 implies an infinite retry count)</td>
</tr>
<tr>
<td>min_pool_size = 1</td>
<td>(IntOpt) Minimum number of SQL connections to keep open in a pool</td>
</tr>
</tbody>
</table>
</para>

25
doc/common/tables/cinder-storage_ceph.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_storage_ceph">
<caption>Description of configuration options for storage_ceph</caption>
<col width="50%"/>
@ -20,31 +19,35 @@
</tr>
<tr>
<td>rbd_ceph_conf = </td>
<td>(StrOpt) path to the ceph configuration file to use</td>
<td>(StrOpt) Path to the ceph configuration file</td>
</tr>
<tr>
<td>rbd_flatten_volume_from_snapshot = False</td>
<td>(BoolOpt) flatten volumes created from snapshots to remove dependency</td>
<td>(BoolOpt) Flatten volumes created from snapshots to remove dependency from volume to snapshot</td>
</tr>
<tr>
<td>rbd_max_clone_depth = 5</td>
<td>(IntOpt) maximum number of nested clones that can be taken of a volume before enforcing a flatten prior to next clone. A value of zero disables cloning</td>
<td>(IntOpt) Maximum number of nested volume clones that are taken before a flatten occurs. Set to 0 to disable cloning.</td>
</tr>
<tr>
<td>rbd_pool = rbd</td>
<td>(StrOpt) the RADOS pool in which rbd volumes are stored</td>
<td>(StrOpt) The RADOS pool where rbd volumes are stored</td>
</tr>
<tr>
<td>rbd_secret_uuid = None</td>
<td>(StrOpt) the libvirt uuid of the secret for the rbd_uservolumes</td>
<td>(StrOpt) The libvirt uuid of the secret for the rbd_user volumes</td>
</tr>
<tr>
<td>rbd_store_chunk_size = 4</td>
<td>(IntOpt) Volumes will be chunked into objects of this size (in megabytes).</td>
</tr>
<tr>
<td>rbd_user = None</td>
<td>(StrOpt) the RADOS client name for accessing rbd volumes - only set when using cephx authentication</td>
<td>(StrOpt) The RADOS client name for accessing rbd volumes - only set when using cephx authentication</td>
</tr>
<tr>
<td>volume_tmp_dir = None</td>
<td>(StrOpt) where to store temporary image files if the volume driver does not write them directly to the volume</td>
<td>(StrOpt) Directory where temporary image files are stored when the volume driver does not write them directly to the volume.</td>
</tr>
</tbody>
</table>

7
doc/common/tables/cinder-storage_glusterfs.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_storage_glusterfs">
<caption>Description of configuration options for storage_glusterfs</caption>
<col width="50%"/>

7
doc/common/tables/cinder-storage_gpfs.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_storage_gpfs">
<caption>Description of configuration options for storage_gpfs</caption>
<col width="50%"/>

7
doc/common/tables/cinder-storage_nfs.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_storage_nfs">
<caption>Description of configuration options for storage_nfs</caption>
<col width="50%"/>

7
doc/common/tables/cinder-storage_xen.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_storage_xen">
<caption>Description of configuration options for storage_xen</caption>
<col width="50%"/>

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

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_storwize">
<caption>Description of configuration options for storwize</caption>
<col width="50%"/>

7
doc/common/tables/cinder-vmware.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_vmware">
<caption>Description of configuration options for vmware</caption>
<col width="50%"/>

7
doc/common/tables/cinder-windows.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_windows">
<caption>Description of configuration options for windows</caption>
<col width="50%"/>

7
doc/common/tables/cinder-xiv.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_xiv">
<caption>Description of configuration options for xiv</caption>
<col width="50%"/>

7
doc/common/tables/cinder-zadara.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_zadara">
<caption>Description of configuration options for zadara</caption>
<col width="50%"/>

7
doc/common/tables/cinder-zones.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_zones">
<caption>Description of configuration options for zones</caption>
<col width="50%"/>

7
doc/common/tables/cinder-zoning.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_zoning">
<caption>Description of configuration options for zoning</caption>
<col width="50%"/>

7
doc/common/tables/cinder-zoning_fabric.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_zoning_fabric">
<caption>Description of configuration options for zoning_fabric</caption>
<col width="50%"/>

7
doc/common/tables/cinder-zoning_manager.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_zoning_manager">
<caption>Description of configuration options for zoning_manager</caption>
<col width="50%"/>

7
doc/common/tables/glance-amqp.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_glance_amqp">
<caption>Description of configuration options for amqp</caption>
<col width="50%"/>

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

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_glance_api">
<caption>Description of configuration options for api</caption>
<col width="50%"/>
@ -26,14 +25,14 @@
<td>allow_anonymous_access = False</td>
<td>(BoolOpt) Allow unauthenticated users to access the API with read-only privileges. This only applies when using ContextMiddleware.</td>
</tr>
<tr>
<td>default_publisher_id = image.localhost</td>
<td>(StrOpt) Default publisher_id for outgoing notifications.</td>
</tr>
<tr>
<td>default_store = file</td>
<td>(StrOpt) Default scheme to use to store image data. The scheme must be registered by one of the stores defined by the 'known_stores' config option.</td>
</tr>
<tr>
<td>default_swift_reference = ref1</td>
<td>(StrOpt) The reference to the default swift account/backing store parameters to use for adding new images.</td>
</tr>
<tr>
<td>enable_v1_api = True</td>
<td>(BoolOpt) Deploy the v1 OpenStack Images API.</td>

31
doc/common/tables/glance-auth_token.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_glance_auth_token">
<caption>Description of configuration options for auth_token</caption>
<col width="50%"/>
@ -35,7 +34,7 @@
</tr>
<tr>
<td>admin_token = None</td>
<td>(StrOpt) Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process.</td>
<td>(StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead.</td>
</tr>
<tr>
<td>admin_user = None</td>
@ -43,19 +42,19 @@
</tr>
<tr>
<td>auth_admin_prefix = </td>
<td>(StrOpt) Prefix to prepend at the beginning of the path</td>
<td>(StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri.</td>
</tr>
<tr>
<td>auth_host = 127.0.0.1</td>
<td>(StrOpt) Host providing the admin Identity API endpoint</td>
<td>(StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri.</td>
</tr>
<tr>
<td>auth_port = 35357</td>
<td>(IntOpt) Port of the admin Identity API endpoint</td>
<td>(IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri.</td>
</tr>
<tr>
<td>auth_protocol = https</td>
<td>(StrOpt) Protocol of the admin Identity API endpoint(http or https)</td>
<td>(StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri.</td>
</tr>
<tr>
<td>auth_uri = None</td>
@ -77,6 +76,10 @@
<td>certfile = None</td>
<td>(StrOpt) Required if Keystone server requires client certificate</td>
</tr>
<tr>
<td>check_revocations_for_cached = False</td>
<td>(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the Keystone server.</td>
</tr>
<tr>
<td>delay_auth_decision = False</td>
<td>(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components</td>
@ -85,6 +88,10 @@
<td>enforce_token_bind = permissive</td>
<td>(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens.</td>
</tr>
<tr>
<td>hash_algorithms = md5</td>
<td>(ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance.</td>
</tr>
<tr>
<td>http_connect_timeout = None</td>
<td>(BoolOpt) Request timeout value for communicating with Identity API server.</td>
@ -93,6 +100,10 @@
<td>http_request_max_retries = 3</td>
<td>(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server.</td>
</tr>
<tr>
<td>identity_uri = None</td>
<td>(StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/</td>
</tr>
<tr>
<td>include_service_catalog = True</td>
<td>(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.</td>
@ -118,7 +129,7 @@
<td>(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.</td>
</tr>
<tr>
<td>revocation_cache_time = 300</td>
<td>revocation_cache_time = 10</td>
<td>(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.</td>
</tr>
<tr>

7
doc/common/tables/glance-cinder.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_glance_cinder">
<caption>Description of configuration options for cinder</caption>
<col width="50%"/>

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

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_glance_common">
<caption>Description of configuration options for common</caption>
<col width="50%"/>
@ -76,7 +75,7 @@
</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). (DEPRECATED)</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>
@ -96,7 +95,7 @@
</tr>
<tr>
<td>user_storage_quota = 0</td>
<td>(IntOpt) Set a system wide quota for every user. This value is the total number of bytes that a user can use across all storage systems. A value of 0 means unlimited.</td>
<td>(StrOpt) Set a system wide quota for every user. This value is the total capacity that a user can use across all storage systems. A value of 0 means unlimited.Optional unit can be specified for the value. Accepted units are B, KB, MB, GB and TB representing Bytes, KiloBytes, MegaBytes, GigaBytes and TeraBytesrespectively. If no unit is specified then Bytes is assumed. Note that there should not be any space between value and unit and units are case sensitive.</td>
</tr>
<tr>
<td>workers = 1</td>

98
doc/common/tables/glance-database.xml Normal file

@ -0,0 +1,98 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_glance_database">
<caption>Description of configuration options for database</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[database]</th>
</tr>
<tr>
<td>backend = sqlalchemy</td>
<td>(StrOpt) The backend to use for db</td>
</tr>
<tr>
<td>connection = None</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>connection_trace = False</td>
<td>(BoolOpt) Add python stack traces to SQL as comment strings</td>
</tr>
<tr>
<td>db_inc_retry_interval = True</td>
<td>(BoolOpt) Whether to increase interval between db connection retries, up to db_max_retry_interval</td>
</tr>
<tr>
<td>db_max_retries = 20</td>
<td>(IntOpt) maximum db connection retries before error is raised. (setting -1 implies an infinite retry count)</td>
</tr>
<tr>
<td>db_max_retry_interval = 10</td>
<td>(IntOpt) max seconds between db connection retries, if db_inc_retry_interval is enabled</td>
</tr>
<tr>
<td>db_retry_interval = 1</td>
<td>(IntOpt) seconds between db connection retries</td>
</tr>
<tr>
<td>idle_timeout = 3600</td>
<td>(IntOpt) Timeout before idle sql connections are reaped</td>
</tr>
<tr>
<td>max_overflow = None</td>
<td>(IntOpt) If set, use this value for max_overflow with sqlalchemy</td>
</tr>
<tr>
<td>max_pool_size = None</td>
<td>(IntOpt) Maximum number of SQL connections to keep open in a pool</td>
</tr>
<tr>
<td>max_retries = 10</td>
<td>(IntOpt) Maximum db connection retries during startup. (setting -1 implies an infinite retry count)</td>
</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>mysql_sql_mode = TRADITIONAL</td>
<td>(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=</td>
</tr>
<tr>
<td>pool_timeout = None</td>
<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>sqlite_db = glance.sqlite</td>
<td>(StrOpt) The file name to use with SQLite</td>
</tr>
<tr>
<td>sqlite_synchronous = True</td>
<td>(BoolOpt) If True, SQLite uses synchronous mode</td>
</tr>
<tr>
<td>use_db_reconnect = False</td>
<td>(BoolOpt) Enable the experimental use of database reconnect on connection lost</td>
</tr>
</tbody>
</table>
</para>

99
doc/common/tables/glance-db.xml

@ -1,99 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all" xml:id="config_table_glance_db">
<caption>Description of configuration options for db</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[database]</th>
</tr>
<tr>
<td>backend = sqlalchemy</td>
<td>(StrOpt) The backend to use for db</td>
</tr>
<tr>
<td>connection = None</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>connection_trace = False</td>
<td>(BoolOpt) Add python stack traces to SQL as comment strings</td>
</tr>
<tr>
<td>db_inc_retry_interval = True</td>
<td>(BoolOpt) Whether to increase interval between db connection retries, up to db_max_retry_interval</td>
</tr>
<tr>
<td>db_max_retries = 20</td>
<td>(IntOpt) maximum db connection retries before error is raised. (setting -1 implies an infinite retry count)</td>
</tr>
<tr>
<td>db_max_retry_interval = 10</td>
<td>(IntOpt) max seconds between db connection retries, if db_inc_retry_interval is enabled</td>
</tr>
<tr>
<td>db_retry_interval = 1</td>
<td>(IntOpt) seconds between db connection retries</td>
</tr>
<tr>
<td>idle_timeout = 3600</td>
<td>(IntOpt) Timeout before idle sql connections are reaped</td>
</tr>
<tr>
<td>max_overflow = None</td>
<td>(IntOpt) If set, use this value for max_overflow with sqlalchemy</td>
</tr>
<tr>
<td>max_pool_size = None</td>
<td>(IntOpt) Maximum number of SQL connections to keep open in a pool</td>
</tr>
<tr>
<td>max_retries = 10</td>
<td>(IntOpt) Maximum db connection retries during startup. (setting -1 implies an infinite retry count)</td>
</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>mysql_sql_mode = TRADITIONAL</td>
<td>(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=</td>
</tr>
<tr>
<td>pool_timeout = None</td>
<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>sqlite_db = glance.sqlite</td>
<td>(StrOpt) The file name to use with SQLite</td>
</tr>
<tr>
<td>sqlite_synchronous = True</td>
<td>(BoolOpt) If True, SQLite uses synchronous mode</td>
</tr>
<tr>
<td>use_db_reconnect = False</td>
<td>(BoolOpt) Enable the experimental use of database reconnect on connection lost</td>
</tr>
</tbody>
</table>
</para>

7
doc/common/tables/glance-filesystem.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_glance_filesystem">
<caption>Description of configuration options for filesystem</caption>
<col width="50%"/>

7
doc/common/tables/glance-gridfs.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_glance_gridfs">
<caption>Description of configuration options for gridfs</caption>
<col width="50%"/>

7
doc/common/tables/glance-imagecache.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_glance_imagecache">
<caption>Description of configuration options for imagecache</caption>
<col width="50%"/>

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

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_glance_logging">
<caption>Description of configuration options for logging</caption>
<col width="50%"/>
@ -23,32 +22,32 @@
<td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).</td>
</tr>
<tr>
<td>default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN</td>
<td>(ListOpt) List of logger=LEVEL pairs</td>
<td>default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN</td>
<td>(ListOpt) List of logger=LEVEL pairs.</td>
</tr>
<tr>
<td>fatal_deprecations = False</td>
<td>(BoolOpt) Make deprecations fatal</td>
<td>(BoolOpt) Enables or disables fatal status of deprecations.</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>(StrOpt) The format for an instance that is passed with the log message. </td>
</tr>
<tr>
<td>instance_uuid_format = "[instance: %(uuid)s] "</td>
<td>(StrOpt) If an instance UUID is passed with the log message, format it like this</td>
<td>(StrOpt) The format for an instance UUID that is passed with the log message. </td>
</tr>
<tr>
<td>log_config_append = None</td>
<td>(StrOpt) The name of logging configuration file. It does not disable existing loggers, but just appends specified logging configuration to any other existing logging options. Please see the Python logging module documentation for details on logging configuration files.</td>
<td>(StrOpt) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation.</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>
@ -60,39 +59,39 @@
</tr>
<tr>
<td>logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s</td>
<td>(StrOpt) Format string to use for log messages with context</td>
<td>(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) Enables or disables publication of 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. Existing syslog format is DEPRECATED during I, and then will be changed in J to honor RFC5424</td>
<td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will chang in J to honor RFC5424.</td>
</tr>
<tr>
<td>use_syslog_rfc_format = False</td>
<td>(BoolOpt) (Optional) Use syslog rfc5424 format for logging. If enabled, will add APP-NAME (RFC5424) before the MSG part of the syslog message. The old format without APP-NAME is deprecated in I, and will be removed in J.</td>
<td>(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in I, and will be removed in J.</td>
</tr>
<tr>
<td>verbose = False</td>

7
doc/common/tables/glance-matchmaker.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_glance_matchmaker">
<caption>Description of configuration options for matchmaker</caption>
<col width="50%"/>

7
doc/common/tables/glance-paste.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_glance_paste">
<caption>Description of configuration options for paste</caption>
<col width="50%"/>

7
doc/common/tables/glance-policy.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_glance_policy">
<caption>Description of configuration options for policy</caption>
<col width="50%"/>

7
doc/common/tables/glance-qpid.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_glance_qpid">
<caption>Description of configuration options for qpid</caption>
<col width="50%"/>

7
doc/common/tables/glance-rabbitmq.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_glance_rabbitmq">
<caption>Description of configuration options for rabbitmq</caption>
<col width="50%"/>

7
doc/common/tables/glance-rbd.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_glance_rbd">
<caption>Description of configuration options for rbd</caption>
<col width="50%"/>

7
doc/common/tables/glance-redis.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_glance_redis">
<caption>Description of configuration options for redis</caption>
<col width="50%"/>

7
doc/common/tables/glance-registry.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_glance_registry">
<caption>Description of configuration options for registry</caption>
<col width="50%"/>

7
doc/common/tables/glance-rpc.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_glance_rpc">
<caption>Description of configuration options for rpc</caption>
<col width="50%"/>

19
doc/common/tables/glance-s3.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_glance_s3">
<caption>Description of configuration options for s3</caption>
<col width="50%"/>
@ -38,6 +37,14 @@
<td>s3_store_host = None</td>
<td>(StrOpt) The host where the S3 server is listening.</td>
</tr>
<tr>
<td>s3_store_large_object_chunk_size = 10</td>
<td>(IntOpt) What multipart upload part size, in MB, should S3 use when uploading parts. The size must be greater than or equal to 5M.</td>
</tr>
<tr>
<td>s3_store_large_object_size = 100</td>
<td>(IntOpt) What size, in MB, should S3 start chunking image files and do a multipart upload in S3.</td>
</tr>
<tr>
<td>s3_store_object_buffer_dir = None</td>
<td>(StrOpt) The local directory where uploads will be staged before they are transferred into S3.</td>
@ -46,6 +53,10 @@
<td>s3_store_secret_key = None</td>
<td>(StrOpt) The S3 query token secret key.</td>
</tr>
<tr>
<td>s3_store_thread_pools = 10</td>
<td>(IntOpt) The number of thread pools to perform a multipart upload in S3.</td>
</tr>
</tbody>
</table>
</para>

7
doc/common/tables/glance-sheepdog.xml

@ -1,9 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_glance_sheepdog">
<caption>Description of configuration options for sheepdog</caption>
<col width="50%"/>

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