diff --git a/doc/common/tables/cinder-auth_token.xml b/doc/common/tables/cinder-auth_token.xml index 4da8d95138c..cc99ca8c7ab 100644 --- a/doc/common/tables/cinder-auth_token.xml +++ b/doc/common/tables/cinder-auth_token.xml @@ -41,6 +41,10 @@ = 127.0.0.1 (StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri. + + = None + (StrOpt) Name of the plugin to load + = 35357 (IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri. @@ -49,6 +53,10 @@ = https (StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri. + + = None + (StrOpt) Config Section from which to load plugin specific options + = None (StrOpt) Complete public Identity API endpoint. @@ -109,6 +117,26 @@ = None (StrOpt) Required if identity server requires client certificate + + = 10 + (IntOpt) (Optional) Number of seconds that an operation will wait to get a memcache client connection from the pool. + + + = 300 + (IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again. + + + = 10 + (IntOpt) (Optional) Maximum total number of open connections to every memcached server. + + + = 3 + (IntOpt) (Optional) Socket timeout in seconds for communicating with a memcache server. + + + = 60 + (IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed. + = None (StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation. @@ -117,6 +145,10 @@ = None (StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization. + + = False + (BoolOpt) (Optional) Use the advanced (eventlet safe) memcache client pool. The advanced pool will only work under python 2.x. + = 10 (IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. diff --git a/doc/common/tables/cinder-common.xml b/doc/common/tables/cinder-common.xml index 66720d4e820..8da15179722 100644 --- a/doc/common/tables/cinder-common.xml +++ b/doc/common/tables/cinder-common.xml @@ -17,6 +17,18 @@ [DEFAULT] + + = None + (StrOpt) CHAP password to use for iSCSI Targets + + + = None + (StrOpt) CHAP username to use for iSCSI Targets + + + = /etc/chelsio-iscsi/chiscsi.conf + (StrOpt) Chiscsi (CXT) global defaults configuration file + = 900 (IntOpt) Timeout for client connections' socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of '0' means wait forever. @@ -41,6 +53,10 @@ = True (BoolOpt) Services to be added to the available pool on create + + = False + (BoolOpt) If this is set to True, attachment of volumes for image transfer will be aborted when multipathd is not running. Otherwise, it will fallback to single path. + = localhost (StrOpt) Name of this node. This can be an opaque identifier. It is not necessarily a host name, FQDN, or IP address. @@ -49,10 +65,18 @@ = /etc/iet/ietd.conf (StrOpt) IET configuration file + + = + (ListOpt) The list of secondary IP addresses of the iSCSI daemon + = (StrOpt) This option is deprecated and unused. It will be removed in the next release. + + = 2.0 + (FloatOpt) Float representation of the over subscription ratio when thin provisioning is involved. Default ratio is 2.0, meaning provisioned capacity can be twice of the total physical capacity. If the ratio is 10.5, it means provisioned capacity can be 10.5 times of the total physical capacity. A ratio of 1.0 means provisioned capacity cannot exceed the total physical capacity. A ratio lower than 1.0 will be ignored and the default value will be used instead. + = None (ListOpt) Memcached servers or None for in process cache. @@ -71,7 +95,7 @@ = False - (BoolOpt) Whether snapshots count against GigaByte quota + (BoolOpt) Whether snapshots count against gigabyte quota = 3 diff --git a/doc/common/tables/cinder-database.xml b/doc/common/tables/cinder-database.xml index 8dd56bdc708..922faa995cf 100644 --- a/doc/common/tables/cinder-database.xml +++ b/doc/common/tables/cinder-database.xml @@ -17,10 +17,6 @@ [DEFAULT] - - = sqlalchemy - (StrOpt) The backend to use for db - = cinder.db (StrOpt) Driver to use for database access diff --git a/doc/common/tables/cinder-emc.xml b/doc/common/tables/cinder-emc.xml index 1c35638cecc..34757bcada4 100644 --- a/doc/common/tables/cinder-emc.xml +++ b/doc/common/tables/cinder-emc.xml @@ -18,13 +18,21 @@ [DEFAULT] - = /etc/cinder/cinder_emc_config.xml - (StrOpt) use this file for cinder emc plugin config data + = False + (BoolOpt) Report free_capacity_gb as 0 when the limit to maximum number of pool LUNs is reached. By default, the value is False. = False (BoolOpt) To destroy storage group when the last LUN is removed from it. By default, the value is False. + + = False + (BoolOpt) Delete a LUN even if it is in Storage Groups. + + + = False + (BoolOpt) Automatically deregister initiators after the related storage group is destroyed. By default, the value is False. + = False (BoolOpt) Automatically register initiators. By default, the value is False. diff --git a/doc/common/tables/cinder-eqlx.xml b/doc/common/tables/cinder-eqlx.xml index f4666e76255..f4a23dd4cfa 100644 --- a/doc/common/tables/cinder-eqlx.xml +++ b/doc/common/tables/cinder-eqlx.xml @@ -19,31 +19,31 @@ = admin - (StrOpt) Existing CHAP account name + (StrOpt) Existing CHAP account name. Defaults to "admin". = password - (StrOpt) Password for specified CHAP account name + (StrOpt) Password for specified CHAP account name. Defaults to "password". = 5 - (IntOpt) Maximum retry count for reconnection + (IntOpt) Maximum retry count for reconnection. Default is 5. = 30 - (IntOpt) Timeout for the Group Manager cli command execution + (IntOpt) Timeout for the Group Manager cli command execution. Default is 30. = group-0 - (StrOpt) Group name to use for creating volumes + (StrOpt) Group name to use for creating volumes. Defaults to "group-0". = default - (StrOpt) Pool in which volumes will be created + (StrOpt) Pool in which volumes will be created. Defaults to "default". = False - (BoolOpt) Use CHAP authentication for targets? + (BoolOpt) Use CHAP authentication for targets. Defaults to "False". diff --git a/doc/common/tables/cinder-huawei.xml b/doc/common/tables/cinder-huawei.xml index 756c272ee88..f3060647ba1 100644 --- a/doc/common/tables/cinder-huawei.xml +++ b/doc/common/tables/cinder-huawei.xml @@ -21,10 +21,6 @@ = /etc/cinder/cinder_huawei_conf.xml (StrOpt) The configuration file for the Cinder Huawei driver - - = /etc/cinder/cinder_huawei_storac_conf.xml - (StrOpt) huawei storagehyper driver config file path - diff --git a/doc/common/tables/cinder-lvm.xml b/doc/common/tables/cinder-lvm.xml index 7c9694789ae..2ca29e6792a 100644 --- a/doc/common/tables/cinder-lvm.xml +++ b/doc/common/tables/cinder-lvm.xml @@ -17,6 +17,10 @@ [DEFAULT] + + = /etc/cinder/lvm.conf + (StrOpt) 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). + = 0 (IntOpt) If >0, create LVs with multiple mirrors. Note that this requires lvm_mirrors + 2 PVs with available space diff --git a/doc/common/tables/cinder-nas.xml b/doc/common/tables/cinder-nas.xml index 858b280a7b9..e6fa9c7e602 100644 --- a/doc/common/tables/cinder-nas.xml +++ b/doc/common/tables/cinder-nas.xml @@ -25,6 +25,10 @@ = admin (StrOpt) User name to connect to NAS system. + + = None + (StrOpt) Options used to mount the storage backend file system where Cinder volumes are stored. + = (StrOpt) Password to connect to NAS system. @@ -41,6 +45,10 @@ = auto (StrOpt) Set more secure file permissions on network-attached storage volume files to restrict broad other/world access. If set to False, volumes are created with open permissions. If set to True, volumes are created with permissions for the cinder user and group (660). If set to auto, a check is done to determine if this is a new installation: True is used if so, otherwise False. Default is auto. + + = + (StrOpt) 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 . + = 22 (IntOpt) SSH port to use to connect to NAS system. diff --git a/doc/common/tables/cinder-openvstorage.xml b/doc/common/tables/cinder-openvstorage.xml new file mode 100644 index 00000000000..e1bc12b6a10 --- /dev/null +++ b/doc/common/tables/cinder-openvstorage.xml @@ -0,0 +1,26 @@ + + + + + + + + + + + + + + + + + + + + + + +
Description of openvstorage configuration options
Configuration option = Default valueDescription
[DEFAULT]
= (StrOpt) Vpool to use for volumes - backend is defined by vpool not by us.
+
diff --git a/doc/common/tables/cinder-rabbitmq.xml b/doc/common/tables/cinder-rabbitmq.xml index b016d5a8d0a..b0a34739595 100644 --- a/doc/common/tables/cinder-rabbitmq.xml +++ b/doc/common/tables/cinder-rabbitmq.xml @@ -35,7 +35,7 @@ = - (StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1 and SSLv23. SSLv2 and SSLv3 may be available on some distributions. + (StrOpt) 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. = False diff --git a/doc/common/tables/cinder-rootwrap.xml b/doc/common/tables/cinder-rootwrap.xml index 82b76d72a9f..46eecc28b44 100644 --- a/doc/common/tables/cinder-rootwrap.xml +++ b/doc/common/tables/cinder-rootwrap.xml @@ -22,7 +22,7 @@ List of directories to load filter definitions from (separated by ','). These directories MUST all be only writeable by root ! - = /sbin,/usr/sbin,/bin,/usr/bin,/usr/local/bin + = /sbin,/usr/sbin,/bin,/usr/bin,/usr/local/bin,/usr/local/sbin List of directories to search executables in, in case filters do not explicitely specify a full path (separated by ',') If not specified, defaults to system PATH environment variable. These directories MUST all be only writeable by root ! diff --git a/doc/common/tables/cinder-rpc.xml b/doc/common/tables/cinder-rpc.xml index 1d625158ce0..ee96ef99971 100644 --- a/doc/common/tables/cinder-rpc.xml +++ b/doc/common/tables/cinder-rpc.xml @@ -43,12 +43,23 @@ = 64 - (IntOpt) Size of RPC greenthread pool. + (IntOpt) Size of RPC thread pool. = cinder-volume (StrOpt) The topic that volume nodes listen on + + [oslo_concurrency] + + + = False + (BoolOpt) Enables or disables inter-process locks. + + + = None + (StrOpt) Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If external locks are used, a lock path must be set. + [oslo_messaging_amqp] diff --git a/doc/common/tables/cinder-scst.xml b/doc/common/tables/cinder-scst.xml new file mode 100644 index 00000000000..c18a3e600cd --- /dev/null +++ b/doc/common/tables/cinder-scst.xml @@ -0,0 +1,30 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of scst configuration options
Configuration option = Default valueDescription
[DEFAULT]
= iscsi(StrOpt) SCST target implementation can choose from multiple SCST target drivers.
= None(StrOpt) Certain ISCSI targets have predefined target names, SCST target driver uses this name.
+
diff --git a/doc/common/tables/cinder-srb.xml b/doc/common/tables/cinder-srb.xml index d4da60daf0c..54814873eab 100644 --- a/doc/common/tables/cinder-srb.xml +++ b/doc/common/tables/cinder-srb.xml @@ -19,7 +19,7 @@ = None - (StrOpt) Comma-separated list of REST servers to connect to + (StrOpt) Comma-separated list of REST servers IP to connect to. (eg http://IP1/,http://IP2:81/path diff --git a/doc/common/tables/cinder-storage.xml b/doc/common/tables/cinder-storage.xml index 9da2b0f77cf..996ebeea3f4 100644 --- a/doc/common/tables/cinder-storage.xml +++ b/doc/common/tables/cinder-storage.xml @@ -31,7 +31,7 @@ = tgtadm - (StrOpt) iSCSI target user-land tool to use. tgtadm is default, use lioadm for LIO iSCSI support, iseradm for the ISER protocol, or fake for testing. + (StrOpt) iSCSI target user-land tool to use. tgtadm is default, use lioadm for LIO iSCSI support, iseradm for the ISER protocol, iscsictl for Chelsio iSCSI Target or fake for testing. = fileio @@ -49,6 +49,10 @@ = 3260 (IntOpt) The port that the iSCSI daemon is listening on + + = iscsi + (StrOpt) Determines the iSCSI protocol for new iSCSI volumes, created with tgtadm or lioadm target helpers. In order to enable RDMA, this parameter should be set with the value "iser". The supported iSCSI protocol values are "iscsi" and "iser". + = iqn.2010-10.org.openstack: (StrOpt) Prefix for iSCSI volumes diff --git a/doc/common/tables/cinder-zeromq.xml b/doc/common/tables/cinder-zeromq.xml index 858fa176869..8f6d8aa5c02 100644 --- a/doc/common/tables/cinder-zeromq.xml +++ b/doc/common/tables/cinder-zeromq.xml @@ -34,7 +34,7 @@ (StrOpt) Directory for holding IPC sockets. - = oslo.messaging._drivers.matchmaker.MatchMakerLocalhost + = oslo_messaging._drivers.matchmaker.MatchMakerLocalhost (StrOpt) MatchMaker driver. diff --git a/tools/autogenerate-config-flagmappings/cinder.flagmappings b/tools/autogenerate-config-flagmappings/cinder.flagmappings index 667e9d32428..91deb071364 100644 --- a/tools/autogenerate-config-flagmappings/cinder.flagmappings +++ b/tools/autogenerate-config-flagmappings/cinder.flagmappings @@ -45,9 +45,11 @@ cb_confirm_volume_create_retries cloudbyte cb_confirm_volume_create_retry_interval cloudbyte cb_create_volume cloudbyte cb_tsm_name cloudbyte -cinder_emc_config_file emc +chap_password common +chap_username common +check_max_pool_luns_threshold emc +chiscsi_conf common cinder_huawei_conf_file huawei -cinder_huawei_sds_conf_file huawei cinder_smis_config_file fujitsu_eternus_dx client_socket_timeout common cloned_volume_same_az zones @@ -64,7 +66,6 @@ datera_api_port datera datera_api_token datera datera_api_version datera datera_num_replicas datera -db_backend database db_driver database debug logging default_availability_zone common @@ -86,6 +87,7 @@ enable_new_services common enable_v1_api api enable_v2_api api enabled_backends storage +enforce_multipath_for_image_xfer common eqlx_chap_login eqlx eqlx_chap_password eqlx eqlx_cli_max_retries eqlx @@ -101,6 +103,7 @@ fatal_exception_format_errors logging flashsystem_connection_protocol flashsystem flashsystem_multihostmap_enabled flashsystem flashsystem_multipath_enabled flashsystem +force_delete_lun_in_storagegroup emc fusionio_iocontrol_retry fusionio fusionio_iocontrol_targetdelay fusionio fusionio_iocontrol_verify_cert fusionio @@ -170,6 +173,7 @@ hplefthand_username hplefthand ibmnas_platform_type ibmnas iet_conf common image_conversion_dir images +initiator_auto_deregistration emc initiator_auto_registration emc instance_format logging instance_uuid_format logging @@ -179,6 +183,8 @@ iscsi_iotype storage iscsi_ip_address storage iscsi_num_targets storage iscsi_port storage prophetstor_dpl +iscsi_protocol storage +iscsi_secondary_ip_addresses common iscsi_target_prefix storage iscsi_write_cache storage ise_completion_retries xio @@ -206,6 +212,7 @@ logging_context_format_string logging logging_debug_format_suffix logging logging_default_format_string logging logging_exception_prefix logging +lvm_conf_file lvm lvm_mirrors lvm lvm_type lvm matchmaker_heartbeat_freq rpc @@ -214,6 +221,7 @@ max_age quota max_gigabytes storage max_header_line api max_luns_per_storage_group emc +max_over_subscription_ratio common memcached_servers common migration_create_volume_timeout_secs storage monkey_patch common @@ -222,10 +230,12 @@ msa_vdisk hpmsa my_ip common nas_ip nas nas_login nas +nas_mount_options nas nas_password nas nas_private_key nas nas_secure_file_operations nas nas_secure_file_permissions nas +nas_share_path nas nas_ssh_port nas naviseccli_path emc netapp_controller_ips netapp_eseries_iscsi @@ -377,7 +387,6 @@ san_private_key san san_secondary_ip san san_ssh_port san san_thin_provision san prophetstor_dpl -san_zfs_volume_base san-solaris scality_sofs_config scality scality_sofs_mount_point scality scality_sofs_volume_dir scality @@ -389,6 +398,8 @@ scheduler_json_config_location scheduler scheduler_manager scheduler scheduler_max_attempts scheduler scheduler_topic scheduler +scst_target_driver scst +scst_target_iqn_name scst service_down_time common sf_account_prefix solidfire sf_allow_template_caching solidfire @@ -487,6 +498,7 @@ volume_transfer_key_length api volume_transfer_salt_length api volume_usage_audit_period storage volumes_dir storage +vpool_name openvstorage windows_iscsi_lun_path windows wsgi_keep_alive common xiv_chap xiv @@ -582,8 +594,10 @@ keystone_authtoken/admin_token auth_token keystone_authtoken/admin_user auth_token keystone_authtoken/auth_admin_prefix auth_token keystone_authtoken/auth_host auth_token +keystone_authtoken/auth_plugin auth_token keystone_authtoken/auth_port auth_token keystone_authtoken/auth_protocol auth_token +keystone_authtoken/auth_section auth_token keystone_authtoken/auth_uri auth_token keystone_authtoken/auth_version auth_token keystone_authtoken/cache auth_token @@ -599,8 +613,14 @@ keystone_authtoken/identity_uri auth_token keystone_authtoken/include_service_catalog auth_token keystone_authtoken/insecure auth_token keystone_authtoken/keyfile auth_token +keystone_authtoken/memcache_pool_conn_get_timeout auth_token +keystone_authtoken/memcache_pool_dead_retry auth_token +keystone_authtoken/memcache_pool_maxsize auth_token +keystone_authtoken/memcache_pool_socket_timeout auth_token +keystone_authtoken/memcache_pool_unused_timeout auth_token keystone_authtoken/memcache_secret_key auth_token keystone_authtoken/memcache_security_strategy auth_token +keystone_authtoken/memcache_use_advanced_pool auth_token keystone_authtoken/memcached_servers common keystone_authtoken/revocation_cache_time auth_token keystone_authtoken/signing_dir auth_token @@ -609,6 +629,8 @@ matchmaker_redis/host redis matchmaker_redis/password redis matchmaker_redis/port redis matchmaker_ring/ringfile redis +oslo_concurrency/disable_process_locking rpc +oslo_concurrency/lock_path rpc oslo_messaging_amqp/allow_insecure_clients rpc oslo_messaging_amqp/broadcast_prefix rpc oslo_messaging_amqp/container_name rpc diff --git a/tools/autogenerate-config-flagmappings/cinder.headers b/tools/autogenerate-config-flagmappings/cinder.headers index 1c4bd9af245..d14bb1be0b3 100644 --- a/tools/autogenerate-config-flagmappings/cinder.headers +++ b/tools/autogenerate-config-flagmappings/cinder.headers @@ -32,12 +32,14 @@ netapp_eseries_iscsi NetApp E-Series driver nexenta_iscsi Nexenta iSCSI driver nexenta_nfs Nexenta NFS driver nimble Nimble driver +openvstorage Open vStorage driver prophetstor_dpl ProphetStor Fibre Channel and iSCSi drivers pure Pure Storage driver quobyte Quobyte USP volume driver san SAN san-solaris Solaris SAN scality Scality SOFS volume driver +scst SCST volume driver solidfire SolidFire driver smbfs Samba volume driver storage storage