Regenerate config tables for K1
This patch regenerates the configuration tables using code from 2014-12-31, or about kilo-1. It also uses new doc-tools code to mark-up options and their default values semantically. Change-Id: Id68a87b69fb80edbc156b9bcb1549cca5e61464b
This commit is contained in:
Tom Fifield
parent
553034f95d
commit
dc7c13a659
@ -18,47 +18,47 @@
|
||||
<th colspan="2">[alarm]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>evaluation_interval = 60</td>
|
||||
<td><option>evaluation_interval</option> = <replaceable>60</replaceable></td>
|
||||
<td>(IntOpt) Period of evaluation cycle, should be >= than configured pipeline interval for collection of underlying metrics.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>evaluation_service = default</td>
|
||||
<td><option>evaluation_service</option> = <replaceable>default</replaceable></td>
|
||||
<td>(StrOpt) Driver to use for alarm evaluation service. DEPRECATED: "singleton" and "partitioned" alarm evaluator services will be removed in Kilo in favour of the default alarm evaluation service using tooz for partitioning.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>notifier_rpc_topic = alarm_notifier</td>
|
||||
<td><option>notifier_rpc_topic</option> = <replaceable>alarm_notifier</replaceable></td>
|
||||
<td>(StrOpt) The topic that ceilometer uses for alarm notifier messages.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>partition_rpc_topic = alarm_partition_coordination</td>
|
||||
<td><option>partition_rpc_topic</option> = <replaceable>alarm_partition_coordination</replaceable></td>
|
||||
<td>(StrOpt) The topic that ceilometer uses for alarm partition coordination messages. DEPRECATED: RPC-based partitionedalarm evaluation service will be removed in Kilo in favour of the default alarm evaluation service using tooz for partitioning.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>project_alarm_quota = None</td>
|
||||
<td><option>project_alarm_quota</option> = <replaceable>None</replaceable></td>
|
||||
<td>(IntOpt) Maximum number of alarms defined for a project.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>record_history = True</td>
|
||||
<td><option>record_history</option> = <replaceable>True</replaceable></td>
|
||||
<td>(BoolOpt) Record alarm change events.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>rest_notifier_certificate_file = </td>
|
||||
<td><option>rest_notifier_certificate_file</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) SSL Client certificate for REST notifier.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>rest_notifier_certificate_key = </td>
|
||||
<td><option>rest_notifier_certificate_key</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) SSL Client private key for REST notifier.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>rest_notifier_max_retries = 0</td>
|
||||
<td><option>rest_notifier_max_retries</option> = <replaceable>0</replaceable></td>
|
||||
<td>(IntOpt) Number of retries for REST notifier</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>rest_notifier_ssl_verify = True</td>
|
||||
<td><option>rest_notifier_ssl_verify</option> = <replaceable>True</replaceable></td>
|
||||
<td>(BoolOpt) Whether to verify the SSL Server certificate when calling alarm action.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>user_alarm_quota = None</td>
|
||||
<td><option>user_alarm_quota</option> = <replaceable>None</replaceable></td>
|
||||
<td>(IntOpt) Maximum number of alarms defined for a user.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,27 +18,27 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>amqp_auto_delete = False</td>
|
||||
<td>(BoolOpt) Auto-delete queues in amqp.</td>
|
||||
<td><option>amqp_auto_delete</option> = <replaceable>False</replaceable></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>
|
||||
<td><option>amqp_durable_queues</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Use durable queues in AMQP.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>control_exchange = openstack</td>
|
||||
<td><option>control_exchange</option> = <replaceable>openstack</replaceable></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>notification_driver = []</td>
|
||||
<td><option>notification_driver</option> = <replaceable>[]</replaceable></td>
|
||||
<td>(MultiStrOpt) Driver or drivers to handle sending notifications.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>notification_topics = notifications</td>
|
||||
<td><option>notification_topics</option> = <replaceable>notifications</replaceable></td>
|
||||
<td>(ListOpt) AMQP topic used for OpenStack notifications.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>transport_url = None</td>
|
||||
<td><option>transport_url</option> = <replaceable>None</replaceable></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>
|
||||
|
||||
@ -18,50 +18,50 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>api_paste_config = api_paste.ini</td>
|
||||
<td><option>api_paste_config</option> = <replaceable>api_paste.ini</replaceable></td>
|
||||
<td>(StrOpt) Configuration file for WSGI definition of API.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>pipeline_cfg_file = pipeline.yaml</td>
|
||||
<td><option>pipeline_cfg_file</option> = <replaceable>pipeline.yaml</replaceable></td>
|
||||
<td>(StrOpt) Configuration file for pipeline definition.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>policy_default_rule = default</td>
|
||||
<td><option>policy_default_rule</option> = <replaceable>default</replaceable></td>
|
||||
<td>(StrOpt) Default rule. Enforced when a requested rule is not found.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>policy_dirs = ['policy.d']</td>
|
||||
<td><option>policy_dirs</option> = <replaceable>['policy.d']</replaceable></td>
|
||||
<td>(MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>policy_file = policy.json</td>
|
||||
<td><option>policy_file</option> = <replaceable>policy.json</replaceable></td>
|
||||
<td>(StrOpt) The JSON file that defines policies.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>reserved_metadata_length = 256</td>
|
||||
<td><option>reserved_metadata_length</option> = <replaceable>256</replaceable></td>
|
||||
<td>(IntOpt) Limit on length of reserved metadata values.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>reserved_metadata_namespace = metering.</td>
|
||||
<td><option>reserved_metadata_namespace</option> = <replaceable>metering.</replaceable></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><option>enable_reverse_dns_lookup</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Set it to False if your environment does not need or have a DNS server, otherwise it will delay the response from the API.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>host = 0.0.0.0</td>
|
||||
<td><option>host</option> = <replaceable>0.0.0.0</replaceable></td>
|
||||
<td>(StrOpt) The listen IP for the ceilometer API server.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>pecan_debug = False</td>
|
||||
<td><option>pecan_debug</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Toggle Pecan Debug Middleware. Defaults to global debug value.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>port = 8777</td>
|
||||
<td><option>port</option> = <replaceable>8777</replaceable></td>
|
||||
<td>(IntOpt) The port for the ceilometer API server.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,39 +18,39 @@
|
||||
<th colspan="2">[service_credentials]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>insecure = False</td>
|
||||
<td><option>insecure</option> = <replaceable>False</replaceable></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><option>os_auth_url</option> = <replaceable>http://localhost:5000/v2.0</replaceable></td>
|
||||
<td>(StrOpt) Auth URL to use for OpenStack service access.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>os_cacert = None</td>
|
||||
<td><option>os_cacert</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Certificate chain for SSL validation.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>os_endpoint_type = publicURL</td>
|
||||
<td><option>os_endpoint_type</option> = <replaceable>publicURL</replaceable></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><option>os_password</option> = <replaceable>admin</replaceable></td>
|
||||
<td>(StrOpt) Password to use for OpenStack service access.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>os_region_name = None</td>
|
||||
<td><option>os_region_name</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Region name to use for OpenStack service endpoints.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>os_tenant_id = </td>
|
||||
<td><option>os_tenant_id</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) Tenant ID to use for OpenStack service access.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>os_tenant_name = admin</td>
|
||||
<td><option>os_tenant_name</option> = <replaceable>admin</replaceable></td>
|
||||
<td>(StrOpt) Tenant name to use for OpenStack service access.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>os_username = ceilometer</td>
|
||||
<td><option>os_username</option> = <replaceable>ceilometer</replaceable></td>
|
||||
<td>(StrOpt) User name to use for OpenStack service access.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,115 +18,115 @@
|
||||
<th colspan="2">[keystone_authtoken]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>admin_password = None</td>
|
||||
<td><option>admin_password</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Keystone account password</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>admin_tenant_name = admin</td>
|
||||
<td><option>admin_tenant_name</option> = <replaceable>admin</replaceable></td>
|
||||
<td>(StrOpt) Keystone service account tenant name to validate user tokens</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>admin_token = None</td>
|
||||
<td><option>admin_token</option> = <replaceable>None</replaceable></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><option>admin_user</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Keystone account username</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>auth_admin_prefix = </td>
|
||||
<td><option>auth_admin_prefix</option> = <replaceable></replaceable></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><option>auth_host</option> = <replaceable>127.0.0.1</replaceable></td>
|
||||
<td>(StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>auth_port = 35357</td>
|
||||
<td><option>auth_port</option> = <replaceable>35357</replaceable></td>
|
||||
<td>(IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>auth_protocol = https</td>
|
||||
<td><option>auth_protocol</option> = <replaceable>https</replaceable></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><option>auth_uri</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Complete public Identity API endpoint</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>auth_version = None</td>
|
||||
<td><option>auth_version</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) API version of the admin Identity API endpoint</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>cache = None</td>
|
||||
<td><option>cache</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Env key for the swift cache</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>cafile = None</td>
|
||||
<td><option>cafile</option> = <replaceable>None</replaceable></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><option>certfile</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Required if Keystone server requires client certificate</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>check_revocations_for_cached = False</td>
|
||||
<td><option>check_revocations_for_cached</option> = <replaceable>False</replaceable></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><option>delay_auth_decision</option> = <replaceable>False</replaceable></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><option>enforce_token_bind</option> = <replaceable>permissive</replaceable></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><option>hash_algorithms</option> = <replaceable>md5</replaceable></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><option>http_connect_timeout</option> = <replaceable>None</replaceable></td>
|
||||
<td>(BoolOpt) Request timeout value for communicating with Identity API server.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>http_request_max_retries = 3</td>
|
||||
<td><option>http_request_max_retries</option> = <replaceable>3</replaceable></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><option>identity_uri</option> = <replaceable>None</replaceable></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><option>include_service_catalog</option> = <replaceable>True</replaceable></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><option>insecure</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Verify HTTPS connections.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>keyfile = None</td>
|
||||
<td><option>keyfile</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Required if Keystone server requires client certificate</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>memcache_secret_key = None</td>
|
||||
<td><option>memcache_secret_key</option> = <replaceable>None</replaceable></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><option>memcache_security_strategy</option> = <replaceable>None</replaceable></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>revocation_cache_time = 10</td>
|
||||
<td><option>revocation_cache_time</option> = <replaceable>10</replaceable></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><option>signing_dir</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Directory used to cache files related to PKI tokens</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>token_cache_time = 300</td>
|
||||
<td><option>token_cache_time</option> = <replaceable>300</replaceable></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>
|
||||
|
||||
62
doc/common/tables/ceilometer-cells.xml
Normal file
62
doc/common/tables/ceilometer-cells.xml
Normal file
@ -0,0 +1,62 @@
|
||||
<?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_cells">
|
||||
<caption>Description of Nova-cells configuration options</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><option>bandwidth_update_interval</option> = <replaceable>600</replaceable></td>
|
||||
<td>(IntOpt) Seconds between bandwidth updates for cells.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>call_timeout</option> = <replaceable>60</replaceable></td>
|
||||
<td>(IntOpt) Seconds to wait for response from a call to a cell.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>capabilities</option> = <replaceable>hypervisor=xenserver;kvm, os=linux;windows</replaceable></td>
|
||||
<td>(ListOpt) Key/Multi-value list with the capabilities of the cell</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>cell_type</option> = <replaceable>compute</replaceable></td>
|
||||
<td>(StrOpt) Type of cell: api or compute</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>enable</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Enable cell functionality</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>manager</option> = <replaceable>nova.cells.manager.CellsManager</replaceable></td>
|
||||
<td>(StrOpt) Manager for cells</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>mute_child_interval</option> = <replaceable>300</replaceable></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><option>name</option> = <replaceable>nova</replaceable></td>
|
||||
<td>(StrOpt) Name of this cell</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>reserve_percent</option> = <replaceable>10.0</replaceable></td>
|
||||
<td>(FloatOpt) Percentage of cell capacity to hold in reserve. Affects both memory and disk utilization</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>topic</option> = <replaceable>cells</replaceable></td>
|
||||
<td>(StrOpt) The topic cells nodes listen on</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</para>
|
||||
@ -18,37 +18,37 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>collector_workers = 1</td>
|
||||
<td><option>collector_workers</option> = <replaceable>1</replaceable></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>requeue_sample_on_dispatcher_error = False</td>
|
||||
<td><option>requeue_sample_on_dispatcher_error</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Requeue the sample on the collector sample queue when the collector fails to dispatch it. This is only valid if the sample come from the notifier publisher.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>udp_address = 0.0.0.0</td>
|
||||
<td><option>udp_address</option> = <replaceable>0.0.0.0</replaceable></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><option>udp_port</option> = <replaceable>4952</replaceable></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><option>backup_count</option> = <replaceable>0</replaceable></td>
|
||||
<td>(IntOpt) The max number of the files to keep.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>file_path = None</td>
|
||||
<td><option>file_path</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Name and the location of the file to record meters.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>max_bytes = 0</td>
|
||||
<td><option>max_bytes</option> = <replaceable>0</replaceable></td>
|
||||
<td>(IntOpt) The max size of the file.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,57 +18,69 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>host = localhost</td>
|
||||
<td><option>host</option> = <replaceable>localhost</replaceable></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>http_timeout = 600</td>
|
||||
<td><option>http_timeout</option> = <replaceable>600</replaceable></td>
|
||||
<td>(IntOpt) Timeout seconds for HTTP requests. Set it to None to disable timeout.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>memcached_servers = None</td>
|
||||
<td><option>memcached_servers</option> = <replaceable>None</replaceable></td>
|
||||
<td>(ListOpt) Memcached servers or None for in process cache.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>notification_workers = 1</td>
|
||||
<td><option>notification_workers</option> = <replaceable>1</replaceable></td>
|
||||
<td>(IntOpt) Number of workers for notification service. A single notification agent is enabled by default.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>rootwrap_config = /etc/ceilometer/rootwrap.conf</td>
|
||||
<td><option>polling_namespaces</option> = <replaceable>['compute', 'central']</replaceable></td>
|
||||
<td>(MultiChoicesOpt) Polling namespace(s) to be used while resource polling</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>pollster_list</option> = <replaceable>[]</replaceable></td>
|
||||
<td>(MultiChoicesOpt) List of pollsters (or wildcard templates) to be used while polling</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>rootwrap_config</option> = <replaceable>/etc/ceilometer/rootwrap.conf</replaceable></td>
|
||||
<td>(StrOpt) Path to the rootwrap configuration file touse for running commands as root</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th colspan="2">[central]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>partitioning_group_prefix = None</td>
|
||||
<td>(StrOpt) Work-load partitioning group prefix. Use only if you want to run multiple central agents with different config files. For each sub-group of the central agent pool with the same partitioning_group_prefix a disjoint subset of pollsters should be loaded.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th colspan="2">[compute]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>workload_partitioning = False</td>
|
||||
<td><option>workload_partitioning</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Enable work-load partitioning, allowing multiple compute agents to be run simultaneously.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th colspan="2">[coordination]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>backend_url = None</td>
|
||||
<td><option>backend_url</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) The backend URL to use for distributed coordination. If left empty, per-deployment central agent and per-host compute agent won't do workload partitioning and will only function correctly if a single instance of that service is running.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>heartbeat = 1.0</td>
|
||||
<td><option>check_watchers</option> = <replaceable>10.0</replaceable></td>
|
||||
<td>(FloatOpt) Number of seconds between checks to see if group membership has changed</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>heartbeat</option> = <replaceable>1.0</replaceable></td>
|
||||
<td>(FloatOpt) Number of seconds between heartbeats for distributed coordination.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th colspan="2">[keystone_authtoken]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>memcached_servers = None</td>
|
||||
<td><option>memcached_servers</option> = <replaceable>None</replaceable></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>
|
||||
<th colspan="2">[polling]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>partitioning_group_prefix</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Work-load partitioning group prefix. Use only if you want to run multiple polling agents with different config files. For each sub-group of the agent pool with the same partitioning_group_prefix a disjoint subset of pollsters should be loaded.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</para>
|
||||
|
||||
30
doc/common/tables/ceilometer-compute.xml
Normal file
30
doc/common/tables/ceilometer-compute.xml
Normal file
@ -0,0 +1,30 @@
|
||||
<?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_compute">
|
||||
<caption>Description of Compute configuration options</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><option>instance_usage_audit_period</option> = <replaceable>month</replaceable></td>
|
||||
<td>(StrOpt) Time period to generate instance usages for. Time period must be hour, day, month or year</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>password_length</option> = <replaceable>12</replaceable></td>
|
||||
<td>(IntOpt) Length of generated instance admin passwords</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</para>
|
||||
@ -18,114 +18,114 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>database_connection = None</td>
|
||||
<td><option>database_connection</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) DEPRECATED - Database connection string.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th colspan="2">[database]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>alarm_connection = None</td>
|
||||
<td><option>alarm_connection</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) The connection string used to connect to the alarm database. (if unset, connection is used)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>backend = sqlalchemy</td>
|
||||
<td><option>backend</option> = <replaceable>sqlalchemy</replaceable></td>
|
||||
<td>(StrOpt) The back end to use for the database.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>connection = None</td>
|
||||
<td><option>connection</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) The SQLAlchemy connection string to use to connect to the database.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>connection_debug = 0</td>
|
||||
<td><option>connection_debug</option> = <replaceable>0</replaceable></td>
|
||||
<td>(IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>connection_trace = False</td>
|
||||
<td><option>connection_trace</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Add Python stack traces to SQL as comment strings.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>db2nosql_resource_id_maxlen = 512</td>
|
||||
<td><option>db2nosql_resource_id_maxlen</option> = <replaceable>512</replaceable></td>
|
||||
<td>(IntOpt) The max length of resources id in DB2 nosql, the value should be larger than len(hostname) * 2 as compute node's resource id is <hostname>_<nodename>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>db_inc_retry_interval = True</td>
|
||||
<td><option>db_inc_retry_interval</option> = <replaceable>True</replaceable></td>
|
||||
<td>(BoolOpt) If True, increases the interval between database connection retries up to db_max_retry_interval.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>db_max_retries = 20</td>
|
||||
<td><option>db_max_retries</option> = <replaceable>20</replaceable></td>
|
||||
<td>(IntOpt) Maximum database connection retries before error is raised. Set to -1 to specify an infinite retry count.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>db_max_retry_interval = 10</td>
|
||||
<td><option>db_max_retry_interval</option> = <replaceable>10</replaceable></td>
|
||||
<td>(IntOpt) If db_inc_retry_interval is set, the maximum seconds between database connection retries.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>db_retry_interval = 1</td>
|
||||
<td><option>db_retry_interval</option> = <replaceable>1</replaceable></td>
|
||||
<td>(IntOpt) Seconds between database connection retries.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>event_connection = None</td>
|
||||
<td><option>event_connection</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) The connection string used to connect to the event database. (if unset, connection is used)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>idle_timeout = 3600</td>
|
||||
<td><option>idle_timeout</option> = <replaceable>3600</replaceable></td>
|
||||
<td>(IntOpt) Timeout before idle SQL connections are reaped.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>max_overflow = None</td>
|
||||
<td><option>max_overflow</option> = <replaceable>None</replaceable></td>
|
||||
<td>(IntOpt) If set, use this value for max_overflow with SQLAlchemy.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>max_pool_size = None</td>
|
||||
<td><option>max_pool_size</option> = <replaceable>None</replaceable></td>
|
||||
<td>(IntOpt) Maximum number of SQL connections to keep open in a pool.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>max_retries = 10</td>
|
||||
<td><option>max_retries</option> = <replaceable>10</replaceable></td>
|
||||
<td>(IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>metering_connection = None</td>
|
||||
<td><option>metering_connection</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) The connection string used to connect to the metering database. (if unset, connection is used)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>min_pool_size = 1</td>
|
||||
<td><option>min_pool_size</option> = <replaceable>1</replaceable></td>
|
||||
<td>(IntOpt) Minimum number of SQL connections to keep open in a pool.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>mongodb_replica_set = </td>
|
||||
<td><option>mongodb_replica_set</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) The name of the replica set which is used to connect to MongoDB database. If it is set, MongoReplicaSetClient will be used instead of MongoClient.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>mysql_sql_mode = TRADITIONAL</td>
|
||||
<td><option>mysql_sql_mode</option> = <replaceable>TRADITIONAL</replaceable></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><option>pool_timeout</option> = <replaceable>None</replaceable></td>
|
||||
<td>(IntOpt) If set, use this value for pool_timeout with SQLAlchemy.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>retry_interval = 10</td>
|
||||
<td><option>retry_interval</option> = <replaceable>10</replaceable></td>
|
||||
<td>(IntOpt) Interval between retries of opening a SQL connection.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>slave_connection = None</td>
|
||||
<td><option>slave_connection</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) The SQLAlchemy connection string to use to connect to the slave database.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>sqlite_db = oslo.sqlite</td>
|
||||
<td><option>sqlite_db</option> = <replaceable>oslo.sqlite</replaceable></td>
|
||||
<td>(StrOpt) The file name to use with SQLite.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>sqlite_synchronous = True</td>
|
||||
<td><option>sqlite_synchronous</option> = <replaceable>True</replaceable></td>
|
||||
<td>(BoolOpt) If True, SQLite uses synchronous mode.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>time_to_live = -1</td>
|
||||
<td><option>time_to_live</option> = <replaceable>-1</replaceable></td>
|
||||
<td>(IntOpt) Number of seconds that samples are kept in the database for (<= 0 means forever).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>use_db_reconnect = False</td>
|
||||
<td><option>use_db_reconnect</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Enable the experimental use of database reconnect on connection lost.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,11 +18,11 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>backdoor_port = None</td>
|
||||
<td><option>backdoor_port</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> 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>nova_http_log_debug = False</td>
|
||||
<td><option>nova_http_log_debug</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Allow novaclient's debug log output.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,15 +18,15 @@
|
||||
<th colspan="2">[dispatcher_http]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>cadf_only = False</td>
|
||||
<td><option>cadf_only</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) The flag which indicates if only cadf message should be posted. If false, all meters will be posted.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>target = </td>
|
||||
<td><option>target</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) The target where the http request will be sent to. If this is not set, no data will be posted. For example: target = http://hostname:1234/path</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>timeout = 5</td>
|
||||
<td><option>timeout</option> = <replaceable>5</replaceable></td>
|
||||
<td>(IntOpt) The max time in second to wait for a request to timeout.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,24 +18,28 @@
|
||||
<th colspan="2">[event]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>definitions_cfg_file = event_definitions.yaml</td>
|
||||
<td><option>definitions_cfg_file</option> = <replaceable>event_definitions.yaml</replaceable></td>
|
||||
<td>(StrOpt) Configuration file for event definitions.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>drop_unmatched_notifications = False</td>
|
||||
<td><option>drop_unmatched_notifications</option> = <replaceable>False</replaceable></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><option>ack_on_event_error</option> = <replaceable>True</replaceable></td>
|
||||
<td>(BoolOpt) Acknowledge message when event persistence fails.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>store_events = False</td>
|
||||
<td><option>store_events</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Save event details.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>workload_partitioning</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Enable workload partitioning, allowing multiple notification agents to be run simultaneously.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</para>
|
||||
|
||||
@ -18,47 +18,47 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>cinder_control_exchange = cinder</td>
|
||||
<td><option>cinder_control_exchange</option> = <replaceable>cinder</replaceable></td>
|
||||
<td>(StrOpt) Exchange name for Cinder notifications.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>glance_control_exchange = glance</td>
|
||||
<td><option>glance_control_exchange</option> = <replaceable>glance</replaceable></td>
|
||||
<td>(StrOpt) Exchange name for Glance notifications.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>heat_control_exchange = heat</td>
|
||||
<td><option>heat_control_exchange</option> = <replaceable>heat</replaceable></td>
|
||||
<td>(StrOpt) Exchange name for Heat notifications</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>http_control_exchanges = ['nova', 'glance', 'neutron', 'cinder']</td>
|
||||
<td><option>http_control_exchanges</option> = <replaceable>['nova', 'glance', 'neutron', 'cinder']</replaceable></td>
|
||||
<td>(MultiStrOpt) Exchanges name to listen for notifications.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>ironic_exchange = ironic</td>
|
||||
<td><option>ironic_exchange</option> = <replaceable>ironic</replaceable></td>
|
||||
<td>(StrOpt) Exchange name for Ironic notifications.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>keystone_control_exchange = keystone</td>
|
||||
<td><option>keystone_control_exchange</option> = <replaceable>keystone</replaceable></td>
|
||||
<td>(StrOpt) Exchange name for Keystone notifications.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>neutron_control_exchange = neutron</td>
|
||||
<td><option>neutron_control_exchange</option> = <replaceable>neutron</replaceable></td>
|
||||
<td>(StrOpt) Exchange name for Neutron notifications.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>nova_control_exchange = nova</td>
|
||||
<td><option>nova_control_exchange</option> = <replaceable>nova</replaceable></td>
|
||||
<td>(StrOpt) Exchange name for Nova notifications.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>sahara_control_exchange = sahara</td>
|
||||
<td><option>sahara_control_exchange</option> = <replaceable>sahara</replaceable></td>
|
||||
<td>(StrOpt) Exchange name for Data Processing notifications.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>sample_source = openstack</td>
|
||||
<td><option>sample_source</option> = <replaceable>openstack</replaceable></td>
|
||||
<td>(StrOpt) Source for samples emitted on this instance.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>trove_control_exchange = trove</td>
|
||||
<td><option>trove_control_exchange</option> = <replaceable>trove</replaceable></td>
|
||||
<td>(StrOpt) Exchange name for DBaaS notifications.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,7 +18,7 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>glance_page_size = 0</td>
|
||||
<td><option>glance_page_size</option> = <replaceable>0</replaceable></td>
|
||||
<td>(IntOpt) Number of items to request in each paginated Glance API request (parameter used by glancecelient). If this is less than or equal to 0, page size is not specified (default value in glanceclient is used).</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,15 +18,15 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hypervisor_inspector = libvirt</td>
|
||||
<td><option>hypervisor_inspector</option> = <replaceable>libvirt</replaceable></td>
|
||||
<td>(StrOpt) Inspector to use for inspecting the hypervisor layer.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>libvirt_type = kvm</td>
|
||||
<td><option>libvirt_type</option> = <replaceable>kvm</replaceable></td>
|
||||
<td>(StrOpt) Libvirt domain type (valid options are: kvm, lxc, qemu, uml, xen).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>libvirt_uri = </td>
|
||||
<td><option>libvirt_uri</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) Override the default libvirt URI (which is dependent on libvirt_type).</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,7 +18,7 @@
|
||||
<th colspan="2">[ipmi]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>node_manager_init_retry = 3</td>
|
||||
<td><option>node_manager_init_retry</option> = <replaceable>3</replaceable></td>
|
||||
<td>(IntOpt) Number of retries upon Intel Node Manager initialization failure</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,83 +18,87 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>debug = False</td>
|
||||
<td><option>debug</option> = <replaceable>False</replaceable></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, urllib3.connectionpool=WARN, websocket=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN</td>
|
||||
<td><option>default_log_levels</option> = <replaceable>amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN</replaceable></td>
|
||||
<td>(ListOpt) List of logger=LEVEL pairs.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>fatal_deprecations = False</td>
|
||||
<td><option>fatal_deprecations</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Enables or disables fatal status of deprecations.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>instance_format = "[instance: %(uuid)s] "</td>
|
||||
<td><option>fatal_exception_format_errors</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Make exception message format errors fatal</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>instance_format</option> = <replaceable>"[instance: %(uuid)s] "</replaceable></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><option>instance_uuid_format</option> = <replaceable>"[instance: %(uuid)s] "</replaceable></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><option>log_config_append</option> = <replaceable>None</replaceable></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><option>log_date_format</option> = <replaceable>%Y-%m-%d %H:%M:%S</replaceable></td>
|
||||
<td>(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s .</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>log_dir = None</td>
|
||||
<td><option>log_dir</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) (Optional) The base directory used for relative --log-file paths.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>log_file = None</td>
|
||||
<td><option>log_file</option> = <replaceable>None</replaceable></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><option>log_format</option> = <replaceable>None</replaceable></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><option>logging_context_format_string</option> = <replaceable>%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s</replaceable></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><option>logging_debug_format_suffix</option> = <replaceable>%(funcName)s %(pathname)s:%(lineno)d</replaceable></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><option>logging_default_format_string</option> = <replaceable>%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s</replaceable></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><option>logging_exception_prefix</option> = <replaceable>%(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s</replaceable></td>
|
||||
<td>(StrOpt) Prefix each line of exception output with this format.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>publish_errors = False</td>
|
||||
<td><option>publish_errors</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Enables or disables publication of error events.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>syslog_log_facility = LOG_USER</td>
|
||||
<td><option>syslog_log_facility</option> = <replaceable>LOG_USER</replaceable></td>
|
||||
<td>(StrOpt) Syslog facility to receive log lines.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>use_stderr = True</td>
|
||||
<td><option>use_stderr</option> = <replaceable>True</replaceable></td>
|
||||
<td>(BoolOpt) Log output to standard error.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>use_syslog = False</td>
|
||||
<td><option>use_syslog</option> = <replaceable>False</replaceable></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><option>use_syslog_rfc_format</option> = <replaceable>False</replaceable></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><option>verbose</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,47 +18,47 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>qpid_heartbeat = 60</td>
|
||||
<td><option>qpid_heartbeat</option> = <replaceable>60</replaceable></td>
|
||||
<td>(IntOpt) Seconds between connection keepalive heartbeats.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>qpid_hostname = localhost</td>
|
||||
<td><option>qpid_hostname</option> = <replaceable>localhost</replaceable></td>
|
||||
<td>(StrOpt) Qpid broker hostname.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>qpid_hosts = $qpid_hostname:$qpid_port</td>
|
||||
<td><option>qpid_hosts</option> = <replaceable>$qpid_hostname:$qpid_port</replaceable></td>
|
||||
<td>(ListOpt) Qpid HA cluster host:port pairs.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>qpid_password = </td>
|
||||
<td><option>qpid_password</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) Password for Qpid connection.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>qpid_port = 5672</td>
|
||||
<td><option>qpid_port</option> = <replaceable>5672</replaceable></td>
|
||||
<td>(IntOpt) Qpid broker port.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>qpid_protocol = tcp</td>
|
||||
<td><option>qpid_protocol</option> = <replaceable>tcp</replaceable></td>
|
||||
<td>(StrOpt) Transport to use, either 'tcp' or 'ssl'.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>qpid_receiver_capacity = 1</td>
|
||||
<td><option>qpid_receiver_capacity</option> = <replaceable>1</replaceable></td>
|
||||
<td>(IntOpt) The number of prefetched messages held by receiver.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>qpid_sasl_mechanisms = </td>
|
||||
<td><option>qpid_sasl_mechanisms</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) Space separated list of SASL mechanisms to use for auth.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>qpid_tcp_nodelay = True</td>
|
||||
<td><option>qpid_tcp_nodelay</option> = <replaceable>True</replaceable></td>
|
||||
<td>(BoolOpt) Whether to disable the Nagle algorithm.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>qpid_topology_version = 1</td>
|
||||
<td><option>qpid_topology_version</option> = <replaceable>1</replaceable></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><option>qpid_username</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) Username for Qpid connection.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,71 +18,71 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>kombu_reconnect_delay = 1.0</td>
|
||||
<td><option>kombu_reconnect_delay</option> = <replaceable>1.0</replaceable></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><option>kombu_ssl_ca_certs</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) SSL certification authority file (valid only if SSL enabled).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>kombu_ssl_certfile = </td>
|
||||
<td><option>kombu_ssl_certfile</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) SSL cert file (valid only if SSL enabled).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>kombu_ssl_keyfile = </td>
|
||||
<td><option>kombu_ssl_keyfile</option> = <replaceable></replaceable></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>
|
||||
<td><option>kombu_ssl_version</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1 and SSLv23. SSLv2 and SSLv3 may be available on some distributions.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>rabbit_ha_queues = False</td>
|
||||
<td><option>rabbit_ha_queues</option> = <replaceable>False</replaceable></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><option>rabbit_host</option> = <replaceable>localhost</replaceable></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><option>rabbit_hosts</option> = <replaceable>$rabbit_host:$rabbit_port</replaceable></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>
|
||||
<td><option>rabbit_login_method</option> = <replaceable>AMQPLAIN</replaceable></td>
|
||||
<td>(StrOpt) The RabbitMQ login method.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>rabbit_max_retries = 0</td>
|
||||
<td><option>rabbit_max_retries</option> = <replaceable>0</replaceable></td>
|
||||
<td>(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>rabbit_password = guest</td>
|
||||
<td><option>rabbit_password</option> = <replaceable>guest</replaceable></td>
|
||||
<td>(StrOpt) The RabbitMQ password.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>rabbit_port = 5672</td>
|
||||
<td><option>rabbit_port</option> = <replaceable>5672</replaceable></td>
|
||||
<td>(IntOpt) The RabbitMQ broker port where a single node is used.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>rabbit_retry_backoff = 2</td>
|
||||
<td><option>rabbit_retry_backoff</option> = <replaceable>2</replaceable></td>
|
||||
<td>(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>rabbit_retry_interval = 1</td>
|
||||
<td><option>rabbit_retry_interval</option> = <replaceable>1</replaceable></td>
|
||||
<td>(IntOpt) How frequently to retry connecting with RabbitMQ.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>rabbit_use_ssl = False</td>
|
||||
<td><option>rabbit_use_ssl</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Connect over SSL for RabbitMQ.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>rabbit_userid = guest</td>
|
||||
<td><option>rabbit_userid</option> = <replaceable>guest</replaceable></td>
|
||||
<td>(StrOpt) The RabbitMQ userid.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>rabbit_virtual_host = /</td>
|
||||
<td><option>rabbit_virtual_host</option> = <replaceable>/</replaceable></td>
|
||||
<td>(StrOpt) The RabbitMQ virtual host.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,22 +18,22 @@
|
||||
<th colspan="2">[matchmaker_redis]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>host = 127.0.0.1</td>
|
||||
<td><option>host</option> = <replaceable>127.0.0.1</replaceable></td>
|
||||
<td>(StrOpt) Host to locate redis.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>password = None</td>
|
||||
<td><option>password</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Password for Redis server (optional).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>port = 6379</td>
|
||||
<td><option>port</option> = <replaceable>6379</replaceable></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><option>ringfile</option> = <replaceable>/etc/oslo/matchmaker_ring.json</replaceable></td>
|
||||
<td>(StrOpt) Matchmaker ring file (JSON).</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,23 +18,23 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>filters_path = /etc/ceilometer/rootwrap.d,/usr/share/ceilometer/rootwrap</td>
|
||||
<td><option>filters_path</option> = <replaceable>/etc/ceilometer/rootwrap.d,/usr/share/ceilometer/rootwrap</replaceable></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><option>exec_dirs</option> = <replaceable>/sbin,/usr/sbin,/bin,/usr/bin</replaceable></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><option>use_syslog</option> = <replaceable>False</replaceable></td>
|
||||
<td>Enable logging to syslog Default value is False</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>syslog_log_facility = syslog</td>
|
||||
<td><option>syslog_log_facility</option> = <replaceable>syslog</replaceable></td>
|
||||
<td>Which syslog facility to use. Valid values include auth, authpriv, syslog, user0, user1... Default value is 'syslog'</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>syslog_log_level = ERROR</td>
|
||||
<td><option>syslog_log_level</option> = <replaceable>ERROR</replaceable></td>
|
||||
<td>Which messages to log. INFO means log all usage ERROR means only log unsuccessful attempts</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,67 +18,114 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>dispatcher = ['database']</td>
|
||||
<td><option>dispatcher</option> = <replaceable>['database']</replaceable></td>
|
||||
<td>(MultiStrOpt) Dispatcher to process data.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>matchmaker_heartbeat_freq = 300</td>
|
||||
<td><option>matchmaker_heartbeat_freq</option> = <replaceable>300</replaceable></td>
|
||||
<td>(IntOpt) Heartbeat frequency.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>matchmaker_heartbeat_ttl = 600</td>
|
||||
<td><option>matchmaker_heartbeat_ttl</option> = <replaceable>600</replaceable></td>
|
||||
<td>(IntOpt) Heartbeat time-to-live.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>rpc_backend = rabbit</td>
|
||||
<td><option>rpc_backend</option> = <replaceable>rabbit</replaceable></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><option>rpc_cast_timeout</option> = <replaceable>30</replaceable></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><option>rpc_conn_pool_size</option> = <replaceable>30</replaceable></td>
|
||||
<td>(IntOpt) Size of RPC connection pool.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>rpc_response_timeout = 60</td>
|
||||
<td><option>rpc_response_timeout</option> = <replaceable>60</replaceable></td>
|
||||
<td>(IntOpt) Seconds to wait for a response from a call.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>rpc_thread_pool_size = 64</td>
|
||||
<td><option>rpc_thread_pool_size</option> = <replaceable>64</replaceable></td>
|
||||
<td>(IntOpt) Size of RPC greenthread pool.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th colspan="2">[notification]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>messaging_urls = []</td>
|
||||
<td><option>messaging_urls</option> = <replaceable>[]</replaceable></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">[oslo_messaging_amqp]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>allow_insecure_clients</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Accept clients using either SSL or plain TCP</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>broadcast_prefix</option> = <replaceable>broadcast</replaceable></td>
|
||||
<td>(StrOpt) address prefix used when broadcasting to all servers</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>container_name</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Name for the AMQP container</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>group_request_prefix</option> = <replaceable>unicast</replaceable></td>
|
||||
<td>(StrOpt) address prefix when sending to any server in group</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>idle_timeout</option> = <replaceable>0</replaceable></td>
|
||||
<td>(IntOpt) Timeout for inactive connections (in seconds)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>server_request_prefix</option> = <replaceable>exclusive</replaceable></td>
|
||||
<td>(StrOpt) address prefix used when sending to a specific server</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>ssl_ca_file</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) CA certificate PEM file for verifing server certificate</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>ssl_cert_file</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) Identifying certificate PEM file to present to clients</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>ssl_key_file</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) Private key PEM file used to sign cert_file certificate</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>ssl_key_password</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Password for decrypting ssl_key_file (if encrypted)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>trace</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Debug: dump AMQP frames to stdout</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th colspan="2">[publisher]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>metering_secret = change this or be hacked</td>
|
||||
<td><option>metering_secret</option> = <replaceable>change this or be hacked</replaceable></td>
|
||||
<td>(StrOpt) Secret value for signing metering messages.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th colspan="2">[publisher_notifier]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>metering_driver = messagingv2</td>
|
||||
<td><option>metering_driver</option> = <replaceable>messagingv2</replaceable></td>
|
||||
<td>(StrOpt) The driver that ceilometer uses for metering notifications.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>metering_topic = metering</td>
|
||||
<td><option>metering_topic</option> = <replaceable>metering</replaceable></td>
|
||||
<td>(StrOpt) The topic that ceilometer uses for metering notifications.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th colspan="2">[publisher_rpc]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>metering_topic = metering</td>
|
||||
<td><option>metering_topic</option> = <replaceable>metering</replaceable></td>
|
||||
<td>(StrOpt) The topic that ceilometer uses for metering messages.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,23 +18,23 @@
|
||||
<th colspan="2">[service_types]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>glance = image</td>
|
||||
<td><option>glance</option> = <replaceable>image</replaceable></td>
|
||||
<td>(StrOpt) Glance service type.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>kwapi = energy</td>
|
||||
<td><option>kwapi</option> = <replaceable>energy</replaceable></td>
|
||||
<td>(StrOpt) Kwapi service type.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>neutron = network</td>
|
||||
<td><option>neutron</option> = <replaceable>network</replaceable></td>
|
||||
<td>(StrOpt) Neutron service type.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>nova = compute</td>
|
||||
<td><option>nova</option> = <replaceable>compute</replaceable></td>
|
||||
<td>(StrOpt) Nova service type.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>swift = object-store</td>
|
||||
<td><option>swift</option> = <replaceable>object-store</replaceable></td>
|
||||
<td>(StrOpt) Swift service type.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,7 +18,7 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>reseller_prefix = AUTH_</td>
|
||||
<td><option>reseller_prefix</option> = <replaceable>AUTH_</replaceable></td>
|
||||
<td>(StrOpt) Swift reseller prefix. Must be on par with reseller_prefix in proxy-server.conf.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,8 +18,16 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>fake_rabbit = False</td>
|
||||
<td>(BoolOpt) If passed, use a fake RabbitMQ provider.</td>
|
||||
<td><option>fake_rabbit</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>monkey_patch</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Whether to log monkey patching</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>monkey_patch_modules</option> = <replaceable>nova.api.ec2.cloud:nova.notifications.notify_decorator, nova.compute.api:nova.notifications.notify_decorator</replaceable></td>
|
||||
<td>(ListOpt) List of modules/decorators to monkey patch</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
@ -18,15 +18,15 @@
|
||||
<th colspan="2">[hardware]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>readonly_user_name = ro_snmp_user</td>
|
||||
<td><option>readonly_user_name</option> = <replaceable>ro_snmp_user</replaceable></td>
|
||||
<td>(StrOpt) SNMPd user name of all nodes running in the cloud.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>readonly_user_password = password</td>
|
||||
<td><option>readonly_user_password</option> = <replaceable>password</replaceable></td>
|
||||
<td>(StrOpt) SNMPd password of all the nodes running in the cloud.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>url_scheme = snmp://</td>
|
||||
<td><option>url_scheme</option> = <replaceable>snmp://</replaceable></td>
|
||||
<td>(StrOpt) URL scheme to use for hardware nodes.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,31 +18,31 @@
|
||||
<th colspan="2">[vmware]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>api_retry_count = 10</td>
|
||||
<td><option>api_retry_count</option> = <replaceable>10</replaceable></td>
|
||||
<td>(IntOpt) Number of times a VMware Vsphere API may be retried.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>host_ip = </td>
|
||||
<td><option>host_ip</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) IP address of the VMware Vsphere host.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>host_password = </td>
|
||||
<td><option>host_password</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) Password of VMware Vsphere.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>host_port = 443</td>
|
||||
<td><option>host_port</option> = <replaceable>443</replaceable></td>
|
||||
<td>(IntOpt) Port of the VMware Vsphere host.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>host_username = </td>
|
||||
<td><option>host_username</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) Username of VMware Vsphere.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>task_poll_interval = 0.5</td>
|
||||
<td><option>task_poll_interval</option> = <replaceable>0.5</replaceable></td>
|
||||
<td>(FloatOpt) Sleep time in seconds for polling an ongoing async task.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>wsdl_location = None</td>
|
||||
<td><option>wsdl_location</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Optional vim service WSDL location e.g http://<server>/vimService.wsdl. Optional over-ride to default location for bug work-arounds.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,19 +18,19 @@
|
||||
<th colspan="2">[xenapi]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>connection_password = None</td>
|
||||
<td><option>connection_password</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Password for connection to XenServer/Xen Cloud Platform.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>connection_url = None</td>
|
||||
<td><option>connection_url</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) URL for connection to XenServer/Xen Cloud Platform.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>connection_username = root</td>
|
||||
<td><option>connection_username</option> = <replaceable>root</replaceable></td>
|
||||
<td>(StrOpt) Username for connection to XenServer/Xen Cloud Platform.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>login_timeout = 10</td>
|
||||
<td><option>login_timeout</option> = <replaceable>10</replaceable></td>
|
||||
<td>(IntOpt) Timeout in seconds for XenAPI login.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,31 +18,31 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>rpc_zmq_bind_address = *</td>
|
||||
<td><option>rpc_zmq_bind_address</option> = <replaceable>*</replaceable></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><option>rpc_zmq_contexts</option> = <replaceable>1</replaceable></td>
|
||||
<td>(IntOpt) Number of ZeroMQ contexts, defaults to 1.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>rpc_zmq_host = localhost</td>
|
||||
<td><option>rpc_zmq_host</option> = <replaceable>localhost</replaceable></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><option>rpc_zmq_ipc_dir</option> = <replaceable>/var/run/openstack</replaceable></td>
|
||||
<td>(StrOpt) Directory for holding IPC sockets.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>rpc_zmq_matchmaker = oslo.messaging._drivers.matchmaker.MatchMakerLocalhost</td>
|
||||
<td><option>rpc_zmq_matchmaker</option> = <replaceable>oslo.messaging._drivers.matchmaker.MatchMakerLocalhost</replaceable></td>
|
||||
<td>(StrOpt) MatchMaker driver.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>rpc_zmq_port = 9501</td>
|
||||
<td><option>rpc_zmq_port</option> = <replaceable>9501</replaceable></td>
|
||||
<td>(IntOpt) ZeroMQ receiver listening port.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>rpc_zmq_topic_backlog = None</td>
|
||||
<td><option>rpc_zmq_topic_backlog</option> = <replaceable>None</replaceable></td>
|
||||
<td>(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,27 +18,27 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>amqp_auto_delete = False</td>
|
||||
<td>(BoolOpt) Auto-delete queues in amqp.</td>
|
||||
<td><option>amqp_auto_delete</option> = <replaceable>False</replaceable></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>
|
||||
<td><option>amqp_durable_queues</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Use durable queues in AMQP.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>control_exchange = openstack</td>
|
||||
<td><option>control_exchange</option> = <replaceable>openstack</replaceable></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>notification_driver = []</td>
|
||||
<td><option>notification_driver</option> = <replaceable>[]</replaceable></td>
|
||||
<td>(MultiStrOpt) Driver or drivers to handle sending notifications.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>notification_topics = notifications</td>
|
||||
<td><option>notification_topics</option> = <replaceable>notifications</replaceable></td>
|
||||
<td>(ListOpt) AMQP topic used for OpenStack notifications.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>transport_url = None</td>
|
||||
<td><option>transport_url</option> = <replaceable>None</replaceable></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>
|
||||
|
||||
@ -18,91 +18,91 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>api_paste_config = api-paste.ini</td>
|
||||
<td><option>api_paste_config</option> = <replaceable>api-paste.ini</replaceable></td>
|
||||
<td>(StrOpt) File name for the paste.deploy config for cinder-api</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>api_rate_limit = True</td>
|
||||
<td><option>api_rate_limit</option> = <replaceable>True</replaceable></td>
|
||||
<td>(BoolOpt) Enables or disables rate limit of the API.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>az_cache_duration = 3600</td>
|
||||
<td><option>az_cache_duration</option> = <replaceable>3600</replaceable></td>
|
||||
<td>(IntOpt) Cache volume availability zones in memory for the provided duration in seconds</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>default_timeout = 525600</td>
|
||||
<td><option>default_timeout</option> = <replaceable>525600</replaceable></td>
|
||||
<td>(IntOpt) Default timeout for CLI operations in minutes. For example, LUN migration is a typical long running operation, which depends on the LUN size and the load of the array. An upper bound in the specific deployment can be set to avoid unnecessary long wait. By default, it is 365 days long.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>enable_v1_api = True</td>
|
||||
<td><option>enable_v1_api</option> = <replaceable>True</replaceable></td>
|
||||
<td>(BoolOpt) DEPRECATED: Deploy v1 of the Cinder API.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>enable_v2_api = True</td>
|
||||
<td><option>enable_v2_api</option> = <replaceable>True</replaceable></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>
|
||||
<td><option>extra_capabilities</option> = <replaceable>{}</replaceable></td>
|
||||
<td>(StrOpt) User defined capabilities, a JSON formatted string specifying key/value pairs. The key/value pairs can be used by the CapabilitiesFilter to select between backends when requests specify volume types. For example, specifying a service level or the geographical location of a backend, then creating a volume type to allow the user to select by these different properties.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>max_header_line = 16384</td>
|
||||
<td><option>max_header_line</option> = <replaceable>16384</replaceable></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><option>osapi_max_limit</option> = <replaceable>1000</replaceable></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><option>osapi_max_request_body_size</option> = <replaceable>114688</replaceable></td>
|
||||
<td>(IntOpt) Max size for body of a request</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>osapi_volume_base_URL = None</td>
|
||||
<td><option>osapi_volume_base_URL</option> = <replaceable>None</replaceable></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><option>osapi_volume_ext_list</option> = <replaceable></replaceable></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><option>osapi_volume_extension</option> = <replaceable>['cinder.api.contrib.standard_extensions']</replaceable></td>
|
||||
<td>(MultiStrOpt) osapi volume extension to load</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>osapi_volume_listen = 0.0.0.0</td>
|
||||
<td><option>osapi_volume_listen</option> = <replaceable>0.0.0.0</replaceable></td>
|
||||
<td>(StrOpt) IP address on which OpenStack Volume API listens</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>osapi_volume_listen_port = 8776</td>
|
||||
<td><option>osapi_volume_listen_port</option> = <replaceable>8776</replaceable></td>
|
||||
<td>(IntOpt) Port on which OpenStack Volume API listens</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>osapi_volume_workers = None</td>
|
||||
<td><option>osapi_volume_workers</option> = <replaceable>None</replaceable></td>
|
||||
<td>(IntOpt) Number of workers for OpenStack Volume API service. The default is equal to the number of CPUs available.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>transfer_api_class = cinder.transfer.api.API</td>
|
||||
<td><option>transfer_api_class</option> = <replaceable>cinder.transfer.api.API</replaceable></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><option>volume_api_class</option> = <replaceable>cinder.volume.api.API</replaceable></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><option>volume_name_template</option> = <replaceable>volume-%s</replaceable></td>
|
||||
<td>(StrOpt) Template string to be used to generate volume names</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>volume_number_multiplier = -1.0</td>
|
||||
<td><option>volume_number_multiplier</option> = <replaceable>-1.0</replaceable></td>
|
||||
<td>(FloatOpt) Multiplier used for weighing volume number. Negative numbers mean to spread vs stack.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>volume_transfer_key_length = 16</td>
|
||||
<td><option>volume_transfer_key_length</option> = <replaceable>16</replaceable></td>
|
||||
<td>(IntOpt) The number of characters in the autogenerated auth key.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>volume_transfer_salt_length = 8</td>
|
||||
<td><option>volume_transfer_salt_length</option> = <replaceable>8</replaceable></td>
|
||||
<td>(IntOpt) The number of characters in the salt.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,7 +18,7 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>auth_strategy = noauth</td>
|
||||
<td><option>auth_strategy</option> = <replaceable>noauth</replaceable></td>
|
||||
<td>(StrOpt) The strategy to use for auth. Supports noauth, keystone, and deprecated.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,115 +18,115 @@
|
||||
<th colspan="2">[keystone_authtoken]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>admin_password = None</td>
|
||||
<td><option>admin_password</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Keystone account password</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>admin_tenant_name = admin</td>
|
||||
<td><option>admin_tenant_name</option> = <replaceable>admin</replaceable></td>
|
||||
<td>(StrOpt) Keystone service account tenant name to validate user tokens</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>admin_token = None</td>
|
||||
<td><option>admin_token</option> = <replaceable>None</replaceable></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><option>admin_user</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Keystone account username</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>auth_admin_prefix = </td>
|
||||
<td><option>auth_admin_prefix</option> = <replaceable></replaceable></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><option>auth_host</option> = <replaceable>127.0.0.1</replaceable></td>
|
||||
<td>(StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>auth_port = 35357</td>
|
||||
<td><option>auth_port</option> = <replaceable>35357</replaceable></td>
|
||||
<td>(IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>auth_protocol = https</td>
|
||||
<td><option>auth_protocol</option> = <replaceable>https</replaceable></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><option>auth_uri</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Complete public Identity API endpoint</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>auth_version = None</td>
|
||||
<td><option>auth_version</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) API version of the admin Identity API endpoint</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>cache = None</td>
|
||||
<td><option>cache</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Env key for the swift cache</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>cafile = None</td>
|
||||
<td><option>cafile</option> = <replaceable>None</replaceable></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><option>certfile</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Required if Keystone server requires client certificate</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>check_revocations_for_cached = False</td>
|
||||
<td><option>check_revocations_for_cached</option> = <replaceable>False</replaceable></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><option>delay_auth_decision</option> = <replaceable>False</replaceable></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><option>enforce_token_bind</option> = <replaceable>permissive</replaceable></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><option>hash_algorithms</option> = <replaceable>md5</replaceable></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><option>http_connect_timeout</option> = <replaceable>None</replaceable></td>
|
||||
<td>(BoolOpt) Request timeout value for communicating with Identity API server.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>http_request_max_retries = 3</td>
|
||||
<td><option>http_request_max_retries</option> = <replaceable>3</replaceable></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><option>identity_uri</option> = <replaceable>None</replaceable></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><option>include_service_catalog</option> = <replaceable>True</replaceable></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><option>insecure</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Verify HTTPS connections.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>keyfile = None</td>
|
||||
<td><option>keyfile</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Required if Keystone server requires client certificate</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>memcache_secret_key = None</td>
|
||||
<td><option>memcache_secret_key</option> = <replaceable>None</replaceable></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><option>memcache_security_strategy</option> = <replaceable>None</replaceable></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>revocation_cache_time = 10</td>
|
||||
<td><option>revocation_cache_time</option> = <replaceable>10</replaceable></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><option>signing_dir</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Directory used to cache files related to PKI tokens</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>token_cache_time = 300</td>
|
||||
<td><option>token_cache_time</option> = <replaceable>300</replaceable></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>
|
||||
|
||||
@ -18,39 +18,47 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>backup_api_class = cinder.backup.api.API</td>
|
||||
<td><option>backup_api_class</option> = <replaceable>cinder.backup.api.API</replaceable></td>
|
||||
<td>(StrOpt) The full class name of the volume backup API class</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>backup_compression_algorithm = zlib</td>
|
||||
<td><option>backup_compression_algorithm</option> = <replaceable>zlib</replaceable></td>
|
||||
<td>(StrOpt) Compression algorithm (None to disable)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>backup_driver = cinder.backup.drivers.swift</td>
|
||||
<td><option>backup_driver</option> = <replaceable>cinder.backup.drivers.swift</replaceable></td>
|
||||
<td>(StrOpt) Driver to use for backups.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>backup_manager = cinder.backup.manager.BackupManager</td>
|
||||
<td><option>backup_manager</option> = <replaceable>cinder.backup.manager.BackupManager</replaceable></td>
|
||||
<td>(StrOpt) Full class name for the Manager for volume backup</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>backup_metadata_version = 1</td>
|
||||
<td><option>backup_metadata_version</option> = <replaceable>2</replaceable></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><option>backup_name_template</option> = <replaceable>backup-%s</replaceable></td>
|
||||
<td>(StrOpt) Template string to be used to generate backup names</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>backup_topic = cinder-backup</td>
|
||||
<td><option>backup_object_number_per_notification</option> = <replaceable>10</replaceable></td>
|
||||
<td>(IntOpt) The number of chunks or objects, for which one Ceilometer notification will be sent</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>backup_timer_interval</option> = <replaceable>120</replaceable></td>
|
||||
<td>(IntOpt) Interval, in seconds, between two progress notifications reporting the backup status</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>backup_topic</option> = <replaceable>cinder-backup</replaceable></td>
|
||||
<td>(StrOpt) The topic that volume backup nodes listen on</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>snapshot_name_template = snapshot-%s</td>
|
||||
<td><option>snapshot_name_template</option> = <replaceable>snapshot-%s</replaceable></td>
|
||||
<td>(StrOpt) Template string to be used to generate snapshot names</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>snapshot_same_host = True</td>
|
||||
<td><option>snapshot_same_host</option> = <replaceable>True</replaceable></td>
|
||||
<td>(BoolOpt) Create volume from snapshot at the host where snapshot resides</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,31 +18,31 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>backup_ceph_chunk_size = 134217728</td>
|
||||
<td><option>backup_ceph_chunk_size</option> = <replaceable>134217728</replaceable></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><option>backup_ceph_conf</option> = <replaceable>/etc/ceph/ceph.conf</replaceable></td>
|
||||
<td>(StrOpt) Ceph configuration file to use.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>backup_ceph_pool = backups</td>
|
||||
<td><option>backup_ceph_pool</option> = <replaceable>backups</replaceable></td>
|
||||
<td>(StrOpt) The Ceph pool where volume backups are stored.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>backup_ceph_stripe_count = 0</td>
|
||||
<td><option>backup_ceph_stripe_count</option> = <replaceable>0</replaceable></td>
|
||||
<td>(IntOpt) RBD stripe count to use when creating a backup image.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>backup_ceph_stripe_unit = 0</td>
|
||||
<td><option>backup_ceph_stripe_unit</option> = <replaceable>0</replaceable></td>
|
||||
<td>(IntOpt) RBD stripe unit to use when creating a backup image.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>backup_ceph_user = cinder</td>
|
||||
<td><option>backup_ceph_user</option> = <replaceable>cinder</replaceable></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><option>restore_discard_excess_bytes</option> = <replaceable>True</replaceable></td>
|
||||
<td>(BoolOpt) If True, always discard excess bytes when restoring volumes i.e. pad with zeroes.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,39 +18,43 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>backup_swift_auth = per_user</td>
|
||||
<td><option>backup_swift_auth</option> = <replaceable>per_user</replaceable></td>
|
||||
<td>(StrOpt) Swift authentication mechanism</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>backup_swift_container = volumebackups</td>
|
||||
<td><option>backup_swift_container</option> = <replaceable>volumebackups</replaceable></td>
|
||||
<td>(StrOpt) The default Swift container to use</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>backup_swift_key = None</td>
|
||||
<td><option>backup_swift_enable_progress_timer</option> = <replaceable>True</replaceable></td>
|
||||
<td>(BoolOpt) Enable or Disable the timer to send the periodic progress notifications to Ceilometer when backing up the volume to the Swift backend storage. The default value is True to enable the timer.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>backup_swift_key</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Swift key for authentication</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>backup_swift_object_size = 52428800</td>
|
||||
<td><option>backup_swift_object_size</option> = <replaceable>52428800</replaceable></td>
|
||||
<td>(IntOpt) The size in bytes of Swift backup objects</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>backup_swift_retry_attempts = 3</td>
|
||||
<td><option>backup_swift_retry_attempts</option> = <replaceable>3</replaceable></td>
|
||||
<td>(IntOpt) The number of retries to make for Swift operations</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>backup_swift_retry_backoff = 2</td>
|
||||
<td><option>backup_swift_retry_backoff</option> = <replaceable>2</replaceable></td>
|
||||
<td>(IntOpt) The backoff time in seconds between Swift retries</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>backup_swift_url = None</td>
|
||||
<td><option>backup_swift_url</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) The URL of the Swift endpoint</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>backup_swift_user = None</td>
|
||||
<td><option>backup_swift_user</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Swift user name</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>swift_catalog_info = object-store:swift:publicURL</td>
|
||||
<td><option>swift_catalog_info</option> = <replaceable>object-store:swift:publicURL</replaceable></td>
|
||||
<td>(StrOpt) Info to match when looking for swift in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:<endpoint_type> - Only used if backup_swift_url is unset</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,15 +18,15 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>backup_tsm_compression = True</td>
|
||||
<td><option>backup_tsm_compression</option> = <replaceable>True</replaceable></td>
|
||||
<td>(BoolOpt) Enable or Disable compression for backups</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>backup_tsm_password = password</td>
|
||||
<td><option>backup_tsm_password</option> = <replaceable>password</replaceable></td>
|
||||
<td>(StrOpt) TSM password for the running username</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>backup_tsm_volume_prefix = backup</td>
|
||||
<td><option>backup_tsm_volume_prefix</option> = <replaceable>backup</replaceable></td>
|
||||
<td>(StrOpt) Volume prefix for the backup id when backing up to TSM</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,7 +18,7 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>available_devices = </td>
|
||||
<td><option>available_devices</option> = <replaceable></replaceable></td>
|
||||
<td>(ListOpt) List of all available devices</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,30 +18,15 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>ssl_ca_file = None</td>
|
||||
<td><option>ssl_ca_file</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) CA certificate file to use to verify connecting clients</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>ssl_cert_file = None</td>
|
||||
<td><option>ssl_cert_file</option> = <replaceable>None</replaceable></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>
|
||||
<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><option>ssl_key_file</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Private key file to use when starting the server securely</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,150 +18,174 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>compute_api_class = cinder.compute.nova.API</td>
|
||||
<td><option>client_socket_timeout</option> = <replaceable>900</replaceable></td>
|
||||
<td>(IntOpt) Timeout for client connections' socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of '0' means wait forever.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>compute_api_class</option> = <replaceable>cinder.compute.nova.API</replaceable></td>
|
||||
<td>(StrOpt) The full class name of the compute API class to use</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>consistencygroup_api_class = cinder.consistencygroup.api.API</td>
|
||||
<td><option>consistencygroup_api_class</option> = <replaceable>cinder.consistencygroup.api.API</replaceable></td>
|
||||
<td>(StrOpt) The full class name of the consistencygroup API class</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>default_availability_zone = None</td>
|
||||
<td><option>default_availability_zone</option> = <replaceable>None</replaceable></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_volume_type = None</td>
|
||||
<td><option>default_volume_type</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Default volume type to use</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>enable_new_services = True</td>
|
||||
<td><option>enable_new_services</option> = <replaceable>True</replaceable></td>
|
||||
<td>(BoolOpt) Services to be added to the available pool on create</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>host = localhost</td>
|
||||
<td><option>host</option> = <replaceable>localhost</replaceable></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><option>iet_conf</option> = <replaceable>/etc/iet/ietd.conf</replaceable></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>
|
||||
<td><option>lio_initiator_iqns</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) This option is deprecated and unused. It will be removed in the next release.</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>memcached_servers = None</td>
|
||||
<td><option>memcached_servers</option> = <replaceable>None</replaceable></td>
|
||||
<td>(ListOpt) Memcached servers or None for in process cache.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>monkey_patch = False</td>
|
||||
<td><option>monkey_patch</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Enable monkey patching</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>monkey_patch_modules = </td>
|
||||
<td><option>monkey_patch_modules</option> = <replaceable></replaceable></td>
|
||||
<td>(ListOpt) List of modules/decorators to monkey patch</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>my_ip = 10.0.0.1</td>
|
||||
<td><option>my_ip</option> = <replaceable>10.0.0.1</replaceable></td>
|
||||
<td>(StrOpt) IP address of this host</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>no_snapshot_gb_quota = False</td>
|
||||
<td><option>no_snapshot_gb_quota</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Whether snapshots count against GigaByte quota</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>num_shell_tries = 3</td>
|
||||
<td><option>num_shell_tries</option> = <replaceable>3</replaceable></td>
|
||||
<td>(IntOpt) Number of times to attempt to run flakey shell commands</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>periodic_fuzzy_delay = 60</td>
|
||||
<td><option>os_privileged_user_name</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) OpenStack privileged account username. Used for requests to other services (such as Nova) that require an account with special rights.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>os_privileged_user_password</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Password associated with the OpenStack privileged account.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>os_privileged_user_tenant</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Tenant name associated with the OpenStack privileged account.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>periodic_fuzzy_delay</option> = <replaceable>60</replaceable></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><option>periodic_interval</option> = <replaceable>60</replaceable></td>
|
||||
<td>(IntOpt) Interval, in seconds, between running periodic tasks</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>policy_default_rule = default</td>
|
||||
<td><option>policy_default_rule</option> = <replaceable>default</replaceable></td>
|
||||
<td>(StrOpt) Default rule. Enforced when a requested rule is not found.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>policy_file = policy.json</td>
|
||||
<td><option>policy_dirs</option> = <replaceable>['policy.d']</replaceable></td>
|
||||
<td>(MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>policy_file</option> = <replaceable>policy.json</replaceable></td>
|
||||
<td>(StrOpt) The JSON file that defines policies.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>replication_api_class = cinder.replication.api.API</td>
|
||||
<td><option>replication_api_class</option> = <replaceable>cinder.replication.api.API</replaceable></td>
|
||||
<td>(StrOpt) The full class name of the volume replication API class</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>report_interval = 10</td>
|
||||
<td><option>report_interval</option> = <replaceable>10</replaceable></td>
|
||||
<td>(IntOpt) Interval, in seconds, between nodes reporting state to datastore</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>reserved_percentage = 0</td>
|
||||
<td><option>request_timeout</option> = <replaceable>300</replaceable></td>
|
||||
<td>(IntOpt) Global backend request timeout, in seconds</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>reserved_percentage</option> = <replaceable>0</replaceable></td>
|
||||
<td>(IntOpt) The percentage of backend capacity is reserved</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>rootwrap_config = /etc/cinder/rootwrap.conf</td>
|
||||
<td><option>rootwrap_config</option> = <replaceable>/etc/cinder/rootwrap.conf</replaceable></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><option>run_external_periodic_tasks</option> = <replaceable>True</replaceable></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><option>service_down_time</option> = <replaceable>60</replaceable></td>
|
||||
<td>(IntOpt) Maximum time since last check-in for a service to be considered up</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>ssh_hosts_key_file = $state_path/ssh_known_hosts</td>
|
||||
<td><option>ssh_hosts_key_file</option> = <replaceable>$state_path/ssh_known_hosts</replaceable></td>
|
||||
<td>(StrOpt) File containing SSH host keys for the systems with which Cinder needs to communicate. OPTIONAL: Default=$state_path/ssh_known_hosts</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>state_path = /var/lib/cinder</td>
|
||||
<td><option>state_path</option> = <replaceable>/var/lib/cinder</replaceable></td>
|
||||
<td>(StrOpt) Top-level directory for maintaining cinder's state</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>storage_availability_zone = nova</td>
|
||||
<td><option>storage_availability_zone</option> = <replaceable>nova</replaceable></td>
|
||||
<td>(StrOpt) Availability zone of this node</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>strict_ssh_host_key_policy = False</td>
|
||||
<td><option>strict_ssh_host_key_policy</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Option to enable strict host key checking. When set to "True" Cinder will only connect to systems with a host key present in the configured "ssh_hosts_key_file". When set to "False" the host key will be saved upon first connection and used for subsequent connections. Default=False</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>tcp_keepalive = True</td>
|
||||
<td><option>tcp_keepalive</option> = <replaceable>True</replaceable></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><option>tcp_keepalive_count</option> = <replaceable>None</replaceable></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><option>tcp_keepalive_interval</option> = <replaceable>None</replaceable></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><option>tcp_keepidle</option> = <replaceable>600</replaceable></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><option>until_refresh</option> = <replaceable>0</replaceable></td>
|
||||
<td>(IntOpt) Count of reservations until usage is refreshed</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>use_forwarded_for = False</td>
|
||||
<td><option>use_forwarded_for</option> = <replaceable>False</replaceable></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><option>wsgi_keep_alive</option> = <replaceable>True</replaceable></td>
|
||||
<td>(BoolOpt) If False, closes the client socket connection explicitly. Setting it to True to maintain backward compatibility. Recommended setting is set it to False.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th colspan="2">[keystone_authtoken]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>memcached_servers = None</td>
|
||||
<td><option>memcached_servers</option> = <replaceable>None</replaceable></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>
|
||||
</tbody>
|
||||
|
||||
@ -18,31 +18,31 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>nova_api_insecure = False</td>
|
||||
<td><option>nova_api_insecure</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Allow to perform insecure SSL requests to nova</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>nova_ca_certificates_file = None</td>
|
||||
<td><option>nova_ca_certificates_file</option> = <replaceable>None</replaceable></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><option>nova_catalog_admin_info</option> = <replaceable>compute:Compute Service:adminURL</replaceable></td>
|
||||
<td>(StrOpt) Same as nova_catalog_info, but for admin endpoint.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>nova_catalog_info = compute:nova:publicURL</td>
|
||||
<td><option>nova_catalog_info</option> = <replaceable>compute:Compute Service:publicURL</replaceable></td>
|
||||
<td>(StrOpt) Match this value when searching for nova in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:<endpoint_type></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>nova_endpoint_admin_template = None</td>
|
||||
<td><option>nova_endpoint_admin_template</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Same as nova_endpoint_template, but for admin endpoint.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>nova_endpoint_template = None</td>
|
||||
<td><option>nova_endpoint_template</option> = <replaceable>None</replaceable></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><option>os_region_name</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Region name of this node</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,23 +18,27 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>coraid_esm_address = </td>
|
||||
<td><option>coraid_default_repository</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) ESM Repository Name to use if not specified in Volume Type keys</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>coraid_esm_address</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) IP address of Coraid ESM</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>coraid_group = admin</td>
|
||||
<td><option>coraid_group</option> = <replaceable>admin</replaceable></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><option>coraid_password</option> = <replaceable>password</replaceable></td>
|
||||
<td>(StrOpt) Password to connect to Coraid ESM</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>coraid_repository_key = coraid_repository</td>
|
||||
<td><option>coraid_repository_key</option> = <replaceable>coraid_repository</replaceable></td>
|
||||
<td>(StrOpt) Volume Type key name to store ESM Repository Name</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>coraid_user = admin</td>
|
||||
<td><option>coraid_user</option> = <replaceable>admin</replaceable></td>
|
||||
<td>(StrOpt) User name to connect to Coraid ESM</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,98 +18,98 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>db_backend = sqlalchemy</td>
|
||||
<td><option>db_backend</option> = <replaceable>sqlalchemy</replaceable></td>
|
||||
<td>(StrOpt) The backend to use for db</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>db_driver = cinder.db</td>
|
||||
<td><option>db_driver</option> = <replaceable>cinder.db</replaceable></td>
|
||||
<td>(StrOpt) Driver to use for database access</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th colspan="2">[database]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>backend = sqlalchemy</td>
|
||||
<td><option>backend</option> = <replaceable>sqlalchemy</replaceable></td>
|
||||
<td>(StrOpt) The back end to use for the database.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>connection = None</td>
|
||||
<td><option>connection</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) The SQLAlchemy connection string to use to connect to the database.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>connection_debug = 0</td>
|
||||
<td><option>connection_debug</option> = <replaceable>0</replaceable></td>
|
||||
<td>(IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>connection_trace = False</td>
|
||||
<td><option>connection_trace</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Add Python stack traces to SQL as comment strings.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>db_inc_retry_interval = True</td>
|
||||
<td><option>db_inc_retry_interval</option> = <replaceable>True</replaceable></td>
|
||||
<td>(BoolOpt) If True, increases the interval between database connection retries up to db_max_retry_interval.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>db_max_retries = 20</td>
|
||||
<td><option>db_max_retries</option> = <replaceable>20</replaceable></td>
|
||||
<td>(IntOpt) Maximum database connection retries before error is raised. Set to -1 to specify an infinite retry count.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>db_max_retry_interval = 10</td>
|
||||
<td><option>db_max_retry_interval</option> = <replaceable>10</replaceable></td>
|
||||
<td>(IntOpt) If db_inc_retry_interval is set, the maximum seconds between database connection retries.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>db_retry_interval = 1</td>
|
||||
<td><option>db_retry_interval</option> = <replaceable>1</replaceable></td>
|
||||
<td>(IntOpt) Seconds between database connection retries.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>idle_timeout = 3600</td>
|
||||
<td><option>idle_timeout</option> = <replaceable>3600</replaceable></td>
|
||||
<td>(IntOpt) Timeout before idle SQL connections are reaped.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>max_overflow = None</td>
|
||||
<td><option>max_overflow</option> = <replaceable>None</replaceable></td>
|
||||
<td>(IntOpt) If set, use this value for max_overflow with SQLAlchemy.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>max_pool_size = None</td>
|
||||
<td><option>max_pool_size</option> = <replaceable>None</replaceable></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. Set to -1 to specify an infinite retry count.</td>
|
||||
<td><option>max_retries</option> = <replaceable>10</replaceable></td>
|
||||
<td>(IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>min_pool_size = 1</td>
|
||||
<td><option>min_pool_size</option> = <replaceable>1</replaceable></td>
|
||||
<td>(IntOpt) Minimum number of SQL connections to keep open in a pool.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>mysql_sql_mode = TRADITIONAL</td>
|
||||
<td><option>mysql_sql_mode</option> = <replaceable>TRADITIONAL</replaceable></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><option>pool_timeout</option> = <replaceable>None</replaceable></td>
|
||||
<td>(IntOpt) If set, use this value for pool_timeout with SQLAlchemy.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>retry_interval = 10</td>
|
||||
<td><option>retry_interval</option> = <replaceable>10</replaceable></td>
|
||||
<td>(IntOpt) Interval between retries of opening a SQL connection.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>slave_connection = None</td>
|
||||
<td><option>slave_connection</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) The SQLAlchemy connection string to use to connect to the slave database.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>sqlite_db = oslo.sqlite</td>
|
||||
<td><option>sqlite_db</option> = <replaceable>oslo.sqlite</replaceable></td>
|
||||
<td>(StrOpt) The file name to use with SQLite.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>sqlite_synchronous = True</td>
|
||||
<td><option>sqlite_synchronous</option> = <replaceable>True</replaceable></td>
|
||||
<td>(BoolOpt) If True, SQLite uses synchronous mode.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>use_db_reconnect = False</td>
|
||||
<td><option>use_db_reconnect</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Enable the experimental use of database reconnect on connection lost.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>use_tpool = False</td>
|
||||
<td><option>use_tpool</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Enable the experimental use of thread pooling for all DB API calls</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,27 +18,27 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>datera_api_port = 7717</td>
|
||||
<td><option>datera_api_port</option> = <replaceable>7717</replaceable></td>
|
||||
<td>(StrOpt) Datera API port.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>datera_api_token = None</td>
|
||||
<td><option>datera_api_token</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Datera API token.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>datera_api_version = 1</td>
|
||||
<td><option>datera_api_version</option> = <replaceable>1</replaceable></td>
|
||||
<td>(StrOpt) Datera API version.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>datera_num_replicas = 3</td>
|
||||
<td><option>datera_num_replicas</option> = <replaceable>3</replaceable></td>
|
||||
<td>(StrOpt) Number of replicas to create of an inode.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>driver_client_cert = None</td>
|
||||
<td><option>driver_client_cert</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) The path to the client certificate for verification, if the driver supports it.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>driver_client_cert_key = None</td>
|
||||
<td><option>driver_client_cert_key</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) The path to the client certificate key for verification, if the driver supports it.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,13 +18,9 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>backdoor_port = None</td>
|
||||
<td><option>backdoor_port</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> 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>
|
||||
</tbody>
|
||||
</table>
|
||||
</para>
|
||||
|
||||
@ -18,19 +18,19 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>dell_sc_api_port = 3033</td>
|
||||
<td><option>dell_sc_api_port</option> = <replaceable>3033</replaceable></td>
|
||||
<td>(IntOpt) Dell API port</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>dell_sc_server_folder = openstack</td>
|
||||
<td><option>dell_sc_server_folder</option> = <replaceable>openstack</replaceable></td>
|
||||
<td>(StrOpt) Name of the server folder to use on the Storage Center</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>dell_sc_ssn = 64702</td>
|
||||
<td><option>dell_sc_ssn</option> = <replaceable>64702</replaceable></td>
|
||||
<td>(IntOpt) Storage Center System Serial Number</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>dell_sc_volume_folder = openstack</td>
|
||||
<td><option>dell_sc_volume_folder</option> = <replaceable>openstack</replaceable></td>
|
||||
<td>(StrOpt) Name of the volume folder to use on the Storage Center</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,39 +18,39 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>cinder_emc_config_file = /etc/cinder/cinder_emc_config.xml</td>
|
||||
<td><option>cinder_emc_config_file</option> = <replaceable>/etc/cinder/cinder_emc_config.xml</replaceable></td>
|
||||
<td>(StrOpt) use this file for cinder emc plugin config data</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>destroy_empty_storage_group = False</td>
|
||||
<td><option>destroy_empty_storage_group</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) To destroy storage group when the last LUN is removed from it. By default, the value is False.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>initiator_auto_registration = False</td>
|
||||
<td><option>initiator_auto_registration</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Automatically register initiators. By default, the value is False.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>iscsi_initiators = </td>
|
||||
<td><option>iscsi_initiators</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) Mapping between hostname and its iSCSI initiator IP addresses.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>max_luns_per_storage_group = 255</td>
|
||||
<td><option>max_luns_per_storage_group</option> = <replaceable>255</replaceable></td>
|
||||
<td>(IntOpt) Default max number of LUNs in a storage group. By default, the value is 255.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>naviseccli_path = </td>
|
||||
<td><option>naviseccli_path</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) Naviseccli Path.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>storage_vnx_authentication_type = global</td>
|
||||
<td><option>storage_vnx_authentication_type</option> = <replaceable>global</replaceable></td>
|
||||
<td>(StrOpt) VNX authentication scope type.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>storage_vnx_pool_name = None</td>
|
||||
<td><option>storage_vnx_pool_name</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Storage pool name.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>storage_vnx_security_file_dir = None</td>
|
||||
<td><option>storage_vnx_security_file_dir</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Directory path that contains the VNX security file. Make sure the security file is generated first.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,31 +18,31 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>eqlx_chap_login = admin</td>
|
||||
<td><option>eqlx_chap_login</option> = <replaceable>admin</replaceable></td>
|
||||
<td>(StrOpt) Existing CHAP account name</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>eqlx_chap_password = password</td>
|
||||
<td><option>eqlx_chap_password</option> = <replaceable>password</replaceable></td>
|
||||
<td>(StrOpt) Password for specified CHAP account name</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>eqlx_cli_max_retries = 5</td>
|
||||
<td><option>eqlx_cli_max_retries</option> = <replaceable>5</replaceable></td>
|
||||
<td>(IntOpt) Maximum retry count for reconnection</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>eqlx_cli_timeout = 30</td>
|
||||
<td><option>eqlx_cli_timeout</option> = <replaceable>30</replaceable></td>
|
||||
<td>(IntOpt) Timeout for the Group Manager cli command execution</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>eqlx_group_name = group-0</td>
|
||||
<td><option>eqlx_group_name</option> = <replaceable>group-0</replaceable></td>
|
||||
<td>(StrOpt) Group name to use for creating volumes</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>eqlx_pool = default</td>
|
||||
<td><option>eqlx_pool</option> = <replaceable>default</replaceable></td>
|
||||
<td>(StrOpt) Pool in which volumes will be created</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>eqlx_use_chap = False</td>
|
||||
<td><option>eqlx_use_chap</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Use CHAP authentication for targets?</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
34
doc/common/tables/cinder-flashsystem.xml
Normal file
34
doc/common/tables/cinder-flashsystem.xml
Normal file
@ -0,0 +1,34 @@
|
||||
<?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_flashsystem">
|
||||
<caption>Description of IBM FlashSystem volume river configuration options</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><option>flashsystem_connection_protocol</option> = <replaceable>FC</replaceable></td>
|
||||
<td>(StrOpt) Connection protocol should be FC.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>flashsystem_multihostmap_enabled</option> = <replaceable>True</replaceable></td>
|
||||
<td>(BoolOpt) Allows vdisk to multi host mapping.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>flashsystem_multipath_enabled</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Connect with multipath (FC only).</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</para>
|
||||
@ -18,7 +18,7 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>cinder_smis_config_file = /etc/cinder/cinder_fujitsu_eternus_dx.xml</td>
|
||||
<td><option>cinder_smis_config_file</option> = <replaceable>/etc/cinder/cinder_fujitsu_eternus_dx.xml</replaceable></td>
|
||||
<td>(StrOpt) The configuration file for the Cinder SMI-S driver</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,15 +18,15 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>fusionio_iocontrol_retry = 3</td>
|
||||
<td><option>fusionio_iocontrol_retry</option> = <replaceable>3</replaceable></td>
|
||||
<td>(IntOpt) number of retries for GET operations</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>fusionio_iocontrol_targetdelay = 5</td>
|
||||
<td><option>fusionio_iocontrol_targetdelay</option> = <replaceable>5</replaceable></td>
|
||||
<td>(IntOpt) amount of time wait for iSCSI target to come online</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>fusionio_iocontrol_verify_cert = True</td>
|
||||
<td><option>fusionio_iocontrol_verify_cert</option> = <replaceable>True</replaceable></td>
|
||||
<td>(BoolOpt) verify the array certificate on each transaction</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,11 +18,11 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hds_hnas_iscsi_config_file = /opt/hds/hnas/cinder_iscsi_conf.xml</td>
|
||||
<td><option>hds_hnas_iscsi_config_file</option> = <replaceable>/opt/hds/hnas/cinder_iscsi_conf.xml</replaceable></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><option>hds_hnas_nfs_config_file</option> = <replaceable>/opt/hds/hnas/cinder_nfs_conf.xml</replaceable></td>
|
||||
<td>(StrOpt) Configuration file for HDS NFS cinder plugin</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,7 +18,7 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hds_cinder_config_file = /opt/hds/hus/cinder_hus_conf.xml</td>
|
||||
<td><option>hds_cinder_config_file</option> = <replaceable>/opt/hds/hus/cinder_hus_conf.xml</replaceable></td>
|
||||
<td>(StrOpt) The configuration file for the Cinder HDS driver for HUS</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,87 +18,87 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hitachi_add_chap_user = False</td>
|
||||
<td><option>hitachi_add_chap_user</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Add CHAP user</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hitachi_async_copy_check_interval = 10</td>
|
||||
<td><option>hitachi_async_copy_check_interval</option> = <replaceable>10</replaceable></td>
|
||||
<td>(IntOpt) Interval to check copy asynchronously</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hitachi_auth_method = None</td>
|
||||
<td><option>hitachi_auth_method</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) iSCSI authentication method</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hitachi_auth_password = HBSD-CHAP-password</td>
|
||||
<td><option>hitachi_auth_password</option> = <replaceable>HBSD-CHAP-password</replaceable></td>
|
||||
<td>(StrOpt) iSCSI authentication password</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hitachi_auth_user = HBSD-CHAP-user</td>
|
||||
<td><option>hitachi_auth_user</option> = <replaceable>HBSD-CHAP-user</replaceable></td>
|
||||
<td>(StrOpt) iSCSI authentication username</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hitachi_copy_check_interval = 3</td>
|
||||
<td><option>hitachi_copy_check_interval</option> = <replaceable>3</replaceable></td>
|
||||
<td>(IntOpt) Interval to check copy</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hitachi_copy_speed = 3</td>
|
||||
<td><option>hitachi_copy_speed</option> = <replaceable>3</replaceable></td>
|
||||
<td>(IntOpt) Copy speed of storage system</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hitachi_default_copy_method = FULL</td>
|
||||
<td><option>hitachi_default_copy_method</option> = <replaceable>FULL</replaceable></td>
|
||||
<td>(StrOpt) Default copy method of storage system</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hitachi_group_range = None</td>
|
||||
<td><option>hitachi_group_range</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Range of group number</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hitachi_group_request = False</td>
|
||||
<td><option>hitachi_group_request</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Request for creating HostGroup or iSCSI Target</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hitachi_horcm_add_conf = True</td>
|
||||
<td><option>hitachi_horcm_add_conf</option> = <replaceable>True</replaceable></td>
|
||||
<td>(BoolOpt) Add to HORCM configuration</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hitachi_horcm_numbers = 200,201</td>
|
||||
<td><option>hitachi_horcm_numbers</option> = <replaceable>200,201</replaceable></td>
|
||||
<td>(StrOpt) Instance numbers for HORCM</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hitachi_horcm_password = None</td>
|
||||
<td><option>hitachi_horcm_password</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Password of storage system for HORCM</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hitachi_horcm_user = None</td>
|
||||
<td><option>hitachi_horcm_user</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Username of storage system for HORCM</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hitachi_ldev_range = None</td>
|
||||
<td><option>hitachi_ldev_range</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Range of logical device of storage system</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hitachi_pool_id = None</td>
|
||||
<td><option>hitachi_pool_id</option> = <replaceable>None</replaceable></td>
|
||||
<td>(IntOpt) Pool ID of storage system</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hitachi_serial_number = None</td>
|
||||
<td><option>hitachi_serial_number</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Serial number of storage system</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hitachi_target_ports = None</td>
|
||||
<td><option>hitachi_target_ports</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Control port names for HostGroup or iSCSI Target</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hitachi_thin_pool_id = None</td>
|
||||
<td><option>hitachi_thin_pool_id</option> = <replaceable>None</replaceable></td>
|
||||
<td>(IntOpt) Thin pool ID of storage system</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hitachi_unit_name = None</td>
|
||||
<td><option>hitachi_unit_name</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Name of an array unit</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hitachi_zoning_request = False</td>
|
||||
<td><option>hitachi_zoning_request</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Request for FC Zone creating HostGroup</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,43 +18,43 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hp3par_api_url = </td>
|
||||
<td><option>hp3par_api_url</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) 3PAR WSAPI Server Url like https://<3par ip>:8080/api/v1</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hp3par_cpg = OpenStack</td>
|
||||
<td>(StrOpt) The CPG to use for volume creation</td>
|
||||
<td><option>hp3par_cpg</option> = <replaceable>OpenStack</replaceable></td>
|
||||
<td>(ListOpt) List of the CPG(s) 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>
|
||||
<td><option>hp3par_cpg_snap</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) The CPG to use for Snapshots for volumes. If empty the userCPG will be used.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hp3par_debug = False</td>
|
||||
<td><option>hp3par_debug</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Enable HTTP debugging to 3PAR</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hp3par_iscsi_chap_enabled = False</td>
|
||||
<td><option>hp3par_iscsi_chap_enabled</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Enable CHAP authentication for iSCSI connections.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hp3par_iscsi_ips = </td>
|
||||
<td><option>hp3par_iscsi_ips</option> = <replaceable></replaceable></td>
|
||||
<td>(ListOpt) List of target iSCSI addresses to use.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hp3par_password = </td>
|
||||
<td><option>hp3par_password</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) 3PAR Super user password</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hp3par_snapshot_expiration = </td>
|
||||
<td><option>hp3par_snapshot_expiration</option> = <replaceable></replaceable></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><option>hp3par_snapshot_retention</option> = <replaceable></replaceable></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><option>hp3par_username</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) 3PAR Super user username</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,27 +18,27 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hplefthand_api_url = None</td>
|
||||
<td><option>hplefthand_api_url</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) HP LeftHand WSAPI Server Url like https://<LeftHand ip>:8081/lhos</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hplefthand_clustername = None</td>
|
||||
<td><option>hplefthand_clustername</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) HP LeftHand cluster name</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hplefthand_debug = False</td>
|
||||
<td><option>hplefthand_debug</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Enable HTTP debugging to LeftHand</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hplefthand_iscsi_chap_enabled = False</td>
|
||||
<td><option>hplefthand_iscsi_chap_enabled</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Configure CHAP authentication for iSCSI connections (Default: Disabled)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hplefthand_password = None</td>
|
||||
<td><option>hplefthand_password</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) HP LeftHand Super user password</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hplefthand_username = None</td>
|
||||
<td><option>hplefthand_username</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) HP LeftHand Super user username</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,7 +18,7 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>msa_vdisk = OpenStack</td>
|
||||
<td><option>msa_vdisk</option> = <replaceable>OpenStack</replaceable></td>
|
||||
<td>(StrOpt) The VDisk to use for volume creation.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,9 +18,13 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>cinder_huawei_conf_file = /etc/cinder/cinder_huawei_conf.xml</td>
|
||||
<td><option>cinder_huawei_conf_file</option> = <replaceable>/etc/cinder/cinder_huawei_conf.xml</replaceable></td>
|
||||
<td>(StrOpt) The configuration file for the Cinder Huawei driver</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>cinder_huawei_sds_conf_file</option> = <replaceable>/etc/cinder/cinder_huawei_storac_conf.xml</replaceable></td>
|
||||
<td>(StrOpt) huawei storagehyper driver config file path</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</para>
|
||||
|
||||
@ -18,7 +18,7 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>ibmnas_platform_type = v7ku</td>
|
||||
<td><option>ibmnas_platform_type</option> = <replaceable>v7ku</replaceable></td>
|
||||
<td>(StrOpt) IBMNAS platform type to be used as backend storage; valid values are - v7ku : for using IBM Storwize V7000 Unified, sonas : for using IBM Scale Out NAS, gpfs-nas : for using NFS based IBM GPFS deployments.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,55 +18,55 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>allowed_direct_url_schemes = </td>
|
||||
<td><option>allowed_direct_url_schemes</option> = <replaceable></replaceable></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><option>glance_api_insecure</option> = <replaceable>False</replaceable></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><option>glance_api_servers</option> = <replaceable>$glance_host:$glance_port</replaceable></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><option>glance_api_ssl_compression</option> = <replaceable>False</replaceable></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><option>glance_api_version</option> = <replaceable>1</replaceable></td>
|
||||
<td>(IntOpt) Version of the glance API to use</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>glance_ca_certificates_file = None</td>
|
||||
<td><option>glance_ca_certificates_file</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Location of ca certificates file to use for glance client requests.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>glance_core_properties = checksum, container_format, disk_format, image_name, image_id, min_disk, min_ram, name, size</td>
|
||||
<td><option>glance_core_properties</option> = <replaceable>checksum, container_format, disk_format, image_name, image_id, min_disk, min_ram, name, size</replaceable></td>
|
||||
<td>(ListOpt) Default core properties of image</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>glance_host = $my_ip</td>
|
||||
<td><option>glance_host</option> = <replaceable>$my_ip</replaceable></td>
|
||||
<td>(StrOpt) Default glance host name or IP</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>glance_num_retries = 0</td>
|
||||
<td><option>glance_num_retries</option> = <replaceable>0</replaceable></td>
|
||||
<td>(IntOpt) Number retries when downloading an image from glance</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>glance_port = 9292</td>
|
||||
<td><option>glance_port</option> = <replaceable>9292</replaceable></td>
|
||||
<td>(IntOpt) Default glance port</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>glance_request_timeout = None</td>
|
||||
<td><option>glance_request_timeout</option> = <replaceable>None</replaceable></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><option>image_conversion_dir</option> = <replaceable>$state_path/conversion</replaceable></td>
|
||||
<td>(StrOpt) Directory used for temporary storage during image conversion</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>use_multipath_for_image_xfer = False</td>
|
||||
<td><option>use_multipath_for_image_xfer</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Do we attach/detach volumes in cinder using multipath for volume to image and image to volume transfers?</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,19 +18,19 @@
|
||||
<th colspan="2">[keymgr]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>api_class = cinder.keymgr.conf_key_mgr.ConfKeyManager</td>
|
||||
<td><option>api_class</option> = <replaceable>cinder.keymgr.conf_key_mgr.ConfKeyManager</replaceable></td>
|
||||
<td>(StrOpt) The full class name of the key manager API class</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>encryption_api_url = http://localhost:9311/v1</td>
|
||||
<td><option>encryption_api_url</option> = <replaceable>http://localhost:9311/v1</replaceable></td>
|
||||
<td>(StrOpt) Url for encryption service.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>encryption_auth_url = http://localhost:5000/v2.0</td>
|
||||
<td><option>encryption_auth_url</option> = <replaceable>http://localhost:5000/v3</replaceable></td>
|
||||
<td>(StrOpt) Authentication url for encryption service.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>fixed_key = None</td>
|
||||
<td><option>fixed_key</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Fixed key returned by key manager, specified in hex</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,87 +18,87 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>debug = False</td>
|
||||
<td><option>debug</option> = <replaceable>False</replaceable></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, urllib3.connectionpool=WARN, websocket=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN</td>
|
||||
<td><option>default_log_levels</option> = <replaceable>amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN</replaceable></td>
|
||||
<td>(ListOpt) List of logger=LEVEL pairs.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>fatal_deprecations = False</td>
|
||||
<td><option>fatal_deprecations</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Enables or disables fatal status of deprecations.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>fatal_exception_format_errors = False</td>
|
||||
<td><option>fatal_exception_format_errors</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Make exception message format errors fatal.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>instance_format = "[instance: %(uuid)s] "</td>
|
||||
<td><option>instance_format</option> = <replaceable>"[instance: %(uuid)s] "</replaceable></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><option>instance_uuid_format</option> = <replaceable>"[instance: %(uuid)s] "</replaceable></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><option>log_config_append</option> = <replaceable>None</replaceable></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><option>log_date_format</option> = <replaceable>%Y-%m-%d %H:%M:%S</replaceable></td>
|
||||
<td>(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s .</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>log_dir = None</td>
|
||||
<td><option>log_dir</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) (Optional) The base directory used for relative --log-file paths.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>log_file = None</td>
|
||||
<td><option>log_file</option> = <replaceable>None</replaceable></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><option>log_format</option> = <replaceable>None</replaceable></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><option>logging_context_format_string</option> = <replaceable>%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s</replaceable></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><option>logging_debug_format_suffix</option> = <replaceable>%(funcName)s %(pathname)s:%(lineno)d</replaceable></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><option>logging_default_format_string</option> = <replaceable>%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s</replaceable></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><option>logging_exception_prefix</option> = <replaceable>%(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s</replaceable></td>
|
||||
<td>(StrOpt) Prefix each line of exception output with this format.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>publish_errors = False</td>
|
||||
<td><option>publish_errors</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Enables or disables publication of error events.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>syslog_log_facility = LOG_USER</td>
|
||||
<td><option>syslog_log_facility</option> = <replaceable>LOG_USER</replaceable></td>
|
||||
<td>(StrOpt) Syslog facility to receive log lines.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>use_stderr = True</td>
|
||||
<td><option>use_stderr</option> = <replaceable>True</replaceable></td>
|
||||
<td>(BoolOpt) Log output to standard error.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>use_syslog = False</td>
|
||||
<td><option>use_syslog</option> = <replaceable>False</replaceable></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><option>use_syslog_rfc_format</option> = <replaceable>False</replaceable></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><option>verbose</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,15 +18,15 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>lvm_mirrors = 0</td>
|
||||
<td><option>lvm_mirrors</option> = <replaceable>0</replaceable></td>
|
||||
<td>(IntOpt) If >0, create LVs with multiple mirrors. Note that this requires lvm_mirrors + 2 PVs with available space</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>lvm_type = default</td>
|
||||
<td><option>lvm_type</option> = <replaceable>default</replaceable></td>
|
||||
<td>(StrOpt) Type of LVM volumes to deploy; (default or thin)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>volume_group = cinder-volumes</td>
|
||||
<td><option>volume_group</option> = <replaceable>cinder-volumes</replaceable></td>
|
||||
<td>(StrOpt) Name for the VG that will contain exported volumes</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,23 +18,31 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>nas_ip = </td>
|
||||
<td><option>nas_ip</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) IP address or Hostname of NAS system.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>nas_login = admin</td>
|
||||
<td><option>nas_login</option> = <replaceable>admin</replaceable></td>
|
||||
<td>(StrOpt) User name to connect to NAS system.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>nas_password = </td>
|
||||
<td><option>nas_password</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) Password to connect to NAS system.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>nas_private_key = </td>
|
||||
<td><option>nas_private_key</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) Filename of private key to use for SSH authentication.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>nas_ssh_port = 22</td>
|
||||
<td><option>nas_secure_file_operations</option> = <replaceable>auto</replaceable></td>
|
||||
<td>(StrOpt) Allow network-attached storage systems to operate in a secure environment where root level access is not permitted. If set to False, access is as the root user and insecure. If set to True, access is not as root. If set to auto, a check is done to determine if this is a new installation: True is used if so, otherwise False. Default is auto.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>nas_secure_file_permissions</option> = <replaceable>auto</replaceable></td>
|
||||
<td>(StrOpt) Set more secure file permissions on network-attached storage volume files to restrict broad other/world access. If set to False, volumes are created with open permissions. If set to True, volumes are created with permissions for the cinder user and group (660). If set to auto, a check is done to determine if this is a new installation: True is used if so, otherwise False. Default is auto.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>nas_ssh_port</option> = <replaceable>22</replaceable></td>
|
||||
<td>(IntOpt) SSH port to use to connect to NAS system.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,44 +18,48 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>netapp_login = None</td>
|
||||
<td><option>netapp_login</option> = <replaceable>None</replaceable></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><option>netapp_partner_backend_name</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) The name of the config.conf stanza for a Data ONTAP (7-mode) HA partner. 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 it is required if the storage protocol selected is FC.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>netapp_password</option> = <replaceable>None</replaceable></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><option>netapp_server_hostname</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) The hostname (or IP address) for the storage system or proxy server.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>netapp_server_port = None</td>
|
||||
<td><option>netapp_server_port</option> = <replaceable>None</replaceable></td>
|
||||
<td>(IntOpt) The TCP port to use for communication with the storage system or proxy server. If not specified, Data ONTAP drivers will use 80 for HTTP and 443 for HTTPS; E-Series will use 8080 for HTTP and 8443 for HTTPS.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>netapp_size_multiplier = 1.2</td>
|
||||
<td><option>netapp_size_multiplier</option> = <replaceable>1.2</replaceable></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><option>netapp_storage_family</option> = <replaceable>ontap_cluster</replaceable></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>
|
||||
<td><option>netapp_storage_protocol</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) The storage protocol to be used on the data path with the storage system; valid values are iscsi, fc, or nfs.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>netapp_transport_type = http</td>
|
||||
<td><option>netapp_transport_type</option> = <replaceable>http</replaceable></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>
|
||||
<td><option>netapp_vfiler</option> = <replaceable>None</replaceable></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. 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>
|
||||
<td><option>netapp_volume_list</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) This option is only utilized when the storage protocol is configured to use iSCSI or FC. 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>
|
||||
|
||||
@ -18,43 +18,47 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>expiry_thres_minutes = 720</td>
|
||||
<td><option>expiry_thres_minutes</option> = <replaceable>720</replaceable></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><option>netapp_login</option> = <replaceable>None</replaceable></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><option>netapp_partner_backend_name</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) The name of the config.conf stanza for a Data ONTAP (7-mode) HA partner. 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 it is required if the storage protocol selected is FC.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>netapp_password</option> = <replaceable>None</replaceable></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><option>netapp_server_hostname</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) The hostname (or IP address) for the storage system or proxy server.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>netapp_server_port = None</td>
|
||||
<td><option>netapp_server_port</option> = <replaceable>None</replaceable></td>
|
||||
<td>(IntOpt) The TCP port to use for communication with the storage system or proxy server. If not specified, Data ONTAP drivers will use 80 for HTTP and 443 for HTTPS; E-Series will use 8080 for HTTP and 8443 for HTTPS.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>netapp_storage_family = ontap_cluster</td>
|
||||
<td><option>netapp_storage_family</option> = <replaceable>ontap_cluster</replaceable></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>
|
||||
<td><option>netapp_storage_protocol</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) The storage protocol to be used on the data path with the storage system; valid values are iscsi, fc, or nfs.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>netapp_transport_type = http</td>
|
||||
<td><option>netapp_transport_type</option> = <replaceable>http</replaceable></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><option>thres_avl_size_perc_start</option> = <replaceable>20</replaceable></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><option>thres_avl_size_perc_stop</option> = <replaceable>60</replaceable></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>
|
||||
|
||||
@ -18,40 +18,44 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>netapp_login = None</td>
|
||||
<td><option>netapp_login</option> = <replaceable>None</replaceable></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><option>netapp_partner_backend_name</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) The name of the config.conf stanza for a Data ONTAP (7-mode) HA partner. 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 it is required if the storage protocol selected is FC.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>netapp_password</option> = <replaceable>None</replaceable></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><option>netapp_server_hostname</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) The hostname (or IP address) for the storage system or proxy server.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>netapp_server_port = None</td>
|
||||
<td><option>netapp_server_port</option> = <replaceable>None</replaceable></td>
|
||||
<td>(IntOpt) The TCP port to use for communication with the storage system or proxy server. If not specified, Data ONTAP drivers will use 80 for HTTP and 443 for HTTPS; E-Series will use 8080 for HTTP and 8443 for HTTPS.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>netapp_size_multiplier = 1.2</td>
|
||||
<td><option>netapp_size_multiplier</option> = <replaceable>1.2</replaceable></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><option>netapp_storage_family</option> = <replaceable>ontap_cluster</replaceable></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>
|
||||
<td><option>netapp_storage_protocol</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) The storage protocol to be used on the data path with the storage system; valid values are iscsi, fc, or nfs.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>netapp_transport_type = http</td>
|
||||
<td><option>netapp_transport_type</option> = <replaceable>http</replaceable></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>
|
||||
<td><option>netapp_vserver</option> = <replaceable>None</replaceable></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.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
@ -18,51 +18,55 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>expiry_thres_minutes = 720</td>
|
||||
<td><option>expiry_thres_minutes</option> = <replaceable>720</replaceable></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><option>netapp_copyoffload_tool_path</option> = <replaceable>None</replaceable></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><option>netapp_login</option> = <replaceable>None</replaceable></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><option>netapp_partner_backend_name</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) The name of the config.conf stanza for a Data ONTAP (7-mode) HA partner. 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 it is required if the storage protocol selected is FC.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>netapp_password</option> = <replaceable>None</replaceable></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><option>netapp_server_hostname</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) The hostname (or IP address) for the storage system or proxy server.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>netapp_server_port = None</td>
|
||||
<td><option>netapp_server_port</option> = <replaceable>None</replaceable></td>
|
||||
<td>(IntOpt) The TCP port to use for communication with the storage system or proxy server. If not specified, Data ONTAP drivers will use 80 for HTTP and 443 for HTTPS; E-Series will use 8080 for HTTP and 8443 for HTTPS.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>netapp_storage_family = ontap_cluster</td>
|
||||
<td><option>netapp_storage_family</option> = <replaceable>ontap_cluster</replaceable></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>
|
||||
<td><option>netapp_storage_protocol</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) The storage protocol to be used on the data path with the storage system; valid values are iscsi, fc, or nfs.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>netapp_transport_type = http</td>
|
||||
<td><option>netapp_transport_type</option> = <replaceable>http</replaceable></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>
|
||||
<td><option>netapp_vserver</option> = <replaceable>None</replaceable></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.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>thres_avl_size_perc_start = 20</td>
|
||||
<td><option>thres_avl_size_perc_start</option> = <replaceable>20</replaceable></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><option>thres_avl_size_perc_stop</option> = <replaceable>60</replaceable></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>
|
||||
|
||||
@ -18,47 +18,51 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>netapp_controller_ips = None</td>
|
||||
<td><option>netapp_controller_ips</option> = <replaceable>None</replaceable></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_eseries_host_type = linux_dm_mp</td>
|
||||
<td><option>netapp_eseries_host_type</option> = <replaceable>linux_dm_mp</replaceable></td>
|
||||
<td>(StrOpt) This option is used to define how the controllers in the E-Series storage array will work with the particular operating system on the hosts that are connected to it.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>netapp_login = None</td>
|
||||
<td><option>netapp_login</option> = <replaceable>None</replaceable></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><option>netapp_partner_backend_name</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) The name of the config.conf stanza for a Data ONTAP (7-mode) HA partner. 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 it is required if the storage protocol selected is FC.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>netapp_password</option> = <replaceable>None</replaceable></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><option>netapp_sa_password</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Password for the NetApp E-Series storage array.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>netapp_server_hostname = None</td>
|
||||
<td><option>netapp_server_hostname</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) The hostname (or IP address) for the storage system or proxy server.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>netapp_server_port = None</td>
|
||||
<td><option>netapp_server_port</option> = <replaceable>None</replaceable></td>
|
||||
<td>(IntOpt) The TCP port to use for communication with the storage system or proxy server. If not specified, Data ONTAP drivers will use 80 for HTTP and 443 for HTTPS; E-Series will use 8080 for HTTP and 8443 for HTTPS.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>netapp_storage_family = ontap_cluster</td>
|
||||
<td><option>netapp_storage_family</option> = <replaceable>ontap_cluster</replaceable></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><option>netapp_storage_pools</option> = <replaceable>None</replaceable></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><option>netapp_transport_type</option> = <replaceable>http</replaceable></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><option>netapp_webservice_path</option> = <replaceable>/devmgr/v2</replaceable></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>
|
||||
|
||||
@ -18,63 +18,63 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>nexenta_blocksize = </td>
|
||||
<td><option>nexenta_blocksize</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) Block size for volumes (default=blank means 8KB)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>nexenta_host = </td>
|
||||
<td><option>nexenta_host</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) IP address of Nexenta SA</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>nexenta_iscsi_target_portal_port = 3260</td>
|
||||
<td><option>nexenta_iscsi_target_portal_port</option> = <replaceable>3260</replaceable></td>
|
||||
<td>(IntOpt) Nexenta target portal port</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>nexenta_password = nexenta</td>
|
||||
<td><option>nexenta_password</option> = <replaceable>nexenta</replaceable></td>
|
||||
<td>(StrOpt) Password to connect to Nexenta SA</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>nexenta_rest_port = 2000</td>
|
||||
<td><option>nexenta_rest_port</option> = <replaceable>2000</replaceable></td>
|
||||
<td>(IntOpt) HTTP port to connect to Nexenta REST API server</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>nexenta_rest_protocol = auto</td>
|
||||
<td><option>nexenta_rest_protocol</option> = <replaceable>auto</replaceable></td>
|
||||
<td>(StrOpt) Use http or https for REST connection (default auto)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>nexenta_rrmgr_compression = 0</td>
|
||||
<td><option>nexenta_rrmgr_compression</option> = <replaceable>0</replaceable></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><option>nexenta_rrmgr_connections</option> = <replaceable>2</replaceable></td>
|
||||
<td>(IntOpt) Number of TCP connections.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>nexenta_rrmgr_tcp_buf_size = 4096</td>
|
||||
<td><option>nexenta_rrmgr_tcp_buf_size</option> = <replaceable>4096</replaceable></td>
|
||||
<td>(IntOpt) TCP Buffer size in KiloBytes.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>nexenta_sparse = False</td>
|
||||
<td><option>nexenta_sparse</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Enables or disables the creation of sparse volumes</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>nexenta_sparsed_volumes = True</td>
|
||||
<td><option>nexenta_sparsed_volumes</option> = <replaceable>True</replaceable></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><option>nexenta_target_group_prefix</option> = <replaceable>cinder/</replaceable></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><option>nexenta_target_prefix</option> = <replaceable>iqn.1986-03.com.sun:02:cinder-</replaceable></td>
|
||||
<td>(StrOpt) IQN prefix for iSCSI targets</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>nexenta_user = admin</td>
|
||||
<td><option>nexenta_user</option> = <replaceable>admin</replaceable></td>
|
||||
<td>(StrOpt) User name to connect to Nexenta SA</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>nexenta_volume = cinder</td>
|
||||
<td><option>nexenta_volume</option> = <replaceable>cinder</replaceable></td>
|
||||
<td>(StrOpt) SA Pool that holds all volumes</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,19 +18,19 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>nexenta_mount_point_base = $state_path/mnt</td>
|
||||
<td><option>nexenta_mount_point_base</option> = <replaceable>$state_path/mnt</replaceable></td>
|
||||
<td>(StrOpt) Base directory that contains NFS share mount points</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>nexenta_nms_cache_volroot = True</td>
|
||||
<td><option>nexenta_nms_cache_volroot</option> = <replaceable>True</replaceable></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><option>nexenta_shares_config</option> = <replaceable>/etc/cinder/nfs_shares</replaceable></td>
|
||||
<td>(StrOpt) File with the list of available nfs shares</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>nexenta_volume_compression = on</td>
|
||||
<td><option>nexenta_volume_compression</option> = <replaceable>on</replaceable></td>
|
||||
<td>(StrOpt) Default compression value for new ZFS folders.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,11 +18,11 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>nimble_pool_name = default</td>
|
||||
<td><option>nimble_pool_name</option> = <replaceable>default</replaceable></td>
|
||||
<td>(StrOpt) Nimble Controller pool name</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>nimble_subnet_label = *</td>
|
||||
<td><option>nimble_subnet_label</option> = <replaceable>*</replaceable></td>
|
||||
<td>(StrOpt) Nimble Subnet Label</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,11 +18,11 @@
|
||||
<th colspan="2">[profiler]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>profiler_enabled = False</td>
|
||||
<td><option>profiler_enabled</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) If False fully disable profiling feature.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>trace_sqlalchemy = False</td>
|
||||
<td><option>trace_sqlalchemy</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) If False doesn't trace SQL requests.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,31 +18,31 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>dpl_pool = </td>
|
||||
<td><option>dpl_pool</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) DPL pool uuid in which DPL volumes are stored.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>dpl_port = 8357</td>
|
||||
<td><option>dpl_port</option> = <replaceable>8357</replaceable></td>
|
||||
<td>(IntOpt) DPL port number.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>iscsi_port = 3260</td>
|
||||
<td><option>iscsi_port</option> = <replaceable>3260</replaceable></td>
|
||||
<td>(IntOpt) The port that the iSCSI daemon is listening on</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>san_ip = </td>
|
||||
<td><option>san_ip</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) IP address of SAN controller</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>san_login = admin</td>
|
||||
<td><option>san_login</option> = <replaceable>admin</replaceable></td>
|
||||
<td>(StrOpt) Username for SAN controller</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>san_password = </td>
|
||||
<td><option>san_password</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) Password for SAN controller</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>san_thin_provision = True</td>
|
||||
<td><option>san_thin_provision</option> = <replaceable>True</replaceable></td>
|
||||
<td>(BoolOpt) Use thin provisioning for SAN volumes?</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,7 +18,7 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>pure_api_token = None</td>
|
||||
<td><option>pure_api_token</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) REST API authorization token.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,47 +18,47 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>qpid_heartbeat = 60</td>
|
||||
<td><option>qpid_heartbeat</option> = <replaceable>60</replaceable></td>
|
||||
<td>(IntOpt) Seconds between connection keepalive heartbeats.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>qpid_hostname = localhost</td>
|
||||
<td><option>qpid_hostname</option> = <replaceable>localhost</replaceable></td>
|
||||
<td>(StrOpt) Qpid broker hostname.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>qpid_hosts = $qpid_hostname:$qpid_port</td>
|
||||
<td><option>qpid_hosts</option> = <replaceable>$qpid_hostname:$qpid_port</replaceable></td>
|
||||
<td>(ListOpt) Qpid HA cluster host:port pairs.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>qpid_password = </td>
|
||||
<td><option>qpid_password</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) Password for Qpid connection.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>qpid_port = 5672</td>
|
||||
<td><option>qpid_port</option> = <replaceable>5672</replaceable></td>
|
||||
<td>(IntOpt) Qpid broker port.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>qpid_protocol = tcp</td>
|
||||
<td><option>qpid_protocol</option> = <replaceable>tcp</replaceable></td>
|
||||
<td>(StrOpt) Transport to use, either 'tcp' or 'ssl'.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>qpid_receiver_capacity = 1</td>
|
||||
<td><option>qpid_receiver_capacity</option> = <replaceable>1</replaceable></td>
|
||||
<td>(IntOpt) The number of prefetched messages held by receiver.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>qpid_sasl_mechanisms = </td>
|
||||
<td><option>qpid_sasl_mechanisms</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) Space separated list of SASL mechanisms to use for auth.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>qpid_tcp_nodelay = True</td>
|
||||
<td><option>qpid_tcp_nodelay</option> = <replaceable>True</replaceable></td>
|
||||
<td>(BoolOpt) Whether to disable the Nagle algorithm.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>qpid_topology_version = 1</td>
|
||||
<td><option>qpid_topology_version</option> = <replaceable>1</replaceable></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><option>qpid_username</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) Username for Qpid connection.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
42
doc/common/tables/cinder-quobyte.xml
Normal file
42
doc/common/tables/cinder-quobyte.xml
Normal file
@ -0,0 +1,42 @@
|
||||
<?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_quobyte">
|
||||
<caption>Description of quobyte configuration options</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><option>quobyte_client_cfg</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Path to a Quobyte Client configuration file.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>quobyte_mount_point_base</option> = <replaceable>$state_path/mnt</replaceable></td>
|
||||
<td>(StrOpt) Base dir containing the mount point for the Quobyte volume.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>quobyte_qcow2_volumes</option> = <replaceable>True</replaceable></td>
|
||||
<td>(BoolOpt) Create volumes as QCOW2 files rather than raw files.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>quobyte_sparsed_volumes</option> = <replaceable>True</replaceable></td>
|
||||
<td>(BoolOpt) Create volumes as sparse 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><option>quobyte_volume_url</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) URL to the Quobyte volume e.g., quobyte://<DIR host>/<volume name></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</para>
|
||||
@ -18,43 +18,43 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>max_age = 0</td>
|
||||
<td><option>max_age</option> = <replaceable>0</replaceable></td>
|
||||
<td>(IntOpt) Number of seconds between subsequent usage refreshes</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>quota_backup_gigabytes = 1000</td>
|
||||
<td><option>quota_backup_gigabytes</option> = <replaceable>1000</replaceable></td>
|
||||
<td>(IntOpt) Total amount of storage, in gigabytes, allowed for backups per project</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>quota_backups = 10</td>
|
||||
<td><option>quota_backups</option> = <replaceable>10</replaceable></td>
|
||||
<td>(IntOpt) Number of volume backups allowed per project</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>quota_consistencygroups = 10</td>
|
||||
<td><option>quota_consistencygroups</option> = <replaceable>10</replaceable></td>
|
||||
<td>(IntOpt) Number of consistencygroups allowed per project</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>quota_driver = cinder.quota.DbQuotaDriver</td>
|
||||
<td><option>quota_driver</option> = <replaceable>cinder.quota.DbQuotaDriver</replaceable></td>
|
||||
<td>(StrOpt) Default driver to use for quota checks</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>quota_gigabytes = 1000</td>
|
||||
<td><option>quota_gigabytes</option> = <replaceable>1000</replaceable></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><option>quota_snapshots</option> = <replaceable>10</replaceable></td>
|
||||
<td>(IntOpt) Number of volume snapshots allowed per project</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>quota_volumes = 10</td>
|
||||
<td><option>quota_volumes</option> = <replaceable>10</replaceable></td>
|
||||
<td>(IntOpt) Number of volumes allowed per project</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>reservation_expire = 86400</td>
|
||||
<td><option>reservation_expire</option> = <replaceable>86400</replaceable></td>
|
||||
<td>(IntOpt) Number of seconds until a reservation expires</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>use_default_quota_class = True</td>
|
||||
<td><option>use_default_quota_class</option> = <replaceable>True</replaceable></td>
|
||||
<td>(BoolOpt) Enables or disables use of default quota class with default quota.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,71 +18,71 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>kombu_reconnect_delay = 1.0</td>
|
||||
<td><option>kombu_reconnect_delay</option> = <replaceable>1.0</replaceable></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><option>kombu_ssl_ca_certs</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) SSL certification authority file (valid only if SSL enabled).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>kombu_ssl_certfile = </td>
|
||||
<td><option>kombu_ssl_certfile</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) SSL cert file (valid only if SSL enabled).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>kombu_ssl_keyfile = </td>
|
||||
<td><option>kombu_ssl_keyfile</option> = <replaceable></replaceable></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>
|
||||
<td><option>kombu_ssl_version</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1 and SSLv23. SSLv2 and SSLv3 may be available on some distributions.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>rabbit_ha_queues = False</td>
|
||||
<td><option>rabbit_ha_queues</option> = <replaceable>False</replaceable></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><option>rabbit_host</option> = <replaceable>localhost</replaceable></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><option>rabbit_hosts</option> = <replaceable>$rabbit_host:$rabbit_port</replaceable></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>
|
||||
<td><option>rabbit_login_method</option> = <replaceable>AMQPLAIN</replaceable></td>
|
||||
<td>(StrOpt) The RabbitMQ login method.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>rabbit_max_retries = 0</td>
|
||||
<td><option>rabbit_max_retries</option> = <replaceable>0</replaceable></td>
|
||||
<td>(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>rabbit_password = guest</td>
|
||||
<td><option>rabbit_password</option> = <replaceable>guest</replaceable></td>
|
||||
<td>(StrOpt) The RabbitMQ password.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>rabbit_port = 5672</td>
|
||||
<td><option>rabbit_port</option> = <replaceable>5672</replaceable></td>
|
||||
<td>(IntOpt) The RabbitMQ broker port where a single node is used.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>rabbit_retry_backoff = 2</td>
|
||||
<td><option>rabbit_retry_backoff</option> = <replaceable>2</replaceable></td>
|
||||
<td>(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>rabbit_retry_interval = 1</td>
|
||||
<td><option>rabbit_retry_interval</option> = <replaceable>1</replaceable></td>
|
||||
<td>(IntOpt) How frequently to retry connecting with RabbitMQ.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>rabbit_use_ssl = False</td>
|
||||
<td><option>rabbit_use_ssl</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Connect over SSL for RabbitMQ.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>rabbit_userid = guest</td>
|
||||
<td><option>rabbit_userid</option> = <replaceable>guest</replaceable></td>
|
||||
<td>(StrOpt) The RabbitMQ userid.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>rabbit_virtual_host = /</td>
|
||||
<td><option>rabbit_virtual_host</option> = <replaceable>/</replaceable></td>
|
||||
<td>(StrOpt) The RabbitMQ virtual host.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,22 +18,22 @@
|
||||
<th colspan="2">[matchmaker_redis]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>host = 127.0.0.1</td>
|
||||
<td><option>host</option> = <replaceable>127.0.0.1</replaceable></td>
|
||||
<td>(StrOpt) Host to locate redis.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>password = None</td>
|
||||
<td><option>password</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Password for Redis server (optional).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>port = 6379</td>
|
||||
<td><option>port</option> = <replaceable>6379</replaceable></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><option>ringfile</option> = <replaceable>/etc/oslo/matchmaker_ring.json</replaceable></td>
|
||||
<td>(StrOpt) Matchmaker ring file (JSON).</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,23 +18,23 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>filters_path = /etc/cinder/rootwrap.d,/usr/share/cinder/rootwrap</td>
|
||||
<td><option>filters_path</option> = <replaceable>/etc/cinder/rootwrap.d,/usr/share/cinder/rootwrap</replaceable></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><option>exec_dirs</option> = <replaceable>/sbin,/usr/sbin,/bin,/usr/bin,/usr/local/bin</replaceable></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><option>use_syslog</option> = <replaceable>False</replaceable></td>
|
||||
<td>Enable logging to syslog Default value is False</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>syslog_log_facility = syslog</td>
|
||||
<td><option>syslog_log_facility</option> = <replaceable>syslog</replaceable></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><option>syslog_log_level</option> = <replaceable>ERROR</replaceable></td>
|
||||
<td>Which messages to log. INFO means log all usage ERROR means only log unsuccessful attempts</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,37 +18,84 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>matchmaker_heartbeat_freq = 300</td>
|
||||
<td><option>matchmaker_heartbeat_freq</option> = <replaceable>300</replaceable></td>
|
||||
<td>(IntOpt) Heartbeat frequency.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>matchmaker_heartbeat_ttl = 600</td>
|
||||
<td><option>matchmaker_heartbeat_ttl</option> = <replaceable>600</replaceable></td>
|
||||
<td>(IntOpt) Heartbeat time-to-live.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>rpc_backend = rabbit</td>
|
||||
<td><option>rpc_backend</option> = <replaceable>rabbit</replaceable></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><option>rpc_cast_timeout</option> = <replaceable>30</replaceable></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><option>rpc_conn_pool_size</option> = <replaceable>30</replaceable></td>
|
||||
<td>(IntOpt) Size of RPC connection pool.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>rpc_response_timeout = 60</td>
|
||||
<td><option>rpc_response_timeout</option> = <replaceable>60</replaceable></td>
|
||||
<td>(IntOpt) Seconds to wait for a response from a call.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>rpc_thread_pool_size = 64</td>
|
||||
<td><option>rpc_thread_pool_size</option> = <replaceable>64</replaceable></td>
|
||||
<td>(IntOpt) Size of RPC greenthread pool.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>volume_topic = cinder-volume</td>
|
||||
<td><option>volume_topic</option> = <replaceable>cinder-volume</replaceable></td>
|
||||
<td>(StrOpt) The topic that volume nodes listen on</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th colspan="2">[oslo_messaging_amqp]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>allow_insecure_clients</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Accept clients using either SSL or plain TCP</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>broadcast_prefix</option> = <replaceable>broadcast</replaceable></td>
|
||||
<td>(StrOpt) address prefix used when broadcasting to all servers</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>container_name</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Name for the AMQP container</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>group_request_prefix</option> = <replaceable>unicast</replaceable></td>
|
||||
<td>(StrOpt) address prefix when sending to any server in group</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>idle_timeout</option> = <replaceable>0</replaceable></td>
|
||||
<td>(IntOpt) Timeout for inactive connections (in seconds)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>server_request_prefix</option> = <replaceable>exclusive</replaceable></td>
|
||||
<td>(StrOpt) address prefix used when sending to a specific server</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>ssl_ca_file</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) CA certificate PEM file for verifing server certificate</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>ssl_cert_file</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) Identifying certificate PEM file to present to clients</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>ssl_key_file</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) Private key PEM file used to sign cert_file certificate</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>ssl_key_password</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Password for decrypting ssl_key_file (if encrypted)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>trace</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Debug: dump AMQP frames to stdout</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</para>
|
||||
|
||||
@ -18,7 +18,7 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>san_zfs_volume_base = rpool/</td>
|
||||
<td><option>san_zfs_volume_base</option> = <replaceable>rpool/</replaceable></td>
|
||||
<td>(StrOpt) The ZFS path under which to create zvols for volumes.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,51 +18,51 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>san_clustername = </td>
|
||||
<td><option>san_clustername</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) Cluster name to use for creating volumes</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>san_ip = </td>
|
||||
<td><option>san_ip</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) IP address of SAN controller</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>san_is_local = False</td>
|
||||
<td><option>san_is_local</option> = <replaceable>False</replaceable></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><option>san_login</option> = <replaceable>admin</replaceable></td>
|
||||
<td>(StrOpt) Username for SAN controller</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>san_password = </td>
|
||||
<td><option>san_password</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) Password for SAN controller</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>san_private_key = </td>
|
||||
<td><option>san_private_key</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) Filename of private key to use for SSH authentication</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>san_secondary_ip = None</td>
|
||||
<td><option>san_secondary_ip</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) VNX secondary SP IP Address.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>san_ssh_port = 22</td>
|
||||
<td><option>san_ssh_port</option> = <replaceable>22</replaceable></td>
|
||||
<td>(IntOpt) SSH port to use with SAN</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>san_thin_provision = True</td>
|
||||
<td><option>san_thin_provision</option> = <replaceable>True</replaceable></td>
|
||||
<td>(BoolOpt) Use thin provisioning for SAN volumes?</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>ssh_conn_timeout = 30</td>
|
||||
<td><option>ssh_conn_timeout</option> = <replaceable>30</replaceable></td>
|
||||
<td>(IntOpt) SSH connection timeout in seconds</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>ssh_max_pool_conn = 5</td>
|
||||
<td><option>ssh_max_pool_conn</option> = <replaceable>5</replaceable></td>
|
||||
<td>(IntOpt) Maximum ssh connections in the pool</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>ssh_min_pool_conn = 1</td>
|
||||
<td><option>ssh_min_pool_conn</option> = <replaceable>1</replaceable></td>
|
||||
<td>(IntOpt) Minimum ssh connections in the pool</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,15 +18,15 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>scality_sofs_config = None</td>
|
||||
<td><option>scality_sofs_config</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Path or URL to Scality SOFS configuration file</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>scality_sofs_mount_point = $state_path/scality</td>
|
||||
<td><option>scality_sofs_mount_point</option> = <replaceable>$state_path/scality</replaceable></td>
|
||||
<td>(StrOpt) Base dir where Scality SOFS shall be mounted</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>scality_sofs_volume_dir = cinder/volumes</td>
|
||||
<td><option>scality_sofs_volume_dir</option> = <replaceable>cinder/volumes</replaceable></td>
|
||||
<td>(StrOpt) Path from Scality SOFS root to volume dir</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,35 +18,35 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>scheduler_default_filters = AvailabilityZoneFilter, CapacityFilter, CapabilitiesFilter</td>
|
||||
<td><option>scheduler_default_filters</option> = <replaceable>AvailabilityZoneFilter, CapacityFilter, CapabilitiesFilter</replaceable></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><option>scheduler_default_weighers</option> = <replaceable>CapacityWeigher</replaceable></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><option>scheduler_driver</option> = <replaceable>cinder.scheduler.filter_scheduler.FilterScheduler</replaceable></td>
|
||||
<td>(StrOpt) Default scheduler driver to use</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>scheduler_host_manager = cinder.scheduler.host_manager.HostManager</td>
|
||||
<td><option>scheduler_host_manager</option> = <replaceable>cinder.scheduler.host_manager.HostManager</replaceable></td>
|
||||
<td>(StrOpt) The scheduler host manager class to use</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>scheduler_json_config_location = </td>
|
||||
<td><option>scheduler_json_config_location</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) Absolute path to scheduler configuration JSON file.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>scheduler_manager = cinder.scheduler.manager.SchedulerManager</td>
|
||||
<td><option>scheduler_manager</option> = <replaceable>cinder.scheduler.manager.SchedulerManager</replaceable></td>
|
||||
<td>(StrOpt) Full class name for the Manager for scheduler</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>scheduler_max_attempts = 3</td>
|
||||
<td><option>scheduler_max_attempts</option> = <replaceable>3</replaceable></td>
|
||||
<td>(IntOpt) Maximum number of attempts to schedule an volume</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>scheduler_topic = cinder-scheduler</td>
|
||||
<td><option>scheduler_topic</option> = <replaceable>cinder-scheduler</replaceable></td>
|
||||
<td>(StrOpt) The topic that scheduler nodes listen on</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,31 +18,31 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>smbfs_default_volume_format = qcow2</td>
|
||||
<td><option>smbfs_default_volume_format</option> = <replaceable>qcow2</replaceable></td>
|
||||
<td>(StrOpt) Default format that will be used when creating volumes if no volume format is specified. Can be set to: raw, qcow2, vhd or vhdx.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>smbfs_mount_options = noperm,file_mode=0775,dir_mode=0775</td>
|
||||
<td><option>smbfs_mount_options</option> = <replaceable>noperm,file_mode=0775,dir_mode=0775</replaceable></td>
|
||||
<td>(StrOpt) Mount options passed to the smbfs client. See mount.cifs man page for details.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>smbfs_mount_point_base = $state_path/mnt</td>
|
||||
<td><option>smbfs_mount_point_base</option> = <replaceable>$state_path/mnt</replaceable></td>
|
||||
<td>(StrOpt) Base dir containing mount points for smbfs shares.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>smbfs_oversub_ratio = 1.0</td>
|
||||
<td><option>smbfs_oversub_ratio</option> = <replaceable>1.0</replaceable></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>smbfs_shares_config = /etc/cinder/smbfs_shares</td>
|
||||
<td><option>smbfs_shares_config</option> = <replaceable>/etc/cinder/smbfs_shares</replaceable></td>
|
||||
<td>(StrOpt) File with the list of available smbfs shares.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>smbfs_sparsed_volumes = True</td>
|
||||
<td><option>smbfs_sparsed_volumes</option> = <replaceable>True</replaceable></td>
|
||||
<td>(BoolOpt) Create volumes as sparsed files which take no space rather than regular files when using raw format, in which case volume creation takes lot of time.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>smbfs_used_ratio = 0.95</td>
|
||||
<td><option>smbfs_used_ratio</option> = <replaceable>0.95</replaceable></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>
|
||||
|
||||
@ -18,19 +18,19 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>sf_account_prefix = None</td>
|
||||
<td><option>sf_account_prefix</option> = <replaceable>None</replaceable></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><option>sf_allow_tenant_qos</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Allow tenants to specify QOS on create</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>sf_api_port = 443</td>
|
||||
<td><option>sf_api_port</option> = <replaceable>443</replaceable></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><option>sf_emulate_512</option> = <replaceable>True</replaceable></td>
|
||||
<td>(BoolOpt) Set 512 byte emulation on volume creation;</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
26
doc/common/tables/cinder-srb.xml
Normal file
26
doc/common/tables/cinder-srb.xml
Normal file
@ -0,0 +1,26 @@
|
||||
<?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_srb">
|
||||
<caption>Description of srb configuration options</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><option>srb_base_urls</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Comma-separated list of REST servers to connect to</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</para>
|
||||
@ -18,127 +18,127 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>allocated_capacity_weight_multiplier = -1.0</td>
|
||||
<td><option>allocated_capacity_weight_multiplier</option> = <replaceable>-1.0</replaceable></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><option>capacity_weight_multiplier</option> = <replaceable>1.0</replaceable></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><option>enabled_backends</option> = <replaceable>None</replaceable></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><option>iscsi_helper</option> = <replaceable>tgtadm</replaceable></td>
|
||||
<td>(StrOpt) iSCSI target user-land tool to use. tgtadm is default, use lioadm for LIO iSCSI support, iseradm for the ISER protocol, or fake for testing.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>iscsi_iotype = fileio</td>
|
||||
<td><option>iscsi_iotype</option> = <replaceable>fileio</replaceable></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><option>iscsi_ip_address</option> = <replaceable>$my_ip</replaceable></td>
|
||||
<td>(StrOpt) The IP address that the iSCSI daemon is listening on</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>iscsi_num_targets = 100</td>
|
||||
<td><option>iscsi_num_targets</option> = <replaceable>100</replaceable></td>
|
||||
<td>(IntOpt) The maximum number of iSCSI target IDs per host</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>iscsi_port = 3260</td>
|
||||
<td><option>iscsi_port</option> = <replaceable>3260</replaceable></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><option>iscsi_target_prefix</option> = <replaceable>iqn.2010-10.org.openstack:</replaceable></td>
|
||||
<td>(StrOpt) Prefix for iSCSI volumes</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>iscsi_write_cache = on</td>
|
||||
<td><option>iscsi_write_cache</option> = <replaceable>on</replaceable></td>
|
||||
<td>(StrOpt) Sets the behavior of the iSCSI target to either perform write-back(on) or write-through(off). This parameter is valid if iscsi_helper is set to tgtadm or iseradm.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>iser_helper = tgtadm</td>
|
||||
<td><option>iser_helper</option> = <replaceable>tgtadm</replaceable></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><option>iser_ip_address</option> = <replaceable>$my_ip</replaceable></td>
|
||||
<td>(StrOpt) The IP address that the iSER daemon is listening on</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>iser_num_targets = 100</td>
|
||||
<td><option>iser_num_targets</option> = <replaceable>100</replaceable></td>
|
||||
<td>(IntOpt) The maximum number of iSER target IDs per host</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>iser_port = 3260</td>
|
||||
<td><option>iser_port</option> = <replaceable>3260</replaceable></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><option>iser_target_prefix</option> = <replaceable>iqn.2010-10.org.iser.openstack:</replaceable></td>
|
||||
<td>(StrOpt) Prefix for iSER volumes</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>max_gigabytes = 10000</td>
|
||||
<td><option>max_gigabytes</option> = <replaceable>10000</replaceable></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><option>migration_create_volume_timeout_secs</option> = <replaceable>300</replaceable></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><option>num_iser_scan_tries</option> = <replaceable>3</replaceable></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><option>num_volume_device_scan_tries</option> = <replaceable>3</replaceable></td>
|
||||
<td>(IntOpt) The maximum number of times to rescan targets to find volume</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>volume_backend_name = None</td>
|
||||
<td><option>volume_backend_name</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) The backend name for a given driver implementation</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>volume_clear = zero</td>
|
||||
<td><option>volume_clear</option> = <replaceable>zero</replaceable></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><option>volume_clear_ionice</option> = <replaceable>None</replaceable></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><option>volume_clear_size</option> = <replaceable>0</replaceable></td>
|
||||
<td>(IntOpt) Size in MiB to wipe at start of old volumes. 0 => all</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>volume_copy_blkio_cgroup_name = cinder-volume-copy</td>
|
||||
<td><option>volume_copy_blkio_cgroup_name</option> = <replaceable>cinder-volume-copy</replaceable></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><option>volume_copy_bps_limit</option> = <replaceable>0</replaceable></td>
|
||||
<td>(IntOpt) The upper limit of bandwidth of volume copy. 0 => unlimited</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>volume_dd_blocksize = 1M</td>
|
||||
<td><option>volume_dd_blocksize</option> = <replaceable>1M</replaceable></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><option>volume_driver</option> = <replaceable>cinder.volume.drivers.lvm.LVMISCSIDriver</replaceable></td>
|
||||
<td>(StrOpt) Driver to use for volume creation</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>volume_manager = cinder.volume.manager.VolumeManager</td>
|
||||
<td><option>volume_manager</option> = <replaceable>cinder.volume.manager.VolumeManager</replaceable></td>
|
||||
<td>(StrOpt) Full class name for the Manager for volume</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>volume_service_inithost_offload = False</td>
|
||||
<td><option>volume_service_inithost_offload</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Offload pending volume delete during volume service startup</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>volume_usage_audit_period = month</td>
|
||||
<td><option>volume_usage_audit_period</option> = <replaceable>month</replaceable></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><option>volumes_dir</option> = <replaceable>$state_path/volumes</replaceable></td>
|
||||
<td>(StrOpt) Volume configuration file storage directory</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,40 +18,40 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>rados_connect_timeout = -1</td>
|
||||
<td><option>rados_connect_timeout</option> = <replaceable>-1</replaceable></td>
|
||||
<td>(IntOpt) Timeout value (in seconds) used when connecting to ceph cluster. If value < 0, no timeout is set and default librados value is used.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>rbd_ceph_conf = </td>
|
||||
<td><option>rbd_ceph_conf</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) Path to the ceph configuration file</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>rbd_flatten_volume_from_snapshot = False</td>
|
||||
<td><option>rbd_flatten_volume_from_snapshot</option> = <replaceable>False</replaceable></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><option>rbd_max_clone_depth</option> = <replaceable>5</replaceable></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><option>rbd_pool</option> = <replaceable>rbd</replaceable></td>
|
||||
<td>(StrOpt) The RADOS pool where rbd volumes are stored</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>rbd_secret_uuid = None</td>
|
||||
<td><option>rbd_secret_uuid</option> = <replaceable>None</replaceable></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><option>rbd_store_chunk_size</option> = <replaceable>4</replaceable></td>
|
||||
<td>(IntOpt) Volumes will be chunked into objects of this size (in megabytes).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>rbd_user = None</td>
|
||||
<td><option>rbd_user</option> = <replaceable>None</replaceable></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>
|
||||
<td><option>volume_tmp_dir</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Directory where temporary image files are stored when the volume driver does not write them directly to the volume. Warning: this option is now deprecated, please use image_conversion_dir instead.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
@ -18,19 +18,19 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>glusterfs_mount_point_base = $state_path/mnt</td>
|
||||
<td><option>glusterfs_mount_point_base</option> = <replaceable>$state_path/mnt</replaceable></td>
|
||||
<td>(StrOpt) Base dir containing mount points for gluster shares.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>glusterfs_qcow2_volumes = False</td>
|
||||
<td><option>glusterfs_qcow2_volumes</option> = <replaceable>False</replaceable></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><option>glusterfs_shares_config</option> = <replaceable>/etc/cinder/glusterfs_shares</replaceable></td>
|
||||
<td>(StrOpt) File with the list of available gluster shares</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>glusterfs_sparsed_volumes = True</td>
|
||||
<td><option>glusterfs_sparsed_volumes</option> = <replaceable>True</replaceable></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>
|
||||
|
||||
@ -18,27 +18,27 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>gpfs_images_dir = None</td>
|
||||
<td><option>gpfs_images_dir</option> = <replaceable>None</replaceable></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><option>gpfs_images_share_mode</option> = <replaceable>None</replaceable></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><option>gpfs_max_clone_depth</option> = <replaceable>0</replaceable></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><option>gpfs_mount_point_base</option> = <replaceable>None</replaceable></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><option>gpfs_sparse_volumes</option> = <replaceable>True</replaceable></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 = system</td>
|
||||
<td><option>gpfs_storage_pool</option> = <replaceable>system</replaceable></td>
|
||||
<td>(StrOpt) Specifies the storage pool that volumes are assigned to. By default, the system storage pool is used.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,27 +18,31 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>nfs_mount_options = None</td>
|
||||
<td><option>nfs_mount_attempts</option> = <replaceable>3</replaceable></td>
|
||||
<td>(IntOpt) The number of attempts to mount nfs shares before raising an error. At least one attempt will be made to mount an nfs share, regardless of the value specified.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>nfs_mount_options</option> = <replaceable>None</replaceable></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><option>nfs_mount_point_base</option> = <replaceable>$state_path/mnt</replaceable></td>
|
||||
<td>(StrOpt) Base dir containing mount points for nfs shares.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>nfs_oversub_ratio = 1.0</td>
|
||||
<td><option>nfs_oversub_ratio</option> = <replaceable>1.0</replaceable></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><option>nfs_shares_config</option> = <replaceable>/etc/cinder/nfs_shares</replaceable></td>
|
||||
<td>(StrOpt) File with the list of available nfs shares</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>nfs_sparsed_volumes = True</td>
|
||||
<td><option>nfs_sparsed_volumes</option> = <replaceable>True</replaceable></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><option>nfs_used_ratio</option> = <replaceable>0.95</replaceable></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>
|
||||
|
||||
30
doc/common/tables/cinder-storpool.xml
Normal file
30
doc/common/tables/cinder-storpool.xml
Normal file
@ -0,0 +1,30 @@
|
||||
<?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_storpool">
|
||||
<caption>Description of storpool configuration options</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><option>storpool_replication</option> = <replaceable>3</replaceable></td>
|
||||
<td>(IntOpt) The default StorPool chain replication value. Used when creating a volume with no specified type if storpool_template is not set. Also used for calculating the apparent free space reported in the stats.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>storpool_template</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) The StorPool template for volumes with no type.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</para>
|
||||
@ -18,67 +18,67 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>storwize_svc_allow_tenant_qos = False</td>
|
||||
<td><option>storwize_svc_allow_tenant_qos</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Allow tenants to specify QOS on create</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>storwize_svc_connection_protocol = iSCSI</td>
|
||||
<td><option>storwize_svc_connection_protocol</option> = <replaceable>iSCSI</replaceable></td>
|
||||
<td>(StrOpt) Connection protocol (iSCSI/FC)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>storwize_svc_flashcopy_timeout = 120</td>
|
||||
<td><option>storwize_svc_flashcopy_timeout</option> = <replaceable>120</replaceable></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><option>storwize_svc_iscsi_chap_enabled</option> = <replaceable>True</replaceable></td>
|
||||
<td>(BoolOpt) Configure CHAP authentication for iSCSI connections (Default: Enabled)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>storwize_svc_multihostmap_enabled = True</td>
|
||||
<td><option>storwize_svc_multihostmap_enabled</option> = <replaceable>True</replaceable></td>
|
||||
<td>(BoolOpt) Allows vdisk to multi host mapping</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>storwize_svc_multipath_enabled = False</td>
|
||||
<td><option>storwize_svc_multipath_enabled</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Connect with multipath (FC only; iSCSI multipath is controlled by Nova)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>storwize_svc_npiv_compatibility_mode = False</td>
|
||||
<td><option>storwize_svc_npiv_compatibility_mode</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Indicate whether svc driver is compatible for NPIV setup. If it is compatible, it will allow no wwpns being returned on get_conn_fc_wwpns during initialize_connection</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>storwize_svc_stretched_cluster_partner = None</td>
|
||||
<td><option>storwize_svc_stretched_cluster_partner</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) If operating in stretched cluster mode, specify the name of the pool in which mirrored copies are stored.Example: "pool2"</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>storwize_svc_vol_autoexpand = True</td>
|
||||
<td><option>storwize_svc_vol_autoexpand</option> = <replaceable>True</replaceable></td>
|
||||
<td>(BoolOpt) Storage system autoexpand parameter for volumes (True/False)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>storwize_svc_vol_compression = False</td>
|
||||
<td><option>storwize_svc_vol_compression</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Storage system compression option for volumes</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>storwize_svc_vol_easytier = True</td>
|
||||
<td><option>storwize_svc_vol_easytier</option> = <replaceable>True</replaceable></td>
|
||||
<td>(BoolOpt) Enable Easy Tier for volumes</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>storwize_svc_vol_grainsize = 256</td>
|
||||
<td><option>storwize_svc_vol_grainsize</option> = <replaceable>256</replaceable></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><option>storwize_svc_vol_iogrp</option> = <replaceable>0</replaceable></td>
|
||||
<td>(IntOpt) The I/O group in which to allocate volumes</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>storwize_svc_vol_rsize = 2</td>
|
||||
<td><option>storwize_svc_vol_rsize</option> = <replaceable>2</replaceable></td>
|
||||
<td>(IntOpt) Storage system space-efficiency parameter for volumes (percentage)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>storwize_svc_vol_warning = 0</td>
|
||||
<td><option>storwize_svc_vol_warning</option> = <replaceable>0</replaceable></td>
|
||||
<td>(IntOpt) Storage system threshold for volume capacity warnings (percentage)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>storwize_svc_volpool_name = volpool</td>
|
||||
<td><option>storwize_svc_volpool_name</option> = <replaceable>volpool</replaceable></td>
|
||||
<td>(StrOpt) Storage system storage pool for volumes</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,11 +18,11 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>backup_swift_auth_version = 1</td>
|
||||
<td><option>backup_swift_auth_version</option> = <replaceable>1</replaceable></td>
|
||||
<td>(StrOpt) Swift authentication version. Specify "1" for auth 1.0, or "2" for auth 2.0</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>backup_swift_tenant = None</td>
|
||||
<td><option>backup_swift_tenant</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Swift tenant/account name. Required when connecting to an auth 2.0 system</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -18,8 +18,8 @@
|
||||
<th colspan="2">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>fake_rabbit = False</td>
|
||||
<td>(BoolOpt) If passed, use a fake RabbitMQ provider.</td>
|
||||
<td><option>fake_rabbit</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
34
doc/common/tables/cinder-violin.xml
Normal file
34
doc/common/tables/cinder-violin.xml
Normal file
@ -0,0 +1,34 @@
|
||||
<?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_violin">
|
||||
<caption>Description of Violin volume driver configuration options</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><option>gateway_mga</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) IP address or hostname of mg-a</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>gateway_mgb</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) IP address or hostname of mg-b</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>use_igroups</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Use igroups to manage targets and initiators</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</para>
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user