Additional options¶
These options can also be set in the cinder.conf file.
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| api_rate_limit = True | (Boolean) Enables or disables rate limit of the API. |
| az_cache_duration = 3600 | (Integer) Cache volume availability zones in memory for the provided duration in seconds |
| backend_host = None | (String) Backend override of host value. |
| default_timeout = 525600 | (Integer) 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. |
| enable_v1_api = True | (Boolean) DEPRECATED: Deploy v1 of the Cinder API. |
| enable_v2_api = True | (Boolean) DEPRECATED: Deploy v2 of the Cinder API. |
| enable_v3_api = True | (Boolean) Deploy v3 of the Cinder API. |
| extra_capabilities = {} | (String) 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. |
| ignore_pool_full_threshold = False | (Boolean) Force LUN creation even if the full threshold of pool is reached. |
| management_ips = | (String) List of Management IP addresses (separated by commas) |
| osapi_max_limit = 1000 | (Integer) The maximum number of items that a collection resource returns in a single response |
| osapi_max_request_body_size = 114688 | (Integer) Max size for body of a request |
| osapi_volume_base_URL = None | (String) Base URL that will be presented to users in links to the OpenStack Volume API |
| osapi_volume_ext_list = | (List) Specify list of extensions to load when using osapi_volume_extension option with cinder.api.contrib.select_extensions |
| osapi_volume_extension = ['cinder.api.contrib.standard_extensions'] | (Multi-valued) osapi volume extension to load |
| osapi_volume_listen = 0.0.0.0 | (String) IP address on which OpenStack Volume API listens |
| osapi_volume_listen_port = 8776 | (Port number) Port on which OpenStack Volume API listens |
| osapi_volume_workers = None | (Integer) Number of workers for OpenStack Volume API service. The default is equal to the number of CPUs available. |
| per_volume_size_limit = -1 | (Integer) Max size allowed per volume, in gigabytes |
| public_endpoint = None | (String) Public url to use for versions endpoint. The default is None, which will use the request’s host_url attribute to populate the URL base. If Cinder is operating behind a proxy, you will want to change this to represent the proxy’s URL. |
| query_volume_filters = name, status, metadata, availability_zone, bootable | (List) Volume filter options which non-admin user could use to query volumes. Default values are: [‘name’, ‘status’, ‘metadata’, ‘availability_zone’ ,’bootable’] |
| transfer_api_class = cinder.transfer.api.API | (String) The full class name of the volume transfer API class |
| volume_api_class = cinder.volume.api.API | (String) The full class name of the volume API class to use |
| volume_name_prefix = openstack- | (String) Prefix before volume name to differenciate DISCO volume created through openstack and the other ones |
| volume_name_template = volume-%s | (String) Template string to be used to generate volume names |
| volume_number_multiplier = -1.0 | (Floating point) Multiplier used for weighing volume number. Negative numbers mean to spread vs stack. |
| volume_transfer_key_length = 16 | (Integer) The number of characters in the autogenerated auth key. |
| volume_transfer_salt_length = 8 | (Integer) The number of characters in the salt. |
| [oslo_middleware] | |
| max_request_body_size = 114688 | (Integer) The maximum body size for each request, in bytes. |
| secure_proxy_ssl_header = X-Forwarded-Proto | (String) DEPRECATED: The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by an SSL termination proxy. |
| [oslo_policy] | |
| policy_default_rule = default | (String) Default rule. Enforced when a requested rule is not found. |
| policy_dirs = ['policy.d'] | (Multi-valued) 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. Missing or empty directories are ignored. |
| policy_file = policy.json | (String) The JSON file that defines policies. |
| [oslo_versionedobjects] | |
| fatal_exception_format_errors = False | (Boolean) Make exception message format errors fatal |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| control_exchange = openstack | (String) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| auth_strategy = keystone | (String) The strategy to use for auth. Supports noauth or keystone. |
| Configuration option = Default value | Description |
|---|---|
| [keystone_authtoken] | |
| admin_password = None | (String) Service user password. |
| admin_tenant_name = admin | (String) Service tenant name. |
| admin_token = None | (String) 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. |
| admin_user = None | (String) Service username. |
| auth_admin_prefix = | (String) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri. |
| auth_host = 127.0.0.1 | (String) Host providing the admin Identity API endpoint. Deprecated, use identity_uri. |
| auth_port = 35357 | (Integer) Port of the admin Identity API endpoint. Deprecated, use identity_uri. |
| auth_protocol = https | (String) Protocol of the admin Identity API endpoint. Deprecated, use identity_uri. |
| auth_section = None | (Unknown) Config Section from which to load plugin specific options |
| auth_type = None | (Unknown) Authentication type to load |
| auth_uri = None | (String) Complete public Identity API endpoint. |
| auth_version = None | (String) API version of the admin Identity API endpoint. |
| cache = None | (String) Env key for the swift cache. |
| cafile = None | (String) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. |
| certfile = None | (String) Required if identity server requires client certificate |
| check_revocations_for_cached = False | (Boolean) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server. |
| delay_auth_decision = False | (Boolean) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components. |
| enforce_token_bind = permissive | (String) 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. |
| hash_algorithms = md5 | (List) 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. |
| http_connect_timeout = None | (Integer) Request timeout value for communicating with Identity API server. |
| http_request_max_retries = 3 | (Integer) How many times are we trying to reconnect when communicating with Identity API Server. |
| identity_uri = None | (String) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/ |
| include_service_catalog = True | (Boolean) (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. |
| insecure = False | (Boolean) Verify HTTPS connections. |
| keyfile = None | (String) Required if identity server requires client certificate |
| memcache_pool_conn_get_timeout = 10 | (Integer) (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool. |
| memcache_pool_dead_retry = 300 | (Integer) (Optional) Number of seconds memcached server is considered dead before it is tried again. |
| memcache_pool_maxsize = 10 | (Integer) (Optional) Maximum total number of open connections to every memcached server. |
| memcache_pool_socket_timeout = 3 | (Integer) (Optional) Socket timeout in seconds for communicating with a memcached server. |
| memcache_pool_unused_timeout = 60 | (Integer) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed. |
| memcache_secret_key = None | (String) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation. |
| memcache_security_strategy = None | (String) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. 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. |
| memcache_use_advanced_pool = False | (Boolean) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x. |
| region_name = None | (String) The region in which the identity server can be found. |
| revocation_cache_time = 10 | (Integer) 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. |
| signing_dir = None | (String) Directory used to cache files related to PKI tokens. |
| token_cache_time = 300 | (Integer) 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. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| backup_api_class = cinder.backup.api.API | (String) The full class name of the volume backup API class |
| backup_compression_algorithm = zlib | (String) Compression algorithm (None to disable) |
| backup_driver = cinder.backup.drivers.swift | (String) Driver to use for backups. |
| backup_manager = cinder.backup.manager.BackupManager | (String) Full class name for the Manager for volume backup |
| backup_metadata_version = 2 | (Integer) 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. |
| backup_name_template = backup-%s | (String) Template string to be used to generate backup names |
| backup_object_number_per_notification = 10 | (Integer) The number of chunks or objects, for which one Ceilometer notification will be sent |
| backup_posix_path = $state_path/backup | (String) Path specifying where to store backups. |
| backup_service_inithost_offload = False | (Boolean) Offload pending backup delete during backup service startup. |
| backup_timer_interval = 120 | (Integer) Interval, in seconds, between two progress notifications reporting the backup status |
| backup_topic = cinder-backup | (String) The topic that volume backup nodes listen on |
| backup_use_same_host = False | (Boolean) Backup services use same backend. |
| snapshot_check_timeout = 3600 | (Integer) How long we check whether a snapshot is finished before we give up |
| snapshot_name_template = snapshot-%s | (String) Template string to be used to generate snapshot names |
| snapshot_same_host = True | (Boolean) Create volume from snapshot at the host where snapshot resides |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| available_devices = | (List) List of all available devices |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| allow_availability_zone_fallback = False | (Boolean) If the requested Cinder availability zone is unavailable, fall back to the value of default_availability_zone, then storage_availability_zone, instead of failing. |
| chap_password = | (String) Password for specified CHAP account name. |
| chap_username = | (String) CHAP user name. |
| chiscsi_conf = /etc/chelsio-iscsi/chiscsi.conf | (String) Chiscsi (CXT) global defaults configuration file |
| cinder_internal_tenant_project_id = None | (String) ID of the project which will be used as the Cinder internal tenant. |
| cinder_internal_tenant_user_id = None | (String) ID of the user to be used in volume operations as the Cinder internal tenant. |
| compute_api_class = cinder.compute.nova.API | (String) The full class name of the compute API class to use |
| consistencygroup_api_class = cinder.consistencygroup.api.API | (String) The full class name of the consistencygroup API class |
| default_availability_zone = None | (String) Default availability zone for new volumes. If not set, the storage_availability_zone option value is used as the default for new volumes. |
| default_volume_type = None | (String) Default volume type to use |
| driver_data_namespace = None | (String) Namespace for driver private data values to be saved in. |
| driver_ssl_cert_path = None | (String) Can be used to specify a non default path to a CA_BUNDLE file or directory with certificates of trusted CAs, which will be used to validate the backend |
| driver_ssl_cert_verify = False | (Boolean) If set to True the http client will validate the SSL certificate of the backend endpoint. |
| enable_force_upload = False | (Boolean) Enables the Force option on upload_to_image. This enables running upload_volume on in-use volumes for backends that support it. |
| enable_new_services = True | (Boolean) Services to be added to the available pool on create |
| end_time = None | (String) If this option is specified then the end time specified is used instead of the end time of the last completed audit period. |
| enforce_multipath_for_image_xfer = False | (Boolean) 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. |
| executor_thread_pool_size = 64 | (Integer) Size of executor thread pool. |
| host = localhost | (String) Name of this node. This can be an opaque identifier. It is not necessarily a host name, FQDN, or IP address. |
| iet_conf = /etc/iet/ietd.conf | (String) IET configuration file |
| iscsi_secondary_ip_addresses = | (List) The list of secondary IP addresses of the iSCSI daemon |
| max_over_subscription_ratio = 20.0 | (Floating point) 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. The ratio has to be a minimum of 1.0. |
| memcached_servers = None | (List) Memcached servers or None for in process cache. |
| monkey_patch = False | (Boolean) Enable monkey patching |
| monkey_patch_modules = | (List) List of modules/decorators to monkey patch |
| my_ip = 10.0.0.1 | (String) IP address of this host |
| no_snapshot_gb_quota = False | (Boolean) Whether snapshots count against gigabyte quota |
| num_shell_tries = 3 | (Integer) Number of times to attempt to run flakey shell commands |
| os_privileged_user_auth_url = None | (String) Auth URL associated with the OpenStack privileged account. |
| os_privileged_user_name = None | (String) OpenStack privileged account username. Used for requests to other services (such as Nova) that require an account with special rights. |
| os_privileged_user_password = None | (String) Password associated with the OpenStack privileged account. |
| os_privileged_user_tenant = None | (String) Tenant name associated with the OpenStack privileged account. |
| periodic_fuzzy_delay = 60 | (Integer) Range, in seconds, to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0) |
| periodic_interval = 60 | (Integer) Interval, in seconds, between running periodic tasks |
| replication_api_class = cinder.replication.api.API | (String) The full class name of the volume replication API class |
| replication_device = None | (Unknown) Multi opt of dictionaries to represent a replication target device. This option may be specified multiple times in a single config section to specify multiple replication target devices. Each entry takes the standard dict config form: replication_device = target_device_id:<required>,key1:value1,key2:value2... |
| report_discard_supported = False | (Boolean) Report to clients of Cinder that the backend supports discard (aka. trim/unmap). This will not actually change the behavior of the backend or the client directly, it will only notify that it can be used. |
| report_interval = 10 | (Integer) Interval, in seconds, between nodes reporting state to datastore |
| reserved_percentage = 0 | (Integer) The percentage of backend capacity is reserved |
| rootwrap_config = /etc/cinder/rootwrap.conf | (String) Path to the rootwrap configuration file to use for running commands as root |
| send_actions = False | (Boolean) Send the volume and snapshot create and delete notifications generated in the specified period. |
| service_down_time = 60 | (Integer) Maximum time since last check-in for a service to be considered up |
| ssh_hosts_key_file = $state_path/ssh_known_hosts | (String) File containing SSH host keys for the systems with which Cinder needs to communicate. OPTIONAL: Default=$state_path/ssh_known_hosts |
| start_time = None | (String) If this option is specified then the start time specified is used instead of the start time of the last completed audit period. |
| state_path = /var/lib/cinder | (String) Top-level directory for maintaining cinder’s state |
| storage_availability_zone = nova | (String) Availability zone of this node |
| strict_ssh_host_key_policy = False | (Boolean) 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 |
| suppress_requests_ssl_warnings = False | (Boolean) Suppress requests library SSL certificate warnings. |
| tcp_keepalive = True | (Boolean) Sets the value of TCP_KEEPALIVE (True/False) for each server socket. |
| tcp_keepalive_count = None | (Integer) Sets the value of TCP_KEEPCNT for each server socket. Not supported on OS X. |
| tcp_keepalive_interval = None | (Integer) Sets the value of TCP_KEEPINTVL in seconds for each server socket. Not supported on OS X. |
| until_refresh = 0 | (Integer) Count of reservations until usage is refreshed |
| use_chap_auth = False | (Boolean) Option to enable/disable CHAP authentication for targets. |
| use_forwarded_for = False | (Boolean) Treat X-Forwarded-For as the canonical remote address. Only enable this if you have a sanitizing proxy. |
| watch_log_file = False | (Boolean) 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. |
| [keystone_authtoken] | |
| memcached_servers = None | (List) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| nova_api_insecure = False | (Boolean) Allow to perform insecure SSL requests to nova |
| nova_ca_certificates_file = None | (String) Location of ca certificates file to use for nova client requests. |
| nova_catalog_admin_info = compute:Compute Service:adminURL | (String) Same as nova_catalog_info, but for admin endpoint. |
| nova_catalog_info = compute:Compute Service:publicURL | (String) Match this value when searching for nova in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:<endpoint_type> |
| nova_endpoint_admin_template = None | (String) Same as nova_endpoint_template, but for admin endpoint. |
| nova_endpoint_template = None | (String) Override service catalog lookup with template for nova endpoint e.g. http://localhost:8774/v2/%(project_id)s |
| os_region_name = None | (String) Region name of this node |
| Configuration option = Default value | Description |
|---|---|
| [coordination] | |
| backend_url = file://$state_path | (String) The backend URL to use for distributed coordination. |
| heartbeat = 1.0 | (Floating point) Number of seconds between heartbeats for distributed coordination. |
| initial_reconnect_backoff = 0.1 | (Floating point) Initial number of seconds to wait after failed reconnection. |
| max_reconnect_backoff = 60.0 | (Floating point) Maximum number of seconds between sequential reconnection retries. |
| Configuration option = Default value | Description |
|---|---|
| [cors] | |
| allow_credentials = True | (Boolean) Indicate that the actual request can include user credentials |
| allow_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | (List) Indicate which header field names may be used during the actual request. |
| allow_methods = GET, POST, PUT, DELETE, OPTIONS | (List) Indicate which methods can be used during the actual request. |
| allowed_origin = None | (List) Indicate whether this resource may be shared with the domain received in the requests “origin” header. |
| expose_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | (List) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. |
| max_age = 3600 | (Integer) Maximum cache age of CORS preflight requests. |
| [cors.subdomain] | |
| allow_credentials = True | (Boolean) Indicate that the actual request can include user credentials |
| allow_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | (List) Indicate which header field names may be used during the actual request. |
| allow_methods = GET, POST, PUT, DELETE, OPTIONS | (List) Indicate which methods can be used during the actual request. |
| allowed_origin = None | (List) Indicate whether this resource may be shared with the domain received in the requests “origin” header. |
| expose_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | (List) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. |
| max_age = 3600 | (Integer) Maximum cache age of CORS preflight requests. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| db_driver = cinder.db | (String) Driver to use for database access |
| [database] | |
| backend = sqlalchemy | (String) The back end to use for the database. |
| connection = None | (String) The SQLAlchemy connection string to use to connect to the database. |
| connection_debug = 0 | (Integer) Verbosity of SQL debugging information: 0=None, 100=Everything. |
| connection_trace = False | (Boolean) Add Python stack traces to SQL as comment strings. |
| db_inc_retry_interval = True | (Boolean) If True, increases the interval between retries of a database operation up to db_max_retry_interval. |
| db_max_retries = 20 | (Integer) Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count. |
| db_max_retry_interval = 10 | (Integer) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation. |
| db_retry_interval = 1 | (Integer) Seconds between retries of a database transaction. |
| idle_timeout = 3600 | (Integer) Timeout before idle SQL connections are reaped. |
| max_overflow = 50 | (Integer) If set, use this value for max_overflow with SQLAlchemy. |
| max_pool_size = None | (Integer) Maximum number of SQL connections to keep open in a pool. |
| max_retries = 10 | (Integer) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. |
| min_pool_size = 1 | (Integer) Minimum number of SQL connections to keep open in a pool. |
| mysql_sql_mode = TRADITIONAL | (String) 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= |
| pool_timeout = None | (Integer) If set, use this value for pool_timeout with SQLAlchemy. |
| retry_interval = 10 | (Integer) Interval between retries of opening a SQL connection. |
| slave_connection = None | (String) The SQLAlchemy connection string to use to connect to the slave database. |
| sqlite_db = oslo.sqlite | (String) The file name to use with SQLite. |
| sqlite_synchronous = True | (Boolean) If True, SQLite uses synchronous mode. |
| use_db_reconnect = False | (Boolean) Enable the experimental use of database reconnect on connection lost. |
| use_tpool = False | (Boolean) Enable the experimental use of thread pooling for all DB API calls |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| trace_flags = None | (List) List of options that control which trace info is written to the DEBUG log level to assist developers. Valid values are method and api. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| drbdmanage_devs_on_controller = True | (Boolean) If set, the c-vol node will receive a useable /dev/drbdX device, even if the actual data is stored on other nodes only. This is useful for debugging, maintenance, and to be able to do the iSCSI export from the c-vol node. |
| drbdmanage_redundancy = 1 | (Integer) Number of nodes that should replicate the data. |
| drbdmanage_resize_plugin = drbdmanage.plugins.plugins.wait_for.WaitForVolumeSize | (String) Volume resize completion wait plugin. |
| drbdmanage_resize_policy = {"timeout": "60"} | (String) Volume resize completion wait policy. |
| drbdmanage_resource_plugin = drbdmanage.plugins.plugins.wait_for.WaitForResource | (String) Resource deployment completion wait plugin. |
| drbdmanage_resource_policy = {"ratio": "0.51", "timeout": "60"} | (String) Resource deployment completion wait policy. |
| drbdmanage_snapshot_plugin = drbdmanage.plugins.plugins.wait_for.WaitForSnapshot | (String) Snapshot completion wait plugin. |
| drbdmanage_snapshot_policy = {"count": "1", "timeout": "60"} | (String) Snapshot completion wait policy. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| check_max_pool_luns_threshold = False | (Boolean) Report free_capacity_gb as 0 when the limit to maximum number of pool LUNs is reached. By default, the value is False. |
| cinder_emc_config_file = /etc/cinder/cinder_emc_config.xml | (String) use this file for cinder emc plugin config data |
| destroy_empty_storage_group = False | (Boolean) To destroy storage group when the last LUN is removed from it. By default, the value is False. |
| force_delete_lun_in_storagegroup = False | (Boolean) Delete a LUN even if it is in Storage Groups. |
| initiator_auto_deregistration = False | (Boolean) Automatically deregister initiators after the related storage group is destroyed. By default, the value is False. |
| initiator_auto_registration = False | (Boolean) Automatically register initiators. By default, the value is False. |
| io_port_list = * | (String) Comma separated iSCSI or FC ports to be used in Nova or Cinder. |
| iscsi_initiators = | (String) Mapping between hostname and its iSCSI initiator IP addresses. |
| max_luns_per_storage_group = 255 | (Integer) Default max number of LUNs in a storage group. By default, the value is 255. |
| naviseccli_path = | (String) Naviseccli Path. |
| storage_vnx_authentication_type = global | (String) VNX authentication scope type. |
| storage_vnx_pool_names = None | (String) Comma-separated list of storage pool names to be used. |
| storage_vnx_security_file_dir = None | (String) Directory path that contains the VNX security file. Make sure the security file is generated first. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| cinder_eternus_config_file = /etc/cinder/cinder_fujitsu_eternus_dx.xml | (String) config file for cinder eternus_dx volume driver |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| flashsystem_connection_protocol = FC | (String) Connection protocol should be FC. (Default is FC.) |
| flashsystem_iscsi_portid = 0 | (Integer) Default iSCSI Port ID of FlashSystem. (Default port is 0.) |
| flashsystem_multihostmap_enabled = True | (Boolean) Allows vdisk to multi host mapping. (Default is True) |
| flashsystem_multipath_enabled = False | (Boolean) DEPRECATED: This option no longer has any affect. It is deprecated and will be removed in the next release. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| hgst_net = Net 1 (IPv4) | (String) Space network name to use for data transfer |
| hgst_redundancy = 0 | (String) Should spaces be redundantly stored (1/0) |
| hgst_space_group = disk | (String) Group to own created spaces |
| hgst_space_mode = 0600 | (String) UNIX mode for created spaces |
| hgst_space_user = root | (String) User to own created spaces |
| hgst_storage_servers = os:gbd0 | (String) Comma separated list of Space storage servers:devices. ex: os1_stor:gbd0,os2_stor:gbd0 |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| hpelefthand_api_url = None | (String) HPE LeftHand WSAPI Server Url like https://<LeftHand ip>:8081/lhos |
| hpelefthand_clustername = None | (String) HPE LeftHand cluster name |
| hpelefthand_debug = False | (Boolean) Enable HTTP debugging to LeftHand |
| hpelefthand_iscsi_chap_enabled = False | (Boolean) Configure CHAP authentication for iSCSI connections (Default: Disabled) |
| hpelefthand_password = None | (String) HPE LeftHand Super user password |
| hpelefthand_ssh_port = 16022 | (Port number) Port number of SSH service. |
| hpelefthand_username = None | (String) HPE LeftHand Super user username |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| hpexp_async_copy_check_interval = 10 | (Integer) Interval to check copy asynchronously |
| hpexp_compute_target_ports = None | (List) Target port names of compute node for host group or iSCSI target |
| hpexp_copy_check_interval = 3 | (Integer) Interval to check copy |
| hpexp_copy_speed = 3 | (Integer) Copy speed of storage system |
| hpexp_default_copy_method = FULL | (String) Default copy method of storage system. There are two valid values: “FULL” specifies that a full copy; “THIN” specifies that a thin copy. Default value is “FULL” |
| hpexp_group_request = False | (Boolean) Request for creating host group or iSCSI target |
| hpexp_horcm_add_conf = True | (Boolean) Add to HORCM configuration |
| hpexp_horcm_name_only_discovery = False | (Boolean) Only discover a specific name of host group or iSCSI target |
| hpexp_horcm_numbers = 200, 201 | (List) Instance numbers for HORCM |
| hpexp_horcm_resource_name = meta_resource | (String) Resource group name of storage system for HORCM |
| hpexp_horcm_user = None | (String) Username of storage system for HORCM |
| hpexp_ldev_range = None | (String) Logical device range of storage system |
| hpexp_pool = None | (String) Pool of storage system |
| hpexp_storage_cli = None | (String) Type of storage command line interface |
| hpexp_storage_id = None | (String) ID of storage system |
| hpexp_target_ports = None | (List) Target port names for host group or iSCSI target |
| hpexp_thin_pool = None | (String) Thin pool of storage system |
| hpexp_zoning_request = False | (Boolean) Request for FC Zone creating host group |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| cinder_huawei_conf_file = /etc/cinder/cinder_huawei_conf.xml | (String) The configuration file for the Cinder Huawei driver. |
| hypermetro_devices = None | (String) The remote device hypermetro will use. |
| Configuration option = Default value | Description |
|---|---|
| [hyperv] | |
| force_volumeutils_v1 = False | (Boolean) DEPRECATED: Force V1 volume utility class |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| allowed_direct_url_schemes = | (List) A list of url schemes that can be downloaded directly via the direct_url. Currently supported schemes: [file]. |
| glance_api_insecure = False | (Boolean) Allow to perform insecure SSL (https) requests to glance |
| glance_api_servers = None | (List) A list of the URLs of glance API servers available to cinder ([http[s]://][hostname|ip]:port). If protocol is not specified it defaults to http. |
| glance_api_ssl_compression = False | (Boolean) 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. |
| glance_api_version = 1 | (Integer) Version of the glance API to use |
| glance_ca_certificates_file = None | (String) Location of ca certificates file to use for glance client requests. |
| glance_catalog_info = image:glance:publicURL | (String) Info to match when looking for glance in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:<endpoint_type> - Only used if glance_api_servers are not provided. |
| glance_core_properties = checksum, container_format, disk_format, image_name, image_id, min_disk, min_ram, name, size | (List) Default core properties of image |
| glance_num_retries = 0 | (Integer) Number retries when downloading an image from glance |
| glance_request_timeout = None | (Integer) http/https timeout value for glance operations. If no value (None) is supplied here, the glanceclient default value is used. |
| image_conversion_dir = $state_path/conversion | (String) Directory used for temporary storage during image conversion |
| image_upload_use_cinder_backend = False | (Boolean) If set to True, upload-to-image in raw format will create a cloned volume and register its location to the image service, instead of uploading the volume content. The cinder backend and locations support must be enabled in the image service, and glance_api_version must be set to 2. |
| image_upload_use_internal_tenant = False | (Boolean) If set to True, the image volume created by upload-to-image will be placed in the internal tenant. Otherwise, the image volume is created in the current context’s tenant. |
| image_volume_cache_enabled = False | (Boolean) Enable the image volume cache for this backend. |
| image_volume_cache_max_count = 0 | (Integer) Max number of entries allowed in the image volume cache. 0 => unlimited. |
| image_volume_cache_max_size_gb = 0 | (Integer) Max size of the image volume cache for this backend in GB. 0 => unlimited. |
| use_multipath_for_image_xfer = False | (Boolean) Do we attach/detach volumes in cinder using multipath for volume to image and image to volume transfers? |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| infortrend_cli_max_retries = 5 | (Integer) Maximum retry time for cli. Default is 5. |
| infortrend_cli_path = /opt/bin/Infortrend/raidcmd_ESDS10.jar | (String) The Infortrend CLI absolute path. By default, it is at /opt/bin/Infortrend/raidcmd_ESDS10.jar |
| infortrend_cli_timeout = 30 | (Integer) Default timeout for CLI copy operations in minutes. Support: migrate volume, create cloned volume and create volume from snapshot. By Default, it is 30 minutes. |
| infortrend_pools_name = | (String) Infortrend raid pool name list. It is separated with comma. |
| infortrend_provisioning = full | (String) Let the volume use specific provisioning. By default, it is the full provisioning. The supported options are full or thin. |
| infortrend_slots_a_channels_id = 0,1,2,3,4,5,6,7 | (String) Infortrend raid channel ID list on Slot A for OpenStack usage. It is separated with comma. By default, it is the channel 0~7. |
| infortrend_slots_b_channels_id = 0,1,2,3,4,5,6,7 | (String) Infortrend raid channel ID list on Slot B for OpenStack usage. It is separated with comma. By default, it is the channel 0~7. |
| infortrend_tiering = 0 | (String) Let the volume use specific tiering level. By default, it is the level 0. The supported levels are 0,2,3,4. |
| Configuration option = Default value | Description |
|---|---|
| [keymgr] | |
| api_class = cinder.keymgr.conf_key_mgr.ConfKeyManager | (String) The full class name of the key manager API class |
| encryption_api_url = http://localhost:9311/v1 | (String) Url for encryption service. |
| encryption_auth_url = http://localhost:5000/v3 | (String) Authentication url for encryption service. |
| fixed_key = None | (String) Fixed key returned by key manager, specified in hex |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| debug = False | (Boolean) If set to true, the logging level will be set to DEBUG instead of the default INFO level. |
| 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, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN, taskflow=WARN, keystoneauth=WARN, oslo.cache=INFO, dogpile.core.dogpile=INFO | (List) List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set. |
| fatal_deprecations = False | (Boolean) Enables or disables fatal status of deprecations. |
| fatal_exception_format_errors = False | (Boolean) Make exception message format errors fatal. |
| instance_format = "[instance: %(uuid)s] " | (String) The format for an instance that is passed with the log message. |
| instance_uuid_format = "[instance: %(uuid)s] " | (String) The format for an instance UUID that is passed with the log message. |
| log_config_append = None | (String) 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. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, logging_context_format_string). |
| log_date_format = %Y-%m-%d %H:%M:%S | (String) Defines the format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. |
| log_dir = None | (String) (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set. |
| log_file = None | (String) (Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set. |
| logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s | (String) Format string to use for log messages with context. |
| logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d | (String) Additional data to append to log message when logging level for the message is DEBUG. |
| logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s | (String) Format string to use for log messages when context is undefined. |
| logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s | (String) Prefix each line of exception output with this format. |
| logging_user_identity_format = %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s | (String) Defines the format string for %(user_identity)s that is used in logging_context_format_string. |
| publish_errors = False | (Boolean) Enables or disables publication of error events. |
| syslog_log_facility = LOG_USER | (String) Syslog facility to receive log lines. This option is ignored if log_config_append is set. |
| use_stderr = True | (Boolean) Log output to standard error. This option is ignored if log_config_append is set. |
| use_syslog = False | (Boolean) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. |
| verbose = True | (Boolean) DEPRECATED: If set to false, the logging level will be set to WARNING instead of the default INFO level. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| nas_ip = | (String) IP address or Hostname of NAS system. |
| nas_login = admin | (String) User name to connect to NAS system. |
| nas_mount_options = None | (String) Options used to mount the storage backend file system where Cinder volumes are stored. |
| nas_password = | (String) Password to connect to NAS system. |
| nas_private_key = | (String) Filename of private key to use for SSH authentication. |
| nas_secure_file_operations = auto | (String) 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. |
| nas_secure_file_permissions = auto | (String) 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. |
| nas_share_path = | (String) Path to the share to use for storing Cinder volumes. For example: “/srv/export1” for an NFS server export available at 10.0.5.10:/srv/export1 . |
| nas_ssh_port = 22 | (Port number) SSH port to use to connect to NAS system. |
| Configuration option = Default value | Description |
|---|---|
| [profiler] | |
| enabled = False | (Boolean) Enables the profiling for all services on this node. Default value is False (fully disable the profiling feature). Possible values: * True: Enables the feature * False: Disables the feature. The profiling cannot be started via this project operations. If the profiling is triggered by another project, this project part will be empty. |
| hmac_keys = SECRET_KEY | (String) Secret key(s) to use for encrypting context data for performance profiling. This string value should have the following format: <key1>[,<key2>,...<keyn>], where each key is some random string. A user who triggers the profiling via the REST API has to set one of these keys in the headers of the REST API call to include profiling results of this node for this particular project. Both “enabled” flag and “hmac_keys” config options should be set to enable profiling. Also, to generate correct profiling information across all services at least one key needs to be consistent between OpenStack projects. This ensures it can be used from client side to generate the trace, containing information from all possible resources. |
| trace_sqlalchemy = False | (Boolean) Enables SQL requests profiling in services. Default value is False (SQL requests won’t be traced). Possible values: * True: Enables SQL requests profiling. Each SQL query will be part of the trace and can the be analyzed by how much time was spent for that. * False: Disables SQL requests profiling. The spent time is only shown on a higher level of operations. Single SQL queries cannot be analyzed this way. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| pure_api_token = None | (String) REST API authorization token. |
| pure_automatic_max_oversubscription_ratio = True | (Boolean) Automatically determine an oversubscription ratio based on the current total data reduction values. If used this calculated value will override the max_over_subscription_ratio config option. |
| pure_eradicate_on_delete = False | (Boolean) When enabled, all Pure volumes, snapshots, and protection groups will be eradicated at the time of deletion in Cinder. Data will NOT be recoverable after a delete with this set to True! When disabled, volumes and snapshots will go into pending eradication state and can be recovered. |
| pure_replica_interval_default = 900 | (Integer) Snapshot replication interval in seconds. |
| pure_replica_retention_long_term_default = 7 | (Integer) Retain snapshots per day on target for this time (in days.) |
| pure_replica_retention_long_term_per_day_default = 3 | (Integer) Retain how many snapshots for each day. |
| pure_replica_retention_short_term_default = 14400 | (Integer) Retain all snapshots on target for this time (in seconds.) |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| max_age = 0 | (Integer) Number of seconds between subsequent usage refreshes |
| quota_backup_gigabytes = 1000 | (Integer) Total amount of storage, in gigabytes, allowed for backups per project |
| quota_backups = 10 | (Integer) Number of volume backups allowed per project |
| quota_consistencygroups = 10 | (Integer) Number of consistencygroups allowed per project |
| quota_driver = cinder.quota.DbQuotaDriver | (String) Default driver to use for quota checks |
| quota_gigabytes = 1000 | (Integer) Total amount of storage, in gigabytes, allowed for volumes and snapshots per project |
| quota_snapshots = 10 | (Integer) Number of volume snapshots allowed per project |
| quota_volumes = 10 | (Integer) Number of volumes allowed per project |
| reservation_expire = 86400 | (Integer) Number of seconds until a reservation expires |
| use_default_quota_class = True | (Boolean) Enables or disables use of default quota class with default quota. |
| Configuration option = Default value | Description |
|---|---|
| [oslo_messaging_rabbit] | |
| amqp_auto_delete = False | (Boolean) Auto-delete queues in AMQP. |
| amqp_durable_queues = False | (Boolean) Use durable queues in AMQP. |
| channel_max = None | (Integer) Maximum number of channels to allow |
| default_notification_exchange = ${control_exchange}_notification | (String) Exchange name for for sending notifications |
| default_notification_retry_attempts = -1 | (Integer) Reconnecting retry count in case of connectivity problem during sending notification, -1 means infinite retry. |
| default_rpc_exchange = ${control_exchange}_rpc | (String) Exchange name for sending RPC messages |
| default_rpc_retry_attempts = -1 | (Integer) Reconnecting retry count in case of connectivity problem during sending RPC message, -1 means infinite retry. If actual retry attempts in not 0 the rpc request could be processed more then one time |
| fake_rabbit = False | (Boolean) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake |
| frame_max = None | (Integer) The maximum byte size for an AMQP frame |
| heartbeat_interval = 1 | (Integer) How often to send heartbeats for consumer’s connections |
| heartbeat_rate = 2 | (Integer) How often times during the heartbeat_timeout_threshold we check the heartbeat. |
| heartbeat_timeout_threshold = 60 | (Integer) Number of seconds after which the Rabbit broker is considered down if heartbeat’s keep-alive fails (0 disable the heartbeat). EXPERIMENTAL |
| host_connection_reconnect_delay = 0.25 | (Floating point) Set delay for reconnection to some host which has connection error |
| kombu_compression = None | (String) EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not be used. This option may notbe available in future versions. |
| kombu_failover_strategy = round-robin | (String) Determines how the next RabbitMQ node is chosen in case the one we are currently connected to becomes unavailable. Takes effect only if more than one RabbitMQ node is provided in config. |
| kombu_missing_consumer_retry_timeout = 60 | (Integer) How long to wait a missing client beforce abandoning to send it its replies. This value should not be longer than rpc_response_timeout. |
| kombu_reconnect_delay = 1.0 | (Floating point) How long to wait before reconnecting in response to an AMQP consumer cancel notification. |
| kombu_ssl_ca_certs = | (String) SSL certification authority file (valid only if SSL enabled). |
| kombu_ssl_certfile = | (String) SSL cert file (valid only if SSL enabled). |
| kombu_ssl_keyfile = | (String) SSL key file (valid only if SSL enabled). |
| kombu_ssl_version = | (String) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions. |
| notification_listener_prefetch_count = 100 | (Integer) Max number of not acknowledged message which RabbitMQ can send to notification listener. |
| notification_persistence = False | (Boolean) Persist notification messages. |
| notification_retry_delay = 0.25 | (Floating point) Reconnecting retry delay in case of connectivity problem during sending notification message |
| pool_max_overflow = 0 | (Integer) Maximum number of connections to create above pool_max_size. |
| pool_max_size = 10 | (Integer) Maximum number of connections to keep queued. |
| pool_recycle = 600 | (Integer) Lifetime of a connection (since creation) in seconds or None for no recycling. Expired connections are closed on acquire. |
| pool_stale = 60 | (Integer) Threshold at which inactive (since release) connections are considered stale in seconds or None for no staleness. Stale connections are closed on acquire. |
| pool_timeout = 30 | (Integer) Default number of seconds to wait for a connections to available |
| rabbit_ha_queues = False | (Boolean) Try to use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. In RabbitMQ 3.0, queue mirroring is no longer controlled by the x-ha-policy argument when declaring a queue. If you just want to make sure that all queues (except those with auto-generated names) are mirrored across all nodes, run: “rabbitmqctl set_policy HA ‘^(?!amq.).*’ ‘{“ha-mode”: “all”}’ “ |
| rabbit_host = localhost | (String) The RabbitMQ broker address where a single node is used. |
| rabbit_hosts = $rabbit_host:$rabbit_port | (List) RabbitMQ HA cluster host:port pairs. |
| rabbit_interval_max = 30 | (Integer) Maximum interval of RabbitMQ connection retries. Default is 30 seconds. |
| rabbit_login_method = AMQPLAIN | (String) The RabbitMQ login method. |
| rabbit_max_retries = 0 | (Integer) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). |
| rabbit_password = guest | (String) The RabbitMQ password. |
| rabbit_port = 5672 | (Port number) The RabbitMQ broker port where a single node is used. |
| rabbit_qos_prefetch_count = 0 | (Integer) Specifies the number of messages to prefetch. Setting to zero allows unlimited messages. |
| rabbit_retry_backoff = 2 | (Integer) How long to backoff for between retries when connecting to RabbitMQ. |
| rabbit_retry_interval = 1 | (Integer) How frequently to retry connecting with RabbitMQ. |
| rabbit_transient_queues_ttl = 1800 | (Integer) Positive integer representing duration in seconds for queue TTL (x-expires). Queues which are unused for the duration of the TTL are automatically deleted. The parameter affects only reply and fanout queues. |
| rabbit_use_ssl = False | (Boolean) Connect over SSL for RabbitMQ. |
| rabbit_userid = guest | (String) The RabbitMQ userid. |
| rabbit_virtual_host = / | (String) The RabbitMQ virtual host. |
| Configuration option = Default value | Description |
|---|---|
| [matchmaker_redis] | |
| check_timeout = 20000 | (Integer) Time in ms to wait before the transaction is killed. |
| host = 127.0.0.1 | (String) Host to locate redis. |
| password = | (String) Password for Redis server (optional). |
| port = 6379 | (Port number) Use this port to connect to redis host. |
| sentinel_group_name = oslo-messaging-zeromq | (String) Redis replica set name. |
| sentinel_hosts = | (List) List of Redis Sentinel hosts (fault tolerance mode) e.g. [host:port, host1:port ... ] |
| socket_timeout = 1000 | (Integer) Timeout in ms on blocking socket operations |
| wait_timeout = 500 | (Integer) Time in ms to wait between connection attempts. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| rpc_backend = rabbit | (String) The messaging driver to use, defaults to rabbit. Other drivers include amqp and zmq. |
| rpc_cast_timeout = -1 | (Integer) Seconds to wait before a cast expires (TTL). The default value of -1 specifies an infinite linger period. The value of 0 specifies no linger period. Pending messages shall be discarded immediately when the socket is closed. Only supported by impl_zmq. |
| rpc_conn_pool_size = 30 | (Integer) Size of RPC connection pool. |
| rpc_poll_timeout = 1 | (Integer) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. |
| rpc_response_timeout = 60 | (Integer) Seconds to wait for a response from a call. |
| volume_topic = cinder-volume | (String) The topic that volume nodes listen on |
| [oslo_concurrency] | |
| disable_process_locking = False | (Boolean) Enables or disables inter-process locks. |
| lock_path = None | (String) Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If external locks are used, a lock path must be set. |
| [oslo_messaging_amqp] | |
| allow_insecure_clients = False | (Boolean) Accept clients using either SSL or plain TCP |
| broadcast_prefix = broadcast | (String) address prefix used when broadcasting to all servers |
| container_name = None | (String) Name for the AMQP container |
| group_request_prefix = unicast | (String) address prefix when sending to any server in group |
| idle_timeout = 0 | (Integer) Timeout for inactive connections (in seconds) |
| password = | (String) Password for message broker authentication |
| sasl_config_dir = | (String) Path to directory that contains the SASL configuration |
| sasl_config_name = | (String) Name of configuration file (without .conf suffix) |
| sasl_mechanisms = | (String) Space separated list of acceptable SASL mechanisms |
| server_request_prefix = exclusive | (String) address prefix used when sending to a specific server |
| ssl_ca_file = | (String) CA certificate PEM file to verify server certificate |
| ssl_cert_file = | (String) Identifying certificate PEM file to present to clients |
| ssl_key_file = | (String) Private key PEM file used to sign cert_file certificate |
| ssl_key_password = None | (String) Password for decrypting ssl_key_file (if encrypted) |
| trace = False | (Boolean) Debug: dump AMQP frames to stdout |
| username = | (String) User name for message broker authentication |
| [oslo_messaging_notifications] | |
| driver = [] | (Multi-valued) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop |
| topics = notifications | (List) AMQP topic used for OpenStack notifications. |
| transport_url = None | (String) 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. |
| [oslo_messaging_rabbit] | |
| rpc_listener_prefetch_count = 100 | (Integer) Max number of not acknowledged message which RabbitMQ can send to rpc listener. |
| rpc_queue_expiration = 60 | (Integer) Time to live for rpc queues without consumers in seconds. |
| rpc_reply_exchange = ${control_exchange}_rpc_reply | (String) Exchange name for receiving RPC replies |
| rpc_reply_listener_prefetch_count = 100 | (Integer) Max number of not acknowledged message which RabbitMQ can send to rpc reply listener. |
| rpc_reply_retry_attempts = -1 | (Integer) Reconnecting retry count in case of connectivity problem during sending reply. -1 means infinite retry during rpc_timeout |
| rpc_reply_retry_delay = 0.25 | (Floating point) Reconnecting retry delay in case of connectivity problem during sending reply. |
| rpc_retry_delay = 0.25 | (Floating point) Reconnecting retry delay in case of connectivity problem during sending RPC message |
| socket_timeout = 0.25 | (Floating point) Set socket timeout in seconds for connection’s socket |
| ssl = None | (Boolean) Enable SSL |
| ssl_options = None | (Dict) Arguments passed to ssl.wrap_socket |
| tcp_user_timeout = 0.25 | (Floating point) Set TCP_USER_TIMEOUT in seconds for connection’s socket |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| san_clustername = | (String) Cluster name to use for creating volumes |
| san_ip = | (String) IP address of SAN controller |
| san_is_local = False | (Boolean) Execute commands locally instead of over SSH; use if the volume service is running on the SAN device |
| san_login = admin | (String) Username for SAN controller |
| san_password = | (String) Password for SAN controller |
| san_private_key = | (String) Filename of private key to use for SSH authentication |
| san_secondary_ip = None | (String) VNX secondary SP IP Address. |
| san_ssh_port = 22 | (Port number) SSH port to use with SAN |
| san_thin_provision = True | (Boolean) Use thin provisioning for SAN volumes? |
| ssh_conn_timeout = 30 | (Integer) SSH connection timeout in seconds |
| ssh_max_pool_conn = 5 | (Integer) Maximum ssh connections in the pool |
| ssh_min_pool_conn = 1 | (Integer) Minimum ssh connections in the pool |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| filter_function = None | (String) String representation for an equation that will be used to filter hosts. Only used when the driver filter is set to be used by the Cinder scheduler. |
| goodness_function = None | (String) String representation for an equation that will be used to determine the goodness of a host. Only used when using the goodness weigher is set to be used by the Cinder scheduler. |
| scheduler_default_filters = AvailabilityZoneFilter, CapacityFilter, CapabilitiesFilter | (List) Which filter class names to use for filtering hosts when not specified in the request. |
| scheduler_default_weighers = CapacityWeigher | (List) Which weigher class names to use for weighing hosts. |
| scheduler_driver = cinder.scheduler.filter_scheduler.FilterScheduler | (String) Default scheduler driver to use |
| scheduler_host_manager = cinder.scheduler.host_manager.HostManager | (String) The scheduler host manager class to use |
| scheduler_json_config_location = | (String) Absolute path to scheduler configuration JSON file. |
| scheduler_manager = cinder.scheduler.manager.SchedulerManager | (String) Full class name for the Manager for scheduler |
| scheduler_max_attempts = 3 | (Integer) Maximum number of attempts to schedule a volume |
| scheduler_topic = cinder-scheduler | (String) The topic that scheduler nodes listen on |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| scst_target_driver = iscsi | (String) SCST target implementation can choose from multiple SCST target drivers. |
| scst_target_iqn_name = None | (String) Certain ISCSI targets have predefined target names, SCST target driver uses this name. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| allocated_capacity_weight_multiplier = -1.0 | (Floating point) Multiplier used for weighing allocated capacity. Positive numbers mean to stack vs spread. |
| capacity_weight_multiplier = 1.0 | (Floating point) Multiplier used for weighing free capacity. Negative numbers mean to stack vs spread. |
| enabled_backends = None | (List) A list of backend names to use. These backend names should be backed by a unique [CONFIG] group with its options |
| iscsi_helper = tgtadm | (String) iSCSI target user-land tool to use. tgtadm is default, use lioadm for LIO iSCSI support, scstadmin for SCST target support, iseradm for the ISER protocol, ietadm for iSCSI Enterprise Target, iscsictl for Chelsio iSCSI Target or fake for testing. |
| iscsi_iotype = fileio | (String) 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 |
| iscsi_ip_address = $my_ip | (String) The IP address that the iSCSI daemon is listening on |
| iscsi_port = 3260 | (Port number) The port that the iSCSI daemon is listening on |
| iscsi_protocol = iscsi | (String) Determines the iSCSI protocol for new iSCSI volumes, created with tgtadm or lioadm target helpers. In order to enable RDMA, this parameter should be set with the value “iser”. The supported iSCSI protocol values are “iscsi” and “iser”. |
| iscsi_target_flags = | (String) Sets the target-specific flags for the iSCSI target. Only used for tgtadm to specify backing device flags using bsoflags option. The specified string is passed as is to the underlying tool. |
| iscsi_target_prefix = iqn.2010-10.org.openstack: | (String) Prefix for iSCSI volumes |
| iscsi_write_cache = on | (String) 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. |
| iser_helper = tgtadm | (String) The name of the iSER target user-land tool to use |
| iser_ip_address = $my_ip | (String) The IP address that the iSER daemon is listening on |
| iser_port = 3260 | (Port number) The port that the iSER daemon is listening on |
| iser_target_prefix = iqn.2010-10.org.openstack: | (String) Prefix for iSER volumes |
| migration_create_volume_timeout_secs = 300 | (Integer) Timeout for creating the volume to migrate to when performing volume migration (seconds) |
| num_iser_scan_tries = 3 | (Integer) The maximum number of times to rescan iSER targetto find volume |
| num_volume_device_scan_tries = 3 | (Integer) The maximum number of times to rescan targets to find volume |
| volume_backend_name = None | (String) The backend name for a given driver implementation |
| volume_clear = zero | (String) Method used to wipe old volumes |
| volume_clear_ionice = None | (String) 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. |
| volume_clear_size = 0 | (Integer) Size in MiB to wipe at start of old volumes. 0 => all |
| volume_copy_blkio_cgroup_name = cinder-volume-copy | (String) The blkio cgroup name to be used to limit bandwidth of volume copy |
| volume_copy_bps_limit = 0 | (Integer) The upper limit of bandwidth of volume copy. 0 => unlimited |
| volume_dd_blocksize = 1M | (String) The default block size used when copying/clearing volumes |
| volume_driver = cinder.volume.drivers.lvm.LVMVolumeDriver | (String) Driver to use for volume creation |
| volume_manager = cinder.volume.manager.VolumeManager | (String) Full class name for the Manager for volume |
| volume_service_inithost_offload = False | (Boolean) Offload pending volume delete during volume service startup |
| volume_usage_audit_period = month | (String) Time period for which to generate volume usages. The options are hour, day, month, or year. |
| volumes_dir = $state_path/volumes | (String) Volume configuration file storage directory |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| tegile_default_pool = None | (String) Create volumes in this pool |
| tegile_default_project = None | (String) Create volumes in this project |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| vzstorage_mount_options = None | (List) Mount options passed to the vzstorage client. See section of the pstorage-mount man page for details. |
| vzstorage_mount_point_base = $state_path/mnt | (String) Base dir containing mount points for vzstorage shares. |
| vzstorage_shares_config = /etc/cinder/vzstorage_shares | (String) File with the list of available vzstorage shares. |
| vzstorage_sparsed_volumes = True | (Boolean) 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. |
| vzstorage_used_ratio = 0.95 | (Floating point) Percent of ACTUAL usage of the underlying volume before no new volumes can be allocated to the volume destination. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| rpc_zmq_bind_address = * | (String) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The “host” option should point or resolve to this address. |
| rpc_zmq_bind_port_retries = 100 | (Integer) Number of retries to find free port number before fail with ZMQBindError. |
| rpc_zmq_concurrency = eventlet | (String) Type of concurrency used. Either “native” or “eventlet” |
| rpc_zmq_contexts = 1 | (Integer) Number of ZeroMQ contexts, defaults to 1. |
| rpc_zmq_host = localhost | (String) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match “host” option, if running Nova. |
| rpc_zmq_ipc_dir = /var/run/openstack | (String) Directory for holding IPC sockets. |
| rpc_zmq_matchmaker = redis | (String) MatchMaker driver. |
| rpc_zmq_max_port = 65536 | (Integer) Maximal port number for random ports range. |
| rpc_zmq_min_port = 49152 | (Port number) Minimal port number for random ports range. |
| rpc_zmq_topic_backlog = None | (Integer) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. |
| use_pub_sub = True | (Boolean) Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy. |
| zmq_target_expire = 120 | (Integer) Expiration timeout in seconds of a name service record about existing target ( < 0 means no timeout). |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| cloned_volume_same_az = True | (Boolean) Ensure that the new volumes are the same AZ as snapshot or source volume |
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.