280 lines
15 KiB
XML
280 lines
15 KiB
XML
<?xml version='1.0' encoding='UTF-8'?>
|
|
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
|
|
<!--
|
|
###################################################################
|
|
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
|
|
###################################################################
|
|
|
|
Warning: Do not edit this file. It is automatically
|
|
generated from the software project's code and your changes
|
|
will be overwritten.
|
|
|
|
The tool to generate this file lives in openstack-doc-tools
|
|
repository.
|
|
|
|
Please make any changes needed in the code, then run the
|
|
autogenerate-config-doc tool from the openstack-doc-tools
|
|
repository, or ask for help on the documentation mailing list,
|
|
IRC channel or meeting.
|
|
|
|
###################################################################
|
|
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
|
|
###################################################################
|
|
-->
|
|
<table rules="all" xml:id="config_table_cinder_common">
|
|
<caption>Description of common 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>allow_availability_zone_fallback</option> = <replaceable>False</replaceable></td>
|
|
<td>(BoolOpt) If the requested Cinder availability zone is unavailable, fall back to the value of default_availability_zone, then storage_availability_zone, instead of failing.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>chap_password</option> = <replaceable></replaceable></td>
|
|
<td>(StrOpt) Password for specified CHAP account name.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>chap_username</option> = <replaceable></replaceable></td>
|
|
<td>(StrOpt) CHAP user name.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>chiscsi_conf</option> = <replaceable>/etc/chelsio-iscsi/chiscsi.conf</replaceable></td>
|
|
<td>(StrOpt) Chiscsi (CXT) global defaults configuration file</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>cinder_internal_tenant_project_id</option> = <replaceable>None</replaceable></td>
|
|
<td>(StrOpt) ID of the project which will be used as the Cinder internal tenant.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>cinder_internal_tenant_user_id</option> = <replaceable>None</replaceable></td>
|
|
<td>(StrOpt) ID of the user to be used in volume operations as the Cinder internal tenant.</td>
|
|
</tr>
|
|
<tr>
|
|
<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><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><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><option>default_volume_type</option> = <replaceable>None</replaceable></td>
|
|
<td>(StrOpt) Default volume type to use</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>driver_data_namespace</option> = <replaceable>None</replaceable></td>
|
|
<td>(StrOpt) Namespace for driver private data values to be saved in.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>driver_ssl_cert_verify</option> = <replaceable>False</replaceable></td>
|
|
<td>(BoolOpt) If set to True the http client will validate the SSL certificate of the backend endpoint.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>enable_force_upload</option> = <replaceable>False</replaceable></td>
|
|
<td>(BoolOpt) Enables the Force option on upload_to_image. This enables running upload_volume on in-use volumes for backends that support it.</td>
|
|
</tr>
|
|
<tr>
|
|
<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><option>end_time</option> = <replaceable>None</replaceable></td>
|
|
<td>(StrOpt) If this option is specified then the end time specified is used instead of the end time of the last completed audit period.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>enforce_multipath_for_image_xfer</option> = <replaceable>False</replaceable></td>
|
|
<td>(BoolOpt) If this is set to True, attachment of volumes for image transfer will be aborted when multipathd is not running. Otherwise, it will fallback to single path.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>executor_thread_pool_size</option> = <replaceable>64</replaceable></td>
|
|
<td>(IntOpt) Size of executor thread pool.</td>
|
|
</tr>
|
|
<tr>
|
|
<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><option>iet_conf</option> = <replaceable>/etc/iet/ietd.conf</replaceable></td>
|
|
<td>(StrOpt) IET configuration file</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>iscsi_secondary_ip_addresses</option> = <replaceable></replaceable></td>
|
|
<td>(ListOpt) The list of secondary IP addresses of the iSCSI daemon</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>managed_replication_target</option> = <replaceable>True</replaceable></td>
|
|
<td>(BoolOpt) There are two types of target configurations managed (replicate to another configured backend) or unmanaged (replicate to a device not managed by Cinder).</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>max_over_subscription_ratio</option> = <replaceable>20.0</replaceable></td>
|
|
<td>(FloatOpt) Float representation of the over subscription ratio when thin provisioning is involved. Default ratio is 20.0, meaning provisioned capacity can be 20 times of the total physical capacity. If the ratio is 10.5, it means provisioned capacity can be 10.5 times of the total physical capacity. A ratio of 1.0 means provisioned capacity cannot exceed the total physical capacity. A ratio lower than 1.0 will be ignored and the default value will be used instead.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>memcached_servers</option> = <replaceable>None</replaceable></td>
|
|
<td>(ListOpt) Memcached servers or None for in process cache.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>monkey_patch</option> = <replaceable>False</replaceable></td>
|
|
<td>(BoolOpt) Enable monkey patching</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>monkey_patch_modules</option> = <replaceable></replaceable></td>
|
|
<td>(ListOpt) List of modules/decorators to monkey patch</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>my_ip</option> = <replaceable>10.0.0.1</replaceable></td>
|
|
<td>(StrOpt) IP address of this host</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>no_snapshot_gb_quota</option> = <replaceable>False</replaceable></td>
|
|
<td>(BoolOpt) Whether snapshots count against gigabyte quota</td>
|
|
</tr>
|
|
<tr>
|
|
<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><option>os_privileged_user_auth_url</option> = <replaceable>None</replaceable></td>
|
|
<td>(StrOpt) Auth URL associated with the OpenStack privileged account.</td>
|
|
</tr>
|
|
<tr>
|
|
<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><option>periodic_interval</option> = <replaceable>60</replaceable></td>
|
|
<td>(IntOpt) Interval, in seconds, between running periodic tasks</td>
|
|
</tr>
|
|
<tr>
|
|
<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><option>replication_devices</option> = <replaceable>None</replaceable></td>
|
|
<td>(ListOpt) List of k/v pairs representing a replication target for this backend device. For unmanaged the format is: {'key-1'='val1' 'key-2'='val2'...},{...} and for managed devices its simply a list of valid configured backend_names that the driver supports replicating to: backend-a,bakcend-b...</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>report_interval</option> = <replaceable>10</replaceable></td>
|
|
<td>(IntOpt) Interval, in seconds, between nodes reporting state to datastore</td>
|
|
</tr>
|
|
<tr>
|
|
<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><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><option>send_actions</option> = <replaceable>False</replaceable></td>
|
|
<td>(BoolOpt) Send the volume and snapshot create and delete notifications generated in the specified period.</td>
|
|
</tr>
|
|
<tr>
|
|
<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><option>sqlite_clean_db</option> = <replaceable>clean.sqlite</replaceable></td>
|
|
<td>(StrOpt) File name of clean sqlite db</td>
|
|
</tr>
|
|
<tr>
|
|
<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><option>start_time</option> = <replaceable>None</replaceable></td>
|
|
<td>(StrOpt) If this option is specified then the start time specified is used instead of the start time of the last completed audit period.</td>
|
|
</tr>
|
|
<tr>
|
|
<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><option>storage_availability_zone</option> = <replaceable>nova</replaceable></td>
|
|
<td>(StrOpt) Availability zone of this node</td>
|
|
</tr>
|
|
<tr>
|
|
<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><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><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><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><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><option>until_refresh</option> = <replaceable>0</replaceable></td>
|
|
<td>(IntOpt) Count of reservations until usage is refreshed</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>use_chap_auth</option> = <replaceable>False</replaceable></td>
|
|
<td>(BoolOpt) Option to enable/disable CHAP authentication for targets.</td>
|
|
</tr>
|
|
<tr>
|
|
<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>watch_log_file</option> = <replaceable>False</replaceable></td>
|
|
<td>(BoolOpt) (Optional) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log-file option is specified and Linux platform is used. This option is ignored if log_config_append is set.</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><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>
|
|
</table>
|
|
</para>
|