Chapter 2. cinder
The following chapter contains information about the configuration options in the cinder service.
2.1. cinder.conf
This section contains options for the /etc/cinder/cinder.conf file.
2.1.1. DEFAULT
The following table outlines the options available under the [DEFAULT] group in the /etc/cinder/cinder.conf file.
.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| integer value | When volume copy task is going on,refresh volume status interval |
|
| boolean value | Enable to allow volumes attaching to multiple hosts with no limit. |
|
| list value | Comma separated list of storage system storage pools for volumes. |
|
| floating point value | Multiplier used for weighing allocated capacity. Positive numbers mean to stack vs spread. |
|
| boolean value | If the requested Cinder availability zone is unavailable, fall back to the value of default_availability_zone, then storage_availability_zone, instead of failing. |
|
| boolean value | The strategy to use for image compression on upload. Default is disallow compression. |
|
| list value | A list of url schemes that can be downloaded directly via the direct_url. Currently supported schemes: [file, cinder]. |
|
| boolean value | Specify whether to use SSL or not when accessing the composer APIs |
|
| string value | File name for the paste.deploy config for api service |
|
| boolean value | Enables or disables rate limit of the API. |
|
| list value | The Storage Pools Cinder should use, a comma separated list. |
|
| string value | The pool which is used as a meta pool when creating a volume, and it should be a replication pool at present. If not set, the driver will choose a replication pool from the value of as13000_ipsan_pools. |
|
| integer value | The effective time of token validity in seconds. |
|
| string value | The strategy to use for auth. Supports noauth, noauth_include_project_id or keystone. |
|
| integer value | Cache volume availability zones in memory for the provided duration in seconds |
|
| string value | 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. |
|
| string value | Enable eventlet backdoor, using the provided path as a unix socket that can receive connections. This option is mutually exclusive with backdoor_port in that only one should be provided. If both are provided then the existence of this option overrides the usage of that option. Inside the path {pid} will be replaced with the PID of the current process. |
|
| string value | Availability zone for this volume backend. If not set, the storage_availability_zone option value is used as the default for all backends. |
|
| integer value | Time in seconds between requests for usage statistics from the backend. Be aware that generating usage statistics is expensive for some backends, so setting this value too low may adversely affect performance. |
|
| string value | The full class name of the volume backup API class |
|
| integer value | The chunk size, in bytes, that a backup is broken into before transfer to the Ceph object store. |
|
| string value | Ceph configuration file to use. |
|
| boolean value | If True, apply JOURNALING and EXCLUSIVE_LOCK feature bits to the backup RBD objects to allow mirroring |
|
| string value | The Ceph pool where volume backups are stored. |
|
| integer value | RBD stripe count to use when creating a backup image. |
|
| integer value | RBD stripe unit to use when creating a backup image. |
|
| string value | 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. |
|
| string value | Compression algorithm for backups (none to disable) |
|
| string value | Custom directory to use for backups. |
|
| string value | Driver to use for backups. |
|
| integer value | Time in seconds between checks to see if the backup driver has been successfully initialized, any time the driver is restarted. |
|
| integer value | Time in seconds between checks of the backup driver status. If does not report as working, it is restarted. |
|
| boolean value | Enable or Disable the timer to send the periodic progress notifications to Ceilometer when backing up the volume to the backend storage. The default value is True to enable the timer. |
|
| integer value | The maximum size in bytes of the files used to hold backups. If the volume being backed up exceeds this size, then it will be backed up into multiple files. backup_file_size also determines the buffer size used to build backup files, so should be scaled according to available RAM and number of workers. backup_file_size must be a multiple of backup_sha_block_size_bytes. |
|
| string value | Full class name for the Manager for volume backup |
|
| integer value | Maximum number of concurrent memory heavy operations: backup and restore. Value of 0 means unlimited |
|
| integer value | 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. |
|
| integer value | The number of attempts to mount NFS shares before raising an error. |
|
| string value | Mount options passed to the NFS client. See NFS man page for details. |
|
| string value | Base dir containing mount point for NFS share. |
|
| string value | Template string to be used to generate backup names |
|
| integer value | Size of the native threads pool for the backups. Most backup drivers rely heavily on this, it can be decreased for specific drivers that don’t. |
|
| integer value | The number of chunks or objects, for which one Ceilometer notification will be sent |
|
| string value | Path specifying where to store backups. |
|
| integer value | The size in bytes that changes are tracked for incremental backups. backup_s3_object_size has to be multiple of backup_s3_block_size. |
|
| string value | path/to/cert/bundle.pem - A filename of the CA cert bundle to use. |
|
| boolean value | Enable or Disable the timer to send the periodic progress notifications to Ceilometer when backing up the volume to the S3 backend storage. The default value is True to enable the timer. |
|
| string value | The url where the S3 server is listening. |
| `backup_s3_http_proxy = ` | string value | Address or host for the http proxy server. |
| `backup_s3_https_proxy = ` | string value | Address or host for the https proxy server. |
|
| integer value | The maximum number of connections to keep in a connection pool. |
|
| boolean value | Enable or Disable md5 validation in the s3 backend. |
|
| integer value | The size in bytes of S3 backup objects |
|
| integer value | An integer representing the maximum number of retry attempts that will be made on a single request. |
|
| string value | A string representing the type of retry mode. e.g: legacy, standard, adaptive |
|
| string value | The SSECustomerAlgorithm. backup_s3_sse_customer_key must be set at the same time to enable SSE. |
|
| string value | The SSECustomerKey. backup_s3_sse_customer_algorithm must be set at the same time to enable SSE. |
|
| string value | The S3 query token access key. |
|
| string value | The S3 bucket to be used to store the Cinder backup data. |
|
| string value | The S3 query token secret key. |
|
| floating point value | The time in seconds till a timeout exception is thrown. |
|
| boolean value | Enable or Disable ssl verify. |
|
| boolean value | Offload pending backup delete during backup service startup. If false, the backup service will remain down until all pending backups are deleted. |
|
| integer value | The size in bytes that changes are tracked for incremental backups. backup_file_size has to be multiple of backup_sha_block_size_bytes. |
|
| string value | NFS share in hostname:path, ipv4addr:path, or "[ipv6addr]:path" format. |
|
| string value | Swift authentication mechanism (per_user or single_user). |
|
| boolean value | Bypass verification of server certificate when making SSL connection to Swift. |
|
| uri value | The URL of the Keystone endpoint |
|
| string value | Swift authentication version. Specify "1" for auth 1.0, or "2" for auth 2.0 or "3" for auth 3.0 |
|
| integer value | The size in bytes that changes are tracked for incremental backups. backup_swift_object_size has to be multiple of backup_swift_block_size. |
|
| string value | Location of the CA certificate file to use for swift client requests. |
|
| string value | The default Swift container to use |
|
| string value | The storage policy to use when creating the Swift container. If the container already exists the storage policy cannot be enforced |
|
| boolean value | 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. |
|
| string value | Swift key for authentication |
|
| integer value | The size in bytes of Swift backup objects |
|
| string value | Swift project/account name. Required when connecting to an auth 3.0 system |
|
| string value | Swift project domain name. Required when connecting to an auth 3.0 system |
|
| integer value | The number of retries to make for Swift operations |
|
| integer value | The backoff time in seconds between Swift retries |
|
| boolean value | Send a X-Service-Token header with service auth credentials. If enabled you also must set the service_user group and enable send_service_user_token. |
|
| string value | Swift tenant/account name. Required when connecting to an auth 2.0 system |
|
| uri value | The URL of the Swift endpoint |
|
| string value | Swift user name |
|
| string value | Swift user domain name. Required when connecting to an auth 3.0 system |
|
| integer value | Interval, in seconds, between two progress notifications reporting the backup status |
|
| boolean value | Backup services use same backend. |
|
| boolean value | If this is set to True, a temporary snapshot will be created for performing non-disruptive backups. Otherwise a temporary volume will be cloned in order to perform a backup. |
|
| integer value | Number of backup processes to launch. Improves performance with concurrent backups. |
|
| floating point value | Multiplier used for weighing free capacity. Negative numbers mean to stack vs spread. |
| `chap_password = ` | string value | Password for specified CHAP account name. |
|
| integer value | Length of the random string for CHAP password. |
| `chap_username = ` | string value | CHAP user name. |
|
| string value | Chiscsi (CXT) global defaults configuration file |
|
| string value | ID of the project which will be used as the Cinder internal tenant. |
|
| string value | ID of the user to be used in volume operations as the Cinder internal tenant. |
|
| integer value | 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. |
|
| integer value | Create clone volume timeout Deprecated since: 14.0.0 *Reason:*FusionStorage cinder driver refactored the code with Restful method and the old CLI mode has been abandon. So those configuration items are no longer used. |
|
| boolean value | Ensure that the new volumes are the same AZ as snapshot or source volume |
|
| string value | Name of this cluster. Used to group volume hosts that share the same backend configurations to work in HA Active-Active mode. |
|
| string value | Image compression format on image upload |
|
| string value | The full class name of the compute API class to use |
|
| list value |
Path to a config directory to pull |
|
| unknown value | Path to a config file to use. Multiple config files can be specified, with values in later files taking precedence. Defaults to %(default)s. This option must be set from the command-line. |
|
| list value | Lists configuration groups that provide more details for accessing configuration settings from locations other than local files. |
|
| integer value | The pool size limit for connections expiration policy |
|
| integer value | The time-to-live in sec of idle connections in the pool |
|
| string value | The full class name of the consistencygroup API class |
|
| string value | The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. |
|
| integer value | Interval between 503 retries |
|
| integer value | Timeout for HTTP 503 retry messages |
|
| string value | Datera API port. |
|
| string value | Datera API version. |
|
| boolean value | True to set function arg and return logging |
|
| boolean value | ONLY FOR DEBUG/TESTING PURPOSES True to set replica_count to 1 |
|
| boolean value | Set to True to disable sending additional metadata to the Datera backend |
|
| boolean value | Set to True to disable profiling in the Datera driver |
|
| boolean value | Set to True to disable automatic template override of the size attribute when creating from a template |
|
| boolean value | Set to True to enable Datera backend image caching |
|
| string value | Cinder volume type id to use for cached volumes |
|
| string value | LDAP authentication server |
|
| string value | If set to Map -→ OpenStack project ID will be mapped implicitly to Datera tenant ID If set to None -→ Datera tenant ID will not be used during volume provisioning If set to anything else -→ Datera tenant ID will be the provided value |
|
| dict value | Settings here will be used as volume-type defaults if the volume-type setting is not provided. This can be used, for example, to set a very low total_iops_max value if none is specified in the volume-type to prevent accidental overusage. Options are specified via the following format, WITHOUT ANY DF: PREFIX: datera_volume_type_defaults=iops_per_gb:100,bandwidth_per_gb:200…etc. |
|
| boolean value | If set to true, the logging level will be set to DEBUG instead of the default INFO level. |
|
| string value | Default availability zone for new volumes. If not set, the storage_availability_zone option value is used as the default for new volumes. |
|
| string value | Default group type to use |
|
| list value | List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set. |
|
| list value | SandStone default target ip. |
|
| string value | Default volume type to use |
|
| string value | The path to the client certificate for verification, if the driver supports it. |
|
| string value | The path to the client certificate key for verification, if the driver supports it. |
|
| string value | Namespace for driver private data values to be saved in. |
|
| string value | 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 |
|
| boolean value | If set to True the http client will validate the SSL certificate of the backend endpoint. |
|
| boolean value | Tell driver to use SSL for connection to backend storage if the driver supports it. |
|
| boolean value | The flag of thin storage allocation. Deprecated since: 14.0.0 *Reason:*FusionStorage cinder driver refactored the code with Restful method and the old CLI mode has been abandon. So those configuration items are no longer used. |
| `dsware_manager = ` | string value | Fusionstorage manager ip addr for cinder-volume. Deprecated since: 14.0.0 *Reason:*FusionStorage cinder driver refactored the code with Restful method and the old CLI mode has been abandon. So those configuration items are no longer used. |
| `dsware_rest_url = ` | string value | The address of FusionStorage array. For example, "dsware_rest_url=xxx" |
| `dsware_storage_pools = ` | string value | The list of pools on the FusionStorage array, the semicolon(;) was used to split the storage pools, "dsware_storage_pools = xxx1; xxx2; xxx3" |
|
| boolean value | Enables the Force option on upload_to_image. This enables running upload_volume on in-use volumes for backends that support it. |
|
| boolean value | Services to be added to the available pool on create |
|
| boolean value | Set this to True when you want to allow an unsupported driver to start. Drivers that haven’t maintained a working CI system and testing are marked as unsupported until CI is working again. This also marks a driver as deprecated and may be removed in the next release. |
|
| list value | A list of backend names to use. These backend names should be backed by a unique [CONFIG] group with its options |
|
| boolean value | 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. This parameter needs to be configured for each backend section or in [backend_defaults] section as a common configuration for all backends. |
|
| integer value | Size of executor thread pool when executor is threading or eventlet. |
|
| boolean value | Enables or disables fatal status of deprecations. |
|
| string value | 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. |
|
| integer value | Create clone volume timeout in seconds |
| `fusionstorageagent = ` | string value | Fusionstorage agent ip addr range Deprecated since: 14.0.0 *Reason:*FusionStorage cinder driver refactored the code with Restful method and the old CLI mode has been abandon. So those configuration items are no longer used. |
|
| boolean value | Allow to perform insecure SSL (https) requests to glance (https will be used but cert validation will not be performed). |
|
| list value | 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. |
|
| boolean value | 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. |
|
| string value | Location of ca certificates file to use for glance client requests. |
|
| string value | 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. |
|
| string value | Location of certificate file to use for glance client requests. |
|
| list value | Default core properties of image |
|
| string value | Location of certificate key file to use for glance client requests. |
|
| integer value | Number retries when downloading an image from glance |
|
| integer value | http/https timeout value for glance operations. If no value (None) is supplied here, the glanceclient default value is used. |
|
| string value | Base dir containing mount point for gluster share. |
|
| string value | GlusterFS share in <hostname|ipv4addr|ipv6addr>:<gluster_vol_name> format. Eg: 1.2.3.4:backup_vol |
|
| string value | 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. |
|
| integer value | Specify a timeout after which a gracefully shutdown server will exit. Zero value means endless wait. |
|
| string value | The full class name of the group API class |
|
| string value | iSCSI authentication password |
|
| string value | iSCSI authentication username |
|
| list value | Target port names of compute node for host group or iSCSI target |
|
| string value | Logical device range of secondary storage system |
|
| integer value | Pair target name of the host group or iSCSI target |
|
| string value | Pool of secondary storage system |
|
| string value | IP address of REST API server |
|
| port value | Port number of REST API server |
|
| list value | Target port names for pair of the host group or iSCSI target |
|
| string value | Password of secondary storage system for REST API |
|
| string value | Username of secondary storage system for REST API |
|
| string value | Thin pool of secondary storage system |
|
| string value | 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 |
|
| boolean value | If set to True the http client will validate the SSL certificate of the backend endpoint. |
|
| string value | ID of secondary storage system |
|
| list value | Target port names for host group or iSCSI target |
|
| boolean value | Whether or not to use iSCSI authentication |
|
| integer value | Path group ID assigned to the remote connection for remote replication |
|
| integer value | ID of the Quorum disk used for global-active device |
|
| integer value | Remote copy speed of storage system. 1 or 2 indicates low speed, 3 indicates middle speed, and a value between 4 and 15 indicates high speed. |
|
| integer value | Instance number for REST API |
|
| integer value | Interval at which remote replication pair status is checked. This parameter is applied if the status has not changed to the expected status after the time indicated by this parameter has elapsed. |
|
| integer value | Initial interval at which remote replication pair status is checked |
|
| integer value | Maximum wait time before the remote replication pair status changes to the expected status |
|
| boolean value | Whether or not to set the mirror reserve attribute |
|
| string value | Name of this node. This can be an opaque identifier. It is not necessarily a host name, FQDN, or IP address. |
|
| string value | DEPRECATED: IET configuration file |
|
| boolean value | When possible, compress images uploaded to the image service |
|
| integer value | Address space limit in gigabytes to convert the image |
|
| integer value | CPU time limit in seconds to convert the image |
|
| string value | Directory used for temporary storage during image conversion |
|
| boolean value | Disallow image conversion when creating a volume from an image and when uploading a volume as an image. Image conversion consumes a large amount of system resources and can cause performance problems on the cinder-volume node. When set True, this option disables image conversion. |
|
| boolean value | 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. |
|
| boolean value | 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. |
|
| boolean value | Enable the image volume cache for this backend. |
|
| integer value | Max number of entries allowed in the image volume cache. 0 ⇒ unlimited. |
|
| integer value | Max size of the image volume cache for this backend in GB. 0 ⇒ unlimited. |
|
| boolean value | The Infortrend CLI cache. While set True, the RAID status report will use cache stored in the CLI. Never enable this unless the RAID is managed only by Openstack and only by one infortrend cinder-volume backend. Otherwise, CLI might report out-dated status to cinder and thus there might be some race condition among all backend/CLIs. |
|
| integer value | The maximum retry times if a command fails. |
|
| string value | The Infortrend CLI absolute path. |
|
| integer value | The timeout for CLI in seconds. |
|
| string value | Infortrend iqn prefix for iSCSI. |
| `infortrend_pools_name = ` | list value | The Infortrend logical volumes name list. It is separated with comma. |
| `infortrend_slots_a_channels_id = ` | list value | Infortrend raid channel ID list on Slot A for OpenStack usage. It is separated with comma. |
| `infortrend_slots_b_channels_id = ` | list value | Infortrend raid channel ID list on Slot B for OpenStack usage. It is separated with comma. |
|
| integer value | Max number of volumes and snapshots to be retrieved per batch during volume manager host initialization. Query results will be obtained in batches from the database and not in one shot to avoid extreme memory usage. Set 0 to turn off this functionality. |
|
| dict value | Support initiator assign target with assign ip. |
| `instance_format = [instance: %(uuid)s] ` | string value | The format for an instance that is passed with the log message. |
| `instance_uuid_format = [instance: %(uuid)s] ` | string value | The format for an instance UUID that is passed with the log message. |
|
| boolean value | Allow tenants to specify QOS on create |
|
| boolean value | Configure CHAP authentication for iSCSI connections (Default: Enabled) |
|
| integer value | Specifies the InStorage LocalCopy copy rate to be used when creating a full volume copy. The default rate is 50, and the valid rates are 1-100. |
|
| integer value | Maximum number of seconds to wait for LocalCopy to be prepared. |
|
| boolean value | Storage system autoexpand parameter for volumes (True/False) |
|
| boolean value | Storage system compression option for volumes |
|
| integer value | Storage system grain size parameter for volumes (32/64/128/256) |
|
| boolean value | Enable InTier for volumes |
|
| string value | The I/O group in which to allocate volumes. It can be a comma-separated list in which case the driver will select an io_group based on least number of volumes associated with the io_group. |
|
| integer value | Storage system space-efficiency parameter for volumes (percentage) |
|
| integer value | Storage system threshold for volume capacity warnings (percentage) |
|
| list value | Comma separated list of storage system storage pools for volumes. |
|
| string value | Specifies secondary management IP or hostname to be used if san_ip is invalid or becomes inaccessible. |
|
| integer value | Maximum read IOPS that volume can get when reading data from the volume during host assisted migration |
|
| string value | 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_target_flags = ` | string value | 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. |
|
| string value | Sets the behavior of the iSCSI target to either perform write-back(on) or write-through(off). This parameter is valid if target_helper is set to tgtadm. |
|
| string value | The name of the iSER target user-land tool to use |
|
| string value | The IP address that the iSER daemon is listening on |
|
| port value | The port that the iSER daemon is listening on |
|
| string value | Prefix for iSER volumes |
|
| string value | The Java absolute path. |
|
| string value | Block size for new volume |
|
| list value | List of multipath ip addresses to ignore. |
|
| string value | JovianDSS pool that holds all cinder volumes |
|
| integer value | Time before HA cluster failure. |
|
| string value | Info to match when looking for keystone in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:<endpoint_type> - Only used if backup_swift_auth_url is unset |
|
| integer value | Volume block size in bytes - 512 or 4096 (Default). |
|
| string value | Cert for provisioner REST API SSL |
|
| integer value | Desired bandwidth in B/s per GB. |
|
| integer value | Desired IOPS/GB. |
|
| integer value | Upper limit for bandwidth in B/s per GB. |
|
| integer value | Upper limit for IOPS/GB. |
|
| integer value | Replicated volume max downtime for replica in minutes. |
|
| integer value | Number of volume replicas. |
|
| string value | Thin or thick volume, Default thick. |
|
| boolean value | Can more than one replica be allocated to same rack. |
|
| integer value | Percentage of the parent volume to be used for log. |
|
| integer value | Writable snapshot percentage of parent volume used for log. |
|
| boolean value | Allow span in snapshot volume - Default True. |
|
| boolean value | Allow span - Default True. |
|
| string value | KumoScale Provisioner auth token. |
|
| string value | KumoScale provisioner REST API URL |
|
| integer value | Thin volume reserved capacity allocation percentage. |
|
| boolean value | Volumes from snapshot writeable or not. |
|
| string value | 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, log-date-format). |
|
| string value | Defines the format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. |
|
| string value | (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set. |
|
| string value | (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. |
|
| boolean value | Enables or disables logging values of all registered options when starting a service (at DEBUG level). |
|
| integer value | The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is set to "interval". |
|
| string value | Rotation interval type. The time of the last file change (or the time when the service was started) is used when scheduling the next rotation. |
|
| string value | Log rotation type. |
|
| string value | Format string to use for log messages with context. Used by oslo_log.formatters.ContextFormatter |
|
| string value | Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter |
|
| string value | Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter |
|
| string value | Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter |
|
| string value | Defines the format string for %(user_identity)s that is used in logging_context_format_string. Used by oslo_log.formatters.ContextFormatter |
|
| dict value | This option is to support the FSA to mount across the different nodes. The parameters takes the standard dict config form, manager_ips = host1:ip1, host2:ip2… |
|
| integer value | Number of seconds between subsequent usage refreshes |
|
| integer value | Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated when keystone is configured to use PKI tokens with big service catalogs). |
|
| integer value | Maximum number of rotated log files. |
|
| integer value | Log file maximum size in MB. This option is ignored if "log_rotation_type" is not set to "size". |
|
| string value | Representation of the over subscription ratio when thin provisioning is enabled. 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. If ratio is auto, Cinder will automatically calculate the ratio based on the provisioned capacity and the used space. If not set to auto, the ratio has to be a minimum of 1.0. |
|
| integer value | interval between periodic task runs to clean expired messages in seconds. |
|
| integer value | message minimum life in seconds. |
|
| integer value | Timeout for creating the volume to migrate to when performing volume migration (seconds) |
|
| boolean value | Enable monkey patching |
|
| list value | List of modules/decorators to monkey patch |
|
| host address value | IP address of this host |
|
| boolean value | Whether snapshots sizes count against global and per volume type gigabyte quotas. By default snapshots' sizes are counted. |
|
| integer value | The maximum number of times to rescan iSER target to find volume |
|
| integer value | Number of times to attempt to run flakey shell commands |
|
| integer value | The maximum number of times to rescan targets to find volume |
|
| port value | The port number to be used when doing nvme connect from host |
|
| integer value | NVMe os-brick connector has 2 different connection info formats, this allows some NVMe-oF drivers that use the original format (version 1), such as spdk and LVM-nvmet, to send the newer format. |
|
| integer value | Namespace id for the subsystem for the LVM volume when not sharing targets. The minimum id value when sharing.Maximum supported value in Linux is 8192 |
|
| port value | The id of the NVMe target port definition when not sharing targets. The starting port id value when sharing, incremented for each secondary ip address. |
|
| integer value | The maximum number of items that a collection resource returns in a single response |
|
| list value | Specify list of extensions to load when using osapi_volume_extension option with cinder.api.contrib.select_extensions |
|
| multi valued | osapi volume extension to load |
|
| string value | IP address on which OpenStack Volume API listens |
|
| port value | Port on which OpenStack Volume API listens |
|
| boolean value | Wraps the socket in a SSL context if True is set. A certificate file and key file must be specified. |
|
| integer value | Number of workers for OpenStack Volume API service. The default is equal to the number of CPUs available. |
|
| integer value | Max size allowed per volume, in gigabytes |
|
| integer value | Range, in seconds, to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0) |
|
| integer value | Interval, in seconds, between running periodic tasks |
|
| list value | Pool id permit to use Deprecated since: 14.0.0 *Reason:*FusionStorage cinder driver refactored the code with Restful method and the old CLI mode has been abandon. So those configuration items are no longer used. |
|
| string value | Pool type, like sata-2copy Deprecated since: 14.0.0 *Reason:*FusionStorage cinder driver refactored the code with Restful method and the old CLI mode has been abandon. So those configuration items are no longer used. |
|
| string value | The validation regex for project_ids used in urls. This defaults to [0-9a-f\\-]+ if not set, which matches normal uuids created by keystone. |
|
| string value | 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. |
|
| boolean value | Enables or disables publication of error events. |
|
| integer value | Total amount of storage, in gigabytes, allowed for backups per project |
|
| integer value | Number of volume backups allowed per project |
|
| integer value | Number of consistencygroups allowed per project |
|
| string value | Default driver to use for quota checks |
|
| integer value | Total amount of storage, in gigabytes, allowed for volumes and snapshots per project |
|
| integer value | Number of groups allowed per project |
|
| integer value | Number of volume snapshots allowed per project |
|
| integer value | Number of volumes allowed per project |
|
| integer value | Maximum number of logged messages per rate_limit_interval. |
|
| string value | Log level name used by rate limiting: CRITICAL, ERROR, INFO, WARNING, DEBUG or empty string. Logs with level greater or equal to rate_limit_except_level are not filtered. An empty string means that all levels are filtered. |
|
| integer value | Interval, number of seconds, of log rate limiting. |
|
| integer value | Maximum times to reintialize the driver if volume initialization fails. The interval of retry is exponentially backoff, and will be 1s, 2s, 4s etc. |
|
| dict value | 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… |
|
| boolean value | 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. |
|
| integer value | Interval, in seconds, between nodes reporting state to datastore |
|
| integer value | Interval between periodic task runs to clean expired reservations in seconds. |
|
| integer value | Number of seconds until a reservation expires |
|
| list value |
List of reserved image namespaces that should be filtered out when uploading a volume as an image back to Glance. When a volume is created from an image, Cinder stores the image properties as volume image metadata, and if the volume is later uploaded as an image, Cinder will add these properties when it creates the image in Glance. This can cause problems for image metadata that are in namespaces that glance reserves for itself, or when properties (such as an image signature) cannot apply to the new image, or when an operator has configured glance property protections to make some image properties read-only. Cinder will always filter out image metadata in the namespaces |
|
| integer value | The percentage of backend capacity is reserved |
|
| string value | Json file indicating user visible filter parameters for list queries. |
|
| boolean value | If True, always discard excess bytes when restoring volumes i.e. pad with zeroes. |
|
| string value | Path to the rootwrap configuration file to use for running commands as root |
|
| integer value | Size of RPC connection pool. |
|
| boolean value | Add an endpoint to answer to ping calls. Endpoint is named oslo_rpc_server_ping |
|
| integer value | Seconds to wait for a response from a call. |
|
| boolean value | Some periodic tasks can be run in a separate process. Should we run them here? |
| `san_hosts = ` | list value | IP address of Open-E JovianDSS SA |
| `sandstone_pool = ` | string value | SandStone storage pool resource name. |
|
| list value | Which filter class names to use for filtering hosts when not specified in the request. |
|
| list value | Which weigher class names to use for weighing hosts. |
|
| string value | Default scheduler driver to use |
|
| integer value | Maximum time in seconds to wait for the driver to report as ready |
|
| string value | The scheduler host manager class to use |
| `scheduler_json_config_location = ` | string value | Absolute path to scheduler configuration JSON file. |
|
| string value | Full class name for the Manager for scheduler |
|
| integer value | Maximum number of attempts to schedule a volume |
|
| string value | Which handler to use for selecting the host/pool after weighing |
|
| string value | SCST target implementation can choose from multiple SCST target drivers. |
|
| string value | Certain ISCSI targets have predefined target names, SCST target driver uses this name. |
|
| integer value | Maximum time since last check-in for a service to be considered up |
|
| string value | Template string to be used to generate snapshot names |
|
| boolean value | Create volume from snapshot at the host where snapshot resides |
|
| boolean value | Log requests to multiple loggers. |
|
| string value | File containing SSH host keys for the systems with which Cinder needs to communicate. OPTIONAL: Default=$state_path/ssh_known_hosts |
|
| string value | Top-level directory for maintaining cinder’s state |
|
| string value | Availability zone of this node. Can be overridden per volume backend with the option "backend_availability_zone". |
|
| string value | Protocol for transferring data between host and storage back-end. |
|
| boolean value | 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 |
|
| string value | 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 |
|
| string value | Syslog facility to receive log lines. This option is ignored if log_config_append is set. |
|
| string value | Target user-land tool to use. tgtadm is default, use lioadm for LIO iSCSI support, scstadmin for SCST target support, ietadm for iSCSI Enterprise Target, iscsictl for Chelsio iSCSI Target, nvmet for NVMEoF support, spdk-nvmeof for SPDK NVMe-oF, or fake for testing. Note: The IET driver is deprecated and will be removed in the V release. |
|
| string value | The IP address that the iSCSI/NVMEoF daemon is listening on |
|
| port value | The port that the iSCSI/NVMEoF daemon is listening on |
|
| string value | Prefix for iSCSI/NVMEoF volumes |
|
| string value | Determines the target protocol for new volumes, created with tgtadm, lioadm and nvmet 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", in case of nvmet target set to "nvmet_rdma" or "nvmet_tcp". |
|
| list value | The list of secondary IP addresses of the iSCSI/NVMEoF daemon |
|
| boolean value | Sets the value of TCP_KEEPALIVE (True/False) for each server socket. |
|
| integer value | Sets the value of TCP_KEEPCNT for each server socket. Not supported on OS X. |
|
| integer value | Sets the value of TCP_KEEPINTVL in seconds for each server socket. Not supported on OS X. |
|
| integer value | Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X. |
|
| list value | List of options that control which trace info is written to the DEBUG log level to assist developers. Valid values are method and api. |
|
| string value | The full class name of the volume transfer API class |
|
| string value | The network address and optional user credentials for connecting to the messaging backend, in URL format. The expected format is: driver://[user:pass@]host:port[,[userN:passN@]hostN:portN]/virtual_host?query Example: rabbit://rabbitmq:password@127.0.0.1:5672// For full details on the fields in the URL see the documentation of oslo_messaging.TransportURL at https://docs.openstack.org/oslo.messaging/latest/reference/transport.html |
|
| integer value | Count of reservations until usage is refreshed |
|
| boolean value | Enable journald for logging. If running in a systemd environment you may wish to enable journal support. Doing so will use the journal native protocol which includes structured metadata in addition to log messages.This option is ignored if log_config_append is set. |
|
| boolean value | Use JSON formatting for logging. This option is ignored if log_config_append is set. |
|
| boolean value | 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. |
|
| boolean value | Option to enable/disable CHAP authentication for targets. |
|
| boolean value | Enables or disables use of default quota class with default quota. |
|
| boolean value | Log output to Windows Event Log. |
|
| boolean value | Treat X-Forwarded-For as the canonical remote address. Only enable this if you have a sanitizing proxy. |
|
| boolean value | Do we attach/detach volumes in cinder using multipath for volume to image and image to volume transfers? This parameter needs to be configured for each backend section or in [backend_defaults] section as a common configuration for all backends. |
|
| boolean value | Log output to standard error. This option is ignored if log_config_append is set. |
|
| string value | Enable image signature verification. Cinder uses the image signature metadata from Glance and verifies the signature of a signed image while downloading that image. There are two options here.
If the image signature cannot be verified or if the image signature metadata is incomplete when required, then Cinder will not create the volume and update it into an error state. This provides end users with stronger assurances of the integrity of the image data they are using to create volumes. |
|
| list value | A list of strings describing the VMDK createType subformats that are allowed. We recommend that you only include single-file-with-sparse-header variants to avoid potential host file exposure when processing named extents when an image is converted to raw format as it is written to a volume. If this list is empty, no VMDK images are allowed. |
|
| string value | The full class name of the volume API class to use |
|
| string value | The backend name for a given driver implementation |
|
| string value | Method used to wipe old volumes |
|
| string value | 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. |
|
| integer value | Size in MiB to wipe at start of old volumes. 1024 MiB at max. 0 ⇒ all |
|
| string value | The blkio cgroup name to be used to limit bandwidth of volume copy |
|
| integer value | The upper limit of bandwidth of volume copy. 0 ⇒ unlimited |
|
| string value | The default block size used when copying/clearing volumes |
|
| string value | Full class name for the Manager for volume |
|
| string value | Template string to be used to generate volume names |
|
| floating point value | Multiplier used for weighing volume number. Negative numbers mean to spread vs stack. |
|
| boolean value | Offload pending volume delete during volume service startup |
|
| integer value | The number of characters in the autogenerated auth key. |
|
| integer value | The number of characters in the salt. |
|
| string value | Time period for which to generate volume usages. The options are hour, day, month, or year. |
|
| string value | Volume configuration file storage directory |
|
| boolean value | Create sparse Lun. |
|
| string value | VA config file. |
|
| boolean value | 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. |
|
| integer value | Size of the pool of greenthreads used by wsgi |
|
| boolean value | If False, closes the client socket connection explicitly. |
|
| string value | A python format string that is used as the template to generate log lines. The following values can beformatted into it: client_ip, date_time, request_line, status_code, body_length, wall_seconds. |
|
| boolean value | True if the server should send exception tracebacks to the clients on 500 errors. If False, the server will respond with empty bodies. |
|
| string value | FC Zoning mode configured, only fabric is supported now. |
2.1.2. backend
The following table outlines the options available under the [backend] group in the /etc/cinder/cinder.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| string value | Backend override of host value. |
2.1.3. backend_defaults
The following table outlines the options available under the [backend_defaults] group in the /etc/cinder/cinder.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| port value | Port to use to access the Tatlin API |
|
| string value | Authentication method for iSCSI (CHAP) |
|
| boolean value | K2 driver will calculate max_oversubscription_ratio on setting this option as True. |
|
| string value | Availability zone for this volume backend. If not set, the storage_availability_zone option value is used as the default for all backends. |
|
| integer value | Size of the native threads pool for the backend. Increase for backends that heavily rely on this, like the RBD driver. |
|
| string value | CHAP authentication mode, effective only for iscsi (disabled|enabled) |
| `chap_password = ` | string value | Password for specified CHAP account name. |
| `chap_username = ` | string value | CHAP user name. |
|
| boolean value | DEPRECATED: Report free_capacity_gb as 0 when the limit to maximum number of pool LUNs is reached. By default, the value is False. |
|
| string value | Chiscsi (CXT) global defaults configuration file |
|
| string value | Config file for cinder eternus_dx volume driver. |
|
| string value | The configuration file for the Cinder Huawei driver. |
|
| string value | Connection type to the IBM Storage Array |
|
| integer value | This defines an optional cycle period that applies to Global Mirror relationships with a cycling mode of multi. A Global Mirror relationship using the multi cycling_mode performs a complete cycle at most once each period. The default is 300 seconds, and the valid seconds are 60-86400. |
|
| integer value | Seconds to wait for a response from a DataCore API call. |
|
| integer value | Seconds to wait for DataCore virtual disk to come out of the "Failed" state. |
|
| list value | List of DataCore disk pools that can be used by volume driver. |
|
| string value | DataCore virtual disk type (single/mirrored). Mirrored virtual disks require two storage servers in the server group. |
|
| list value | List of FC targets that cannot be used to attach volume. To prevent the DataCore FibreChannel volume driver from using some front-end targets in volume attachment, specify this option and list the iqn and target machine for each target as the value, such as <wwpns:target name>, <wwpns:target name>, <wwpns:target name>. |
|
| string value | Fully qualified file name where dynamically generated iSCSI CHAP secrets are stored. This must be changed to a unique per-backend value if deploying multiple DataCore backends on the same host. |
|
| list value | List of iSCSI targets that cannot be used to attach volume. To prevent the DataCore iSCSI volume driver from using some front-end targets in volume attachment, specify this option and list the iqn and target machine for each target as the value, such as <iqn:target name>, <iqn:target name>, <iqn:target name>. |
|
| string value | DataCore virtual disk storage profile. |
|
| integer value | 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. |
|
| integer value | Time delay in seconds before a volume is eligible for permanent removal after being tagged for deferred deletion. |
|
| integer value | Number of seconds between runs of the periodic task to purge volumes tagged for deletion. |
|
| integer value | Dell SC API async call default timeout in seconds. |
|
| integer value | Dell SC API sync call default timeout in seconds. |
|
| port value | Dell API port |
|
| string value | Name of the server folder to use on the Storage Center |
|
| integer value | Storage Center System Serial Number |
|
| boolean value | Enable HTTPS SC certificate verification |
|
| string value | Name of the volume folder to use on the Storage Center |
|
| string value | Server OS type to use when creating a new server on the Storage Center. |
|
| boolean value | To destroy storage group when the last LUN is removed from it. By default, the value is False. |
|
| boolean value | Disabling iSCSI discovery (sendtargets) for multipath connections on K2 driver. |
| `dpl_pool = ` | string value | DPL pool uuid in which DPL volumes are stored. |
|
| port value | DPL port number. |
|
| string value | The path to the client certificate for verification, if the driver supports it. |
|
| string value | The path to the client certificate key for verification, if the driver supports it. |
|
| string value | Namespace for driver private data values to be saved in. |
|
| string value | 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 |
|
| boolean value | If set to True the http client will validate the SSL certificate of the backend endpoint. |
|
| boolean value | Tell driver to use SSL for connection to backend storage if the driver supports it. |
| `ds8k_devadd_unitadd_mapping = ` | string value | Mapping between IODevice address and unit address. |
|
| string value | Set to zLinux if your OpenStack version is prior to Liberty and you’re connecting to zLinux systems. Otherwise set to auto. Valid values for this parameter are: auto, AMDLinuxRHEL, AMDLinuxSuse, AppleOSX, Fujitsu, Hp, HpTru64, HpVms, LinuxDT, LinuxRF, LinuxRHEL, LinuxSuse, Novell, SGI, SVC, SanFsAIX, SanFsLinux, Sun, VMWare, Win2000, Win2003, Win2008, Win2012, iLinux, nSeries, pLinux, pSeries, pSeriesPowerswap, zLinux, iSeries. |
|
| string value | Set the first two digits of SSID. |
|
| boolean value | Enable deferred deletion. Upon deletion, volumes are tagged for deletion but will only be removed asynchronously at a later time. |
|
| boolean value | Set this to True when you want to allow an unsupported driver to start. Drivers that haven’t maintained a working CI system and testing are marked as unsupported until CI is working again. This also marks a driver as deprecated and may be removed in the next release. |
|
| boolean value | 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. This parameter needs to be configured for each backend section or in [backend_defaults] section as a common configuration for all backends. |
|
| IP address value | DEPRECATED: Fault Domain IP to be excluded from iSCSI returns. Deprecated since: Stein *Reason:*Replaced by excluded_domain_ips option |
|
| list value | Comma separated Fault Domain IPs to be excluded from iSCSI returns. |
|
| integer value | 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. |
| `export_ports = ` | string value | Ports to export Tatlin resource through |
|
| string value | 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. |
|
| string value | 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. |
|
| string value | Connection protocol should be FC. (Default is FC.) |
|
| integer value | Default iSCSI Port ID of FlashSystem. (Default port is 0.) |
|
| boolean value | Allows vdisk to multi host mapping. (Default is True) |
|
| boolean value | Delete a LUN even if it is in Storage Groups. |
|
| string value | 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. |
|
| list value | Comma-separated list of IP address or hostnames of GPFS nodes. |
|
| string value | File containing SSH host keys for the gpfs nodes with which driver needs to communicate. Default=$state_path/ssh_known_hosts |
|
| string value | Specifies the path of the Image service repository in GPFS. Leave undefined if not storing images in GPFS. |
|
| string value | 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. |
|
| integer value | 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. |
|
| string value | Specifies the path of the GPFS directory where Block Storage volume and snapshot files are stored. |
| `gpfs_private_key = ` | string value | Filename of private key to use for SSH authentication. |
|
| boolean value | 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. |
|
| port value | SSH port to use. |
|
| string value | Specifies the storage pool that volumes are assigned to. By default, the system storage pool is used. |
|
| boolean value | Option to enable strict gpfs host key checking while connecting to gpfs nodes. Default=False |
|
| string value | Username for GPFS nodes. |
| `gpfs_user_password = ` | string value | Password for GPFS node user. |
|
| integer value | Interval in seconds to check asynchronous copying status during a copy pair deletion or data restoration. |
|
| list value | IDs of the storage ports used to attach volumes to compute nodes. To specify multiple ports, connect them by commas (e.g. CL1-A,CL2-A). |
|
| integer value | Interval in seconds to check copying status during a volume copy. |
|
| integer value | Copy speed of storage system. 1 or 2 indicates low speed, 3 indicates middle speed, and a value between 4 and 15 indicates high speed. |
|
| boolean value | Enable or disable zero page reclamation in a DP-VOL. |
|
| integer value | Retry interval in seconds for REST API execution. |
|
| integer value | Maximum wait time in seconds for a volume extention to complete. |
|
| boolean value | If True, the driver will create host groups or iSCSI targets on storage ports as needed. |
|
| boolean value | If True, the driver will delete host groups or iSCSI targets on storage ports as needed. |
|
| string value | Format of host groups, iSCSI targets, and server objects. |
|
| list value | Host mode option for host group or iSCSI target. |
|
| string value | Range of the LDEV numbers in the format of xxxx-yyyy that can be used by the driver. Values can be in decimal format (e.g. 1000) or in colon-separated hexadecimal format (e.g. 00:03:E8). |
|
| integer value | Maximum wait time in seconds for storage to be logined or unlocked. |
|
| integer value | Retry interval in seconds for REST API adding a LUN mapping to the server. |
|
| integer value | Maximum wait time in seconds for adding a LUN mapping to the server. |
|
| integer value | Pair target name of the host group or iSCSI target |
|
| list value | Pool number[s] or pool name[s] of the DP pool. |
|
| boolean value | Enable port scheduling of WWNs to the configured ports so that WWNs are registered to ports in a round-robin fashion. |
|
| integer value | Retry time in seconds when new LUN allocation request fails. |
|
| integer value | Maximum wait time in seconds for connecting to REST API session. |
|
| boolean value | This option will allow detaching volume immediately. If set False, storage may take few minutes to detach volume after I/O. |
|
| integer value | Maximum wait time in seconds for a response against sync methods, for example GET |
|
| integer value | Maximum wait time in seconds for a response against async methods from REST API, for example PUT and DELETE. |
|
| integer value | Loop interval in seconds for keeping REST API session. |
|
| list value | Target port names for pair of the host group or iSCSI target |
|
| integer value | Maximum wait time in seconds when REST API returns busy. |
|
| boolean value | Enables or disables use of REST API tcp keepalive |
|
| integer value | Maximum number of transmissions for TCP keepalive packet. |
|
| integer value | Wait time in seconds for sending a first TCP keepalive packet. |
|
| integer value | Interval of transmissions in seconds for TCP keepalive packet. |
|
| integer value | Maximum wait time in seconds for each REST API request. |
|
| integer value | Maximum wait time in seconds for the restore operation to complete. |
|
| string value | Pool number or pool name of the snapshot pool. |
|
| integer value | Maximum wait time in seconds for a volume transition to complete. |
|
| string value | Product number of the storage system. |
|
| list value | IDs of the storage ports used to attach volumes to the controller node. To specify multiple ports, connect them by commas (e.g. CL1-A,CL2-A). |
|
| boolean value | If True, the driver will configure FC zoning between the server and the storage system provided that FC zoning manager is enabled. |
| `host_group = ` | string value | Tatlin host group name |
| `hpe3par_api_url = ` | string value | WSAPI Server URL. This setting applies to: 3PAR, Primera and Alletra 9k Example 1: for 3PAR, URL is: https://<3par ip>:8080/api/v1 Example 2: for Primera/Alletra 9k, URL is: https://<primera ip>:443/api/v1 |
|
| list value | List of the 3PAR/Primera/Alletra 9k CPG(s) to use for volume creation |
| `hpe3par_cpg_snap = ` | string value | The 3PAR/Primera/Alletra 9k CPG to use for snapshots of volumes. If empty the userCPG will be used. |
|
| boolean value | Enable HTTP debugging to 3PAR/Primera/Alletra 9k |
|
| boolean value | Enable CHAP authentication for iSCSI connections. |
|
| list value | List of target iSCSI addresses to use. |
| `hpe3par_password = ` | string value | 3PAR/Primera/Alletra 9k password for the user specified in hpe3par_username |
| `hpe3par_snapshot_expiration = ` | string value | The time in hours when a snapshot expires and is deleted. This must be larger than expiration |
| `hpe3par_snapshot_retention = ` | string value | The time in hours to retain a snapshot. You can’t delete it before this expires. |
| `hpe3par_target_nsp = ` | string value | The nsp of 3PAR/Primera/Alletra 9k backend to be used when: (1) multipath is not enabled in cinder.conf. (2) Fiber Channel Zone Manager is not used. (3) the backend is prezoned with this specific nsp only. For example if nsp is 2 1 2, the format of the option’s value is 2:1:2 |
| `hpe3par_username = ` | string value | 3PAR/Primera/Alletra 9k username with the edit role |
|
| integer value | Interval in seconds to check copy asynchronously |
|
| list value | IDs of the storage ports used to attach volumes to compute nodes. To specify multiple ports, connect them by commas (e.g. CL1-A,CL2-A). |
|
| integer value | Interval in seconds to check copy |
|
| integer value | Copy speed of storage system. 1 or 2 indicates low speed, 3 indicates middle speed, and a value between 4 and 15 indicates high speed. |
|
| boolean value | Enable or disable zero page reclamation in a THP V-VOL. |
|
| integer value | Retry interval in seconds for REST API execution. |
|
| integer value | Maximum wait time in seconds for a volume extention to complete. |
|
| boolean value | If True, the driver will create host groups or iSCSI targets on storage ports as needed. |
|
| boolean value | If True, the driver will delete host groups or iSCSI targets on storage ports as needed. |
|
| list value | Host mode option for host group or iSCSI target. |
|
| string value | Range of the LDEV numbers in the format of xxxx-yyyy that can be used by the driver. Values can be in decimal format (e.g. 1000) or in colon-separated hexadecimal format (e.g. 00:03:E8). |
|
| integer value | Maximum wait time in seconds for storage to be unlocked. |
|
| integer value | Retry interval in seconds for REST API adding a LUN. |
|
| integer value | Maximum wait time in seconds for adding a LUN to complete. |
|
| list value | Pool number[s] or pool name[s] of the THP pool. |
|
| integer value | Retry time in seconds when new LUN allocation request fails. |
|
| integer value | Maximum wait time in seconds for REST API connection to complete. |
|
| boolean value | It may take some time to detach volume after I/O. This option will allow detaching volume to complete immediately. |
|
| integer value | Maximum wait time in seconds for a response against GET method of REST API. |
|
| integer value | Maximum wait time in seconds for a response from REST API. |
|
| integer value | Loop interval in seconds for keeping REST API session. |
|
| integer value | Maximum wait time in seconds when REST API returns busy. |
|
| boolean value | Enables or disables use of REST API tcp keepalive |
|
| integer value | Maximum number of transmissions for TCP keepalive packet. |
|
| integer value | Wait time in seconds for sending a first TCP keepalive packet. |
|
| integer value | Interval of transmissions in seconds for TCP keepalive packet. |
|
| integer value | Maximum wait time in seconds for REST API execution to complete. |
|
| integer value | Maximum wait time in seconds for the restore operation to complete. |
|
| string value | Pool number or pool name of the snapshot pool. |
|
| integer value | Maximum wait time in seconds for a volume transition to complete. |
|
| string value | Product number of the storage system. |
|
| list value | IDs of the storage ports used to attach volumes to the controller node. To specify multiple ports, connect them by commas (e.g. CL1-A,CL2-A). |
|
| boolean value | If True, the driver will configure FC zoning between the server and the storage system provided that FC zoning manager is enabled. |
|
| string value | HPMSA API interface protocol. |
|
| list value | List of comma-separated target iSCSI IP addresses. |
|
| string value | Pool or Vdisk name to use for volume creation. |
|
| string value | linear (for Vdisk) or virtual (for Pool). |
|
| boolean value | Whether to verify HPMSA array SSL certificate. |
|
| string value | HPMSA array SSL certificate path. |
|
| string value | The remote device hypermetro will use. |
|
| string value | DEPRECATED: IET configuration file |
|
| boolean value | Force LUN creation even if the full threshold of pool is reached. By default, the value is False. |
|
| boolean value | 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. |
|
| boolean value | 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. |
|
| boolean value | Enable the image volume cache for this backend. |
|
| integer value | Max number of entries allowed in the image volume cache. 0 ⇒ unlimited. |
|
| integer value | Max size of the image volume cache for this backend in GB. 0 ⇒ unlimited. |
|
| list value | Comma separated Fault Domain IPs to be included from iSCSI returns. |
|
| list value | List of names of network spaces to use for iSCSI connectivity |
|
| string value | Name of the pool from which volumes are allocated |
|
| string value | Protocol for transferring data between host and storage back-end. |
|
| boolean value | Specifies whether to turn on compression for newly created volumes. |
|
| boolean value | Automatically deregister initiators after the related storage group is destroyed. By default, the value is False. |
|
| boolean value | Automatically register initiators. By default, the value is False. |
|
| boolean value | Use this value to enable the initiator_check. |
|
| integer value | Use this value to specify length of the interval in seconds. |
|
| list value | Comma separated iSCSI or FC ports to be used in Nova or Cinder. |
|
| string value | Mapping between hostname and its iSCSI initiator IP addresses. |
|
| string value | 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_target_flags = ` | string value | 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. |
|
| string value | Sets the behavior of the iSCSI target to either perform write-back(on) or write-through(off). This parameter is valid if target_helper is set to tgtadm. |
|
| string value | The name of the iSER target user-land tool to use |
|
| string value | The IP address that the iSER daemon is listening on |
|
| port value | The port that the iSER daemon is listening on |
|
| string value | Prefix for iSER volumes |
|
| string value | LBA Format for new volume |
|
| string value | Lenovo api interface protocol. |
|
| list value | List of comma-separated target iSCSI IP addresses. |
|
| string value | Pool or Vdisk name to use for volume creation. |
|
| string value | linear (for VDisk) or virtual (for Pool). |
|
| boolean value | Whether to verify Lenovo array SSL certificate. |
|
| string value | Lenovo array SSL certificate path. |
|
| list value | The IP addresses of the LightOS API servers separated by commas. |
|
| port value | The TCP/IP port at which the LightOS API endpoints listen. Port 443 is used for HTTPS and other values are used for HTTP. |
|
| integer value | The default amount of time (in seconds) to wait for an API endpoint response. |
|
| boolean value | Set to True to create new volumes compressed assuming no other compression setting is specified via the volumes type. |
|
| integer value | The default number of replicas to create for each volume. |
|
| string value | JWT to be used for volume and snapshot operations with the LightOS cluster. Do not set this parameter if the cluster is installed with multi-tenancy disabled. |
|
| integer value | Autoplace replication count on volume deployment. 0 = Full cluster replication without autoplace, 1 = Single node deployment without replication, 2 or greater = Replicated deployment with autoplace. |
|
| boolean value | True means Cinder node is a diskless LINSTOR node. |
|
| integer value | Default Block size for Image restoration. When using iSCSI transport, this option specifies the block size. |
|
| string value | Default Storage Pool name for LINSTOR. |
|
| string value | Default storage URI for LINSTOR. |
|
| string value | Default Volume Group name for LINSTOR. Not Cinder Volume. |
|
| floating point value | Default volume downscale size in KiB = 4 MiB. |
|
| boolean value | Enable/disable load balancing for a PowerMax backend. |
|
| boolean value | Enable/disable real-time performance metrics for Port level load balancing for a PowerMax backend. |
|
| string value | Performance data format, not applicable for real-time metrics. Available options are "avg" and "max". |
|
| integer value | How far in minutes to look back for diagnostic performance metrics in load calculation, minimum of 0 maximum of 1440 (24 hours). |
|
| integer value | How far in minutes to look back for real-time performance metrics in load calculation, minimum of 1 maximum of 10. |
| `lss_range_for_cg = ` | string value | Reserve LSSs for consistency group. |
|
| string value | LVM conf file to use for the LVM driver in Cinder; this setting is ignored if the specified file does not exist (You can also specify None to not use a conf file even if one exists). |
|
| integer value | If >0, create LVs with multiple mirrors. Note that this requires lvm_mirrors + 2 PVs with available space |
|
| boolean value | Whether to share the same target for all LUNs or not (currently only supported by nvmet. |
|
| boolean value | Suppress leaked file descriptor warnings in LVM commands. |
|
| string value | Type of LVM volumes to deploy; (default, thin, or auto). Auto defaults to thin if thin is supported. |
|
| list value | Macrosan iscsi_clients list. You can configure multiple clients. You can configure it in this format: (host; client_name; sp1_iscsi_port; sp2_iscsi_port), (host; client_name; sp1_iscsi_port; sp2_iscsi_port) Important warning, Client_name has the following requirements: [a-zA-Z0-9.-_:], the maximum number of characters is 31 E.g: (controller1; device1; eth-1:0; eth-2:0), (controller2; device2; eth-1:0/eth-1:1; eth-2:0/eth-2:1), |
|
| string value | This is the default connection ports' name for iscsi. This default configuration is used when no host related information is obtained.E.g: eth-1:0/eth-1:1; eth-2:0/eth-2:1 |
|
| boolean value | In the case of an FC connection, the configuration item associated with the port is maintained. |
|
| integer value | The use_sp_port_nr parameter is the number of online FC ports used by the single-ended memory when the FC connection is established in the switch non-all-pass mode. The maximum is 4 |
|
| boolean value | Force disconnect while deleting volume |
|
| boolean value | Whether enable log timing |
|
| string value | Pool to use for volume creation |
|
| list value | Slave device |
|
| list value | MacroSAN replication devices' ip addresses |
|
| string value | MacroSAN replication devices' password |
|
| string value | MacroSAN replication devices' username |
|
| list value | MacroSAN sdas devices' ip addresses |
|
| string value | MacroSAN sdas devices' password |
|
| string value | MacroSAN sdas devices' username |
|
| floating point value | Set snapshot’s resource ratio |
|
| integer value | Set the thin lun’s extent size |
|
| integer value | Set the thin lun’s high watermark |
|
| integer value | Set the thin lun’s low watermark |
| `management_ips = ` | string value | List of Management IP addresses (separated by commas) |
|
| integer value | Default max number of LUNs in a storage group. By default, the value is 255. |
|
| string value | Representation of the over subscription ratio when thin provisioning is enabled. 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. If ratio is auto, Cinder will automatically calculate the ratio based on the provisioned capacity and the used space. If not set to auto, the ratio has to be a minimum of 1.0. |
|
| integer value | Max resource count allowed for Tatlin |
|
| string value | The remote metro device domain name. |
|
| string value | The remote metro device request url. |
|
| string value | The remote metro device san password. |
|
| string value | The remote metro device san user. |
|
| string value | The remote metro device pool names. |
| `nas_host = ` | string value | IP address or Hostname of NAS system. |
|
| string value | User name to connect to NAS system. |
|
| string value | Options used to mount the storage backend file system where Cinder volumes are stored. |
| `nas_password = ` | string value | Password to connect to NAS system. |
| `nas_private_key = ` | string value | Filename of private key to use for SSH authentication. |
|
| string value | 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. |
|
| string value | 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 value | 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 . |
|
| port value | SSH port to use to connect to NAS system. |
|
| string value | Provisioning type that will be used when creating volumes. |
|
| string value | Naviseccli Path. |
|
| integer value | Interval in seconds to check asynchronous copying status during a copy pair deletion or data restoration. |
|
| list value | IDs of the storage ports used to attach volumes to compute nodes. To specify multiple ports, connect them by commas (e.g. CL1-A,CL2-A). |
|
| integer value | Interval in seconds to check copying status during a volume copy. |
|
| integer value | Copy speed of storage system. 1 or 2 indicates low speed, 3 indicates middle speed, and a value between 4 and 15 indicates high speed. |
|
| boolean value | Enable or disable zero page reclamation in a DP-VOL. |
|
| integer value | Retry interval in seconds for REST API execution. |
|
| integer value | Maximum wait time in seconds for a volume extention to complete. |
|
| boolean value | If True, the driver will create host groups or iSCSI targets on storage ports as needed. |
|
| boolean value | If True, the driver will delete host groups or iSCSI targets on storage ports as needed. |
|
| list value | Host mode option for host group or iSCSI target |
|
| string value | Range of the LDEV numbers in the format of xxxx-yyyy that can be used by the driver. Values can be in decimal format (e.g. 1000) or in colon-separated hexadecimal format (e.g. 00:03:E8). |
|
| integer value | Maximum wait time in seconds for storage to be unlocked. |
|
| integer value | Retry interval in seconds for REST API adding a LUN. |
|
| integer value | Maximum wait time in seconds for adding a LUN to complete. |
|
| list value | Pool number[s] or pool name[s] of the DP pool. |
|
| integer value | Retry time in seconds when new LUN allocation request fails. |
|
| integer value | Maximum wait time in seconds for REST API connection to complete. |
|
| boolean value | It may take some time to detach volume after I/O. This option will allow detaching volume to complete immediately. |
|
| integer value | Maximum wait time in seconds for a response against GET method of REST API. |
|
| integer value | Maximum wait time in seconds for a response from REST API. |
|
| integer value | Loop interval in seconds for keeping REST API session. |
|
| integer value | Maximum wait time in seconds when REST API returns busy. |
|
| boolean value | Enables or disables use of REST API tcp keepalive |
|
| integer value | Maximum number of transmissions for TCP keepalive packet. |
|
| integer value | Wait time in seconds for sending a first TCP keepalive packet. |
|
| integer value | Interval of transmissions in seconds for TCP keepalive packet. |
|
| integer value | Maximum wait time in seconds for REST API execution to complete. |
|
| integer value | Maximum wait time in seconds for the restore operation to complete. |
|
| string value | Pool number or pool name of the snapshot pool. |
|
| integer value | Maximum wait time in seconds for a volume transition to complete. |
|
| string value | Product number of the storage system. |
|
| list value | IDs of the storage ports used to attach volumes to the controller node. To specify multiple ports, connect them by commas (e.g. CL1-A,CL2-A). |
|
| boolean value | If True, the driver will configure FC zoning between the server and the storage system provided that FC zoning manager is enabled. |
|
| string value |
A regular expression to limit the API tracing. This option is honored only if enabling |
|
| integer value | The maximum time in seconds to wait for completing a REST asynchronous operation. |
|
| string value | 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. |
|
| boolean value | Set to True for Cinder to query the storage system in order to calculate volumes provisioned size, otherwise provisioned_capacity_gb will corresponds to the value of allocated_capacity_gb (calculated by Cinder Core code). Enabling this feature increases the number of API calls to the storage and requires more processing on host, which may impact volume report overall performance. |
|
| string value | This option defines the type of operating system for all initiators that can access a LUN. This information is used when mapping LUNs to individual hosts or groups of hosts. |
|
| string value | Administrative user account name used to access the storage system or proxy server. |
|
| string value | This option defines the type of operating system that will access a LUN exported from Data ONTAP; it is assigned to the LUN at the time it is created. |
|
| string value | This option determines if storage space is reserved for LUN allocation. If enabled, LUNs are thick provisioned. If space reservation is disabled, storage space is allocated on demand. |
|
| integer value | Sets time in seconds to wait for storage assisted volume migration to complete. |
|
| string value | This option defines the type of operating system that will access a namespace exported from Data ONTAP; it is assigned to the namespace at the time it is created. |
|
| integer value | Sets time in seconds between NFS image cache cleanup tasks. |
|
| string value | Password for the administrative user account specified in the netapp_login option. |
|
| string value | This option is used to restrict provisioning to the specified pools. Specify the value of this option to be a regular expression which will be applied to the names of objects from the storage backend which represent pools in Cinder. This option is only utilized when the storage protocol is configured to use iSCSI or FC. |
|
| dict value | Multi opt of dictionaries to represent the aggregate mapping between source and destination back ends when using whole back end replication. For every source aggregate associated with a cinder pool (NetApp FlexVol/FlexGroup), you would need to specify the destination aggregate on the replication target device. A replication target device is configured with the configuration option replication_device. Specify this option as many times as you have replication devices. Each entry takes the standard dict config form: netapp_replication_aggregate_map = backend_id:<name_of_replication_device_section>,src_aggr_name1:dest_aggr_name1,src_aggr_name2:dest_aggr_name2,… |
|
| integer value | Sets time in seconds to wait for a replication volume create to complete and go online. |
|
| string value | The hostname (or IP address) for the storage system or proxy server. |
|
| integer value | 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. |
|
| floating point value | 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. Note: this option is deprecated and will be removed in favor of "reserved_percentage" in the Mitaka release. |
|
| integer value | The maximum time in seconds to wait for existing SnapMirror transfers to complete before aborting during a failover. |
|
| string value | The path to a CA_BUNDLE file or directory with certificates of trusted CA. If set to a directory, it must have been processed using the c_rehash utility supplied with OpenSSL. If not informed, it will use the Mozilla’s carefully curated collection of Root Certificates for validating the trustworthiness of SSL certificates. Only applies with new REST client. |
|
| string value | The storage family type used on the storage system; the only valid value is ontap_cluster for using clustered Data ONTAP. |
|
| string value | The storage protocol to be used on the data path with the storage system. |
|
| string value | The transport protocol used when communicating with the storage system or proxy server. |
|
| boolean value | Select which ONTAP client to use for retrieving and modifying data on the storage. The legacy client relies on ZAPI calls. If set to False, the new REST client is used, which runs REST calls if supported, otherwise falls back to the equivalent ZAPI call. |
|
| string value | This option specifies the virtual storage server (Vserver) name on the storage cluster on which provisioning of block storage volumes should occur. |
|
| integer value | Block size for datasets |
|
| integer value | NexentaEdge iSCSI LUN object chunk size |
| `nexenta_client_address = ` | string value | NexentaEdge iSCSI Gateway client address for non-VIP service |
|
| string value | Compression value for new ZFS folders. |
|
| string value | Deduplication value for new ZFS folders. |
| `nexenta_dataset_description = ` | string value | Human-readable description for the folder. |
|
| boolean value | Defines whether NexentaEdge iSCSI LUN object has encryption enabled. |
| `nexenta_folder = ` | string value | A folder where cinder created datasets will reside. |
|
| string value | Template string to generate group snapshot name |
| `nexenta_host = ` | string value | IP address of NexentaStor Appliance |
|
| string value | Prefix for iSCSI host groups on NexentaStor |
|
| integer value | NexentaEdge iSCSI LUN object IOPS limit |
| `nexenta_iscsi_service = ` | string value | NexentaEdge iSCSI service name |
|
| string value | Group of hosts which are allowed to access volumes |
| `nexenta_iscsi_target_portal_groups = ` | string value | NexentaStor target portal groups |
|
| integer value | Nexenta appliance iSCSI target portal port |
| `nexenta_iscsi_target_portals = ` | string value | Comma separated list of portals for NexentaStor5, in format of IP1:port1,IP2:port2. Port is optional, default=3260. Example: 10.10.10.1:3267,10.10.1.2 |
|
| boolean value | Postponed write to backing store or not |
| `nexenta_lun_container = ` | string value | NexentaEdge logical path of bucket for LUNs |
|
| integer value | Amount of LUNs per iSCSI target |
|
| string value | Base directory that contains NFS share mount points |
|
| string value | NexentaEdge logical path of directory to store symbolic links to NBDs |
|
| boolean value | If set True cache NexentaStor appliance volroot option value. |
|
| integer value | Block size for datasets |
|
| string value | Template string to generate origin name of clone |
|
| string value | Password to connect to NexentaStor management REST API server |
|
| boolean value | Create volumes as QCOW2 files rather than raw files |
|
| integer value | NexentaEdge iSCSI LUN object replication count. |
| `nexenta_rest_address = ` | string value | IP address of NexentaStor management REST API endpoint |
|
| floating point value | Specifies the backoff factor to apply between connection attempts to NexentaStor management REST API server |
|
| floating point value | Specifies the time limit (in seconds), within which the connection to NexentaStor management REST API server must be established |
|
| string value | Password to connect to NexentaEdge. |
|
| integer value | HTTP(S) port to connect to NexentaStor management REST API server. If it is equal zero, 8443 for HTTPS and 8080 for HTTP is used |
|
| string value | Use http or https for NexentaStor management REST API connection (default auto) |
|
| floating point value | Specifies the time limit (in seconds), within which NexentaStor management REST API server must send a response |
|
| integer value | Specifies the number of times to repeat NexentaStor management REST API call in case of connection errors and NexentaStor appliance EBUSY or ENOENT errors |
|
| string value | User name to connect to NexentaEdge. |
|
| integer value | Enable stream compression, level 1..9. 1 - gives best speed; 9 - gives best compression. |
|
| integer value | Number of TCP connections. |
|
| integer value | TCP Buffer size in KiloBytes. |
|
| string value | File with the list of available nfs shares |
|
| boolean value | Enables or disables the creation of sparse datasets |
|
| boolean value | 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. |
|
| string value | Prefix for iSCSI target groups on NexentaStor |
|
| string value | iqn prefix for NexentaStor iSCSI targets |
|
| boolean value | Use HTTP secure protocol for NexentaStor management REST API connections |
|
| string value | User name to connect to NexentaStor management REST API server |
|
| string value | NexentaStor pool name that holds all volumes |
|
| string value | Volume group for NexentaStor5 iSCSI |
|
| integer value | 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. |
|
| string value | Mount options passed to the NFS client. See the NFS(5) man page for details. |
|
| string value | Base dir containing mount points for NFS shares. |
|
| boolean value | Create volumes as QCOW2 files rather than raw files. |
|
| string value | File with the list of available NFS shares. |
|
| boolean value | Enable support for snapshots on the NFS driver. Platforms using libvirt <1.2.7 will encounter issues with this feature. |
|
| boolean value | 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. |
|
| string value | Nimble Controller pool name |
|
| string value | Nimble Subnet Label |
|
| string value | Path to Nimble Array SSL certificate |
|
| boolean value | Whether to verify Nimble SSL Certificate |
|
| integer value | The maximum number of times to rescan iSER target to find volume |
|
| integer value | Number of times to attempt to run flakey shell commands |
|
| integer value | The maximum number of times to rescan targets to find volume |
|
| integer value | NVMe os-brick connector has 2 different connection info formats, this allows some NVMe-oF drivers that use the original format (version 1), such as spdk and LVM-nvmet, to send the newer format. |
|
| integer value | Namespace id for the subsystem for the LVM volume when not sharing targets. The minimum id value when sharing.Maximum supported value in Linux is 8192 |
|
| port value | The id of the NVMe target port definition when not sharing targets. The starting port id value when sharing, incremented for each secondary ip address. |
|
| integer value | Max resource count allowed for single pool |
| `pool_name = ` | string value | storage pool name |
|
| string value | Metric used for port group load calculation. |
|
| string value | Metric used for port load calculation. |
|
| boolean value | Allow volume migration during rebuild. |
|
| boolean value | Allow volumes to be created in Storage Pools when zero padding is disabled. This option should not be enabled if multiple tenants will utilize volumes from a shared Storage Pool. |
|
| floating point value | max_over_subscription_ratio setting for the driver. Maximum value allowed is 10.0. |
|
| port value | Gateway REST server port. |
|
| boolean value | Round volume sizes up to 8GB boundaries. PowerFlex/VxFlex OS requires volumes to be sized in multiples of 8GB. If set to False, volume creation will fail for volumes not sized properly |
|
| string value | PowerFlex/ScaleIO API version. This value should be left as the default value unless otherwise instructed by technical support. |
|
| string value | Storage Pools. Comma separated list of storage pools used to provide volumes. Each pool should be specified as a protection_domain_name:storage_pool_name value |
|
| boolean value | Unmap volumes before deletion. |
|
| string value | Serial number of the array to connect to. |
|
| list value | List of user assigned name for storage array. |
|
| string value | User defined override for port group name. |
|
| list value | List of port groups containing frontend ports configured prior for server connection. |
|
| string value | Service level to use for provisioning storage. Setting this as an extra spec in pool_name is preferable. |
|
| string value | User defined override for short host name. |
|
| string value | Storage resource pool on array to use for provisioning. |
|
| list value | Appliances names. Comma separated list of PowerStore appliances names used to provision volumes. Deprecated since: Wallaby *Reason:*Is not used anymore. PowerStore Load Balancer is used to provision volumes instead. |
|
| boolean value | Connect PowerStore volumes using NVMe-OF. |
|
| list value | Allowed ports. Comma separated list of PowerStore iSCSI IPs or FC WWNs (ex. 58:cc:f0:98:49:22:07:02) to be used. If option is not set all ports are allowed. |
|
| string value | Proxy driver that connects to the IBM Storage Array |
|
| string value | REST API authorization token. |
|
| boolean value | 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. |
|
| boolean value | 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. |
|
| string value | Determines how the Purity system tunes the protocol used between the array and the initiator. |
|
| string value | CIDR of FlashArray iSCSI targets hosts are allowed to connect to. Default will allow connection to any IPv4 address. This parameter now supports IPv6 subnets. Ignored when pure_iscsi_cidr_list is set. |
|
| list value | Comma-separated list of CIDR of FlashArray iSCSI targets hosts are allowed to connect to. It supports IPv4 and IPv6 subnets. This parameter supersedes pure_iscsi_cidr. |
|
| string value | CIDR of FlashArray NVMe targets hosts are allowed to connect to. Default will allow connection to any IPv4 address. This parameter now supports IPv6 subnets. Ignored when pure_nvme_cidr_list is set. |
|
| list value | Comma-separated list of CIDR of FlashArray NVMe targets hosts are allowed to connect to. It supports IPv4 and IPv6 subnets. This parameter supersedes pure_nvme_cidr. |
|
| string value | The NVMe transport layer to be used by the NVMe driver. |
|
| integer value | Snapshot replication interval in seconds. |
|
| integer value | Retain snapshots per day on target for this time (in days.) |
|
| integer value | Retain how many snapshots for each day. |
|
| integer value | Retain all snapshots on target for this time (in seconds.) |
|
| string value | Pure Protection Group name to use for async replication (will be created if it does not exist). |
|
| string value | Pure Pod name to use for sync replication (will be created if it does not exist). |
|
| boolean value | When enabled and two replication devices are provided, one each of types sync and async, this will enable the ability to create a volume that is sync replicated to one array and async replicated to a separate array. |
|
| string value | Pure Protection Group name to use for trisync replication leg inside the sync replication pod (will be created if it does not exist). |
|
| list value | List of comma-separated target iSCSI IP addresses. |
|
| string value | Pool or Vdisk name to use for volume creation. |
|
| uri value | The URL to management QNAP Storage. Driver does not support IPv6 address in URL. |
|
| string value | The pool name in the QNAP Storage |
|
| string value | Communication protocol to access QNAP storage |
|
| string value | Path to a Quobyte Client configuration file. |
|
| string value | Base dir containing the mount point for the Quobyte volume. |
|
| boolean value | Create new volumes from the volume_from_snapshot_cache by creating overlay files instead of full copies. This speeds up the creation of volumes from this cache. This feature requires the options quobyte_qcow2_volumes and quobyte_volume_from_snapshot_cache to be set to True. If one of these is set to False this option is ignored. |
|
| boolean value | Create volumes as QCOW2 files rather than raw files. |
|
| boolean value | Create volumes as sparse files which take no space. If set to False, volume is created as regular file. |
|
| boolean value | Create a cache of volumes from merged snapshots to speed up creation of multiple volumes from a single snapshot. |
|
| string value | Quobyte URL to the Quobyte volume using e.g. a DNS SRV record (preferred) or a host list (alternatively) like quobyte://<DIR host1>, <DIR host2>/<volume name> |
|
| integer value | Timeout value (in seconds) used when connecting to ceph cluster. If value < 0, no timeout is set and default librados value is used. |
|
| integer value | Interval value (in seconds) between connection retries to ceph cluster. |
|
| integer value | Number of retries if connection to ceph cluster failed. |
| `rbd_ceph_conf = ` | string value | Path to the ceph configuration file |
|
| string value | The name of ceph cluster |
|
| integer value | Number of flatten operations that will run concurrently on this volume service. |
|
| boolean value | Set to False if the pool is shared with other usages. On exclusive use driver won’t query images' provisioned size as they will match the value calculated by the Cinder core code for allocated_capacity_gb. This reduces the load on the Ceph cluster as well as on the volume service. On non exclusive use driver will query the Ceph cluster for per image used disk, this is an intensive operation having an independent request for each image. |
|
| boolean value | Flatten volumes created from snapshots to remove dependency from volume to snapshot |
|
| boolean value | Enable client request debugging. |
| `rbd_iscsi_api_password = ` | string value | The username for the rbd_target_api service |
| `rbd_iscsi_api_url = ` | string value | The url to the rbd_target_api service |
| `rbd_iscsi_api_user = ` | string value | The username for the rbd_target_api service |
|
| string value | The preconfigured target_iqn on the iscsi gateway. |
|
| integer value | Maximum number of nested volume clones that are taken before a flatten occurs. Set to 0 to disable cloning. Note: lowering this value will not affect existing volumes whose clone depth exceeds the new value. |
|
| string value | The RADOS pool where rbd volumes are stored |
|
| string value | The libvirt uuid of the secret for the rbd_user volumes. Defaults to the cluster FSID. |
|
| integer value | Volumes will be chunked into objects of this size (in megabytes). |
|
| string value | The RADOS client name for accessing rbd volumes - only set when using cephx authentication |
|
| boolean value | To remove the host from Unity when the last LUN is detached from it. By default, it is False. |
|
| integer value | Timeout value (in seconds) used when connecting to ceph cluster to do a demotion/promotion of volumes. If value < 0, no timeout is set and default librados value is used. |
|
| dict value | 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… |
|
| boolean value | 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. |
|
| boolean value | Set to True for driver to report total capacity as a dynamic value (used + current free) and to False to report a static value (quota max bytes if defined and global size of cluster if not). |
|
| integer value | The percentage of backend capacity is reserved |
|
| integer value | Use this value to specify number of retries. |
|
| port value | Port to use to access the SAN API |
| `san_clustername = ` | string value | Cluster name to use for creating volumes |
| `san_ip = ` | string value | IP address of SAN controller |
|
| boolean value | Execute commands locally instead of over SSH; use if the volume service is running on the SAN device |
|
| string value | Username for SAN controller |
| `san_password = ` | string value | Password for SAN controller |
| `san_private_key = ` | string value | Filename of private key to use for SSH authentication |
|
| port value | SSH port to use with SAN |
|
| boolean value | Use thin provisioning for SAN volumes? |
|
| string value | SCST target implementation can choose from multiple SCST target drivers. |
|
| string value | Certain ISCSI targets have predefined target names, SCST target driver uses this name. |
|
| list value | List of comma-separated target iSCSI IP addresses. |
|
| string value | Pool or vdisk name to use for volume creation. |
|
| string value | linear (for vdisk) or virtual (for virtual pool). |
| `secondary_san_ip = ` | string value | IP address of secondary DSM controller |
|
| string value | Secondary DSM user name |
| `secondary_san_password = ` | string value | Secondary DSM user password name |
|
| port value | Secondary Dell API port |
|
| string value | 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 hostname (previous default behavior). The default is NO prefix. |
|
| boolean value | Allow tenants to specify QOS on create |
|
| port value | SolidFire API port. Useful if the device api is behind a proxy on a different port. |
|
| integer value | Sets time in seconds to wait for an api request to complete. |
|
| integer value | Sets time in seconds to wait for clusters to complete pairing. |
|
| boolean value | Set 512 byte emulation on volume creation; |
|
| boolean value | Utilize volume access groups on a per-tenant basis. |
|
| string value | Change how SolidFire reports used space and provisioning calculations. If this parameter is set to usedSpace, the driver will report correct values as expected by Cinder thin provisioning. |
|
| string value | Overrides default cluster SVIP with the one specified. This is required or deployments that have implemented the use of VLANs for iSCSI networks in their cloud. |
|
| integer value | Sets time in seconds to wait for a clone of a volume or snapshot to complete. |
|
| integer value | Sets time in seconds to wait for a create volume operation to complete. |
|
| integer value | Sets time in seconds to wait for a migrating volume to complete pairing and sync. |
|
| string value | Create SolidFire volumes with this prefix. Volume names are of the form <sf_volume_prefix><cinder-volume-id>. The default is to use a prefix of UUID-. |
|
| string value | Default format that will be used when creating volumes if no volume format is specified. |
|
| string value | Base dir containing mount points for smbfs shares. |
|
| dict value | Mappings between share locations and pool names. If not specified, the share names will be used as pool names. Example: //addr/share:pool_name,//addr/share2:pool_name2 |
|
| string value | File with the list of available smbfs shares. |
|
| integer value | Queue depth for rdma transport. |
|
| string value | The NVMe target remote configuration IP address. |
|
| string value | The NVMe target remote configuration password. |
|
| port value | The NVMe target remote configuration port. |
|
| string value | Protocol to be used with SPDK RPC proxy |
|
| string value | The NVMe target remote configuration username. |
|
| integer value | SSH connection timeout in seconds |
|
| integer value | Maximum ssh connections in the pool |
|
| integer value | Minimum ssh connections in the pool |
|
| string value | Protocol for transferring data between host and storage back-end. |
|
| string value | VNX authentication scope type. By default, the value is global. |
|
| list value | Comma-separated list of storage pool names to be used. |
|
| string value | Directory path that contains the VNX security file. Make sure the security file is generated first. |
|
| integer value | 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. |
|
| string value | The StorPool template for volumes with no type. |
|
| string value | Specifies the name of the peer pool for hyperswap volume, the peer pool must exist on the other site. |
|
| string value | Specifies the name of the portset in which the host is to be created. |
|
| dict value | Specifies the site information for host. One WWPN or multi WWPNs used in the host can be specified. For example: storwize_preferred_host_site=site1:wwpn1,site2:wwpn2&wwpn3 or storwize_preferred_host_site=site1:iqn1,site2:iqn2 |
|
| string value | Specifies secondary management IP or hostname to be used if san_ip is invalid or becomes inaccessible. |
|
| boolean value | Allow tenants to specify QOS on create |
|
| integer value | Specifies the Storwize cleaning rate for the mapping. The default rate is 50, and the valid rates are 0-150. |
|
| integer value | Specifies the Storwize FlashCopy copy rate to be used when creating a full volume copy. The default is rate is 50, and the valid rates are 1-150. |
|
| integer value | Maximum number of seconds to wait for FlashCopy to be prepared. |
|
| boolean value | Configure CHAP authentication for iSCSI connections (Default: Enabled) |
|
| string value | Specifies the name of the pool in which mirrored copy is stored. Example: "pool2" |
|
| boolean value | This option no longer has any affect. It is deprecated and will be removed in the next release. |
|
| boolean value | Connect with multipath (FC only; iSCSI multipath is controlled by Nova) |
|
| boolean value | Enable or disable retaining of aux volume on secondary storage during delete of the volume on primary storage or moving the primary volume from mirror to non-mirror with replication enabled. This option is valid for Storage Virtualize Family. |
|
| string value | Specifies the name of the source child pool in which global mirror source change volume is stored. |
|
| string value | If operating in stretched cluster mode, specify the name of the pool in which mirrored copies are stored.Example: "pool2" |
|
| string value | Specifies the name of the target child pool in which global mirror auxiliary change volume is stored. |
|
| boolean value | Storage system autoexpand parameter for volumes (True/False) |
|
| boolean value | Storage system compression option for volumes |
|
| boolean value | Enable Easy Tier for volumes |
|
| integer value | Storage system grain size parameter for volumes (8/32/64/128/256) |
|
| string value | The I/O group in which to allocate volumes. It can be a comma-separated list in which case the driver will select an io_group based on least number of volumes associated with the io_group. |
|
| boolean value | Specifies that the volume not be formatted during creation. |
|
| integer value | Storage system space-efficiency parameter for volumes (percentage) |
|
| integer value | Storage system threshold for volume capacity warnings (percentage) |
|
| list value | Comma separated list of storage system storage pools for volumes. |
|
| boolean value | Parameter to enable or disable Volume Group(True/False) |
|
| boolean value | Suppress requests library SSL certificate warnings. |
|
| port value | Management port for Synology storage. |
|
| string value | Device id for skip one time password check for logging in Synology storage if OTP is enabled. |
|
| string value | One time password of administrator for logging in Synology storage if OTP is enabled. |
| `synology_password = ` | string value | Password of administrator for logging in Synology storage. |
| `synology_pool_name = ` | string value | Volume on Synology storage to be used for creating lun. |
|
| boolean value | Do certificate validation or not if $driver_use_ssl is True |
|
| string value | Administrator of Synology storage. |
|
| string value | Target user-land tool to use. tgtadm is default, use lioadm for LIO iSCSI support, scstadmin for SCST target support, ietadm for iSCSI Enterprise Target, iscsictl for Chelsio iSCSI Target, nvmet for NVMEoF support, spdk-nvmeof for SPDK NVMe-oF, or fake for testing. Note: The IET driver is deprecated and will be removed in the V release. |
|
| string value | The IP address that the iSCSI/NVMEoF daemon is listening on |
|
| port value | The port that the iSCSI/NVMEoF daemon is listening on |
|
| string value | Prefix for iSCSI/NVMEoF volumes |
|
| string value | Determines the target protocol for new volumes, created with tgtadm, lioadm and nvmet 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", in case of nvmet target set to "nvmet_rdma" or "nvmet_tcp". |
|
| list value | The list of secondary IP addresses of the iSCSI/NVMEoF daemon |
|
| integer value | Number of retry on Tatlin API |
|
| integer value | 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. |
|
| integer value | 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. |
|
| list value | List of options that control which trace info is written to the DEBUG log level to assist developers. Valid values are method and api. |
|
| boolean value | If the driver should automatically failback to the primary instance of Unisphere when a successful connection is re-established. |
|
| integer value | A backoff factor to apply between attempts after the second try (most errors are resolved immediately by a second try without a delay). Retries will sleep for: {backoff factor} * (2 ^ ({number of total retries} - 1)) seconds. |
|
| integer value | The maximum number of retries each connection should attempt. Note, this applies only to failed DNS lookups, socket connections and connection timeouts, never to requests where data has made it to the server. |
|
| dict value | Dictionary of Unisphere failover target info. |
|
| integer value | How long to wait for the server to send data before giving up. |
|
| boolean value | Whether or not our private network has unique FQDN on each initiator or not. For example networks with QA systems usually have multiple servers/VMs with the same FQDN. When true this will create host entries on 3PAR using the FQDN, when false it will use the reversed IQN/WWNN. |
|
| list value | A comma-separated list of iSCSI or FC ports to be used. Each port can be Unix-style glob expressions. |
|
| list value | A comma-separated list of storage pool names to be used. |
|
| boolean value | Option to enable/disable CHAP authentication for targets. |
|
| boolean value | Do we attach/detach volumes in cinder using multipath for volume to image and image to volume transfers? This parameter needs to be configured for each backend section or in [backend_defaults] section as a common configuration for all backends. |
|
| string value | Workload, setting this as an extra spec in pool_name is preferable. |
|
| string value | Default adapter type to be used for attaching volumes. |
|
| integer value | Number of times VMware vCenter server API must be retried upon connection related issues. |
|
| string value | CA bundle file to use in verifying the vCenter server certificate. |
|
| multi valued | Name of a vCenter compute cluster where volumes should be created. |
|
| integer value | Maximum number of connections in http connection pool. |
|
| string value | Regular expression pattern to match the name of datastores where backend volumes are created. |
|
| boolean value | If true, this enables the fetching of the volume stats from the backend. This has potential performance issues at scale. When False, the driver will not collect ANY stats about the backend. |
|
| string value | IP address for connecting to VMware vCenter server. |
|
| string value | Password for authenticating with VMware vCenter server. |
|
| port value | Port number for connecting to VMware vCenter server. |
|
| string value | Username for authenticating with VMware vCenter server. |
|
| string value | Optional string specifying the VMware vCenter server version. The driver attempts to retrieve the version from VMware vCenter server. Set this configuration only if you want to override the vCenter server version. |
|
| integer value | Timeout in seconds for VMDK volume transfer between Cinder and Glance. |
|
| boolean value | If true, the vCenter server certificate is not verified. If false, then the default CA truststore is used for verification. This option is ignored if "vmware_ca_file" is set. |
|
| boolean value | If true, the backend volume in vCenter server is created lazily when the volume is created without any source. The backend volume is created when the volume is attached, uploaded to image service or during backup. |
|
| integer value | Max number of objects to be retrieved per batch. Query results will be obtained in batches from the server and not in one shot. Server may still limit the count to something less than the configured value. |
|
| string value | Volume snapshot format in vCenter server. |
|
| multi valued | Names of storage profiles to be monitored. Only used when vmware_enable_volume_stats is True. |
|
| floating point value | The interval (in seconds) for polling remote tasks invoked on VMware vCenter server. |
|
| string value | Directory where virtual disks are stored during volume backup and restore. |
|
| string value | Name of the vCenter inventory folder that will contain Cinder volumes. This folder will be created under "OpenStack/<project_folder>", where project_folder is of format "Project (<volume_project_id>)". |
|
| string value | Optional VIM service WSDL Location e.g http://<server>/vimService.wsdl. Optional over-ride to default location for bug work-arounds. |
|
| boolean value |
Always use asynchronous migration during volume cloning and creating from snapshot. As described in configuration doc, async migration has some constraints. Besides using metadata, customers could use this option to disable async migration. Be aware that |
|
| string value | The backend name for a given driver implementation |
|
| string value | Method used to wipe old volumes |
|
| string value | 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. |
|
| integer value | Size in MiB to wipe at start of old volumes. 1024 MiB at max. 0 ⇒ all |
|
| string value | The blkio cgroup name to be used to limit bandwidth of volume copy |
|
| integer value | The upper limit of bandwidth of volume copy. 0 ⇒ unlimited |
|
| string value | The default block size used when copying/clearing volumes |
|
| string value | Driver to use for volume creation |
|
| string value | Name for the VG that will contain exported volumes |
|
| string value | Volume configuration file storage directory |
|
| boolean value | renamed to powerflex_allow_migration_during_rebuild. |
|
| boolean value | renamed to powerflex_allow_non_padded_volumes. |
|
| floating point value | renamed to powerflex_max_over_subscription_ratio. |
|
| port value | renamed to powerflex_rest_server_port. |
|
| boolean value | renamed to powerflex_round_volume_capacity. |
|
| string value | renamed to powerflex_server_api_version. |
|
| string value | renamed to powerflex_storage_pools. |
|
| boolean value | renamed to powerflex_round_volume_capacity. |
|
| string value | Default format that will be used when creating volumes if no volume format is specified. |
|
| list value | Mount options passed to the vzstorage client. See section of the pstorage-mount man page for details. |
|
| string value | Base dir containing mount points for vzstorage shares. |
|
| string value | File with the list of available vzstorage shares. |
|
| boolean value | 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. |
|
| floating point value | Percent of ACTUAL usage of the underlying volume before no new volumes can be allocated to the volume destination. |
|
| integer value | Wait number of seconds before re-checking |
|
| integer value | Number of checks for a lengthy operation to finish |
|
| string value | Path to store VHD backed volumes |
|
| integer value | Number of retries in case array is busy |
|
| integer value | Interval between retries in case array is busy |
|
| boolean value | Should the driver remove initiator groups with no volumes after the last connection was terminated. Since the behavior till now was to leave the IG be, we default to False (not deleting IGs without connected volumes); setting this parameter to True will remove any IG after terminating its connection to the last volume. |
| `xtremio_cluster_name = ` | string value | XMS cluster id in multi-cluster environment |
|
| list value | Allowed ports. Comma separated list of XtremIO iSCSI IPs or FC WWNs (ex. 58:cc:f0:98:49:22:07:02) to be used. If option is not set all ports are allowed. |
|
| integer value | Number of volumes created from each cached glance image |
|
| string value | VPSA access key |
|
| boolean value | VPSA - Attach snapshot policy for volumes. If the option is neither configured nor provided as metadata, the VPSA will inherit the default value. |
|
| boolean value | VPSA - Enable compression for volumes. If the option is neither configured nor provided as metadata, the VPSA will inherit the default value. |
|
| boolean value | VPSA - Enable deduplication for volumes. If the option is neither configured nor provided as metadata, the VPSA will inherit the default value. |
|
| boolean value | If set to True the http client will validate the SSL certificate of the VPSA endpoint. |
|
| boolean value | VPSA - Default encryption policy for volumes. If the option is neither configured nor provided as metadata, the VPSA will inherit the default value. |
|
| host address value | VPSA - Management Host name or IP address |
|
| string value | VPSA - Storage Pool assigned for volumes |
|
| port value | VPSA - Port number |
|
| boolean value | VPSA - Use SSL connection |
2.1.4. barbican
The following table outlines the options available under the [barbican] group in the /etc/cinder/cinder.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| string value | Use this endpoint to connect to Keystone |
|
| string value | Version of the Barbican API, for example: "v1" |
|
| string value | Use this endpoint to connect to Barbican, for example: "http://localhost:9311/" |
|
| string value | Specifies the type of endpoint. Allowed values are: public, private, and admin |
|
| string value | Specifies the region of the chosen endpoint. |
|
| integer value | Number of times to retry poll for key creation completion |
|
| integer value | Number of seconds to wait before retrying poll for key creation completion |
|
| boolean value | When True, if sending a user token to a REST API, also send a service token. Nova often reuses the user token provided to the nova-api to talk to other REST APIs, such as Cinder, Glance and Neutron. It is possible that while the user token was valid when the request was made to Nova, the token may expire before it reaches the other service. To avoid any failures, and to make it clear it is Nova calling the service on the user’s behalf, we include a service token along with the user token. Should the user’s token have expired, a valid service token ensures the REST API request will still be accepted by the keystone middleware. |
|
| boolean value | Specifies if insecure TLS (https) requests. If False, the server’s certificate will not be validated, if True, we can set the verify_ssl_path config meanwhile. |
|
| string value | A path to a bundle or CA certs to check against, or None for requests to attempt to locate and use certificates which verify_ssh is True. If verify_ssl is False, this is ignored. |
2.1.5. barbican_service_user
The following table outlines the options available under the [barbican_service_user] group in the /etc/cinder/cinder.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| string value | Config Section from which to load plugin specific options |
|
| string value | Authentication type to load |
|
| string value | PEM encoded Certificate Authority to use when verifying HTTPs connections. |
|
| string value | PEM encoded client certificate cert file |
|
| boolean value | Collect per-API call timing information. |
|
| boolean value | Verify HTTPS connections. |
|
| string value | PEM encoded client certificate key file |
|
| boolean value | Log requests to multiple loggers. |
|
| integer value | Timeout value for http requests |
2.1.6. brcd_fabric_example
The following table outlines the options available under the [brcd_fabric_example] group in the /etc/cinder/cinder.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
| `fc_fabric_address = ` | string value | Management IP of fabric. |
| `fc_fabric_password = ` | string value | Password for user. |
|
| port value | Connecting port |
| `fc_fabric_ssh_cert_path = ` | string value | Local SSH certificate Path. |
| `fc_fabric_user = ` | string value | Fabric user ID. |
|
| string value | South bound connector for the fabric. |
|
| string value | Virtual Fabric ID. |
|
| boolean value | Overridden zoning activation state. |
|
| string value | Overridden zone name prefix. |
|
| string value | Overridden zoning policy. |
2.1.7. cisco_fabric_example
The following table outlines the options available under the [cisco_fabric_example] group in the /etc/cinder/cinder.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
| `cisco_fc_fabric_address = ` | string value | Management IP of fabric |
| `cisco_fc_fabric_password = ` | string value | Password for user |
|
| port value | Connecting port |
| `cisco_fc_fabric_user = ` | string value | Fabric user ID |
|
| boolean value | overridden zoning activation state |
|
| string value | overridden zone name prefix |
|
| string value | overridden zoning policy |
|
| string value | VSAN of the Fabric |
2.1.8. coordination
The following table outlines the options available under the [coordination] group in the /etc/cinder/cinder.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| string value | The backend URL to use for distributed coordination. |
2.1.9. cors
The following table outlines the options available under the [cors] group in the /etc/cinder/cinder.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| boolean value | Indicate that the actual request can include user credentials |
|
| list value | Indicate which header field names may be used during the actual request. |
|
| list value | Indicate which methods can be used during the actual request. |
|
| list value | Indicate whether this resource may be shared with the domain received in the requests "origin" header. Format: "<protocol>://<host>[:<port>]", no trailing slash. Example: https://horizon.example.com |
|
| list value | Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. |
|
| integer value | Maximum cache age of CORS preflight requests. |
2.1.10. database
The following table outlines the options available under the [database] group in the /etc/cinder/cinder.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| string value | The back end to use for the database. |
|
| string value | The SQLAlchemy connection string to use to connect to the database. |
|
| integer value | Verbosity of SQL debugging information: 0=None, 100=Everything. |
| `connection_parameters = ` | string value | Optional URL parameters to append onto the connection URL at connect time; specify as param1=value1¶m2=value2&… |
|
| integer value | Connections which have been present in the connection pool longer than this number of seconds will be replaced with a new one the next time they are checked out from the pool. |
|
| boolean value | Add Python stack traces to SQL as comment strings. |
|
| boolean value | If True, increases the interval between retries of a database operation up to db_max_retry_interval. |
|
| integer value | Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count. |
|
| integer value | If db_inc_retry_interval is set, the maximum seconds between retries of a database operation. |
|
| integer value | Seconds between retries of a database transaction. |
|
| integer value | If set, use this value for max_overflow with SQLAlchemy. |
|
| integer value | Maximum number of SQL connections to keep open in a pool. Setting a value of 0 indicates no limit. |
|
| integer value | Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. |
|
| boolean value | If True, transparently enables support for handling MySQL Cluster (NDB). Deprecated since: 12.1.0 *Reason:*Support for the MySQL NDB Cluster storage engine has been deprecated and will be removed in a future release. |
|
| string value | 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= |
|
| integer value | For Galera only, configure wsrep_sync_wait causality checks on new connections. Default is None, meaning don’t configure any setting. |
|
| integer value | If set, use this value for pool_timeout with SQLAlchemy. |
|
| integer value | Interval between retries of opening a SQL connection. |
|
| string value | The SQLAlchemy connection string to use to connect to the slave database. |
|
| boolean value | If True, SQLite uses synchronous mode. |
|
| boolean value | Enable the experimental use of database reconnect on connection lost. |
2.1.11. fc-zone-manager
The following table outlines the options available under the [fc-zone-manager] group in the /etc/cinder/cinder.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| string value | South bound connector for zoning operation |
|
| string value | Southbound connector for zoning operation |
|
| boolean value | Set this to True when you want to allow an unsupported zone manager driver to start. Drivers that haven’t maintained a working CI system and testing are marked as unsupported until CI is working again. This also marks a driver as deprecated and may be removed in the next release. |
|
| string value | Comma separated list of Fibre Channel fabric names. This list of names is used to retrieve other SAN credentials for connecting to each SAN fabric |
|
| string value | FC SAN Lookup Service |
|
| string value | FC Zone Driver responsible for zone management |
|
| string value | Zoning policy configured by user; valid values include "initiator-target" or "initiator" |
2.1.12. healthcheck
The following table outlines the options available under the [healthcheck] group in the /etc/cinder/cinder.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| list value | Additional backends that can perform health checks and report that information back as part of a request. |
|
| boolean value | Show more detailed information as part of the response. Security note: Enabling this option may expose sensitive details about the service being monitored. Be sure to verify that it will not violate your security policies. |
|
| string value | Check the presence of a file to determine if an application is running on a port. Used by DisableByFileHealthcheck plugin. |
|
| list value | Check the presence of a file based on a port to determine if an application is running on a port. Expects a "port:path" list of strings. Used by DisableByFilesPortsHealthcheck plugin. |
|
| string value | The path to respond to healtcheck requests on. |
2.1.13. key_manager
The following table outlines the options available under the [key_manager] group in the /etc/cinder/cinder.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| string value | The type of authentication credential to create. Possible values are token, password, keystone_token, and keystone_password. Required if no context is passed to the credential factory. |
|
| string value | Use this endpoint to connect to Keystone. |
|
| string value | Specify the key manager implementation. Options are "barbican" and "vault". Default is "barbican". Will support the values earlier set using [key_manager]/api_class for some time. |
|
| string value | Domain ID for domain scoping. Optional for keystone_token and keystone_password auth_type. |
|
| string value | Domain name for domain scoping. Optional for keystone_token and keystone_password auth_type. |
|
| string value | Fixed key returned by key manager, specified in hex |
|
| string value | Password for authentication. Required for password and keystone_password auth_type. |
|
| string value | Project’s domain ID for project. Optional for keystone_token and keystone_password auth_type. |
|
| string value | Project’s domain name for project. Optional for keystone_token and keystone_password auth_type. |
|
| string value | Project ID for project scoping. Optional for keystone_token and keystone_password auth_type. |
|
| string value | Project name for project scoping. Optional for keystone_token and keystone_password auth_type. |
|
| boolean value | Allow fetching a new token if the current one is going to expire. Optional for keystone_token and keystone_password auth_type. |
|
| string value | Token for authentication. Required for token and keystone_token auth_type if no context is passed to the credential factory. |
|
| string value | Trust ID for trust scoping. Optional for keystone_token and keystone_password auth_type. |
|
| string value | User’s domain ID for authentication. Optional for keystone_token and keystone_password auth_type. |
|
| string value | User’s domain name for authentication. Optional for keystone_token and keystone_password auth_type. |
|
| string value | User ID for authentication. Optional for keystone_token and keystone_password auth_type. |
|
| string value | Username for authentication. Required for password auth_type. Optional for the keystone_password auth_type. |
2.1.14. keystone_authtoken
The following table outlines the options available under the [keystone_authtoken] group in the /etc/cinder/cinder.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| string value | Config Section from which to load plugin specific options |
|
| string value | Authentication type to load |
|
| string value | Complete "public" Identity API endpoint. This endpoint should not be an "admin" endpoint, as it should be accessible by all end users. Unauthenticated clients are redirected to this endpoint to authenticate. Although this endpoint should ideally be unversioned, client support in the wild varies. If you’re using a versioned v2 endpoint here, then this should not be the same endpoint the service user utilizes for validating tokens, because normal end users may not be able to reach that endpoint. This option is deprecated in favor of www_authenticate_uri and will be removed in the S release. Deprecated since: Queens *Reason:*The auth_uri option is deprecated in favor of www_authenticate_uri and will be removed in the S release. |
|
| string value | API version of the Identity API endpoint. |
|
| string value |
Request environment key where the Swift cache object is stored. When auth_token middleware is deployed with a Swift cache, use this option to have the middleware share a caching backend with swift. Otherwise, use the |
|
| string value | A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. |
|
| string value | Required if identity server requires client certificate |
|
| boolean value | Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components. |
|
| string value | 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. |
|
| integer value | Request timeout value for communicating with Identity API server. |
|
| integer value | How many times are we trying to reconnect when communicating with Identity API Server. |
|
| boolean value | (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. |
|
| boolean value | Verify HTTPS connections. |
|
| string value | Interface to use for the Identity API endpoint. Valid values are "public", "internal" (default) or "admin". |
|
| string value | Required if identity server requires client certificate |
|
| integer value | (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool. |
|
| integer value | (Optional) Number of seconds memcached server is considered dead before it is tried again. |
|
| integer value | (Optional) Maximum total number of open connections to every memcached server. |
|
| integer value | (Optional) Socket timeout in seconds for communicating with a memcached server. |
|
| integer value | (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed. |
|
| string value | (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation. |
|
| string value | (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. |
|
| boolean value | (Optional) Use the advanced (eventlet safe) memcached client pool. |
|
| list value | Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. |
|
| string value | The region in which the identity server can be found. |
|
| list value | A choice of roles that must be present in a service token. Service tokens are allowed to request that an expired token can be used and so this check should tightly control that only actual services should be sending this token. Roles here are applied as an ANY check so any role in this list must be present. For backwards compatibility reasons this currently only affects the allow_expired check. |
|
| boolean value | For backwards compatibility reasons we must let valid service tokens pass that don’t pass the service_token_roles check as valid. Setting this true will become the default in a future release and should be enabled if possible. |
|
| string value | The name or type of the service as it appears in the service catalog. This is used to validate tokens that have restricted access rules. |
|
| integer value | 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. |
|
| string value | Complete "public" Identity API endpoint. This endpoint should not be an "admin" endpoint, as it should be accessible by all end users. Unauthenticated clients are redirected to this endpoint to authenticate. Although this endpoint should ideally be unversioned, client support in the wild varies. If you’re using a versioned v2 endpoint here, then this should not be the same endpoint the service user utilizes for validating tokens, because normal end users may not be able to reach that endpoint. |
2.1.15. nova
The following table outlines the options available under the [nova] group in the /etc/cinder/cinder.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| string value | Config Section from which to load plugin specific options |
|
| string value | Authentication type to load |
|
| string value | PEM encoded Certificate Authority to use when verifying HTTPs connections. |
|
| string value | PEM encoded client certificate cert file |
|
| boolean value | Collect per-API call timing information. |
|
| boolean value | Verify HTTPS connections. |
|
| string value | Type of the nova endpoint to use. This endpoint will be looked up in the keystone catalog and should be one of public, internal or admin. |
|
| string value | PEM encoded client certificate key file |
|
| string value | Name of nova region to use. Useful if keystone manages more than one region. |
|
| boolean value | Log requests to multiple loggers. |
|
| integer value | Timeout value for http requests |
|
| string value | The authentication URL for the nova connection when using the current users token |
2.1.16. oslo_concurrency
The following table outlines the options available under the [oslo_concurrency] group in the /etc/cinder/cinder.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| boolean value | Enables or disables inter-process locks. |
|
| string value | 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. |
2.1.17. oslo_messaging_amqp
The following table outlines the options available under the [oslo_messaging_amqp] group in the /etc/cinder/cinder.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| string value | Indicates the addressing mode used by the driver. Permitted values: legacy - use legacy non-routable addressing routable - use routable addresses dynamic - use legacy addresses if the message bus does not support routing otherwise use routable addressing |
|
| string value | Appended to the address prefix when sending to a group of consumers. Used by the message bus to identify messages that should be delivered in a round-robin fashion across consumers. |
|
| string value | address prefix used when broadcasting to all servers |
|
| integer value | Increase the connection_retry_interval by this many seconds after each unsuccessful failover attempt. |
|
| integer value | Seconds to pause before attempting to re-connect. |
|
| integer value | Maximum limit for connection_retry_interval + connection_retry_backoff |
|
| string value | Name for the AMQP container. must be globally unique. Defaults to a generated UUID |
|
| string value | Exchange name used in notification addresses. Exchange name resolution precedence: Target.exchange if set else default_notification_exchange if set else control_exchange if set else notify |
|
| integer value | The deadline for a sent notification message delivery. Only used when caller does not provide a timeout expiry. |
|
| integer value | The maximum number of attempts to re-send a reply message which failed due to a recoverable error. |
|
| integer value | The deadline for an rpc reply message delivery. |
|
| string value | Exchange name used in RPC addresses. Exchange name resolution precedence: Target.exchange if set else default_rpc_exchange if set else control_exchange if set else rpc |
|
| integer value | The deadline for an rpc cast or call message delivery. Only used when caller does not provide a timeout expiry. |
|
| integer value | The duration to schedule a purge of idle sender links. Detach link after expiry. |
|
| string value | address prefix when sending to any server in group |
|
| integer value | Timeout for inactive connections (in seconds) |
|
| integer value | Time to pause between re-connecting an AMQP 1.0 link that failed due to a recoverable error. |
|
| string value | Appended to the address prefix when sending a fanout message. Used by the message bus to identify fanout messages. |
|
| string value | Address prefix for all generated Notification addresses |
|
| integer value | Window size for incoming Notification messages |
|
| multi valued | Send messages of this type pre-settled. Pre-settled messages will not receive acknowledgement from the peer. Note well: pre-settled messages may be silently discarded if the delivery fails. Permitted values: rpc-call - send RPC Calls pre-settled rpc-reply- send RPC Replies pre-settled rpc-cast - Send RPC Casts pre-settled notify - Send Notifications pre-settled |
|
| boolean value | Enable virtual host support for those message buses that do not natively support virtual hosting (such as qpidd). When set to true the virtual host name will be added to all message bus addresses, effectively creating a private subnet per virtual host. Set to False if the message bus supports virtual hosting using the hostname field in the AMQP 1.0 Open performative as the name of the virtual host. |
|
| integer value | Window size for incoming RPC Reply messages. |
|
| string value | Address prefix for all generated RPC addresses |
|
| integer value | Window size for incoming RPC Request messages |
| `sasl_config_dir = ` | string value | Path to directory that contains the SASL configuration |
| `sasl_config_name = ` | string value | Name of configuration file (without .conf suffix) |
| `sasl_default_realm = ` | string value | SASL realm to use if no realm present in username |
| `sasl_mechanisms = ` | string value | Space separated list of acceptable SASL mechanisms |
|
| string value | address prefix used when sending to a specific server |
|
| boolean value | Attempt to connect via SSL. If no other ssl-related parameters are given, it will use the system’s CA-bundle to verify the server’s certificate. |
| `ssl_ca_file = ` | string value | CA certificate PEM file used to verify the server’s certificate |
| `ssl_cert_file = ` | string value | Self-identifying certificate PEM file for client authentication |
| `ssl_key_file = ` | string value | Private key PEM file used to sign ssl_cert_file certificate (optional) |
|
| string value | Password for decrypting ssl_key_file (if encrypted) |
|
| boolean value | By default SSL checks that the name in the server’s certificate matches the hostname in the transport_url. In some configurations it may be preferable to use the virtual hostname instead, for example if the server uses the Server Name Indication TLS extension (rfc6066) to provide a certificate per virtual host. Set ssl_verify_vhost to True if the server’s SSL certificate uses the virtual host name instead of the DNS name. |
|
| boolean value | Debug: dump AMQP frames to stdout |
|
| string value | Appended to the address prefix when sending to a particular RPC/Notification server. Used by the message bus to identify messages sent to a single destination. |
2.1.18. oslo_messaging_kafka
The following table outlines the options available under the [oslo_messaging_kafka] group in the /etc/cinder/cinder.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| string value | The compression codec for all data generated by the producer. If not set, compression will not be used. Note that the allowed values of this depend on the kafka version |
|
| integer value | The pool size limit for connections expiration policy |
|
| integer value | The time-to-live in sec of idle connections in the pool |
|
| string value | Group id for Kafka consumer. Consumers in one group will coordinate message consumption |
|
| boolean value | Enable asynchronous consumer commits |
|
| floating point value | Default timeout(s) for Kafka consumers |
|
| integer value | Max fetch bytes of Kafka consumer |
|
| integer value | The maximum number of records returned in a poll call |
|
| integer value | Pool Size for Kafka Consumers |
|
| integer value | Size of batch for the producer async send |
|
| floating point value | Upper bound on the delay for KafkaProducer batching in seconds |
|
| string value | Mechanism when security protocol is SASL |
|
| string value | Protocol used to communicate with brokers |
| `ssl_cafile = ` | string value | CA certificate PEM file used to verify the server certificate |
| `ssl_client_cert_file = ` | string value | Client certificate PEM file used for authentication. |
| `ssl_client_key_file = ` | string value | Client key PEM file used for authentication. |
| `ssl_client_key_password = ` | string value | Client key password file used for authentication. |
2.1.19. oslo_messaging_notifications
The following table outlines the options available under the [oslo_messaging_notifications] group in the /etc/cinder/cinder.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| multi valued | The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop |
|
| integer value | The maximum number of attempts to re-send a notification message which failed to be delivered due to a recoverable error. 0 - No retry, -1 - indefinite |
|
| list value | AMQP topic used for OpenStack notifications. |
|
| string value | A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC. |
2.1.20. oslo_messaging_rabbit
The following table outlines the options available under the [oslo_messaging_rabbit] group in the /etc/cinder/cinder.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| boolean value | Auto-delete queues in AMQP. |
|
| boolean value | Use durable queues in AMQP. If rabbit_quorum_queue is enabled, queues will be durable and this value will be ignored. |
|
| boolean value | (DEPRECATED) Enable/Disable the RabbitMQ mandatory flag for direct send. The direct send is used as reply, so the MessageUndeliverable exception is raised in case the client queue does not exist.MessageUndeliverable exception will be used to loop for a timeout to lets a chance to sender to recover.This flag is deprecated and it will not be possible to deactivate this functionality anymore |
|
| boolean value | Enable x-cancel-on-ha-failover flag so that rabbitmq server will cancel and notify consumerswhen queue is down |
|
| boolean value | Run the health check heartbeat thread through a native python thread by default. If this option is equal to False then the health check heartbeat will inherit the execution model from the parent process. For example if the parent process has monkey patched the stdlib by using eventlet/greenlet then the heartbeat will be run through a green thread. This option should be set to True only for the wsgi services. |
|
| integer value | How often times during the heartbeat_timeout_threshold we check the heartbeat. |
|
| integer value | Number of seconds after which the Rabbit broker is considered down if heartbeat’s keep-alive fails (0 disables heartbeat). |
|
| string value | EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not be used. This option may not be available in future versions. |
|
| string value | 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. |
|
| integer value | How long to wait a missing client before abandoning to send it its replies. This value should not be longer than rpc_response_timeout. |
|
| floating point value | How long to wait (in seconds) before reconnecting in response to an AMQP consumer cancel notification. |
|
| boolean value | 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"} " |
|
| integer value | Maximum interval of RabbitMQ connection retries. Default is 30 seconds. |
|
| string value | The RabbitMQ login method. |
|
| integer value | Specifies the number of messages to prefetch. Setting to zero allows unlimited messages. |
|
| integer value | Each time a message is redelivered to a consumer, a counter is incremented. Once the redelivery count exceeds the delivery limit the message gets dropped or dead-lettered (if a DLX exchange has been configured) Used only when rabbit_quorum_queue is enabled, Default 0 which means dont set a limit. |
|
| integer value | By default all messages are maintained in memory if a quorum queue grows in length it can put memory pressure on a cluster. This option can limit the number of memory bytes used by the quorum queue. Used only when rabbit_quorum_queue is enabled, Default 0 which means dont set a limit. |
|
| integer value | By default all messages are maintained in memory if a quorum queue grows in length it can put memory pressure on a cluster. This option can limit the number of messages in the quorum queue. Used only when rabbit_quorum_queue is enabled, Default 0 which means dont set a limit. |
|
| boolean value |
Use quorum queues in RabbitMQ (x-queue-type: quorum). The quorum queue is a modern queue type for RabbitMQ implementing a durable, replicated FIFO queue based on the Raft consensus algorithm. It is available as of RabbitMQ 3.8.0. If set this option will conflict with the HA queues ( |
|
| integer value | How long to backoff for between retries when connecting to RabbitMQ. |
|
| integer value | How frequently to retry connecting with RabbitMQ. |
|
| integer value | 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. |
|
| boolean value | Connect over SSL. |
| `ssl_ca_file = ` | string value | SSL certification authority file (valid only if SSL enabled). |
| `ssl_cert_file = ` | string value | SSL cert file (valid only if SSL enabled). |
|
| boolean value | Global toggle for enforcing the OpenSSL FIPS mode. This feature requires Python support. This is available in Python 3.9 in all environments and may have been backported to older Python versions on select environments. If the Python executable used does not support OpenSSL FIPS mode, an exception will be raised. |
| `ssl_key_file = ` | string value | SSL key file (valid only if SSL enabled). |
| `ssl_version = ` | string value | 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. |
2.1.21. oslo_middleware
The following table outlines the options available under the [oslo_middleware] group in the /etc/cinder/cinder.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| boolean value | Whether the application is behind a proxy or not. This determines if the middleware should parse the headers or not. |
|
| string value | HTTP basic auth password file. |
|
| integer value | The maximum body size for each request, in bytes. |
|
| string value | The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by a SSL termination proxy. |
2.1.22. oslo_policy
The following table outlines the options available under the [oslo_policy] group in the /etc/cinder/cinder.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| boolean value |
This option controls whether or not to use old deprecated defaults when evaluating policies. If |
|
| boolean value |
This option controls whether or not to enforce scope when evaluating policies. If |
|
| string value | Default rule. Enforced when a requested rule is not found. |
|
| 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. |
|
| string value | The relative or absolute path of a file that maps roles to permissions for a given service. Relative paths must be specified in relation to the configuration file setting this option. |
|
| string value | Content Type to send and receive data for REST based policy check |
|
| string value | Absolute path to ca cert file for REST based policy check |
|
| string value | Absolute path to client cert for REST based policy check |
|
| string value | Absolute path client key file REST based policy check |
|
| boolean value | server identity verification for REST based policy check |
2.1.23. oslo_reports
The following table outlines the options available under the [oslo_reports] group in the /etc/cinder/cinder.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| string value | The path to a file to watch for changes to trigger the reports, instead of signals. Setting this option disables the signal trigger for the reports. If application is running as a WSGI application it is recommended to use this instead of signals. |
|
| integer value | How many seconds to wait between polls when file_event_handler is set |
|
| string value | Path to a log directory where to create a file |
2.1.24. oslo_versionedobjects
The following table outlines the options available under the [oslo_versionedobjects] group in the /etc/cinder/cinder.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| boolean value | Make exception message format errors fatal |
2.1.25. privsep
The following table outlines the options available under the [privsep] group in the /etc/cinder/cinder.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| list value | List of Linux capabilities retained by the privsep daemon. |
|
| string value | Group that the privsep daemon should run as. |
|
| string value | Command to invoke to start the privsep daemon if not using the "fork" method. If not specified, a default is generated using "sudo privsep-helper" and arguments designed to recreate the current configuration. This command must accept suitable --privsep_context and --privsep_sock_path arguments. |
|
| string value | Logger name to use for this privsep context. By default all contexts log with oslo_privsep.daemon. |
|
| integer value | The number of threads available for privsep to concurrently run processes. Defaults to the number of CPU cores in the system. |
|
| string value | User that the privsep daemon should run as. |
2.1.26. profiler
The following table outlines the options available under the [profiler] group in the /etc/cinder/cinder.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| string value | Connection string for a notifier backend.
Default value is Examples of possible values:
|
|
| boolean value | Enable the profiling for all services on this node. Default value is False (fully disable the profiling feature). Possible values:
|
|
| string value | Document type for notification indexing in elasticsearch. |
|
| integer value | Elasticsearch splits large requests in batches. This parameter defines maximum size of each batch (for example: es_scroll_size=10000). |
|
| string value | This parameter is a time value parameter (for example: es_scroll_time=2m), indicating for how long the nodes that participate in the search will maintain relevant resources in order to continue and support it. |
|
| boolean value | Enable filter traces that contain error/exception to a separated place. Default value is set to False. Possible values:
|
|
| string value | 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. |
|
| string value |
Redissentinel uses a service name to identify a master redis service. This parameter defines the name (for example: |
|
| floating point value | Redissentinel provides a timeout option on the connections. This parameter defines that timeout (for example: socket_timeout=0.1). |
|
| boolean value | Enable SQL requests profiling in services. Default value is False (SQL requests won’t be traced). Possible values:
|
2.1.27. sample_castellan_source
The following table outlines the options available under the [sample_castellan_source] group in the /etc/cinder/cinder.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| string value | The path to a castellan configuration file. |
|
| string value | The name of the driver that can load this configuration source. |
|
| string value | The path to a configuration/castellan_id mapping file. |
2.1.28. sample_remote_file_source
The following table outlines the options available under the [sample_remote_file_source] group in the /etc/cinder/cinder.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| string value | The path to a CA_BUNDLE file or directory with certificates of trusted CAs. |
|
| string value | Client side certificate, as a single file path containing either the certificate only or the private key and the certificate. |
|
| string value | Client side private key, in case client_cert is specified but does not includes the private key. |
|
| string value | The name of the driver that can load this configuration source. |
|
| uri value | Required option with the URI of the extra configuration file’s location. |
2.1.29. service_user
The following table outlines the options available under the [service_user] group in the /etc/cinder/cinder.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| string value | Authentication URL |
|
| string value | PEM encoded Certificate Authority to use when verifying HTTPs connections. |
|
| string value | PEM encoded client certificate cert file |
|
| boolean value | Collect per-API call timing information. |
|
| string value | Domain ID to scope to |
|
| string value | Domain name to scope to |
|
| boolean value | Verify HTTPS connections. |
|
| string value | PEM encoded client certificate key file |
|
| string value | User’s password |
|
| string value | Domain ID containing project |
|
| string value | Domain name containing project |
|
| string value | Project ID to scope to |
|
| string value | Project name to scope to |
|
| boolean value | When True, if sending a user token to an REST API, also send a service token. |
|
| boolean value | Log requests to multiple loggers. |
|
| string value | Scope for system operations |
|
| integer value | Timeout value for http requests |
|
| string value | ID of the trust to use as a trustee use |
|
| string value | User’s domain id |
|
| string value | User’s domain name |
|
| string value | User ID |
|
| string value | Username |
2.1.30. ssl
The following table outlines the options available under the [ssl] group in the /etc/cinder/cinder.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| string value | CA certificate file to use to verify connecting clients. |
|
| string value | Certificate file to use when starting the server securely. |
|
| string value | Sets the list of available ciphers. value should be a string in the OpenSSL cipher list format. |
|
| string value | Private key file to use when starting the server securely. |
|
| string value | 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. |
2.1.31. vault
The following table outlines the options available under the [vault] group in the /etc/cinder/cinder.conf file.
| Configuration option = Default value | Type | Description |
|---|---|---|
|
| string value | AppRole role_id for authentication with vault |
|
| string value | AppRole secret_id for authentication with vault |
|
| string value | Mountpoint of KV store in Vault to use, for example: secret |
|
| integer value | Version of KV store in Vault to use, for example: 2 |
|
| string value | Vault Namespace to use for all requests to Vault. Vault Namespaces feature is available only in Vault Enterprise |
|
| string value | root token for vault |
|
| string value | Absolute path to ca cert file |
|
| boolean value | SSL Enabled/Disabled |
|
| string value | Use this endpoint to connect to Vault, for example: "http://127.0.0.1:8200" |
