From 464277220ddb800ac69562649fde62e5ca9358c4 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Sat, 18 Jan 2014 16:45:45 +0100 Subject: [PATCH] Improve consistency of help strings Fixes include rework of text, missing or extra spaces, wrong capitalization and no sentence style capitalization. Co-Authored-By: Diane Fleming Change-Id: Iddab947ce9597f4a1de885f1f6c0fb0e5ba9dc46 --- cinder/api/common.py | 4 +- cinder/common/config.py | 58 +++--- cinder/compute/nova.py | 7 +- cinder/db/base.py | 2 +- cinder/quota.py | 19 +- cinder/service.py | 13 +- cinder/volume/driver.py | 14 +- cinder/volume/drivers/emc/emc_smis_common.py | 4 +- cinder/volume/drivers/hds/hds.py | 3 +- cinder/volume/drivers/huawei/__init__.py | 3 +- cinder/volume/drivers/nexenta/options.py | 17 +- cinder/volume/drivers/rbd.py | 23 +-- etc/cinder/cinder.conf.sample | 176 +++++++++---------- 13 files changed, 173 insertions(+), 170 deletions(-) diff --git a/cinder/api/common.py b/cinder/api/common.py index 736599f6778..2ee3324b9bb 100644 --- a/cinder/api/common.py +++ b/cinder/api/common.py @@ -30,8 +30,8 @@ from cinder import utils api_common_opts = [ cfg.IntOpt('osapi_max_limit', default=1000, - help='the maximum number of items returned in a single ' - 'response from a collection resource'), + help='The maximum number of items that a collection ' + 'resource returns in a single response'), cfg.StrOpt('osapi_volume_base_URL', default=None, help='Base URL that will be presented to users in links ' diff --git a/cinder/common/config.py b/cinder/common/config.py index 969f8c3c1de..09e2d36db5f 100644 --- a/cinder/common/config.py +++ b/cinder/common/config.py @@ -72,20 +72,20 @@ CONF.register_cli_opts(debug_opts) global_opts = [ cfg.StrOpt('my_ip', default=_get_my_ip(), - help='ip address of this host'), + help='IP address of this host'), cfg.StrOpt('glance_host', default='$my_ip', - help='default glance hostname or ip'), + help='Default glance host name or IP'), cfg.IntOpt('glance_port', default=9292, - help='default glance port'), + help='Default glance port'), cfg.ListOpt('glance_api_servers', default=['$glance_host:$glance_port'], - help='A list of the glance api servers available to cinder ' + help='A list of the glance API servers available to cinder ' '([hostname|ip]:port)'), cfg.IntOpt('glance_api_version', default=1, - help='Version of the glance api to use'), + help='Version of the glance API to use'), cfg.IntOpt('glance_num_retries', default=0, help='Number retries when downloading an image from glance'), @@ -95,12 +95,11 @@ global_opts = [ 'glance'), cfg.BoolOpt('glance_api_ssl_compression', default=False, - help='Whether to attempt to negotiate SSL layer compression ' - 'when using SSL (https) requests. Set to False to ' - 'disable SSL layer compression. In some cases disabling ' - 'this may improve data throughput, eg when high network ' - 'bandwidth is available and you are using already ' - 'compressed image formats such as qcow2 .'), + help='Enables or disables negotiation of SSL layer ' + 'compression. In some cases disabling compression ' + 'can improve data throughput, such as when high ' + 'network bandwidth is available and you use ' + 'compressed image formats like qcow2.'), cfg.IntOpt('glance_request_timeout', default=None, help='http/https timeout value for glance operations. If no ' @@ -108,13 +107,13 @@ global_opts = [ 'value is used.'), cfg.StrOpt('scheduler_topic', default='cinder-scheduler', - help='the topic scheduler nodes listen on'), + help='The topic that scheduler nodes listen on'), cfg.StrOpt('volume_topic', default='cinder-volume', - help='the topic volume nodes listen on'), + help='The topic that volume nodes listen on'), cfg.StrOpt('backup_topic', default='cinder-backup', - help='the topic volume backup nodes listen on'), + help='The topic that volume backup nodes listen on'), cfg.BoolOpt('enable_v1_api', default=True, help=_("Deploy v1 of the Cinder API.")), @@ -123,7 +122,7 @@ global_opts = [ help=_("Deploy v2 of the Cinder API.")), cfg.BoolOpt('api_rate_limit', default=True, - help='whether to rate limit the api'), + help='Enables or disables rate limit of the API.'), cfg.ListOpt('osapi_volume_ext_list', default=[], help='Specify list of extensions to load when using osapi_' @@ -134,34 +133,32 @@ global_opts = [ help='osapi volume extension to load'), cfg.StrOpt('volume_manager', default='cinder.volume.manager.VolumeManager', - help='full class name for the Manager for volume'), + help='Full class name for the Manager for volume'), cfg.StrOpt('backup_manager', default='cinder.backup.manager.BackupManager', - help='full class name for the Manager for volume backup'), + help='Full class name for the Manager for volume backup'), cfg.StrOpt('scheduler_manager', default='cinder.scheduler.manager.SchedulerManager', - help='full class name for the Manager for scheduler'), + help='Full class name for the Manager for scheduler'), cfg.StrOpt('host', default=socket.gethostname(), - help='Name of this node. This can be an opaque identifier. ' - 'It is not necessarily a hostname, FQDN, or IP address.'), + help='Name of this node. This can be an opaque identifier. ' + 'It is not necessarily a host name, FQDN, or IP address.'), # NOTE(vish): default to nova for compatibility with nova installs cfg.StrOpt('storage_availability_zone', default='nova', - help='availability zone of this node'), + help='Availability zone of this node'), cfg.StrOpt('default_availability_zone', default=None, - help='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.'), + help='Default availability zone for new volumes. If not set, ' + 'the storage_availability_zone option value is used as ' + 'the default for new volumes.'), cfg.StrOpt('default_volume_type', default=None, - help='default volume type to use'), + help='Default volume type to use'), cfg.StrOpt('volume_usage_audit_period', - default='month', - help='time period to generate volume usages for. ' - 'Time period must be hour, day, month or year'), + help='Time period for which to generate volume usages. ' + 'The options are hour, day, month, or year.'), cfg.StrOpt('rootwrap_config', default='/etc/cinder/rootwrap.conf', help='Path to the rootwrap configuration file to use for ' @@ -174,7 +171,8 @@ global_opts = [ help='List of modules/decorators to monkey patch'), cfg.IntOpt('service_down_time', default=60, - help='maximum time since last check-in for up service'), + help='Maximum time since last check-in for a service to be ' + 'considered up'), cfg.StrOpt('volume_api_class', default='cinder.volume.api.API', help='The full class name of the volume API class to use'), diff --git a/cinder/compute/nova.py b/cinder/compute/nova.py index 647edda432f..6a285419762 100644 --- a/cinder/compute/nova.py +++ b/cinder/compute/nova.py @@ -28,8 +28,9 @@ from cinder.openstack.common import log as logging nova_opts = [ cfg.StrOpt('nova_catalog_info', default='compute:nova:publicURL', - help='Info to match when looking for nova in the service ' - 'catalog. Format is : separated values of the form: ' + help='Match this value when searching for nova in the ' + 'service catalog. Format is: separated values of ' + 'the form: ' '::'), cfg.StrOpt('nova_catalog_admin_info', default='compute:nova:adminURL', @@ -43,7 +44,7 @@ nova_opts = [ help='Same as nova_endpoint_template, but for admin endpoint.'), cfg.StrOpt('os_region_name', default=None, - help='region name of this node'), + help='Region name of this node'), cfg.StrOpt('nova_ca_certificates_file', default=None, help='Location of ca certificates file to use for nova client ' diff --git a/cinder/db/base.py b/cinder/db/base.py index 21a862f564a..76fbc99aff2 100644 --- a/cinder/db/base.py +++ b/cinder/db/base.py @@ -24,7 +24,7 @@ from cinder.openstack.common import importutils db_driver_opt = cfg.StrOpt('db_driver', default='cinder.db', - help='driver to use for database access') + help='Driver to use for database access') CONF = cfg.CONF CONF.register_opt(db_driver_opt) diff --git a/cinder/quota.py b/cinder/quota.py index 6e48ea41042..bf96117938d 100644 --- a/cinder/quota.py +++ b/cinder/quota.py @@ -34,29 +34,30 @@ LOG = logging.getLogger(__name__) quota_opts = [ cfg.IntOpt('quota_volumes', default=10, - help='number of volumes allowed per project'), + help='Number of volumes allowed per project'), cfg.IntOpt('quota_snapshots', default=10, - help='number of volume snapshots allowed per project'), + help='Number of volume snapshots allowed per project'), cfg.IntOpt('quota_gigabytes', default=1000, - help='number of volume gigabytes (snapshots are also included) ' - 'allowed per project'), + help='Total amount of storage, in gigabytes, allowed ' + 'for volumes and snapshots per project'), cfg.IntOpt('reservation_expire', default=86400, - help='number of seconds until a reservation expires'), + help='Number of seconds until a reservation expires'), cfg.IntOpt('until_refresh', default=0, - help='count of reservations until usage is refreshed'), + help='Count of reservations until usage is refreshed'), cfg.IntOpt('max_age', default=0, - help='number of seconds between subsequent usage refreshes'), + help='Number of seconds between subsequent usage refreshes'), cfg.StrOpt('quota_driver', default='cinder.quota.DbQuotaDriver', - help='default driver to use for quota checks'), + help='Default driver to use for quota checks'), cfg.BoolOpt('use_default_quota_class', default=True, - help='whether to use default quota class for default quota'), ] + help='Enables or disables use of default quota class ' + 'with default quota.'), ] CONF = cfg.CONF CONF.register_opts(quota_opts) diff --git a/cinder/service.py b/cinder/service.py index 7d0d5717123..7f5a959122a 100755 --- a/cinder/service.py +++ b/cinder/service.py @@ -42,23 +42,22 @@ LOG = logging.getLogger(__name__) service_opts = [ cfg.IntOpt('report_interval', default=10, - help='seconds between nodes reporting state to datastore'), + help='Interval, in seconds, between nodes reporting state ' + 'to datastore'), cfg.IntOpt('periodic_interval', default=60, - help='seconds between running periodic tasks'), + help='Interval, in seconds, between running periodic tasks'), cfg.IntOpt('periodic_fuzzy_delay', default=60, - help='range of seconds to randomly delay when starting the' + help='Range, in seconds, to randomly delay when starting the' ' periodic task scheduler to reduce stampeding.' ' (Disable by setting to 0)'), cfg.StrOpt('osapi_volume_listen', default="0.0.0.0", - help='IP address for OpenStack Volume API to listen'), + help='IP address on which OpenStack Volume API listens'), cfg.IntOpt('osapi_volume_listen_port', default=8776, - help='port for os volume api to listen'), - cfg.IntOpt('osapi_volume_workers', - help='Number of workers for OpenStack Volume API service'), ] + help='Port on which OpenStack Volume API listens'), ] CONF = cfg.CONF CONF.register_opts(service_opts) diff --git a/cinder/volume/driver.py b/cinder/volume/driver.py index 58d4195b161..526a32c8814 100644 --- a/cinder/volume/driver.py +++ b/cinder/volume/driver.py @@ -38,16 +38,16 @@ LOG = logging.getLogger(__name__) volume_opts = [ cfg.IntOpt('num_shell_tries', default=3, - help='number of times to attempt to run flakey shell commands'), + help='Number of times to attempt to run flakey shell commands'), cfg.IntOpt('reserved_percentage', default=0, help='The percentage of backend capacity is reserved'), cfg.IntOpt('iscsi_num_targets', default=100, - help='The maximum number of iscsi target ids per host'), + help='The maximum number of iSCSI target IDs per host'), cfg.StrOpt('iscsi_target_prefix', default='iqn.2010-10.org.openstack:', - help='prefix for iscsi volumes'), + help='Prefix for iSCSI volumes'), cfg.StrOpt('iscsi_ip_address', default='$my_ip', help='The IP address that the iSCSI daemon is listening on'), @@ -80,7 +80,7 @@ volume_opts = [ 'for example "-c3" for idle only priority.'), cfg.StrOpt('iscsi_helper', default='tgtadm', - help='iscsi target user-land tool to use'), + help='iSCSI target user-land tool to use'), cfg.StrOpt('volumes_dir', default='$state_path/volumes', help='Volume configuration file storage ' @@ -113,10 +113,10 @@ iser_opts = [ 'to find volume'), cfg.IntOpt('iser_num_targets', default=100, - help='The maximum number of iser target ids per host'), + help='The maximum number of iSER target IDs per host'), cfg.StrOpt('iser_target_prefix', default='iqn.2010-10.org.iser.openstack:', - help='prefix for iser volumes'), + help='Prefix for iSER volumes'), cfg.StrOpt('iser_ip_address', default='$my_ip', help='The IP address that the iSER daemon is listening on'), @@ -125,7 +125,7 @@ iser_opts = [ help='The port that the iSER daemon is listening on'), cfg.StrOpt('iser_helper', default='tgtadm', - help='iser target user-land tool to use'), + help='The name of the iSER target user-land tool to use'), ] diff --git a/cinder/volume/drivers/emc/emc_smis_common.py b/cinder/volume/drivers/emc/emc_smis_common.py index 736d068dc2b..85ebf6023b4 100644 --- a/cinder/volume/drivers/emc/emc_smis_common.py +++ b/cinder/volume/drivers/emc/emc_smis_common.py @@ -48,8 +48,8 @@ POOL = 'storagetype:pool' emc_opts = [ cfg.StrOpt('cinder_emc_config_file', default=CINDER_EMC_CONFIG_FILE, - help='use this file for cinder emc plugin ' - 'config data'), ] + help='The configuration file for the Cinder ' + 'EMC driver'), ] CONF.register_opts(emc_opts) diff --git a/cinder/volume/drivers/hds/hds.py b/cinder/volume/drivers/hds/hds.py index 1e0f4f9accf..c7093ba2a40 100644 --- a/cinder/volume/drivers/hds/hds.py +++ b/cinder/volume/drivers/hds/hds.py @@ -36,7 +36,8 @@ LOG = logging.getLogger(__name__) HUS_OPTS = [ cfg.StrOpt('hds_cinder_config_file', default='/opt/hds/hus/cinder_hus_conf.xml', - help='configuration file for HDS cinder plugin for HUS'), ] + help='The configuration file for the Cinder HDS driver ' + 'for HUS'), ] CONF = cfg.CONF CONF.register_opts(HUS_OPTS) diff --git a/cinder/volume/drivers/huawei/__init__.py b/cinder/volume/drivers/huawei/__init__.py index f6ce6c10107..5f263b77865 100644 --- a/cinder/volume/drivers/huawei/__init__.py +++ b/cinder/volume/drivers/huawei/__init__.py @@ -33,7 +33,8 @@ LOG = logging.getLogger(__name__) huawei_opt = [ cfg.StrOpt('cinder_huawei_conf_file', default='/etc/cinder/cinder_huawei_conf.xml', - help='config data for cinder huawei plugin')] + help='The configuration file for the Cinder Huawei ' + 'driver')] CONF = cfg.CONF CONF.register_opts(huawei_opt) diff --git a/cinder/volume/drivers/nexenta/options.py b/cinder/volume/drivers/nexenta/options.py index ee872a2e37b..7b61e63134a 100644 --- a/cinder/volume/drivers/nexenta/options.py +++ b/cinder/volume/drivers/nexenta/options.py @@ -49,13 +49,13 @@ NEXENTA_ISCSI_OPTIONS = [ help='Nexenta target portal port'), cfg.StrOpt('nexenta_volume', default='cinder', - help='pool on SA that will hold all volumes'), + help='SA Pool that holds all volumes'), cfg.StrOpt('nexenta_target_prefix', default='iqn.1986-03.com.sun:02:cinder-', help='IQN prefix for iSCSI targets'), cfg.StrOpt('nexenta_target_group_prefix', default='cinder/', - help='prefix for iSCSI target groups on SA'), + help='Prefix for iSCSI target groups on SA'), ] NEXENTA_NFS_OPTIONS = [ @@ -64,12 +64,13 @@ NEXENTA_NFS_OPTIONS = [ help='File with the list of available nfs shares'), cfg.StrOpt('nexenta_mount_point_base', default='$state_path/mnt', - help='Base dir containing mount points for nfs shares'), + help='Base directory that contains NFS share mount points'), cfg.BoolOpt('nexenta_sparsed_volumes', default=True, - help=('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.')), + help='Enables or disables the creation of volumes as ' + 'sparsed files that take no space. If disabled ' + '(False), volume is created as a regular file, ' + 'which takes a long time.'), cfg.StrOpt('nexenta_volume_compression', default='on', help='Default compression value for new ZFS folders.'), @@ -82,10 +83,10 @@ NEXENTA_NFS_OPTIONS = [ NEXENTA_VOLUME_OPTIONS = [ cfg.StrOpt('nexenta_blocksize', default='', - help='block size for volumes (blank=default,8KB)'), + help='Block size for volumes (default=blank means 8KB)'), cfg.BoolOpt('nexenta_sparse', default=False, - help='flag to create sparse volumes'), + help='Enables or disables the creation of sparse volumes'), ] NEXENTA_RRMGR_OPTIONS = [ diff --git a/cinder/volume/drivers/rbd.py b/cinder/volume/drivers/rbd.py index 1a2b9f999b3..ee7ddce9511 100644 --- a/cinder/volume/drivers/rbd.py +++ b/cinder/volume/drivers/rbd.py @@ -43,31 +43,32 @@ LOG = logging.getLogger(__name__) rbd_opts = [ cfg.StrOpt('rbd_pool', default='rbd', - help='the RADOS pool in which rbd volumes are stored'), + help='The RADOS pool where rbd volumes are stored'), cfg.StrOpt('rbd_user', default=None, - help='the RADOS client name for accessing rbd volumes ' + help='The RADOS client name for accessing rbd volumes ' '- only set when using cephx authentication'), cfg.StrOpt('rbd_ceph_conf', default='', # default determined by librados - help='path to the ceph configuration file to use'), + help='Path to the ceph configuration file'), cfg.BoolOpt('rbd_flatten_volume_from_snapshot', default=False, - help='flatten volumes created from snapshots to remove ' - 'dependency'), + help='Flatten volumes created from snapshots to remove ' + 'dependency from volume to snapshot'), cfg.StrOpt('rbd_secret_uuid', default=None, - help='the libvirt uuid of the secret for the rbd_user' + help='The libvirt uuid of the secret for the rbd_user ' 'volumes'), cfg.StrOpt('volume_tmp_dir', default=None, - help='where to store temporary image files if the volume ' - 'driver does not write them directly to the volume'), + help='Directory where temporary image files are stored ' + 'when the volume driver does not write them directly ' + 'to the volume.'), cfg.IntOpt('rbd_max_clone_depth', default=5, - help='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')] + help='Maximum number of nested volume clones that are ' + 'taken before a flatten occurs. Set to 0 to disable ' + 'cloning.')] CONF = cfg.CONF CONF.register_opts(rbd_opts) diff --git a/etc/cinder/cinder.conf.sample b/etc/cinder/cinder.conf.sample index d0f4eb55cc5..4827fcb2499 100644 --- a/etc/cinder/cinder.conf.sample +++ b/etc/cinder/cinder.conf.sample @@ -217,34 +217,34 @@ # Options defined in cinder.quota # -# number of volumes allowed per project (integer value) +# Number of volumes allowed per project (integer value) #quota_volumes=10 -# number of volume snapshots allowed per project (integer +# Number of volume snapshots allowed per project (integer # value) #quota_snapshots=10 -# number of volume gigabytes (snapshots are also included) -# allowed per project (integer value) +# Total amount of storage, in gigabytes, allowed for volumes +# and snapshots per project (integer value) #quota_gigabytes=1000 -# number of seconds until a reservation expires (integer +# Number of seconds until a reservation expires (integer # value) #reservation_expire=86400 -# count of reservations until usage is refreshed (integer +# Count of reservations until usage is refreshed (integer # value) #until_refresh=0 -# number of seconds between subsequent usage refreshes +# Number of seconds between subsequent usage refreshes # (integer value) #max_age=0 -# default driver to use for quota checks (string value) +# Default driver to use for quota checks (string value) #quota_driver=cinder.quota.DbQuotaDriver -# whether to use default quota class for default quota -# (boolean value) +# Enables or disables use of default quota class with default +# quota. (boolean value) #use_default_quota_class=true @@ -252,28 +252,26 @@ # Options defined in cinder.service # -# seconds between nodes reporting state to datastore (integer -# value) +# Interval, in seconds, between nodes reporting state to +# datastore (integer value) #report_interval=10 -# seconds between running periodic tasks (integer value) +# Interval, in seconds, between running periodic tasks +# (integer value) #periodic_interval=60 -# range of seconds to randomly delay when starting the +# Range, in seconds, to randomly delay when starting the # periodic task scheduler to reduce stampeding. (Disable by # setting to 0) (integer value) #periodic_fuzzy_delay=60 -# IP address for OpenStack Volume API to listen (string value) +# IP address on which OpenStack Volume API listens (string +# value) #osapi_volume_listen=0.0.0.0 -# port for os volume api to listen (integer value) +# Port on which OpenStack Volume API listens (integer value) #osapi_volume_listen_port=8776 -# Number of workers for OpenStack Volume API service (integer -# value) -#osapi_volume_workers= - # # Options defined in cinder.test @@ -314,8 +312,8 @@ # Options defined in cinder.api.common # -# the maximum number of items returned in a single response -# from a collection resource (integer value) +# The maximum number of items that a collection resource +# returns in a single response (integer value) #osapi_max_limit=1000 # Base URL that will be presented to users in links to the @@ -455,20 +453,20 @@ # Deprecated group/name - [DEFAULT]/pybasedir #state_path=/var/lib/cinder -# ip address of this host (string value) +# IP address of this host (string value) #my_ip=10.0.0.1 -# default glance hostname or ip (string value) +# Default glance host name or IP (string value) #glance_host=$my_ip -# default glance port (integer value) +# Default glance port (integer value) #glance_port=9292 -# A list of the glance api servers available to cinder +# A list of the glance API servers available to cinder # ([hostname|ip]:port) (list value) #glance_api_servers=$glance_host:$glance_port -# Version of the glance api to use (integer value) +# Version of the glance API to use (integer value) #glance_api_version=1 # Number retries when downloading an image from glance @@ -479,12 +477,11 @@ # (boolean value) #glance_api_insecure=false -# Whether to attempt to negotiate SSL layer compression when -# using SSL (https) requests. Set to False to disable SSL -# layer compression. In some cases disabling this may improve -# data throughput, eg when high network bandwidth is available -# and you are using already compressed image formats such as -# qcow2 . (boolean value) +# Enables or disables negotiation of SSL layer compression. In +# some cases disabling compression can improve data +# throughput, such as when high network bandwidth is available +# and you use compressed image formats like qcow2. (boolean +# value) #glance_api_ssl_compression=false # http/https timeout value for glance operations. If no value @@ -492,13 +489,13 @@ # used. (integer value) #glance_request_timeout= -# the topic scheduler nodes listen on (string value) +# The topic that scheduler nodes listen on (string value) #scheduler_topic=cinder-scheduler -# the topic volume nodes listen on (string value) +# The topic that volume nodes listen on (string value) #volume_topic=cinder-volume -# the topic volume backup nodes listen on (string value) +# The topic that volume backup nodes listen on (string value) #backup_topic=cinder-backup # Deploy v1 of the Cinder API. (boolean value) @@ -507,7 +504,7 @@ # Deploy v2 of the Cinder API. (boolean value) #enable_v2_api=true -# whether to rate limit the api (boolean value) +# Enables or disables rate limit of the API. (boolean value) #api_rate_limit=true # Specify list of extensions to load when using @@ -518,36 +515,35 @@ # osapi volume extension to load (multi valued) #osapi_volume_extension=cinder.api.contrib.standard_extensions -# full class name for the Manager for volume (string value) +# Full class name for the Manager for volume (string value) #volume_manager=cinder.volume.manager.VolumeManager -# full class name for the Manager for volume backup (string +# Full class name for the Manager for volume backup (string # value) #backup_manager=cinder.backup.manager.BackupManager -# full class name for the Manager for scheduler (string value) +# Full class name for the Manager for scheduler (string value) #scheduler_manager=cinder.scheduler.manager.SchedulerManager -# Name of this node. This can be an opaque identifier. It is -# not necessarily a hostname, FQDN, or IP address. (string +# Name of this node. This can be an opaque identifier. It is +# not necessarily a host name, FQDN, or IP address. (string # value) #host=cinder -# availability zone of this node (string value) +# Availability zone of this node (string value) #storage_availability_zone=nova -# 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. (string value) +# Default availability zone for new volumes. If not set, the +# storage_availability_zone option value is used as the +# default for new volumes. (string value) #default_availability_zone= -# default volume type to use (string value) +# Default volume type to use (string value) #default_volume_type= -# time period to generate volume usages for. Time period must -# be hour, day, month or year (string value) -#volume_usage_audit_period=month +# Time period for which to generate volume usages. The options +# are hour, day, month, or year. (string value) +#volume_usage_audit_period= # Path to the rootwrap configuration file to use for running # commands as root (string value) @@ -559,8 +555,8 @@ # List of modules/decorators to monkey patch (list value) #monkey_patch_modules= -# maximum time since last check-in for up service (integer -# value) +# Maximum time since last check-in for a service to be +# considered up (integer value) #service_down_time=60 # The full class name of the volume API class to use (string @@ -602,8 +598,8 @@ # Options defined in cinder.compute.nova # -# Info to match when looking for nova in the service catalog. -# Format is : separated values of the form: +# Match this value when searching for nova in the service +# catalog. Format is: separated values of the form: # :: (string value) #nova_catalog_info=compute:nova:publicURL @@ -620,7 +616,7 @@ # (string value) #nova_endpoint_admin_template= -# region name of this node (string value) +# Region name of this node (string value) #os_region_name= # Location of ca certificates file to use for nova client @@ -660,7 +656,7 @@ # Options defined in cinder.db.base # -# driver to use for database access (string value) +# Driver to use for database access (string value) #db_driver=cinder.db @@ -922,11 +918,11 @@ # volume (integer value) #num_iser_scan_tries=3 -# The maximum number of iser target ids per host (integer +# The maximum number of iSER target IDs per host (integer # value) #iser_num_targets=100 -# prefix for iser volumes (string value) +# Prefix for iSER volumes (string value) #iser_target_prefix=iqn.2010-10.org.iser.openstack: # The IP address that the iSER daemon is listening on (string @@ -937,10 +933,11 @@ # value) #iser_port=3260 -# iser target user-land tool to use (string value) +# The name of the iSER target user-land tool to use (string +# value) #iser_helper=tgtadm -# number of times to attempt to run flakey shell commands +# Number of times to attempt to run flakey shell commands # (integer value) #num_shell_tries=3 @@ -948,11 +945,11 @@ # value) #reserved_percentage=0 -# The maximum number of iscsi target ids per host (integer +# The maximum number of iSCSI target IDs per host (integer # value) #iscsi_num_targets=100 -# prefix for iscsi volumes (string value) +# Prefix for iSCSI volumes (string value) #iscsi_target_prefix=iqn.2010-10.org.openstack: # The IP address that the iSCSI daemon is listening on (string @@ -990,7 +987,7 @@ # "-c3" for idle only priority. (string value) #volume_clear_ionice= -# iscsi target user-land tool to use (string value) +# iSCSI target user-land tool to use (string value) #iscsi_helper=tgtadm # Volume configuration file storage directory (string value) @@ -1047,7 +1044,7 @@ # Options defined in cinder.volume.drivers.emc.emc_smis_common # -# use this file for cinder emc plugin config data (string +# The configuration file for the Cinder EMC driver (string # value) #cinder_emc_config_file=/etc/cinder/cinder_emc_config.xml @@ -1124,8 +1121,8 @@ # Options defined in cinder.volume.drivers.hds.hds # -# configuration file for HDS cinder plugin for HUS (string -# value) +# The configuration file for the Cinder HDS driver for HUS +# (string value) #hds_cinder_config_file=/opt/hds/hus/cinder_hus_conf.xml @@ -1133,7 +1130,8 @@ # Options defined in cinder.volume.drivers.huawei # -# config data for cinder huawei plugin (string value) +# The configuration file for the Cinder Huawei driver (string +# value) #cinder_huawei_conf_file=/etc/cinder/cinder_huawei_conf.xml @@ -1419,25 +1417,25 @@ # Nexenta target portal port (integer value) #nexenta_iscsi_target_portal_port=3260 -# pool on SA that will hold all volumes (string value) +# SA Pool that holds all volumes (string value) #nexenta_volume=cinder # IQN prefix for iSCSI targets (string value) #nexenta_target_prefix=iqn.1986-03.com.sun:02:cinder- -# prefix for iSCSI target groups on SA (string value) +# Prefix for iSCSI target groups on SA (string value) #nexenta_target_group_prefix=cinder/ # File with the list of available nfs shares (string value) #nexenta_shares_config=/etc/cinder/nfs_shares -# Base dir containing mount points for nfs shares (string +# Base directory that contains NFS share mount points (string # value) #nexenta_mount_point_base=$state_path/mnt -# 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. (boolean value) +# Enables or disables the creation of volumes as sparsed files +# that take no space. If disabled (False), volume is created +# as a regular file, which takes a long time. (boolean value) #nexenta_sparsed_volumes=true # Default compression value for new ZFS folders. (string @@ -1458,10 +1456,12 @@ # Number of TCP connections. (integer value) #nexenta_rrmgr_connections=2 -# block size for volumes (blank=default,8KB) (string value) +# Block size for volumes (default=blank means 8KB) (string +# value) #nexenta_blocksize= -# flag to create sparse volumes (boolean value) +# Enables or disables the creation of sparse volumes (boolean +# value) #nexenta_sparse=false @@ -1516,32 +1516,32 @@ # Options defined in cinder.volume.drivers.rbd # -# the RADOS pool in which rbd volumes are stored (string -# value) +# The RADOS pool where rbd volumes are stored (string value) #rbd_pool=rbd -# the RADOS client name for accessing rbd volumes - only set +# The RADOS client name for accessing rbd volumes - only set # when using cephx authentication (string value) #rbd_user= -# path to the ceph configuration file to use (string value) +# Path to the ceph configuration file (string value) #rbd_ceph_conf= -# flatten volumes created from snapshots to remove dependency -# (boolean value) +# Flatten volumes created from snapshots to remove dependency +# from volume to snapshot (boolean value) #rbd_flatten_volume_from_snapshot=false -# the libvirt uuid of the secret for the rbd_uservolumes +# The libvirt uuid of the secret for the rbd_user volumes # (string value) #rbd_secret_uuid= -# where to store temporary image files if the volume driver -# does not write them directly to the volume (string value) +# Directory where temporary image files are stored when the +# volume driver does not write them directly to the volume. +# (string value) #volume_tmp_dir= -# 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 (integer value) +# Maximum number of nested volume clones that are taken before +# a flatten occurs. Set to 0 to disable cloning. (integer +# value) #rbd_max_clone_depth=5