Additional options¶

api_rate_limit = True

(Boolean) Enables or disables rate limit of the API.

group_api_class = cinder.group.api.API

(String) The full class name of the group API class

osapi_volume_extension = [cinder.api.contrib.standard_extensions]

(String) osapi volume extension to load

tcp_keepalive_count = None

(Integer) Sets the value of TCP_KEEPCNT for each server socket. Not supported on OS X.

volume_api_class = cinder.volume.api.API

(String) The full class name of the volume API class to use

enable_proxy_headers_parsing = False

(Boolean) Whether the application is behind a proxy or not. This determines if the middleware should parse the headers or not.

secure_proxy_ssl_header = X-Forwarded-Proto

(String) 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. DEPRECATED

auth_strategy = keystone

(String(choices=[‘noauth’, ‘noauth_include_project_id’, ‘keystone’])) The strategy to use for auth. Supports noauth, noauth_include_project_id or keystone.

backend_native_threads_pool_size = 20

(Integer(min=20)) Size of the native threads pool for the backend. Increase for backends that heavily rely on this, like the RBD driver.

extra_capabilities = {}

(String) User defined capabilities, a JSON formatted string specifying key/value pairs. The key/value pairs can be used by the CapabilitiesFilter to select between backends when requests specify volume types. For example, specifying a service level or the geographical location of a backend, then creating a volume type to allow the user to select by these different properties.

migration_create_volume_timeout_secs = 300

(Integer) Timeout for creating the volume to migrate to when performing volume migration (seconds)

suppress_requests_ssl_warnings = False

(Boolean) Suppress requests library SSL certificate warnings.

volume_service_inithost_offload = False

(Boolean) Offload pending volume delete during volume service startup

allocated_capacity_weight_multiplier = -1.0

(Float) Multiplier used for weighing allocated capacity. Positive numbers mean to stack vs spread.

scheduler_default_filters = [AvailabilityZoneFilter, CapacityFilter, CapabilitiesFilter]

(List of String) Which filter class names to use for filtering hosts when not specified in the request.

scheduler_driver = cinder.scheduler.filter_scheduler.FilterScheduler

(String) Default scheduler driver to use

scheduler_host_manager = cinder.scheduler.host_manager.HostManager

(String) The scheduler host manager class to use

scheduler_weight_handler = cinder.scheduler.weights.OrderedHostWeightHandler

(String) Which handler to use for selecting the host/pool after weighing

backup_api_class = cinder.backup.api.API

(String) The full class name of the volume backup API class

backup_driver = cinder.backup.drivers.swift.SwiftBackupDriver

(String) Driver to use for backups.

backup_driver_stats_polling_interval = 60

(Integer(min=10)) Time in seconds between checks of the backup driver status. If does not report as working, it is restarted.

backup_metadata_version = 2

(Integer) Backup metadata version to be used when backing up volume metadata. If this number is bumped, make sure the service doing the restore supports the new version.

backup_native_threads_pool_size = 60

(Integer(min=20)) 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.

backup_service_inithost_offload = True

(Boolean) Offload pending backup delete during backup service startup. If false, the backup service will remain down until all pending backups are deleted.

backup_use_same_host = False

(Boolean) Backup services use same backend.

auth_section = None

(<class ‘str’>) Config Section from which to load plugin specific options

cafile = None

(String) PEM encoded Certificate Authority to use when verifying HTTPs connections.

collect-timing = False

(Boolean) Collect per-API call timing information.

interface = public

(String(choices=[‘public’, ‘admin’, ‘internal’])) 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.

region_name = None

(String) Name of nova region to use. Useful if keystone manages more than one region.

timeout = None

(Integer) Timeout value for http requests

allowed_direct_url_schemes = []

(List of String) A list of url schemes that can be downloaded directly via the direct_url. Currently supported schemes: [file, cinder].

glance_api_insecure = False

(Boolean) Allow to perform insecure SSL (https) requests to glance (https will be used but cert validation will not be performed).

glance_api_ssl_compression = False

(Boolean) Enables or disables negotiation of SSL layer compression. In some cases disabling compression can improve data throughput, such as when high network bandwidth is available and you use compressed image formats like qcow2.

glance_catalog_info = image:glance:publicURL

(String) Info to match when looking for glance in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:<endpoint_type> - Only used if glance_api_servers are not provided.

glance_core_properties = [checksum, container_format, disk_format, image_name, image_id, min_disk, min_ram, name, size]

(List of String) Default core properties of image

glance_num_retries = 3

(Integer(min=0)) Number retries when downloading an image from glance

image_compress_on_upload = True

(Boolean) When possible, compress images uploaded to the image service

image_conversion_cpu_limit = 60

(Integer) CPU time limit in seconds to convert the image

image_conversion_disable = False

(Boolean) 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.

image_upload_use_internal_tenant = False

(Boolean) If set to True, the image volume created by upload-to-image will be placed in the internal tenant. Otherwise, the image volume is created in the current context’s tenant.

image_volume_cache_max_count = 0

(Integer) Max number of entries allowed in the image volume cache. 0 => unlimited.

reserved_image_namespaces = []

(List of String) 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 os_glance and img_signature; this configuration option allows operators to specify additional namespaces to be excluded.

verify_glance_signatures = enabled

(String(choices=[‘disabled’, ‘enabled’])) 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. 1. enabled: verify when image has signature metadata. 2. disabled: verification is turned off. 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.

nas_host = <>

(String) IP address or Hostname of NAS system.

nas_mount_options = None

(String) Options used to mount the storage backend file system where Cinder volumes are stored.

nas_private_key = <>

(String) Filename of private key to use for SSH authentication.

nas_secure_file_permissions = auto

(String) Set more secure file permissions on network-attached storage volume files to restrict broad other/world access. If set to False, volumes are created with open permissions. If set to True, volumes are created with permissions for the cinder user and group (660). If set to auto, a check is done to determine if this is a new installation: True is used if so, otherwise False. Default is auto.

nas_ssh_port = 22

(Port(min=0, max=65535)) SSH port to use to connect to NAS system.

backend_availability_zone = None

(String) Availability zone for this volume backend. If not set, the storage_availability_zone option value is used as the default for all backends.

chap_username = <>

(String) CHAP user name.

driver_client_cert = None

(String) The path to the client certificate for verification, if the driver supports it.

driver_data_namespace = None

(String) Namespace for driver private data values to be saved in.

driver_ssl_cert_verify = False

(Boolean) If set to True the http client will validate the SSL certificate of the backend endpoint.

enable_unsupported_driver = False

(Boolean) 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.

goodness_function = None

(String) String representation for an equation that will be used to determine the goodness of a host. Only used when using the goodness weigher is set to be used by the Cinder scheduler.

iscsi_secondary_ip_addresses = []

(List of String) The list of secondary IP addresses of the iSCSI daemon

iscsi_write_cache = on

(String(choices=[‘on’, ‘off’])) 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.

num_shell_tries = 3

(Integer) Number of times to attempt to run flakey shell commands

replication_device = None

(Dict of String) 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…

reserved_percentage = 0

(Integer(min=0, max=100)) The percentage of backend capacity is reserved

target_helper = tgtadm

(String(choices=[‘tgtadm’, ‘lioadm’, ‘scstadmin’, ‘iscsictl’, ‘ietadm’, ‘nvmet’, ‘spdk-nvmeof’, ‘fake’])) 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.

target_port = 3260

(Port(min=0, max=65535)) The port that the iSCSI daemon is listening on

target_protocol = iscsi

(String(choices=[‘iscsi’, ‘iser’, ‘nvmet_rdma’, ‘nvmet_tcp’])) 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”.

use_chap_auth = False

(Boolean) Option to enable/disable CHAP authentication for targets.

volume_clear = zero

(String(choices=[‘none’, ‘zero’])) Method used to wipe old volumes

volume_clear_size = 0

(Integer(max=1024)) Size in MiB to wipe at start of old volumes. 1024 MiB at max. 0 => all

volume_copy_bps_limit = 0

(Integer) The upper limit of bandwidth of volume copy. 0 => unlimited

volumes_dir = $state_path/volumes

(String) Volume configuration file storage directory

allow_availability_zone_fallback = False

(Boolean) If the requested Cinder availability zone is unavailable, fall back to the value of default_availability_zone, then storage_availability_zone, instead of failing.

default_availability_zone = None

(String) Default availability zone for new volumes. If not set, the storage_availability_zone option value is used as the default for new volumes.

default_volume_type = __DEFAULT__

(String) Default volume type to use

host = localhost

(String) Name of this node. This can be an opaque identifier. It is not necessarily a host name, FQDN, or IP address.

monkey_patch_modules = []

(List of String) List of modules/decorators to monkey patch

no_snapshot_gb_quota = False

(Boolean) Whether snapshots sizes count against global and per volume type gigabyte quotas. By default snapshots’ sizes are counted.

scheduler_manager = cinder.scheduler.manager.SchedulerManager

(String) Full class name for the Manager for scheduler

split_loggers = False

(Boolean) Log requests to multiple loggers.

transfer_api_class = cinder.transfer.api.API

(String) The full class name of the volume transfer API class

volume_usage_audit_period = month

(String) Time period for which to generate volume usages. The options are hour, day, month, or year.

connection_string = messaging://

(String) Connection string for a notifier backend. Default value is messaging:// which sets the notifier to oslo_messaging. Examples of possible values: * messaging:// - use oslo_messaging driver for sending spans. * redis://127.0.0.1:6379 - use redis driver for sending spans. * mongodb://127.0.0.1:27017 - use mongodb driver for sending spans. * elasticsearch://127.0.0.1:9200 - use elasticsearch driver for sending spans. * jaeger://127.0.0.1:6831 - use jaeger tracing as driver for sending spans.

es_doc_type = notification

(String) Document type for notification indexing in elasticsearch.

es_scroll_time = 2m

(String) 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.

hmac_keys = SECRET_KEY

(String) Secret key(s) to use for encrypting context data for performance profiling. This string value should have the following format: <key1>[,<key2>,…<keyn>], where each key is some random string. A user who triggers the profiling via the REST API has to set one of these keys in the headers of the REST API call to include profiling results of this node for this particular project. Both “enabled” flag and “hmac_keys” config options should be set to enable profiling. Also, to generate correct profiling information across all services at least one key needs to be consistent between OpenStack projects. This ensures it can be used from client side to generate the trace, containing information from all possible resources.

socket_timeout = 0.1

(Float) Redissentinel provides a timeout option on the connections. This parameter defines that timeout (for example: socket_timeout=0.1).

max_age = 0

(Integer) Number of seconds between subsequent usage refreshes

quota_backup_gigabytes = 1000

(Integer) Total amount of storage, in gigabytes, allowed for backups per project

quota_consistencygroups = 10

(Integer) Number of consistencygroups allowed per project

quota_gigabytes = 1000

(Integer) Total amount of storage, in gigabytes, allowed for volumes and snapshots per project

quota_snapshots = 10

(Integer) Number of volume snapshots allowed per project

reservation_clean_interval = $reservation_expire

(Integer) Interval between periodic task runs to clean expired reservations in seconds.

until_refresh = 0

(Integer) Count of reservations until usage is refreshed

san_api_port = None

(Port(min=0, max=65535)) Port to use to access the SAN API

san_ip = <>

(String) IP address of SAN controller

san_login = admin

(String) Username for SAN controller

san_private_key = <>

(String) Filename of private key to use for SSH authentication

san_thin_provision = True

(Boolean) Use thin provisioning for SAN volumes?

ssh_max_pool_conn = 5

(Integer) Maximum ssh connections in the pool

iser_helper = tgtadm

(String) The name of the iSER target user-land tool to use

iser_port = 3260

(Port(min=0, max=65535)) The port that the iSER daemon is listening on

num_iser_scan_tries = 3

(Integer) The maximum number of times to rescan iSER target to find volume

nvmet_ns_id = 10

(Integer) The namespace id associated with the subsystem that will be created with the path for the LVM volume.

scst_target_driver = iscsi

(String) SCST target implementation can choose from multiple SCST target drivers.

cloned_volume_same_az = True

(Boolean) Ensure that the new volumes are the same AZ as snapshot or source volume