From 1b1351ea30279051947bc1a6f794ac9edaa51194 Mon Sep 17 00:00:00 2001 From: venkatamahesh Date: Sat, 3 Sep 2016 12:49:39 +0530 Subject: [PATCH] [config-ref] Update cinder tables Closes-Bug: #1609404 Closes-Bug: #1609630 Closes-Bug: #1609331 Closes-Bug: #1610331 Closes-Bug: #1618171 Closes-Bug: #1619331 Closes-Bug: #1619400 Closes-Bug: #1619731 Closes-Bug: #1620308 Closes-Bug: #1609941 Change-Id: Icbb6746d1974e250b6e25f67881dc6cb56fd234d --- .../source/tables/cinder-api.rst | 14 +- .../source/tables/cinder-backups.rst | 10 +- .../source/tables/cinder-backups_gcs.rst | 2 + .../source/tables/cinder-backups_swift.rst | 8 +- .../source/tables/cinder-coho.rst | 2 +- .../source/tables/cinder-common.rst | 28 ++- .../source/tables/cinder-coprhd.rst | 6 +- .../source/tables/cinder-datera.rst | 20 +- .../source/tables/cinder-dellsc.rst | 14 +- .../source/tables/cinder-disco.rst | 2 + .../source/tables/cinder-drbd.rst | 6 + .../source/tables/cinder-emc.rst | 14 +- .../source/tables/cinder-emc_sio.rst | 2 + .../source/tables/cinder-falconstor.rst | 26 +++ .../source/tables/cinder-fusionio.rst | 28 +++ .../source/tables/cinder-hds-hnas.rst | 4 +- .../source/tables/cinder-hitachi-hbsd.rst | 40 ++++ .../source/tables/cinder-huawei.rst | 10 + .../source/tables/cinder-images.rst | 2 +- .../source/tables/cinder-kaminario.rst | 22 ++ .../source/tables/cinder-nas.rst | 2 +- .../tables/cinder-netapp_7mode_iscsi.rst | 4 + .../source/tables/cinder-netapp_7mode_nfs.rst | 4 + .../tables/cinder-netapp_cdot_iscsi.rst | 4 + .../source/tables/cinder-netapp_cdot_nfs.rst | 4 + .../tables/cinder-netapp_eseries_iscsi.rst | 4 + .../source/tables/cinder-nexenta.rst | 6 +- .../source/tables/cinder-nexenta5.rst | 2 +- .../source/tables/cinder-nexenta_edge.rst | 4 +- .../source/tables/cinder-osbrick.rst | 28 +++ .../source/tables/cinder-profiler.rst | 26 ++- .../source/tables/cinder-quota.rst | 2 + .../source/tables/cinder-rabbitmq.rst | 24 ++- .../source/tables/cinder-redis.rst | 12 +- .../source/tables/cinder-rpc.rst | 44 +++- .../source/tables/cinder-san.rst | 2 - .../source/tables/cinder-scheduler.rst | 4 +- .../source/tables/cinder-storage.rst | 6 +- .../source/tables/cinder-storage_gpfs.rst | 2 +- .../source/tables/cinder-synology.rst | 36 ++++ .../source/tables/cinder-violin.rst | 8 + .../source/tables/cinder-vmware.rst | 4 +- .../source/tables/cinder-vzstorage.rst | 4 +- .../source/tables/cinder-xiv.rst | 8 +- .../source/tables/cinder-zadara.rst | 40 ++++ .../source/tables/cinder-zeromq.rst | 52 ++++- .../source/tables/cinder-zoning.rst | 2 + .../tables/cinder-zoning_fabric_cisco.rst | 16 +- .../tables/cinder-zoning_manager_brcd.rst | 4 - .../tables/cinder-zoning_manager_cisco.rst | 2 +- .../source/tables/cinder-zte.rst | 52 +++++ .../cinder.flagmappings | 199 ++++++++++++++++-- .../cinder.headers | 5 + 53 files changed, 754 insertions(+), 122 deletions(-) create mode 100644 doc/config-reference/source/tables/cinder-falconstor.rst create mode 100644 doc/config-reference/source/tables/cinder-fusionio.rst create mode 100644 doc/config-reference/source/tables/cinder-kaminario.rst create mode 100644 doc/config-reference/source/tables/cinder-osbrick.rst create mode 100644 doc/config-reference/source/tables/cinder-synology.rst create mode 100644 doc/config-reference/source/tables/cinder-zadara.rst create mode 100644 doc/config-reference/source/tables/cinder-zte.rst diff --git a/doc/config-reference/source/tables/cinder-api.rst b/doc/config-reference/source/tables/cinder-api.rst index 40e31ef6ba..2e5ec02b74 100644 --- a/doc/config-reference/source/tables/cinder-api.rst +++ b/doc/config-reference/source/tables/cinder-api.rst @@ -24,7 +24,7 @@ - (Integer) Cache volume availability zones in memory for the provided duration in seconds * - ``backend_host`` = ``None`` - (String) Backend override of host value. - * - ``default_timeout`` = ``525600`` + * - ``default_timeout`` = ``31536000`` - (Integer) Default timeout for CLI operations in minutes. For example, LUN migration is a typical long running operation, which depends on the LUN size and the load of the array. An upper bound in the specific deployment can be set to avoid unnecessary long wait. By default, it is 365 days long. * - ``enable_v1_api`` = ``True`` - (Boolean) DEPRECATED: Deploy v1 of the Cinder API. @@ -35,9 +35,11 @@ * - ``extra_capabilities`` = ``{}`` - (String) User defined capabilities, a JSON formatted string specifying key/value pairs. The key/value pairs can be used by the CapabilitiesFilter to select between backends when requests specify volume types. For example, specifying a service level or the geographical location of a backend, then creating a volume type to allow the user to select by these different properties. * - ``ignore_pool_full_threshold`` = ``False`` - - (Boolean) Force LUN creation even if the full threshold of pool is reached. + - (Boolean) Force LUN creation even if the full threshold of pool is reached. By default, the value is False. * - ``management_ips`` = - (String) List of Management IP addresses (separated by commas) + * - ``message_ttl`` = ``2592000`` + - (Integer) message minimum life in seconds. * - ``osapi_max_limit`` = ``1000`` - (Integer) The maximum number of items that a collection resource returns in a single response * - ``osapi_max_request_body_size`` = ``114688`` @@ -58,14 +60,14 @@ - (Integer) Max size allowed per volume, in gigabytes * - ``public_endpoint`` = ``None`` - (String) Public url to use for versions endpoint. The default is None, which will use the request's host_url attribute to populate the URL base. If Cinder is operating behind a proxy, you will want to change this to represent the proxy's URL. - * - ``query_volume_filters`` = ``name, status, metadata, availability_zone, bootable`` - - (List) Volume filter options which non-admin user could use to query volumes. Default values are: ['name', 'status', 'metadata', 'availability_zone' ,'bootable'] + * - ``query_volume_filters`` = ``name, status, metadata, availability_zone, bootable, group_id`` + - (List) Volume filter options which non-admin user could use to query volumes. Default values are: ['name', 'status', 'metadata', 'availability_zone' ,'bootable', 'group_id'] * - ``transfer_api_class`` = ``cinder.transfer.api.API`` - (String) The full class name of the volume transfer API class * - ``volume_api_class`` = ``cinder.volume.api.API`` - (String) The full class name of the volume API class to use * - ``volume_name_prefix`` = ``openstack-`` - - (String) Prefix before volume name to differenciate DISCO volume created through openstack and the other ones + - (String) Prefix before volume name to differentiate DISCO volume created through openstack and the other ones * - ``volume_name_template`` = ``volume-%s`` - (String) Template string to be used to generate volume names * - ``volume_number_multiplier`` = ``-1.0`` @@ -79,7 +81,7 @@ * - ``max_request_body_size`` = ``114688`` - (Integer) The maximum body size for each request, in bytes. * - ``secure_proxy_ssl_header`` = ``X-Forwarded-Proto`` - - (String) DEPRECATED: The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by an SSL termination proxy. + - (String) DEPRECATED: 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. * - **[oslo_versionedobjects]** - * - ``fatal_exception_format_errors`` = ``False`` diff --git a/doc/config-reference/source/tables/cinder-backups.rst b/doc/config-reference/source/tables/cinder-backups.rst index cda0a5a5bc..75cc3d6e1f 100644 --- a/doc/config-reference/source/tables/cinder-backups.rst +++ b/doc/config-reference/source/tables/cinder-backups.rst @@ -32,16 +32,14 @@ - (String) Template string to be used to generate backup names * - ``backup_object_number_per_notification`` = ``10`` - (Integer) The number of chunks or objects, for which one Ceilometer notification will be sent - * - ``backup_posix_path`` = ``$state_path/backup`` - - (String) Path specifying where to store backups. - * - ``backup_service_inithost_offload`` = ``False`` - - (Boolean) Offload pending backup delete during backup service startup. + * - ``backup_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_timer_interval`` = ``120`` - (Integer) Interval, in seconds, between two progress notifications reporting the backup status - * - ``backup_topic`` = ``cinder-backup`` - - (String) The topic that volume backup nodes listen on * - ``backup_use_same_host`` = ``False`` - (Boolean) Backup services use same backend. + * - ``backup_use_temp_snapshot`` = ``False`` + - (Boolean) If this is set to True, the backup_use_temp_snapshot path will be used during the backup. Otherwise, it will use backup_use_temp_volume path. * - ``snapshot_check_timeout`` = ``3600`` - (Integer) How long we check whether a snapshot is finished before we give up * - ``snapshot_name_template`` = ``snapshot-%s`` diff --git a/doc/config-reference/source/tables/cinder-backups_gcs.rst b/doc/config-reference/source/tables/cinder-backups_gcs.rst index 1efbb97564..0d29c2da6c 100644 --- a/doc/config-reference/source/tables/cinder-backups_gcs.rst +++ b/doc/config-reference/source/tables/cinder-backups_gcs.rst @@ -34,6 +34,8 @@ - (Integer) The size in bytes of GCS backup objects. * - ``backup_gcs_project_id`` = ``None`` - (String) Owner project id for GCS bucket. + * - ``backup_gcs_proxy_url`` = ``None`` + - (Unknown) URL for http proxy access. * - ``backup_gcs_reader_chunk_size`` = ``2097152`` - (Integer) GCS object will be downloaded in chunks of bytes. * - ``backup_gcs_retry_error_codes`` = ``429`` diff --git a/doc/config-reference/source/tables/cinder-backups_swift.rst b/doc/config-reference/source/tables/cinder-backups_swift.rst index 8f28ebc293..af2788a26d 100644 --- a/doc/config-reference/source/tables/cinder-backups_swift.rst +++ b/doc/config-reference/source/tables/cinder-backups_swift.rst @@ -21,7 +21,7 @@ * - ``backup_swift_auth`` = ``per_user`` - (String) Swift authentication mechanism * - ``backup_swift_auth_version`` = ``1`` - - (String) Swift authentication version. Specify "1" for auth 1.0, or "2" for auth 2.0 + - (String) Swift authentication version. Specify "1" for auth 1.0, or "2" for auth 2.0 or "3" for auth 3.0 * - ``backup_swift_block_size`` = ``32768`` - (Integer) The size in bytes that changes are tracked for incremental backups. backup_swift_object_size has to be multiple of backup_swift_block_size. * - ``backup_swift_ca_cert_file`` = ``None`` @@ -34,6 +34,10 @@ - (String) Swift key for authentication * - ``backup_swift_object_size`` = ``52428800`` - (Integer) The size in bytes of Swift backup objects + * - ``backup_swift_project`` = ``None`` + - (String) Swift project/account name. Required when connecting to an auth 3.0 system + * - ``backup_swift_project_domain`` = ``None`` + - (String) Swift project domain name. Required when connecting to an auth 3.0 system * - ``backup_swift_retry_attempts`` = ``3`` - (Integer) The number of retries to make for Swift operations * - ``backup_swift_retry_backoff`` = ``2`` @@ -44,6 +48,8 @@ - (String) The URL of the Swift endpoint * - ``backup_swift_user`` = ``None`` - (String) Swift user name + * - ``backup_swift_user_domain`` = ``None`` + - (String) Swift user domain name. Required when connecting to an auth 3.0 system * - ``keystone_catalog_info`` = ``identity:Identity Service:publicURL`` - (String) Info to match when looking for keystone in the service catalog. Format is: separated values of the form: :: - Only used if backup_swift_auth_url is unset * - ``swift_catalog_info`` = ``object-store:swift:publicURL`` diff --git a/doc/config-reference/source/tables/cinder-coho.rst b/doc/config-reference/source/tables/cinder-coho.rst index df53ace1c3..d15da09d11 100644 --- a/doc/config-reference/source/tables/cinder-coho.rst +++ b/doc/config-reference/source/tables/cinder-coho.rst @@ -19,4 +19,4 @@ * - **[DEFAULT]** - * - ``coho_rpc_port`` = ``2049`` - - (Integer) RPC port to connect to Coha Data MicroArray + - (Integer) RPC port to connect to Coho Data MicroArray diff --git a/doc/config-reference/source/tables/cinder-common.rst b/doc/config-reference/source/tables/cinder-common.rst index 17b50a5c03..ddb9d071d2 100644 --- a/doc/config-reference/source/tables/cinder-common.rst +++ b/doc/config-reference/source/tables/cinder-common.rst @@ -20,6 +20,8 @@ - * - ``allow_availability_zone_fallback`` = ``False`` - (Boolean) If the requested Cinder availability zone is unavailable, fall back to the value of default_availability_zone, then storage_availability_zone, instead of failing. + * - ``chap`` = ``disabled`` + - (String) CHAP authentication mode, effective only for iscsi (disabled|enabled) * - ``chap_password`` = - (String) Password for specified CHAP account name. * - ``chap_username`` = @@ -30,14 +32,24 @@ - (String) ID of the project which will be used as the Cinder internal tenant. * - ``cinder_internal_tenant_user_id`` = ``None`` - (String) ID of the user to be used in volume operations as the Cinder internal tenant. + * - ``cluster`` = ``None`` + - (String) Name of this cluster. Used to group volume hosts that share the same backend configurations to work in HA Active-Active mode. Active-Active is not yet supported. * - ``compute_api_class`` = ``cinder.compute.nova.API`` - (String) The full class name of the compute API class to use + * - ``connection_type`` = ``iscsi`` + - (String) Connection type to the IBM Storage Array * - ``consistencygroup_api_class`` = ``cinder.consistencygroup.api.API`` - (String) The full class name of the consistencygroup API class * - ``default_availability_zone`` = ``None`` - (String) Default availability zone for new volumes. If not set, the storage_availability_zone option value is used as the default for new volumes. + * - ``default_group_type`` = ``None`` + - (String) Default group type to use * - ``default_volume_type`` = ``None`` - (String) Default volume type to use + * - ``driver_client_cert`` = ``None`` + - (String) The path to the client certificate for verification, if the driver supports it. + * - ``driver_client_cert_key`` = ``None`` + - (String) The path to the client certificate key 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_path`` = ``None`` @@ -48,6 +60,8 @@ - (Boolean) Enables the Force option on upload_to_image. This enables running upload_volume on in-use volumes for backends that support it. * - ``enable_new_services`` = ``True`` - (Boolean) Services to be added to the available pool on create + * - ``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. * - ``end_time`` = ``None`` - (String) If this option is specified then the end time specified is used instead of the end time of the last completed audit period. * - ``enforce_multipath_for_image_xfer`` = ``False`` @@ -56,6 +70,8 @@ - (Integer) Size of executor thread pool. * - ``fatal_exception_format_errors`` = ``False`` - (Boolean) Make exception message format errors fatal. + * - ``group_api_class`` = ``cinder.group.api.API`` + - (String) The full class name of the group API class * - ``host`` = ``localhost`` - (String) Name of this node. This can be an opaque identifier. It is not necessarily a host name, FQDN, or IP address. * - ``iet_conf`` = ``/etc/iet/ietd.conf`` @@ -64,8 +80,6 @@ - (List) The list of secondary IP addresses of the iSCSI daemon * - ``max_over_subscription_ratio`` = ``20.0`` - (Floating point) Float representation of the over subscription ratio when thin provisioning is involved. Default ratio is 20.0, meaning provisioned capacity can be 20 times of the total physical capacity. If the ratio is 10.5, it means provisioned capacity can be 10.5 times of the total physical capacity. A ratio of 1.0 means provisioned capacity cannot exceed the total physical capacity. The ratio has to be a minimum of 1.0. - * - ``memcached_servers`` = ``None`` - - (List) Memcached servers or None for in process cache. * - ``monkey_patch`` = ``False`` - (Boolean) Enable monkey patching * - ``monkey_patch_modules`` = @@ -88,6 +102,8 @@ - (Integer) Range, in seconds, to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0) * - ``periodic_interval`` = ``60`` - (Integer) Interval, in seconds, between running periodic tasks + * - ``proxy`` = ``storage.proxy.IBMStorageProxy`` + - (String) Proxy driver that connects to the IBM Storage Array * - ``replication_api_class`` = ``cinder.replication.api.API`` - (String) The full class name of the volume replication API class * - ``replication_device`` = ``None`` @@ -112,6 +128,8 @@ - (String) Top-level directory for maintaining cinder's state * - ``storage_availability_zone`` = ``nova`` - (String) Availability zone of this node + * - ``storage_protocol`` = ``iscsi`` + - (String) Protocol for transferring data between host and storage back-end. * - ``strict_ssh_host_key_policy`` = ``False`` - (Boolean) Option to enable strict host key checking. When set to "True" Cinder will only connect to systems with a host key present in the configured "ssh_hosts_key_file". When set to "False" the host key will be saved upon first connection and used for subsequent connections. Default=False * - ``suppress_requests_ssl_warnings`` = ``False`` @@ -128,3 +146,9 @@ - (Boolean) Option to enable/disable CHAP authentication for targets. * - ``use_forwarded_for`` = ``False`` - (Boolean) Treat X-Forwarded-For as the canonical remote address. Only enable this if you have a sanitizing proxy. + * - **[key_manager]** + - + * - ``api_class`` = ``castellan.key_manager.barbican_key_manager.BarbicanKeyManager`` + - (String) The full class name of the key manager API class + * - ``fixed_key`` = ``None`` + - (String) Fixed key returned by key manager, specified in hex diff --git a/doc/config-reference/source/tables/cinder-coprhd.rst b/doc/config-reference/source/tables/cinder-coprhd.rst index b75a767c7c..d1f6ab9ca3 100644 --- a/doc/config-reference/source/tables/cinder-coprhd.rst +++ b/doc/config-reference/source/tables/cinder-coprhd.rst @@ -10,7 +10,7 @@ .. _cinder-coprhd: -.. list-table:: Description of CoprHD volume driver configuration options +.. list-table:: Description of Coprhd volume driver configuration options :header-rows: 1 :class: config-ref-table @@ -42,3 +42,7 @@ - (String) Username for accessing the CoprHD Instance * - ``coprhd_varray`` = ``None`` - (String) Virtual Array to utilize within the CoprHD Instance + * - ``scaleio_server_certificate_path`` = ``None`` + - (String) Server certificate path + * - ``scaleio_verify_server_certificate`` = ``False`` + - (Boolean) verify server certificate diff --git a/doc/config-reference/source/tables/cinder-datera.rst b/doc/config-reference/source/tables/cinder-datera.rst index 31803dddb4..f1962daa2d 100644 --- a/doc/config-reference/source/tables/cinder-datera.rst +++ b/doc/config-reference/source/tables/cinder-datera.rst @@ -18,17 +18,19 @@ - Description * - **[DEFAULT]** - + * - ``datera_503_interval`` = ``5`` + - (Integer) Interval between 503 retries + * - ``datera_503_timeout`` = ``120`` + - (Integer) Timeout for HTTP 503 retry messages + * - ``datera_acl_allow_all`` = ``False`` + - (Boolean) DEPRECATED: True to set acl 'allow_all' on volumes created * - ``datera_api_port`` = ``7717`` - (String) Datera API port. * - ``datera_api_version`` = ``2`` - (String) Datera API version. - * - ``datera_num_replicas`` = ``3`` - - (Int) Number of replicas to create of an inode. - * - ``datera_503_timeout`` = ``120`` - - (Int) Timeout for HTTP 503 retry messages - * - ``datera_503_interval`` = ``5`` - - (Int) Interval between HTTP 503 retries - * - ``datera_acl_allow_all`` = ``False`` - - (Bool) True to set acl 'allow_all' on volumes created * - ``datera_debug`` = ``False`` - - (Bool) True to set function arg and return logging + - (Boolean) True to set function arg and return logging + * - ``datera_debug_replica_count_override`` = ``False`` + - (Boolean) ONLY FOR DEBUG/TESTING PURPOSES True to set replica_count to 1 + * - ``datera_num_replicas`` = ``3`` + - (Integer) DEPRECATED: Number of replicas to create of an inode. diff --git a/doc/config-reference/source/tables/cinder-dellsc.rst b/doc/config-reference/source/tables/cinder-dellsc.rst index 78e47a7591..9d9ca732b0 100644 --- a/doc/config-reference/source/tables/cinder-dellsc.rst +++ b/doc/config-reference/source/tables/cinder-dellsc.rst @@ -25,6 +25,18 @@ * - ``dell_sc_ssn`` = ``64702`` - (Integer) Storage Center System Serial Number * - ``dell_sc_verify_cert`` = ``False`` - - (Boolean) Enable HTTPS SC certificate verification. + - (Boolean) Enable HTTPS SC certificate verification * - ``dell_sc_volume_folder`` = ``openstack`` - (String) Name of the volume folder to use on the Storage Center + * - ``dell_server_os`` = ``Red Hat Linux 6.x`` + - (String) Server OS type to use when creating a new server on the Storage Center. + * - ``excluded_domain_ip`` = ``None`` + - (Unknown) Domain IP to be excluded from iSCSI returns. + * - ``secondary_san_ip`` = + - (String) IP address of secondary DSM controller + * - ``secondary_san_login`` = ``Admin`` + - (String) Secondary DSM user name + * - ``secondary_san_password`` = + - (String) Secondary DSM user password name + * - ``secondary_sc_api_port`` = ``3033`` + - (Port number) Secondary Dell API port diff --git a/doc/config-reference/source/tables/cinder-disco.rst b/doc/config-reference/source/tables/cinder-disco.rst index 755ee5866a..4cd222e771 100644 --- a/doc/config-reference/source/tables/cinder-disco.rst +++ b/doc/config-reference/source/tables/cinder-disco.rst @@ -20,6 +20,8 @@ - * - ``clone_check_timeout`` = ``3600`` - (Integer) How long we check whether a clone is finished before we give up + * - ``clone_volume_timeout`` = ``680`` + - (Integer) Create clone volume timeout. * - ``disco_client`` = ``127.0.0.1`` - (Unknown) The IP of DMS client socket server * - ``disco_client_port`` = ``9898`` diff --git a/doc/config-reference/source/tables/cinder-drbd.rst b/doc/config-reference/source/tables/cinder-drbd.rst index 96ea155089..221044da0c 100644 --- a/doc/config-reference/source/tables/cinder-drbd.rst +++ b/doc/config-reference/source/tables/cinder-drbd.rst @@ -20,12 +20,18 @@ - * - ``drbdmanage_devs_on_controller`` = ``True`` - (Boolean) If set, the c-vol node will receive a useable /dev/drbdX device, even if the actual data is stored on other nodes only. This is useful for debugging, maintenance, and to be able to do the iSCSI export from the c-vol node. + * - ``drbdmanage_disk_options`` = ``{"c-min-rate": "4M"}`` + - (String) Disk options to set on new resources. See http://www.drbd.org/en/doc/users-guide-90/re-drbdconf for all the details. + * - ``drbdmanage_net_options`` = ``{"connect-int": "4", "allow-two-primaries": "yes", "ko-count": "30", "max-buffers": "20000", "ping-timeout": "100"}`` + - (String) Net options to set on new resources. See http://www.drbd.org/en/doc/users-guide-90/re-drbdconf for all the details. * - ``drbdmanage_redundancy`` = ``1`` - (Integer) Number of nodes that should replicate the data. * - ``drbdmanage_resize_plugin`` = ``drbdmanage.plugins.plugins.wait_for.WaitForVolumeSize`` - (String) Volume resize completion wait plugin. * - ``drbdmanage_resize_policy`` = ``{"timeout": "60"}`` - (String) Volume resize completion wait policy. + * - ``drbdmanage_resource_options`` = ``{"auto-promote-timeout": "300"}`` + - (String) Resource options to set on new resources. See http://www.drbd.org/en/doc/users-guide-90/re-drbdconf for all the details. * - ``drbdmanage_resource_plugin`` = ``drbdmanage.plugins.plugins.wait_for.WaitForResource`` - (String) Resource deployment completion wait plugin. * - ``drbdmanage_resource_policy`` = ``{"ratio": "0.51", "timeout": "60"}`` diff --git a/doc/config-reference/source/tables/cinder-emc.rst b/doc/config-reference/source/tables/cinder-emc.rst index c8cf94418a..052166035d 100644 --- a/doc/config-reference/source/tables/cinder-emc.rst +++ b/doc/config-reference/source/tables/cinder-emc.rst @@ -25,22 +25,22 @@ * - ``destroy_empty_storage_group`` = ``False`` - (Boolean) To destroy storage group when the last LUN is removed from it. By default, the value is False. * - ``force_delete_lun_in_storagegroup`` = ``False`` - - (Boolean) Delete a LUN even if it is in Storage Groups. + - (Boolean) Delete a LUN even if it is in Storage Groups. By default, the value is False. * - ``initiator_auto_deregistration`` = ``False`` - (Boolean) Automatically deregister initiators after the related storage group is destroyed. By default, the value is False. * - ``initiator_auto_registration`` = ``False`` - (Boolean) Automatically register initiators. By default, the value is False. - * - ``io_port_list`` = ``*`` - - (String) Comma separated iSCSI or FC ports to be used in Nova or Cinder. - * - ``iscsi_initiators`` = + * - ``io_port_list`` = ``None`` + - (List) Comma separated iSCSI or FC ports to be used in Nova or Cinder. + * - ``iscsi_initiators`` = ``None`` - (String) Mapping between hostname and its iSCSI initiator IP addresses. * - ``max_luns_per_storage_group`` = ``255`` - (Integer) Default max number of LUNs in a storage group. By default, the value is 255. - * - ``naviseccli_path`` = + * - ``naviseccli_path`` = ``None`` - (String) Naviseccli Path. * - ``storage_vnx_authentication_type`` = ``global`` - - (String) VNX authentication scope type. + - (String) VNX authentication scope type. By default, the value is global. * - ``storage_vnx_pool_names`` = ``None`` - - (String) Comma-separated list of storage pool names to be used. + - (List) Comma-separated list of storage pool names to be used. * - ``storage_vnx_security_file_dir`` = ``None`` - (String) Directory path that contains the VNX security file. Make sure the security file is generated first. diff --git a/doc/config-reference/source/tables/cinder-emc_sio.rst b/doc/config-reference/source/tables/cinder-emc_sio.rst index 11ed0cec92..635559d8f2 100644 --- a/doc/config-reference/source/tables/cinder-emc_sio.rst +++ b/doc/config-reference/source/tables/cinder-emc_sio.rst @@ -18,6 +18,8 @@ - Description * - **[DEFAULT]** - + * - ``sio_max_over_subscription_ratio`` = ``None`` + - (Floating point) max_over_subscription_ratio setting for the ScaleIO driver. If set, this takes precedence over the general max_over_subscription_ratio option. If None, the general option is used.Maximum value allowed for ScaleIO is 10.0. * - ``sio_protection_domain_id`` = ``None`` - (String) Protection Domain ID. * - ``sio_protection_domain_name`` = ``None`` diff --git a/doc/config-reference/source/tables/cinder-falconstor.rst b/doc/config-reference/source/tables/cinder-falconstor.rst new file mode 100644 index 0000000000..6c1b936608 --- /dev/null +++ b/doc/config-reference/source/tables/cinder-falconstor.rst @@ -0,0 +1,26 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. _cinder-falconstor: + +.. list-table:: Description of Falconstor volume driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``additional_retry_list`` = + - (String) FSS additional retry list, separate by ; + * - ``fss_debug`` = ``False`` + - (Boolean) Enable HTTP debugging to FSS + * - ``fss_pool`` = + - (Integer) FSS pool id in which FalconStor volumes are stored. diff --git a/doc/config-reference/source/tables/cinder-fusionio.rst b/doc/config-reference/source/tables/cinder-fusionio.rst new file mode 100644 index 0000000000..926333cde1 --- /dev/null +++ b/doc/config-reference/source/tables/cinder-fusionio.rst @@ -0,0 +1,28 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. _cinder-fusionio: + +.. list-table:: Description of Fusion-io driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``dsware_isthin`` = ``False`` + - (Boolean) The flag of thin storage allocation. + * - ``dsware_manager`` = + - (String) Fusionstorage manager ip addr for cinder-volume. + * - ``fusionstorageagent`` = + - (String) Fusionstorage agent ip addr range. + * - ``pool_id_filter`` = + - (List) Pool id permit to use. diff --git a/doc/config-reference/source/tables/cinder-hds-hnas.rst b/doc/config-reference/source/tables/cinder-hds-hnas.rst index 5e30de9c63..00bc17d443 100644 --- a/doc/config-reference/source/tables/cinder-hds-hnas.rst +++ b/doc/config-reference/source/tables/cinder-hds-hnas.rst @@ -19,6 +19,6 @@ * - **[DEFAULT]** - * - ``hds_hnas_iscsi_config_file`` = ``/opt/hds/hnas/cinder_iscsi_conf.xml`` - - (String) Configuration file for HDS iSCSI cinder plugin + - (String) DEPRECATED: Legacy configuration file for HNAS iSCSI Cinder plugin. This is not needed if you fill all configuration on cinder.conf * - ``hds_hnas_nfs_config_file`` = ``/opt/hds/hnas/cinder_nfs_conf.xml`` - - (String) Configuration file for HDS NFS cinder plugin + - (String) DEPRECATED: Legacy configuration file for HNAS NFS Cinder plugin. This is not needed if you fill all configuration on cinder.conf diff --git a/doc/config-reference/source/tables/cinder-hitachi-hbsd.rst b/doc/config-reference/source/tables/cinder-hitachi-hbsd.rst index 544f518436..fd0d3ac4ee 100644 --- a/doc/config-reference/source/tables/cinder-hitachi-hbsd.rst +++ b/doc/config-reference/source/tables/cinder-hitachi-hbsd.rst @@ -62,3 +62,43 @@ - (String) Name of an array unit * - ``hitachi_zoning_request`` = ``False`` - (Boolean) Request for FC Zone creating HostGroup + * - ``hnas_chap_enabled`` = ``True`` + - (Boolean) Whether the chap authentication is enabled in the iSCSI target or not. + * - ``hnas_cluster_admin_ip0`` = ``None`` + - (String) The IP of the HNAS cluster admin. Required only for HNAS multi-cluster setups. + * - ``hnas_mgmt_ip0`` = ``None`` + - (Unknown) Management IP address of HNAS. This can be any IP in the admin address on HNAS or the SMU IP. + * - ``hnas_password`` = ``None`` + - (String) HNAS password. + * - ``hnas_ssc_cmd`` = ``ssc`` + - (String) Command to communicate to HNAS. + * - ``hnas_ssh_port`` = ``22`` + - (Port number) Port to be used for SSH authentication. + * - ``hnas_ssh_private_key`` = ``None`` + - (String) Path to the SSH private key used to authenticate in HNAS SMU. + * - ``hnas_svc0_hdp`` = ``None`` + - (String) Service 0 HDP + * - ``hnas_svc0_iscsi_ip`` = ``None`` + - (Unknown) Service 0 iSCSI IP + * - ``hnas_svc0_volume_type`` = ``None`` + - (String) Service 0 volume type + * - ``hnas_svc1_hdp`` = ``None`` + - (String) Service 1 HDP + * - ``hnas_svc1_iscsi_ip`` = ``None`` + - (Unknown) Service 1 iSCSI IP + * - ``hnas_svc1_volume_type`` = ``None`` + - (String) Service 1 volume type + * - ``hnas_svc2_hdp`` = ``None`` + - (String) Service 2 HDP + * - ``hnas_svc2_iscsi_ip`` = ``None`` + - (Unknown) Service 2 iSCSI IP + * - ``hnas_svc2_volume_type`` = ``None`` + - (String) Service 2 volume type + * - ``hnas_svc3_hdp`` = ``None`` + - (String) Service 3 HDP + * - ``hnas_svc3_iscsi_ip`` = ``None`` + - (Unknown) Service 3 iSCSI IP + * - ``hnas_svc3_volume_type`` = ``None`` + - (String) Service 3 volume type + * - ``hnas_username`` = ``None`` + - (String) HNAS username. diff --git a/doc/config-reference/source/tables/cinder-huawei.rst b/doc/config-reference/source/tables/cinder-huawei.rst index 7a1ebb2f51..41c37311bc 100644 --- a/doc/config-reference/source/tables/cinder-huawei.rst +++ b/doc/config-reference/source/tables/cinder-huawei.rst @@ -22,3 +22,13 @@ - (String) The configuration file for the Cinder Huawei driver. * - ``hypermetro_devices`` = ``None`` - (String) The remote device hypermetro will use. + * - ``metro_domain_name`` = ``None`` + - (String) The remote metro device domain name. + * - ``metro_san_address`` = ``None`` + - (String) The remote metro device request url. + * - ``metro_san_password`` = ``None`` + - (String) The remote metro device san password. + * - ``metro_san_user`` = ``None`` + - (String) The remote metro device san user. + * - ``metro_storage_pools`` = ``None`` + - (String) The remote metro device pool names. diff --git a/doc/config-reference/source/tables/cinder-images.rst b/doc/config-reference/source/tables/cinder-images.rst index 0087a5e4af..c9b3b6708e 100644 --- a/doc/config-reference/source/tables/cinder-images.rst +++ b/doc/config-reference/source/tables/cinder-images.rst @@ -21,7 +21,7 @@ * - ``allowed_direct_url_schemes`` = - (List) A list of url schemes that can be downloaded directly via the direct_url. Currently supported schemes: [file]. * - ``glance_api_insecure`` = ``False`` - - (Boolean) Allow to perform insecure SSL (https) requests to glance + - (Boolean) Allow to perform insecure SSL (https) requests to glance (https will be used but cert validation will not be performed). * - ``glance_api_servers`` = ``None`` - (List) A list of the URLs of glance API servers available to cinder ([http[s]://][hostname|ip]:port). If protocol is not specified it defaults to http. * - ``glance_api_ssl_compression`` = ``False`` diff --git a/doc/config-reference/source/tables/cinder-kaminario.rst b/doc/config-reference/source/tables/cinder-kaminario.rst new file mode 100644 index 0000000000..bcf9c5b84d --- /dev/null +++ b/doc/config-reference/source/tables/cinder-kaminario.rst @@ -0,0 +1,22 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. _cinder-kaminario: + +.. list-table:: Description of Kaminario volume driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``kaminario_nodedup_substring`` = ``K2-nodedup`` + - (String) DEPRECATED: If volume-type name contains this substring nodedup volume will be created, otherwise dedup volume wil be created. This option is deprecated in favour of 'kaminario:thin_prov_type' in extra-specs and will be removed in the next release. diff --git a/doc/config-reference/source/tables/cinder-nas.rst b/doc/config-reference/source/tables/cinder-nas.rst index 7bebe7ffd0..6c6a34bcba 100644 --- a/doc/config-reference/source/tables/cinder-nas.rst +++ b/doc/config-reference/source/tables/cinder-nas.rst @@ -18,7 +18,7 @@ - Description * - **[DEFAULT]** - - * - ``nas_ip`` = + * - ``nas_host`` = - (String) IP address or Hostname of NAS system. * - ``nas_login`` = ``admin`` - (String) User name to connect to NAS system. diff --git a/doc/config-reference/source/tables/cinder-netapp_7mode_iscsi.rst b/doc/config-reference/source/tables/cinder-netapp_7mode_iscsi.rst index c9530ae7ef..f1f3c79fd1 100644 --- a/doc/config-reference/source/tables/cinder-netapp_7mode_iscsi.rst +++ b/doc/config-reference/source/tables/cinder-netapp_7mode_iscsi.rst @@ -26,12 +26,16 @@ - (String) Password for the administrative user account specified in the netapp_login option. * - ``netapp_pool_name_search_pattern`` = ``(.+)`` - (String) 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. + * - ``netapp_replication_aggregate_map`` = ``None`` + - (Unknown) 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), 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:,src_aggr_name1:dest_aggr_name1,src_aggr_name2:dest_aggr_name2,... * - ``netapp_server_hostname`` = ``None`` - (String) The hostname (or IP address) for the storage system or proxy server. * - ``netapp_server_port`` = ``None`` - (Integer) 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; E-Series will use 8080 for HTTP and 8443 for HTTPS. * - ``netapp_size_multiplier`` = ``1.2`` - (Floating point) 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. + * - ``netapp_snapmirror_quiesce_timeout`` = ``3600`` + - (Integer) The maximum time in seconds to wait for existing SnapMirror transfers to complete before aborting during a failover. * - ``netapp_storage_family`` = ``ontap_cluster`` - (String) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series. * - ``netapp_storage_protocol`` = ``None`` diff --git a/doc/config-reference/source/tables/cinder-netapp_7mode_nfs.rst b/doc/config-reference/source/tables/cinder-netapp_7mode_nfs.rst index 84e9a69fa3..d9a59ac4aa 100644 --- a/doc/config-reference/source/tables/cinder-netapp_7mode_nfs.rst +++ b/doc/config-reference/source/tables/cinder-netapp_7mode_nfs.rst @@ -28,10 +28,14 @@ - (String) Password for the administrative user account specified in the netapp_login option. * - ``netapp_pool_name_search_pattern`` = ``(.+)`` - (String) 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. + * - ``netapp_replication_aggregate_map`` = ``None`` + - (Unknown) 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), 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:,src_aggr_name1:dest_aggr_name1,src_aggr_name2:dest_aggr_name2,... * - ``netapp_server_hostname`` = ``None`` - (String) The hostname (or IP address) for the storage system or proxy server. * - ``netapp_server_port`` = ``None`` - (Integer) 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; E-Series will use 8080 for HTTP and 8443 for HTTPS. + * - ``netapp_snapmirror_quiesce_timeout`` = ``3600`` + - (Integer) The maximum time in seconds to wait for existing SnapMirror transfers to complete before aborting during a failover. * - ``netapp_storage_family`` = ``ontap_cluster`` - (String) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series. * - ``netapp_storage_protocol`` = ``None`` diff --git a/doc/config-reference/source/tables/cinder-netapp_cdot_iscsi.rst b/doc/config-reference/source/tables/cinder-netapp_cdot_iscsi.rst index 42166d2e1b..84d563f94b 100644 --- a/doc/config-reference/source/tables/cinder-netapp_cdot_iscsi.rst +++ b/doc/config-reference/source/tables/cinder-netapp_cdot_iscsi.rst @@ -30,12 +30,16 @@ - (String) Password for the administrative user account specified in the netapp_login option. * - ``netapp_pool_name_search_pattern`` = ``(.+)`` - (String) 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. + * - ``netapp_replication_aggregate_map`` = ``None`` + - (Unknown) 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), 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:,src_aggr_name1:dest_aggr_name1,src_aggr_name2:dest_aggr_name2,... * - ``netapp_server_hostname`` = ``None`` - (String) The hostname (or IP address) for the storage system or proxy server. * - ``netapp_server_port`` = ``None`` - (Integer) 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; E-Series will use 8080 for HTTP and 8443 for HTTPS. * - ``netapp_size_multiplier`` = ``1.2`` - (Floating point) 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. + * - ``netapp_snapmirror_quiesce_timeout`` = ``3600`` + - (Integer) The maximum time in seconds to wait for existing SnapMirror transfers to complete before aborting during a failover. * - ``netapp_storage_family`` = ``ontap_cluster`` - (String) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series. * - ``netapp_storage_protocol`` = ``None`` diff --git a/doc/config-reference/source/tables/cinder-netapp_cdot_nfs.rst b/doc/config-reference/source/tables/cinder-netapp_cdot_nfs.rst index 7424fae13f..e7e1e145c6 100644 --- a/doc/config-reference/source/tables/cinder-netapp_cdot_nfs.rst +++ b/doc/config-reference/source/tables/cinder-netapp_cdot_nfs.rst @@ -36,10 +36,14 @@ - (String) Password for the administrative user account specified in the netapp_login option. * - ``netapp_pool_name_search_pattern`` = ``(.+)`` - (String) 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. + * - ``netapp_replication_aggregate_map`` = ``None`` + - (Unknown) 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), 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:,src_aggr_name1:dest_aggr_name1,src_aggr_name2:dest_aggr_name2,... * - ``netapp_server_hostname`` = ``None`` - (String) The hostname (or IP address) for the storage system or proxy server. * - ``netapp_server_port`` = ``None`` - (Integer) 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; E-Series will use 8080 for HTTP and 8443 for HTTPS. + * - ``netapp_snapmirror_quiesce_timeout`` = ``3600`` + - (Integer) The maximum time in seconds to wait for existing SnapMirror transfers to complete before aborting during a failover. * - ``netapp_storage_family`` = ``ontap_cluster`` - (String) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series. * - ``netapp_storage_protocol`` = ``None`` diff --git a/doc/config-reference/source/tables/cinder-netapp_eseries_iscsi.rst b/doc/config-reference/source/tables/cinder-netapp_eseries_iscsi.rst index 5fbcb915b7..5325df62b8 100644 --- a/doc/config-reference/source/tables/cinder-netapp_eseries_iscsi.rst +++ b/doc/config-reference/source/tables/cinder-netapp_eseries_iscsi.rst @@ -32,12 +32,16 @@ - (String) Password for the administrative user account specified in the netapp_login option. * - ``netapp_pool_name_search_pattern`` = ``(.+)`` - (String) 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. + * - ``netapp_replication_aggregate_map`` = ``None`` + - (Unknown) 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), 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:,src_aggr_name1:dest_aggr_name1,src_aggr_name2:dest_aggr_name2,... * - ``netapp_sa_password`` = ``None`` - (String) Password for the NetApp E-Series storage array. * - ``netapp_server_hostname`` = ``None`` - (String) The hostname (or IP address) for the storage system or proxy server. * - ``netapp_server_port`` = ``None`` - (Integer) 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; E-Series will use 8080 for HTTP and 8443 for HTTPS. + * - ``netapp_snapmirror_quiesce_timeout`` = ``3600`` + - (Integer) The maximum time in seconds to wait for existing SnapMirror transfers to complete before aborting during a failover. * - ``netapp_storage_family`` = ``ontap_cluster`` - (String) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series. * - ``netapp_transport_type`` = ``http`` diff --git a/doc/config-reference/source/tables/cinder-nexenta.rst b/doc/config-reference/source/tables/cinder-nexenta.rst index c067df6b14..6f249b29b8 100644 --- a/doc/config-reference/source/tables/cinder-nexenta.rst +++ b/doc/config-reference/source/tables/cinder-nexenta.rst @@ -10,7 +10,7 @@ .. _cinder-nexenta: -.. list-table:: Description of NexentaStor 4.x driver configuration options +.. list-table:: Description of Nexenta driver configuration options :header-rows: 1 :class: config-ref-table @@ -20,7 +20,7 @@ - * - ``nexenta_blocksize`` = ``4096`` - (Integer) Block size for datasets - * - ``nexenta_chunksize`` = ``16384`` + * - ``nexenta_chunksize`` = ``32768`` - (Integer) NexentaEdge iSCSI LUN object chunk size * - ``nexenta_client_address`` = - (String) NexentaEdge iSCSI Gateway client address for non-VIP service @@ -36,6 +36,8 @@ - (Integer) Nexenta target portal port * - ``nexenta_mount_point_base`` = ``$state_path/mnt`` - (String) Base directory that contains NFS share mount points + * - ``nexenta_nbd_symlinks_dir`` = ``/dev/disk/by-path`` + - (String) NexentaEdge logical path of directory to store symbolic links to NBDs * - ``nexenta_nms_cache_volroot`` = ``True`` - (Boolean) If set True cache NexentaStor appliance volroot option value. * - ``nexenta_password`` = ``nexenta`` diff --git a/doc/config-reference/source/tables/cinder-nexenta5.rst b/doc/config-reference/source/tables/cinder-nexenta5.rst index 51d04b3d02..0cfcfaf282 100644 --- a/doc/config-reference/source/tables/cinder-nexenta5.rst +++ b/doc/config-reference/source/tables/cinder-nexenta5.rst @@ -10,7 +10,7 @@ .. _cinder-nexenta5: -.. list-table:: Description of NexentaStor 5.x driver configuration options +.. list-table:: Description of nexenta5 configuration options :header-rows: 1 :class: config-ref-table diff --git a/doc/config-reference/source/tables/cinder-nexenta_edge.rst b/doc/config-reference/source/tables/cinder-nexenta_edge.rst index 060b92178d..e165834f9a 100644 --- a/doc/config-reference/source/tables/cinder-nexenta_edge.rst +++ b/doc/config-reference/source/tables/cinder-nexenta_edge.rst @@ -10,7 +10,7 @@ .. _cinder-nexenta_edge: -.. list-table:: Description of NexentaEdge driver configuration options +.. list-table:: Description of nexenta_edge configuration options :header-rows: 1 :class: config-ref-table @@ -20,7 +20,7 @@ - * - ``nexenta_blocksize`` = ``4096`` - (Integer) Block size for datasets - * - ``nexenta_chunksize`` = ``16384`` + * - ``nexenta_chunksize`` = ``32768`` - (Integer) NexentaEdge iSCSI LUN object chunk size * - ``nexenta_client_address`` = - (String) NexentaEdge iSCSI Gateway client address for non-VIP service diff --git a/doc/config-reference/source/tables/cinder-osbrick.rst b/doc/config-reference/source/tables/cinder-osbrick.rst new file mode 100644 index 0000000000..4502dcc2cc --- /dev/null +++ b/doc/config-reference/source/tables/cinder-osbrick.rst @@ -0,0 +1,28 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. _cinder-osbrick: + +.. list-table:: Description of osbrick configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[privsep_osbrick]** + - + * - ``capabilities`` = ``[]`` + - (Unknown) List of Linux capabilities retained by the privsep daemon. + * - ``group`` = ``None`` + - (String) Group that the privsep daemon should run as. + * - ``helper_command`` = ``None`` + - (String) 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. + * - ``user`` = ``None`` + - (String) User that the privsep daemon should run as. diff --git a/doc/config-reference/source/tables/cinder-profiler.rst b/doc/config-reference/source/tables/cinder-profiler.rst index 6ea1ca3094..315a711e1f 100644 --- a/doc/config-reference/source/tables/cinder-profiler.rst +++ b/doc/config-reference/source/tables/cinder-profiler.rst @@ -18,9 +18,29 @@ - Description * - **[profiler]** - + * - ``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 notifications. * - ``enabled`` = ``False`` - - (Boolean) Enables the profiling for all services on this node. Default value is False (fully disable the profiling feature). Possible values: * True: Enables the feature * False: Disables the feature. The profiling cannot be started via this project operations. If the profiling is triggered by another project, this project part will be empty. + - (Boolean) Enables the profiling for all services on this node. Default value is False (fully disable the profiling feature). + + Possible values: + + * True: Enables the feature + + * False: Disables the feature. The profiling cannot be started via this project operations. If the profiling is triggered by another project, this project part will be empty. * - ``hmac_keys`` = ``SECRET_KEY`` - - (String) Secret key(s) to use for encrypting context data for performance profiling. This string value should have the following format: [,,...], 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) Secret key(s) to use for encrypting context data for performance profiling. This string value should have the following format: [,,...], where each key is some random string. A user who triggers the profiling via the REST API has to set one of these keys in the headers of the REST API call to include profiling results of this node for this particular project. + + Both "enabled" flag and "hmac_keys" config options should be set to enable profiling. Also, to generate correct profiling information across all services at least one key needs to be consistent between OpenStack projects. This ensures it can be used from client side to generate the trace, containing information from all possible resources. * - ``trace_sqlalchemy`` = ``False`` - - (Boolean) Enables SQL requests profiling in services. Default value is False (SQL requests won't be traced). Possible values: * True: Enables SQL requests profiling. Each SQL query will be part of the trace and can the be analyzed by how much time was spent for that. * False: Disables SQL requests profiling. The spent time is only shown on a higher level of operations. Single SQL queries cannot be analyzed this way. + - (Boolean) Enables SQL requests profiling in services. Default value is False (SQL requests won't be traced). + + Possible values: + + * True: Enables SQL requests profiling. Each SQL query will be part of the trace and can the be analyzed by how much time was spent for that. + + * False: Disables SQL requests profiling. The spent time is only shown on a higher level of operations. Single SQL queries cannot be analyzed this way. diff --git a/doc/config-reference/source/tables/cinder-quota.rst b/doc/config-reference/source/tables/cinder-quota.rst index c8baa88e1e..bcf704b92f 100644 --- a/doc/config-reference/source/tables/cinder-quota.rst +++ b/doc/config-reference/source/tables/cinder-quota.rst @@ -30,6 +30,8 @@ - (String) Default driver to use for quota checks * - ``quota_gigabytes`` = ``1000`` - (Integer) Total amount of storage, in gigabytes, allowed for volumes and snapshots per project + * - ``quota_groups`` = ``10`` + - (Integer) Number of groups allowed per project * - ``quota_snapshots`` = ``10`` - (Integer) Number of volume snapshots allowed per project * - ``quota_volumes`` = ``10`` diff --git a/doc/config-reference/source/tables/cinder-rabbitmq.rst b/doc/config-reference/source/tables/cinder-rabbitmq.rst index 6c2786391b..1a49917797 100644 --- a/doc/config-reference/source/tables/cinder-rabbitmq.rst +++ b/doc/config-reference/source/tables/cinder-rabbitmq.rst @@ -24,8 +24,10 @@ - (Boolean) Use durable queues in AMQP. * - ``channel_max`` = ``None`` - (Integer) Maximum number of channels to allow + * - ``connection_factory`` = ``single`` + - (String) Connection factory implementation * - ``default_notification_exchange`` = ``${control_exchange}_notification`` - - (String) Exchange name for for sending notifications + - (String) Exchange name for sending notifications * - ``default_notification_retry_attempts`` = ``-1`` - (Integer) Reconnecting retry count in case of connectivity problem during sending notification, -1 means infinite retry. * - ``default_rpc_exchange`` = ``${control_exchange}_rpc`` @@ -36,7 +38,7 @@ - (Boolean) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake * - ``frame_max`` = ``None`` - (Integer) The maximum byte size for an AMQP frame - * - ``heartbeat_interval`` = ``1`` + * - ``heartbeat_interval`` = ``3`` - (Integer) How often to send heartbeats for consumer's connections * - ``heartbeat_rate`` = ``2`` - (Integer) How often times during the heartbeat_timeout_threshold we check the heartbeat. @@ -45,7 +47,7 @@ * - ``host_connection_reconnect_delay`` = ``0.25`` - (Floating point) Set delay for reconnection to some host which has connection error * - ``kombu_compression`` = ``None`` - - (String) EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not be used. This option may notbe available in future versions. + - (String) EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not be used. This option may not be available in future versions. * - ``kombu_failover_strategy`` = ``round-robin`` - (String) Determines how the next RabbitMQ node is chosen in case the one we are currently connected to becomes unavailable. Takes effect only if more than one RabbitMQ node is provided in config. * - ``kombu_missing_consumer_retry_timeout`` = ``60`` @@ -68,7 +70,7 @@ - (Floating point) Reconnecting retry delay in case of connectivity problem during sending notification message * - ``pool_max_overflow`` = ``0`` - (Integer) Maximum number of connections to create above `pool_max_size`. - * - ``pool_max_size`` = ``10`` + * - ``pool_max_size`` = ``30`` - (Integer) Maximum number of connections to keep queued. * - ``pool_recycle`` = ``600`` - (Integer) Lifetime of a connection (since creation) in seconds or None for no recycling. Expired connections are closed on acquire. @@ -79,19 +81,19 @@ * - ``rabbit_ha_queues`` = ``False`` - (Boolean) Try to use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. In RabbitMQ 3.0, queue mirroring is no longer controlled by the x-ha-policy argument when declaring a queue. If you just want to make sure that all queues (except those with auto-generated names) are mirrored across all nodes, run: "rabbitmqctl set_policy HA '^(?!amq\.).*' '{"ha-mode": "all"}' " * - ``rabbit_host`` = ``localhost`` - - (String) The RabbitMQ broker address where a single node is used. + - (String) DEPRECATED: The RabbitMQ broker address where a single node is used. Replaced by [DEFAULT]/transport_url * - ``rabbit_hosts`` = ``$rabbit_host:$rabbit_port`` - - (List) RabbitMQ HA cluster host:port pairs. + - (List) DEPRECATED: RabbitMQ HA cluster host:port pairs. Replaced by [DEFAULT]/transport_url * - ``rabbit_interval_max`` = ``30`` - (Integer) Maximum interval of RabbitMQ connection retries. Default is 30 seconds. * - ``rabbit_login_method`` = ``AMQPLAIN`` - (String) The RabbitMQ login method. * - ``rabbit_max_retries`` = ``0`` - - (Integer) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). + - (Integer) DEPRECATED: Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). * - ``rabbit_password`` = ``guest`` - - (String) The RabbitMQ password. + - (String) DEPRECATED: The RabbitMQ password. Replaced by [DEFAULT]/transport_url * - ``rabbit_port`` = ``5672`` - - (Port number) The RabbitMQ broker port where a single node is used. + - (Port number) DEPRECATED: The RabbitMQ broker port where a single node is used. Replaced by [DEFAULT]/transport_url * - ``rabbit_qos_prefetch_count`` = ``0`` - (Integer) Specifies the number of messages to prefetch. Setting to zero allows unlimited messages. * - ``rabbit_retry_backoff`` = ``2`` @@ -103,6 +105,6 @@ * - ``rabbit_use_ssl`` = ``False`` - (Boolean) Connect over SSL for RabbitMQ. * - ``rabbit_userid`` = ``guest`` - - (String) The RabbitMQ userid. + - (String) DEPRECATED: The RabbitMQ userid. Replaced by [DEFAULT]/transport_url * - ``rabbit_virtual_host`` = ``/`` - - (String) The RabbitMQ virtual host. + - (String) DEPRECATED: The RabbitMQ virtual host. Replaced by [DEFAULT]/transport_url diff --git a/doc/config-reference/source/tables/cinder-redis.rst b/doc/config-reference/source/tables/cinder-redis.rst index ef8c20bd86..69fa7e5e49 100644 --- a/doc/config-reference/source/tables/cinder-redis.rst +++ b/doc/config-reference/source/tables/cinder-redis.rst @@ -21,16 +21,16 @@ * - ``check_timeout`` = ``20000`` - (Integer) Time in ms to wait before the transaction is killed. * - ``host`` = ``127.0.0.1`` - - (String) Host to locate redis. + - (String) DEPRECATED: Host to locate redis. Replaced by [DEFAULT]/transport_url * - ``password`` = - - (String) Password for Redis server (optional). + - (String) DEPRECATED: Password for Redis server (optional). Replaced by [DEFAULT]/transport_url * - ``port`` = ``6379`` - - (Port number) Use this port to connect to redis host. + - (Port number) DEPRECATED: Use this port to connect to redis host. Replaced by [DEFAULT]/transport_url * - ``sentinel_group_name`` = ``oslo-messaging-zeromq`` - (String) Redis replica set name. * - ``sentinel_hosts`` = - - (List) List of Redis Sentinel hosts (fault tolerance mode) e.g. [host:port, host1:port ... ] - * - ``socket_timeout`` = ``1000`` + - (List) DEPRECATED: List of Redis Sentinel hosts (fault tolerance mode) e.g. [host:port, host1:port ... ] Replaced by [DEFAULT]/transport_url + * - ``socket_timeout`` = ``10000`` - (Integer) Timeout in ms on blocking socket operations - * - ``wait_timeout`` = ``500`` + * - ``wait_timeout`` = ``2000`` - (Integer) Time in ms to wait between connection attempts. diff --git a/doc/config-reference/source/tables/cinder-rpc.rst b/doc/config-reference/source/tables/cinder-rpc.rst index c5cc347f07..a4d68f7d8b 100644 --- a/doc/config-reference/source/tables/cinder-rpc.rst +++ b/doc/config-reference/source/tables/cinder-rpc.rst @@ -19,7 +19,7 @@ * - **[DEFAULT]** - * - ``rpc_backend`` = ``rabbit`` - - (String) The messaging driver to use, defaults to rabbit. Other drivers include amqp and zmq. + - (String) DEPRECATED: The messaging driver to use, defaults to rabbit. Other drivers include amqp and zmq. Replaced by [DEFAULT]/transport_url * - ``rpc_cast_timeout`` = ``-1`` - (Integer) Seconds to wait before a cast expires (TTL). The default value of -1 specifies an infinite linger period. The value of 0 specifies no linger period. Pending messages shall be discarded immediately when the socket is closed. Only supported by impl_zmq. * - ``rpc_conn_pool_size`` = ``30`` @@ -28,8 +28,6 @@ - (Integer) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. * - ``rpc_response_timeout`` = ``60`` - (Integer) Seconds to wait for a response from a call. - * - ``volume_topic`` = ``cinder-volume`` - - (String) The topic that volume nodes listen on * - **[oslo_concurrency]** - * - ``disable_process_locking`` = ``False`` @@ -38,18 +36,52 @@ - (String) Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If external locks are used, a lock path must be set. * - **[oslo_messaging_amqp]** - + * - ``addressing_mode`` = ``dynamic`` + - (String) 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 * - ``allow_insecure_clients`` = ``False`` - (Boolean) Accept clients using either SSL or plain TCP + * - ``anycast_address`` = ``anycast`` + - (String) 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. * - ``broadcast_prefix`` = ``broadcast`` - (String) address prefix used when broadcasting to all servers + * - ``connection_retry_backoff`` = ``2`` + - (Integer) Increase the connection_retry_interval by this many seconds after each unsuccessful failover attempt. + * - ``connection_retry_interval`` = ``1`` + - (Integer) Seconds to pause before attempting to re-connect. + * - ``connection_retry_interval_max`` = ``30`` + - (Integer) Maximum limit for connection_retry_interval + connection_retry_backoff * - ``container_name`` = ``None`` - - (String) Name for the AMQP container + - (String) Name for the AMQP container. must be globally unique. Defaults to a generated UUID + * - ``default_notification_exchange`` = ``None`` + - (String) 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' + * - ``default_notify_timeout`` = ``30`` + - (Integer) The deadline for a sent notification message delivery. Only used when caller does not provide a timeout expiry. + * - ``default_reply_timeout`` = ``30`` + - (Integer) The deadline for an rpc reply message delivery. Only used when caller does not provide a timeout expiry. + * - ``default_rpc_exchange`` = ``None`` + - (String) 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' + * - ``default_send_timeout`` = ``30`` + - (Integer) The deadline for an rpc cast or call message delivery. Only used when caller does not provide a timeout expiry. * - ``group_request_prefix`` = ``unicast`` - (String) address prefix when sending to any server in group * - ``idle_timeout`` = ``0`` - (Integer) Timeout for inactive connections (in seconds) + * - ``link_retry_delay`` = ``10`` + - (Integer) Time to pause between re-connecting an AMQP 1.0 link that failed due to a recoverable error. + * - ``multicast_address`` = ``multicast`` + - (String) Appended to the address prefix when sending a fanout message. Used by the message bus to identify fanout messages. + * - ``notify_address_prefix`` = ``openstack.org/om/notify`` + - (String) Address prefix for all generated Notification addresses + * - ``notify_server_credit`` = ``100`` + - (Integer) Window size for incoming Notification messages * - ``password`` = - (String) Password for message broker authentication + * - ``reply_link_credit`` = ``200`` + - (Integer) Window size for incoming RPC Reply messages. + * - ``rpc_address_prefix`` = ``openstack.org/om/rpc`` + - (String) Address prefix for all generated RPC addresses + * - ``rpc_server_credit`` = ``100`` + - (Integer) Window size for incoming RPC Request messages * - ``sasl_config_dir`` = - (String) Path to directory that contains the SASL configuration * - ``sasl_config_name`` = @@ -68,6 +100,8 @@ - (String) Password for decrypting ssl_key_file (if encrypted) * - ``trace`` = ``False`` - (Boolean) Debug: dump AMQP frames to stdout + * - ``unicast_address`` = ``unicast`` + - (String) 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. * - ``username`` = - (String) User name for message broker authentication * - **[oslo_messaging_notifications]** @@ -77,7 +111,7 @@ * - ``topics`` = ``notifications`` - (List) AMQP topic used for OpenStack notifications. * - ``transport_url`` = ``None`` - - (String) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration. + - (String) A URL representing the messaging driver to use and its full configuration. * - **[oslo_messaging_rabbit]** - * - ``rpc_listener_prefetch_count`` = ``100`` diff --git a/doc/config-reference/source/tables/cinder-san.rst b/doc/config-reference/source/tables/cinder-san.rst index 64110a1538..21e7d0566d 100644 --- a/doc/config-reference/source/tables/cinder-san.rst +++ b/doc/config-reference/source/tables/cinder-san.rst @@ -30,8 +30,6 @@ - (String) Password for SAN controller * - ``san_private_key`` = - (String) Filename of private key to use for SSH authentication - * - ``san_secondary_ip`` = ``None`` - - (String) VNX secondary SP IP Address. * - ``san_ssh_port`` = ``22`` - (Port number) SSH port to use with SAN * - ``san_thin_provision`` = ``True`` diff --git a/doc/config-reference/source/tables/cinder-scheduler.rst b/doc/config-reference/source/tables/cinder-scheduler.rst index bfcad6a9eb..14c24e6f91 100644 --- a/doc/config-reference/source/tables/cinder-scheduler.rst +++ b/doc/config-reference/source/tables/cinder-scheduler.rst @@ -36,5 +36,5 @@ - (String) Full class name for the Manager for scheduler * - ``scheduler_max_attempts`` = ``3`` - (Integer) Maximum number of attempts to schedule a volume - * - ``scheduler_topic`` = ``cinder-scheduler`` - - (String) The topic that scheduler nodes listen on + * - ``scheduler_weight_handler`` = ``cinder.scheduler.weights.OrderedHostWeightHandler`` + - (String) Which handler to use for selecting the host/pool after weighing diff --git a/doc/config-reference/source/tables/cinder-storage.rst b/doc/config-reference/source/tables/cinder-storage.rst index 26bfd893f7..edaff6bbdd 100644 --- a/doc/config-reference/source/tables/cinder-storage.rst +++ b/doc/config-reference/source/tables/cinder-storage.rst @@ -25,7 +25,7 @@ * - ``enabled_backends`` = ``None`` - (List) A list of backend names to use. These backend names should be backed by a unique [CONFIG] group with its options * - ``iscsi_helper`` = ``tgtadm`` - - (String) iSCSI target user-land tool to use. tgtadm is default, use lioadm for LIO iSCSI support, scstadmin for SCST target support, iseradm for the ISER protocol, ietadm for iSCSI Enterprise Target, iscsictl for Chelsio iSCSI Target or fake for testing. + - (String) iSCSI 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 or fake for testing. * - ``iscsi_iotype`` = ``fileio`` - (String) Sets the behavior of the iSCSI target to either perform blockio or fileio optionally, auto can be set and Cinder will autodetect type of backing device * - ``iscsi_ip_address`` = ``$my_ip`` @@ -39,7 +39,7 @@ * - ``iscsi_target_prefix`` = ``iqn.2010-10.org.openstack:`` - (String) Prefix for iSCSI volumes * - ``iscsi_write_cache`` = ``on`` - - (String) Sets the behavior of the iSCSI target to either perform write-back(on) or write-through(off). This parameter is valid if iscsi_helper is set to tgtadm or iseradm. + - (String) Sets the behavior of the iSCSI target to either perform write-back(on) or write-through(off). This parameter is valid if iscsi_helper is set to tgtadm. * - ``iser_helper`` = ``tgtadm`` - (String) The name of the iSER target user-land tool to use * - ``iser_ip_address`` = ``$my_ip`` @@ -61,7 +61,7 @@ * - ``volume_clear_ionice`` = ``None`` - (String) The flag to pass to ionice to alter the i/o priority of the process used to zero a volume after deletion, for example "-c3" for idle only priority. * - ``volume_clear_size`` = ``0`` - - (Integer) Size in MiB to wipe at start of old volumes. 0 => all + - (Integer) Size in MiB to wipe at start of old volumes. 1024 MiBat max. 0 => all * - ``volume_copy_blkio_cgroup_name`` = ``cinder-volume-copy`` - (String) The blkio cgroup name to be used to limit bandwidth of volume copy * - ``volume_copy_bps_limit`` = ``0`` diff --git a/doc/config-reference/source/tables/cinder-storage_gpfs.rst b/doc/config-reference/source/tables/cinder-storage_gpfs.rst index 73650c17ed..838266de66 100644 --- a/doc/config-reference/source/tables/cinder-storage_gpfs.rst +++ b/doc/config-reference/source/tables/cinder-storage_gpfs.rst @@ -30,7 +30,7 @@ - (Boolean) 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. * - ``gpfs_storage_pool`` = ``system`` - (String) Specifies the storage pool that volumes are assigned to. By default, the system storage pool is used. - * - ``nas_ip`` = + * - ``nas_host`` = - (String) IP address or Hostname of NAS system. * - ``nas_login`` = ``admin`` - (String) User name to connect to NAS system. diff --git a/doc/config-reference/source/tables/cinder-synology.rst b/doc/config-reference/source/tables/cinder-synology.rst new file mode 100644 index 0000000000..c8562fcd2a --- /dev/null +++ b/doc/config-reference/source/tables/cinder-synology.rst @@ -0,0 +1,36 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. _cinder-synology: + +.. list-table:: Description of Synology volume driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``pool_type`` = ``default`` + - (String) Pool type, like sata-2copy. + * - ``synology_admin_port`` = ``5000`` + - (Port number) Management port for Synology storage. + * - ``synology_device_id`` = ``None`` + - (String) Device id for skip one time password check for logging in Synology storage if OTP is enabled. + * - ``synology_one_time_pass`` = ``None`` + - (String) One time password of administrator for logging in Synology storage if OTP is enabled. + * - ``synology_password`` = + - (String) Password of administrator for logging in Synology storage. + * - ``synology_pool_name`` = + - (String) Volume on Synology storage to be used for creating lun. + * - ``synology_ssl_verify`` = ``True`` + - (Boolean) Do certificate validation or not if $driver_use_ssl is True + * - ``synology_username`` = ``admin`` + - (String) Administrator of Synology storage. diff --git a/doc/config-reference/source/tables/cinder-violin.rst b/doc/config-reference/source/tables/cinder-violin.rst index 8b4accc528..703856e6fd 100644 --- a/doc/config-reference/source/tables/cinder-violin.rst +++ b/doc/config-reference/source/tables/cinder-violin.rst @@ -18,5 +18,13 @@ - Description * - **[DEFAULT]** - + * - ``violin_dedup_capable_pools`` = + - (List) Storage pools capable of dedup and other luns.(Comma separated list) + * - ``violin_dedup_only_pools`` = + - (List) Storage pools to be used to setup dedup luns only.(Comma separated list) + * - ``violin_iscsi_target_ips`` = + - (List) Target iSCSI addresses to use.(Comma separated list) + * - ``violin_pool_allocation_method`` = ``random`` + - (String) Method of choosing a storage pool for a lun. * - ``violin_request_timeout`` = ``300`` - (Integer) Global backend request timeout, in seconds. diff --git a/doc/config-reference/source/tables/cinder-vmware.rst b/doc/config-reference/source/tables/cinder-vmware.rst index 84b0e51be9..25c18b2316 100644 --- a/doc/config-reference/source/tables/cinder-vmware.rst +++ b/doc/config-reference/source/tables/cinder-vmware.rst @@ -28,6 +28,8 @@ - (String) IP address for connecting to VMware vCenter server. * - ``vmware_host_password`` = ``None`` - (String) Password for authenticating with VMware vCenter server. + * - ``vmware_host_port`` = ``443`` + - (Port number) Port number for connecting to VMware vCenter server. * - ``vmware_host_username`` = ``None`` - (String) Username for authenticating with VMware vCenter server. * - ``vmware_host_version`` = ``None`` @@ -38,7 +40,7 @@ - (Boolean) 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. * - ``vmware_max_objects_retrieval`` = ``100`` - (Integer) 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. - * - ``vmware_task_poll_interval`` = ``0.5`` + * - ``vmware_task_poll_interval`` = ``2.0`` - (Floating point) The interval (in seconds) for polling remote tasks invoked on VMware vCenter server. * - ``vmware_tmp_dir`` = ``/tmp`` - (String) Directory where virtual disks are stored during volume backup and restore. diff --git a/doc/config-reference/source/tables/cinder-vzstorage.rst b/doc/config-reference/source/tables/cinder-vzstorage.rst index b5260ff8f8..ee11525e0e 100644 --- a/doc/config-reference/source/tables/cinder-vzstorage.rst +++ b/doc/config-reference/source/tables/cinder-vzstorage.rst @@ -10,7 +10,7 @@ .. _cinder-vzstorage: -.. list-table:: Description of VidZapper Storage volume driver configuration options +.. list-table:: Description of Virtuozzo Storage volume driver configuration options :header-rows: 1 :class: config-ref-table @@ -18,6 +18,8 @@ - Description * - **[DEFAULT]** - + * - ``vzstorage_default_volume_format`` = ``raw`` + - (String) Default format that will be used when creating volumes if no volume format is specified. * - ``vzstorage_mount_options`` = ``None`` - (List) Mount options passed to the vzstorage client. See section of the pstorage-mount man page for details. * - ``vzstorage_mount_point_base`` = ``$state_path/mnt`` diff --git a/doc/config-reference/source/tables/cinder-xiv.rst b/doc/config-reference/source/tables/cinder-xiv.rst index bfff57b96a..c67af01d2d 100644 --- a/doc/config-reference/source/tables/cinder-xiv.rst +++ b/doc/config-reference/source/tables/cinder-xiv.rst @@ -10,7 +10,7 @@ .. _cinder-xiv: -.. list-table:: Description of the IBM Storage driver configuration options +.. list-table:: Description of IBM Storage driver configuration options :header-rows: 1 :class: config-ref-table @@ -26,9 +26,3 @@ - (String) Username for SAN controller * - ``san_password`` = - (String) Password for SAN controller - * - ``xiv_chap`` = ``disabled`` - - (String) CHAP authentication mode, effective only for iscsi (disabled|enabled) - * - ``xiv_ds8k_connection_type`` = ``iscsi`` - - (String) Connection type to the IBM Storage Array - * - ``xiv_ds8k_proxy`` = ``xiv_ds8k_openstack.nova_proxy.XIVDS8KNovaProxy`` - - (String) Proxy driver that connects to the IBM Storage Array diff --git a/doc/config-reference/source/tables/cinder-zadara.rst b/doc/config-reference/source/tables/cinder-zadara.rst new file mode 100644 index 0000000000..23edf4f1b0 --- /dev/null +++ b/doc/config-reference/source/tables/cinder-zadara.rst @@ -0,0 +1,40 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. _cinder-zadara: + +.. list-table:: Description of Zadara Storage driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``zadara_default_snap_policy`` = ``False`` + - (Boolean) VPSA - Attach snapshot policy for volumes + * - ``zadara_password`` = ``None`` + - (String) VPSA - Password + * - ``zadara_use_iser`` = ``True`` + - (Boolean) VPSA - Use ISER instead of iSCSI + * - ``zadara_user`` = ``None`` + - (String) VPSA - Username + * - ``zadara_vol_encrypt`` = ``False`` + - (Boolean) VPSA - Default encryption policy for volumes + * - ``zadara_vol_name_template`` = ``OS_%s`` + - (String) VPSA - Default template for VPSA volume names + * - ``zadara_vpsa_host`` = ``None`` + - (String) VPSA - Management Host name or IP address + * - ``zadara_vpsa_poolname`` = ``None`` + - (String) VPSA - Storage Pool assigned for volumes + * - ``zadara_vpsa_port`` = ``None`` + - (Port number) VPSA - Port number + * - ``zadara_vpsa_use_ssl`` = ``False`` + - (Boolean) VPSA - Use SSL connection diff --git a/doc/config-reference/source/tables/cinder-zeromq.rst b/doc/config-reference/source/tables/cinder-zeromq.rst index e3bcf69019..0d43fe6194 100644 --- a/doc/config-reference/source/tables/cinder-zeromq.rst +++ b/doc/config-reference/source/tables/cinder-zeromq.rst @@ -22,8 +22,6 @@ - (String) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. * - ``rpc_zmq_bind_port_retries`` = ``100`` - (Integer) Number of retries to find free port number before fail with ZMQBindError. - * - ``rpc_zmq_concurrency`` = ``eventlet`` - - (String) Type of concurrency used. Either "native" or "eventlet" * - ``rpc_zmq_contexts`` = ``1`` - (Integer) Number of ZeroMQ contexts, defaults to 1. * - ``rpc_zmq_host`` = ``localhost`` @@ -34,11 +32,57 @@ - (String) MatchMaker driver. * - ``rpc_zmq_max_port`` = ``65536`` - (Integer) Maximal port number for random ports range. - * - ``rpc_zmq_min_port`` = ``49152`` + * - ``rpc_zmq_min_port`` = ``49153`` - (Port number) Minimal port number for random ports range. + * - ``rpc_zmq_serialization`` = ``json`` + - (String) Default serialization mechanism for serializing/deserializing outgoing/incoming messages * - ``rpc_zmq_topic_backlog`` = ``None`` - (Integer) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. * - ``use_pub_sub`` = ``True`` - (Boolean) Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy. - * - ``zmq_target_expire`` = ``120`` + * - ``zmq_immediate`` = ``False`` + - (Boolean) This option configures round-robin mode in zmq socket. True means not keeping a queue when server side disconnects. False means to keep queue and messages even if server is disconnected, when the server appears we send all accumulated messages to it. + * - ``zmq_target_expire`` = ``300`` - (Integer) Expiration timeout in seconds of a name service record about existing target ( < 0 means no timeout). + * - ``zmq_target_update`` = ``180`` + - (Integer) Update period in seconds of a name service record about existing target. + * - **[oslo_messaging_zmq]** + - + * - ``rpc_cast_timeout`` = ``-1`` + - (Integer) Seconds to wait before a cast expires (TTL). The default value of -1 specifies an infinite linger period. The value of 0 specifies no linger period. Pending messages shall be discarded immediately when the socket is closed. Only supported by impl_zmq. + * - ``rpc_poll_timeout`` = ``1`` + - (Integer) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. + * - ``rpc_zmq_bind_address`` = ``*`` + - (String) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. + * - ``rpc_zmq_bind_port_retries`` = ``100`` + - (Integer) Number of retries to find free port number before fail with ZMQBindError. + * - ``rpc_zmq_contexts`` = ``1`` + - (Integer) Number of ZeroMQ contexts, defaults to 1. + * - ``rpc_zmq_host`` = ``localhost`` + - (String) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova. + * - ``rpc_zmq_ipc_dir`` = ``/var/run/openstack`` + - (String) Directory for holding IPC sockets. + * - ``rpc_zmq_matchmaker`` = ``redis`` + - (String) MatchMaker driver. + * - ``rpc_zmq_max_port`` = ``65536`` + - (Integer) Maximal port number for random ports range. + * - ``rpc_zmq_min_port`` = ``49153`` + - (Port number) Minimal port number for random ports range. + * - ``rpc_zmq_serialization`` = ``json`` + - (String) Default serialization mechanism for serializing/deserializing outgoing/incoming messages + * - ``rpc_zmq_topic_backlog`` = ``None`` + - (Integer) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. + * - ``use_pub_sub`` = ``True`` + - (Boolean) Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy. + * - ``use_router_proxy`` = ``True`` + - (Boolean) Use ROUTER remote proxy. + * - ``zmq_immediate`` = ``False`` + - (Boolean) This option configures round-robin mode in zmq socket. True means not keeping a queue when server side disconnects. False means to keep queue and messages even if server is disconnected, when the server appears we send all accumulated messages to it. + * - ``zmq_target_expire`` = ``300`` + - (Integer) Expiration timeout in seconds of a name service record about existing target ( < 0 means no timeout). + * - ``zmq_target_update`` = ``180`` + - (Integer) Update period in seconds of a name service record about existing target. + * - **[oslo_middleware]** + - + * - ``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. diff --git a/doc/config-reference/source/tables/cinder-zoning.rst b/doc/config-reference/source/tables/cinder-zoning.rst index 3839f795df..b9d4520bf4 100644 --- a/doc/config-reference/source/tables/cinder-zoning.rst +++ b/doc/config-reference/source/tables/cinder-zoning.rst @@ -22,6 +22,8 @@ - (String) FC Zoning mode configured * - **[fc-zone-manager]** - + * - ``enable_unsupported_driver`` = ``False`` + - (Boolean) 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. * - ``fc_fabric_names`` = ``None`` - (String) 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 * - ``fc_san_lookup_service`` = ``cinder.zonemanager.drivers.brocade.brcd_fc_san_lookup_service.BrcdFCSanLookupService`` diff --git a/doc/config-reference/source/tables/cinder-zoning_fabric_cisco.rst b/doc/config-reference/source/tables/cinder-zoning_fabric_cisco.rst index 3c78d736ae..911f66d5ca 100644 --- a/doc/config-reference/source/tables/cinder-zoning_fabric_cisco.rst +++ b/doc/config-reference/source/tables/cinder-zoning_fabric_cisco.rst @@ -19,18 +19,18 @@ * - **[CISCO_FABRIC_EXAMPLE]** - * - ``cisco_fc_fabric_address`` = - - (StrOpt) Management IP of fabric + - (String) Management IP of fabric * - ``cisco_fc_fabric_password`` = - - (StrOpt) Password for user + - (String) Password for user * - ``cisco_fc_fabric_port`` = ``22`` - - (PortOpt) Connecting port + - (Port number) Connecting port * - ``cisco_fc_fabric_user`` = - - (StrOpt) Fabric user ID + - (String) Fabric user ID * - ``cisco_zone_activate`` = ``True`` - - (BoolOpt) overridden zoning activation state + - (Boolean) overridden zoning activation state * - ``cisco_zone_name_prefix`` = ``None`` - - (StrOpt) overridden zone name prefix + - (String) overridden zone name prefix * - ``cisco_zoning_policy`` = ``initiator-target`` - - (StrOpt) overridden zoning policy + - (String) overridden zoning policy * - ``cisco_zoning_vsan`` = ``None`` - - (StrOpt) VSAN of the Fabric + - (String) VSAN of the Fabric diff --git a/doc/config-reference/source/tables/cinder-zoning_manager_brcd.rst b/doc/config-reference/source/tables/cinder-zoning_manager_brcd.rst index 0bd52b08a7..22a883ebd4 100644 --- a/doc/config-reference/source/tables/cinder-zoning_manager_brcd.rst +++ b/doc/config-reference/source/tables/cinder-zoning_manager_brcd.rst @@ -16,10 +16,6 @@ * - Configuration option = Default value - Description - * - **[DEFAULT]** - - - * - ``zoning_mode`` = ``None`` - - (String) FC Zoning mode configured * - **[fc-zone-manager]** - * - ``brcd_sb_connector`` = ``HTTP`` diff --git a/doc/config-reference/source/tables/cinder-zoning_manager_cisco.rst b/doc/config-reference/source/tables/cinder-zoning_manager_cisco.rst index 93084f16ca..fbf0324dca 100644 --- a/doc/config-reference/source/tables/cinder-zoning_manager_cisco.rst +++ b/doc/config-reference/source/tables/cinder-zoning_manager_cisco.rst @@ -19,4 +19,4 @@ * - **[fc-zone-manager]** - * - ``cisco_sb_connector`` = ``cinder.zonemanager.drivers.cisco.cisco_fc_zone_client_cli.CiscoFCZoneClientCLI`` - - (StrOpt) Southbound connector for zoning operation + - (String) Southbound connector for zoning operation diff --git a/doc/config-reference/source/tables/cinder-zte.rst b/doc/config-reference/source/tables/cinder-zte.rst new file mode 100644 index 0000000000..2aa213f70f --- /dev/null +++ b/doc/config-reference/source/tables/cinder-zte.rst @@ -0,0 +1,52 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. _cinder-zte: + +.. list-table:: Description of Zte volume driver configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``zteAheadReadSize`` = ``8`` + - (Integer) Cache readahead size. + * - ``zteCachePolicy`` = ``1`` + - (Integer) Cache policy. 0, Write Back; 1, Write Through. + * - ``zteChunkSize`` = ``4`` + - (Integer) Virtual block size of pool. Unit : KB. Valid value : 4, 8, 16, 32, 64, 128, 256, 512. + * - ``zteControllerIP0`` = ``None`` + - (Unknown) Main controller IP. + * - ``zteControllerIP1`` = ``None`` + - (Unknown) Slave controller IP. + * - ``zteLocalIP`` = ``None`` + - (Unknown) Local IP. + * - ``ztePoolVoAllocatedPolicy`` = ``0`` + - (Integer) Pool volume allocated policy. 0, Auto; 1, High Performance Tier First; 2, Performance Tier First; 3, Capacity Tier First. + * - ``ztePoolVolAlarmStopAllocatedFlag`` = ``0`` + - (Integer) Pool volume alarm stop allocated flag. + * - ``ztePoolVolAlarmThreshold`` = ``0`` + - (Integer) Pool volume alarm threshold. [0, 100] + * - ``ztePoolVolInitAllocatedCapacity`` = ``0`` + - (Integer) Pool volume init allocated Capacity.Unit : KB. + * - ``ztePoolVolIsThin`` = ``False`` + - (Integer) Whether it is a thin volume. + * - ``ztePoolVolMovePolicy`` = ``0`` + - (Integer) Pool volume move policy.0, Auto; 1, Highest Available; 2, Lowest Available; 3, No Relocation. + * - ``zteSSDCacheSwitch`` = ``1`` + - (Integer) SSD cache switch. 0, OFF; 1, ON. + * - ``zteStoragePool`` = + - (List) Pool name list. + * - ``zteUserName`` = ``None`` + - (String) User name. + * - ``zteUserPassword`` = ``None`` + - (String) User password. diff --git a/tools/autogenerate-config-flagmappings/cinder.flagmappings b/tools/autogenerate-config-flagmappings/cinder.flagmappings index 0b326e1922..2c60a9728f 100644 --- a/tools/autogenerate-config-flagmappings/cinder.flagmappings +++ b/tools/autogenerate-config-flagmappings/cinder.flagmappings @@ -1,3 +1,4 @@ +additional_retry_list falconstor allocated_capacity_weight_multiplier storage allow_availability_zone_fallback common allowed_direct_url_schemes images @@ -26,6 +27,7 @@ backup_gcs_enable_progress_timer backups_gcs backup_gcs_num_retries backups_gcs backup_gcs_object_size backups_gcs backup_gcs_project_id backups_gcs +backup_gcs_proxy_url backups_gcs backup_gcs_reader_chunk_size backups_gcs backup_gcs_retry_error_codes backups_gcs backup_gcs_storage_class backups_gcs @@ -60,11 +62,11 @@ backup_swift_url backups_swift backup_swift_user backups_swift backup_swift_user_domain backups_swift backup_timer_interval backups -backup_topic backups backup_tsm_compression backups_tsm backup_tsm_password backups_tsm backup_tsm_volume_prefix backups_tsm backup_use_same_host backups +backup_use_temp_snapshot backups blockbridge_api_host blockbridge blockbridge_api_port blockbridge blockbridge_auth_password blockbridge @@ -86,6 +88,7 @@ cb_create_volume cloudbyte cb_tsm_name cloudbyte cb_update_file_system cloudbyte cb_update_qos_group cloudbyte +chap common chap_password common chap_username common check_max_pool_luns_threshold emc @@ -96,21 +99,40 @@ cinder_huawei_conf_file huawei cinder_internal_tenant_project_id common cinder_internal_tenant_user_id common clone_check_timeout disco +clone_volume_timeout disco cloned_volume_same_az zones +cluster common coho_rpc_port coho compute_api_class common +conn_pool_min_size disable +conn_pool_ttl disable +connection_type common consistencygroup_api_class common control_exchange amqp +coprhd_emulate_snapshot coprhd +coprhd_hostname coprhd +coprhd_password coprhd +coprhd_port coprhd +coprhd_project coprhd +coprhd_scaleio_rest_gateway_host coprhd +coprhd_scaleio_rest_gateway_port coprhd +coprhd_scaleio_rest_server_password coprhd +coprhd_scaleio_rest_server_username coprhd +coprhd_tenant coprhd +coprhd_username coprhd +coprhd_varray coprhd +datera_503_interval datera +datera_503_timeout datera +datera_acl_allow_all datera datera_api_port datera datera_api_version datera -datera_num_replicas datera -datera_503_timeout datera -datera_503_interval datera -datera_acl_allow_all datera datera_debug datera +datera_debug_replica_count_override datera +datera_num_replicas datera db_driver disable debug disable default_availability_zone common +default_group_type common default_log_levels disable default_timeout api default_volume_type common @@ -119,6 +141,7 @@ dell_sc_server_folder dellsc dell_sc_ssn dellsc dell_sc_verify_cert dellsc dell_sc_volume_folder dellsc +dell_server_os dellsc destroy_empty_storage_group emc disco_client disco disco_client_port disco @@ -132,19 +155,27 @@ dothill_verify_certificate_path dothill dpl_pool prophetstor_dpl dpl_port prophetstor_dpl drbdmanage_devs_on_controller drbd +drbdmanage_disk_options drbd +drbdmanage_net_options drbd drbdmanage_redundancy drbd drbdmanage_resize_plugin drbd drbdmanage_resize_policy drbd +drbdmanage_resource_options drbd drbdmanage_resource_plugin drbd drbdmanage_resource_policy drbd drbdmanage_snapshot_plugin drbd drbdmanage_snapshot_policy drbd +driver_client_cert common +driver_client_cert_key common driver_data_namespace common driver_ssl_cert_path common driver_ssl_cert_verify common driver_use_ssl xio +dsware_isthin fusionio +dsware_manager fusionio enable_force_upload common enable_new_services common +enable_unsupported_driver common enable_v1_api api enable_v2_api api enable_v3_api api @@ -158,6 +189,7 @@ eqlx_cli_timeout eqlx eqlx_group_name eqlx eqlx_pool eqlx eqlx_use_chap eqlx +excluded_domain_ip dellsc executor_thread_pool_size common expiry_thres_minutes netapp_7mode_nfs netapp_cdot_nfs extra_capabilities api @@ -169,6 +201,9 @@ flashsystem_iscsi_portid flashsystem flashsystem_multihostmap_enabled flashsystem flashsystem_multipath_enabled flashsystem force_delete_lun_in_storagegroup emc +fss_debug falconstor +fss_pool falconstor +fusionstorageagent fusionio glance_api_insecure images glance_api_servers images glance_api_ssl_compression images @@ -189,6 +224,7 @@ gpfs_max_clone_depth storage_gpfs gpfs_mount_point_base storage_gpfs gpfs_sparse_volumes storage_gpfs gpfs_storage_pool storage_gpfs +group_api_class common hds_hnas_iscsi_config_file hds-hnas hds_hnas_nfs_config_file hds-hnas hgst_net hgst @@ -219,6 +255,26 @@ hitachi_target_ports hitachi-hbsd hitachi_thin_pool_id hitachi-hbsd hitachi_unit_name hitachi-hbsd hitachi_zoning_request hitachi-hbsd +hnas_chap_enabled hitachi-hbsd +hnas_cluster_admin_ip0 hitachi-hbsd +hnas_mgmt_ip0 hitachi-hbsd +hnas_password hitachi-hbsd +hnas_ssc_cmd hitachi-hbsd +hnas_ssh_port hitachi-hbsd +hnas_ssh_private_key hitachi-hbsd +hnas_svc0_hdp hitachi-hbsd +hnas_svc0_iscsi_ip hitachi-hbsd +hnas_svc0_volume_type hitachi-hbsd +hnas_svc1_hdp hitachi-hbsd +hnas_svc1_iscsi_ip hitachi-hbsd +hnas_svc1_volume_type hitachi-hbsd +hnas_svc2_hdp hitachi-hbsd +hnas_svc2_iscsi_ip hitachi-hbsd +hnas_svc2_volume_type hitachi-hbsd +hnas_svc3_hdp hitachi-hbsd +hnas_svc3_iscsi_ip hitachi-hbsd +hnas_svc3_volume_type hitachi-hbsd +hnas_username hitachi-hbsd host common hpe3par_api_url hpe3par hpe3par_cpg hpe3par @@ -302,6 +358,7 @@ iser_helper storage iser_ip_address storage iser_port storage iser_target_prefix storage +kaminario_nodedup_substring kaminario keystone_catalog_info backups_swift lenovo_api_protocol lenovo lenovo_backend_name lenovo @@ -326,12 +383,17 @@ management_ips api max_age quota max_luns_per_storage_group emc max_over_subscription_ratio common -memcached_servers common +message_ttl api +metro_domain_name huawei +metro_san_address huawei +metro_san_password huawei +metro_san_user huawei +metro_storage_pools huawei migration_create_volume_timeout_secs storage monkey_patch common monkey_patch_modules common my_ip common -nas_ip nas storage_gpfs +nas_host nas storage_gpfs nas_login nas storage_gpfs nas_mount_options nas nas_password nas storage_gpfs @@ -352,10 +414,12 @@ netapp_lun_space_reservation netapp_cdot_iscsi netapp_partner_backend_name netapp_7mode_iscsi netapp_7mode_nfs netapp_cdot_iscsi netapp_cdot_nfs netapp_eseries_iscsi netapp_password netapp_7mode_iscsi netapp_7mode_nfs netapp_cdot_iscsi netapp_cdot_nfs netapp_eseries_iscsi netapp_pool_name_search_pattern netapp_7mode_iscsi netapp_7mode_nfs netapp_cdot_iscsi netapp_cdot_nfs netapp_eseries_iscsi +netapp_replication_aggregate_map netapp_7mode_iscsi netapp_7mode_nfs netapp_cdot_iscsi netapp_cdot_nfs netapp_eseries_iscsi netapp_sa_password netapp_eseries_iscsi netapp_server_hostname netapp_7mode_iscsi netapp_7mode_nfs netapp_cdot_iscsi netapp_cdot_nfs netapp_eseries_iscsi netapp_server_port netapp_7mode_iscsi netapp_7mode_nfs netapp_cdot_iscsi netapp_cdot_nfs netapp_eseries_iscsi netapp_size_multiplier netapp_7mode_iscsi netapp_cdot_iscsi +netapp_snapmirror_quiesce_timeout netapp_7mode_iscsi netapp_7mode_nfs netapp_cdot_iscsi netapp_cdot_nfs netapp_eseries_iscsi netapp_storage_family netapp_7mode_iscsi netapp_7mode_nfs netapp_cdot_iscsi netapp_cdot_nfs netapp_eseries_iscsi netapp_storage_protocol netapp_7mode_iscsi netapp_7mode_nfs netapp_cdot_iscsi netapp_cdot_nfs netapp_transport_type netapp_7mode_iscsi netapp_7mode_nfs netapp_cdot_iscsi netapp_cdot_nfs netapp_eseries_iscsi @@ -373,6 +437,7 @@ nexenta_iscsi_service nexenta_edge nexenta_iscsi_target_portal_port nexenta nexenta5 nexenta_edge nexenta_lun_container nexenta_edge nexenta_mount_point_base nexenta nexenta5 +nexenta_nbd_symlinks_dir nexenta nexenta_nms_cache_volroot nexenta nexenta_ns5_blocksize nexenta5 nexenta_password nexenta @@ -425,6 +490,9 @@ osapi_volume_workers api per_volume_size_limit api periodic_fuzzy_delay common periodic_interval common +pool_id_filter fusionio +pool_type synology +proxy common public_endpoint api publish_errors disable pure_api_token pure @@ -445,6 +513,7 @@ quota_backups quota quota_consistencygroups quota quota_driver quota quota_gigabytes quota +quota_groups quota quota_snapshots quota quota_volumes quota rados_connect_timeout storage_ceph @@ -475,13 +544,13 @@ rpc_poll_timeout rpc rpc_response_timeout rpc rpc_zmq_bind_address zeromq rpc_zmq_bind_port_retries zeromq -rpc_zmq_concurrency zeromq rpc_zmq_contexts zeromq rpc_zmq_host zeromq rpc_zmq_ipc_dir zeromq rpc_zmq_matchmaker zeromq rpc_zmq_max_port zeromq rpc_zmq_min_port zeromq +rpc_zmq_serialization zeromq rpc_zmq_topic_backlog zeromq san_clustername san xiv san_ip san prophetstor_dpl xiv @@ -489,9 +558,10 @@ san_is_local san san_login san prophetstor_dpl xiv san_password san prophetstor_dpl xiv san_private_key san -san_secondary_ip san san_ssh_port san san_thin_provision san prophetstor_dpl +scaleio_server_certificate_path coprhd +scaleio_verify_server_certificate coprhd scality_sofs_config scality scality_sofs_mount_point scality scality_sofs_volume_dir scality @@ -502,9 +572,13 @@ scheduler_host_manager scheduler scheduler_json_config_location scheduler scheduler_manager scheduler scheduler_max_attempts scheduler -scheduler_topic scheduler +scheduler_weight_handler scheduler scst_target_driver scst scst_target_iqn_name scst +secondary_san_ip dellsc +secondary_san_login dellsc +secondary_san_password dellsc +secondary_sc_api_port dellsc send_actions common service_down_time common sf_account_prefix solidfire @@ -519,6 +593,7 @@ sf_template_account_name solidfire sf_volume_prefix solidfire sheepdog_store_address sheepdog sheepdog_store_port sheepdog +sio_max_over_subscription_ratio emc_sio sio_protection_domain_id emc_sio sio_protection_domain_name emc_sio sio_rest_server_port emc_sio @@ -547,6 +622,7 @@ ssh_min_pool_conn san start_time common state_path common storage_availability_zone common +storage_protocol common storage_vnx_authentication_type emc storage_vnx_pool_names emc storage_vnx_security_file_dir emc @@ -570,6 +646,13 @@ storwize_svc_volpool_name storwize strict_ssh_host_key_policy common suppress_requests_ssl_warnings common swift_catalog_info backups_swift +synology_admin_port synology +synology_device_id synology +synology_one_time_pass synology +synology_password synology +synology_pool_name synology +synology_ssl_verify synology +synology_username synology syslog_log_facility disable tcp_keepalive common tcp_keepalive_count common @@ -592,15 +675,21 @@ use_default_quota_class quota use_forwarded_for common use_multipath_for_image_xfer images use_pub_sub zeromq +use_router_proxy disable use_stderr disable use_syslog disable verbose disable +violin_dedup_capable_pools violin +violin_dedup_only_pools violin +violin_iscsi_target_ips violin +violin_pool_allocation_method violin violin_request_timeout violin vmware_api_retry_count vmware vmware_ca_file vmware vmware_cluster_name vmware vmware_host_ip vmware vmware_host_password vmware +vmware_host_port vmware vmware_host_username vmware vmware_host_version vmware vmware_image_transfer_timeout_secs vmware @@ -626,11 +715,11 @@ volume_name_template api volume_number_multiplier api volume_service_inithost_offload storage volume_tmp_dir storage_ceph -volume_topic rpc volume_transfer_key_length api volume_transfer_salt_length api volume_usage_audit_period storage volumes_dir storage +vzstorage_default_volume_format vzstorage vzstorage_mount_options vzstorage vzstorage_mount_point_base vzstorage vzstorage_shares_config vzstorage @@ -638,13 +727,20 @@ vzstorage_sparsed_volumes vzstorage vzstorage_used_ratio vzstorage watch_log_file disable windows_iscsi_lun_path windows -xiv_chap xiv -xiv_ds8k_connection_type xiv -xiv_ds8k_proxy xiv xtremio_array_busy_retry_count emc_xtremio xtremio_array_busy_retry_interval emc_xtremio xtremio_cluster_name emc_xtremio xtremio_volumes_per_glance_cache emc_xtremio +zadara_default_snap_policy zadara +zadara_password zadara +zadara_use_iser zadara +zadara_user zadara +zadara_vol_encrypt zadara +zadara_vol_name_template zadara +zadara_vpsa_host zadara +zadara_vpsa_poolname zadara +zadara_vpsa_port zadara +zadara_vpsa_use_ssl zadara zfssa_cache_directory zfssa-nfs zfssa_cache_project zfssa-nfs zfssa_data_ip zfssa-nfs @@ -675,8 +771,26 @@ zfssa_target_interfaces zfssa-iscsi zfssa_target_password zfssa-iscsi zfssa_target_portal zfssa-iscsi zfssa_target_user zfssa-iscsi +zmq_immediate zeromq zmq_target_expire zeromq +zmq_target_update zeromq zoning_mode zoning +zteAheadReadSize zte +zteCachePolicy zte +zteChunkSize zte +zteControllerIP0 zte +zteControllerIP1 zte +zteLocalIP zte +ztePoolVoAllocatedPolicy zte +ztePoolVolAlarmStopAllocatedFlag zte +ztePoolVolAlarmThreshold zte +ztePoolVolInitAllocatedCapacity zte +ztePoolVolIsThin zte +ztePoolVolMovePolicy zte +zteSSDCacheSwitch zte +zteStoragePool zte +zteUserName zte +zteUserPassword zte BRCD_FABRIC_EXAMPLE/fc_fabric_address zoning_fabric_brcd BRCD_FABRIC_EXAMPLE/fc_fabric_password zoning_fabric_brcd BRCD_FABRIC_EXAMPLE/fc_fabric_port zoning_fabric_brcd @@ -696,6 +810,11 @@ CISCO_FABRIC_EXAMPLE/cisco_zone_activate zoning_fabric_cisco CISCO_FABRIC_EXAMPLE/cisco_zone_name_prefix zoning_fabric_cisco CISCO_FABRIC_EXAMPLE/cisco_zoning_policy zoning_fabric_cisco CISCO_FABRIC_EXAMPLE/cisco_zoning_vsan zoning_fabric_cisco +barbican/auth_endpoint disable +barbican/barbican_api_version disable +barbican/barbican_endpoint disable +barbican/number_of_retries disable +barbican/retry_delay disable coordination/backend_url coordination coordination/heartbeat coordination coordination/initial_reconnect_backoff coordination @@ -732,18 +851,16 @@ database/slave_connection disable database/sqlite_db disable database/sqlite_synchronous disable database/use_db_reconnect disable -database/use_tpool disable -fc-zone-manager/brcd_sb_connector zoning_manage_brcd +fc-zone-manager/brcd_sb_connector zoning_manager_brcd fc-zone-manager/cisco_sb_connector zoning_manager_cisco +fc-zone-manager/enable_unsupported_driver zoning fc-zone-manager/fc_fabric_names zoning fc-zone-manager/fc_san_lookup_service zoning fc-zone-manager/zone_driver zoning fc-zone-manager/zoning_policy zoning hyperv/force_volumeutils_v1 hyperv -keymgr/api_class keymgr -keymgr/encryption_api_url keymgr -keymgr/encryption_auth_url keymgr -keymgr/fixed_key keymgr +key_manager/api_class common +key_manager/fixed_key common keystone_authtoken/admin_password disable keystone_authtoken/admin_tenant_name disable keystone_authtoken/admin_token disable @@ -792,12 +909,29 @@ matchmaker_redis/socket_timeout redis matchmaker_redis/wait_timeout redis oslo_concurrency/disable_process_locking rpc oslo_concurrency/lock_path rpc +oslo_messaging_amqp/addressing_mode rpc oslo_messaging_amqp/allow_insecure_clients rpc +oslo_messaging_amqp/anycast_address rpc oslo_messaging_amqp/broadcast_prefix rpc +oslo_messaging_amqp/connection_retry_backoff rpc +oslo_messaging_amqp/connection_retry_interval rpc +oslo_messaging_amqp/connection_retry_interval_max rpc oslo_messaging_amqp/container_name rpc +oslo_messaging_amqp/default_notification_exchange rpc +oslo_messaging_amqp/default_notify_timeout rpc +oslo_messaging_amqp/default_reply_timeout rpc +oslo_messaging_amqp/default_rpc_exchange rpc +oslo_messaging_amqp/default_send_timeout rpc oslo_messaging_amqp/group_request_prefix rpc oslo_messaging_amqp/idle_timeout rpc +oslo_messaging_amqp/link_retry_delay rpc +oslo_messaging_amqp/multicast_address rpc +oslo_messaging_amqp/notify_address_prefix rpc +oslo_messaging_amqp/notify_server_credit rpc oslo_messaging_amqp/password rpc +oslo_messaging_amqp/reply_link_credit rpc +oslo_messaging_amqp/rpc_address_prefix rpc +oslo_messaging_amqp/rpc_server_credit rpc oslo_messaging_amqp/sasl_config_dir rpc oslo_messaging_amqp/sasl_config_name rpc oslo_messaging_amqp/sasl_mechanisms rpc @@ -807,6 +941,7 @@ oslo_messaging_amqp/ssl_cert_file rpc oslo_messaging_amqp/ssl_key_file rpc oslo_messaging_amqp/ssl_key_password rpc oslo_messaging_amqp/trace rpc +oslo_messaging_amqp/unicast_address rpc oslo_messaging_amqp/username rpc oslo_messaging_notifications/driver rpc oslo_messaging_notifications/topics rpc @@ -814,6 +949,7 @@ oslo_messaging_notifications/transport_url rpc oslo_messaging_rabbit/amqp_auto_delete rabbitmq oslo_messaging_rabbit/amqp_durable_queues rabbitmq oslo_messaging_rabbit/channel_max rabbitmq +oslo_messaging_rabbit/connection_factory rabbitmq oslo_messaging_rabbit/default_notification_exchange rabbitmq oslo_messaging_rabbit/default_notification_retry_attempts rabbitmq oslo_messaging_rabbit/default_rpc_exchange rabbitmq @@ -866,12 +1002,35 @@ oslo_messaging_rabbit/socket_timeout rpc oslo_messaging_rabbit/ssl rpc oslo_messaging_rabbit/ssl_options rpc oslo_messaging_rabbit/tcp_user_timeout rpc +oslo_messaging_zmq/rpc_cast_timeout zeromq +oslo_messaging_zmq/rpc_poll_timeout zeromq +oslo_messaging_zmq/rpc_zmq_bind_address zeromq +oslo_messaging_zmq/rpc_zmq_bind_port_retries zeromq +oslo_messaging_zmq/rpc_zmq_contexts zeromq +oslo_messaging_zmq/rpc_zmq_host zeromq +oslo_messaging_zmq/rpc_zmq_ipc_dir zeromq +oslo_messaging_zmq/rpc_zmq_matchmaker zeromq +oslo_messaging_zmq/rpc_zmq_max_port zeromq +oslo_messaging_zmq/rpc_zmq_min_port zeromq +oslo_messaging_zmq/rpc_zmq_serialization zeromq +oslo_messaging_zmq/rpc_zmq_topic_backlog zeromq +oslo_messaging_zmq/use_pub_sub zeromq +oslo_messaging_zmq/use_router_proxy zeromq +oslo_messaging_zmq/zmq_immediate zeromq +oslo_messaging_zmq/zmq_target_expire zeromq +oslo_messaging_zmq/zmq_target_update zeromq +oslo_middleware/enable_proxy_headers_parsing zeromq oslo_middleware/max_request_body_size api oslo_middleware/secure_proxy_ssl_header api oslo_policy/policy_default_rule disable oslo_policy/policy_dirs disable oslo_policy/policy_file disable oslo_versionedobjects/fatal_exception_format_errors api +privsep_osbrick/capabilities osbrick +privsep_osbrick/group osbrick +privsep_osbrick/helper_command osbrick +privsep_osbrick/user osbrick +profiler/connection_string profiler profiler/enabled profiler profiler/hmac_keys profiler profiler/trace_sqlalchemy profiler diff --git a/tools/autogenerate-config-flagmappings/cinder.headers b/tools/autogenerate-config-flagmappings/cinder.headers index 431641898c..df8622ea3b 100644 --- a/tools/autogenerate-config-flagmappings/cinder.headers +++ b/tools/autogenerate-config-flagmappings/cinder.headers @@ -10,6 +10,7 @@ blockbridge BlockBridge EPS volume driver cloudbyte CloudByte volume driver coho Coho volume driver coordination Coordination +coprhd Coprhd volume driver datera Datera volume driver dellsc Dell Storage Center volume driver disco Disco volume driver @@ -20,6 +21,7 @@ emc_sio EMC SIO volume driver emc_xtremio EMC XtremIO volume driver eqlx Dell EqualLogic volume driver eternus Eternus volume driver +falconstor Falconstor volume driver flashsystem IBM FlashSystem volume driver fujitsu_eternus_dx Fujitsu ETERNUS DX volume driver fusionio Fusion-io driver @@ -36,6 +38,7 @@ hyperv HyperV volume driver ibmnas IBM SONAS and Storwise V7000 volume driver images images infortrend Infortrend volume driver +kaminario Kaminario volume driver lenovo Lenovo volume driver lvm LVM nas NAS @@ -68,6 +71,7 @@ storage_xen Xen storage storpool StorPool volume driver storwize IBM Storwise driver srb Scality REST Block storage driver +synology Synology volume driver tegile Tegile volume driver tintri Tintri volume driver violin Violin volume driver @@ -85,3 +89,4 @@ zoning_fabric_brcd brocade zoning fabrics zoning_fabric_cisco cisco zoning fabrics zoning_manager_brcd brocade zoning manager zoning_manager_cisco cisco zoning manager +zte Zte volume driver