diff --git a/doc/common/tables/cinder-api.xml b/doc/common/tables/cinder-api.xml index 4fa146b7fe..b8053e33f5 100644 --- a/doc/common/tables/cinder-api.xml +++ b/doc/common/tables/cinder-api.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description @@ -29,11 +29,11 @@ enable_v1_api=True - (BoolOpt) Deploy v1 of the Cinder API. + (BoolOpt) Deploy v1 of the Cinder API. enable_v2_api=True - (BoolOpt) Deploy v2 of the Cinder API. + (BoolOpt) Deploy v2 of the Cinder API. osapi_max_limit=1000 @@ -89,4 +89,4 @@ - + \ No newline at end of file diff --git a/doc/common/tables/cinder-auth.xml b/doc/common/tables/cinder-auth.xml index 47647335cc..1d6c5a5007 100644 --- a/doc/common/tables/cinder-auth.xml +++ b/doc/common/tables/cinder-auth.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description diff --git a/doc/common/tables/cinder-backup.xml b/doc/common/tables/cinder-backup.xml index 3c9627938e..ab0e3d1007 100644 --- a/doc/common/tables/cinder-backup.xml +++ b/doc/common/tables/cinder-backup.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description diff --git a/doc/common/tables/cinder-backups.xml b/doc/common/tables/cinder-backups.xml index 4fb140771e..e1c9eed537 100644 --- a/doc/common/tables/cinder-backups.xml +++ b/doc/common/tables/cinder-backups.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description @@ -19,30 +19,6 @@ backup_api_class=cinder.backup.api.API (StrOpt) The full class name of the volume backup API class - - backup_ceph_chunk_size=134217728 - (IntOpt) the chunk size in bytes that a backup will be broken into before transfer to backup store - - - backup_ceph_conf=/etc/ceph/ceph.conf - (StrOpt) Ceph config file to use. - - - backup_ceph_pool=backups - (StrOpt) the Ceph pool to backup to - - - backup_ceph_stripe_count=0 - (IntOpt) RBD stripe count to use when creating a backup image - - - backup_ceph_stripe_unit=0 - (IntOpt) RBD stripe unit to use when creating a backup image - - - backup_ceph_user=cinder - (StrOpt) the Ceph user to connect with - backup_driver=cinder.backup.drivers.swift (StrOpt) Driver to use for backups. @@ -59,6 +35,10 @@ backup_topic=cinder-backup (StrOpt) the topic volume backup nodes listen on + + restore_discard_excess_bytes=True + (BoolOpt) If True, always discard excess bytes when restoring volumes. + \ No newline at end of file diff --git a/doc/common/tables/cinder-backups_ceph.xml b/doc/common/tables/cinder-backups_ceph.xml new file mode 100644 index 0000000000..4bdb90c252 --- /dev/null +++ b/doc/common/tables/cinder-backups_ceph.xml @@ -0,0 +1,44 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of configuration options for backups_ceph
Configuration option=Default valueDescription
backup_ceph_chunk_size=134217728(IntOpt) the chunk size in bytes that a backup will be broken into before transfer to backup store
backup_ceph_conf=/etc/ceph/ceph.conf(StrOpt) Ceph config file to use.
backup_ceph_pool=backups(StrOpt) the Ceph pool to backup to
backup_ceph_stripe_count=0(IntOpt) RBD stripe count to use when creating a backup image
backup_ceph_stripe_unit=0(IntOpt) RBD stripe unit to use when creating a backup image
backup_ceph_user=cinder(StrOpt) the Ceph user to connect with
+ \ No newline at end of file diff --git a/doc/common/tables/cinder-backups_swift.xml b/doc/common/tables/cinder-backups_swift.xml new file mode 100644 index 0000000000..c443007a83 --- /dev/null +++ b/doc/common/tables/cinder-backups_swift.xml @@ -0,0 +1,56 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of configuration options for backups_swift
Configuration option=Default valueDescription
backup_compression_algorithm=zlib(StrOpt) Compression algorithm (None to disable)
backup_swift_auth=per_user(StrOpt) Swift authentication mechanism
backup_swift_container=volumebackups(StrOpt) The default Swift container to use
backup_swift_key=None(StrOpt) Swift key for authentication
backup_swift_object_size=52428800(IntOpt) The size in bytes of Swift backup objects
backup_swift_retry_attempts=3(IntOpt) The number of retries to make for Swift operations
backup_swift_retry_backoff=2(IntOpt) The backoff time in seconds between Swift retries
backup_swift_url=http://localhost:8080/v1/AUTH_(StrOpt) The URL of the Swift endpoint
backup_swift_user=None(StrOpt) Swift user name
+ \ No newline at end of file diff --git a/doc/common/tables/cinder-backups_tsm.xml b/doc/common/tables/cinder-backups_tsm.xml new file mode 100644 index 0000000000..919b35fc99 --- /dev/null +++ b/doc/common/tables/cinder-backups_tsm.xml @@ -0,0 +1,32 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of configuration options for backups_tsm
Configuration option=Default valueDescription
backup_tsm_compression=True(BoolOpt) Enable or Disable compression for backups
backup_tsm_password=password(StrOpt) TSM password for the running username
backup_tsm_volume_prefix=backup(StrOpt) Volume prefix for the backup id when backing up to TSM
+ \ No newline at end of file diff --git a/doc/common/tables/cinder-common.xml b/doc/common/tables/cinder-common.xml index 8b108af294..3ebbc64199 100644 --- a/doc/common/tables/cinder-common.xml +++ b/doc/common/tables/cinder-common.xml @@ -11,14 +11,22 @@ Configuration option=Default value - (Type) Description + Description + + compute_api_class=cinder.compute.nova.API + (StrOpt) The full class name of the compute API class to use + debug=False (BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level). + + default_availability_zone=None + (StrOpt) default availability zone to use when creating a new volume. If this is not set then we use the value from the storage_availability_zone option as the default availability_zone for new volumes. + default_log_levels=amqplib=WARN,sqlalchemy=WARN,boto=WARN,suds=INFO,keystone=INFO,eventlet.wsgi.server=WARN (ListOpt) list of logger=LEVEL pairs @@ -28,7 +36,7 @@ (StrOpt) Default notification level for outgoing notifications - default_publisher_id=$host + default_publisher_id=None (StrOpt) Default publisher_id for outgoing notifications @@ -51,10 +59,6 @@ fatal_exception_format_errors=False (BoolOpt) make exception message format errors fatal - - host=127.0.0.1 - (StrOpt) Host to locate redis - host=autodoc (StrOpt) Name of this node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address. @@ -67,6 +71,10 @@ host=autodoc (StrOpt) Name of this node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address. + + host=127.0.0.1 + (StrOpt) Host to locate redis + idle_timeout=3600 (IntOpt) timeout before idle sql connections are reaped @@ -121,14 +129,14 @@ monkey_patch=False - (BoolOpt) Whether to log monkey patching + (BoolOpt) Enable monkey patching monkey_patch_modules= (ListOpt) List of modules/decorators to monkey patch - my_ip=198.61.167.113 + my_ip=192.168.122.175 (StrOpt) ip address of this host @@ -136,13 +144,37 @@ (BoolOpt) Whether snapshots count against GigaByte quota - num_iscsi_scan_tries=3 - (IntOpt) number of times to rescan iSCSI target to find volume + nova_api_insecure=False + (BoolOpt) Allow to perform insecure SSL requests to nova + + + nova_ca_certificates_file=None + (StrOpt) Location of ca certicates file to use for nova client requests. + + + nova_catalog_admin_info=compute:nova:adminURL + (StrOpt) Same as nova_catalog_info, but for admin endpoint. + + + nova_catalog_info=compute:nova:publicURL + (StrOpt) Info to match when looking for nova in the service catalog. Format is : separated values of the form: <service_type>:<service_name>:<endpoint_type> + + + nova_endpoint_admin_template=None + (StrOpt) Same as nova_endpoint_template, but for admin endpoint. + + + nova_endpoint_template=None + (StrOpt) Override service catalog lookup with template for nova endpoint e.g. http://localhost:8774/v2/%(tenant_id)s num_shell_tries=3 (IntOpt) number of times to attempt to run flakey shell commands + + os_region_name=None + (StrOpt) region name of this node + password=None (StrOpt) Password for Redis server. (optional) @@ -164,7 +196,7 @@ (IntOpt) Use this port to connect to redis host. - pybasedir=/home/stacker/repos/cinder + pybasedir=/usr/lib/python2.7/site-packages (StrOpt) Directory where the cinder python module is installed @@ -200,7 +232,7 @@ (StrOpt) Deprecated: command to use for running commands as root - rootwrap_config=None + rootwrap_config=/etc/cinder/rootwrap.conf (StrOpt) Path to the rootwrap configuration file to use for running commands as root @@ -261,7 +293,7 @@ topics=notifications - (ListOpt) AMQP topic(s) used for openstack notifications + (ListOpt) AMQP topic(s) used for OpenStack notifications until_refresh=0 diff --git a/doc/common/tables/cinder-connection.xml b/doc/common/tables/cinder-connection.xml index 1fbf878bc3..fb4a00fe48 100644 --- a/doc/common/tables/cinder-connection.xml +++ b/doc/common/tables/cinder-connection.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description diff --git a/doc/common/tables/cinder-database.xml b/doc/common/tables/cinder-database.xml index 3cb982635d..321431a7cc 100644 --- a/doc/common/tables/cinder-database.xml +++ b/doc/common/tables/cinder-database.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description diff --git a/doc/common/tables/cinder-gpfs_volume.xml b/doc/common/tables/cinder-gpfs_volume.xml new file mode 100644 index 0000000000..a00f26af0e --- /dev/null +++ b/doc/common/tables/cinder-gpfs_volume.xml @@ -0,0 +1,40 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of configuration options for gpfs_volume
Configuration option=Default valueDescription
gpfs_images_dir=None(StrOpt) Path to GPFS Glance repository as mounted on Nova nodes
gpfs_images_share_mode=None(StrOpt) Set this if Glance image repo is on GPFS as well so that the image bits can be transferred efficiently between Glance and Cinder. Valid values are copy or copy_on_write. copy performs a full copy of the image, copy_on_write efficiently shares unmodified blocks of the image.
gpfs_max_clone_depth=0(IntOpt) A lengthy chain of copy-on-write snapshots or clones could have impact on performance. This option limits the number of indirections required to reach a specific block. 0 indicates unlimited.
gpfs_mount_point_base=None(StrOpt) Path to the directory on GPFS mount point where volumes are stored
gpfs_sparse_volumes=True(BoolOpt) Create volumes as sparse files which take no space. If set to False volume is created as regular file. In this case volume creation may take a significantly longer time.
+ \ No newline at end of file diff --git a/doc/common/tables/cinder-images.xml b/doc/common/tables/cinder-images.xml index 580a6d77ee..3bc0acd5f0 100644 --- a/doc/common/tables/cinder-images.xml +++ b/doc/common/tables/cinder-images.xml @@ -11,10 +11,14 @@ Configuration option=Default value - (Type) Description + Description + + allowed_direct_url_schemes= + (ListOpt) A list of url schemes that can be downloaded directly via the direct_url. Currently supported schemes: [file]. + glance_api_insecure=False (BoolOpt) Allow to perform insecure SSL (https) requests to glance @@ -44,35 +48,19 @@ (IntOpt) default glance port - gpfs_images_dir=None - (StrOpt) Path to GPFS Glance repository as mounted on Nova nodes + glance_request_timeout=None + (IntOpt) http/https timeout value for glance operations. If no value (None) is supplied here, the glanceclient default value is used. - gpfs_images_share_mode=None - (StrOpt) Set this if Glance image repo is on GPFS as well so that the image bits can be transferred efficiently between Glance and Cinder. Valid values are copy or copy_on_write. copy performs a full copy of the image, copy_on_write efficiently shares unmodified blocks of the image. + image_conversion_dir=$state_path/conversion + (StrOpt) Directory used for temporary storage during image conversion - gpfs_max_clone_depth=0 - (IntOpt) A lengthy chain of copy-on-write snapshots or clones could have impact on performance. This option limits the number of indirections required to reach a specific block. 0 indicates unlimited. - - - gpfs_mount_point_base=None - (StrOpt) Path to the directory on GPFS mount point where volumes are stored - - - gpfs_sparse_volumes=True - (BoolOpt) Create volumes as sparse files which take no space. If set to False volume is created as regular file. In this case volume creation may take a significantly longer time. - - - image_conversion_dir=/tmp - (StrOpt) parent dir for tempdir used for image conversion - - - instance_format=[instance: %(uuid)s] + instance_format=[instance: %(uuid)s] (StrOpt) If an instance is passed with the log message, format it like this - instance_uuid_format=[instance: %(uuid)s] + instance_uuid_format=[instance: %(uuid)s] (StrOpt) If an instance UUID is passed with the log message, format it like this @@ -81,4 +69,4 @@ - + \ No newline at end of file diff --git a/doc/common/tables/cinder-log.xml b/doc/common/tables/cinder-log.xml index cf4d850b5d..7bf93f313d 100644 --- a/doc/common/tables/cinder-log.xml +++ b/doc/common/tables/cinder-log.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description diff --git a/doc/common/tables/cinder-rpc.xml b/doc/common/tables/cinder-rpc.xml index 5797d87da0..03ea425a37 100644 --- a/doc/common/tables/cinder-rpc.xml +++ b/doc/common/tables/cinder-rpc.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description @@ -19,6 +19,14 @@ allowed_rpc_exception_modules=cinder.openstack.common.exception,nova.exception,cinder.exception,exceptions (ListOpt) Modules of exceptions that are permitted to be recreatedupon receiving exception data from an rpc call. + + amqp_auto_delete=False + (BoolOpt) Auto-delete queues in amqp. + + + amqp_durable_queues=False + (BoolOpt) Use durable queues in amqp. + amqp_rpc_single_reply_queue=False (BoolOpt) Enable a fast single reply queue if using AMQP based RPC like RabbitMQ or Qpid. @@ -65,7 +73,7 @@ notification_topics=notifications - (ListOpt) AMQP topic used for openstack notifications + (ListOpt) AMQP topic used for OpenStack notifications publish_errors=False @@ -104,12 +112,12 @@ (BoolOpt) Disable Nagle algorithm - qpid_username= - (StrOpt) Username for qpid connection + qpid_topology_version=1 + (IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break. - rabbit_durable_queues=False - (BoolOpt) use durable queues in RabbitMQ + qpid_username= + (StrOpt) Username for qpid connection rabbit_ha_queues=False diff --git a/doc/common/tables/cinder-scheduler.xml b/doc/common/tables/cinder-scheduler.xml index 9e90994719..f29f5565f7 100644 --- a/doc/common/tables/cinder-scheduler.xml +++ b/doc/common/tables/cinder-scheduler.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description diff --git a/doc/common/tables/cinder-storage.xml b/doc/common/tables/cinder-storage.xml index 04a02d2368..e2002e39f9 100644 --- a/doc/common/tables/cinder-storage.xml +++ b/doc/common/tables/cinder-storage.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description @@ -60,25 +60,81 @@ (ListOpt) A list of backend names to use. These backend names should be backed by a unique [CONFIG] group with its options - glusterfs_disk_util=df - (StrOpt) Use du or df for free space calculation + eqlx_chap_login=admin + (StrOpt) Existing CHAP account name - glusterfs_mount_point_base=$state_path/mnt - (StrOpt) Base dir containing mount points for gluster shares + eqlx_chap_password=password + (StrOpt) Password for specified CHAP account name - glusterfs_shares_config=/etc/cinder/glusterfs_shares - (StrOpt) File with the list of available gluster shares + eqlx_cli_max_retries=5 + (IntOpt) Maximum retry count for reconnection - glusterfs_sparsed_volumes=True - (BoolOpt) Create volumes as sparsed files which take no space.If set to False volume is created as regular file.In such case volume creation takes a lot of time. + eqlx_cli_timeout=30 + (IntOpt) Timeout for the Group Manager cli command execution + + + eqlx_group_name=group-0 + (StrOpt) Group name to use for creating volumes + + + eqlx_pool=default + (StrOpt) Pool in which volumes will be created + + + eqlx_use_chap=False + (BoolOpt) Use CHAP authentificaion for targets? + + + expiry_thres_minutes=720 + (IntOpt) Threshold minutes after which cache file can be cleaned. hds_cinder_config_file=/opt/hds/hus/cinder_hus_conf.xml (StrOpt) configuration file for HDS cinder plugin for HUS + + hp3par_api_url= + (StrOpt) 3PAR WSAPI Server Url like https://<3par ip>:8080/api/v1 + + + hp3par_cpg=OpenStack + (StrOpt) The CPG to use for volume creation + + + hp3par_cpg_snap= + (StrOpt) The CPG to use for Snapshots for volumes. If empty hp3par_cpg will be used + + + hp3par_debug=False + (BoolOpt) Enable HTTP debugging to 3PAR + + + hp3par_domain=None + (StrOpt) This option is DEPRECATED and no longer used. The 3par domain name to use. + + + hp3par_iscsi_ips= + (ListOpt) List of target iSCSI addresses to use. + + + hp3par_password= + (StrOpt) 3PAR Super user password + + + hp3par_snapshot_expiration= + (StrOpt) The time in hours when a snapshot expires and is deleted. This must be larger than expiration + + + hp3par_snapshot_retention= + (StrOpt) The time in hours to retain a snapshot. You can't delete it before this expires. + + + hp3par_username= + (StrOpt) 3PAR Super user username + iscsi_helper=tgtadm (StrOpt) iscsi target user-land tool to use @@ -89,11 +145,11 @@ iscsi_ip_address=$my_ip - (StrOpt) The port that the iSCSI daemon is listening on + (StrOpt) The IP address that the iSCSI daemon is listening on iscsi_num_targets=100 - (IntOpt) Number of iscsi target ids per host + (IntOpt) The maximum number of iscsi target ids per host iscsi_port=3260 @@ -103,10 +159,38 @@ iscsi_target_prefix=iqn.2010-10.org.openstack: (StrOpt) prefix for iscsi volumes + + iser_helper=tgtadm + (StrOpt) iser target user-land tool to use + + + iser_ip_address=$my_ip + (StrOpt) The IP address that the iSER daemon is listening on + + + iser_num_targets=100 + (IntOpt) The maximum number of iser target ids per host + + + iser_port=3260 + (IntOpt) The port that the iSER daemon is listening on + + + iser_target_prefix=iqn.2010-10.org.iser.openstack: + (StrOpt) prefix for iser volumes + + + keymgr_api_class=cinder.keymgr.not_implemented_key_mgr.NotImplementedKeyManager + (StrOpt) The full class name of the key manager API class + lvm_mirrors=0 (IntOpt) If set, create lvms with multiple mirrors. Note that this requires lvm_mirrors + 2 pvs with available space + + lvm_type=default + (StrOpt) Type of LVM volumes to deploy; (default or thin) + max_age=0 (IntOpt) number of seconds between subsequent usage refreshes @@ -139,10 +223,6 @@ min_pool_size=1 (IntOpt) Minimum number of SQL connections to keep open in a pool - - netapp_login=None - (StrOpt) User name for the storage controller - netapp_password=None (StrOpt) Password for the storage controller @@ -171,85 +251,21 @@ netapp_transport_type=http (StrOpt) Transport type protocol - - netapp_vfiler=None - (StrOpt) Vfiler to use for provisioning - netapp_volume_list=None (StrOpt) Comma separated volumes to be used for provisioning - netapp_vserver=openstack + netapp_vserver=None (StrOpt) Cluster vserver to use for provisioning - nexenta_blocksize= - (StrOpt) block size for volumes (blank=default,8KB) + num_iser_scan_tries=3 + (IntOpt) The maximum number of times to rescan iSER targetto find volume - nexenta_host= - (StrOpt) IP address of Nexenta SA - - - nexenta_iscsi_target_portal_port=3260 - (IntOpt) Nexenta target portal port - - - nexenta_password=nexenta - (StrOpt) Password to connect to Nexenta SA - - - nexenta_rest_port=2000 - (IntOpt) HTTP port to connect to Nexenta REST API server - - - nexenta_rest_protocol=auto - (StrOpt) Use http or https for REST connection (default auto) - - - nexenta_sparse=False - (BoolOpt) flag to create sparse volumes - - - nexenta_target_group_prefix=cinder/ - (StrOpt) prefix for iSCSI target groups on SA - - - nexenta_target_prefix=iqn.1986-03.com.sun:02:cinder- - (StrOpt) IQN prefix for iSCSI targets - - - nexenta_user=admin - (StrOpt) User name to connect to Nexenta SA - - - nexenta_volume=cinder - (StrOpt) pool on SA that will hold all volumes - - - nfs_mount_options=None - (StrOpt) Mount options passed to the nfs client. See section of the nfs man page for details - - - nfs_mount_point_base=$state_path/mnt - (StrOpt) Base dir containing mount points for nfs shares - - - nfs_oversub_ratio=1.0 - (FloatOpt) This will compare the allocated to available space on the volume destination. If the ratio exceeds this number, the destination will no longer be valid. - - - nfs_shares_config=/etc/cinder/nfs_shares - (StrOpt) File with the list of available nfs shares - - - nfs_sparsed_volumes=True - (BoolOpt) Create volumes as sparsed files which take no space.If set to False volume is created as regular file.In such case volume creation takes a lot of time. - - - nfs_used_ratio=0.95 - (FloatOpt) Percent of ACTUAL usage of the underlying volume before no new volumes can be allocated to the volume destination. + num_volume_device_scan_tries=3 + (IntOpt) The maximum number of times to rescan targetsto find volume rbd_ceph_conf= @@ -259,6 +275,10 @@ rbd_flatten_volume_from_snapshot=False (BoolOpt) flatten volumes created from snapshots to remove dependency + + rbd_max_clone_depth=5 + (IntOpt) maximum number of nested clones that can be taken of a volume before enforcing a flatten prior to next clone. A value of zero disables cloning + rbd_pool=rbd (StrOpt) the RADOS pool in which rbd volumes are stored @@ -327,6 +347,10 @@ sf_allow_tenant_qos=False (BoolOpt) Allow tenants to specify QOS on create + + sf_api_port=443 + (IntOpt) SolidFire API port. Useful if the device api is behind a proxy on a different port. + sf_emulate_512=True (BoolOpt) Set 512 byte emulation on volume creation; @@ -337,7 +361,7 @@ storwize_svc_flashcopy_timeout=120 - (IntOpt) Maximum number of seconds to wait for FlashCopy to be prepared. Maximum value is 600 seconds (10 minutes). + (IntOpt) Maximum number of seconds to wait for FlashCopy to be prepared. Maximum value is 600 seconds (10 minutes) storwize_svc_multihostmap_enabled=True @@ -345,7 +369,7 @@ storwize_svc_multipath_enabled=False - (BoolOpt) Connect with multipath (currently FC-only) + (BoolOpt) Connect with multipath (FC only; iSCSI multipath is controlled by Nova) storwize_svc_vol_autoexpand=True @@ -363,6 +387,10 @@ storwize_svc_vol_grainsize=256 (IntOpt) Storage system grain size parameter for volumes (32/64/128/256) + + storwize_svc_vol_iogrp=0 + (IntOpt) The I/O group in which to allocate volumes + storwize_svc_vol_rsize=2 (IntOpt) Storage system space-efficiency parameter for volumes (percentage) @@ -375,13 +403,21 @@ storwize_svc_volpool_name=volpool (StrOpt) Storage system storage pool for volumes + + thres_avl_size_perc_start=20 + (IntOpt) Threshold available percent to start cache cleaning. + + + thres_avl_size_perc_stop=60 + (IntOpt) Threshold available percent to stop cache cleaning. + volume_backend_name=None (StrOpt) The backend name for a given driver implementation volume_clear=zero - (StrOpt) Method used to wipe old volumes (valid options are: none, zero, shred) + (StrOpt) Method used to wipe old voumes (valid options are: none, zero, shred) volume_clear_size=0 @@ -436,16 +472,12 @@ (StrOpt) Path to store VHD backed volumes - xiv_proxy=xiv_openstack.nova_proxy.XIVNovaProxy - (StrOpt) Proxy driver + xiv_ds8k_connection_type=iscsi + (StrOpt) Connection type to the IBM Storage Array (fibre_channel|iscsi) - zadara_default_cache_policy=write-through - (StrOpt) Default cache policy for volumes - - - zadara_default_encryption=NO - (StrOpt) Default encryption policy for volumes + xiv_ds8k_proxy=xiv_ds8k_openstack.nova_proxy.XIVDS8KNovaProxy + (StrOpt) Proxy driver that connects to the IBM Storage Array zadara_default_stripesize=64 @@ -463,10 +495,18 @@ zadara_user=None (StrOpt) User name for the VPSA + + zadara_vol_encrypt=False + (BoolOpt) Default encryption policy for volumes + zadara_vol_name_template=OS_%s (StrOpt) Default template for VPSA volume names + + zadara_vol_thin=True + (BoolOpt) Default thin provisioning policy for volumes + zadara_vpsa_allow_nonexistent_delete=True (BoolOpt) Don't halt on deletion of non-existing volumes diff --git a/doc/common/tables/cinder-storage_glusterfs.xml b/doc/common/tables/cinder-storage_glusterfs.xml new file mode 100644 index 0000000000..1c5ef8ae9c --- /dev/null +++ b/doc/common/tables/cinder-storage_glusterfs.xml @@ -0,0 +1,40 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of configuration options for storage_glusterfs
Configuration option=Default valueDescription
glusterfs_disk_util=df(StrOpt) Use du or df for free space calculation
glusterfs_mount_point_base=$state_path/mnt(StrOpt) Base dir containing mount points for gluster shares
glusterfs_qcow2_volumes=False(BoolOpt) Create volumes as QCOW2 files rather than raw files.
glusterfs_shares_config=/etc/cinder/glusterfs_shares(StrOpt) File with the list of available gluster shares
glusterfs_sparsed_volumes=True(BoolOpt) Create volumes as sparsed files which take no space.If set to False volume is created as regular file.In such case volume creation takes a lot of time.
+ \ No newline at end of file diff --git a/doc/common/tables/cinder-storage_netapp.xml b/doc/common/tables/cinder-storage_netapp.xml new file mode 100644 index 0000000000..90f3890424 --- /dev/null +++ b/doc/common/tables/cinder-storage_netapp.xml @@ -0,0 +1,28 @@ + + + + + + + + + + + + + + + + + + + + + + + +
Description of configuration options for storage_netapp
Configuration option=Default valueDescription
netapp_login=None(StrOpt) User name for the storage controller
netapp_vfiler=None(StrOpt) Vfiler to use for provisioning
+ \ No newline at end of file diff --git a/doc/common/tables/cinder-storage_nexenta_iscsi.xml b/doc/common/tables/cinder-storage_nexenta_iscsi.xml new file mode 100644 index 0000000000..cbb2f36fb7 --- /dev/null +++ b/doc/common/tables/cinder-storage_nexenta_iscsi.xml @@ -0,0 +1,64 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of configuration options for storage_nexenta_iscsi
Configuration option=Default valueDescription
nexenta_blocksize=(StrOpt) block size for volumes (blank=default,8KB)
nexenta_host=(StrOpt) IP address of Nexenta SA
nexenta_iscsi_target_portal_port=3260(IntOpt) Nexenta target portal port
nexenta_password=nexenta(StrOpt) Password to connect to Nexenta SA
nexenta_rest_port=2000(IntOpt) HTTP port to connect to Nexenta REST API server
nexenta_rest_protocol=auto(StrOpt) Use http or https for REST connection (default auto)
nexenta_sparse=False(BoolOpt) flag to create sparse volumes
nexenta_target_group_prefix=cinder/(StrOpt) prefix for iSCSI target groups on SA
nexenta_target_prefix=iqn.1986-03.com.sun:02:cinder-(StrOpt) IQN prefix for iSCSI targets
nexenta_user=admin(StrOpt) User name to connect to Nexenta SA
nexenta_volume=cinder(StrOpt) pool on SA that will hold all volumes
+ \ No newline at end of file diff --git a/doc/common/tables/cinder-storage_nexenta_nfs.xml b/doc/common/tables/cinder-storage_nexenta_nfs.xml new file mode 100644 index 0000000000..10fd8a56cb --- /dev/null +++ b/doc/common/tables/cinder-storage_nexenta_nfs.xml @@ -0,0 +1,48 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of configuration options for storage_nexenta_nfs
Configuration option=Default valueDescription
nexenta_mount_options=None(StrOpt) Mount options passed to the nfs client. See section of the nfs man page for details
nexenta_mount_point_base=$state_path/mnt(StrOpt) Base dir containing mount points for nfs shares
nexenta_oversub_ratio=1.0(FloatOpt) This will compare the allocated to available space on the volume destination. If the ratio exceeds this number, the destination will no longer be valid.
nexenta_shares_config=/etc/cinder/nfs_shares(StrOpt) File with the list of available nfs shares
nexenta_sparsed_volumes=True(BoolOpt) Create volumes as sparsed files which take no space.If set to False volume is created as regular file.In such case volume creation takes a lot of time.
nexenta_used_ratio=0.95(FloatOpt) Percent of ACTUAL usage of the underlying volume before no new volumes can be allocated to the volume destination.
nexenta_volume_compression=on(StrOpt) Default compression value for new ZFS folders.
+ \ No newline at end of file diff --git a/doc/common/tables/cinder-storage_nfs.xml b/doc/common/tables/cinder-storage_nfs.xml new file mode 100644 index 0000000000..bef1a4075f --- /dev/null +++ b/doc/common/tables/cinder-storage_nfs.xml @@ -0,0 +1,44 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of configuration options for storage_nfs
Configuration option=Default valueDescription
nfs_mount_options=None(StrOpt) Mount options passed to the nfs client. See section of the nfs man page for details
nfs_mount_point_base=$state_path/mnt(StrOpt) Base dir containing mount points for nfs shares
nfs_oversub_ratio=1.0(FloatOpt) This will compare the allocated to available space on the volume destination. If the ratio exceeds this number, the destination will no longer be valid.
nfs_shares_config=/etc/cinder/nfs_shares(StrOpt) File with the list of available nfs shares
nfs_sparsed_volumes=True(BoolOpt) Create volumes as sparsed files which take no space.If set to False volume is created as regular file.In such case volume creation takes a lot of time.
nfs_used_ratio=0.95(FloatOpt) Percent of ACTUAL usage of the underlying volume before no new volumes can be allocated to the volume destination.
+ \ No newline at end of file diff --git a/doc/common/tables/cinder-zones.xml b/doc/common/tables/cinder-zones.xml index 2c8fe38c50..771b73cef2 100644 --- a/doc/common/tables/cinder-zones.xml +++ b/doc/common/tables/cinder-zones.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description diff --git a/tools/autogenerate-config-docs/flagmappings/cinder.flagmappings b/tools/autogenerate-config-docs/flagmappings/cinder.flagmappings index 66d81ca9c6..182862e472 100644 --- a/tools/autogenerate-config-docs/flagmappings/cinder.flagmappings +++ b/tools/autogenerate-config-docs/flagmappings/cinder.flagmappings @@ -1,4 +1,7 @@ +allowed_direct_url_schemes images allowed_rpc_exception_modules rpc +amqp_auto_delete rpc +amqp_durable_queues rpc amqp_rpc_single_reply_queue rpc api_paste_config api api_rate_limit api @@ -8,20 +11,33 @@ backdoor_port api backend storage backlog log backup_api_class backups -backup_ceph_chunk_size backups -backup_ceph_conf backups -backup_ceph_pool backups -backup_ceph_stripe_count backups -backup_ceph_stripe_unit backups -backup_ceph_user backups +backup_ceph_chunk_size backups_ceph +backup_ceph_conf backups_ceph +backup_ceph_pool backups_ceph +backup_ceph_stripe_count backups_ceph +backup_ceph_stripe_unit backups_ceph +backup_ceph_user backups_ceph +backup_compression_algorithm backups_swift backup_driver backups backup_manager backups backup_name_template backups +backup_swift_auth backups_swift +backup_swift_container backups_swift +backup_swift_key backups_swift +backup_swift_object_size backups_swift +backup_swift_retry_attempts backups_swift +backup_swift_retry_backoff backups_swift +backup_swift_url backups_swift +backup_swift_user backups_swift backup_topic backups +backup_tsm_compression backups_tsm +backup_tsm_password backups_tsm +backup_tsm_volume_prefix backups_tsm bindir storage capacity_weight_multiplier storage cinder_huawei_conf_file storage cloned_volume_same_az zones +compute_api_class common connection connection connection_debug connection connection_trace connection @@ -35,6 +51,7 @@ coraid_user storage db_backend database db_driver database debug common +default_availability_zone common default_log_levels common default_notification_level common default_publisher_id common @@ -44,6 +61,14 @@ enable_new_services common enable_v1_api api enable_v2_api api enabled_backends storage +eqlx_chap_login storage +eqlx_chap_password storage +eqlx_cli_max_retries storage +eqlx_cli_timeout storage +eqlx_group_name storage +eqlx_pool storage +eqlx_use_chap storage +expiry_thres_minutes storage fake_rabbit rpc fatal_deprecations common fatal_exception_format_errors common @@ -54,18 +79,30 @@ glance_api_version images glance_host images glance_num_retries images glance_port images -glusterfs_disk_util storage -glusterfs_mount_point_base storage -glusterfs_shares_config storage -glusterfs_sparsed_volumes storage -gpfs_images_dir images -gpfs_images_share_mode images -gpfs_max_clone_depth images -gpfs_mount_point_base images -gpfs_sparse_volumes images +glance_request_timeout images +glusterfs_disk_util storage_glusterfs +glusterfs_mount_point_base storage_glusterfs +glusterfs_qcow2_volumes storage_glusterfs +glusterfs_shares_config storage_glusterfs +glusterfs_sparsed_volumes storage_glusterfs +gpfs_images_dir gpfs_volume +gpfs_images_share_mode gpfs_volume +gpfs_max_clone_depth gpfs_volume +gpfs_mount_point_base gpfs_volume +gpfs_sparse_volumes gpfs_volume hds_cinder_config_file storage host common host common +hp3par_api_url storage +hp3par_cpg storage +hp3par_cpg_snap storage +hp3par_debug storage +hp3par_domain storage +hp3par_iscsi_ips storage +hp3par_password storage +hp3par_snapshot_expiration storage +hp3par_snapshot_retention storage +hp3par_username storage idle_timeout common iet_conf common image_conversion_dir images @@ -77,17 +114,17 @@ iscsi_ip_address storage iscsi_num_targets storage iscsi_port storage iscsi_target_prefix storage -iser_target_prefix Unknown +iser_helper storage +iser_ip_address storage +iser_num_targets storage +iser_port storage +iser_target_prefix storage +keymgr_api_class storage kombu_ssl_ca_certs rpc -iser_port Unknown kombu_ssl_certfile rpc -iser_num_targets Unknown kombu_ssl_keyfile rpc -iser_ip_address Unknown kombu_ssl_version rpc -keymgr_api_class Unknown lio_initiator_iqns common -iser_helper Unknown lock_path common log_config common log_date_format common @@ -99,6 +136,7 @@ logging_debug_format_suffix common logging_default_format_string common logging_exception_prefix common lvm_mirrors storage +lvm_type storage matchmaker_heartbeat_freq rpc matchmaker_heartbeat_ttl rpc matchmaker_ringfile rpc @@ -113,7 +151,7 @@ min_pool_size storage monkey_patch common monkey_patch_modules common my_ip common -netapp_login storage +netapp_login storage_netapp netapp_password storage netapp_server_hostname storage netapp_server_port storage @@ -121,32 +159,46 @@ netapp_size_multiplier storage netapp_storage_family storage netapp_storage_protocol storage netapp_transport_type storage -netapp_vfiler storage +netapp_vfiler storage_netapp netapp_volume_list storage netapp_vserver storage -nexenta_blocksize storage -nexenta_host storage -nexenta_iscsi_target_portal_port storage -nexenta_password storage -nexenta_rest_port storage -nexenta_rest_protocol storage -nexenta_sparse storage -nexenta_target_group_prefix storage -nexenta_target_prefix storage -nexenta_user storage -nexenta_volume storage -nfs_mount_options storage -nfs_mount_point_base storage -nfs_oversub_ratio storage -nfs_shares_config storage -nfs_sparsed_volumes storage -nfs_used_ratio storage +nexenta_blocksize storage_nexenta_iscsi +nexenta_host storage_nexenta_iscsi +nexenta_iscsi_target_portal_port storage_nexenta_iscsi +nexenta_mount_options storage_nexenta_nfs +nexenta_mount_point_base storage_nexenta_nfs +nexenta_oversub_ratio storage_nexenta_nfs +nexenta_password storage_nexenta_iscsi +nexenta_rest_port storage_nexenta_iscsi +nexenta_rest_protocol storage_nexenta_iscsi +nexenta_shares_config storage_nexenta_nfs +nexenta_sparse storage_nexenta_iscsi +nexenta_sparsed_volumes storage_nexenta_nfs +nexenta_target_group_prefix storage_nexenta_iscsi +nexenta_target_prefix storage_nexenta_iscsi +nexenta_used_ratio storage_nexenta_nfs +nexenta_user storage_nexenta_iscsi +nexenta_volume storage_nexenta_iscsi +nexenta_volume_compression storage_nexenta_nfs +nfs_mount_options storage_nfs +nfs_mount_point_base storage_nfs +nfs_oversub_ratio storage_nfs +nfs_shares_config storage_nfs +nfs_sparsed_volumes storage_nfs +nfs_used_ratio storage_nfs no_snapshot_gb_quota common notification_driver rpc notification_topics rpc -num_iscsi_scan_tries common -num_iser_scan_tries Unknown +nova_api_insecure common +nova_ca_certificates_file common +nova_catalog_admin_info common +nova_catalog_info common +nova_endpoint_admin_template common +nova_endpoint_template common +num_iser_scan_tries storage num_shell_tries common +num_volume_device_scan_tries storage +os_region_name common osapi_max_limit api osapi_max_request_body_size api osapi_volume_base_URL api @@ -167,12 +219,12 @@ qpid_port rpc qpid_protocol rpc qpid_sasl_mechanisms rpc qpid_tcp_nodelay rpc +qpid_topology_version rpc qpid_username rpc quota_driver common quota_gigabytes common quota_snapshots common quota_volumes common -rabbit_durable_queues rpc rabbit_ha_queues rpc rabbit_host rpc rabbit_hosts rpc @@ -186,11 +238,13 @@ rabbit_userid rpc rabbit_virtual_host rpc rbd_ceph_conf storage rbd_flatten_volume_from_snapshot storage +rbd_max_clone_depth storage rbd_pool storage rbd_secret_uuid storage rbd_user storage reservation_expire common reserved_percentage common +restore_discard_excess_bytes backups retry_interval common root_helper common rootwrap_config common @@ -230,6 +284,7 @@ scheduler_topic scheduler service_down_time common sf_account_prefix storage sf_allow_tenant_qos storage +sf_api_port storage sf_emulate_512 storage snapshot_name_template backup snapshot_same_host backup @@ -251,11 +306,14 @@ storwize_svc_vol_autoexpand storage storwize_svc_vol_compression storage storwize_svc_vol_easytier storage storwize_svc_vol_grainsize storage +storwize_svc_vol_iogrp storage storwize_svc_vol_rsize storage storwize_svc_vol_warning storage storwize_svc_volpool_name storage syslog_log_facility common tcp_keepidle common +thres_avl_size_perc_start storage +thres_avl_size_perc_stop storage topics common transfer_api_class api until_refresh common @@ -288,14 +346,15 @@ xenapi_connection_username api xenapi_nfs_server api xenapi_nfs_serverpath api xenapi_sr_base_path api -xiv_proxy storage -zadara_default_cache_policy storage -zadara_default_encryption storage +xiv_ds8k_connection_type storage +xiv_ds8k_proxy storage zadara_default_stripesize storage zadara_default_striping_mode storage zadara_password storage zadara_user storage +zadara_vol_encrypt storage zadara_vol_name_template storage +zadara_vol_thin storage zadara_vpsa_allow_nonexistent_delete storage zadara_vpsa_auto_detach_on_delete storage zadara_vpsa_ip storage