From bb680dfdc7f67ab70990103b0a842e1e17abceb2 Mon Sep 17 00:00:00 2001 From: Tom Fifield Date: Mon, 7 Oct 2013 11:14:21 +0000 Subject: [PATCH] Update conf option tables for cinder This re-runs the autodoc tool to generate new flagmappings for cinder from the recent trunk. It starts to separate out the 'storage' category into various driver components. Change-Id: Iaa8770001fcb182403ce9f1b756d4732d06bc3f6 --- doc/common/tables/cinder-api.xml | 20 +- doc/common/tables/cinder-backups.xml | 12 +- doc/common/tables/cinder-backups_ceph.xml | 4 + doc/common/tables/cinder-backups_swift.xml | 4 - doc/common/tables/cinder-block-device.xml | 24 ++ doc/common/tables/cinder-common.xml | 78 +--- doc/common/tables/cinder-compute.xml | 48 +++ doc/common/tables/cinder-coraid.xml | 36 ++ doc/common/tables/cinder-eqlx.xml | 48 +++ doc/common/tables/cinder-gpfs_volume.xml | 40 -- doc/common/tables/cinder-hds.xml | 24 ++ doc/common/tables/cinder-huawei.xml | 24 ++ .../{cinder-backup.xml => cinder-keymgr.xml} | 10 +- doc/common/tables/cinder-lvm.xml | 36 ++ doc/common/tables/cinder-netapp.xml | 76 ++++ doc/common/tables/cinder-nfs.xml | 44 +++ doc/common/tables/cinder-quota.xml | 48 +++ doc/common/tables/cinder-rpc.xml | 16 +- doc/common/tables/cinder-san-solaris.xml | 24 ++ doc/common/tables/cinder-san.xml | 64 +++ doc/common/tables/cinder-scality.xml | 32 ++ doc/common/tables/cinder-solidfire.xml | 36 ++ doc/common/tables/cinder-storage.xml | 366 +----------------- .../tables/cinder-storage_glusterfs.xml | 2 +- doc/common/tables/cinder-storage_gpfs.xml | 40 ++ doc/common/tables/cinder-storage_nfs.xml | 4 +- doc/common/tables/cinder-storwize.xml | 72 ++++ doc/common/tables/cinder-windows.xml | 24 ++ doc/common/tables/cinder-xiv.xml | 28 ++ doc/common/tables/cinder-zadara.xml | 68 ++++ .../drivers/hds-volume-driver.xml | 1 + .../drivers/huawei-storage-driver.xml | 1 + .../drivers/ibm-gpfs-volume-driver.xml | 2 +- .../drivers/ibm-storwize-svc-driver.xml | 1 + .../drivers/solidfire-volume-driver.xml | 1 + .../drivers/windows-volume-driver.xml | 14 + .../drivers/zadara-volume-driver.xml | 14 + .../block-storage/section_volume-drivers.xml | 2 + .../ch_blockstorageconfigure.xml | 1 - .../flagmappings/cinder.flagmappings | 284 +++++++------- 40 files changed, 1034 insertions(+), 639 deletions(-) create mode 100644 doc/common/tables/cinder-block-device.xml create mode 100644 doc/common/tables/cinder-compute.xml create mode 100644 doc/common/tables/cinder-coraid.xml create mode 100644 doc/common/tables/cinder-eqlx.xml delete mode 100644 doc/common/tables/cinder-gpfs_volume.xml create mode 100644 doc/common/tables/cinder-hds.xml create mode 100644 doc/common/tables/cinder-huawei.xml rename doc/common/tables/{cinder-backup.xml => cinder-keymgr.xml} (63%) create mode 100644 doc/common/tables/cinder-lvm.xml create mode 100644 doc/common/tables/cinder-netapp.xml create mode 100644 doc/common/tables/cinder-nfs.xml create mode 100644 doc/common/tables/cinder-quota.xml create mode 100644 doc/common/tables/cinder-san-solaris.xml create mode 100644 doc/common/tables/cinder-san.xml create mode 100644 doc/common/tables/cinder-scality.xml create mode 100644 doc/common/tables/cinder-solidfire.xml create mode 100644 doc/common/tables/cinder-storage_gpfs.xml create mode 100644 doc/common/tables/cinder-storwize.xml create mode 100644 doc/common/tables/cinder-windows.xml create mode 100644 doc/common/tables/cinder-xiv.xml create mode 100644 doc/common/tables/cinder-zadara.xml create mode 100644 doc/config-reference/block-storage/drivers/windows-volume-driver.xml create mode 100644 doc/config-reference/block-storage/drivers/zadara-volume-driver.xml diff --git a/doc/common/tables/cinder-api.xml b/doc/common/tables/cinder-api.xml index 7d889597c2..b51be75fa8 100644 --- a/doc/common/tables/cinder-api.xml +++ b/doc/common/tables/cinder-api.xml @@ -47,14 +47,14 @@ osapi_volume_base_URL=None (StrOpt) Base URL that will be presented to users in links to the OpenStack Volume API - - osapi_volume_ext_list= - (ListOpt) Specify list of extensions to load when using osapi_volume_extension option with cinder.api.contrib.select_extensions - osapi_volume_extension=['cinder.api.contrib.standard_extensions'] (MultiStrOpt) osapi volume extension to load + + osapi_volume_ext_list= + (ListOpt) Specify list of extensions to load when using osapi_volume_extension option with cinder.api.contrib.select_extensions + transfer_api_class=cinder.transfer.api.API (StrOpt) The full class name of the volume transfer API class @@ -63,6 +63,18 @@ volume_api_class=cinder.volume.api.API (StrOpt) The full class name of the volume API class to use + + volume_name_template=volume-%s + (StrOpt) Template string to be used to generate volume names + + + volume_transfer_key_length=16 + (IntOpt) The number of characters in the autogenerated auth key. + + + volume_transfer_salt_length=8 + (IntOpt) The number of characters in the salt. + \ No newline at end of file diff --git a/doc/common/tables/cinder-backups.xml b/doc/common/tables/cinder-backups.xml index e1c9eed537..2201befed7 100644 --- a/doc/common/tables/cinder-backups.xml +++ b/doc/common/tables/cinder-backups.xml @@ -19,6 +19,10 @@ backup_api_class=cinder.backup.api.API (StrOpt) The full class name of the volume backup API class + + backup_compression_algorithm=zlib + (StrOpt) Compression algorithm (None to disable) + backup_driver=cinder.backup.drivers.swift (StrOpt) Driver to use for backups. @@ -36,8 +40,12 @@ (StrOpt) the topic volume backup nodes listen on - restore_discard_excess_bytes=True - (BoolOpt) If True, always discard excess bytes when restoring volumes. + snapshot_name_template=snapshot-%s + (StrOpt) Template string to be used to generate snapshot names + + + snapshot_same_host=True + (BoolOpt) Create volume from snapshot at the host where snapshot resides diff --git a/doc/common/tables/cinder-backups_ceph.xml b/doc/common/tables/cinder-backups_ceph.xml index 4bdb90c252..d14e458627 100644 --- a/doc/common/tables/cinder-backups_ceph.xml +++ b/doc/common/tables/cinder-backups_ceph.xml @@ -39,6 +39,10 @@ backup_ceph_user=cinder (StrOpt) the Ceph user to connect with + + 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_swift.xml b/doc/common/tables/cinder-backups_swift.xml index c443007a83..246e34d43c 100644 --- a/doc/common/tables/cinder-backups_swift.xml +++ b/doc/common/tables/cinder-backups_swift.xml @@ -15,10 +15,6 @@ - - backup_compression_algorithm=zlib - (StrOpt) Compression algorithm (None to disable) - backup_swift_auth=per_user (StrOpt) Swift authentication mechanism diff --git a/doc/common/tables/cinder-block-device.xml b/doc/common/tables/cinder-block-device.xml new file mode 100644 index 0000000000..b43a965540 --- /dev/null +++ b/doc/common/tables/cinder-block-device.xml @@ -0,0 +1,24 @@ + + + + + + + + + + + + + + + + + + + +
Description of configuration options for block-device
Configuration option=Default valueDescription
available_devices=(ListOpt) List of all available devices
+ \ No newline at end of file diff --git a/doc/common/tables/cinder-common.xml b/doc/common/tables/cinder-common.xml index 3ebbc64199..b1e96981d4 100644 --- a/doc/common/tables/cinder-common.xml +++ b/doc/common/tables/cinder-common.xml @@ -60,7 +60,7 @@ (BoolOpt) make exception message format errors fatal - host=autodoc + host=docwork (StrOpt) Name of this node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address. @@ -68,7 +68,7 @@ (StrOpt) Host to locate redis - host=autodoc + host=docwork (StrOpt) Name of this node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address. @@ -85,7 +85,7 @@ lio_initiator_iqns= - (StrOpt) Comma-separatd list of initiator IQNs allowed to connect to the iSCSI target. (From Nova compute nodes.) + (StrOpt) Comma-separated list of initiator IQNs allowed to connect to the iSCSI target. (From Nova compute nodes.) lock_path=None @@ -136,45 +136,17 @@ (ListOpt) List of modules/decorators to monkey patch - my_ip=192.168.122.175 + my_ip=115.146.84.189 (StrOpt) ip address of this host no_snapshot_gb_quota=False (BoolOpt) Whether snapshots count against GigaByte quota - - 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) @@ -187,38 +159,14 @@ policy_file=policy.json (StrOpt) JSON file representing policy - - pool_size=None - (StrOpt) Size of thin provisioning pool (None uses entire cinder VG) - port=6379 (IntOpt) Use this port to connect to redis host. - pybasedir=/usr/lib/python2.7/site-packages + pybasedir=/home/ubuntu/cinder (StrOpt) Directory where the cinder python module is installed - - quota_driver=cinder.quota.DbQuotaDriver - (StrOpt) default driver to use for quota checks - - - quota_gigabytes=1000 - (IntOpt) number of volume gigabytes (snapshots are also included) allowed per project - - - quota_snapshots=10 - (IntOpt) number of volume snapshots allowed per project - - - quota_volumes=10 - (IntOpt) number of volumes allowed per project - - - reservation_expire=86400 - (IntOpt) number of seconds until a reservation expires - reserved_percentage=0 (IntOpt) The percentage of backend capacity is reserved @@ -251,18 +199,6 @@ sqlite_synchronous=True (BoolOpt) If true, use synchronous mode for sqlite - - ssh_conn_timeout=30 - (IntOpt) SSH connection timeout in seconds - - - ssh_max_pool_conn=5 - (IntOpt) Maximum ssh connections in the pool - - - ssh_min_pool_conn=1 - (IntOpt) Minimum ssh connections in the pool - ssl_ca_file=None (StrOpt) CA certificate file to use to verify connecting clients @@ -299,10 +235,6 @@ until_refresh=0 (IntOpt) count of reservations until usage is refreshed - - use_default_quota_class=True - (BoolOpt) whether to use default quota class for default quota - use_forwarded_for=False (BoolOpt) Treat X-Forwarded-For as the canonical remote address. Only enable this if you have a sanitizing proxy. diff --git a/doc/common/tables/cinder-compute.xml b/doc/common/tables/cinder-compute.xml new file mode 100644 index 0000000000..e126e152d6 --- /dev/null +++ b/doc/common/tables/cinder-compute.xml @@ -0,0 +1,48 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of configuration options for compute
Configuration option=Default valueDescription
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
os_region_name=None(StrOpt) region name of this node
+ \ No newline at end of file diff --git a/doc/common/tables/cinder-coraid.xml b/doc/common/tables/cinder-coraid.xml new file mode 100644 index 0000000000..53a7e3428e --- /dev/null +++ b/doc/common/tables/cinder-coraid.xml @@ -0,0 +1,36 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of configuration options for coraid
Configuration option=Default valueDescription
coraid_group=admin(StrOpt) Name of group on Coraid ESM to which coraid_user belongs (must have admin privilege)
coraid_password=password(StrOpt) Password to connect to Coraid ESM
coraid_repository_key=coraid_repository(StrOpt) Volume Type key name to store ESM Repository Name
coraid_user=admin(StrOpt) User name to connect to Coraid ESM
+ \ No newline at end of file diff --git a/doc/common/tables/cinder-eqlx.xml b/doc/common/tables/cinder-eqlx.xml new file mode 100644 index 0000000000..38be725fd2 --- /dev/null +++ b/doc/common/tables/cinder-eqlx.xml @@ -0,0 +1,48 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of configuration options for eqlx
Configuration option=Default valueDescription
eqlx_chap_login=admin(StrOpt) Existing CHAP account name
eqlx_chap_password=password(StrOpt) Password for specified CHAP account name
eqlx_cli_max_retries=5(IntOpt) Maximum retry count for reconnection
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?
+ \ No newline at end of file diff --git a/doc/common/tables/cinder-gpfs_volume.xml b/doc/common/tables/cinder-gpfs_volume.xml deleted file mode 100644 index a00f26af0e..0000000000 --- a/doc/common/tables/cinder-gpfs_volume.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
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-hds.xml b/doc/common/tables/cinder-hds.xml new file mode 100644 index 0000000000..ba68ebb1fe --- /dev/null +++ b/doc/common/tables/cinder-hds.xml @@ -0,0 +1,24 @@ + + + + + + + + + + + + + + + + + + + +
Description of configuration options for hds
Configuration option=Default valueDescription
hds_cinder_config_file=/opt/hds/hus/cinder_hus_conf.xml(StrOpt) configuration file for HDS cinder plugin for HUS
+ \ No newline at end of file diff --git a/doc/common/tables/cinder-huawei.xml b/doc/common/tables/cinder-huawei.xml new file mode 100644 index 0000000000..e3c860e894 --- /dev/null +++ b/doc/common/tables/cinder-huawei.xml @@ -0,0 +1,24 @@ + + + + + + + + + + + + + + + + + + + +
Description of configuration options for huawei
Configuration option=Default valueDescription
cinder_huawei_conf_file=/etc/cinder/cinder_huawei_conf.xml(StrOpt) config data for cinder huawei plugin
+ \ No newline at end of file diff --git a/doc/common/tables/cinder-backup.xml b/doc/common/tables/cinder-keymgr.xml similarity index 63% rename from doc/common/tables/cinder-backup.xml rename to doc/common/tables/cinder-keymgr.xml index ab0e3d1007..b7271060b9 100644 --- a/doc/common/tables/cinder-backup.xml +++ b/doc/common/tables/cinder-keymgr.xml @@ -5,7 +5,7 @@ repository --> - + @@ -16,12 +16,12 @@ - - + + - - + +
Description of configuration options for backupDescription of configuration options for keymgr
snapshot_name_template=snapshot-%s(StrOpt) Template string to be used to generate snapshot namesapi_class=cinder.keymgr.conf_key_mgr.ConfKeyManager(StrOpt) The full class name of the key manager API class
snapshot_same_host=True(BoolOpt) Create volume from snapshot at the host where snapshot residesfixed_key=None(StrOpt) Fixed key returned by key manager, specified in hex
diff --git a/doc/common/tables/cinder-lvm.xml b/doc/common/tables/cinder-lvm.xml new file mode 100644 index 0000000000..c9cb6e1eb8 --- /dev/null +++ b/doc/common/tables/cinder-lvm.xml @@ -0,0 +1,36 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of configuration options for lvm
Configuration option=Default valueDescription
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)
pool_size=None(StrOpt) Size of thin provisioning pool (None uses entire cinder VG)
volume_group=cinder-volumes(StrOpt) Name for the VG that will contain exported volumes
+ \ No newline at end of file diff --git a/doc/common/tables/cinder-netapp.xml b/doc/common/tables/cinder-netapp.xml new file mode 100644 index 0000000000..d1f6ed435a --- /dev/null +++ b/doc/common/tables/cinder-netapp.xml @@ -0,0 +1,76 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of configuration options for netapp
Configuration option=Default valueDescription
expiry_thres_minutes=720(IntOpt) Threshold minutes after which cache file can be cleaned.
netapp_login=None(StrOpt) User name for the storage controller
netapp_password=None(StrOpt) Password for the storage controller
netapp_server_hostname=None(StrOpt) Host name for the storage controller
netapp_server_port=80(IntOpt) Port number for the storage controller
netapp_size_multiplier=1.2(FloatOpt) Volume size multiplier to ensure while creation
netapp_storage_family=ontap_cluster(StrOpt) Storage family type.
netapp_storage_protocol=None(StrOpt) Storage protocol type.
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=None(StrOpt) Cluster vserver to use for provisioning
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.
+ \ No newline at end of file diff --git a/doc/common/tables/cinder-nfs.xml b/doc/common/tables/cinder-nfs.xml new file mode 100644 index 0000000000..b60184b56a --- /dev/null +++ b/doc/common/tables/cinder-nfs.xml @@ -0,0 +1,44 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of configuration options for 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-quota.xml b/doc/common/tables/cinder-quota.xml new file mode 100644 index 0000000000..8497110574 --- /dev/null +++ b/doc/common/tables/cinder-quota.xml @@ -0,0 +1,48 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of configuration options for quota
Configuration option=Default valueDescription
max_age=0(IntOpt) number of seconds between subsequent usage refreshes
quota_driver=cinder.quota.DbQuotaDriver(StrOpt) default driver to use for quota checks
quota_gigabytes=1000(IntOpt) number of volume gigabytes (snapshots are also included) allowed per project
quota_snapshots=10(IntOpt) number of volume snapshots allowed per project
quota_volumes=10(IntOpt) number of volumes allowed per project
reservation_expire=86400(IntOpt) number of seconds until a reservation expires
use_default_quota_class=True(BoolOpt) whether to use default quota class for default quota
+ \ No newline at end of file diff --git a/doc/common/tables/cinder-rpc.xml b/doc/common/tables/cinder-rpc.xml index 03ea425a37..fbb6c2d27a 100644 --- a/doc/common/tables/cinder-rpc.xml +++ b/doc/common/tables/cinder-rpc.xml @@ -16,7 +16,7 @@ - allowed_rpc_exception_modules=cinder.openstack.common.exception,nova.exception,cinder.exception,exceptions + allowed_rpc_exception_modules=nova.exception,cinder.exception,exceptions (ListOpt) Modules of exceptions that are permitted to be recreatedupon receiving exception data from an rpc call. @@ -151,14 +151,14 @@ rabbit_retry_interval=1 (IntOpt) how frequently to retry connecting with RabbitMQ - - rabbit_use_ssl=False - (BoolOpt) connect over SSL for RabbitMQ - rabbit_userid=guest (StrOpt) the RabbitMQ userid + + rabbit_use_ssl=False + (BoolOpt) connect over SSL for RabbitMQ + rabbit_virtual_host=/ (StrOpt) the RabbitMQ virtual host @@ -192,7 +192,7 @@ (IntOpt) Number of ZeroMQ contexts, defaults to 1 - rpc_zmq_host=autodoc + rpc_zmq_host=docwork (StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova. @@ -211,6 +211,10 @@ rpc_zmq_topic_backlog=None (IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. + + volume_topic=cinder-volume + (StrOpt) the topic volume nodes listen on + \ No newline at end of file diff --git a/doc/common/tables/cinder-san-solaris.xml b/doc/common/tables/cinder-san-solaris.xml new file mode 100644 index 0000000000..b2c6ce037a --- /dev/null +++ b/doc/common/tables/cinder-san-solaris.xml @@ -0,0 +1,24 @@ + + + + + + + + + + + + + + + + + + + +
Description of configuration options for san-solaris
Configuration option=Default valueDescription
san_zfs_volume_base=rpool/(StrOpt) The ZFS path under which to create zvols for volumes.
+ \ No newline at end of file diff --git a/doc/common/tables/cinder-san.xml b/doc/common/tables/cinder-san.xml new file mode 100644 index 0000000000..53947ef4e1 --- /dev/null +++ b/doc/common/tables/cinder-san.xml @@ -0,0 +1,64 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of configuration options for san
Configuration option=Default valueDescription
san_clustername=(StrOpt) Cluster name to use for creating volumes
san_ip=(StrOpt) IP address of SAN controller
san_is_local=False(BoolOpt) Execute commands locally instead of over SSH; use if the volume service is running on the SAN device
san_login=admin(StrOpt) Username for SAN controller
san_password=(StrOpt) Password for SAN controller
san_private_key=(StrOpt) Filename of private key to use for SSH authentication
san_ssh_port=22(IntOpt) SSH port to use with SAN
san_thin_provision=True(BoolOpt) Use thin provisioning for SAN volumes?
ssh_conn_timeout=30(IntOpt) SSH connection timeout in seconds
ssh_max_pool_conn=5(IntOpt) Maximum ssh connections in the pool
ssh_min_pool_conn=1(IntOpt) Minimum ssh connections in the pool
+ \ No newline at end of file diff --git a/doc/common/tables/cinder-scality.xml b/doc/common/tables/cinder-scality.xml new file mode 100644 index 0000000000..0cdf5adfd3 --- /dev/null +++ b/doc/common/tables/cinder-scality.xml @@ -0,0 +1,32 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of configuration options for scality
Configuration option=Default valueDescription
scality_sofs_config=None(StrOpt) Path or URL to Scality SOFS configuration file
scality_sofs_mount_point=$state_path/scality(StrOpt) Base dir where Scality SOFS shall be mounted
scality_sofs_volume_dir=cinder/volumes(StrOpt) Path from Scality SOFS root to volume dir
+ \ No newline at end of file diff --git a/doc/common/tables/cinder-solidfire.xml b/doc/common/tables/cinder-solidfire.xml new file mode 100644 index 0000000000..52c6cf8c3a --- /dev/null +++ b/doc/common/tables/cinder-solidfire.xml @@ -0,0 +1,36 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of configuration options for solidfire
Configuration option=Default valueDescription
sf_account_prefix=docwork(StrOpt) Create SolidFire accounts with this prefix
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;
+ \ No newline at end of file diff --git a/doc/common/tables/cinder-storage.xml b/doc/common/tables/cinder-storage.xml index 1d35dbbd6a..07cbb7a4f3 100644 --- a/doc/common/tables/cinder-storage.xml +++ b/doc/common/tables/cinder-storage.xml @@ -15,10 +15,6 @@ - - available_devices= - (ListOpt) List of all available devices - backend=sqlalchemy (StrOpt) The backend to use for db @@ -31,110 +27,14 @@ capacity_weight_multiplier=1.0 (FloatOpt) Multiplier used for weighing volume capacity. Negative numbers mean to stack vs spread. - - cinder_huawei_conf_file=/etc/cinder/cinder_huawei_conf.xml - (StrOpt) config data for cinder huawei plugin - coraid_esm_address= (StrOpt) IP address of Coraid ESM - - coraid_group=admin - (StrOpt) Name of group on Coraid ESM to which coraid_user belongs (must have admin privilege) - - - coraid_password=password - (StrOpt) Password to connect to Coraid ESM - - - coraid_repository_key=coraid_repository - (StrOpt) Volume Type key name to store ESM Repository Name - - - coraid_user=admin - (StrOpt) User name to connect to Coraid ESM - enabled_backends=None (ListOpt) A list of backend names to use. These backend names should be backed by a unique [CONFIG] group with its options - - eqlx_chap_login=admin - (StrOpt) Existing CHAP account name - - - eqlx_chap_password=password - (StrOpt) Password for specified CHAP account name - - - eqlx_cli_max_retries=5 - (IntOpt) Maximum retry count for reconnection - - - 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 @@ -179,22 +79,6 @@ 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 - max_gigabytes=10000 (IntOpt) maximum number of volume gigabytes to allow per host @@ -223,182 +107,26 @@ min_pool_size=1 (IntOpt) Minimum number of SQL connections to keep open in a pool - - netapp_password=None - (StrOpt) Password for the storage controller - - - netapp_server_hostname=None - (StrOpt) Host name for the storage controller - - - netapp_server_port=80 - (IntOpt) Port number for the storage controller - - - netapp_size_multiplier=1.2 - (FloatOpt) Volume size multiplier to ensure while creation - - - netapp_storage_family=ontap_cluster - (StrOpt) Storage family type. - - - netapp_storage_protocol=None - (StrOpt) Storage protocol type. - - - netapp_transport_type=http - (StrOpt) Transport type protocol - - - netapp_volume_list=None - (StrOpt) Comma separated volumes to be used for provisioning - - - netapp_vserver=None - (StrOpt) Cluster vserver to use for provisioning - num_iser_scan_tries=3 (IntOpt) The maximum number of times to rescan iSER targetto find volume num_volume_device_scan_tries=3 - (IntOpt) The maximum number of times to rescan targetsto find volume - - - san_clustername= - (StrOpt) Cluster name to use for creating volumes - - - san_ip= - (StrOpt) IP address of SAN controller - - - san_is_local=False - (BoolOpt) Execute commands locally instead of over SSH; use if the volume service is running on the SAN device - - - san_login=admin - (StrOpt) Username for SAN controller - - - san_password= - (StrOpt) Password for SAN controller - - - san_private_key= - (StrOpt) Filename of private key to use for SSH authentication - - - san_ssh_port=22 - (IntOpt) SSH port to use with SAN - - - san_thin_provision=True - (BoolOpt) Use thin provisioning for SAN volumes? - - - san_zfs_volume_base=rpool/ - (StrOpt) The ZFS path under which to create zvols for volumes. - - - scality_sofs_config=None - (StrOpt) Path or URL to Scality SOFS configuration file - - - scality_sofs_mount_point=$state_path/scality - (StrOpt) Base dir where Scality SOFS shall be mounted - - - scality_sofs_volume_dir=cinder/volumes - (StrOpt) Path from Scality SOFS root to volume dir - - - sf_account_prefix=autodoc - (StrOpt) Create SolidFire accounts with this prefix - - - 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; - - - storwize_svc_connection_protocol=iSCSI - (StrOpt) Connection protocol (iSCSI/FC) - - - storwize_svc_flashcopy_timeout=120 - (IntOpt) Maximum number of seconds to wait for FlashCopy to be prepared. Maximum value is 600 seconds (10 minutes) - - - storwize_svc_multihostmap_enabled=True - (BoolOpt) Allows vdisk to multi host mapping - - - storwize_svc_multipath_enabled=False - (BoolOpt) Connect with multipath (FC only; iSCSI multipath is controlled by Nova) - - - storwize_svc_vol_autoexpand=True - (BoolOpt) Storage system autoexpand parameter for volumes (True/False) - - - storwize_svc_vol_compression=False - (BoolOpt) Storage system compression option for volumes - - - storwize_svc_vol_easytier=True - (BoolOpt) Enable Easy Tier for volumes - - - 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) - - - storwize_svc_vol_warning=0 - (IntOpt) Storage system threshold for volume capacity warnings (percentage) - - - 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. + (IntOpt) The maximum number of times to rescan targets to find volume volume_backend_name=None (StrOpt) The backend name for a given driver implementation - - volume_clear=zero - (StrOpt) Method used to wipe old voumes (valid options are: none, zero, shred) - volume_clear_size=0 (IntOpt) Size in MiB to wipe at start of old volumes. 0 => all + + volume_clear=zero + (StrOpt) Method used to wipe old voumes (valid options are: none, zero, shred) + volume_dd_blocksize=1M (StrOpt) The default block size used when copying/clearing volumes @@ -407,102 +135,22 @@ volume_driver=cinder.volume.drivers.lvm.LVMISCSIDriver (StrOpt) Driver to use for volume creation - - volume_group=cinder-volumes - (StrOpt) Name for the VG that will contain exported volumes - volume_manager=cinder.volume.manager.VolumeManager (StrOpt) full class name for the Manager for volume - - volume_name_template=volume-%s - (StrOpt) Template string to be used to generate volume names - - - volume_topic=cinder-volume - (StrOpt) the topic volume nodes listen on - - - volume_transfer_key_length=16 - (IntOpt) The number of characters in the autogenerated auth key. - - - volume_transfer_salt_length=8 - (IntOpt) The number of characters in the salt. - - - volume_usage_audit_period=month - (StrOpt) time period to generate volume usages for. Time period must be hour, day, month or year - volumes_dir=$state_path/volumes (StrOpt) Volume configuration file storage directory - windows_iscsi_lun_path=C:\iSCSIVirtualDisks - (StrOpt) Path to store VHD backed volumes - - - xiv_ds8k_connection_type=iscsi - (StrOpt) Connection type to the IBM Storage Array (fibre_channel|iscsi) - - - xiv_ds8k_proxy=xiv_ds8k_openstack.nova_proxy.XIVDS8KNovaProxy - (StrOpt) Proxy driver that connects to the IBM Storage Array + volume_usage_audit_period=month + (StrOpt) time period to generate volume usages for. Time period must be hour, day, month or year zadara_default_stripesize=64 (StrOpt) Default stripe size for volumes - - zadara_default_striping_mode=simple - (StrOpt) Default striping mode for volumes - - - zadara_password=None - (StrOpt) Password for the VPSA - - - 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 - - - zadara_vpsa_auto_detach_on_delete=True - (BoolOpt) Automatically detach from servers on volume delete - - - zadara_vpsa_ip=None - (StrOpt) Management IP of Zadara VPSA - - - zadara_vpsa_poolname=None - (StrOpt) Name of VPSA storage pool for volumes - - - zadara_vpsa_port=None - (StrOpt) Zadara VPSA port number - - - zadara_vpsa_use_ssl=False - (BoolOpt) Use SSL connection - \ No newline at end of file diff --git a/doc/common/tables/cinder-storage_glusterfs.xml b/doc/common/tables/cinder-storage_glusterfs.xml index 1c5ef8ae9c..cb368b63c2 100644 --- a/doc/common/tables/cinder-storage_glusterfs.xml +++ b/doc/common/tables/cinder-storage_glusterfs.xml @@ -21,7 +21,7 @@ glusterfs_mount_point_base=$state_path/mnt - (StrOpt) Base dir containing mount points for gluster shares + (StrOpt) Base dir containing mount points for gluster shares. glusterfs_qcow2_volumes=False diff --git a/doc/common/tables/cinder-storage_gpfs.xml b/doc/common/tables/cinder-storage_gpfs.xml new file mode 100644 index 0000000000..a0fadfe331 --- /dev/null +++ b/doc/common/tables/cinder-storage_gpfs.xml @@ -0,0 +1,40 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of configuration options for storage_gpfs
Configuration option=Default valueDescription
gpfs_images_dir=None(StrOpt) Specifies the path of the Image service repository in GPFS. Leave undefined if not storing images in GPFS.
gpfs_images_share_mode=None(StrOpt) Specifies the type of image copy to be used. Set this when the Image service repository also uses GPFS so that image files can be transferred efficiently from the Image service to the Block Storage service. There are two valid values: "copy" specifies that a full copy of the image is made; "copy_on_write" specifies that copy-on-write optimization strategy is used and unmodified blocks of the image file are shared efficiently.
gpfs_max_clone_depth=0(IntOpt) Specifies an upper limit on the number of indirections required to reach a specific block due to snapshots or clones. A lengthy chain of copy-on-write snapshots or clones can have a negative impact on performance, but improves space utilization. 0 indicates unlimited clone depth.
gpfs_mount_point_base=None(StrOpt) Specifies the path of the GPFS directory where Block Storage volume and snapshot files are stored.
gpfs_sparse_volumes=True(BoolOpt) 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.
+ diff --git a/doc/common/tables/cinder-storage_nfs.xml b/doc/common/tables/cinder-storage_nfs.xml index bef1a4075f..58908a483e 100644 --- a/doc/common/tables/cinder-storage_nfs.xml +++ b/doc/common/tables/cinder-storage_nfs.xml @@ -17,11 +17,11 @@ nfs_mount_options=None - (StrOpt) Mount options passed to the nfs client. See section of the nfs man page for details + (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 + (StrOpt) Base dir containing mount points for nfs shares. nfs_oversub_ratio=1.0 diff --git a/doc/common/tables/cinder-storwize.xml b/doc/common/tables/cinder-storwize.xml new file mode 100644 index 0000000000..3dcd147291 --- /dev/null +++ b/doc/common/tables/cinder-storwize.xml @@ -0,0 +1,72 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of configuration options for storwize
Configuration option=Default valueDescription
storwize_svc_connection_protocol=iSCSI(StrOpt) Connection protocol (iSCSI/FC)
storwize_svc_flashcopy_timeout=120(IntOpt) Maximum number of seconds to wait for FlashCopy to be prepared. Maximum value is 600 seconds (10 minutes)
storwize_svc_iscsi_chap_enabled=True(BoolOpt) Configure CHAP authentication for iSCSI connections (Default: Enabled)
storwize_svc_multihostmap_enabled=True(BoolOpt) Allows vdisk to multi host mapping
storwize_svc_multipath_enabled=False(BoolOpt) Connect with multipath (FC only; iSCSI multipath is controlled by Nova)
storwize_svc_vol_autoexpand=True(BoolOpt) Storage system autoexpand parameter for volumes (True/False)
storwize_svc_vol_compression=False(BoolOpt) Storage system compression option for volumes
storwize_svc_vol_easytier=True(BoolOpt) Enable Easy Tier for volumes
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_volpool_name=volpool(StrOpt) Storage system storage pool for volumes
storwize_svc_vol_rsize=2(IntOpt) Storage system space-efficiency parameter for volumes (percentage)
storwize_svc_vol_warning=0(IntOpt) Storage system threshold for volume capacity warnings (percentage)
+ \ No newline at end of file diff --git a/doc/common/tables/cinder-windows.xml b/doc/common/tables/cinder-windows.xml new file mode 100644 index 0000000000..ce0814a6b6 --- /dev/null +++ b/doc/common/tables/cinder-windows.xml @@ -0,0 +1,24 @@ + + + + + + + + + + + + + + + + + + + +
Description of configuration options for windows
Configuration option=Default valueDescription
windows_iscsi_lun_path=C:\iSCSIVirtualDisks(StrOpt) Path to store VHD backed volumes
+ \ No newline at end of file diff --git a/doc/common/tables/cinder-xiv.xml b/doc/common/tables/cinder-xiv.xml new file mode 100644 index 0000000000..180edfdba0 --- /dev/null +++ b/doc/common/tables/cinder-xiv.xml @@ -0,0 +1,28 @@ + + + + + + + + + + + + + + + + + + + + + + + +
Description of configuration options for xiv
Configuration option=Default valueDescription
xiv_ds8k_connection_type=iscsi(StrOpt) Connection type to the IBM Storage Array (fibre_channel|iscsi)
xiv_ds8k_proxy=xiv_ds8k_openstack.nova_proxy.XIVDS8KNovaProxy(StrOpt) Proxy driver that connects to the IBM Storage Array
+ \ No newline at end of file diff --git a/doc/common/tables/cinder-zadara.xml b/doc/common/tables/cinder-zadara.xml new file mode 100644 index 0000000000..b85a01ba42 --- /dev/null +++ b/doc/common/tables/cinder-zadara.xml @@ -0,0 +1,68 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of configuration options for zadara
Configuration option=Default valueDescription
zadara_default_striping_mode=simple(StrOpt) Default striping mode for volumes
zadara_password=None(StrOpt) Password for the VPSA
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
zadara_vpsa_auto_detach_on_delete=True(BoolOpt) Automatically detach from servers on volume delete
zadara_vpsa_ip=None(StrOpt) Management IP of Zadara VPSA
zadara_vpsa_poolname=None(StrOpt) Name of VPSA storage pool for volumes
zadara_vpsa_port=None(StrOpt) Zadara VPSA port number
zadara_vpsa_use_ssl=False(BoolOpt) Use SSL connection
+ \ No newline at end of file diff --git a/doc/config-reference/block-storage/drivers/hds-volume-driver.xml b/doc/config-reference/block-storage/drivers/hds-volume-driver.xml index 48f33f589c..8e69dd1ac6 100644 --- a/doc/config-reference/block-storage/drivers/hds-volume-driver.xml +++ b/doc/config-reference/block-storage/drivers/hds-volume-driver.xml @@ -76,6 +76,7 @@ okay to run manage multiple HUS arrays using multiple cinder instances (or servers) + Single Backend diff --git a/doc/config-reference/block-storage/drivers/huawei-storage-driver.xml b/doc/config-reference/block-storage/drivers/huawei-storage-driver.xml index 4e5c1ca451..caddacbb0c 100644 --- a/doc/config-reference/block-storage/drivers/huawei-storage-driver.xml +++ b/doc/config-reference/block-storage/drivers/huawei-storage-driver.xml @@ -152,6 +152,7 @@ volume_driver = cinder.volume.drivers.huawei.huawei_iscsi.HuaweiISCSIDriver cinder_huawei_conf_file = /etc/cinder/cinder_huawei_conf.xml + Configuration File Details diff --git a/doc/config-reference/block-storage/drivers/ibm-gpfs-volume-driver.xml b/doc/config-reference/block-storage/drivers/ibm-gpfs-volume-driver.xml index 9ef7e361cd..54f79c6fe8 100644 --- a/doc/config-reference/block-storage/drivers/ibm-gpfs-volume-driver.xml +++ b/doc/config-reference/block-storage/drivers/ibm-gpfs-volume-driver.xml @@ -48,7 +48,7 @@ The following table contains the configuration options supported by the GPFS driver. + href="../../../common/tables/cinder-storage_gpfs.xml"/> The gpfs_images_share_mode flag is only valid if the Image service is configured to diff --git a/doc/config-reference/block-storage/drivers/ibm-storwize-svc-driver.xml b/doc/config-reference/block-storage/drivers/ibm-storwize-svc-driver.xml index efa9d4dae7..8028bb1a54 100644 --- a/doc/config-reference/block-storage/drivers/ibm-storwize-svc-driver.xml +++ b/doc/config-reference/block-storage/drivers/ibm-storwize-svc-driver.xml @@ -487,6 +487,7 @@ + Placement with volume types diff --git a/doc/config-reference/block-storage/drivers/solidfire-volume-driver.xml b/doc/config-reference/block-storage/drivers/solidfire-volume-driver.xml index abf9547621..b6a917312c 100644 --- a/doc/config-reference/block-storage/drivers/solidfire-volume-driver.xml +++ b/doc/config-reference/block-storage/drivers/solidfire-volume-driver.xml @@ -18,4 +18,5 @@ san_login=sfadmin # your cluster admin login san_password=sfpassword # your cluster admin password + diff --git a/doc/config-reference/block-storage/drivers/windows-volume-driver.xml b/doc/config-reference/block-storage/drivers/windows-volume-driver.xml new file mode 100644 index 0000000000..53a1ac1955 --- /dev/null +++ b/doc/config-reference/block-storage/drivers/windows-volume-driver.xml @@ -0,0 +1,14 @@ +
+Windows + There is a volume backend for Windows. Set the following in your + cinder.conf, and use the options below to configure it. + + + volume_driver=cinder.volume.drivers.windows.WindowsDriver + + +
diff --git a/doc/config-reference/block-storage/drivers/zadara-volume-driver.xml b/doc/config-reference/block-storage/drivers/zadara-volume-driver.xml new file mode 100644 index 0000000000..0381f50708 --- /dev/null +++ b/doc/config-reference/block-storage/drivers/zadara-volume-driver.xml @@ -0,0 +1,14 @@ +
+Zadara + There is a volume backend for Zadara. Set the following in your + cinder.conf, and use the options below to configure it. + + + volume_driver=cinder.volume.drivers.zadara.ZadaraVPSAISCSIDriver + + +
diff --git a/doc/config-reference/block-storage/section_volume-drivers.xml b/doc/config-reference/block-storage/section_volume-drivers.xml index e636e57450..e6ca8090f0 100644 --- a/doc/config-reference/block-storage/section_volume-drivers.xml +++ b/doc/config-reference/block-storage/section_volume-drivers.xml @@ -27,6 +27,8 @@ iscsi_helper=tgtadm + + diff --git a/doc/config-reference/ch_blockstorageconfigure.xml b/doc/config-reference/ch_blockstorageconfigure.xml index cdf212d2ed..34c167917c 100644 --- a/doc/config-reference/ch_blockstorageconfigure.xml +++ b/doc/config-reference/ch_blockstorageconfigure.xml @@ -8,7 +8,6 @@ xmlns:ns3="http://www.w3.org/1998/Math/MathML" xmlns:ns="http://docbook.org/ns/docbook"> OpenStack Block Storage - The Block Storage project works with many different storage drivers. You can configure those following the instructions. diff --git a/tools/autogenerate-config-docs/flagmappings/cinder.flagmappings b/tools/autogenerate-config-docs/flagmappings/cinder.flagmappings index aad08eb098..9bf2dffc5e 100644 --- a/tools/autogenerate-config-docs/flagmappings/cinder.flagmappings +++ b/tools/autogenerate-config-docs/flagmappings/cinder.flagmappings @@ -3,10 +3,11 @@ allowed_rpc_exception_modules rpc amqp_auto_delete rpc amqp_durable_queues rpc amqp_rpc_single_reply_queue rpc +api_class keymgr api_paste_config api api_rate_limit api auth_strategy auth -available_devices storage +available_devices block-device backdoor_port api backend storage backlog log @@ -17,7 +18,7 @@ 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_compression_algorithm backups backup_driver backups backup_manager backups backup_name_template backups @@ -35,7 +36,7 @@ backup_tsm_password backups_tsm backup_tsm_volume_prefix backups_tsm bindir storage capacity_weight_multiplier storage -cinder_huawei_conf_file storage +cinder_huawei_conf_file huawei cloned_volume_same_az zones compute_api_class common connection connection @@ -44,10 +45,10 @@ connection_trace connection connection_type connection control_exchange rpc coraid_esm_address storage -coraid_group storage -coraid_password storage -coraid_repository_key storage -coraid_user storage +coraid_group coraid +coraid_password coraid +coraid_repository_key coraid +coraid_user coraid db_backend database db_driver database debug common @@ -57,21 +58,22 @@ default_notification_level common default_publisher_id common default_volume_type common disable_process_locking common +enabled_backends storage 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 +eqlx_chap_login eqlx +eqlx_chap_password eqlx +eqlx_cli_max_retries eqlx +eqlx_cli_timeout eqlx +eqlx_group_name eqlx +eqlx_pool eqlx +eqlx_use_chap eqlx +expiry_thres_minutes netapp fake_rabbit rpc fatal_deprecations common fatal_exception_format_errors common +fixed_key keymgr glance_api_insecure images glance_api_servers images glance_api_ssl_compression images @@ -85,24 +87,24 @@ 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 +gpfs_images_dir storage_gpfs +gpfs_images_share_mode storage_gpfs +gpfs_max_clone_depth storage_gpfs +gpfs_mount_point_base storage_gpfs +gpfs_sparse_volumes storage_gpfs +hds_cinder_config_file hds 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 +hp3par_api_url hp3par +hp3par_cpg hp3par +hp3par_cpg_snap hp3par +hp3par_debug hp3par +hp3par_domain hp3par +hp3par_iscsi_ips hp3par +hp3par_password hp3par +hp3par_snapshot_expiration hp3par +hp3par_snapshot_retention hp3par +hp3par_username hp3par idle_timeout common iet_conf common image_conversion_dir images @@ -114,12 +116,11 @@ iscsi_ip_address storage iscsi_num_targets storage iscsi_port storage iscsi_target_prefix storage -iser_helper storage +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 kombu_ssl_certfile rpc kombu_ssl_keyfile rpc @@ -135,12 +136,12 @@ logging_context_format_string common logging_debug_format_suffix common logging_default_format_string common logging_exception_prefix common -lvm_mirrors storage -lvm_type storage +lvm_mirrors lvm +lvm_type lvm matchmaker_heartbeat_freq rpc matchmaker_heartbeat_ttl rpc matchmaker_ringfile rpc -max_age storage +max_age quota max_gigabytes storage max_overflow storage max_pool_size storage @@ -151,35 +152,35 @@ min_pool_size storage monkey_patch common monkey_patch_modules common my_ip common -netapp_login storage_netapp -netapp_password storage -netapp_server_hostname storage -netapp_server_port storage -netapp_size_multiplier storage -netapp_storage_family storage -netapp_storage_protocol storage -netapp_transport_type storage -netapp_vfiler storage_netapp -netapp_volume_list storage -netapp_vserver 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 +netapp_login netapp +netapp_password netapp +netapp_server_hostname netapp +netapp_server_port netapp +netapp_size_multiplier netapp +netapp_storage_family netapp +netapp_storage_protocol netapp +netapp_transport_type netapp +netapp_vfiler netapp +netapp_volume_list netapp +netapp_vserver netapp +nexenta_blocksize nexenta_iscsi +nexenta_host nexenta_iscsi +nexenta_iscsi_target_portal_port nexenta_iscsi +nexenta_mount_options nexenta_nfs +nexenta_mount_point_base nexenta_nfs +nexenta_oversub_ratio nexenta_nfs +nexenta_password nexenta_iscsi +nexenta_rest_port nexenta_iscsi +nexenta_rest_protocol nexenta_iscsi +nexenta_shares_config nexenta_nfs +nexenta_sparsed_volumes nexenta_iscsi +nexenta_sparse nexenta_iscsi +nexenta_target_group_prefix nexenta_iscsi +nexenta_target_prefix nexenta_iscsi +nexenta_used_ratio nexenta_nfs +nexenta_user nexenta_iscsi +nexenta_volume_compression nexenta_nfs +nexenta_volume nexenta_iscsi nfs_mount_options storage_nfs nfs_mount_point_base storage_nfs nfs_oversub_ratio storage_nfs @@ -189,25 +190,25 @@ nfs_used_ratio storage_nfs no_snapshot_gb_quota common notification_driver rpc notification_topics rpc -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 +nova_api_insecure compute +nova_ca_certificates_file compute +nova_catalog_admin_info compute +nova_catalog_info compute +nova_endpoint_admin_template compute +nova_endpoint_template compute 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 -osapi_volume_ext_list api osapi_volume_extension api +osapi_volume_ext_list api +os_region_name compute password common policy_default_rule common policy_file common -pool_size common +pool_size lvm port common publish_errors rpc pybasedir common @@ -221,10 +222,10 @@ 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 +quota_driver quota +quota_gigabytes quota +quota_snapshots quota +quota_volumes quota rabbit_ha_queues rpc rabbit_host rpc rabbit_hosts rpc @@ -233,8 +234,8 @@ rabbit_password rpc rabbit_port rpc rabbit_retry_backoff rpc rabbit_retry_interval rpc -rabbit_use_ssl rpc rabbit_userid rpc +rabbit_use_ssl rpc rabbit_virtual_host rpc rbd_ceph_conf storage_ceph rbd_flatten_volume_from_snapshot storage_ceph @@ -242,9 +243,9 @@ rbd_max_clone_depth storage_ceph rbd_pool storage_ceph rbd_secret_uuid storage_ceph rbd_user storage_ceph -reservation_expire common +reservation_expire quota reserved_percentage common -restore_discard_excess_bytes backups +restore_discard_excess_bytes backups_ceph retry_interval common root_helper common rootwrap_config common @@ -261,18 +262,18 @@ rpc_zmq_matchmaker rpc rpc_zmq_port rpc rpc_zmq_topic_backlog rpc run_external_periodic_tasks common -san_clustername storage -san_ip storage -san_is_local storage -san_login storage -san_password storage -san_private_key storage -san_ssh_port storage -san_thin_provision storage -san_zfs_volume_base storage -scality_sofs_config storage -scality_sofs_mount_point storage -scality_sofs_volume_dir storage +san_clustername san +san_ip san +san_is_local san +san_login san +san_password san +san_private_key san +san_ssh_port san +san_thin_provision san +san_zfs_volume_base san-solaris +scality_sofs_config scality +scality_sofs_mount_point scality +scality_sofs_volume_dir scality scheduler_default_filters scheduler scheduler_default_weighers scheduler scheduler_driver scheduler @@ -282,42 +283,43 @@ scheduler_manager scheduler scheduler_max_attempts scheduler 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 +sf_account_prefix solidfire +sf_allow_tenant_qos solidfire +sf_api_port solidfire +sf_emulate_512 solidfire +snapshot_name_template backups +snapshot_same_host backups sqlite_db common sqlite_synchronous common -ssh_conn_timeout common -ssh_max_pool_conn common -ssh_min_pool_conn common +ssh_conn_timeout san +ssh_max_pool_conn san +ssh_min_pool_conn san ssl_ca_file common ssl_cert_file common ssl_key_file common state_path common storage_availability_zone common -storwize_svc_connection_protocol storage -storwize_svc_flashcopy_timeout storage -storwize_svc_multihostmap_enabled storage -storwize_svc_multipath_enabled storage -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 +storwize_svc_connection_protocol storwize +storwize_svc_flashcopy_timeout storwize +storwize_svc_iscsi_chap_enabled storwize +storwize_svc_multihostmap_enabled storwize +storwize_svc_multipath_enabled storwize +storwize_svc_vol_autoexpand storwize +storwize_svc_vol_compression storwize +storwize_svc_vol_easytier storwize +storwize_svc_vol_grainsize storwize +storwize_svc_vol_iogrp storwize +storwize_svc_volpool_name storwize +storwize_svc_vol_rsize storwize +storwize_svc_vol_warning storwize syslog_log_facility common tcp_keepidle common -thres_avl_size_perc_start storage -thres_avl_size_perc_stop storage +thres_avl_size_perc_start netapp +thres_avl_size_perc_stop netapp topics common transfer_api_class api until_refresh common -use_default_quota_class common +use_default_quota_class quota use_forwarded_for common use_multipath_for_image_xfer images use_stderr common @@ -326,38 +328,38 @@ use_tpool common verbose common volume_api_class api volume_backend_name storage -volume_clear storage volume_clear_size storage +volume_clear storage volume_dd_blocksize storage volume_driver storage -volume_group storage +volume_group lvm volume_manager storage -volume_name_template storage -volume_tmp_dir storage_ceph -volume_topic storage -volume_transfer_key_length storage -volume_transfer_salt_length storage -volume_usage_audit_period storage +volume_name_template api volumes_dir storage -windows_iscsi_lun_path storage +volume_tmp_dir storage_ceph +volume_topic rpc +volume_transfer_key_length api +volume_transfer_salt_length api +volume_usage_audit_period storage +windows_iscsi_lun_path windows xenapi_connection_password storage_xen xenapi_connection_url storage_xen xenapi_connection_username storage_xen xenapi_nfs_server storage_xen xenapi_nfs_serverpath storage_xen xenapi_sr_base_path storage_xen -xiv_ds8k_connection_type storage -xiv_ds8k_proxy storage +xiv_ds8k_connection_type xiv +xiv_ds8k_proxy xiv 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 -zadara_vpsa_poolname storage -zadara_vpsa_port storage -zadara_vpsa_use_ssl storage +zadara_default_striping_mode zadara +zadara_password zadara +zadara_user zadara +zadara_vol_encrypt zadara +zadara_vol_name_template zadara +zadara_vol_thin zadara +zadara_vpsa_allow_nonexistent_delete zadara +zadara_vpsa_auto_detach_on_delete zadara +zadara_vpsa_ip zadara +zadara_vpsa_poolname zadara +zadara_vpsa_port zadara +zadara_vpsa_use_ssl zadara