openstack
/
openstack-manuals
Code Issues Proposed changes

config reference update for juno-1 

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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

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

109
doc/common/tables/ceilometer-alarm.xml
View File

@ -1,55 +1,54 @@
<?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_alarm">
<caption>Description of configuration options for alarm</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">[alarm]</th>
</tr>
<tr>
<td>evaluation_interval = 60</td>
<td>(IntOpt) Period of evaluation cycle, should be &gt;= than configured pipeline interval for collection of underlying metrics.</td>
</tr>
<tr>
<td>evaluation_service = ceilometer.alarm.service.SingletonAlarmService</td>
<td>(StrOpt) Class to launch as alarm evaluation service.</td>
</tr>
<tr>
<td>notifier_rpc_topic = alarm_notifier</td>
<td>(StrOpt) The topic that ceilometer uses for alarm notifier messages.</td>
</tr>
<tr>
<td>partition_rpc_topic = alarm_partition_coordination</td>
<td>(StrOpt) The topic that ceilometer uses for alarm partition coordination messages.</td>
</tr>
<tr>
<td>record_history = True</td>
<td>(BoolOpt) Record alarm change events.</td>
</tr>
<tr>
<td>rest_notifier_certificate_file = </td>
<td>(StrOpt) SSL Client certificate for REST notifier.</td>
</tr>
<tr>
<td>rest_notifier_certificate_key = </td>
<td>(StrOpt) SSL Client private key for REST notifier.</td>
</tr>
<tr>
<td>rest_notifier_ssl_verify = True</td>
<td>(BoolOpt) Whether to verify the SSL Server certificate when calling alarm action.</td>
</tr>
</tbody>
</table>
</para>
<?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_alarm">
<caption>Description of configuration options for alarm</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">[alarm]</th>
</tr>
<tr>
<td>evaluation_interval = 60</td>
<td>(IntOpt) Period of evaluation cycle, should be &gt;= than configured pipeline interval for collection of underlying metrics.</td>
</tr>
<tr>
<td>evaluation_service = ceilometer.alarm.service.SingletonAlarmService</td>
<td>(StrOpt) Class to launch as alarm evaluation service.</td>
</tr>
<tr>
<td>notifier_rpc_topic = alarm_notifier</td>
<td>(StrOpt) The topic that ceilometer uses for alarm notifier messages.</td>
</tr>
<tr>
<td>partition_rpc_topic = alarm_partition_coordination</td>
<td>(StrOpt) The topic that ceilometer uses for alarm partition coordination messages.</td>
</tr>
<tr>
<td>record_history = True</td>
<td>(BoolOpt) Record alarm change events.</td>
</tr>
<tr>
<td>rest_notifier_certificate_file = </td>
<td>(StrOpt) SSL Client certificate for REST notifier.</td>
</tr>
<tr>
<td>rest_notifier_certificate_key = </td>
<td>(StrOpt) SSL Client private key for REST notifier.</td>
</tr>
<tr>
<td>rest_notifier_ssl_verify = True</td>
<td>(BoolOpt) Whether to verify the SSL Server certificate when calling alarm action.</td>
</tr>
</tbody>
</table>
</para>

77
doc/common/tables/ceilometer-amqp.xml
View File

@ -1,39 +1,38 @@
<?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_amqp">
<caption>Description of configuration options for amqp</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>amqp_auto_delete = False</td>
<td>(BoolOpt) Auto-delete queues in amqp.</td>
</tr>
<tr>
<td>amqp_durable_queues = False</td>
<td>(BoolOpt) Use durable queues in amqp.</td>
</tr>
<tr>
<td>notification_driver = []</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>
</tr>
</tbody>
</table>
</para>
<?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_amqp">
<caption>Description of configuration options for amqp</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>amqp_auto_delete = False</td>
<td>(BoolOpt) Auto-delete queues in amqp.</td>
</tr>
<tr>
<td>amqp_durable_queues = False</td>
<td>(BoolOpt) Use durable queues in amqp.</td>
</tr>
<tr>
<td>notification_driver = []</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>
</tr>
</tbody>
</table>
</para>

127
doc/common/tables/ceilometer-api.xml
View File

@ -1,62 +1,65 @@
<?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_api">
<caption>Description of configuration options for api</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_v1_api = True</td>
<td>(BoolOpt) Deploy the deprecated v1 API.</td>
</tr>
<tr>
<td>max_request_body_size = 114688</td>
<td>(IntOpt) The maximum body size per request, in bytes</td>
</tr>
<tr>
<td>pipeline_cfg_file = pipeline.yaml</td>
<td>(StrOpt) Configuration file for pipeline definition.</td>
</tr>
<tr>
<td>policy_default_rule = default</td>
<td>(StrOpt) Rule enforced when requested rule is not found</td>
</tr>
<tr>
<td>policy_file = policy.json</td>
<td>(StrOpt) JSON file containing policy</td>
</tr>
<tr>
<td>reserved_metadata_length = 256</td>
<td>(IntOpt) Limit on length of reserved metadata values.</td>
</tr>
<tr>
<td>reserved_metadata_namespace = metering.</td>
<td>(ListOpt) List of metadata prefixes reserved for metering use.</td>
</tr>
<tr>
<th colspan="2">[api]</th>
</tr>
<tr>
<td>host = 0.0.0.0</td>
<td>(StrOpt) The listen IP for the ceilometer API server.</td>
</tr>
<tr>
<td>port = 8777</td>
<td>(IntOpt) The port for the ceilometer API server.</td>
</tr>
</tbody>
</table>
</para>
<?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_api">
<caption>Description of configuration options for api</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>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 for each request, in bytes.</td>
</tr>
<tr>
<td>pipeline_cfg_file = pipeline.yaml</td>
<td>(StrOpt) Configuration file for pipeline definition.</td>
</tr>
<tr>
<td>policy_default_rule = default</td>
<td>(StrOpt) Default rule. Enforced when a requested rule is not found.</td>
</tr>
<tr>
<td>policy_file = policy.json</td>
<td>(StrOpt) The JSON file that defines policies.</td>
</tr>
<tr>
<td>reserved_metadata_length = 256</td>
<td>(IntOpt) Limit on length of reserved metadata values.</td>
</tr>
<tr>
<td>reserved_metadata_namespace = metering.</td>
<td>(ListOpt) List of metadata prefixes reserved for metering use.</td>
</tr>
<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>
</tr>
<tr>
<td>port = 8777</td>
<td>(IntOpt) The port for the ceilometer API server.</td>
</tr>
</tbody>
</table>
</para>

231
doc/common/tables/ceilometer-auth.xml
View File

@ -1,173 +1,58 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all" xml:id="config_table_ceilometer_auth">
<caption>Description of configuration options for auth</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>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>
<tr>
<td>insecure = False</td>
<td>(BoolOpt) Disables X.509 certificate validation when an SSL connection to Identity Service is established.</td>
</tr>
<tr>
<td>os_auth_url = http://localhost:5000/v2.0</td>
<td>(StrOpt) Auth URL to use for OpenStack service access.</td>
</tr>
<tr>
<td>os_cacert = None</td>
<td>(StrOpt) Certificate chain for SSL validation.</td>
</tr>
<tr>
<td>os_endpoint_type = publicURL</td>
<td>(StrOpt) Type of endpoint in Identity service catalog to use for communication with OpenStack services.</td>
</tr>
<tr>
<td>os_password = admin</td>
<td>(StrOpt) Password to use for OpenStack service access.</td>
</tr>
<tr>
<td>os_region_name = None</td>
<td>(StrOpt) Region name to use for OpenStack service endpoints.</td>
</tr>
<tr>
<td>os_tenant_id = </td>
<td>(StrOpt) Tenant ID to use for OpenStack service access.</td>
</tr>
<tr>
<td>os_tenant_name = admin</td>
<td>(StrOpt) Tenant name to use for OpenStack service access.</td>
</tr>
<tr>
<td>os_username = ceilometer</td>
<td>(StrOpt) User name to use for OpenStack service access.</td>
</tr>
</tbody>
</table>
</para>
<?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">
<caption>Description of configuration options for auth</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">[service_credentials]</th>
</tr>
<tr>
<td>insecure = False</td>
<td>(BoolOpt) Disables X.509 certificate validation when an SSL connection to Identity Service is established.</td>
</tr>
<tr>
<td>os_auth_url = http://localhost:5000/v2.0</td>
<td>(StrOpt) Auth URL to use for OpenStack service access.</td>
</tr>
<tr>
<td>os_cacert = None</td>
<td>(StrOpt) Certificate chain for SSL validation.</td>
</tr>
<tr>
<td>os_endpoint_type = publicURL</td>
<td>(StrOpt) Type of endpoint in Identity service catalog to use for communication with OpenStack services.</td>
</tr>
<tr>
<td>os_password = admin</td>
<td>(StrOpt) Password to use for OpenStack service access.</td>
</tr>
<tr>
<td>os_region_name = None</td>
<td>(StrOpt) Region name to use for OpenStack service endpoints.</td>
</tr>
<tr>
<td>os_tenant_id = </td>
<td>(StrOpt) Tenant ID to use for OpenStack service access.</td>
</tr>
<tr>
<td>os_tenant_name = admin</td>
<td>(StrOpt) Tenant name to use for OpenStack service access.</td>
</tr>
<tr>
<td>os_username = ceilometer</td>
<td>(StrOpt) User name to use for OpenStack service access.</td>
</tr>
</tbody>
</table>
</para>

138
doc/common/tables/ceilometer-auth_token.xml Normal file
View 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
View File

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

94
doc/common/tables/ceilometer-collector.xml
View File

@ -1,53 +1,41 @@
<?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_collector">
<caption>Description of configuration options for collector</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>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>
<tr>
<td>backup_count = 0</td>
<td>(IntOpt) The max number of the files to keep.</td>
</tr>
<tr>
<td>file_path = None</td>
<td>(StrOpt) Name and the location of the file to record meters.</td>
</tr>
<tr>
<td>max_bytes = 0</td>
<td>(IntOpt) The max size of the file.</td>
</tr>
</tbody>
</table>
</para>
<?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_collector">
<caption>Description of configuration options for collector</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>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">[dispatcher_file]</th>
</tr>
<tr>
<td>backup_count = 0</td>
<td>(IntOpt) The max number of the files to keep.</td>
</tr>
<tr>
<td>file_path = None</td>
<td>(StrOpt) Name and the location of the file to record meters.</td>
</tr>
<tr>
<td>max_bytes = 0</td>
<td>(IntOpt) The max size of the file.</td>
</tr>
</tbody>
</table>
</para>

97
doc/common/tables/ceilometer-common.xml
View File

@ -1,47 +1,50 @@
<?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_common">
<caption>Description of configuration options for common</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>backdoor_port = None</td>
<td>(StrOpt) Enable eventlet backdoor. Acceptable values are 0, &lt;port&gt;, and &lt;start&gt;:&lt;end&gt;, where 0 results in listening on a random tcp port number; &lt;port&gt; results in listening on the specified port number (and not enabling backdoor if that port is in use); and &lt;start&gt;:&lt;end&gt; results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.</td>
</tr>
<tr>
<td>disable_process_locking = False</td>
<td>(BoolOpt) Whether to disable inter-process locks.</td>
</tr>
<tr>
<td>fatal_deprecations = False</td>
<td>(BoolOpt) Make deprecations fatal</td>
</tr>
<tr>
<td>lock_path = None</td>
<td>(StrOpt) Directory to use for lock files.</td>
</tr>
<tr>
<td>memcached_servers = None</td>
<td>(ListOpt) Memcached servers or None for in process cache.</td>
</tr>
<tr>
<td>notification_workers = 1</td>
<td>(IntOpt) Number of workers for notification service. A single notification agent is enabled by default.</td>
</tr>
</tbody>
</table>
</para>
<?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_common">
<caption>Description of configuration options for common</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>backdoor_port = None</td>
<td>(StrOpt) Enable eventlet backdoor. Acceptable values are 0, &lt;port&gt;, and &lt;start&gt;:&lt;end&gt;, where 0 results in listening on a random tcp port number; &lt;port&gt; results in listening on the specified port number (and not enabling backdoor if that port is in use); and &lt;start&gt;:&lt;end&gt; results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.</td>
</tr>
<tr>
<td>disable_process_locking = False</td>
<td>(BoolOpt) Enables or disables inter-process locks.</td>
</tr>
<tr>
<td>fatal_deprecations = False</td>
<td>(BoolOpt) Enables or disables fatal status of deprecations.</td>
</tr>
<tr>
<td>fatal_exception_format_errors = False</td>
<td>(BoolOpt) Make exception message format errors fatal</td>
</tr>
<tr>
<td>lock_path = None</td>
<td>(StrOpt) Directory to use for lock files.</td>
</tr>
<tr>
<td>memcached_servers = None</td>
<td>(ListOpt) Memcached servers or None for in process cache.</td>
</tr>
<tr>
<td>notification_workers = 1</td>
<td>(IntOpt) Number of workers for notification service. A single notification agent is enabled by default.</td>
</tr>
</tbody>
</table>
</para>

207
doc/common/tables/ceilometer-database.xml
View File

@ -1,94 +1,113 @@
<?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_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">[DEFAULT]</th>
</tr>
<tr>
<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>
<tr>
<td>backend = sqlalchemy</td>
<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>(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>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>pool_timeout = None</td>
<td>(IntOpt) If set, use this value for pool_timeout with sqlalchemy</td>
</tr>
<tr>
<td>retry_interval = 10</td>
<td>(IntOpt) Interval between retries of opening a sql connection</td>
</tr>
<tr>
<td>slave_connection = </td>
<td>(StrOpt) The SQLAlchemy connection string used to connect to the slave database</td>
</tr>
<tr>
<td>time_to_live = -1</td>
<td>(IntOpt) Number of seconds that samples are kept in the database for (&lt;= 0 means forever).</td>
</tr>
</tbody>
</table>
</para>
<?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_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">[DEFAULT]</th>
</tr>
<tr>
<td>database_connection = None</td>
<td>(StrOpt) DEPRECATED - Database connection string.</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 = 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 = 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>

83
doc/common/tables/ceilometer-events.xml
View File

@ -1,42 +1,41 @@
<?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_events">
<caption>Description of configuration options for events</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">[event]</th>
</tr>
<tr>
<td>definitions_cfg_file = event_definitions.yaml</td>
<td>(StrOpt) Configuration file for event definitions.</td>
</tr>
<tr>
<td>drop_unmatched_notifications = False</td>
<td>(BoolOpt) Drop notifications if no event definition matches. (Otherwise, we convert them with just the default traits)</td>
</tr>
<tr>
<th colspan="2">[notification]</th>
</tr>
<tr>
<td>ack_on_event_error = True</td>
<td>(BoolOpt) Acknowledge message when event persistence fails.</td>
</tr>
<tr>
<td>store_events = False</td>
<td>(BoolOpt) Save event details.</td>
</tr>
</tbody>
</table>
</para>
<?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_events">
<caption>Description of configuration options for events</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">[event]</th>
</tr>
<tr>
<td>definitions_cfg_file = event_definitions.yaml</td>
<td>(StrOpt) Configuration file for event definitions.</td>
</tr>
<tr>
<td>drop_unmatched_notifications = False</td>
<td>(BoolOpt) Drop notifications if no event definition matches. (Otherwise, we convert them with just the default traits)</td>
</tr>
<tr>
<th colspan="2">[notification]</th>
</tr>
<tr>
<td>ack_on_event_error = True</td>
<td>(BoolOpt) Acknowledge message when event persistence fails.</td>
</tr>
<tr>
<td>store_events = False</td>
<td>(BoolOpt) Save event details.</td>
</tr>
</tbody>
</table>
</para>

113
doc/common/tables/ceilometer-exchange.xml
View File

@ -1,59 +1,54 @@
<?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_exchange">
<caption>Description of configuration options for exchange</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>cinder_control_exchange = cinder</td>
<td>(StrOpt) Exchange name for Cinder notifications.</td>
</tr>
<tr>
<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>
</tr>
<tr>
<td>heat_control_exchange = heat</td>
<td>(StrOpt) Exchange name for Heat notifications</td>
</tr>
<tr>
<td>http_control_exchanges = ['nova', 'glance', 'neutron', 'cinder']</td>
<td>(MultiStrOpt) Exchanges name to listen for notifications.</td>
</tr>
<tr>
<td>neutron_control_exchange = neutron</td>
<td>(StrOpt) Exchange name for Neutron notifications.</td>
</tr>
<tr>
<td>nova_control_exchange = nova</td>
<td>(StrOpt) Exchange name for Nova notifications.</td>
</tr>
<tr>
<td>sample_source = openstack</td>
<td>(StrOpt) Source for samples emitted on this instance.</td>
</tr>
</tbody>
</table>
</para>
<?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_exchange">
<caption>Description of configuration options for exchange</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>cinder_control_exchange = cinder</td>
<td>(StrOpt) Exchange name for Cinder notifications.</td>
</tr>
<tr>
<td>control_exchange = openstack</td>
<td>(StrOpt) AMQP exchange to connect to if using RabbitMQ or Qpid</td>
</tr>
<tr>
<td>glance_control_exchange = glance</td>
<td>(StrOpt) Exchange name for Glance notifications.</td>
</tr>
<tr>
<td>heat_control_exchange = heat</td>
<td>(StrOpt) Exchange name for Heat notifications</td>
</tr>
<tr>
<td>http_control_exchanges = ['nova', 'glance', 'neutron', 'cinder']</td>
<td>(MultiStrOpt) Exchanges name to listen for notifications.</td>
</tr>
<tr>
<td>neutron_control_exchange = neutron</td>
<td>(StrOpt) Exchange name for Neutron notifications.</td>
</tr>
<tr>
<td>nova_control_exchange = nova</td>
<td>(StrOpt) Exchange name for Nova notifications.</td>
</tr>
<tr>
<td>sample_source = openstack</td>
<td>(StrOpt) Source for samples emitted on this instance.</td>
</tr>
</tbody>
</table>
</para>

69
doc/common/tables/ceilometer-inspector.xml
View File

@ -1,35 +1,34 @@
<?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_inspector">
<caption>Description of configuration options for inspector</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>hypervisor_inspector = libvirt</td>
<td>(StrOpt) Inspector to use for inspecting the hypervisor layer.</td>
</tr>
<tr>
<td>libvirt_type = kvm</td>
<td>(StrOpt) Libvirt domain type (valid options are: kvm, lxc, qemu, uml, xen).</td>
</tr>
<tr>
<td>libvirt_uri = </td>
<td>(StrOpt) Override the default libvirt URI (which is dependent on libvirt_type).</td>
</tr>
</tbody>
</table>
</para>
<?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_inspector">
<caption>Description of configuration options for inspector</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>hypervisor_inspector = libvirt</td>
<td>(StrOpt) Inspector to use for inspecting the hypervisor layer.</td>
</tr>
<tr>
<td>libvirt_type = kvm</td>
<td>(StrOpt) Libvirt domain type (valid options are: kvm, lxc, qemu, uml, xen).</td>
</tr>
<tr>
<td>libvirt_uri = </td>
<td>(StrOpt) Override the default libvirt URI (which is dependent on libvirt_type).</td>
</tr>
</tbody>
</table>
</para>

212
doc/common/tables/ceilometer-logging.xml
View File

@ -1,114 +1,98 @@
<?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_logging">
<caption>Description of configuration options for logging</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>debug = False</td>
<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>
</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>
</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>
</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>
</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>
</tr>
<tr>
<td>log_dir = None</td>
<td>(StrOpt) (Optional) The base directory used for relative --log-file paths</td>
</tr>
<tr>
<td>log_file = None</td>
<td>(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.</td>
</tr>
<tr>
<td>log_format = None</td>
<td>(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.</td>
</tr>
<tr>
<td>logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s</td>
<td>(StrOpt) Format string to use for log messages with context</td>
</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>
</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>
</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>
</tr>
<tr>
<td>publish_errors = False</td>
<td>(BoolOpt) Publish error events</td>
</tr>
<tr>
<td>syslog_log_facility = LOG_USER</td>
<td>(StrOpt) Syslog facility to receive log lines</td>
</tr>
<tr>
<td>use_stderr = True</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>
</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>
</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>
<?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_logging">
<caption>Description of configuration options for logging</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>debug = False</td>
<td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).</td>
</tr>
<tr>
<td>default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN</td>
<td>(ListOpt) List of logger=LEVEL pairs.</td>
</tr>
<tr>
<td>instance_format = "[instance: %(uuid)s] "</td>
<td>(StrOpt) The format for an instance that is passed with the log message. </td>
</tr>
<tr>
<td>instance_uuid_format = "[instance: %(uuid)s] "</td>
<td>(StrOpt) The format for an instance UUID that is passed with the log message. </td>
</tr>
<tr>
<td>log_config_append = None</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>
</tr>
<tr>
<td>log_dir = None</td>
<td>(StrOpt) (Optional) The base directory used for relative --log-file paths.</td>
</tr>
<tr>
<td>log_file = None</td>
<td>(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.</td>
</tr>
<tr>
<td>log_format = None</td>
<td>(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.</td>
</tr>
<tr>
<td>logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s</td>
<td>(StrOpt) Format string to use for log messages with context.</td>
</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>
</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>
</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>
</tr>
<tr>
<td>publish_errors = False</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>
</tr>
<tr>
<td>use_stderr = True</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 will change in J to honor RFC5424.</td>
</tr>
<tr>
<td>use_syslog_rfc_format = False</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>
</tbody>
</table>
</para>

69
doc/common/tables/ceilometer-nova_cells.xml Normal file
View 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
View 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>

125
doc/common/tables/ceilometer-qpid.xml
View File

@ -1,63 +1,62 @@
<?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_qpid">
<caption>Description of configuration options for qpid</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>qpid_heartbeat = 60</td>
<td>(IntOpt) Seconds between connection keepalive heartbeats</td>
</tr>
<tr>
<td>qpid_hostname = localhost</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>
</tr>
<tr>
<td>qpid_password = </td>
<td>(StrOpt) Password for qpid connection</td>
</tr>
<tr>
<td>qpid_port = 5672</td>
<td>(IntOpt) Qpid broker port</td>
</tr>
<tr>
<td>qpid_protocol = tcp</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>
</tr>
<tr>
<td>qpid_tcp_nodelay = True</td>
<td>(BoolOpt) Disable Nagle algorithm</td>
</tr>
<tr>
<td>qpid_topology_version = 1</td>
<td>(IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.</td>
</tr>
<tr>
<td>qpid_username = </td>
<td>(StrOpt) Username for qpid connection</td>
</tr>
</tbody>
</table>
</para>
<?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_qpid">
<caption>Description of configuration options for qpid</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>qpid_heartbeat = 60</td>
<td>(IntOpt) Seconds between connection keepalive heartbeats.</td>
</tr>
<tr>
<td>qpid_hostname = localhost</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>
</tr>
<tr>
<td>qpid_password = </td>
<td>(StrOpt) Password for Qpid connection.</td>
</tr>
<tr>
<td>qpid_port = 5672</td>
<td>(IntOpt) Qpid broker port.</td>
</tr>
<tr>
<td>qpid_protocol = tcp</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>
</tr>
<tr>
<td>qpid_tcp_nodelay = True</td>
<td>(BoolOpt) Whether to disable the Nagle algorithm.</td>
</tr>
<tr>
<td>qpid_topology_version = 1</td>
<td>(IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.</td>
</tr>
<tr>
<td>qpid_username = </td>
<td>(StrOpt) Username for Qpid connection.</td>
</tr>
</tbody>
</table>
</para>

181
doc/common/tables/ceilometer-rabbitmq.xml
View File

@ -1,87 +1,94 @@
<?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_rabbitmq">
<caption>Description of configuration options for rabbitmq</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>fake_rabbit = False</td>
<td>(BoolOpt) If passed, use a fake RabbitMQ provider</td>
</tr>
<tr>
<td>kombu_ssl_ca_certs = </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>
</tr>
<tr>
<td>kombu_ssl_keyfile = </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>
</tr>
<tr>
<td>rabbit_ha_queues = False</td>
<td>(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database.</td>
</tr>
<tr>
<td>rabbit_host = localhost</td>
<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>
</tr>
<tr>
<td>rabbit_max_retries = 0</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>
</tr>
<tr>
<td>rabbit_port = 5672</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>
</tr>
<tr>
<td>rabbit_retry_interval = 1</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>
</tr>
<tr>
<td>rabbit_userid = guest</td>
<td>(StrOpt) The RabbitMQ userid</td>
</tr>
<tr>
<td>rabbit_virtual_host = /</td>
<td>(StrOpt) The RabbitMQ virtual host</td>
</tr>
</tbody>
</table>
</para>
<?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_rabbitmq">
<caption>Description of configuration options for rabbitmq</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>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>
</tr>
<tr>
<td>kombu_ssl_certfile = </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>
</tr>
<tr>
<td>kombu_ssl_version = </td>
<td>(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions.</td>
</tr>
<tr>
<td>rabbit_ha_queues = False</td>
<td>(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database.</td>
</tr>
<tr>
<td>rabbit_host = localhost</td>
<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>
</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>
</tr>
<tr>
<td>rabbit_password = guest</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>
</tr>
<tr>
<td>rabbit_retry_backoff = 2</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>
</tr>
<tr>
<td>rabbit_use_ssl = False</td>
<td>(BoolOpt) Connect over SSL for RabbitMQ.</td>
</tr>
<tr>
<td>rabbit_userid = guest</td>
<td>(StrOpt) The RabbitMQ userid.</td>
</tr>
<tr>
<td>rabbit_virtual_host = /</td>
<td>(StrOpt) The RabbitMQ virtual host.</td>
</tr>
</tbody>
</table>
</para>

98
doc/common/tables/ceilometer-redis.xml
View File

@ -1,57 +1,41 @@
<?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_redis">
<caption>Description of configuration options for redis</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>host = oslo</td>
<td>(StrOpt) Name of this node, which must be valid in an AMQP key. Can be an opaque identifier. For ZeroMQ only, must be a valid host name, FQDN, or IP address.</td>
</tr>
<tr>
<td>matchmaker_heartbeat_freq = 300</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>
</tr>
</tbody>
</table>
</para>
<?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_redis">
<caption>Description of configuration options for redis</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>host = oslo</td>
<td>(StrOpt) Name of this node, which must be valid in an AMQP key. Can be an opaque identifier. For ZeroMQ only, must be a valid host name, FQDN, or IP address.</td>
</tr>
<tr>
<td>matchmaker_heartbeat_freq = 300</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_ring]</th>
</tr>
<tr>
<td>ringfile = /etc/oslo/matchmaker_ring.json</td>
<td>(StrOpt) Matchmaker ring file (JSON).</td>
</tr>
</tbody>
</table>
</para>

211
doc/common/tables/ceilometer-rpc.xml
View File

@ -1,100 +1,111 @@
<?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_rpc">
<caption>Description of configuration options for rpc</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>allowed_rpc_exception_modules = nova.exception, cinder.exception, exceptions</td>
<td>(ListOpt) Modules of exceptions that are permitted to be recreated upon receiving exception data from an rpc call.</td>
</tr>
<tr>
<td>dispatcher = ['database']</td>
<td>(MultiStrOpt) Dispatcher to process data.</td>
</tr>
<tr>
<td>rpc_backend = ceilometer.openstack.common.rpc.impl_kombu</td>
<td>(StrOpt) The messaging module to use, defaults to kombu.</td>
</tr>
<tr>
<td>rpc_cast_timeout = 30</td>
<td>(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq.</td>
</tr>
<tr>
<td>rpc_conn_pool_size = 30</td>
<td>(IntOpt) Size of RPC connection pool</td>
</tr>
<tr>
<td>rpc_response_timeout = 60</td>
<td>(IntOpt) Seconds to wait for a response from call or multicall</td>
</tr>
<tr>
<td>rpc_thread_pool_size = 64</td>
<td>(IntOpt) Size of RPC thread pool</td>
</tr>
<tr>
<td>rpc_zmq_bind_address = *</td>
<td>(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address.</td>
</tr>
<tr>
<td>rpc_zmq_contexts = 1</td>
<td>(IntOpt) Number of ZeroMQ contexts, defaults to 1</td>
</tr>
<tr>
<td>rpc_zmq_host = oslo</td>
<td>(StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova.</td>
</tr>
<tr>
<td>rpc_zmq_ipc_dir = /var/run/openstack</td>
<td>(StrOpt) Directory for holding IPC sockets</td>
</tr>
<tr>
<td>rpc_zmq_matchmaker = ceilometer.openstack.common.rpc.matchmaker.MatchMakerLocalhost</td>
<td>(StrOpt) MatchMaker driver</td>
</tr>
<tr>
<td>rpc_zmq_port = 9501</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>
<th colspan="2">[publisher]</th>
</tr>
<tr>
<td>metering_secret = change this or be hacked</td>
<td>(StrOpt) Secret value for signing metering messages.</td>
</tr>
<tr>
<th colspan="2">[publisher_rpc]</th>
</tr>
<tr>
<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>
<?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_rpc">
<caption>Description of configuration options for rpc</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>allowed_rpc_exception_modules = nova.exception, cinder.exception, exceptions</td>
<td>(ListOpt) Modules of exceptions that are permitted to be recreated upon receiving exception data from an rpc call.</td>
</tr>
<tr>
<td>dispatcher = ['database']</td>
<td>(MultiStrOpt) Dispatcher to process data.</td>
</tr>
<tr>
<td>password = None</td>
<td>(StrOpt) Password for Redis server (optional).</td>
</tr>
<tr>
<td>port = 6379</td>
<td>(IntOpt) Use this port to connect to redis host.</td>
</tr>
<tr>
<td>rpc_backend = ceilometer.openstack.common.rpc.impl_kombu</td>
<td>(StrOpt) The messaging module to use, defaults to kombu.</td>
</tr>
<tr>
<td>rpc_cast_timeout = 30</td>
<td>(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq.</td>
</tr>
<tr>
<td>rpc_conn_pool_size = 30</td>
<td>(IntOpt) Size of RPC connection pool</td>
</tr>
<tr>
<td>rpc_response_timeout = 60</td>
<td>(IntOpt) Seconds to wait for a response from call or multicall</td>
</tr>
<tr>
<td>rpc_thread_pool_size = 64</td>
<td>(IntOpt) Size of RPC thread pool</td>
</tr>
<tr>
<td>rpc_zmq_bind_address = *</td>
<td>(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address.</td>
</tr>
<tr>
<td>rpc_zmq_contexts = 1</td>
<td>(IntOpt) Number of ZeroMQ contexts, defaults to 1.</td>
</tr>
<tr>
<td>rpc_zmq_host = oslo</td>
<td>(StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova.</td>
</tr>
<tr>
<td>rpc_zmq_ipc_dir = /var/run/openstack</td>
<td>(StrOpt) Directory for holding IPC sockets.</td>
</tr>
<tr>
<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>
</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>
<tr>
<td>metering_secret = change this or be hacked</td>
<td>(StrOpt) Secret value for signing metering messages.</td>
</tr>
<tr>
<th colspan="2">[publisher_rpc]</th>
</tr>
<tr>
<td>metering_topic = metering</td>
<td>(StrOpt) The topic that ceilometer uses for metering messages.</td>
</tr>
</tbody>
</table>
</para>

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

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

53
doc/common/tables/ceilometer-swift.xml
View File

@ -1,27 +1,26 @@
<?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_swift">
<caption>Description of configuration options for swift</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>reseller_prefix = AUTH_</td>
<td>(StrOpt) Swift reseller prefix. Must be on par with reseller_prefix in proxy-server.conf.</td>
</tr>
</tbody>
</table>
</para>
<?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_swift">
<caption>Description of configuration options for swift</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>reseller_prefix = AUTH_</td>
<td>(StrOpt) Swift reseller prefix. Must be on par with reseller_prefix in proxy-server.conf.</td>
</tr>
</tbody>
</table>
</para>

89
doc/common/tables/ceilometer-vmware.xml
View File

@ -1,43 +1,46 @@
<?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_vmware">
<caption>Description of configuration options for vmware</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">[vmware]</th>
</tr>
<tr>
<td>api_retry_count = 10</td>
<td>(IntOpt) Number of times a VMware Vsphere API must be retried</td>
</tr>
<tr>
<td>host_ip = </td>
<td>(StrOpt) IP address of the VMware Vsphere host</td>
</tr>
<tr>
<td>host_password = </td>
<td>(StrOpt) Password of VMware Vsphere</td>
</tr>
<tr>
<td>host_username = </td>
<td>(StrOpt) Username of VMware Vsphere</td>
</tr>
<tr>
<td>task_poll_interval = 0.5</td>
<td>(FloatOpt) Sleep time in seconds for polling an ongoing async task</td>
</tr>
</tbody>
</table>
</para>
<?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_vmware">
<caption>Description of configuration options for vmware</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">[vmware]</th>
</tr>
<tr>
<td>api_retry_count = 10</td>
<td>(IntOpt) Number of times a VMware Vsphere API must be retried</td>
</tr>
<tr>
<td>host_ip = </td>
<td>(StrOpt) IP address of the VMware Vsphere host</td>
</tr>
<tr>
<td>host_password = </td>
<td>(StrOpt) Password of VMware Vsphere</td>
</tr>
<tr>
<td>host_username = </td>
<td>(StrOpt) Username of VMware Vsphere</td>
</tr>
<tr>
<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>

205
doc/common/tables/cinder-api.xml
View File

@ -1,103 +1,102 @@
<?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_api">
<caption>Description of configuration options for api</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>api_paste_config = api-paste.ini</td>
<td>(StrOpt) File name for the paste.deploy config for cinder-api</td>
</tr>
<tr>
<td>api_rate_limit = True</td>
<td>(BoolOpt) whether to rate limit the api</td>
</tr>
<tr>
<td>backdoor_port = None</td>
<td>(StrOpt) Enable eventlet backdoor. Acceptable values are 0, &lt;port&gt;, and &lt;start&gt;:&lt;end&gt;, where 0 results in listening on a random tcp port number; &lt;port&gt; results in listening on the specified port number (and not enabling backdoor if that port is in use); and &lt;start&gt;:&lt;end&gt; results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.</td>
</tr>
<tr>
<td>enable_v1_api = True</td>
<td>(BoolOpt) Deploy v1 of the Cinder API.</td>
</tr>
<tr>
<td>enable_v2_api = True</td>
<td>(BoolOpt) Deploy v2 of the Cinder API.</td>
</tr>
<tr>
<td>extra_capabilities = {}</td>
<td>(StrOpt) User defined capabilities, a JSON formatted string specifying key/value pairs.</td>
</tr>
<tr>
<td>max_header_line = 16384</td>
<td>(IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs).</td>
</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>
</tr>
<tr>
<td>osapi_max_request_body_size = 114688</td>
<td>(IntOpt) Max size for body of a request</td>
</tr>
<tr>
<td>osapi_volume_base_URL = None</td>
<td>(StrOpt) Base URL that will be presented to users in links to the OpenStack Volume API</td>
</tr>
<tr>
<td>osapi_volume_ext_list = </td>
<td>(ListOpt) Specify list of extensions to load when using osapi_volume_extension option with cinder.api.contrib.select_extensions</td>
</tr>
<tr>
<td>osapi_volume_extension = ['cinder.api.contrib.standard_extensions']</td>
<td>(MultiStrOpt) osapi volume extension to load</td>
</tr>
<tr>
<td>osapi_volume_listen = 0.0.0.0</td>
<td>(StrOpt) IP address for OpenStack Volume API to listen</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>
</tr>
<tr>
<td>transfer_api_class = cinder.transfer.api.API</td>
<td>(StrOpt) The full class name of the volume transfer API class</td>
</tr>
<tr>
<td>volume_api_class = cinder.volume.api.API</td>
<td>(StrOpt) The full class name of the volume API class to use</td>
</tr>
<tr>
<td>volume_name_template = volume-%s</td>
<td>(StrOpt) Template string to be used to generate volume names</td>
</tr>
<tr>
<td>volume_transfer_key_length = 16</td>
<td>(IntOpt) The number of characters in the autogenerated auth key.</td>
</tr>
<tr>
<td>volume_transfer_salt_length = 8</td>
<td>(IntOpt) The number of characters in the salt.</td>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_api">
<caption>Description of configuration options for api</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>api_paste_config = api-paste.ini</td>
<td>(StrOpt) File name for the paste.deploy config for cinder-api</td>
</tr>
<tr>
<td>api_rate_limit = True</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>
<td>(StrOpt) Enable eventlet backdoor. Acceptable values are 0, &lt;port&gt;, and &lt;start&gt;:&lt;end&gt;, where 0 results in listening on a random tcp port number; &lt;port&gt; results in listening on the specified port number (and not enabling backdoor if that port is in use); and &lt;start&gt;:&lt;end&gt; results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.</td>
</tr>
<tr>
<td>enable_v1_api = True</td>
<td>(BoolOpt) Deploy v1 of the Cinder API.</td>
</tr>
<tr>
<td>enable_v2_api = True</td>
<td>(BoolOpt) Deploy v2 of the Cinder API.</td>
</tr>
<tr>
<td>extra_capabilities = {}</td>
<td>(StrOpt) User defined capabilities, a JSON formatted string specifying key/value pairs.</td>
</tr>
<tr>
<td>max_header_line = 16384</td>
<td>(IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs).</td>
</tr>
<tr>
<td>osapi_max_limit = 1000</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>
<td>(IntOpt) Max size for body of a request</td>
</tr>
<tr>
<td>osapi_volume_base_URL = None</td>
<td>(StrOpt) Base URL that will be presented to users in links to the OpenStack Volume API</td>
</tr>
<tr>
<td>osapi_volume_ext_list = </td>
<td>(ListOpt) Specify list of extensions to load when using osapi_volume_extension option with cinder.api.contrib.select_extensions</td>
</tr>
<tr>
<td>osapi_volume_extension = ['cinder.api.contrib.standard_extensions']</td>
<td>(MultiStrOpt) osapi volume extension to load</td>
</tr>
<tr>
<td>osapi_volume_listen = 0.0.0.0</td>
<td>(StrOpt) IP address on which OpenStack Volume API listens</td>
</tr>
<tr>
<td>osapi_volume_listen_port = 8776</td>
<td>(IntOpt) Port on which OpenStack Volume API listens</td>
</tr>
<tr>
<td>transfer_api_class = cinder.transfer.api.API</td>
<td>(StrOpt) The full class name of the volume transfer API class</td>
</tr>
<tr>
<td>volume_api_class = cinder.volume.api.API</td>
<td>(StrOpt) The full class name of the volume API class to use</td>
</tr>
<tr>
<td>volume_name_template = volume-%s</td>
<td>(StrOpt) Template string to be used to generate volume names</td>
</tr>
<tr>
<td>volume_transfer_key_length = 16</td>
<td>(IntOpt) The number of characters in the autogenerated auth key.</td>
</tr>
<tr>
<td>volume_transfer_salt_length = 8</td>
<td>(IntOpt) The number of characters in the salt.</td>
</tr>
</tbody>
</table>
</para>

53
doc/common/tables/cinder-auth.xml
View File

@ -1,27 +1,26 @@
<?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_auth">
<caption>Description of configuration options for auth</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>auth_strategy = noauth</td>
<td>(StrOpt) The strategy to use for auth. Supports noauth, keystone, and deprecated.</td>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_auth">
<caption>Description of configuration options for auth</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>auth_strategy = noauth</td>
<td>(StrOpt) The strategy to use for auth. Supports noauth, keystone, and deprecated.</td>
</tr>
</tbody>
</table>
</para>

279
doc/common/tables/cinder-auth_token.xml
View File

@ -1,134 +1,145 @@
<?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_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">[DEFAULT]</th>
</tr>
<tr>
<td>memcached_servers = None</td>
<td>(ListOpt) Memcached servers or None for in process cache.</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>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_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">[DEFAULT]</th>
</tr>
<tr>
<td>memcached_servers = None</td>
<td>(ListOpt) Memcached servers or None for in process cache.</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) 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>

117
doc/common/tables/cinder-backups.xml
View File

@ -1,59 +1,58 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all" xml:id="config_table_cinder_backups">
<caption>Description of configuration options for backups</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>backup_api_class = cinder.backup.api.API</td>
<td>(StrOpt) The full class name of the volume backup API class</td>
</tr>
<tr>
<td>backup_compression_algorithm = zlib</td>
<td>(StrOpt) Compression algorithm (None to disable)</td>
</tr>
<tr>
<td>backup_driver = cinder.backup.drivers.swift</td>
<td>(StrOpt) Driver to use for backups.</td>
</tr>
<tr>
<td>backup_manager = cinder.backup.manager.BackupManager</td>
<td>(StrOpt) full class name for the Manager for volume backup</td>
</tr>
<tr>
<td>backup_metadata_version = 1</td>
<td>(IntOpt) Backup metadata version to be used when backing up volume metadata. If this number is bumped, make sure the service doing the restore supports the new version.</td>
</tr>
<tr>
<td>backup_name_template = backup-%s</td>
<td>(StrOpt) Template string to be used to generate backup names</td>
</tr>
<tr>
<td>backup_topic = cinder-backup</td>
<td>(StrOpt) the topic volume backup nodes listen on</td>
</tr>
<tr>
<td>snapshot_name_template = snapshot-%s</td>
<td>(StrOpt) Template string to be used to generate snapshot names</td>
</tr>
<tr>
<td>snapshot_same_host = True</td>
<td>(BoolOpt) Create volume from snapshot at the host where snapshot resides</td>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_backups">
<caption>Description of configuration options for backups</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>backup_api_class = cinder.backup.api.API</td>
<td>(StrOpt) The full class name of the volume backup API class</td>
</tr>
<tr>
<td>backup_compression_algorithm = zlib</td>
<td>(StrOpt) Compression algorithm (None to disable)</td>
</tr>
<tr>
<td>backup_driver = cinder.backup.drivers.swift</td>
<td>(StrOpt) Driver to use for backups.</td>
</tr>
<tr>
<td>backup_manager = cinder.backup.manager.BackupManager</td>
<td>(StrOpt) Full class name for the Manager for volume backup</td>
</tr>
<tr>
<td>backup_metadata_version = 1</td>
<td>(IntOpt) Backup metadata version to be used when backing up volume metadata. If this number is bumped, make sure the service doing the restore supports the new version.</td>
</tr>
<tr>
<td>backup_name_template = backup-%s</td>
<td>(StrOpt) Template string to be used to generate backup names</td>
</tr>
<tr>
<td>backup_topic = cinder-backup</td>
<td>(StrOpt) The topic that volume backup nodes listen on</td>
</tr>
<tr>
<td>snapshot_name_template = snapshot-%s</td>
<td>(StrOpt) Template string to be used to generate snapshot names</td>
</tr>
<tr>
<td>snapshot_same_host = True</td>
<td>(BoolOpt) Create volume from snapshot at the host where snapshot resides</td>
</tr>
</tbody>
</table>
</para>

101
doc/common/tables/cinder-backups_ceph.xml
View File

@ -1,51 +1,50 @@
<?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_backups_ceph">
<caption>Description of configuration options for backups_ceph</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>backup_ceph_chunk_size = 134217728</td>
<td>(IntOpt) The chunk size, in bytes, that a backup is broken into before transfer to the Ceph object store.</td>
</tr>
<tr>
<td>backup_ceph_conf = /etc/ceph/ceph.conf</td>
<td>(StrOpt) Ceph configuration file to use.</td>
</tr>
<tr>
<td>backup_ceph_pool = backups</td>
<td>(StrOpt) The Ceph pool where volume backups are stored.</td>
</tr>
<tr>
<td>backup_ceph_stripe_count = 0</td>
<td>(IntOpt) RBD stripe count to use when creating a backup image.</td>
</tr>
<tr>
<td>backup_ceph_stripe_unit = 0</td>
<td>(IntOpt) RBD stripe unit to use when creating a backup image.</td>
</tr>
<tr>
<td>backup_ceph_user = cinder</td>
<td>(StrOpt) The Ceph user to connect with. Default here is to use the same user as for Cinder volumes. If not using cephx this should be set to None.</td>
</tr>
<tr>
<td>restore_discard_excess_bytes = True</td>
<td>(BoolOpt) If True, always discard excess bytes when restoring volumes i.e. pad with zeroes.</td>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_backups_ceph">
<caption>Description of configuration options for backups_ceph</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>backup_ceph_chunk_size = 134217728</td>
<td>(IntOpt) The chunk size, in bytes, that a backup is broken into before transfer to the Ceph object store.</td>
</tr>
<tr>
<td>backup_ceph_conf = /etc/ceph/ceph.conf</td>
<td>(StrOpt) Ceph configuration file to use.</td>
</tr>
<tr>
<td>backup_ceph_pool = backups</td>
<td>(StrOpt) The Ceph pool where volume backups are stored.</td>
</tr>
<tr>
<td>backup_ceph_stripe_count = 0</td>
<td>(IntOpt) RBD stripe count to use when creating a backup image.</td>
</tr>
<tr>
<td>backup_ceph_stripe_unit = 0</td>
<td>(IntOpt) RBD stripe unit to use when creating a backup image.</td>
</tr>
<tr>
<td>backup_ceph_user = cinder</td>
<td>(StrOpt) The Ceph user to connect with. Default here is to use the same user as for Cinder volumes. If not using cephx this should be set to None.</td>
</tr>
<tr>
<td>restore_discard_excess_bytes = True</td>
<td>(BoolOpt) If True, always discard excess bytes when restoring volumes i.e. pad with zeroes.</td>
</tr>
</tbody>
</table>
</para>

109
doc/common/tables/cinder-backups_swift.xml
View File

@ -1,55 +1,54 @@
<?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_backups_swift">
<caption>Description of configuration options for backups_swift</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>backup_swift_auth = per_user</td>
<td>(StrOpt) Swift authentication mechanism</td>
</tr>
<tr>
<td>backup_swift_container = volumebackups</td>
<td>(StrOpt) The default Swift container to use</td>
</tr>
<tr>
<td>backup_swift_key = None</td>
<td>(StrOpt) Swift key for authentication</td>
</tr>
<tr>
<td>backup_swift_object_size = 52428800</td>
<td>(IntOpt) The size in bytes of Swift backup objects</td>
</tr>
<tr>
<td>backup_swift_retry_attempts = 3</td>
<td>(IntOpt) The number of retries to make for Swift operations</td>
</tr>
<tr>
<td>backup_swift_retry_backoff = 2</td>
<td>(IntOpt) The backoff time in seconds between Swift retries</td>
</tr>
<tr>
<td>backup_swift_url = http://localhost:8080/v1/AUTH_</td>
<td>(StrOpt) The URL of the Swift endpoint</td>
</tr>
<tr>
<td>backup_swift_user = None</td>
<td>(StrOpt) Swift user name</td>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_backups_swift">
<caption>Description of configuration options for backups_swift</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>backup_swift_auth = per_user</td>
<td>(StrOpt) Swift authentication mechanism</td>
</tr>
<tr>
<td>backup_swift_container = volumebackups</td>
<td>(StrOpt) The default Swift container to use</td>
</tr>
<tr>
<td>backup_swift_key = None</td>
<td>(StrOpt) Swift key for authentication</td>
</tr>
<tr>
<td>backup_swift_object_size = 52428800</td>
<td>(IntOpt) The size in bytes of Swift backup objects</td>
</tr>
<tr>
<td>backup_swift_retry_attempts = 3</td>
<td>(IntOpt) The number of retries to make for Swift operations</td>
</tr>
<tr>
<td>backup_swift_retry_backoff = 2</td>
<td>(IntOpt) The backoff time in seconds between Swift retries</td>
</tr>
<tr>
<td>backup_swift_url = http://localhost:8080/v1/AUTH_</td>
<td>(StrOpt) The URL of the Swift endpoint</td>
</tr>
<tr>
<td>backup_swift_user = None</td>
<td>(StrOpt) Swift user name</td>
</tr>
</tbody>
</table>
</para>

69
doc/common/tables/cinder-backups_tsm.xml
View File

@ -1,35 +1,34 @@
<?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_backups_tsm">
<caption>Description of configuration options for backups_tsm</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>backup_tsm_compression = True</td>
<td>(BoolOpt) Enable or Disable compression for backups</td>
</tr>
<tr>
<td>backup_tsm_password = password</td>
<td>(StrOpt) TSM password for the running username</td>
</tr>
<tr>
<td>backup_tsm_volume_prefix = backup</td>
<td>(StrOpt) Volume prefix for the backup id when backing up to TSM</td>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_backups_tsm">
<caption>Description of configuration options for backups_tsm</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>backup_tsm_compression = True</td>
<td>(BoolOpt) Enable or Disable compression for backups</td>
</tr>
<tr>
<td>backup_tsm_password = password</td>
<td>(StrOpt) TSM password for the running username</td>
</tr>
<tr>
<td>backup_tsm_volume_prefix = backup</td>
<td>(StrOpt) Volume prefix for the backup id when backing up to TSM</td>
</tr>
</tbody>
</table>
</para>

53
doc/common/tables/cinder-block-device.xml
View File

@ -1,27 +1,26 @@
<?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_block-device">
<caption>Description of configuration options for block-device</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>available_devices = </td>
<td>(ListOpt) List of all available devices</td>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_block-device">
<caption>Description of configuration options for block-device</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>available_devices = </td>
<td>(ListOpt) List of all available devices</td>
</tr>
</tbody>
</table>
</para>

472
doc/common/tables/cinder-common.xml
View File

@ -1,242 +1,230 @@
<?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_common">
<caption>Description of configuration options for common</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>compute_api_class = cinder.compute.nova.API</td>
<td>(StrOpt) The full class name of the compute API class to use</td>
</tr>
<tr>
<td>debug = False</td>
<td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).</td>
</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>
</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>
</tr>
<tr>
<td>default_volume_type = None</td>
<td>(StrOpt) default volume type to use</td>
</tr>
<tr>
<td>disable_process_locking = False</td>
<td>(BoolOpt) Whether to disable inter-process locks</td>
</tr>
<tr>
<td>enable_new_services = True</td>
<td>(BoolOpt) Services to be added to the available pool on create</td>
</tr>
<tr>
<td>fatal_deprecations = False</td>
<td>(BoolOpt) Make deprecations fatal</td>
</tr>
<tr>
<td>fatal_exception_format_errors = False</td>
<td>(BoolOpt) make exception message format errors fatal</td>
</tr>
<tr>
<td>host = oslo</td>
<td>(StrOpt) Name of this node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address.</td>
</tr>
<tr>
<td>iet_conf = /etc/iet/ietd.conf</td>
<td>(StrOpt) IET configuration file</td>
</tr>
<tr>
<td>lio_initiator_iqns = </td>
<td>(StrOpt) Comma-separated list of initiator IQNs allowed to connect to the iSCSI target. (From Nova compute nodes.)</td>
</tr>
<tr>
<td>lock_path = None</td>
<td>(StrOpt) Directory to use for lock files. Default to a temp directory</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>
</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>
</tr>
<tr>
<td>log_dir = None</td>
<td>(StrOpt) (Optional) The base directory used for relative --log-file paths</td>
</tr>
<tr>
<td>log_file = None</td>
<td>(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.</td>
</tr>
<tr>
<td>log_format = None</td>
<td>(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.</td>
</tr>
<tr>
<td>logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s</td>
<td>(StrOpt) Format string to use for log messages with context</td>
</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>
</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>
</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>
</tr>
<tr>
<td>monkey_patch = False</td>
<td>(BoolOpt) Enable monkey patching</td>
</tr>
<tr>
<td>monkey_patch_modules = </td>
<td>(ListOpt) List of modules/decorators to monkey patch</td>
</tr>
<tr>
<td>my_ip = 10.0.0.1</td>
<td>(StrOpt) ip address of this host</td>
</tr>
<tr>
<td>no_snapshot_gb_quota = False</td>
<td>(BoolOpt) Whether snapshots count against GigaByte quota</td>
</tr>
<tr>
<td>num_shell_tries = 3</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>
</tr>
<tr>
<td>periodic_interval = 60</td>
<td>(IntOpt) seconds between running periodic tasks</td>
</tr>
<tr>
<td>policy_default_rule = default</td>
<td>(StrOpt) Rule checked when requested rule is not found</td>
</tr>
<tr>
<td>policy_file = policy.json</td>
<td>(StrOpt) JSON file representing policy</td>
</tr>
<tr>
<td>report_interval = 10</td>
<td>(IntOpt) seconds between nodes reporting state to datastore</td>
</tr>
<tr>
<td>reserved_percentage = 0</td>
<td>(IntOpt) The percentage of backend capacity is reserved</td>
</tr>
<tr>
<td>rootwrap_config = /etc/cinder/rootwrap.conf</td>
<td>(StrOpt) Path to the rootwrap configuration file to use for running commands as root</td>
</tr>
<tr>
<td>run_external_periodic_tasks = True</td>
<td>(BoolOpt) Some periodic tasks can be run in a separate process. Should we run them here?</td>
</tr>
<tr>
<td>service_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>
</tr>
<tr>
<td>ssl_ca_file = None</td>
<td>(StrOpt) CA certificate file to use to verify connecting clients</td>
</tr>
<tr>
<td>ssl_cert_file = None</td>
<td>(StrOpt) Certificate file to use when starting the server securely</td>
</tr>
<tr>
<td>ssl_key_file = None</td>
<td>(StrOpt) Private key file to use when starting the server securely</td>
</tr>
<tr>
<td>state_path = /var/lib/cinder</td>
<td>(StrOpt) Top-level directory for maintaining cinder's state</td>
</tr>
<tr>
<td>storage_availability_zone = nova</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>
</tr>
<tr>
<td>tcp_keepidle = 600</td>
<td>(IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X.</td>
</tr>
<tr>
<td>until_refresh = 0</td>
<td>(IntOpt) count of reservations until usage is refreshed</td>
</tr>
<tr>
<td>use_forwarded_for = False</td>
<td>(BoolOpt) Treat X-Forwarded-For as the canonical remote address. Only enable this if you have a sanitizing proxy.</td>
</tr>
<tr>
<td>use_stderr = True</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>
</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>
</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>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_common">
<caption>Description of configuration options for common</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>compute_api_class = cinder.compute.nova.API</td>
<td>(StrOpt) The full class name of the compute API class to use</td>
</tr>
<tr>
<td>debug = False</td>
<td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).</td>
</tr>
<tr>
<td>default_availability_zone = None</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>
</tr>
<tr>
<td>default_volume_type = None</td>
<td>(StrOpt) Default volume type to use</td>
</tr>
<tr>
<td>disable_process_locking = False</td>
<td>(BoolOpt) Whether to disable inter-process locks</td>
</tr>
<tr>
<td>enable_new_services = True</td>
<td>(BoolOpt) Services to be added to the available pool on create</td>
</tr>
<tr>
<td>fatal_deprecations = False</td>
<td>(BoolOpt) Enables or disables fatal status of deprecations.</td>
</tr>
<tr>
<td>fatal_exception_format_errors = False</td>
<td>(BoolOpt) make exception message format errors fatal</td>
</tr>
<tr>
<td>host = oslo</td>
<td>(StrOpt) Name of this node. This can be an opaque identifier. It is not necessarily a host name, FQDN, or IP address.</td>
</tr>
<tr>
<td>iet_conf = /etc/iet/ietd.conf</td>
<td>(StrOpt) IET configuration file</td>
</tr>
<tr>
<td>lio_initiator_iqns = </td>
<td>(StrOpt) Comma-separated list of initiator IQNs allowed to connect to the iSCSI target. (From Nova compute nodes.)</td>
</tr>
<tr>
<td>lock_path = None</td>
<td>(StrOpt) Directory to use for lock files. Default to a temp directory</td>
</tr>
<tr>
<td>log_config_append = None</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>
</tr>
<tr>
<td>log_dir = None</td>
<td>(StrOpt) (Optional) The base directory used for relative --log-file paths.</td>
</tr>
<tr>
<td>log_file = None</td>
<td>(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.</td>
</tr>
<tr>
<td>log_format = None</td>
<td>(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.</td>
</tr>
<tr>
<td>logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s</td>
<td>(StrOpt) Format string to use for log messages with context.</td>
</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>
</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>
</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>
</tr>
<tr>
<td>monkey_patch = False</td>
<td>(BoolOpt) Enable monkey patching</td>
</tr>
<tr>
<td>monkey_patch_modules = </td>
<td>(ListOpt) List of modules/decorators to monkey patch</td>
</tr>
<tr>
<td>my_ip = 10.0.0.1</td>
<td>(StrOpt) IP address of this host</td>
</tr>
<tr>
<td>no_snapshot_gb_quota = False</td>
<td>(BoolOpt) Whether snapshots count against GigaByte quota</td>
</tr>
<tr>
<td>num_shell_tries = 3</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, 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) Interval, in seconds, between running periodic tasks</td>
</tr>
<tr>
<td>policy_default_rule = default</td>
<td>(StrOpt) Rule checked when requested rule is not found</td>
</tr>
<tr>
<td>policy_file = policy.json</td>
<td>(StrOpt) JSON file representing policy</td>
</tr>
<tr>
<td>report_interval = 10</td>
<td>(IntOpt) Interval, in seconds, between nodes reporting state to datastore</td>
</tr>
<tr>
<td>reserved_percentage = 0</td>
<td>(IntOpt) The percentage of backend capacity is reserved</td>
</tr>
<tr>
<td>rootwrap_config = /etc/cinder/rootwrap.conf</td>
<td>(StrOpt) Path to the rootwrap configuration file to use for running commands as root</td>
</tr>
<tr>
<td>run_external_periodic_tasks = True</td>
<td>(BoolOpt) Some periodic tasks can be run in a separate process. Should we run them here?</td>
</tr>
<tr>
<td>service_down_time = 60</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>
<td>(StrOpt) CA certificate file to use to verify connecting clients</td>
</tr>
<tr>
<td>ssl_cert_file = None</td>
<td>(StrOpt) Certificate file to use when starting the server securely</td>
</tr>
<tr>
<td>ssl_key_file = None</td>
<td>(StrOpt) Private key file to use when starting the server securely</td>
</tr>
<tr>
<td>state_path = /var/lib/cinder</td>
<td>(StrOpt) Top-level directory for maintaining cinder's state</td>
</tr>
<tr>
<td>storage_availability_zone = nova</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>
</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>
<td>(IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X.</td>
</tr>
<tr>
<td>until_refresh = 0</td>
<td>(IntOpt) Count of reservations until usage is refreshed</td>
</tr>
<tr>
<td>use_forwarded_for = False</td>
<td>(BoolOpt) Treat X-Forwarded-For as the canonical remote address. Only enable this if you have a sanitizing proxy.</td>
</tr>
<tr>
<td>use_stderr = True</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 will chang in J to honor RFC5424.</td>
</tr>
<tr>
<td>use_syslog_rfc_format = False</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>
</tbody>
</table>
</para>

101
doc/common/tables/cinder-compute.xml
View File

@ -1,51 +1,50 @@
<?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_compute">
<caption>Description of configuration options for compute</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>nova_api_insecure = False</td>
<td>(BoolOpt) Allow to perform insecure SSL requests to nova</td>
</tr>
<tr>
<td>nova_ca_certificates_file = None</td>
<td>(StrOpt) Location of ca certificates file to use for nova client requests.</td>
</tr>
<tr>
<td>nova_catalog_admin_info = compute:nova:adminURL</td>
<td>(StrOpt) Same as nova_catalog_info, but for admin endpoint.</td>
</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>
</tr>
<tr>
<td>nova_endpoint_admin_template = None</td>
<td>(StrOpt) Same as nova_endpoint_template, but for admin endpoint.</td>
</tr>
<tr>
<td>nova_endpoint_template = None</td>
<td>(StrOpt) Override service catalog lookup with template for nova endpoint e.g. http://localhost:8774/v2/%(project_id)s</td>
</tr>
<tr>
<td>os_region_name = None</td>
<td>(StrOpt) region name of this node</td>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_compute">
<caption>Description of configuration options for compute</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>nova_api_insecure = False</td>
<td>(BoolOpt) Allow to perform insecure SSL requests to nova</td>
</tr>
<tr>
<td>nova_ca_certificates_file = None</td>
<td>(StrOpt) Location of ca certificates file to use for nova client requests.</td>
</tr>
<tr>
<td>nova_catalog_admin_info = compute:nova:adminURL</td>
<td>(StrOpt) Same as nova_catalog_info, but for admin endpoint.</td>
</tr>
<tr>
<td>nova_catalog_info = compute:nova:publicURL</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>
<td>(StrOpt) Same as nova_endpoint_template, but for admin endpoint.</td>
</tr>
<tr>
<td>nova_endpoint_template = None</td>
<td>(StrOpt) Override service catalog lookup with template for nova endpoint e.g. http://localhost:8774/v2/%(project_id)s</td>
</tr>
<tr>
<td>os_region_name = None</td>
<td>(StrOpt) Region name of this node</td>
</tr>
</tbody>
</table>
</para>

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

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

85
doc/common/tables/cinder-coraid.xml
View File

@ -1,43 +1,42 @@
<?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_coraid">
<caption>Description of configuration options for coraid</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>coraid_esm_address = </td>
<td>(StrOpt) IP address of Coraid ESM</td>
</tr>
<tr>
<td>coraid_group = admin</td>
<td>(StrOpt) Name of group on Coraid ESM to which coraid_user belongs (must have admin privilege)</td>
</tr>
<tr>
<td>coraid_password = password</td>
<td>(StrOpt) Password to connect to Coraid ESM</td>
</tr>
<tr>
<td>coraid_repository_key = coraid_repository</td>
<td>(StrOpt) Volume Type key name to store ESM Repository Name</td>
</tr>
<tr>
<td>coraid_user = admin</td>
<td>(StrOpt) User name to connect to Coraid ESM</td>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_coraid">
<caption>Description of configuration options for coraid</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>coraid_esm_address = </td>
<td>(StrOpt) IP address of Coraid ESM</td>
</tr>
<tr>
<td>coraid_group = admin</td>
<td>(StrOpt) Name of group on Coraid ESM to which coraid_user belongs (must have admin privilege)</td>
</tr>
<tr>
<td>coraid_password = password</td>
<td>(StrOpt) Password to connect to Coraid ESM</td>
</tr>
<tr>
<td>coraid_repository_key = coraid_repository</td>
<td>(StrOpt) Volume Type key name to store ESM Repository Name</td>
</tr>
<tr>
<td>coraid_user = admin</td>
<td>(StrOpt) User name to connect to Coraid ESM</td>
</tr>
</tbody>
</table>
</para>

148
doc/common/tables/cinder-database.xml
View File

@ -1,31 +1,117 @@
<?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_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">[DEFAULT]</th>
</tr>
<tr>
<td>db_backend = sqlalchemy</td>
<td>(StrOpt) The backend to use for db</td>
</tr>
<tr>
<td>db_driver = cinder.db</td>
<td>(StrOpt) driver to use for database access</td>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_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">[DEFAULT]</th>
</tr>
<tr>
<td>db_backend = sqlalchemy</td>
<td>(StrOpt) The backend to use for db</td>
</tr>
<tr>
<td>db_driver = cinder.db</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>
</para>

77
doc/common/tables/cinder-emc.xml
View File

@ -1,39 +1,38 @@
<?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_emc">
<caption>Description of configuration options for emc</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>cinder_emc_config_file = /etc/cinder/cinder_emc_config.xml</td>
<td>(StrOpt) use this file for cinder emc plugin config data</td>
</tr>
<tr>
<td>max_luns_per_storage_group = 256</td>
<td>(IntOpt) Default max number of LUNs in a storage group</td>
</tr>
<tr>
<td>naviseccli_path = </td>
<td>(StrOpt) Naviseccli Path</td>
</tr>
<tr>
<td>storage_vnx_pool_name = None</td>
<td>(StrOpt) ISCSI pool name</td>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_emc">
<caption>Description of configuration options for emc</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>cinder_emc_config_file = /etc/cinder/cinder_emc_config.xml</td>
<td>(StrOpt) The configuration file for the Cinder EMC driver</td>
</tr>
<tr>
<td>max_luns_per_storage_group = 256</td>
<td>(IntOpt) Default max number of LUNs in a storage group</td>
</tr>
<tr>
<td>naviseccli_path = </td>
<td>(StrOpt) Naviseccli Path</td>
</tr>
<tr>
<td>storage_vnx_pool_name = None</td>
<td>(StrOpt) ISCSI pool name</td>
</tr>
</tbody>
</table>
</para>

101
doc/common/tables/cinder-eqlx.xml
View File

@ -1,51 +1,50 @@
<?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_eqlx">
<caption>Description of configuration options for eqlx</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>eqlx_chap_login = admin</td>
<td>(StrOpt) Existing CHAP account name</td>
</tr>
<tr>
<td>eqlx_chap_password = password</td>
<td>(StrOpt) Password for specified CHAP account name</td>
</tr>
<tr>
<td>eqlx_cli_max_retries = 5</td>
<td>(IntOpt) Maximum retry count for reconnection</td>
</tr>
<tr>
<td>eqlx_cli_timeout = 30</td>
<td>(IntOpt) Timeout for the Group Manager cli command execution</td>
</tr>
<tr>
<td>eqlx_group_name = group-0</td>
<td>(StrOpt) Group name to use for creating volumes</td>
</tr>
<tr>
<td>eqlx_pool = default</td>
<td>(StrOpt) Pool in which volumes will be created</td>
</tr>
<tr>
<td>eqlx_use_chap = False</td>
<td>(BoolOpt) Use CHAP authentication for targets?</td>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_eqlx">
<caption>Description of configuration options for eqlx</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>eqlx_chap_login = admin</td>
<td>(StrOpt) Existing CHAP account name</td>
</tr>
<tr>
<td>eqlx_chap_password = password</td>
<td>(StrOpt) Password for specified CHAP account name</td>
</tr>
<tr>
<td>eqlx_cli_max_retries = 5</td>
<td>(IntOpt) Maximum retry count for reconnection</td>
</tr>
<tr>
<td>eqlx_cli_timeout = 30</td>
<td>(IntOpt) Timeout for the Group Manager cli command execution</td>
</tr>
<tr>
<td>eqlx_group_name = group-0</td>
<td>(StrOpt) Group name to use for creating volumes</td>
</tr>
<tr>
<td>eqlx_pool = default</td>
<td>(StrOpt) Pool in which volumes will be created</td>
</tr>
<tr>
<td>eqlx_use_chap = False</td>
<td>(BoolOpt) Use CHAP authentication for targets?</td>
</tr>
</tbody>
</table>
</para>

61
doc/common/tables/cinder-hds-hus.xml
View File

@ -1,27 +1,34 @@
<?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_hds-hus">
<caption>Description of configuration options for hds-hus</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>hds_cinder_config_file = /opt/hds/hus/cinder_hus_conf.xml</td>
<td>(StrOpt) configuration file for HDS cinder plugin for HUS</td>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_hds-hus">
<caption>Description of configuration options for hds-hus</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>hds_cinder_config_file = /opt/hds/hus/cinder_hus_conf.xml</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>
</para>

117
doc/common/tables/cinder-hp3par.xml
View File

@ -1,59 +1,58 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all" xml:id="config_table_cinder_hp3par">
<caption>Description of configuration options for hp3par</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>hp3par_api_url = </td>
<td>(StrOpt) 3PAR WSAPI Server Url like https://&lt;3par ip&gt;:8080/api/v1</td>
</tr>
<tr>
<td>hp3par_cpg = OpenStack</td>
<td>(StrOpt) The CPG to use for volume creation</td>
</tr>
<tr>
<td>hp3par_cpg_snap = </td>
<td>(StrOpt) The CPG to use for Snapshots for volumes. If empty hp3par_cpg will be used</td>
</tr>
<tr>
<td>hp3par_debug = False</td>
<td>(BoolOpt) Enable HTTP debugging to 3PAR</td>
</tr>
<tr>
<td>hp3par_iscsi_ips = </td>
<td>(ListOpt) List of target iSCSI addresses to use.</td>
</tr>
<tr>
<td>hp3par_password = </td>
<td>(StrOpt) 3PAR Super user password</td>
</tr>
<tr>
<td>hp3par_snapshot_expiration = </td>
<td>(StrOpt) The time in hours when a snapshot expires and is deleted. This must be larger than expiration</td>
</tr>
<tr>
<td>hp3par_snapshot_retention = </td>
<td>(StrOpt) The time in hours to retain a snapshot. You can't delete it before this expires.</td>
</tr>
<tr>
<td>hp3par_username = </td>
<td>(StrOpt) 3PAR Super user username</td>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_hp3par">
<caption>Description of configuration options for hp3par</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>hp3par_api_url = </td>
<td>(StrOpt) 3PAR WSAPI Server Url like https://&lt;3par ip&gt;:8080/api/v1</td>
</tr>
<tr>
<td>hp3par_cpg = OpenStack</td>
<td>(StrOpt) The CPG to use for volume creation</td>
</tr>
<tr>
<td>hp3par_cpg_snap = </td>
<td>(StrOpt) The CPG to use for Snapshots for volumes. If empty hp3par_cpg will be used</td>
</tr>
<tr>
<td>hp3par_debug = False</td>
<td>(BoolOpt) Enable HTTP debugging to 3PAR</td>
</tr>
<tr>
<td>hp3par_iscsi_ips = </td>
<td>(ListOpt) List of target iSCSI addresses to use.</td>
</tr>
<tr>
<td>hp3par_password = </td>
<td>(StrOpt) 3PAR Super user password</td>
</tr>
<tr>
<td>hp3par_snapshot_expiration = </td>
<td>(StrOpt) The time in hours when a snapshot expires and is deleted. This must be larger than expiration</td>
</tr>
<tr>
<td>hp3par_snapshot_retention = </td>
<td>(StrOpt) The time in hours to retain a snapshot. You can't delete it before this expires.</td>
</tr>
<tr>
<td>hp3par_username = </td>
<td>(StrOpt) 3PAR Super user username</td>
</tr>
</tbody>
</table>
</para>

93
doc/common/tables/cinder-hplefthand.xml
View File

@ -1,47 +1,46 @@
<?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_hplefthand">
<caption>Description of configuration options for hplefthand</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>hplefthand_api_url = None</td>
<td>(StrOpt) HP LeftHand WSAPI Server Url like https://&lt;LeftHand ip&gt;:8081/lhos</td>
</tr>
<tr>
<td>hplefthand_clustername = None</td>
<td>(StrOpt) HP LeftHand cluster name</td>
</tr>
<tr>
<td>hplefthand_debug = False</td>
<td>(BoolOpt) Enable HTTP debugging to LeftHand</td>
</tr>
<tr>
<td>hplefthand_iscsi_chap_enabled = False</td>
<td>(BoolOpt) Configure CHAP authentication for iSCSI connections (Default: Disabled)</td>
</tr>
<tr>
<td>hplefthand_password = None</td>
<td>(StrOpt) HP LeftHand Super user password</td>
</tr>
<tr>
<td>hplefthand_username = None</td>
<td>(StrOpt) HP LeftHand Super user username</td>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_hplefthand">
<caption>Description of configuration options for hplefthand</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>hplefthand_api_url = None</td>
<td>(StrOpt) HP LeftHand WSAPI Server Url like https://&lt;LeftHand ip&gt;:8081/lhos</td>
</tr>
<tr>
<td>hplefthand_clustername = None</td>
<td>(StrOpt) HP LeftHand cluster name</td>
</tr>
<tr>
<td>hplefthand_debug = False</td>
<td>(BoolOpt) Enable HTTP debugging to LeftHand</td>
</tr>
<tr>
<td>hplefthand_iscsi_chap_enabled = False</td>
<td>(BoolOpt) Configure CHAP authentication for iSCSI connections (Default: Disabled)</td>
</tr>
<tr>
<td>hplefthand_password = None</td>
<td>(StrOpt) HP LeftHand Super user password</td>
</tr>
<tr>
<td>hplefthand_username = None</td>
<td>(StrOpt) HP LeftHand Super user username</td>
</tr>
</tbody>
</table>
</para>

53
doc/common/tables/cinder-hpmsa.xml
View File

@ -1,27 +1,26 @@
<?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_hpmsa">
<caption>Description of configuration options for hpmsa</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>msa_vdisk = OpenStack</td>
<td>(StrOpt) The VDisk to use for volume creation.</td>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_hpmsa">
<caption>Description of configuration options for hpmsa</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>msa_vdisk = OpenStack</td>
<td>(StrOpt) The VDisk to use for volume creation.</td>
</tr>
</tbody>
</table>
</para>

53
doc/common/tables/cinder-huawei.xml
View File

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

153
doc/common/tables/cinder-images.xml
View File

@ -1,75 +1,78 @@
<?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_images">
<caption>Description of configuration options for images</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>allowed_direct_url_schemes = </td>
<td>(ListOpt) A list of url schemes that can be downloaded directly via the direct_url. Currently supported schemes: [file].</td>
</tr>
<tr>
<td>glance_api_insecure = False</td>
<td>(BoolOpt) Allow to perform insecure SSL (https) requests to glance</td>
</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>
</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>
</tr>
<tr>
<td>glance_api_version = 1</td>
<td>(IntOpt) Version of the glance api to use</td>
</tr>
<tr>
<td>glance_host = $my_ip</td>
<td>(StrOpt) default glance hostname or ip</td>
</tr>
<tr>
<td>glance_num_retries = 0</td>
<td>(IntOpt) Number retries when downloading an image from glance</td>
</tr>
<tr>
<td>glance_port = 9292</td>
<td>(IntOpt) default glance port</td>
</tr>
<tr>
<td>glance_request_timeout = None</td>
<td>(IntOpt) http/https timeout value for glance operations. If no value (None) is supplied here, the glanceclient default value is used.</td>
</tr>
<tr>
<td>image_conversion_dir = $state_path/conversion</td>
<td>(StrOpt) Directory used for temporary storage during image conversion</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>
</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>
</tr>
<tr>
<td>use_multipath_for_image_xfer = False</td>
<td>(BoolOpt) Do we attach/detach volumes in cinder using multipath for volume to image and image to volume transfers?</td>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_images">
<caption>Description of configuration options for images</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>allowed_direct_url_schemes = </td>
<td>(ListOpt) A list of url schemes that can be downloaded directly via the direct_url. Currently supported schemes: [file].</td>
</tr>
<tr>
<td>glance_api_insecure = False</td>
<td>(BoolOpt) Allow to perform insecure SSL (https) requests to glance</td>
</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>
</tr>
<tr>
<td>glance_api_ssl_compression = False</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>
</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 host name or IP</td>
</tr>
<tr>
<td>glance_num_retries = 0</td>
<td>(IntOpt) Number retries when downloading an image from glance</td>
</tr>
<tr>
<td>glance_port = 9292</td>
<td>(IntOpt) Default glance port</td>
</tr>
<tr>
<td>glance_request_timeout = None</td>
<td>(IntOpt) http/https timeout value for glance operations. If no value (None) is supplied here, the glanceclient default value is used.</td>
</tr>
<tr>
<td>image_conversion_dir = $state_path/conversion</td>
<td>(StrOpt) Directory used for temporary storage during image conversion</td>
</tr>
<tr>
<td>instance_format = "[instance: %(uuid)s] "</td>
<td>(StrOpt) The format for an instance that is passed with the log message. </td>
</tr>
<tr>
<td>instance_uuid_format = "[instance: %(uuid)s] "</td>
<td>(StrOpt) The format for an instance UUID that is passed with the log message. </td>
</tr>
<tr>
<td>use_multipath_for_image_xfer = False</td>
<td>(BoolOpt) Do we attach/detach volumes in cinder using multipath for volume to image and image to volume transfers?</td>
</tr>
</tbody>
</table>
</para>

61
doc/common/tables/cinder-keymgr.xml
View File

@ -1,31 +1,30 @@
<?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_keymgr">
<caption>Description of configuration options for keymgr</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">[keymgr]</th>
</tr>
<tr>
<td>api_class = cinder.keymgr.conf_key_mgr.ConfKeyManager</td>
<td>(StrOpt) The full class name of the key manager API class</td>
</tr>
<tr>
<td>fixed_key = None</td>
<td>(StrOpt) Fixed key returned by key manager, specified in hex</td>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_keymgr">
<caption>Description of configuration options for keymgr</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">[keymgr]</th>
</tr>
<tr>
<td>api_class = cinder.keymgr.conf_key_mgr.ConfKeyManager</td>
<td>(StrOpt) The full class name of the key manager API class</td>
</tr>
<tr>
<td>fixed_key = None</td>
<td>(StrOpt) Fixed key returned by key manager, specified in hex</td>
</tr>
</tbody>
</table>
</para>

69
doc/common/tables/cinder-lvm.xml
View File

@ -1,35 +1,34 @@
<?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_lvm">
<caption>Description of configuration options for lvm</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>lvm_mirrors = 0</td>
<td>(IntOpt) If set, create lvms with multiple mirrors. Note that this requires lvm_mirrors + 2 pvs with available space</td>
</tr>
<tr>
<td>lvm_type = default</td>
<td>(StrOpt) Type of LVM volumes to deploy; (default or thin)</td>
</tr>
<tr>
<td>volume_group = cinder-volumes</td>
<td>(StrOpt) Name for the VG that will contain exported volumes</td>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_lvm">
<caption>Description of configuration options for lvm</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>lvm_mirrors = 0</td>
<td>(IntOpt) If set, create lvms with multiple mirrors. Note that this requires lvm_mirrors + 2 pvs with available space</td>
</tr>
<tr>
<td>lvm_type = default</td>
<td>(StrOpt) Type of LVM volumes to deploy; (default or thin)</td>
</tr>
<tr>
<td>volume_group = cinder-volumes</td>
<td>(StrOpt) Name for the VG that will contain exported volumes</td>
</tr>
</tbody>
</table>
</para>

85
doc/common/tables/cinder-nas.xml
View File

@ -1,43 +1,42 @@
<?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_nas">
<caption>Description of configuration options for nas</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>nas_ip = </td>
<td>(StrOpt) IP address or Hostname of NAS system.</td>
</tr>
<tr>
<td>nas_login = admin</td>
<td>(StrOpt) User name to connect to NAS system.</td>
</tr>
<tr>
<td>nas_password = </td>
<td>(StrOpt) Password to connect to NAS system.</td>
</tr>
<tr>
<td>nas_private_key = </td>
<td>(StrOpt) Filename of private key to use for SSH authentication.</td>
</tr>
<tr>
<td>nas_ssh_port = 22</td>
<td>(IntOpt) SSH port to use to connect to NAS system.</td>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_nas">
<caption>Description of configuration options for nas</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>nas_ip = </td>
<td>(StrOpt) IP address or Hostname of NAS system.</td>
</tr>
<tr>
<td>nas_login = admin</td>
<td>(StrOpt) User name to connect to NAS system.</td>
</tr>
<tr>
<td>nas_password = </td>
<td>(StrOpt) Password to connect to NAS system.</td>
</tr>
<tr>
<td>nas_private_key = </td>
<td>(StrOpt) Filename of private key to use for SSH authentication.</td>
</tr>
<tr>
<td>nas_ssh_port = 22</td>
<td>(IntOpt) SSH port to use to connect to NAS system.</td>
</tr>
</tbody>
</table>
</para>

125
doc/common/tables/cinder-netapp_7mode_iscsi.xml
View File

@ -1,63 +1,62 @@
<?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_netapp_7mode_iscsi">
<caption>Description of configuration options for netapp_7mode_iscsi</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>netapp_login = None</td>
<td>(StrOpt) Administrative user account name used to access the storage system or proxy server.</td>
</tr>
<tr>
<td>netapp_password = None</td>
<td>(StrOpt) Password for the administrative user account specified in the netapp_login option.</td>
</tr>
<tr>
<td>netapp_server_hostname = None</td>
<td>(StrOpt) The hostname (or IP address) for the storage system or proxy server.</td>
</tr>
<tr>
<td>netapp_server_port = 80</td>
<td>(IntOpt) The TCP port to use for communication with the storage system or proxy server. Traditionally, port 80 is used for HTTP and port 443 is used for HTTPS; however, this value should be changed if an alternate port has been configured on the storage system or proxy server.</td>
</tr>
<tr>
<td>netapp_size_multiplier = 1.2</td>
<td>(FloatOpt) The quantity to be multiplied by the requested volume size to ensure enough space is available on the virtual storage server (Vserver) to fulfill the volume creation request.</td>
</tr>
<tr>
<td>netapp_storage_family = ontap_cluster</td>
<td>(StrOpt) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series.</td>
</tr>
<tr>
<td>netapp_storage_protocol = None</td>
<td>(StrOpt) The storage protocol to be used on the data path with the storage system; valid values are iscsi or nfs.</td>
</tr>
<tr>
<td>netapp_transport_type = http</td>
<td>(StrOpt) The transport protocol used when communicating with the storage system or proxy server. Valid values are http or https.</td>
</tr>
<tr>
<td>netapp_vfiler = None</td>
<td>(StrOpt) The vFiler unit on which provisioning of block storage volumes will be done. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode and the storage protocol selected is iSCSI. Only use this option when utilizing the MultiStore feature on the NetApp storage system.</td>
</tr>
<tr>
<td>netapp_volume_list = None</td>
<td>(StrOpt) This option is only utilized when the storage protocol is configured to use iSCSI. This option is used to restrict provisioning to the specified controller volumes. Specify the value of this option to be a comma separated list of NetApp controller volume names to be used for provisioning.</td>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_netapp_7mode_iscsi">
<caption>Description of configuration options for netapp_7mode_iscsi</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>netapp_login = None</td>
<td>(StrOpt) Administrative user account name used to access the storage system or proxy server.</td>
</tr>
<tr>
<td>netapp_password = None</td>
<td>(StrOpt) Password for the administrative user account specified in the netapp_login option.</td>
</tr>
<tr>
<td>netapp_server_hostname = None</td>
<td>(StrOpt) The hostname (or IP address) for the storage system or proxy server.</td>
</tr>
<tr>
<td>netapp_server_port = 80</td>
<td>(IntOpt) The TCP port to use for communication with the storage system or proxy server. Traditionally, port 80 is used for HTTP and port 443 is used for HTTPS; however, this value should be changed if an alternate port has been configured on the storage system or proxy server.</td>
</tr>
<tr>
<td>netapp_size_multiplier = 1.2</td>
<td>(FloatOpt) The quantity to be multiplied by the requested volume size to ensure enough space is available on the virtual storage server (Vserver) to fulfill the volume creation request.</td>
</tr>
<tr>
<td>netapp_storage_family = ontap_cluster</td>
<td>(StrOpt) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series.</td>
</tr>
<tr>
<td>netapp_storage_protocol = None</td>
<td>(StrOpt) The storage protocol to be used on the data path with the storage system; valid values are iscsi or nfs.</td>
</tr>
<tr>
<td>netapp_transport_type = http</td>
<td>(StrOpt) The transport protocol used when communicating with the storage system or proxy server. Valid values are http or https.</td>
</tr>
<tr>
<td>netapp_vfiler = None</td>
<td>(StrOpt) The vFiler unit on which provisioning of block storage volumes will be done. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode and the storage protocol selected is iSCSI. Only use this option when utilizing the MultiStore feature on the NetApp storage system.</td>
</tr>
<tr>
<td>netapp_volume_list = None</td>
<td>(StrOpt) This option is only utilized when the storage protocol is configured to use iSCSI. This option is used to restrict provisioning to the specified controller volumes. Specify the value of this option to be a comma separated list of NetApp controller volume names to be used for provisioning.</td>
</tr>
</tbody>
</table>
</para>

125
doc/common/tables/cinder-netapp_7mode_nfs.xml
View File

@ -1,63 +1,62 @@
<?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_netapp_7mode_nfs">
<caption>Description of configuration options for netapp_7mode_nfs</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>expiry_thres_minutes = 720</td>
<td>(IntOpt) This option specifies the threshold for last access time for images in the NFS image cache. When a cache cleaning cycle begins, images in the cache that have not been accessed in the last M minutes, where M is the value of this parameter, will be deleted from the cache to create free space on the NFS share.</td>
</tr>
<tr>
<td>netapp_login = None</td>
<td>(StrOpt) Administrative user account name used to access the storage system or proxy server.</td>
</tr>
<tr>
<td>netapp_password = None</td>
<td>(StrOpt) Password for the administrative user account specified in the netapp_login option.</td>
</tr>
<tr>
<td>netapp_server_hostname = None</td>
<td>(StrOpt) The hostname (or IP address) for the storage system or proxy server.</td>
</tr>
<tr>
<td>netapp_server_port = 80</td>
<td>(IntOpt) The TCP port to use for communication with the storage system or proxy server. Traditionally, port 80 is used for HTTP and port 443 is used for HTTPS; however, this value should be changed if an alternate port has been configured on the storage system or proxy server.</td>
</tr>
<tr>
<td>netapp_storage_family = ontap_cluster</td>
<td>(StrOpt) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series.</td>
</tr>
<tr>
<td>netapp_storage_protocol = None</td>
<td>(StrOpt) The storage protocol to be used on the data path with the storage system; valid values are iscsi or nfs.</td>
</tr>
<tr>
<td>netapp_transport_type = http</td>
<td>(StrOpt) The transport protocol used when communicating with the storage system or proxy server. Valid values are http or https.</td>
</tr>
<tr>
<td>thres_avl_size_perc_start = 20</td>
<td>(IntOpt) If the percentage of available space for an NFS share has dropped below the value specified by this option, the NFS image cache will be cleaned.</td>
</tr>
<tr>
<td>thres_avl_size_perc_stop = 60</td>
<td>(IntOpt) When the percentage of available space on an NFS share has reached the percentage specified by this option, the driver will stop clearing files from the NFS image cache that have not been accessed in the last M minutes, where M is the value of the expiry_thres_minutes configuration option.</td>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_netapp_7mode_nfs">
<caption>Description of configuration options for netapp_7mode_nfs</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>expiry_thres_minutes = 720</td>
<td>(IntOpt) This option specifies the threshold for last access time for images in the NFS image cache. When a cache cleaning cycle begins, images in the cache that have not been accessed in the last M minutes, where M is the value of this parameter, will be deleted from the cache to create free space on the NFS share.</td>
</tr>
<tr>
<td>netapp_login = None</td>
<td>(StrOpt) Administrative user account name used to access the storage system or proxy server.</td>
</tr>
<tr>
<td>netapp_password = None</td>
<td>(StrOpt) Password for the administrative user account specified in the netapp_login option.</td>
</tr>
<tr>
<td>netapp_server_hostname = None</td>
<td>(StrOpt) The hostname (or IP address) for the storage system or proxy server.</td>
</tr>
<tr>
<td>netapp_server_port = 80</td>
<td>(IntOpt) The TCP port to use for communication with the storage system or proxy server. Traditionally, port 80 is used for HTTP and port 443 is used for HTTPS; however, this value should be changed if an alternate port has been configured on the storage system or proxy server.</td>
</tr>
<tr>
<td>netapp_storage_family = ontap_cluster</td>
<td>(StrOpt) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series.</td>
</tr>
<tr>
<td>netapp_storage_protocol = None</td>
<td>(StrOpt) The storage protocol to be used on the data path with the storage system; valid values are iscsi or nfs.</td>
</tr>
<tr>
<td>netapp_transport_type = http</td>
<td>(StrOpt) The transport protocol used when communicating with the storage system or proxy server. Valid values are http or https.</td>
</tr>
<tr>
<td>thres_avl_size_perc_start = 20</td>
<td>(IntOpt) If the percentage of available space for an NFS share has dropped below the value specified by this option, the NFS image cache will be cleaned.</td>
</tr>
<tr>
<td>thres_avl_size_perc_stop = 60</td>
<td>(IntOpt) When the percentage of available space on an NFS share has reached the percentage specified by this option, the driver will stop clearing files from the NFS image cache that have not been accessed in the last M minutes, where M is the value of the expiry_thres_minutes configuration option.</td>
</tr>
</tbody>
</table>
</para>

117
doc/common/tables/cinder-netapp_cdot_iscsi.xml
View File

@ -1,59 +1,58 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all" xml:id="config_table_cinder_netapp_cdot_iscsi">
<caption>Description of configuration options for netapp_cdot_iscsi</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>netapp_login = None</td>
<td>(StrOpt) Administrative user account name used to access the storage system or proxy server.</td>
</tr>
<tr>
<td>netapp_password = None</td>
<td>(StrOpt) Password for the administrative user account specified in the netapp_login option.</td>
</tr>
<tr>
<td>netapp_server_hostname = None</td>
<td>(StrOpt) The hostname (or IP address) for the storage system or proxy server.</td>
</tr>
<tr>
<td>netapp_server_port = 80</td>
<td>(IntOpt) The TCP port to use for communication with the storage system or proxy server. Traditionally, port 80 is used for HTTP and port 443 is used for HTTPS; however, this value should be changed if an alternate port has been configured on the storage system or proxy server.</td>
</tr>
<tr>
<td>netapp_size_multiplier = 1.2</td>
<td>(FloatOpt) The quantity to be multiplied by the requested volume size to ensure enough space is available on the virtual storage server (Vserver) to fulfill the volume creation request.</td>
</tr>
<tr>
<td>netapp_storage_family = ontap_cluster</td>
<td>(StrOpt) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series.</td>
</tr>
<tr>
<td>netapp_storage_protocol = None</td>
<td>(StrOpt) The storage protocol to be used on the data path with the storage system; valid values are iscsi or nfs.</td>
</tr>
<tr>
<td>netapp_transport_type = http</td>
<td>(StrOpt) The transport protocol used when communicating with the storage system or proxy server. Valid values are http or https.</td>
</tr>
<tr>
<td>netapp_vserver = None</td>
<td>(StrOpt) This option specifies the virtual storage server (Vserver) name on the storage cluster on which provisioning of block storage volumes should occur. If using the NFS storage protocol, this parameter is mandatory for storage service catalog support (utilized by Cinder volume type extra_specs support). If this option is specified, the exports belonging to the Vserver will only be used for provisioning in the future. Block storage volumes on exports not belonging to the Vserver specified by this option will continue to function normally.</td>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_netapp_cdot_iscsi">
<caption>Description of configuration options for netapp_cdot_iscsi</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>netapp_login = None</td>
<td>(StrOpt) Administrative user account name used to access the storage system or proxy server.</td>
</tr>
<tr>
<td>netapp_password = None</td>
<td>(StrOpt) Password for the administrative user account specified in the netapp_login option.</td>
</tr>
<tr>
<td>netapp_server_hostname = None</td>
<td>(StrOpt) The hostname (or IP address) for the storage system or proxy server.</td>
</tr>
<tr>
<td>netapp_server_port = 80</td>
<td>(IntOpt) The TCP port to use for communication with the storage system or proxy server. Traditionally, port 80 is used for HTTP and port 443 is used for HTTPS; however, this value should be changed if an alternate port has been configured on the storage system or proxy server.</td>
</tr>
<tr>
<td>netapp_size_multiplier = 1.2</td>
<td>(FloatOpt) The quantity to be multiplied by the requested volume size to ensure enough space is available on the virtual storage server (Vserver) to fulfill the volume creation request.</td>
</tr>
<tr>
<td>netapp_storage_family = ontap_cluster</td>
<td>(StrOpt) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series.</td>
</tr>
<tr>
<td>netapp_storage_protocol = None</td>
<td>(StrOpt) The storage protocol to be used on the data path with the storage system; valid values are iscsi or nfs.</td>
</tr>
<tr>
<td>netapp_transport_type = http</td>
<td>(StrOpt) The transport protocol used when communicating with the storage system or proxy server. Valid values are http or https.</td>
</tr>
<tr>
<td>netapp_vserver = None</td>
<td>(StrOpt) This option specifies the virtual storage server (Vserver) name on the storage cluster on which provisioning of block storage volumes should occur. If using the NFS storage protocol, this parameter is mandatory for storage service catalog support (utilized by Cinder volume type extra_specs support). If this option is specified, the exports belonging to the Vserver will only be used for provisioning in the future. Block storage volumes on exports not belonging to the Vserver specified by this option will continue to function normally.</td>
</tr>
</tbody>
</table>
</para>

141
doc/common/tables/cinder-netapp_cdot_nfs.xml
View File

@ -1,71 +1,70 @@
<?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_netapp_cdot_nfs">
<caption>Description of configuration options for netapp_cdot_nfs</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>expiry_thres_minutes = 720</td>
<td>(IntOpt) This option specifies the threshold for last access time for images in the NFS image cache. When a cache cleaning cycle begins, images in the cache that have not been accessed in the last M minutes, where M is the value of this parameter, will be deleted from the cache to create free space on the NFS share.</td>
</tr>
<tr>
<td>netapp_copyoffload_tool_path = None</td>
<td>(StrOpt) This option specifies the path of the NetApp copy offload tool binary. Ensure that the binary has execute permissions set which allow the effective user of the cinder-volume process to execute the file.</td>
</tr>
<tr>
<td>netapp_login = None</td>
<td>(StrOpt) Administrative user account name used to access the storage system or proxy server.</td>
</tr>
<tr>
<td>netapp_password = None</td>
<td>(StrOpt) Password for the administrative user account specified in the netapp_login option.</td>
</tr>
<tr>
<td>netapp_server_hostname = None</td>
<td>(StrOpt) The hostname (or IP address) for the storage system or proxy server.</td>
</tr>
<tr>
<td>netapp_server_port = 80</td>
<td>(IntOpt) The TCP port to use for communication with the storage system or proxy server. Traditionally, port 80 is used for HTTP and port 443 is used for HTTPS; however, this value should be changed if an alternate port has been configured on the storage system or proxy server.</td>
</tr>
<tr>
<td>netapp_storage_family = ontap_cluster</td>
<td>(StrOpt) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series.</td>
</tr>
<tr>
<td>netapp_storage_protocol = None</td>
<td>(StrOpt) The storage protocol to be used on the data path with the storage system; valid values are iscsi or nfs.</td>
</tr>
<tr>
<td>netapp_transport_type = http</td>
<td>(StrOpt) The transport protocol used when communicating with the storage system or proxy server. Valid values are http or https.</td>
</tr>
<tr>
<td>netapp_vserver = None</td>
<td>(StrOpt) This option specifies the virtual storage server (Vserver) name on the storage cluster on which provisioning of block storage volumes should occur. If using the NFS storage protocol, this parameter is mandatory for storage service catalog support (utilized by Cinder volume type extra_specs support). If this option is specified, the exports belonging to the Vserver will only be used for provisioning in the future. Block storage volumes on exports not belonging to the Vserver specified by this option will continue to function normally.</td>
</tr>
<tr>
<td>thres_avl_size_perc_start = 20</td>
<td>(IntOpt) If the percentage of available space for an NFS share has dropped below the value specified by this option, the NFS image cache will be cleaned.</td>
</tr>
<tr>
<td>thres_avl_size_perc_stop = 60</td>
<td>(IntOpt) When the percentage of available space on an NFS share has reached the percentage specified by this option, the driver will stop clearing files from the NFS image cache that have not been accessed in the last M minutes, where M is the value of the expiry_thres_minutes configuration option.</td>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_netapp_cdot_nfs">
<caption>Description of configuration options for netapp_cdot_nfs</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>expiry_thres_minutes = 720</td>
<td>(IntOpt) This option specifies the threshold for last access time for images in the NFS image cache. When a cache cleaning cycle begins, images in the cache that have not been accessed in the last M minutes, where M is the value of this parameter, will be deleted from the cache to create free space on the NFS share.</td>
</tr>
<tr>
<td>netapp_copyoffload_tool_path = None</td>
<td>(StrOpt) This option specifies the path of the NetApp copy offload tool binary. Ensure that the binary has execute permissions set which allow the effective user of the cinder-volume process to execute the file.</td>
</tr>
<tr>
<td>netapp_login = None</td>
<td>(StrOpt) Administrative user account name used to access the storage system or proxy server.</td>
</tr>
<tr>
<td>netapp_password = None</td>
<td>(StrOpt) Password for the administrative user account specified in the netapp_login option.</td>
</tr>
<tr>
<td>netapp_server_hostname = None</td>
<td>(StrOpt) The hostname (or IP address) for the storage system or proxy server.</td>
</tr>
<tr>
<td>netapp_server_port = 80</td>
<td>(IntOpt) The TCP port to use for communication with the storage system or proxy server. Traditionally, port 80 is used for HTTP and port 443 is used for HTTPS; however, this value should be changed if an alternate port has been configured on the storage system or proxy server.</td>
</tr>
<tr>
<td>netapp_storage_family = ontap_cluster</td>
<td>(StrOpt) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series.</td>
</tr>
<tr>
<td>netapp_storage_protocol = None</td>
<td>(StrOpt) The storage protocol to be used on the data path with the storage system; valid values are iscsi or nfs.</td>
</tr>
<tr>
<td>netapp_transport_type = http</td>
<td>(StrOpt) The transport protocol used when communicating with the storage system or proxy server. Valid values are http or https.</td>
</tr>
<tr>
<td>netapp_vserver = None</td>
<td>(StrOpt) This option specifies the virtual storage server (Vserver) name on the storage cluster on which provisioning of block storage volumes should occur. If using the NFS storage protocol, this parameter is mandatory for storage service catalog support (utilized by Cinder volume type extra_specs support). If this option is specified, the exports belonging to the Vserver will only be used for provisioning in the future. Block storage volumes on exports not belonging to the Vserver specified by this option will continue to function normally.</td>
</tr>
<tr>
<td>thres_avl_size_perc_start = 20</td>
<td>(IntOpt) If the percentage of available space for an NFS share has dropped below the value specified by this option, the NFS image cache will be cleaned.</td>
</tr>
<tr>
<td>thres_avl_size_perc_stop = 60</td>
<td>(IntOpt) When the percentage of available space on an NFS share has reached the percentage specified by this option, the driver will stop clearing files from the NFS image cache that have not been accessed in the last M minutes, where M is the value of the expiry_thres_minutes configuration option.</td>
</tr>
</tbody>
</table>
</para>

125
doc/common/tables/cinder-netapp_eseries_iscsi.xml
View File

@ -1,63 +1,62 @@
<?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_netapp_eseries_iscsi">
<caption>Description of configuration options for netapp_eseries_iscsi</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>netapp_controller_ips = None</td>
<td>(StrOpt) This option is only utilized when the storage family is configured to eseries. This option is used to restrict provisioning to the specified controllers. Specify the value of this option to be a comma separated list of controller hostnames or IP addresses to be used for provisioning.</td>
</tr>
<tr>
<td>netapp_login = None</td>
<td>(StrOpt) Administrative user account name used to access the storage system or proxy server.</td>
</tr>
<tr>
<td>netapp_password = None</td>
<td>(StrOpt) Password for the administrative user account specified in the netapp_login option.</td>
</tr>
<tr>
<td>netapp_sa_password = None</td>
<td>(StrOpt) Password for the NetApp E-Series storage array.</td>
</tr>
<tr>
<td>netapp_server_hostname = None</td>
<td>(StrOpt) The hostname (or IP address) for the storage system or proxy server.</td>
</tr>
<tr>
<td>netapp_server_port = 80</td>
<td>(IntOpt) The TCP port to use for communication with the storage system or proxy server. Traditionally, port 80 is used for HTTP and port 443 is used for HTTPS; however, this value should be changed if an alternate port has been configured on the storage system or proxy server.</td>
</tr>
<tr>
<td>netapp_storage_family = ontap_cluster</td>
<td>(StrOpt) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series.</td>
</tr>
<tr>
<td>netapp_storage_pools = None</td>
<td>(StrOpt) This option is used to restrict provisioning to the specified storage pools. Only dynamic disk pools are currently supported. Specify the value of this option to be a comma separated list of disk pool names to be used for provisioning.</td>
</tr>
<tr>
<td>netapp_transport_type = http</td>
<td>(StrOpt) The transport protocol used when communicating with the storage system or proxy server. Valid values are http or https.</td>
</tr>
<tr>
<td>netapp_webservice_path = /devmgr/v2</td>
<td>(StrOpt) This option is used to specify the path to the E-Series proxy application on a proxy server. The value is combined with the value of the netapp_transport_type, netapp_server_hostname, and netapp_server_port options to create the URL used by the driver to connect to the proxy application.</td>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_netapp_eseries_iscsi">
<caption>Description of configuration options for netapp_eseries_iscsi</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>netapp_controller_ips = None</td>
<td>(StrOpt) This option is only utilized when the storage family is configured to eseries. This option is used to restrict provisioning to the specified controllers. Specify the value of this option to be a comma separated list of controller hostnames or IP addresses to be used for provisioning.</td>
</tr>
<tr>
<td>netapp_login = None</td>
<td>(StrOpt) Administrative user account name used to access the storage system or proxy server.</td>
</tr>
<tr>
<td>netapp_password = None</td>
<td>(StrOpt) Password for the administrative user account specified in the netapp_login option.</td>
</tr>
<tr>
<td>netapp_sa_password = None</td>
<td>(StrOpt) Password for the NetApp E-Series storage array.</td>
</tr>
<tr>
<td>netapp_server_hostname = None</td>
<td>(StrOpt) The hostname (or IP address) for the storage system or proxy server.</td>
</tr>
<tr>
<td>netapp_server_port = 80</td>
<td>(IntOpt) The TCP port to use for communication with the storage system or proxy server. Traditionally, port 80 is used for HTTP and port 443 is used for HTTPS; however, this value should be changed if an alternate port has been configured on the storage system or proxy server.</td>
</tr>
<tr>
<td>netapp_storage_family = ontap_cluster</td>
<td>(StrOpt) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series.</td>
</tr>
<tr>
<td>netapp_storage_pools = None</td>
<td>(StrOpt) This option is used to restrict provisioning to the specified storage pools. Only dynamic disk pools are currently supported. Specify the value of this option to be a comma separated list of disk pool names to be used for provisioning.</td>
</tr>
<tr>
<td>netapp_transport_type = http</td>
<td>(StrOpt) The transport protocol used when communicating with the storage system or proxy server. Valid values are http or https.</td>
</tr>
<tr>
<td>netapp_webservice_path = /devmgr/v2</td>
<td>(StrOpt) This option is used to specify the path to the E-Series proxy application on a proxy server. The value is combined with the value of the netapp_transport_type, netapp_server_hostname, and netapp_server_port options to create the URL used by the driver to connect to the proxy application.</td>
</tr>
</tbody>
</table>
</para>

165
doc/common/tables/cinder-nexenta_iscsi.xml
View File

@ -1,83 +1,82 @@
<?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_nexenta_iscsi">
<caption>Description of configuration options for nexenta_iscsi</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>nexenta_blocksize = </td>
<td>(StrOpt) block size for volumes (blank=default,8KB)</td>
</tr>
<tr>
<td>nexenta_host = </td>
<td>(StrOpt) IP address of Nexenta SA</td>
</tr>
<tr>
<td>nexenta_iscsi_target_portal_port = 3260</td>
<td>(IntOpt) Nexenta target portal port</td>
</tr>
<tr>
<td>nexenta_password = nexenta</td>
<td>(StrOpt) Password to connect to Nexenta SA</td>
</tr>
<tr>
<td>nexenta_rest_port = 2000</td>
<td>(IntOpt) HTTP port to connect to Nexenta REST API server</td>
</tr>
<tr>
<td>nexenta_rest_protocol = auto</td>
<td>(StrOpt) Use http or https for REST connection (default auto)</td>
</tr>
<tr>
<td>nexenta_rrmgr_compression = 0</td>
<td>(IntOpt) Enable stream compression, level 1..9. 1 - gives best speed; 9 - gives best compression.</td>
</tr>
<tr>
<td>nexenta_rrmgr_connections = 2</td>
<td>(IntOpt) Number of TCP connections.</td>
</tr>
<tr>
<td>nexenta_rrmgr_tcp_buf_size = 4096</td>
<td>(IntOpt) TCP Buffer size in KiloBytes.</td>
</tr>
<tr>
<td>nexenta_sparse = False</td>
<td>(BoolOpt) flag to create 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>
</tr>
<tr>
<td>nexenta_target_group_prefix = cinder/</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>
<td>(StrOpt) IQN prefix for iSCSI targets</td>
</tr>
<tr>
<td>nexenta_user = admin</td>
<td>(StrOpt) User name to connect to Nexenta SA</td>
</tr>
<tr>
<td>nexenta_volume = cinder</td>
<td>(StrOpt) pool on SA that will hold all volumes</td>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_nexenta_iscsi">
<caption>Description of configuration options for nexenta_iscsi</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>nexenta_blocksize = </td>
<td>(StrOpt) Block size for volumes (default=blank means 8KB)</td>
</tr>
<tr>
<td>nexenta_host = </td>
<td>(StrOpt) IP address of Nexenta SA</td>
</tr>
<tr>
<td>nexenta_iscsi_target_portal_port = 3260</td>
<td>(IntOpt) Nexenta target portal port</td>
</tr>
<tr>
<td>nexenta_password = nexenta</td>
<td>(StrOpt) Password to connect to Nexenta SA</td>
</tr>
<tr>
<td>nexenta_rest_port = 2000</td>
<td>(IntOpt) HTTP port to connect to Nexenta REST API server</td>
</tr>
<tr>
<td>nexenta_rest_protocol = auto</td>
<td>(StrOpt) Use http or https for REST connection (default auto)</td>
</tr>
<tr>
<td>nexenta_rrmgr_compression = 0</td>
<td>(IntOpt) Enable stream compression, level 1..9. 1 - gives best speed; 9 - gives best compression.</td>
</tr>
<tr>
<td>nexenta_rrmgr_connections = 2</td>
<td>(IntOpt) Number of TCP connections.</td>
</tr>
<tr>
<td>nexenta_rrmgr_tcp_buf_size = 4096</td>
<td>(IntOpt) TCP Buffer size in KiloBytes.</td>
</tr>
<tr>
<td>nexenta_sparse = False</td>
<td>(BoolOpt) Enables or disables the creation of sparse volumes</td>
</tr>
<tr>
<td>nexenta_sparsed_volumes = True</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>
</tr>
<tr>
<td>nexenta_target_prefix = iqn.1986-03.com.sun:02:cinder-</td>
<td>(StrOpt) IQN prefix for iSCSI targets</td>
</tr>
<tr>
<td>nexenta_user = admin</td>
<td>(StrOpt) User name to connect to Nexenta SA</td>
</tr>
<tr>
<td>nexenta_volume = cinder</td>
<td>(StrOpt) SA Pool that holds all volumes</td>
</tr>
</tbody>
</table>
</para>

77
doc/common/tables/cinder-nexenta_nfs.xml
View File

@ -1,39 +1,38 @@
<?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_nexenta_nfs">
<caption>Description of configuration options for nexenta_nfs</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>nexenta_mount_point_base = $state_path/mnt</td>
<td>(StrOpt) Base dir containing mount points for nfs shares</td>
</tr>
<tr>
<td>nexenta_nms_cache_volroot = True</td>
<td>(BoolOpt) If set True cache NexentaStor appliance volroot option value.</td>
</tr>
<tr>
<td>nexenta_shares_config = /etc/cinder/nfs_shares</td>
<td>(StrOpt) File with the list of available nfs shares</td>
</tr>
<tr>
<td>nexenta_volume_compression = on</td>
<td>(StrOpt) Default compression value for new ZFS folders.</td>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_nexenta_nfs">
<caption>Description of configuration options for nexenta_nfs</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>nexenta_mount_point_base = $state_path/mnt</td>
<td>(StrOpt) Base directory that contains NFS share mount points</td>
</tr>
<tr>
<td>nexenta_nms_cache_volroot = True</td>
<td>(BoolOpt) If set True cache NexentaStor appliance volroot option value.</td>
</tr>
<tr>
<td>nexenta_shares_config = /etc/cinder/nfs_shares</td>
<td>(StrOpt) File with the list of available nfs shares</td>
</tr>
<tr>
<td>nexenta_volume_compression = on</td>
<td>(StrOpt) Default compression value for new ZFS folders.</td>
</tr>
</tbody>
</table>
</para>

101
doc/common/tables/cinder-quota.xml
View File

@ -1,51 +1,50 @@
<?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_quota">
<caption>Description of configuration options for quota</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>max_age = 0</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>
</tr>
<tr>
<td>quota_gigabytes = 1000</td>
<td>(IntOpt) number of volume gigabytes (snapshots are also included) allowed per project</td>
</tr>
<tr>
<td>quota_snapshots = 10</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>
</tr>
<tr>
<td>reservation_expire = 86400</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>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_quota">
<caption>Description of configuration options for quota</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>max_age = 0</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>
</tr>
<tr>
<td>quota_gigabytes = 1000</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>
</tr>
<tr>
<td>quota_volumes = 10</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>
</tr>
<tr>
<td>use_default_quota_class = True</td>
<td>(BoolOpt) Enables or disables use of default quota class with default quota.</td>
</tr>
</tbody>
</table>
</para>

85
doc/common/tables/cinder-rootwrap.xml
View File

@ -1,43 +1,42 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all" xml:id="config_table_cinder_rootwrap">
<caption>Description of configuration options for rootwrap</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>filters_path = /etc/cinder/rootwrap.d,/usr/share/cinder/rootwrap</td>
<td>List of directories to load filter definitions from (separated by ','). These directories MUST all be only writeable by root !</td>
</tr>
<tr>
<td>exec_dirs = /sbin,/usr/sbin,/bin,/usr/bin</td>
<td>List of directories to search executables in, in case filters do not explicitely specify a full path (separated by ',') If not specified, defaults to system PATH environment variable. These directories MUST all be only writeable by root !</td>
</tr>
<tr>
<td>use_syslog = False</td>
<td>Enable logging to syslog Default value is False</td>
</tr>
<tr>
<td>syslog_log_facility = syslog</td>
<td>Which syslog facility to use. Valid values include auth, authpriv, syslog, local0, local1... Default value is 'syslog'</td>
</tr>
<tr>
<td>syslog_log_level = ERROR</td>
<td>Which messages to log. INFO means log all usage ERROR means only log unsuccessful attempts</td>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_rootwrap">
<caption>Description of configuration options for rootwrap</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>filters_path = /etc/cinder/rootwrap.d,/usr/share/cinder/rootwrap</td>
<td>List of directories to load filter definitions from (separated by ','). These directories MUST all be only writeable by root !</td>
</tr>
<tr>
<td>exec_dirs = /sbin,/usr/sbin,/bin,/usr/bin</td>
<td>List of directories to search executables in, in case filters do not explicitely specify a full path (separated by ',') If not specified, defaults to system PATH environment variable. These directories MUST all be only writeable by root !</td>
</tr>
<tr>
<td>use_syslog = False</td>
<td>Enable logging to syslog Default value is False</td>
</tr>
<tr>
<td>syslog_log_facility = syslog</td>
<td>Which syslog facility to use. Valid values include auth, authpriv, syslog, local0, local1... Default value is 'syslog'</td>
</tr>
<tr>
<td>syslog_log_level = ERROR</td>
<td>Which messages to log. INFO means log all usage ERROR means only log unsuccessful attempts</td>
</tr>
</tbody>
</table>
</para>

491
doc/common/tables/cinder-rpc.xml
View File

@ -1,246 +1,245 @@
<?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_rpc">
<caption>Description of configuration options for rpc</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>allowed_rpc_exception_modules = oslo.messaging.exceptions, nova.exception, cinder.exception, exceptions</td>
<td>(ListOpt) Modules of exceptions that are permitted to be recreated upon receiving exception data from an rpc call.</td>
</tr>
<tr>
<td>amqp_auto_delete = False</td>
<td>(BoolOpt) Auto-delete queues in amqp.</td>
</tr>
<tr>
<td>amqp_durable_queues = False</td>
<td>(BoolOpt) Use durable queues in amqp.</td>
</tr>
<tr>
<td>control_exchange = openstack</td>
<td>(StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.</td>
</tr>
<tr>
<td>default_timeout = 20</td>
<td>(IntOpt) Default Time Out For CLI operations in minutes</td>
</tr>
<tr>
<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>
</tr>
<tr>
<td>kombu_ssl_certfile = </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>
</tr>
<tr>
<td>kombu_ssl_version = </td>
<td>(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions.</td>
</tr>
<tr>
<td>matchmaker_heartbeat_freq = 300</td>
<td>(IntOpt) Heartbeat frequency.</td>
</tr>
<tr>
<td>matchmaker_heartbeat_ttl = 600</td>
<td>(IntOpt) Heartbeat time-to-live.</td>
</tr>
<tr>
<td>notification_driver = []</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>
</tr>
<tr>
<td>password = None</td>
<td>(StrOpt) Password for Redis server (optional).</td>
</tr>
<tr>
<td>port = 6379</td>
<td>(IntOpt) Use this port to connect to redis host.</td>
</tr>
<tr>
<td>publish_errors = False</td>
<td>(BoolOpt) Publish error events</td>
</tr>
<tr>
<td>qpid_heartbeat = 60</td>
<td>(IntOpt) Seconds between connection keepalive heartbeats.</td>
</tr>
<tr>
<td>qpid_hostname = localhost</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>
</tr>
<tr>
<td>qpid_password = </td>
<td>(StrOpt) Password for Qpid connection.</td>
</tr>
<tr>
<td>qpid_port = 5672</td>
<td>(IntOpt) Qpid broker port.</td>
</tr>
<tr>
<td>qpid_protocol = tcp</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>
</tr>
<tr>
<td>qpid_tcp_nodelay = True</td>
<td>(BoolOpt) Whether to disable the Nagle algorithm.</td>
</tr>
<tr>
<td>qpid_topology_version = 1</td>
<td>(IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.</td>
</tr>
<tr>
<td>qpid_username = </td>
<td>(StrOpt) Username for Qpid connection.</td>
</tr>
<tr>
<td>rabbit_ha_queues = False</td>
<td>(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database.</td>
</tr>
<tr>
<td>rabbit_host = localhost</td>
<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>
</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>
</tr>
<tr>
<td>rabbit_password = guest</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>
</tr>
<tr>
<td>rabbit_retry_backoff = 2</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>
</tr>
<tr>
<td>rabbit_use_ssl = False</td>
<td>(BoolOpt) Connect over SSL for RabbitMQ.</td>
</tr>
<tr>
<td>rabbit_userid = guest</td>
<td>(StrOpt) The RabbitMQ userid.</td>
</tr>
<tr>
<td>rabbit_virtual_host = /</td>
<td>(StrOpt) The RabbitMQ virtual host.</td>
</tr>
<tr>
<td>rpc_backend = rabbit</td>
<td>(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq.</td>
</tr>
<tr>
<td>rpc_cast_timeout = 30</td>
<td>(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq.</td>
</tr>
<tr>
<td>rpc_conn_pool_size = 30</td>
<td>(IntOpt) Size of RPC connection pool.</td>
</tr>
<tr>
<td>rpc_response_timeout = 60</td>
<td>(IntOpt) Seconds to wait for a response from a call.</td>
</tr>
<tr>
<td>rpc_thread_pool_size = 64</td>
<td>(IntOpt) Size of RPC greenthread pool.</td>
</tr>
<tr>
<td>rpc_zmq_bind_address = *</td>
<td>(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address.</td>
</tr>
<tr>
<td>rpc_zmq_contexts = 1</td>
<td>(IntOpt) Number of ZeroMQ contexts, defaults to 1.</td>
</tr>
<tr>
<td>rpc_zmq_host = oslo</td>
<td>(StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova.</td>
</tr>
<tr>
<td>rpc_zmq_ipc_dir = /var/run/openstack</td>
<td>(StrOpt) Directory for holding IPC sockets.</td>
</tr>
<tr>
<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>
</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>
<td>volume_topic = cinder-volume</td>
<td>(StrOpt) the topic volume nodes listen on</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>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_rpc">
<caption>Description of configuration options for rpc</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>allowed_rpc_exception_modules = oslo.messaging.exceptions, nova.exception, cinder.exception, exceptions</td>
<td>(ListOpt) Modules of exceptions that are permitted to be recreated upon receiving exception data from an rpc call.</td>
</tr>
<tr>
<td>amqp_auto_delete = False</td>
<td>(BoolOpt) Auto-delete queues in amqp.</td>
</tr>
<tr>
<td>amqp_durable_queues = False</td>
<td>(BoolOpt) Use durable queues in amqp.</td>
</tr>
<tr>
<td>control_exchange = openstack</td>
<td>(StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.</td>
</tr>
<tr>
<td>default_timeout = 20</td>
<td>(IntOpt) Default Time Out For CLI operations in minutes</td>
</tr>
<tr>
<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>
</tr>
<tr>
<td>kombu_ssl_certfile = </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>
</tr>
<tr>
<td>kombu_ssl_version = </td>
<td>(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions.</td>
</tr>
<tr>
<td>matchmaker_heartbeat_freq = 300</td>
<td>(IntOpt) Heartbeat frequency.</td>
</tr>
<tr>
<td>matchmaker_heartbeat_ttl = 600</td>
<td>(IntOpt) Heartbeat time-to-live.</td>
</tr>
<tr>
<td>notification_driver = []</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>
</tr>
<tr>
<td>password = None</td>
<td>(StrOpt) Password for Redis server (optional).</td>
</tr>
<tr>
<td>port = 6379</td>
<td>(IntOpt) Use this port to connect to redis host.</td>
</tr>
<tr>
<td>publish_errors = False</td>
<td>(BoolOpt) Enables or disables publication of error events.</td>
</tr>
<tr>
<td>qpid_heartbeat = 60</td>
<td>(IntOpt) Seconds between connection keepalive heartbeats.</td>
</tr>
<tr>
<td>qpid_hostname = localhost</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>
</tr>
<tr>
<td>qpid_password = </td>
<td>(StrOpt) Password for Qpid connection.</td>
</tr>
<tr>
<td>qpid_port = 5672</td>
<td>(IntOpt) Qpid broker port.</td>
</tr>
<tr>
<td>qpid_protocol = tcp</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>
</tr>
<tr>
<td>qpid_tcp_nodelay = True</td>
<td>(BoolOpt) Whether to disable the Nagle algorithm.</td>
</tr>
<tr>
<td>qpid_topology_version = 1</td>
<td>(IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.</td>
</tr>
<tr>
<td>qpid_username = </td>
<td>(StrOpt) Username for Qpid connection.</td>
</tr>
<tr>
<td>rabbit_ha_queues = False</td>
<td>(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database.</td>
</tr>
<tr>
<td>rabbit_host = localhost</td>
<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>
</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>
</tr>
<tr>
<td>rabbit_password = guest</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>
</tr>
<tr>
<td>rabbit_retry_backoff = 2</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>
</tr>
<tr>
<td>rabbit_use_ssl = False</td>
<td>(BoolOpt) Connect over SSL for RabbitMQ.</td>
</tr>
<tr>
<td>rabbit_userid = guest</td>
<td>(StrOpt) The RabbitMQ userid.</td>
</tr>
<tr>
<td>rabbit_virtual_host = /</td>
<td>(StrOpt) The RabbitMQ virtual host.</td>
</tr>
<tr>
<td>rpc_backend = rabbit</td>
<td>(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq.</td>
</tr>
<tr>
<td>rpc_cast_timeout = 30</td>
<td>(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq.</td>
</tr>
<tr>
<td>rpc_conn_pool_size = 30</td>
<td>(IntOpt) Size of RPC connection pool.</td>
</tr>
<tr>
<td>rpc_response_timeout = 60</td>
<td>(IntOpt) Seconds to wait for a response from a call.</td>
</tr>
<tr>
<td>rpc_thread_pool_size = 64</td>
<td>(IntOpt) Size of RPC greenthread pool.</td>
</tr>
<tr>
<td>rpc_zmq_bind_address = *</td>
<td>(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address.</td>
</tr>
<tr>
<td>rpc_zmq_contexts = 1</td>
<td>(IntOpt) Number of ZeroMQ contexts, defaults to 1.</td>
</tr>
<tr>
<td>rpc_zmq_host = oslo</td>
<td>(StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova.</td>
</tr>
<tr>
<td>rpc_zmq_ipc_dir = /var/run/openstack</td>
<td>(StrOpt) Directory for holding IPC sockets.</td>
</tr>
<tr>
<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>
</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>
<td>volume_topic = cinder-volume</td>
<td>(StrOpt) The topic that volume nodes listen on</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>
</tr>
</tbody>
</table>
</para>

53
doc/common/tables/cinder-san-solaris.xml
View File

@ -1,27 +1,26 @@
<?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_san-solaris">
<caption>Description of configuration options for san-solaris</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>san_zfs_volume_base = rpool/</td>
<td>(StrOpt) The ZFS path under which to create zvols for volumes.</td>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_san-solaris">
<caption>Description of configuration options for san-solaris</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>san_zfs_volume_base = rpool/</td>
<td>(StrOpt) The ZFS path under which to create zvols for volumes.</td>
</tr>
</tbody>
</table>
</para>

133
doc/common/tables/cinder-san.xml
View File

@ -1,67 +1,66 @@
<?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_san">
<caption>Description of configuration options for san</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>san_clustername = </td>
<td>(StrOpt) Cluster name to use for creating volumes</td>
</tr>
<tr>
<td>san_ip = </td>
<td>(StrOpt) IP address of SAN controller</td>
</tr>
<tr>
<td>san_is_local = False</td>
<td>(BoolOpt) Execute commands locally instead of over SSH; use if the volume service is running on the SAN device</td>
</tr>
<tr>
<td>san_login = admin</td>
<td>(StrOpt) Username for SAN controller</td>
</tr>
<tr>
<td>san_password = </td>
<td>(StrOpt) Password for SAN controller</td>
</tr>
<tr>
<td>san_private_key = </td>
<td>(StrOpt) Filename of private key to use for SSH authentication</td>
</tr>
<tr>
<td>san_ssh_port = 22</td>
<td>(IntOpt) SSH port to use with SAN</td>
</tr>
<tr>
<td>san_thin_provision = True</td>
<td>(BoolOpt) Use thin provisioning for SAN volumes?</td>
</tr>
<tr>
<td>ssh_conn_timeout = 30</td>
<td>(IntOpt) SSH connection timeout in seconds</td>
</tr>
<tr>
<td>ssh_max_pool_conn = 5</td>
<td>(IntOpt) Maximum ssh connections in the pool</td>
</tr>
<tr>
<td>ssh_min_pool_conn = 1</td>
<td>(IntOpt) Minimum ssh connections in the pool</td>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_san">
<caption>Description of configuration options for san</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>san_clustername = </td>
<td>(StrOpt) Cluster name to use for creating volumes</td>
</tr>
<tr>
<td>san_ip = </td>
<td>(StrOpt) IP address of SAN controller</td>
</tr>
<tr>
<td>san_is_local = False</td>
<td>(BoolOpt) Execute commands locally instead of over SSH; use if the volume service is running on the SAN device</td>
</tr>
<tr>
<td>san_login = admin</td>
<td>(StrOpt) Username for SAN controller</td>
</tr>
<tr>
<td>san_password = </td>
<td>(StrOpt) Password for SAN controller</td>
</tr>
<tr>
<td>san_private_key = </td>
<td>(StrOpt) Filename of private key to use for SSH authentication</td>
</tr>
<tr>
<td>san_ssh_port = 22</td>
<td>(IntOpt) SSH port to use with SAN</td>
</tr>
<tr>
<td>san_thin_provision = True</td>
<td>(BoolOpt) Use thin provisioning for SAN volumes?</td>
</tr>
<tr>
<td>ssh_conn_timeout = 30</td>
<td>(IntOpt) SSH connection timeout in seconds</td>
</tr>
<tr>
<td>ssh_max_pool_conn = 5</td>
<td>(IntOpt) Maximum ssh connections in the pool</td>
</tr>
<tr>
<td>ssh_min_pool_conn = 1</td>
<td>(IntOpt) Minimum ssh connections in the pool</td>
</tr>
</tbody>
</table>
</para>

69
doc/common/tables/cinder-scality.xml
View File

@ -1,35 +1,34 @@
<?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_scality">
<caption>Description of configuration options for scality</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>scality_sofs_config = None</td>
<td>(StrOpt) Path or URL to Scality SOFS configuration file</td>
</tr>
<tr>
<td>scality_sofs_mount_point = $state_path/scality</td>
<td>(StrOpt) Base dir where Scality SOFS shall be mounted</td>
</tr>
<tr>
<td>scality_sofs_volume_dir = cinder/volumes</td>
<td>(StrOpt) Path from Scality SOFS root to volume dir</td>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_scality">
<caption>Description of configuration options for scality</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>scality_sofs_config = None</td>
<td>(StrOpt) Path or URL to Scality SOFS configuration file</td>
</tr>
<tr>
<td>scality_sofs_mount_point = $state_path/scality</td>
<td>(StrOpt) Base dir where Scality SOFS shall be mounted</td>
</tr>
<tr>
<td>scality_sofs_volume_dir = cinder/volumes</td>
<td>(StrOpt) Path from Scality SOFS root to volume dir</td>
</tr>
</tbody>
</table>
</para>

109
doc/common/tables/cinder-scheduler.xml
View File

@ -1,55 +1,54 @@
<?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_scheduler">
<caption>Description of configuration options for scheduler</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>scheduler_default_filters = AvailabilityZoneFilter, CapacityFilter, CapabilitiesFilter</td>
<td>(ListOpt) Which filter class names to use for filtering hosts when not specified in the request.</td>
</tr>
<tr>
<td>scheduler_default_weighers = CapacityWeigher</td>
<td>(ListOpt) Which weigher class names to use for weighing hosts.</td>
</tr>
<tr>
<td>scheduler_driver = cinder.scheduler.filter_scheduler.FilterScheduler</td>
<td>(StrOpt) Default scheduler driver to use</td>
</tr>
<tr>
<td>scheduler_host_manager = cinder.scheduler.host_manager.HostManager</td>
<td>(StrOpt) The scheduler host manager class to use</td>
</tr>
<tr>
<td>scheduler_json_config_location = </td>
<td>(StrOpt) Absolute path to scheduler configuration JSON file.</td>
</tr>
<tr>
<td>scheduler_manager = cinder.scheduler.manager.SchedulerManager</td>
<td>(StrOpt) full class name for the Manager for scheduler</td>
</tr>
<tr>
<td>scheduler_max_attempts = 3</td>
<td>(IntOpt) Maximum number of attempts to schedule an volume</td>
</tr>
<tr>
<td>scheduler_topic = cinder-scheduler</td>
<td>(StrOpt) the topic scheduler nodes listen on</td>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_scheduler">
<caption>Description of configuration options for scheduler</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>scheduler_default_filters = AvailabilityZoneFilter, CapacityFilter, CapabilitiesFilter</td>
<td>(ListOpt) Which filter class names to use for filtering hosts when not specified in the request.</td>
</tr>
<tr>
<td>scheduler_default_weighers = CapacityWeigher</td>
<td>(ListOpt) Which weigher class names to use for weighing hosts.</td>
</tr>
<tr>
<td>scheduler_driver = cinder.scheduler.filter_scheduler.FilterScheduler</td>
<td>(StrOpt) Default scheduler driver to use</td>
</tr>
<tr>
<td>scheduler_host_manager = cinder.scheduler.host_manager.HostManager</td>
<td>(StrOpt) The scheduler host manager class to use</td>
</tr>
<tr>
<td>scheduler_json_config_location = </td>
<td>(StrOpt) Absolute path to scheduler configuration JSON file.</td>
</tr>
<tr>
<td>scheduler_manager = cinder.scheduler.manager.SchedulerManager</td>
<td>(StrOpt) Full class name for the Manager for scheduler</td>
</tr>
<tr>
<td>scheduler_max_attempts = 3</td>
<td>(IntOpt) Maximum number of attempts to schedule an volume</td>
</tr>
<tr>
<td>scheduler_topic = cinder-scheduler</td>
<td>(StrOpt) The topic that scheduler nodes listen on</td>
</tr>
</tbody>
</table>
</para>

77
doc/common/tables/cinder-solidfire.xml
View File

@ -1,39 +1,38 @@
<?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_solidfire">
<caption>Description of configuration options for solidfire</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>sf_account_prefix = None</td>
<td>(StrOpt) Create SolidFire accounts with this prefix. Any string can be used here, but the string "hostname" is special and will create a prefix using the cinder node hostsname (previous default behavior). The default is NO prefix.</td>
</tr>
<tr>
<td>sf_allow_tenant_qos = False</td>
<td>(BoolOpt) Allow tenants to specify QOS on create</td>
</tr>
<tr>
<td>sf_api_port = 443</td>
<td>(IntOpt) SolidFire API port. Useful if the device api is behind a proxy on a different port.</td>
</tr>
<tr>
<td>sf_emulate_512 = True</td>
<td>(BoolOpt) Set 512 byte emulation on volume creation; </td>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_solidfire">
<caption>Description of configuration options for solidfire</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>sf_account_prefix = None</td>
<td>(StrOpt) Create SolidFire accounts with this prefix. Any string can be used here, but the string "hostname" is special and will create a prefix using the cinder node hostsname (previous default behavior). The default is NO prefix.</td>
</tr>
<tr>
<td>sf_allow_tenant_qos = False</td>
<td>(BoolOpt) Allow tenants to specify QOS on create</td>
</tr>
<tr>
<td>sf_api_port = 443</td>
<td>(IntOpt) SolidFire API port. Useful if the device api is behind a proxy on a different port.</td>
</tr>
<tr>
<td>sf_emulate_512 = True</td>
<td>(BoolOpt) Set 512 byte emulation on volume creation; </td>
</tr>
</tbody>
</table>
</para>

69
doc/common/tables/cinder-ssl.xml
View File

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

300
doc/common/tables/cinder-storage.xml
View File

@ -1,158 +1,142 @@
<?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_storage">
<caption>Description of configuration options for storage</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>allocated_capacity_weight_multiplier = -1.0</td>
<td>(FloatOpt) Multiplier used for weighing volume capacity. Negative numbers mean to stack vs spread.</td>
</tr>
<tr>
<td>capacity_weight_multiplier = 1.0</td>
<td>(FloatOpt) Multiplier used for weighing volume capacity. Negative numbers mean to stack vs spread.</td>
</tr>
<tr>
<td>enabled_backends = None</td>
<td>(ListOpt) A list of backend names to use. These backend names should be backed by a unique [CONFIG] group with its options</td>
</tr>
<tr>
<td>iscsi_helper = tgtadm</td>
<td>(StrOpt) iscsi target user-land tool to use</td>
</tr>
<tr>
<td>iscsi_iotype = fileio</td>
<td>(StrOpt) Sets the behavior of the iSCSI target to either perform blockio or fileio optionally, auto can be set and Cinder will autodetect type of backing device</td>
</tr>
<tr>
<td>iscsi_ip_address = $my_ip</td>
<td>(StrOpt) The IP address that the iSCSI daemon is listening on</td>
</tr>
<tr>
<td>iscsi_num_targets = 100</td>
<td>(IntOpt) The maximum number of iscsi target ids per host</td>
</tr>
<tr>
<td>iscsi_port = 3260</td>
<td>(IntOpt) The port that the iSCSI daemon is listening on</td>
</tr>
<tr>
<td>iscsi_target_prefix = iqn.2010-10.org.openstack:</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>
</tr>
<tr>
<td>iser_ip_address = $my_ip</td>
<td>(StrOpt) The IP address that the iSER daemon is listening on</td>
</tr>
<tr>
<td>iser_num_targets = 100</td>
<td>(IntOpt) The maximum number of iser target ids per host</td>
</tr>
<tr>
<td>iser_port = 3260</td>
<td>(IntOpt) The port that the iSER daemon is listening on</td>
</tr>
<tr>
<td>iser_target_prefix = iqn.2010-10.org.iser.openstack:</td>
<td>(StrOpt) prefix for iser volumes</td>
</tr>
<tr>
<td>max_gigabytes = 10000</td>
<td>(IntOpt) This configure option has been deprecated along with the SimpleScheduler. New scheduler is able to gather capacity information for each host, thus setting the maximum number of volume gigabytes for host is no longer needed. It's safe to remove this configure from cinder.conf.</td>
</tr>
<tr>
<td>migration_create_volume_timeout_secs = 300</td>
<td>(IntOpt) Timeout for creating the volume to migrate to when performing volume migration (seconds)</td>
</tr>
<tr>
<td>num_iser_scan_tries = 3</td>
<td>(IntOpt) The maximum number of times to rescan iSER targetto find volume</td>
</tr>
<tr>
<td>num_volume_device_scan_tries = 3</td>
<td>(IntOpt) The maximum number of times to rescan targets to find volume</td>
</tr>
<tr>
<td>volume_backend_name = None</td>
<td>(StrOpt) The backend name for a given driver implementation</td>
</tr>
<tr>
<td>volume_clear = zero</td>
<td>(StrOpt) Method used to wipe old voumes (valid options are: none, zero, shred)</td>
</tr>
<tr>
<td>volume_clear_ionice = None</td>
<td>(StrOpt) The flag to pass to ionice to alter the i/o priority of the process used to zero a volume after deletion, for example "-c3" for idle only priority.</td>
</tr>
<tr>
<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_dd_blocksize = 1M</td>
<td>(StrOpt) The default block size used when copying/clearing volumes</td>
</tr>
<tr>
<td>volume_driver = cinder.volume.drivers.lvm.LVMISCSIDriver</td>
<td>(StrOpt) Driver to use for volume creation</td>
</tr>
<tr>
<td>volume_manager = cinder.volume.manager.VolumeManager</td>
<td>(StrOpt) full class name for the Manager for volume</td>
</tr>
<tr>
<td>volume_service_inithost_offload = False</td>
<td>(BoolOpt) Offload pending volume delete during volume service startup</td>
</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>
</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>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_storage">
<caption>Description of configuration options for storage</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>allocated_capacity_weight_multiplier = -1.0</td>
<td>(FloatOpt) Multiplier used for weighing volume capacity. Negative numbers mean to stack vs spread.</td>
</tr>
<tr>
<td>capacity_weight_multiplier = 1.0</td>
<td>(FloatOpt) Multiplier used for weighing volume capacity. Negative numbers mean to stack vs spread.</td>
</tr>
<tr>
<td>enabled_backends = None</td>
<td>(ListOpt) A list of backend names to use. These backend names should be backed by a unique [CONFIG] group with its options</td>
</tr>
<tr>
<td>iscsi_helper = tgtadm</td>
<td>(StrOpt) iSCSI target user-land tool to use</td>
</tr>
<tr>
<td>iscsi_iotype = fileio</td>
<td>(StrOpt) Sets the behavior of the iSCSI target to either perform blockio or fileio optionally, auto can be set and Cinder will autodetect type of backing device</td>
</tr>
<tr>
<td>iscsi_ip_address = $my_ip</td>
<td>(StrOpt) The IP address that the iSCSI daemon is listening on</td>
</tr>
<tr>
<td>iscsi_num_targets = 100</td>
<td>(IntOpt) The maximum number of iSCSI target IDs per host</td>
</tr>
<tr>
<td>iscsi_port = 3260</td>
<td>(IntOpt) The port that the iSCSI daemon is listening on</td>
</tr>
<tr>
<td>iscsi_target_prefix = iqn.2010-10.org.openstack:</td>
<td>(StrOpt) Prefix for iSCSI volumes</td>
</tr>
<tr>
<td>iser_helper = tgtadm</td>
<td>(StrOpt) The name of the iSER target user-land tool to use</td>
</tr>
<tr>
<td>iser_ip_address = $my_ip</td>
<td>(StrOpt) The IP address that the iSER daemon is listening on</td>
</tr>
<tr>
<td>iser_num_targets = 100</td>
<td>(IntOpt) The maximum number of iSER target IDs per host</td>
</tr>
<tr>
<td>iser_port = 3260</td>
<td>(IntOpt) The port that the iSER daemon is listening on</td>
</tr>
<tr>
<td>iser_target_prefix = iqn.2010-10.org.iser.openstack:</td>
<td>(StrOpt) Prefix for iSER volumes</td>
</tr>
<tr>
<td>max_gigabytes = 10000</td>
<td>(IntOpt) This configure option has been deprecated along with the SimpleScheduler. New scheduler is able to gather capacity information for each host, thus setting the maximum number of volume gigabytes for host is no longer needed. It's safe to remove this configure from cinder.conf.</td>
</tr>
<tr>
<td>migration_create_volume_timeout_secs = 300</td>
<td>(IntOpt) Timeout for creating the volume to migrate to when performing volume migration (seconds)</td>
</tr>
<tr>
<td>num_iser_scan_tries = 3</td>
<td>(IntOpt) The maximum number of times to rescan iSER targetto find volume</td>
</tr>
<tr>
<td>num_volume_device_scan_tries = 3</td>
<td>(IntOpt) The maximum number of times to rescan targets to find volume</td>
</tr>
<tr>
<td>volume_backend_name = None</td>
<td>(StrOpt) The backend name for a given driver implementation</td>
</tr>
<tr>
<td>volume_clear = zero</td>
<td>(StrOpt) Method used to wipe old volumes (valid options are: none, zero, shred)</td>
</tr>
<tr>
<td>volume_clear_ionice = None</td>
<td>(StrOpt) The flag to pass to ionice to alter the i/o priority of the process used to zero a volume after deletion, for example "-c3" for idle only priority.</td>
</tr>
<tr>
<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>
</tr>
<tr>
<td>volume_driver = cinder.volume.drivers.lvm.LVMISCSIDriver</td>
<td>(StrOpt) Driver to use for volume creation</td>
</tr>
<tr>
<td>volume_manager = cinder.volume.manager.VolumeManager</td>
<td>(StrOpt) Full class name for the Manager for volume</td>
</tr>
<tr>
<td>volume_service_inithost_offload = False</td>
<td>(BoolOpt) Offload pending volume delete during volume service startup</td>
</tr>
<tr>
<td>volume_usage_audit_period = month</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>
</tbody>
</table>
</para>

105
doc/common/tables/cinder-storage_ceph.xml
View File

@ -1,51 +1,54 @@
<?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_storage_ceph">
<caption>Description of configuration options for storage_ceph</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>rbd_ceph_conf = </td>
<td>(StrOpt) path to the ceph configuration file to use</td>
</tr>
<tr>
<td>rbd_flatten_volume_from_snapshot = False</td>
<td>(BoolOpt) flatten volumes created from snapshots to remove dependency</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>
</tr>
<tr>
<td>rbd_pool = rbd</td>
<td>(StrOpt) the RADOS pool in which 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>
</tr>
<tr>
<td>rbd_user = None</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>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_storage_ceph">
<caption>Description of configuration options for storage_ceph</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>rbd_ceph_conf = </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 from volume to snapshot</td>
</tr>
<tr>
<td>rbd_max_clone_depth = 5</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 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_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>
</tr>
<tr>
<td>volume_tmp_dir = None</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>
</para>

77
doc/common/tables/cinder-storage_glusterfs.xml
View File

@ -1,39 +1,38 @@
<?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_storage_glusterfs">
<caption>Description of configuration options for storage_glusterfs</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>glusterfs_mount_point_base = $state_path/mnt</td>
<td>(StrOpt) Base dir containing mount points for gluster shares.</td>
</tr>
<tr>
<td>glusterfs_qcow2_volumes = False</td>
<td>(BoolOpt) Create volumes as QCOW2 files rather than raw files.</td>
</tr>
<tr>
<td>glusterfs_shares_config = /etc/cinder/glusterfs_shares</td>
<td>(StrOpt) File with the list of available gluster shares</td>
</tr>
<tr>
<td>glusterfs_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>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_storage_glusterfs">
<caption>Description of configuration options for storage_glusterfs</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>glusterfs_mount_point_base = $state_path/mnt</td>
<td>(StrOpt) Base dir containing mount points for gluster shares.</td>
</tr>
<tr>
<td>glusterfs_qcow2_volumes = False</td>
<td>(BoolOpt) Create volumes as QCOW2 files rather than raw files.</td>
</tr>
<tr>
<td>glusterfs_shares_config = /etc/cinder/glusterfs_shares</td>
<td>(StrOpt) File with the list of available gluster shares</td>
</tr>
<tr>
<td>glusterfs_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>
</tr>
</tbody>
</table>
</para>

93
doc/common/tables/cinder-storage_gpfs.xml
View File

@ -1,47 +1,46 @@
<?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_storage_gpfs">
<caption>Description of configuration options for storage_gpfs</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>gpfs_images_dir = None</td>
<td>(StrOpt) Specifies the path of the Image service repository in GPFS. Leave undefined if not storing images in GPFS.</td>
</tr>
<tr>
<td>gpfs_images_share_mode = None</td>
<td>(StrOpt) Specifies the type of image copy to be used. Set this when the Image service repository also uses GPFS so that image files can be transferred efficiently from the Image service to the Block Storage service. There are two valid values: "copy" specifies that a full copy of the image is made; "copy_on_write" specifies that copy-on-write optimization strategy is used and unmodified blocks of the image file are shared efficiently.</td>
</tr>
<tr>
<td>gpfs_max_clone_depth = 0</td>
<td>(IntOpt) Specifies an upper limit on the number of indirections required to reach a specific block due to snapshots or clones. A lengthy chain of copy-on-write snapshots or clones can have a negative impact on performance, but improves space utilization. 0 indicates unlimited clone depth.</td>
</tr>
<tr>
<td>gpfs_mount_point_base = None</td>
<td>(StrOpt) Specifies the path of the GPFS directory where Block Storage volume and snapshot files are stored.</td>
</tr>
<tr>
<td>gpfs_sparse_volumes = True</td>
<td>(BoolOpt) Specifies that volumes are created as sparse files which initially consume no space. If set to False, the volume is created as a fully allocated file, in which case, creation may take a significantly longer time.</td>
</tr>
<tr>
<td>gpfs_storage_pool = None</td>
<td>(StrOpt) Specifies the storage pool that volumes are assigned to. By default, the system storage pool is used.</td>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_storage_gpfs">
<caption>Description of configuration options for storage_gpfs</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>gpfs_images_dir = None</td>
<td>(StrOpt) Specifies the path of the Image service repository in GPFS. Leave undefined if not storing images in GPFS.</td>
</tr>
<tr>
<td>gpfs_images_share_mode = None</td>
<td>(StrOpt) Specifies the type of image copy to be used. Set this when the Image service repository also uses GPFS so that image files can be transferred efficiently from the Image service to the Block Storage service. There are two valid values: "copy" specifies that a full copy of the image is made; "copy_on_write" specifies that copy-on-write optimization strategy is used and unmodified blocks of the image file are shared efficiently.</td>
</tr>
<tr>
<td>gpfs_max_clone_depth = 0</td>
<td>(IntOpt) Specifies an upper limit on the number of indirections required to reach a specific block due to snapshots or clones. A lengthy chain of copy-on-write snapshots or clones can have a negative impact on performance, but improves space utilization. 0 indicates unlimited clone depth.</td>
</tr>
<tr>
<td>gpfs_mount_point_base = None</td>
<td>(StrOpt) Specifies the path of the GPFS directory where Block Storage volume and snapshot files are stored.</td>
</tr>
<tr>
<td>gpfs_sparse_volumes = True</td>
<td>(BoolOpt) Specifies that volumes are created as sparse files which initially consume no space. If set to False, the volume is created as a fully allocated file, in which case, creation may take a significantly longer time.</td>
</tr>
<tr>
<td>gpfs_storage_pool = None</td>
<td>(StrOpt) Specifies the storage pool that volumes are assigned to. By default, the system storage pool is used.</td>
</tr>
</tbody>
</table>
</para>

93
doc/common/tables/cinder-storage_nfs.xml
View File

@ -1,47 +1,46 @@
<?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_storage_nfs">
<caption>Description of configuration options for storage_nfs</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>nfs_mount_options = None</td>
<td>(StrOpt) Mount options passed to the nfs client. See section of the nfs man page for details.</td>
</tr>
<tr>
<td>nfs_mount_point_base = $state_path/mnt</td>
<td>(StrOpt) Base dir containing mount points for nfs shares.</td>
</tr>
<tr>
<td>nfs_oversub_ratio = 1.0</td>
<td>(FloatOpt) This will compare the allocated to available space on the volume destination. If the ratio exceeds this number, the destination will no longer be valid.</td>
</tr>
<tr>
<td>nfs_shares_config = /etc/cinder/nfs_shares</td>
<td>(StrOpt) File with the list of available nfs shares</td>
</tr>
<tr>
<td>nfs_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>
</tr>
<tr>
<td>nfs_used_ratio = 0.95</td>
<td>(FloatOpt) Percent of ACTUAL usage of the underlying volume before no new volumes can be allocated to the volume destination.</td>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_storage_nfs">
<caption>Description of configuration options for storage_nfs</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>nfs_mount_options = None</td>
<td>(StrOpt) Mount options passed to the nfs client. See section of the nfs man page for details.</td>
</tr>
<tr>
<td>nfs_mount_point_base = $state_path/mnt</td>
<td>(StrOpt) Base dir containing mount points for nfs shares.</td>
</tr>
<tr>
<td>nfs_oversub_ratio = 1.0</td>
<td>(FloatOpt) This will compare the allocated to available space on the volume destination. If the ratio exceeds this number, the destination will no longer be valid.</td>
</tr>
<tr>
<td>nfs_shares_config = /etc/cinder/nfs_shares</td>
<td>(StrOpt) File with the list of available nfs shares</td>
</tr>
<tr>
<td>nfs_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>
</tr>
<tr>
<td>nfs_used_ratio = 0.95</td>
<td>(FloatOpt) Percent of ACTUAL usage of the underlying volume before no new volumes can be allocated to the volume destination.</td>
</tr>
</tbody>
</table>
</para>

93
doc/common/tables/cinder-storage_xen.xml
View File

@ -1,47 +1,46 @@
<?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_storage_xen">
<caption>Description of configuration options for storage_xen</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>xenapi_connection_password = None</td>
<td>(StrOpt) Password for XenAPI connection</td>
</tr>
<tr>
<td>xenapi_connection_url = None</td>
<td>(StrOpt) URL for XenAPI connection</td>
</tr>
<tr>
<td>xenapi_connection_username = root</td>
<td>(StrOpt) Username for XenAPI connection</td>
</tr>
<tr>
<td>xenapi_nfs_server = None</td>
<td>(StrOpt) NFS server to be used by XenAPINFSDriver</td>
</tr>
<tr>
<td>xenapi_nfs_serverpath = None</td>
<td>(StrOpt) Path of exported NFS, used by XenAPINFSDriver</td>
</tr>
<tr>
<td>xenapi_sr_base_path = /var/run/sr-mount</td>
<td>(StrOpt) Base path to the storage repository</td>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_storage_xen">
<caption>Description of configuration options for storage_xen</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>xenapi_connection_password = None</td>
<td>(StrOpt) Password for XenAPI connection</td>
</tr>
<tr>
<td>xenapi_connection_url = None</td>
<td>(StrOpt) URL for XenAPI connection</td>
</tr>
<tr>
<td>xenapi_connection_username = root</td>
<td>(StrOpt) Username for XenAPI connection</td>
</tr>
<tr>
<td>xenapi_nfs_server = None</td>
<td>(StrOpt) NFS server to be used by XenAPINFSDriver</td>
</tr>
<tr>
<td>xenapi_nfs_serverpath = None</td>
<td>(StrOpt) Path of exported NFS, used by XenAPINFSDriver</td>
</tr>
<tr>
<td>xenapi_sr_base_path = /var/run/sr-mount</td>
<td>(StrOpt) Base path to the storage repository</td>
</tr>
</tbody>
</table>
</para>

149
doc/common/tables/cinder-storwize.xml
View File

@ -1,75 +1,74 @@
<?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_storwize">
<caption>Description of configuration options for storwize</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>storwize_svc_connection_protocol = iSCSI</td>
<td>(StrOpt) Connection protocol (iSCSI/FC)</td>
</tr>
<tr>
<td>storwize_svc_flashcopy_timeout = 120</td>
<td>(IntOpt) Maximum number of seconds to wait for FlashCopy to be prepared. Maximum value is 600 seconds (10 minutes)</td>
</tr>
<tr>
<td>storwize_svc_iscsi_chap_enabled = True</td>
<td>(BoolOpt) Configure CHAP authentication for iSCSI connections (Default: Enabled)</td>
</tr>
<tr>
<td>storwize_svc_multihostmap_enabled = True</td>
<td>(BoolOpt) Allows vdisk to multi host mapping</td>
</tr>
<tr>
<td>storwize_svc_multipath_enabled = False</td>
<td>(BoolOpt) Connect with multipath (FC only; iSCSI multipath is controlled by Nova)</td>
</tr>
<tr>
<td>storwize_svc_vol_autoexpand = True</td>
<td>(BoolOpt) Storage system autoexpand parameter for volumes (True/False)</td>
</tr>
<tr>
<td>storwize_svc_vol_compression = False</td>
<td>(BoolOpt) Storage system compression option for volumes</td>
</tr>
<tr>
<td>storwize_svc_vol_easytier = True</td>
<td>(BoolOpt) Enable Easy Tier for volumes</td>
</tr>
<tr>
<td>storwize_svc_vol_grainsize = 256</td>
<td>(IntOpt) Storage system grain size parameter for volumes (32/64/128/256)</td>
</tr>
<tr>
<td>storwize_svc_vol_iogrp = 0</td>
<td>(IntOpt) The I/O group in which to allocate volumes</td>
</tr>
<tr>
<td>storwize_svc_vol_rsize = 2</td>
<td>(IntOpt) Storage system space-efficiency parameter for volumes (percentage)</td>
</tr>
<tr>
<td>storwize_svc_vol_warning = 0</td>
<td>(IntOpt) Storage system threshold for volume capacity warnings (percentage)</td>
</tr>
<tr>
<td>storwize_svc_volpool_name = volpool</td>
<td>(StrOpt) Storage system storage pool for volumes</td>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_storwize">
<caption>Description of configuration options for storwize</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>storwize_svc_connection_protocol = iSCSI</td>
<td>(StrOpt) Connection protocol (iSCSI/FC)</td>
</tr>
<tr>
<td>storwize_svc_flashcopy_timeout = 120</td>
<td>(IntOpt) Maximum number of seconds to wait for FlashCopy to be prepared. Maximum value is 600 seconds (10 minutes)</td>
</tr>
<tr>
<td>storwize_svc_iscsi_chap_enabled = True</td>
<td>(BoolOpt) Configure CHAP authentication for iSCSI connections (Default: Enabled)</td>
</tr>
<tr>
<td>storwize_svc_multihostmap_enabled = True</td>
<td>(BoolOpt) Allows vdisk to multi host mapping</td>
</tr>
<tr>
<td>storwize_svc_multipath_enabled = False</td>
<td>(BoolOpt) Connect with multipath (FC only; iSCSI multipath is controlled by Nova)</td>
</tr>
<tr>
<td>storwize_svc_vol_autoexpand = True</td>
<td>(BoolOpt) Storage system autoexpand parameter for volumes (True/False)</td>
</tr>
<tr>
<td>storwize_svc_vol_compression = False</td>
<td>(BoolOpt) Storage system compression option for volumes</td>
</tr>
<tr>
<td>storwize_svc_vol_easytier = True</td>
<td>(BoolOpt) Enable Easy Tier for volumes</td>
</tr>
<tr>
<td>storwize_svc_vol_grainsize = 256</td>
<td>(IntOpt) Storage system grain size parameter for volumes (32/64/128/256)</td>
</tr>
<tr>
<td>storwize_svc_vol_iogrp = 0</td>
<td>(IntOpt) The I/O group in which to allocate volumes</td>
</tr>
<tr>
<td>storwize_svc_vol_rsize = 2</td>
<td>(IntOpt) Storage system space-efficiency parameter for volumes (percentage)</td>
</tr>
<tr>
<td>storwize_svc_vol_warning = 0</td>
<td>(IntOpt) Storage system threshold for volume capacity warnings (percentage)</td>
</tr>
<tr>
<td>storwize_svc_volpool_name = volpool</td>
<td>(StrOpt) Storage system storage pool for volumes</td>
</tr>
</tbody>
</table>
</para>

125
doc/common/tables/cinder-vmware.xml
View File

@ -1,63 +1,62 @@
<?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_vmware">
<caption>Description of configuration options for vmware</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>vmware_api_retry_count = 10</td>
<td>(IntOpt) Number of times VMware ESX/VC server API must be retried upon connection related issues.</td>
</tr>
<tr>
<td>vmware_host_ip = None</td>
<td>(StrOpt) IP address for connecting to VMware ESX/VC server.</td>
</tr>
<tr>
<td>vmware_host_password = None</td>
<td>(StrOpt) Password for authenticating with VMware ESX/VC server.</td>
</tr>
<tr>
<td>vmware_host_username = None</td>
<td>(StrOpt) Username for authenticating with VMware ESX/VC server.</td>
</tr>
<tr>
<td>vmware_host_version = None</td>
<td>(StrOpt) Optional string specifying the VMware VC server version. The driver attempts to retrieve the version from VMware VC server. Set this configuration only if you want to override the VC server version.</td>
</tr>
<tr>
<td>vmware_image_transfer_timeout_secs = 7200</td>
<td>(IntOpt) Timeout in seconds for VMDK volume transfer between Cinder and Glance.</td>
</tr>
<tr>
<td>vmware_max_objects_retrieval = 100</td>
<td>(IntOpt) Max number of objects to be retrieved per batch. Query results will be obtained in batches from the server and not in one shot. Server may still limit the count to something less than the configured value.</td>
</tr>
<tr>
<td>vmware_task_poll_interval = 5</td>
<td>(IntOpt) The interval (in seconds) for polling remote tasks invoked on VMware ESX/VC server.</td>
</tr>
<tr>
<td>vmware_volume_folder = cinder-volumes</td>
<td>(StrOpt) Name for the folder in the VC datacenter that will contain cinder volumes.</td>
</tr>
<tr>
<td>vmware_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>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_vmware">
<caption>Description of configuration options for vmware</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>vmware_api_retry_count = 10</td>
<td>(IntOpt) Number of times VMware ESX/VC server API must be retried upon connection related issues.</td>
</tr>
<tr>
<td>vmware_host_ip = None</td>
<td>(StrOpt) IP address for connecting to VMware ESX/VC server.</td>
</tr>
<tr>
<td>vmware_host_password = None</td>
<td>(StrOpt) Password for authenticating with VMware ESX/VC server.</td>
</tr>
<tr>
<td>vmware_host_username = None</td>
<td>(StrOpt) Username for authenticating with VMware ESX/VC server.</td>
</tr>
<tr>
<td>vmware_host_version = None</td>
<td>(StrOpt) Optional string specifying the VMware VC server version. The driver attempts to retrieve the version from VMware VC server. Set this configuration only if you want to override the VC server version.</td>
</tr>
<tr>
<td>vmware_image_transfer_timeout_secs = 7200</td>
<td>(IntOpt) Timeout in seconds for VMDK volume transfer between Cinder and Glance.</td>
</tr>
<tr>
<td>vmware_max_objects_retrieval = 100</td>
<td>(IntOpt) Max number of objects to be retrieved per batch. Query results will be obtained in batches from the server and not in one shot. Server may still limit the count to something less than the configured value.</td>
</tr>
<tr>
<td>vmware_task_poll_interval = 5</td>
<td>(IntOpt) The interval (in seconds) for polling remote tasks invoked on VMware ESX/VC server.</td>
</tr>
<tr>
<td>vmware_volume_folder = cinder-volumes</td>
<td>(StrOpt) Name for the folder in the VC datacenter that will contain cinder volumes.</td>
</tr>
<tr>
<td>vmware_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>

53
doc/common/tables/cinder-windows.xml
View File

@ -1,27 +1,26 @@
<?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_windows">
<caption>Description of configuration options for windows</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>windows_iscsi_lun_path = C:\iSCSIVirtualDisks</td>
<td>(StrOpt) Path to store VHD backed volumes</td>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_windows">
<caption>Description of configuration options for windows</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>windows_iscsi_lun_path = C:\iSCSIVirtualDisks</td>
<td>(StrOpt) Path to store VHD backed volumes</td>
</tr>
</tbody>
</table>
</para>

69
doc/common/tables/cinder-xiv.xml
View File

@ -1,35 +1,34 @@
<?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_xiv">
<caption>Description of configuration options for xiv</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>xiv_chap = disabled</td>
<td>(StrOpt) CHAP authentication mode, effective only for iscsi (disabled|enabled)</td>
</tr>
<tr>
<td>xiv_ds8k_connection_type = iscsi</td>
<td>(StrOpt) Connection type to the IBM Storage Array (fibre_channel|iscsi)</td>
</tr>
<tr>
<td>xiv_ds8k_proxy = xiv_ds8k_openstack.nova_proxy.XIVDS8KNovaProxy</td>
<td>(StrOpt) Proxy driver that connects to the IBM Storage Array</td>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_xiv">
<caption>Description of configuration options for xiv</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>xiv_chap = disabled</td>
<td>(StrOpt) CHAP authentication mode, effective only for iscsi (disabled|enabled)</td>
</tr>
<tr>
<td>xiv_ds8k_connection_type = iscsi</td>
<td>(StrOpt) Connection type to the IBM Storage Array (fibre_channel|iscsi)</td>
</tr>
<tr>
<td>xiv_ds8k_proxy = xiv_ds8k_openstack.nova_proxy.XIVDS8KNovaProxy</td>
<td>(StrOpt) Proxy driver that connects to the IBM Storage Array</td>
</tr>
</tbody>
</table>
</para>

133
doc/common/tables/cinder-zadara.xml
View File

@ -1,67 +1,66 @@
<?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_zadara">
<caption>Description of configuration options for zadara</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>zadara_password = None</td>
<td>(StrOpt) Password for the VPSA</td>
</tr>
<tr>
<td>zadara_user = None</td>
<td>(StrOpt) User name for the VPSA</td>
</tr>
<tr>
<td>zadara_vol_encrypt = False</td>
<td>(BoolOpt) Default encryption policy for volumes</td>
</tr>
<tr>
<td>zadara_vol_name_template = OS_%s</td>
<td>(StrOpt) Default template for VPSA volume names</td>
</tr>
<tr>
<td>zadara_vol_thin = True</td>
<td>(BoolOpt) Default thin provisioning policy for volumes</td>
</tr>
<tr>
<td>zadara_vpsa_allow_nonexistent_delete = True</td>
<td>(BoolOpt) Don't halt on deletion of non-existing volumes</td>
</tr>
<tr>
<td>zadara_vpsa_auto_detach_on_delete = True</td>
<td>(BoolOpt) Automatically detach from servers on volume delete</td>
</tr>
<tr>
<td>zadara_vpsa_ip = None</td>
<td>(StrOpt) Management IP of Zadara VPSA</td>
</tr>
<tr>
<td>zadara_vpsa_poolname = None</td>
<td>(StrOpt) Name of VPSA storage pool for volumes</td>
</tr>
<tr>
<td>zadara_vpsa_port = None</td>
<td>(StrOpt) Zadara VPSA port number</td>
</tr>
<tr>
<td>zadara_vpsa_use_ssl = False</td>
<td>(BoolOpt) Use SSL connection</td>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_zadara">
<caption>Description of configuration options for zadara</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>zadara_password = None</td>
<td>(StrOpt) Password for the VPSA</td>
</tr>
<tr>
<td>zadara_user = None</td>
<td>(StrOpt) User name for the VPSA</td>
</tr>
<tr>
<td>zadara_vol_encrypt = False</td>
<td>(BoolOpt) Default encryption policy for volumes</td>
</tr>
<tr>
<td>zadara_vol_name_template = OS_%s</td>
<td>(StrOpt) Default template for VPSA volume names</td>
</tr>
<tr>
<td>zadara_vol_thin = True</td>
<td>(BoolOpt) Default thin provisioning policy for volumes</td>
</tr>
<tr>
<td>zadara_vpsa_allow_nonexistent_delete = True</td>
<td>(BoolOpt) Don't halt on deletion of non-existing volumes</td>
</tr>
<tr>
<td>zadara_vpsa_auto_detach_on_delete = True</td>
<td>(BoolOpt) Automatically detach from servers on volume delete</td>
</tr>
<tr>
<td>zadara_vpsa_ip = None</td>
<td>(StrOpt) Management IP of Zadara VPSA</td>
</tr>
<tr>
<td>zadara_vpsa_poolname = None</td>
<td>(StrOpt) Name of VPSA storage pool for volumes</td>
</tr>
<tr>
<td>zadara_vpsa_port = None</td>
<td>(StrOpt) Zadara VPSA port number</td>
</tr>
<tr>
<td>zadara_vpsa_use_ssl = False</td>
<td>(BoolOpt) Use SSL connection</td>
</tr>
</tbody>
</table>
</para>

53
doc/common/tables/cinder-zones.xml
View File

@ -1,27 +1,26 @@
<?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_zones">
<caption>Description of configuration options for zones</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>cloned_volume_same_az = True</td>
<td>(BoolOpt) Ensure that the new volumes are the same AZ as snapshot or source volume</td>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_zones">
<caption>Description of configuration options for zones</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>cloned_volume_same_az = True</td>
<td>(BoolOpt) Ensure that the new volumes are the same AZ as snapshot or source volume</td>
</tr>
</tbody>
</table>
</para>

75
doc/common/tables/cinder-zoning.xml
View File

@ -1,38 +1,37 @@
<?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_zoning">
<caption>Description of configuration options for zoning</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>zoning_mode = none</td>
<td>(StrOpt) FC Zoning mode configured</td>
</tr>
<tr>
<th colspan="2">[fc-zone-manager]</th>
</tr>
<tr>
<td>fc_fabric_names = None</td>
<td>(StrOpt) Comma separated list of fibre channel fabric names. This list of names is used to retrieve other SAN credentials for connecting to each SAN fabric</td>
</tr>
<tr>
<td>zoning_policy = initiator-target</td>
<td>(StrOpt) Zoning policy configured by user</td>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_zoning">
<caption>Description of configuration options for zoning</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>zoning_mode = none</td>
<td>(StrOpt) FC Zoning mode configured</td>
</tr>
<tr>
<th colspan="2">[fc-zone-manager]</th>
</tr>
<tr>
<td>fc_fabric_names = None</td>
<td>(StrOpt) Comma separated list of fibre channel fabric names. This list of names is used to retrieve other SAN credentials for connecting to each SAN fabric</td>
</tr>
<tr>
<td>zoning_policy = initiator-target</td>
<td>(StrOpt) Zoning policy configured by user</td>
</tr>
</tbody>
</table>
</para>

109
doc/common/tables/cinder-zoning_fabric.xml
View File

@ -1,55 +1,54 @@
<?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_zoning_fabric">
<caption>Description of configuration options for zoning_fabric</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">[BRCD_FABRIC_EXAMPLE]</th>
</tr>
<tr>
<td>fc_fabric_address = </td>
<td>(StrOpt) Management IP of fabric</td>
</tr>
<tr>
<td>fc_fabric_password = </td>
<td>(StrOpt) Password for user</td>
</tr>
<tr>
<td>fc_fabric_port = 22</td>
<td>(IntOpt) Connecting port</td>
</tr>
<tr>
<td>fc_fabric_user = </td>
<td>(StrOpt) Fabric user ID</td>
</tr>
<tr>
<td>principal_switch_wwn = None</td>
<td>(StrOpt) Principal switch WWN of the fabric</td>
</tr>
<tr>
<td>zone_activate = True</td>
<td>(BoolOpt) overridden zoning activation state</td>
</tr>
<tr>
<td>zone_name_prefix = None</td>
<td>(StrOpt) overridden zone name prefix</td>
</tr>
<tr>
<td>zoning_policy = initiator-target</td>
<td>(StrOpt) overridden zoning policy</td>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_zoning_fabric">
<caption>Description of configuration options for zoning_fabric</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">[BRCD_FABRIC_EXAMPLE]</th>
</tr>
<tr>
<td>fc_fabric_address = </td>
<td>(StrOpt) Management IP of fabric</td>
</tr>
<tr>
<td>fc_fabric_password = </td>
<td>(StrOpt) Password for user</td>
</tr>
<tr>
<td>fc_fabric_port = 22</td>
<td>(IntOpt) Connecting port</td>
</tr>
<tr>
<td>fc_fabric_user = </td>
<td>(StrOpt) Fabric user ID</td>
</tr>
<tr>
<td>principal_switch_wwn = None</td>
<td>(StrOpt) Principal switch WWN of the fabric</td>
</tr>
<tr>
<td>zone_activate = True</td>
<td>(BoolOpt) overridden zoning activation state</td>
</tr>
<tr>
<td>zone_name_prefix = None</td>
<td>(StrOpt) overridden zone name prefix</td>
</tr>
<tr>
<td>zoning_policy = initiator-target</td>
<td>(StrOpt) overridden zoning policy</td>
</tr>
</tbody>
</table>
</para>

69
doc/common/tables/cinder-zoning_manager.xml
View File

@ -1,35 +1,34 @@
<?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_zoning_manager">
<caption>Description of configuration options for zoning_manager</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">[fc-zone-manager]</th>
</tr>
<tr>
<td>brcd_sb_connector = cinder.zonemanager.drivers.brocade.brcd_fc_zone_client_cli.BrcdFCZoneClientCLI</td>
<td>(StrOpt) Southbound connector for zoning operation</td>
</tr>
<tr>
<td>fc_san_lookup_service = cinder.zonemanager.drivers.brocade.brcd_fc_san_lookup_service.BrcdFCSanLookupService</td>
<td>(StrOpt) FC San Lookup Service</td>
</tr>
<tr>
<td>zone_driver = cinder.zonemanager.drivers.brocade.brcd_fc_zone_driver.BrcdFCZoneDriver</td>
<td>(StrOpt) FC Zone Driver responsible for zone management</td>
</tr>
</tbody>
</table>
</para>
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_zoning_manager">
<caption>Description of configuration options for zoning_manager</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">[fc-zone-manager]</th>
</tr>
<tr>
<td>brcd_sb_connector = cinder.zonemanager.drivers.brocade.brcd_fc_zone_client_cli.BrcdFCZoneClientCLI</td>
<td>(StrOpt) Southbound connector for zoning operation</td>
</tr>
<tr>
<td>fc_san_lookup_service = cinder.zonemanager.drivers.brocade.brcd_fc_san_lookup_service.BrcdFCSanLookupService</td>
<td>(StrOpt) FC San Lookup Service</td>
</tr>
<tr>
<td>zone_driver = cinder.zonemanager.drivers.brocade.brcd_fc_zone_driver.BrcdFCZoneDriver</td>
<td>(StrOpt) FC Zone Driver responsible for zone management</td>
</tr>
</tbody>
</table>
</para>

117
doc/common/tables/glance-amqp.xml
View File

@ -1,59 +1,58 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all" xml:id="config_table_glance_amqp">
<caption>Description of configuration options for amqp</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>amqp_auto_delete = False</td>
<td>(BoolOpt) Auto-delete queues in amqp.</td>
</tr>
<tr>
<td>amqp_durable_queues = False</td>
<td>(BoolOpt) Use durable queues in amqp.</td>
</tr>
<tr>
<td>notification_driver = []</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>
</tr>
<tr>
<td>rpc_backend = rabbit</td>
<td>(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq.</td>
</tr>
<tr>
<td>rpc_conn_pool_size = 30</td>
<td>(IntOpt) Size of RPC connection pool.</td>
</tr>
<tr>
<td>rpc_response_timeout = 60</td>
<td>(IntOpt) Seconds to wait for a response from a call.</td>
</tr>
<tr>
<td>rpc_thread_pool_size = 64</td>
<td>(IntOpt) Size of RPC greenthread pool.</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>
</tbody>
</table>
</para>
<?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_amqp">
<caption>Description of configuration options for amqp</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>amqp_auto_delete = False</td>
<td>(BoolOpt) Auto-delete queues in amqp.</td>
</tr>
<tr>
<td>amqp_durable_queues = False</td>
<td>(BoolOpt) Use durable queues in amqp.</td>
</tr>
<tr>
<td>notification_driver = []</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>
</tr>
<tr>
<td>rpc_backend = rabbit</td>
<td>(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq.</td>
</tr>
<tr>
<td>rpc_conn_pool_size = 30</td>
<td>(IntOpt) Size of RPC connection pool.</td>
</tr>
<tr>
<td>rpc_response_timeout = 60</td>
<td>(IntOpt) Seconds to wait for a response from a call.</td>
</tr>
<tr>
<td>rpc_thread_pool_size = 64</td>
<td>(IntOpt) Size of RPC greenthread pool.</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>
</tbody>
</table>
</para>

179
doc/common/tables/glance-api.xml
View File

@ -1,90 +1,89 @@
<?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_api">
<caption>Description of configuration options for api</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>admin_role = admin</td>
<td>(StrOpt) Role used to identify an authenticated user as administrator.</td>
</tr>
<tr>
<td>allow_anonymous_access = False</td>
<td>(BoolOpt) Allow unauthenticated users to access the API with read-only privileges. This only applies when using ContextMiddleware.</td>
</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>enable_v1_api = True</td>
<td>(BoolOpt) Deploy the v1 OpenStack Images API.</td>
</tr>
<tr>
<td>enable_v1_registry = True</td>
<td>(BoolOpt) Deploy the v1 OpenStack Registry API.</td>
</tr>
<tr>
<td>enable_v2_api = True</td>
<td>(BoolOpt) Deploy the v2 OpenStack Images API.</td>
</tr>
<tr>
<td>enable_v2_registry = True</td>
<td>(BoolOpt) Deploy the v2 OpenStack Registry API.</td>
</tr>
<tr>
<td>image_size_cap = 1099511627776</td>
<td>(IntOpt) Maximum size of image a user can upload in bytes. Defaults to 1099511627776 bytes (1 TB).</td>
</tr>
<tr>
<td>known_stores = glance.store.filesystem.Store, glance.store.http.Store</td>
<td>(ListOpt) List of which store classes and store class locations are currently known to glance at startup.</td>
</tr>
<tr>
<td>location_strategy = location_order</td>
<td>(StrOpt) This value sets what strategy will be used to determine the image location order. Currently two strategies are packaged with Glance 'location_order' and 'store_type'.</td>
</tr>
<tr>
<td>owner_is_tenant = True</td>
<td>(BoolOpt) When true, this option sets the owner of an image to be the tenant. Otherwise, the owner of the image will be the authenticated user issuing the request.</td>
</tr>
<tr>
<td>send_identity_headers = False</td>
<td>(BoolOpt) Whether to pass through headers containing user and tenant information when making requests to the registry. This allows the registry to use the context middleware without the keystoneclients' auth_token middleware, removing calls to the keystone auth service. It is recommended that when using this option, secure communication between glance api and glance registry is ensured by means other than auth_token middleware.</td>
</tr>
<tr>
<td>show_multiple_locations = False</td>
<td>(BoolOpt) Whether to include the backend image locations in image properties. Revealing storage location can be a security risk, so use this setting with caution! The overrides show_image_direct_url.</td>
</tr>
<tr>
<td>use_user_token = True</td>
<td>(BoolOpt) Whether to pass through the user token when making requests to the registry.</td>
</tr>
<tr>
<th colspan="2">[store_type_location_strategy]</th>
</tr>
<tr>
<td>store_type_preference = </td>
<td>(ListOpt) The store names to use to get store preference order. The name must be registered by one of the stores defined by the 'known_stores' config option. This option will be applied when you using 'store_type' option as image location strategy defined by the 'location_strategy' config option.</td>
</tr>
</tbody>
</table>
</para>
<?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_api">
<caption>Description of configuration options for api</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>admin_role = admin</td>
<td>(StrOpt) Role used to identify an authenticated user as administrator.</td>
</tr>
<tr>
<td>allow_anonymous_access = False</td>
<td>(BoolOpt) Allow unauthenticated users to access the API with read-only privileges. This only applies when using ContextMiddleware.</td>
</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>
</tr>
<tr>
<td>enable_v1_registry = True</td>
<td>(BoolOpt) Deploy the v1 OpenStack Registry API.</td>
</tr>
<tr>
<td>enable_v2_api = True</td>
<td>(BoolOpt) Deploy the v2 OpenStack Images API.</td>
</tr>
<tr>
<td>enable_v2_registry = True</td>
<td>(BoolOpt) Deploy the v2 OpenStack Registry API.</td>
</tr>
<tr>
<td>image_size_cap = 1099511627776</td>
<td>(IntOpt) Maximum size of image a user can upload in bytes. Defaults to 1099511627776 bytes (1 TB).</td>
</tr>
<tr>
<td>known_stores = glance.store.filesystem.Store, glance.store.http.Store</td>
<td>(ListOpt) List of which store classes and store class locations are currently known to glance at startup.</td>
</tr>
<tr>
<td>location_strategy = location_order</td>
<td>(StrOpt) This value sets what strategy will be used to determine the image location order. Currently two strategies are packaged with Glance 'location_order' and 'store_type'.</td>
</tr>
<tr>
<td>owner_is_tenant = True</td>
<td>(BoolOpt) When true, this option sets the owner of an image to be the tenant. Otherwise, the owner of the image will be the authenticated user issuing the request.</td>
</tr>
<tr>
<td>send_identity_headers = False</td>
<td>(BoolOpt) Whether to pass through headers containing user and tenant information when making requests to the registry. This allows the registry to use the context middleware without the keystoneclients' auth_token middleware, removing calls to the keystone auth service. It is recommended that when using this option, secure communication between glance api and glance registry is ensured by means other than auth_token middleware.</td>
</tr>
<tr>
<td>show_multiple_locations = False</td>
<td>(BoolOpt) Whether to include the backend image locations in image properties. Revealing storage location can be a security risk, so use this setting with caution! The overrides show_image_direct_url.</td>
</tr>
<tr>
<td>use_user_token = True</td>
<td>(BoolOpt) Whether to pass through the user token when making requests to the registry.</td>
</tr>
<tr>
<th colspan="2">[store_type_location_strategy]</th>
</tr>
<tr>
<td>store_type_preference = </td>
<td>(ListOpt) The store names to use to get store preference order. The name must be registered by one of the stores defined by the 'known_stores' config option. This option will be applied when you using 'store_type' option as image location strategy defined by the 'location_strategy' config option.</td>
</tr>
</tbody>
</table>
</para>

279
doc/common/tables/glance-auth_token.xml
View File

@ -1,134 +1,145 @@
<?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_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">[DEFAULT]</th>
</tr>
<tr>
<td>memcached_servers = None</td>
<td>(ListOpt) Memcached servers or None for in process cache.</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>
</tbody>
</table>
</para>
<?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_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">[DEFAULT]</th>
</tr>
<tr>
<td>memcached_servers = None</td>
<td>(ListOpt) Memcached servers or None for in process cache.</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) 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>

85
doc/common/tables/glance-cinder.xml
View File

@ -1,43 +1,42 @@
<?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_cinder">
<caption>Description of configuration options for cinder</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>cinder_api_insecure = False</td>
<td>(BoolOpt) Allow to perform insecure SSL requests to cinder.</td>
</tr>
<tr>
<td>cinder_ca_certificates_file = None</td>
<td>(StrOpt) Location of CA certicates file to use for cinder client requests.</td>
</tr>
<tr>
<td>cinder_catalog_info = volume:cinder:publicURL</td>
<td>(StrOpt) Info to match when looking for cinder 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>cinder_endpoint_template = None</td>
<td>(StrOpt) Override service catalog lookup with template for cinder endpoint e.g. http://localhost:8776/v1/%(project_id)s.</td>
</tr>
<tr>
<td>cinder_http_retries = 3</td>
<td>(IntOpt) Number of cinderclient retries on failed http calls.</td>
</tr>
</tbody>
</table>
</para>
<?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_cinder">
<caption>Description of configuration options for cinder</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>cinder_api_insecure = False</td>
<td>(BoolOpt) Allow to perform insecure SSL requests to cinder.</td>
</tr>
<tr>
<td>cinder_ca_certificates_file = None</td>
<td>(StrOpt) Location of CA certicates file to use for cinder client requests.</td>
</tr>
<tr>
<td>cinder_catalog_info = volume:cinder:publicURL</td>
<td>(StrOpt) Info to match when looking for cinder 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>cinder_endpoint_template = None</td>
<td>(StrOpt) Override service catalog lookup with template for cinder endpoint e.g. http://localhost:8776/v1/%(project_id)s.</td>
</tr>
<tr>
<td>cinder_http_retries = 3</td>
<td>(IntOpt) Number of cinderclient retries on failed http calls.</td>
</tr>
</tbody>
</table>
</para>

249
doc/common/tables/glance-common.xml
View File

@ -1,125 +1,124 @@
<?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_common">
<caption>Description of configuration options for common</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>allow_additional_image_properties = True</td>
<td>(BoolOpt) Whether to allow users to specify image properties beyond what the image schema provides</td>
</tr>
<tr>
<td>api_limit_max = 1000</td>
<td>(IntOpt) Maximum permissible number of items that could be returned by a request</td>
</tr>
<tr>
<td>backlog = 4096</td>
<td>(IntOpt) The backlog value that will be used when creating the TCP listener socket.</td>
</tr>
<tr>
<td>bind_host = 0.0.0.0</td>
<td>(StrOpt) Address to bind the server. Useful when selecting a particular network interface.</td>
</tr>
<tr>
<td>bind_port = None</td>
<td>(IntOpt) The port on which the server will listen.</td>
</tr>
<tr>
<td>data_api = glance.db.sqlalchemy.api</td>
<td>(StrOpt) Python module path of data access API</td>
</tr>
<tr>
<td>disable_process_locking = False</td>
<td>(BoolOpt) Whether to disable inter-process locks</td>
</tr>
<tr>
<td>image_location_quota = 10</td>
<td>(IntOpt) Maximum number of locations allowed on an image. Negative values evaluate to unlimited.</td>
</tr>
<tr>
<td>image_member_quota = 128</td>
<td>(IntOpt) Maximum number of image members per image. Negative values evaluate to unlimited.</td>
</tr>
<tr>
<td>image_property_quota = 128</td>
<td>(IntOpt) Maximum number of properties allowed on an image. Negative values evaluate to unlimited.</td>
</tr>
<tr>
<td>image_tag_quota = 128</td>
<td>(IntOpt) Maximum number of tags allowed on an image. Negative values evaluate to unlimited.</td>
</tr>
<tr>
<td>limit_param_default = 25</td>
<td>(IntOpt) Default value for the number of items returned by a request if not specified explicitly in the request</td>
</tr>
<tr>
<td>lock_path = None</td>
<td>(StrOpt) Directory to use for lock files.</td>
</tr>
<tr>
<td>metadata_encryption_key = None</td>
<td>(StrOpt) Key used for encrypting sensitive metadata while talking to the registry or database.</td>
</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>
</tr>
<tr>
<td>os_region_name = None</td>
<td>(StrOpt) Region name of this node.</td>
</tr>
<tr>
<td>property_protection_file = None</td>
<td>(StrOpt) The location of the property protection file.</td>
</tr>
<tr>
<td>property_protection_rule_format = roles</td>
<td>(StrOpt) This config value indicates whether "roles" or "policies" are used in the property protection file.</td>
</tr>
<tr>
<td>show_image_direct_url = False</td>
<td>(BoolOpt) Whether to include the backend image storage location in image properties. Revealing storage location can be a security risk, so use this setting with caution!</td>
</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>
</tr>
<tr>
<td>workers = 1</td>
<td>(IntOpt) The number of child process workers that will be created to service API requests.</td>
</tr>
<tr>
<th colspan="2">[image_format]</th>
</tr>
<tr>
<td>container_formats = ami, ari, aki, bare, ovf, ova</td>
<td>(ListOpt) Supported values for the 'container_format' image attribute</td>
</tr>
<tr>
<td>disk_formats = ami, ari, aki, vhd, vmdk, raw, qcow2, vdi, iso</td>
<td>(ListOpt) Supported values for the 'disk_format' image attribute</td>
</tr>
<tr>
<th colspan="2">[task]</th>
</tr>
<tr>
<td>task_time_to_live = 48</td>
<td>(IntOpt) Time in hours for which a task lives after, either succeeding or failing</td>
</tr>
</tbody>
</table>
</para>
<?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_common">
<caption>Description of configuration options for common</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>allow_additional_image_properties = True</td>
<td>(BoolOpt) Whether to allow users to specify image properties beyond what the image schema provides</td>
</tr>
<tr>
<td>api_limit_max = 1000</td>
<td>(IntOpt) Maximum permissible number of items that could be returned by a request</td>
</tr>
<tr>
<td>backlog = 4096</td>
<td>(IntOpt) The backlog value that will be used when creating the TCP listener socket.</td>
</tr>
<tr>
<td>bind_host = 0.0.0.0</td>
<td>(StrOpt) Address to bind the server. Useful when selecting a particular network interface.</td>
</tr>
<tr>
<td>bind_port = None</td>
<td>(IntOpt) The port on which the server will listen.</td>
</tr>
<tr>
<td>data_api = glance.db.sqlalchemy.api</td>
<td>(StrOpt) Python module path of data access API</td>
</tr>
<tr>
<td>disable_process_locking = False</td>
<td>(BoolOpt) Whether to disable inter-process locks</td>
</tr>
<tr>
<td>image_location_quota = 10</td>
<td>(IntOpt) Maximum number of locations allowed on an image. Negative values evaluate to unlimited.</td>
</tr>
<tr>
<td>image_member_quota = 128</td>
<td>(IntOpt) Maximum number of image members per image. Negative values evaluate to unlimited.</td>
</tr>
<tr>
<td>image_property_quota = 128</td>
<td>(IntOpt) Maximum number of properties allowed on an image. Negative values evaluate to unlimited.</td>
</tr>
<tr>
<td>image_tag_quota = 128</td>
<td>(IntOpt) Maximum number of tags allowed on an image. Negative values evaluate to unlimited.</td>
</tr>
<tr>
<td>limit_param_default = 25</td>
<td>(IntOpt) Default value for the number of items returned by a request if not specified explicitly in the request</td>
</tr>
<tr>
<td>lock_path = None</td>
<td>(StrOpt) Directory to use for lock files.</td>
</tr>
<tr>
<td>metadata_encryption_key = None</td>
<td>(StrOpt) Key used for encrypting sensitive metadata while talking to the registry or database.</td>
</tr>
<tr>
<td>notifier_strategy = default</td>
<td>(StrOpt) Notifications can be sent when images are create, updated or deleted. There are three methods of sending notifications, logging (via the log_file directive), rabbit (via a rabbitmq queue), qpid (via a Qpid message queue), or noop (no notifications sent, the default).</td>
</tr>
<tr>
<td>os_region_name = None</td>
<td>(StrOpt) Region name of this node.</td>
</tr>
<tr>
<td>property_protection_file = None</td>
<td>(StrOpt) The location of the property protection file.</td>
</tr>
<tr>
<td>property_protection_rule_format = roles</td>
<td>(StrOpt) This config value indicates whether "roles" or "policies" are used in the property protection file.</td>
</tr>
<tr>
<td>show_image_direct_url = False</td>
<td>(BoolOpt) Whether to include the backend image storage location in image properties. Revealing storage location can be a security risk, so use this setting with caution!</td>
</tr>
<tr>
<td>user_storage_quota = 0</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>
<td>(IntOpt) The number of child process workers that will be created to service API requests.</td>
</tr>
<tr>
<th colspan="2">[image_format]</th>
</tr>
<tr>
<td>container_formats = ami, ari, aki, bare, ovf, ova</td>
<td>(ListOpt) Supported values for the 'container_format' image attribute</td>
</tr>
<tr>
<td>disk_formats = ami, ari, aki, vhd, vmdk, raw, qcow2, vdi, iso</td>
<td>(ListOpt) Supported values for the 'disk_format' image attribute</td>
</tr>
<tr>
<th colspan="2">[task]</th>
</tr>
<tr>
<td>task_time_to_live = 48</td>
<td>(IntOpt) Time in hours for which a task lives after, either succeeding or failing</td>
</tr>
</tbody>
</table>
</para>

98
doc/common/tables/glance-database.xml Normal file
View 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
View File

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

69
doc/common/tables/glance-filesystem.xml
View File

@ -1,35 +1,34 @@
<?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_filesystem">
<caption>Description of configuration options for filesystem</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>filesystem_store_datadir = None</td>
<td>(StrOpt) Directory to which the Filesystem backend store writes images.</td>
</tr>
<tr>
<td>filesystem_store_datadirs = None</td>
<td>(MultiStrOpt) List of directories and its priorities to which the Filesystem backend store writes images.</td>
</tr>
<tr>
<td>filesystem_store_metadata_file = None</td>
<td>(StrOpt) The path to a file which contains the metadata to be returned with any location associated with this store. The file must contain a valid JSON dict.</td>
</tr>
</tbody>
</table>
</para>
<?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_filesystem">
<caption>Description of configuration options for filesystem</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>filesystem_store_datadir = None</td>
<td>(StrOpt) Directory to which the Filesystem backend store writes images.</td>
</tr>
<tr>
<td>filesystem_store_datadirs = None</td>
<td>(MultiStrOpt) List of directories and its priorities to which the Filesystem backend store writes images.</td>
</tr>
<tr>
<td>filesystem_store_metadata_file = None</td>
<td>(StrOpt) The path to a file which contains the metadata to be returned with any location associated with this store. The file must contain a valid JSON dict.</td>
</tr>
</tbody>
</table>
</para>

61
doc/common/tables/glance-gridfs.xml
View File

@ -1,31 +1,30 @@
<?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_gridfs">
<caption>Description of configuration options for gridfs</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>mongodb_store_db = None</td>
<td>(StrOpt) Database to use.</td>
</tr>
<tr>
<td>mongodb_store_uri = None</td>
<td>(StrOpt) Hostname or IP address of the instance to connect to, or a mongodb URI, or a list of hostnames / mongodb URIs. If host is an IPv6 literal it must be enclosed in '[' and ']' characters following the RFC2732 URL syntax (e.g. '[::1]' for localhost).</td>
</tr>
</tbody>
</table>
</para>
<?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_gridfs">
<caption>Description of configuration options for gridfs</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>mongodb_store_db = None</td>
<td>(StrOpt) Database to use.</td>
</tr>
<tr>
<td>mongodb_store_uri = None</td>
<td>(StrOpt) Hostname or IP address of the instance to connect to, or a mongodb URI, or a list of hostnames / mongodb URIs. If host is an IPv6 literal it must be enclosed in '[' and ']' characters following the RFC2732 URL syntax (e.g. '[::1]' for localhost).</td>
</tr>
</tbody>
</table>
</para>

125
doc/common/tables/glance-imagecache.xml
View File

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

205
doc/common/tables/glance-logging.xml
View File

@ -1,103 +1,102 @@
<?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_logging">
<caption>Description of configuration options for logging</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>debug = False</td>
<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>fatal_deprecations = False</td>
<td>(BoolOpt) Make deprecations fatal</td>
</tr>
<tr>
<td>instance_format = "[instance: %(uuid)s] "</td>
<td>(StrOpt) If an instance is passed with the log message, format it like this</td>
</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>
</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>
</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>
</tr>
<tr>
<td>log_dir = None</td>
<td>(StrOpt) (Optional) The base directory used for relative --log-file paths</td>
</tr>
<tr>
<td>log_file = None</td>
<td>(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.</td>
</tr>
<tr>
<td>log_format = None</td>
<td>(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.</td>
</tr>
<tr>
<td>logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s</td>
<td>(StrOpt) Format string to use for log messages with context</td>
</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>
</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>
</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>
</tr>
<tr>
<td>publish_errors = False</td>
<td>(BoolOpt) Publish error events</td>
</tr>
<tr>
<td>syslog_log_facility = LOG_USER</td>
<td>(StrOpt) Syslog facility to receive log lines</td>
</tr>
<tr>
<td>use_stderr = True</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>
</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>
</tr>
<tr>
<td>verbose = False</td>
<td>(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).</td>
</tr>
</tbody>
</table>
</para>
<?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_logging">
<caption>Description of configuration options for logging</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>debug = False</td>
<td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).</td>
</tr>
<tr>
<td>default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN</td>
<td>(ListOpt) List of logger=LEVEL pairs.</td>
</tr>
<tr>
<td>fatal_deprecations = False</td>
<td>(BoolOpt) Enables or disables fatal status of deprecations.</td>
</tr>
<tr>
<td>instance_format = "[instance: %(uuid)s] "</td>
<td>(StrOpt) The format for an instance that is passed with the log message. </td>
</tr>
<tr>
<td>instance_uuid_format = "[instance: %(uuid)s] "</td>
<td>(StrOpt) The format for an instance UUID that is passed with the log message. </td>
</tr>
<tr>
<td>log_config_append = None</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>
</tr>
<tr>
<td>log_dir = None</td>
<td>(StrOpt) (Optional) The base directory used for relative --log-file paths.</td>
</tr>
<tr>
<td>log_file = None</td>
<td>(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.</td>
</tr>
<tr>
<td>log_format = None</td>
<td>(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.</td>
</tr>
<tr>
<td>logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s</td>
<td>(StrOpt) Format string to use for log messages with context.</td>
</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>
</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>
</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>
</tr>
<tr>
<td>publish_errors = False</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>
</tr>
<tr>
<td>use_stderr = True</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 will chang in J to honor RFC5424.</td>
</tr>
<tr>
<td>use_syslog_rfc_format = False</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>
</tbody>
</table>
</para>

75
doc/common/tables/glance-matchmaker.xml
View File

@ -1,38 +1,37 @@
<?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_matchmaker">
<caption>Description of configuration options for matchmaker</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>matchmaker_heartbeat_freq = 300</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_ring]</th>
</tr>
<tr>
<td>ringfile = /etc/oslo/matchmaker_ring.json</td>
<td>(StrOpt) Matchmaker ring file (JSON).</td>
</tr>
</tbody>
</table>
</para>
<?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_matchmaker">
<caption>Description of configuration options for matchmaker</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>matchmaker_heartbeat_freq = 300</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_ring]</th>
</tr>
<tr>
<td>ringfile = /etc/oslo/matchmaker_ring.json</td>
<td>(StrOpt) Matchmaker ring file (JSON).</td>
</tr>
</tbody>
</table>
</para>

61
doc/common/tables/glance-paste.xml
View File

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

61
doc/common/tables/glance-policy.xml
View File

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

125
doc/common/tables/glance-qpid.xml
View File

@ -1,63 +1,62 @@
<?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_qpid">
<caption>Description of configuration options for qpid</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>qpid_heartbeat = 60</td>
<td>(IntOpt) Seconds between connection keepalive heartbeats.</td>
</tr>
<tr>
<td>qpid_hostname = localhost</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>
</tr>
<tr>
<td>qpid_password = </td>
<td>(StrOpt) Password for Qpid connection.</td>
</tr>
<tr>
<td>qpid_port = 5672</td>
<td>(IntOpt) Qpid broker port.</td>
</tr>
<tr>
<td>qpid_protocol = tcp</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>
</tr>
<tr>
<td>qpid_tcp_nodelay = True</td>
<td>(BoolOpt) Whether to disable the Nagle algorithm.</td>
</tr>
<tr>
<td>qpid_topology_version = 1</td>
<td>(IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.</td>
</tr>
<tr>
<td>qpid_username = </td>
<td>(StrOpt) Username for Qpid connection.</td>
</tr>
</tbody>
</table>
</para>
<?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_qpid">
<caption>Description of configuration options for qpid</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>qpid_heartbeat = 60</td>
<td>(IntOpt) Seconds between connection keepalive heartbeats.</td>
</tr>
<tr>
<td>qpid_hostname = localhost</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>
</tr>
<tr>
<td>qpid_password = </td>
<td>(StrOpt) Password for Qpid connection.</td>
</tr>
<tr>
<td>qpid_port = 5672</td>
<td>(IntOpt) Qpid broker port.</td>
</tr>
<tr>
<td>qpid_protocol = tcp</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>
</tr>
<tr>
<td>qpid_tcp_nodelay = True</td>
<td>(BoolOpt) Whether to disable the Nagle algorithm.</td>
</tr>
<tr>
<td>qpid_topology_version = 1</td>
<td>(IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.</td>
</tr>
<tr>
<td>qpid_username = </td>
<td>(StrOpt) Username for Qpid connection.</td>
</tr>
</tbody>
</table>
</para>

197
doc/common/tables/glance-rabbitmq.xml
View File

@ -1,99 +1,98 @@
<?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_rabbitmq">
<caption>Description of configuration options for rabbitmq</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>control_exchange = openstack</td>
<td>(StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.</td>
</tr>
<tr>
<td>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>
</tr>
<tr>
<td>kombu_ssl_certfile = </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>
</tr>
<tr>
<td>kombu_ssl_version = </td>
<td>(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions.</td>
</tr>
<tr>
<td>rabbit_ha_queues = False</td>
<td>(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database.</td>
</tr>
<tr>
<td>rabbit_host = localhost</td>
<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>
</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>
</tr>
<tr>
<td>rabbit_password = guest</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>
</tr>
<tr>
<td>rabbit_retry_backoff = 2</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>
</tr>
<tr>
<td>rabbit_use_ssl = False</td>
<td>(BoolOpt) Connect over SSL for RabbitMQ.</td>
</tr>
<tr>
<td>rabbit_userid = guest</td>
<td>(StrOpt) The RabbitMQ userid.</td>
</tr>
<tr>
<td>rabbit_virtual_host = /</td>
<td>(StrOpt) The RabbitMQ virtual host.</td>
</tr>
</tbody>
</table>
</para>
<?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_rabbitmq">
<caption>Description of configuration options for rabbitmq</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>control_exchange = openstack</td>
<td>(StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.</td>
</tr>
<tr>
<td>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>
</tr>
<tr>
<td>kombu_ssl_certfile = </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>
</tr>
<tr>
<td>kombu_ssl_version = </td>
<td>(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions.</td>
</tr>
<tr>
<td>rabbit_ha_queues = False</td>
<td>(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database.</td>
</tr>
<tr>
<td>rabbit_host = localhost</td>
<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>
</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>
</tr>
<tr>
<td>rabbit_password = guest</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>
</tr>
<tr>
<td>rabbit_retry_backoff = 2</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>
</tr>
<tr>
<td>rabbit_use_ssl = False</td>
<td>(BoolOpt) Connect over SSL for RabbitMQ.</td>
</tr>
<tr>
<td>rabbit_userid = guest</td>
<td>(StrOpt) The RabbitMQ userid.</td>
</tr>
<tr>
<td>rabbit_virtual_host = /</td>
<td>(StrOpt) The RabbitMQ virtual host.</td>
</tr>
</tbody>
</table>
</para>

77
doc/common/tables/glance-rbd.xml
View File

@ -1,39 +1,38 @@
<?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_rbd">
<caption>Description of configuration options for rbd</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>rbd_store_ceph_conf = /etc/ceph/ceph.conf</td>
<td>(StrOpt) Ceph configuration file path. If &lt;None&gt;, librados will locate the default config. If using cephx authentication, this file should include a reference to the right keyring in a client.&lt;USER&gt; section.</td>
</tr>
<tr>
<td>rbd_store_chunk_size = 8</td>
<td>(IntOpt) RADOS images will be chunked into objects of this size (in megabytes). For best performance, this should be a power of two.</td>
</tr>
<tr>
<td>rbd_store_pool = images</td>
<td>(StrOpt) RADOS pool in which images are stored.</td>
</tr>
<tr>
<td>rbd_store_user = None</td>
<td>(StrOpt) RADOS user to authenticate as (only applicable if using Cephx. If &lt;None&gt;, a default will be chosen based on the client. section in rbd_store_ceph_conf).</td>
</tr>
</tbody>
</table>
</para>
<?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_rbd">
<caption>Description of configuration options for rbd</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>rbd_store_ceph_conf = /etc/ceph/ceph.conf</td>
<td>(StrOpt) Ceph configuration file path. If &lt;None&gt;, librados will locate the default config. If using cephx authentication, this file should include a reference to the right keyring in a client.&lt;USER&gt; section.</td>
</tr>
<tr>
<td>rbd_store_chunk_size = 8</td>
<td>(IntOpt) RADOS images will be chunked into objects of this size (in megabytes). For best performance, this should be a power of two.</td>
</tr>
<tr>
<td>rbd_store_pool = images</td>
<td>(StrOpt) RADOS pool in which images are stored.</td>
</tr>
<tr>
<td>rbd_store_user = None</td>
<td>(StrOpt) RADOS user to authenticate as (only applicable if using Cephx. If &lt;None&gt;, a default will be chosen based on the client. section in rbd_store_ceph_conf).</td>
</tr>
</tbody>
</table>
</para>

69
doc/common/tables/glance-redis.xml
View File

@ -1,35 +1,34 @@
<?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_redis">
<caption>Description of configuration options for redis</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>host = 127.0.0.1</td>
<td>(StrOpt) Host to locate redis.</td>
</tr>
<tr>
<td>password = None</td>
<td>(StrOpt) Password for Redis server (optional).</td>
</tr>
<tr>
<td>port = 6379</td>
<td>(IntOpt) Use this port to connect to redis host.</td>
</tr>
</tbody>
</table>
</para>
<?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_redis">
<caption>Description of configuration options for redis</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>host = 127.0.0.1</td>
<td>(StrOpt) Host to locate redis.</td>
</tr>
<tr>
<td>password = None</td>
<td>(StrOpt) Password for Redis server (optional).</td>
</tr>
<tr>
<td>port = 6379</td>
<td>(IntOpt) Use this port to connect to redis host.</td>
</tr>
</tbody>
</table>
</para>

157
doc/common/tables/glance-registry.xml
View File

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

53
doc/common/tables/glance-rpc.xml
View File

@ -1,27 +1,26 @@
<?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_rpc">
<caption>Description of configuration options for rpc</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>allowed_rpc_exception_modules = openstack.common.exception, glance.common.exception, exceptions</td>
<td>(ListOpt) Modules of exceptions that are permitted to be recreatedupon receiving exception data from an rpc call.</td>
</tr>
</tbody>
</table>
</para>
<?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_rpc">
<caption>Description of configuration options for rpc</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>allowed_rpc_exception_modules = openstack.common.exception, glance.common.exception, exceptions</td>
<td>(ListOpt) Modules of exceptions that are permitted to be recreatedupon receiving exception data from an rpc call.</td>
</tr>
</tbody>
</table>
</para>

113
doc/common/tables/glance-s3.xml
View File

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

69
doc/common/tables/glance-sheepdog.xml
View File

@ -1,35 +1,34 @@
<?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_sheepdog">
<caption>Description of configuration options for sheepdog</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>sheepdog_store_address = 127.0.0.1</td>
<td>(StrOpt) IP address of sheep daemon.</td>
</tr>
<tr>
<td>sheepdog_store_chunk_size = 64</td>
<td>(IntOpt) Images will be chunked into objects of this size (in megabytes). For best performance, this should be a power of two.</td>
</tr>
<tr>
<td>sheepdog_store_port = 7000</td>
<td>(IntOpt) Port of sheep daemon.</td>
</tr>
</tbody>
</table>
</para>
<?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_sheepdog">
<caption>Description of configuration options for sheepdog</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>sheepdog_store_address = 127.0.0.1</td>
<td>(StrOpt) IP address of sheep daemon.</td>
</tr>
<tr>
<td>sheepdog_store_chunk_size = 64</td>
<td>(IntOpt) Images will be chunked into objects of this size (in megabytes). For best performance, this should be a power of two.</td>
</tr>
<tr>
<td>sheepdog_store_port = 7000</td>
<td>(IntOpt) Port of sheep daemon.</td>
</tr>
</tbody>
</table>
</para>

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