openstack
/
cinder
Code Issues Proposed changes

Use config-table for dynamic config documentation 

A lot of our config option reference documentation was out of date, with
deprecated and removed options and changed defaults. This changes the
"Additional options" configuration reference to use the config-table
directive so the published docs stay in sync with changes in the code.

Closes-bug: #1814910

Change-Id: Ib891435dc69eb795ea6d4d0fb6626259e95cf27f
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
This commit is contained in:
Sean McGinnis 2019-02-06 15:26:54 -06:00
parent dff120cc22
commit c39182e01e
No known key found for this signature in database
GPG Key ID: CE7EE4BFAF8D70C8
25 changed files with 294 additions and 824 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
cinder/backup/api.py
View File

@ -44,14 +44,14 @@ from cinder import quota_utils
import cinder.volume
from cinder.volume import utils as volume_utils
backup_api_opts = [
backup_opts = [
cfg.BoolOpt('backup_use_same_host',
default=False,
help='Backup services use same backend.')
]
CONF = cfg.CONF
CONF.register_opts(backup_api_opts)
CONF.register_opts(backup_opts)
LOG = logging.getLogger(__name__)
QUOTAS = quota.QUOTAS
IMPORT_VOLUME_ID = '00000000-0000-0000-0000-000000000000'

4
cinder/backup/chunkeddriver.py
View File

@ -47,7 +47,7 @@ if sys.platform == 'win32':
LOG = logging.getLogger(__name__)
chunkedbackup_service_opts = [
backup_opts = [
cfg.StrOpt('backup_compression_algorithm',
default='zlib',
choices=['none', 'off', 'no',
@ -57,7 +57,7 @@ chunkedbackup_service_opts = [
]
CONF = cfg.CONF
CONF.register_opts(chunkedbackup_service_opts)
CONF.register_opts(backup_opts)
# Object writer and reader returned by inheriting classes must not have any

4
cinder/backup/driver.py
View File

@ -26,7 +26,7 @@ from cinder.db import base
from cinder import exception
from cinder.i18n import _
service_opts = [
backup_opts = [
cfg.IntOpt('backup_metadata_version', default=2,
help='Backup metadata version to be used when backing up '
'volume metadata. If this number is bumped, make sure the '
@ -42,7 +42,7 @@ service_opts = [
]
CONF = cfg.CONF
CONF.register_opts(service_opts)
CONF.register_opts(backup_opts)
LOG = logging.getLogger(__name__)

118
cinder/common/config.py
View File

@ -46,39 +46,7 @@ core_opts = [
CONF.register_cli_opts(core_opts)
global_opts = [
cfg.HostAddressOpt('my_ip',
sample_default='<HOST_IP_ADDRESS>',
default=netutils.get_my_ipv4(),
help='IP address of this host'),
cfg.ListOpt('glance_api_servers',
default=None,
help='A list of the URLs of glance API servers available to '
'cinder ([http[s]://][hostname|ip]:port). If protocol '
'is not specified it defaults to http.'),
cfg.IntOpt('glance_num_retries',
min=0,
default=0,
help='Number retries when downloading an image from glance'),
cfg.BoolOpt('glance_api_insecure',
default=False,
help='Allow to perform insecure SSL (https) requests to '
'glance (https will be used but cert validation will '
'not be performed).'),
cfg.BoolOpt('glance_api_ssl_compression',
default=False,
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.StrOpt('glance_ca_certificates_file',
help='Location of ca certificates file to use for glance '
'client requests.'),
cfg.IntOpt('glance_request_timeout',
help='http/https timeout value for glance operations. If no '
'value (None) is supplied here, the glanceclient default '
'value is used.'),
api_opts = [
cfg.BoolOpt('enable_v2_api',
default=True,
deprecated_for_removal=True,
@ -89,6 +57,9 @@ global_opts = [
cfg.BoolOpt('api_rate_limit',
default=True,
help='Enables or disables rate limit of the API.'),
cfg.StrOpt('group_api_class',
default='cinder.group.api.API',
help='The full class name of the group API class'),
cfg.ListOpt('osapi_volume_ext_list',
default=[],
help='Specify list of extensions to load when using osapi_'
@ -97,12 +68,19 @@ global_opts = [
cfg.MultiStrOpt('osapi_volume_extension',
default=['cinder.api.contrib.standard_extensions'],
help='osapi volume extension to load'),
cfg.StrOpt('volume_api_class',
default='cinder.volume.api.API',
help='The full class name of the volume API class to use'),
]
global_opts = [
cfg.HostAddressOpt('my_ip',
sample_default='<HOST_IP_ADDRESS>',
default=netutils.get_my_ipv4(),
help='IP address of this host'),
cfg.StrOpt('volume_manager',
default='cinder.volume.manager.VolumeManager',
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'),
cfg.StrOpt('scheduler_manager',
default='cinder.scheduler.manager.SchedulerManager',
help='Full class name for the Manager for scheduler'),
@ -150,18 +128,6 @@ global_opts = [
default=60,
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'),
cfg.StrOpt('backup_api_class',
default='cinder.backup.api.API',
help='The full class name of the volume backup API class'),
cfg.StrOpt('auth_strategy',
default='keystone',
choices=[('noauth', 'Do not perform authentication'),
('keystone', 'Authenticate using keystone')],
help='The strategy to use for auth. Supports noauth or '
'keystone.'),
cfg.ListOpt('enabled_backends',
help='A list of backend names to use. These backend names '
'should be backed by a unique [CONFIG] group '
@ -175,15 +141,65 @@ global_opts = [
cfg.StrOpt('consistencygroup_api_class',
default='cinder.consistencygroup.api.API',
help='The full class name of the consistencygroup API class'),
cfg.StrOpt('group_api_class',
default='cinder.group.api.API',
help='The full class name of the group API class'),
cfg.BoolOpt('split_loggers',
default=False,
help='Log requests to multiple loggers.')
]
auth_opts = [
cfg.StrOpt('auth_strategy',
default='keystone',
choices=[('noauth', 'Do not perform authentication'),
('keystone', 'Authenticate using keystone')],
help='The strategy to use for auth. Supports noauth or '
'keystone.'),
]
backup_opts = [
cfg.StrOpt('backup_api_class',
default='cinder.backup.api.API',
help='The full class name of the volume backup API class'),
cfg.StrOpt('backup_manager',
default='cinder.backup.manager.BackupManager',
help='Full class name for the Manager for volume backup'),
]
image_opts = [
cfg.ListOpt('glance_api_servers',
default=None,
help='A list of the URLs of glance API servers available to '
'cinder ([http[s]://][hostname|ip]:port). If protocol '
'is not specified it defaults to http.'),
cfg.IntOpt('glance_num_retries',
min=0,
default=0,
help='Number retries when downloading an image from glance'),
cfg.BoolOpt('glance_api_insecure',
default=False,
help='Allow to perform insecure SSL (https) requests to '
'glance (https will be used but cert validation will '
'not be performed).'),
cfg.BoolOpt('glance_api_ssl_compression',
default=False,
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.StrOpt('glance_ca_certificates_file',
help='Location of ca certificates file to use for glance '
'client requests.'),
cfg.IntOpt('glance_request_timeout',
help='http/https timeout value for glance operations. If no '
'value (None) is supplied here, the glanceclient default '
'value is used.'),
]
CONF.register_opts(api_opts)
CONF.register_opts(core_opts)
CONF.register_opts(auth_opts)
CONF.register_opts(backup_opts)
CONF.register_opts(image_opts)
CONF.register_opts(global_opts)

8
cinder/db/api.py
View File

@ -54,13 +54,17 @@ db_opts = [
cfg.StrOpt('snapshot_name_template',
default='snapshot-%s',
help='Template string to be used to generate snapshot names'),
]
backup_opts = [
cfg.StrOpt('backup_name_template',
default='backup-%s',
help='Template string to be used to generate backup names'), ]
help='Template string to be used to generate backup names'),
]
CONF = cfg.CONF
CONF.register_opts(db_opts)
CONF.register_opts(backup_opts)
db_options.set_defaults(CONF)
_BACKEND_MAPPING = {'sqlalchemy': 'cinder.db.sqlalchemy.api'}

4
cinder/image/glance.py
View File

@ -42,7 +42,7 @@ from cinder.i18n import _
from cinder import service_auth
glance_opts = [
image_opts = [
cfg.ListOpt('allowed_direct_url_schemes',
default=[],
help='A list of url schemes that can be downloaded directly '
@ -84,7 +84,7 @@ glance_core_properties_opts = [
help='Default core properties of image')
]
CONF = cfg.CONF
CONF.register_opts(glance_opts)
CONF.register_opts(image_opts)
CONF.register_opts(glance_core_properties_opts)
_SESSION = None

11
cinder/image/image_utils.py
View File

@ -53,13 +53,14 @@ from cinder.volume import utils as volume_utils
LOG = logging.getLogger(__name__)
image_helper_opts = [cfg.StrOpt('image_conversion_dir',
default='$state_path/conversion',
help='Directory used for temporary storage '
'during image conversion'), ]
image_opts = [
cfg.StrOpt('image_conversion_dir',
default='$state_path/conversion',
help='Directory used for temporary storage '
'during image conversion'), ]
CONF = cfg.CONF
CONF.register_opts(image_helper_opts)
CONF.register_opts(image_opts)
QEMU_IMG_LIMITS = processutils.ProcessLimits(
cpu_time=8,

20
cinder/opts.py
View File

@ -208,9 +208,9 @@ def list_opts():
cinder_api_common.api_common_opts,
[cinder_api_middleware_auth.use_forwarded_for_opt],
cinder_api_views_versions.versions_opts,
cinder_backup_api.backup_api_opts,
cinder_backup_chunkeddriver.chunkedbackup_service_opts,
cinder_backup_driver.service_opts,
cinder_backup_api.backup_opts,
cinder_backup_chunkeddriver.backup_opts,
cinder_backup_driver.backup_opts,
cinder_backup_drivers_ceph.service_opts,
cinder_backup_drivers_gcs.gcsbackup_service_opts,
cinder_backup_drivers_glusterfs.glusterfsbackup_service_opts,
@ -221,15 +221,20 @@ def list_opts():
cinder_backup_manager.backup_manager_opts,
[cinder_cmd_backup.backup_workers_opt],
[cinder_cmd_volume.cluster_opt],
cinder_common_config.api_opts,
cinder_common_config.core_opts,
cinder_common_config.auth_opts,
cinder_common_config.backup_opts,
cinder_common_config.image_opts,
cinder_common_config.global_opts,
cinder.compute.compute_opts,
cinder_context.context_opts,
cinder_db_api.db_opts,
cinder_db_api.backup_opts,
[cinder_db_base.db_driver_opt],
cinder_image_glance.glance_opts,
cinder_image_glance.image_opts,
cinder_image_glance.glance_core_properties_opts,
cinder_image_imageutils.image_helper_opts,
cinder_image_imageutils.image_opts,
cinder_message_api.messages_opts,
cinder_quota.quota_opts,
cinder_scheduler_driver.scheduler_driver_opts,
@ -250,6 +255,9 @@ def list_opts():
cinder_volume_driver.volume_opts,
cinder_volume_driver.iser_opts,
cinder_volume_driver.nvmet_opts,
cinder_volume_driver.scst_opts,
cinder_volume_driver.backup_opts,
cinder_volume_driver.image_opts,
cinder_volume_drivers_datacore_driver.datacore_opts,
cinder_volume_drivers_datacore_iscsi.datacore_iscsi_opts,
cinder_volume_drivers_fusionstorage_dsware.volume_opts,
@ -284,6 +292,8 @@ def list_opts():
cinder_volume_driver.volume_opts,
cinder_volume_driver.iser_opts,
cinder_volume_driver.nvmet_opts,
cinder_volume_driver.scst_opts,
cinder_volume_driver.image_opts,
cinder_volume_drivers_datera_dateraiscsi.d_opts,
cinder_volume_drivers_dell_emc_powermax_common.powermax_opts,
cinder_volume_drivers_dell_emc_ps.eqlx_opts,

109
cinder/volume/driver.py
View File

@ -66,15 +66,6 @@ volume_opts = [
' to find volume'),
cfg.StrOpt('volume_backend_name',
help='The backend name for a given driver implementation'),
cfg.BoolOpt('use_multipath_for_image_xfer',
default=False,
help='Do we attach/detach volumes in cinder using multipath '
'for volume to image and image to volume transfers?'),
cfg.BoolOpt('enforce_multipath_for_image_xfer',
default=False,
help='If this is set to True, attachment of volumes for '
'image transfer will be aborted when multipathd is not '
'running. Otherwise, it will fallback to single path.'),
cfg.StrOpt('volume_clear',
default='zero',
choices=['none', 'zero'],
@ -173,13 +164,6 @@ volume_opts = [
'automatically calculate the ratio based on the '
'provisioned capacity and the used space. If not set to '
'auto, the ratio has to be a minimum of 1.0.'),
cfg.StrOpt('scst_target_iqn_name',
help='Certain ISCSI targets have predefined target names, '
'SCST target driver uses this name.'),
cfg.StrOpt('scst_target_driver',
default='iscsi',
help='SCST target implementation can choose from multiple '
'SCST target drivers.'),
cfg.BoolOpt('use_chap_auth',
default=False,
help='Option to enable/disable CHAP authentication for '
@ -225,30 +209,6 @@ volume_opts = [
"standard dict config form: replication_device = "
"target_device_id:<required>,"
"key1:value1,key2:value2..."),
cfg.BoolOpt('image_upload_use_cinder_backend',
default=False,
help='If set to True, upload-to-image in raw format will '
'create a cloned volume and register its location to '
'the image service, instead of uploading the volume '
'content. The cinder backend and locations support '
'must be enabled in the image service.'),
cfg.BoolOpt('image_upload_use_internal_tenant',
default=False,
help='If set to True, the image volume created by '
'upload-to-image will be placed in the internal tenant. '
'Otherwise, the image volume is created in the current '
'context\'s tenant.'),
cfg.BoolOpt('image_volume_cache_enabled',
default=False,
help='Enable the image volume cache for this backend.'),
cfg.IntOpt('image_volume_cache_max_size_gb',
default=0,
help='Max size of the image volume cache for this backend in '
'GB. 0 => unlimited.'),
cfg.IntOpt('image_volume_cache_max_count',
default=0,
help='Max number of entries allowed in the image volume cache. '
'0 => unlimited.'),
cfg.BoolOpt('report_discard_supported',
default=False,
help='Report to clients of Cinder that the backend supports '
@ -261,12 +221,6 @@ volume_opts = [
choices=['iscsi', 'fc'],
help='Protocol for transferring data between host and '
'storage back-end.'),
cfg.BoolOpt('backup_use_temp_snapshot',
default=False,
help='If this is set to True, a temporary snapshot will '
'be created for performing non-disruptive backups. '
'Otherwise a temporary volume will be cloned '
'in order to perform a backup.'),
cfg.BoolOpt('enable_unsupported_driver',
default=False,
help="Set this to True when you want to allow an unsupported "
@ -311,14 +265,74 @@ nvmet_opts = [
'that will be created with the path for the LVM volume.'),
]
scst_opts = [
cfg.StrOpt('scst_target_iqn_name',
help='Certain ISCSI targets have predefined target names, '
'SCST target driver uses this name.'),
cfg.StrOpt('scst_target_driver',
default='iscsi',
help='SCST target implementation can choose from multiple '
'SCST target drivers.'),
]
backup_opts = [
cfg.BoolOpt('backup_use_temp_snapshot',
default=False,
help='If this is set to True, a temporary snapshot will '
'be created for performing non-disruptive backups. '
'Otherwise a temporary volume will be cloned '
'in order to perform a backup.'),
]
image_opts = [
cfg.BoolOpt('image_upload_use_cinder_backend',
default=False,
help='If set to True, upload-to-image in raw format will '
'create a cloned volume and register its location to '
'the image service, instead of uploading the volume '
'content. The cinder backend and locations support '
'must be enabled in the image service.'),
cfg.BoolOpt('image_upload_use_internal_tenant',
default=False,
help='If set to True, the image volume created by '
'upload-to-image will be placed in the internal tenant. '
'Otherwise, the image volume is created in the current '
'context\'s tenant.'),
cfg.BoolOpt('image_volume_cache_enabled',
default=False,
help='Enable the image volume cache for this backend.'),
cfg.IntOpt('image_volume_cache_max_size_gb',
default=0,
help='Max size of the image volume cache for this backend in '
'GB. 0 => unlimited.'),
cfg.IntOpt('image_volume_cache_max_count',
default=0,
help='Max number of entries allowed in the image volume cache. '
'0 => unlimited.'),
cfg.BoolOpt('use_multipath_for_image_xfer',
default=False,
help='Do we attach/detach volumes in cinder using multipath '
'for volume to image and image to volume transfers?'),
cfg.BoolOpt('enforce_multipath_for_image_xfer',
default=False,
help='If this is set to True, attachment of volumes for '
'image transfer will be aborted when multipathd is not '
'running. Otherwise, it will fallback to single path.'),
]
CONF = cfg.CONF
CONF.register_opts(volume_opts, group=configuration.SHARED_CONF_GROUP)
CONF.register_opts(iser_opts, group=configuration.SHARED_CONF_GROUP)
CONF.register_opts(nvmet_opts, group=configuration.SHARED_CONF_GROUP)
CONF.register_opts(scst_opts, group=configuration.SHARED_CONF_GROUP)
CONF.register_opts(image_opts, group=configuration.SHARED_CONF_GROUP)
CONF.register_opts(volume_opts)
CONF.register_opts(iser_opts)
CONF.register_opts(nvmet_opts)
CONF.register_opts(scst_opts)
CONF.register_opts(backup_opts)
CONF.register_opts(image_opts)
CONF.import_opt('backup_use_same_host', 'cinder.backup.api')
@ -377,6 +391,9 @@ class BaseVD(object):
self.configuration.append_config_values(volume_opts)
self.configuration.append_config_values(iser_opts)
self.configuration.append_config_values(nvmet_opts)
self.configuration.append_config_values(scst_opts)
self.configuration.append_config_values(backup_opts)
self.configuration.append_config_values(image_opts)
utils.setup_tracing(self.configuration.safe_get('trace_flags'))
# NOTE(geguileo): Don't allow to start if we are enabling

13
doc/ext/driver_opts.py
View File

@ -34,20 +34,24 @@ class ConfigTableDirective(rst.Directive):
'table-title': directives.unchanged,
'config-target': directives.unchanged,
'exclude-list': directives.unchanged,
'exclusive-list': directives.unchanged,
}
has_content = True
def _doc_module(self, module, filters):
def _doc_module(self, module, filters, exclusive):
"""Extract config options from module."""
options = []
try:
mod = importlib.import_module(module)
for prop in dir(mod):
# exclusive-list overrides others
if exclusive and prop not in exclusive:
continue
if prop in filters:
continue
thing = getattr(mod, prop)
if isinstance(thing, cfg.Opt):
if isinstance(thing, cfg.Opt) and thing not in options:
# An individual config option
options.append(thing)
elif (isinstance(thing, list) and len(thing) > 0 and
@ -94,6 +98,9 @@ class ConfigTableDirective(rst.Directive):
exclude = self.options.get('exclude-list', '')
exclude_list = [e.strip() for e in exclude.split(',') if e.strip()]
exclusive = self.options.get('exclusive-list', '')
exclusive_list = [e.strip() for e in exclusive.split(',') if e.strip()]
result.append('.. _{}:'.format(title.replace(' ', '-')), source)
result.append('', source)
result.append('.. list-table:: {}'.format(title), source)
@ -105,7 +112,7 @@ class ConfigTableDirective(rst.Directive):
options = []
for module in modules:
retval = self._doc_module(module, exclude_list)
retval = self._doc_module(module, exclude_list, exclusive_list)
if retval:
options.extend(retval)
else:

135
doc/source/configuration/block-storage/config-options.rst
View File

@ -4,19 +4,122 @@ Additional options
These options can also be set in the ``cinder.conf`` file.
.. include:: ../tables/cinder-api.inc
.. include:: ../tables/cinder-auth.inc
.. include:: ../tables/cinder-backups.inc
.. include:: ../tables/cinder-common.inc
.. include:: ../tables/cinder-compute.inc
.. include:: ../tables/cinder-coordination.inc
.. include:: ../tables/cinder-debug.inc
.. include:: ../tables/cinder-images.inc
.. include:: ../tables/cinder-nas.inc
.. include:: ../tables/cinder-profiler.inc
.. include:: ../tables/cinder-quota.inc
.. include:: ../tables/cinder-san.inc
.. include:: ../tables/cinder-scheduler.inc
.. include:: ../tables/cinder-scst.inc
.. include:: ../tables/cinder-storage.inc
.. include:: ../tables/cinder-zones.inc
.. config-table::
:config-target: API
:exclusive-list: api_opts,compute_opts,socket_opts
cinder.api.common
cinder.common.config
cinder.compute
cinder.service
cinder.wsgi.eventlet_server
.. config-table::
:config-target: [oslo_middleware]
oslo_middleware.http_proxy_to_wsgi
oslo_middleware.sizelimit
oslo_middleware.ssl
.. config-table::
:config-target: authorization
:exclusive-list: auth_opts
cinder.common.config
.. config-table::
:config-target: Volume Manager
cinder.volume.manager
.. config-table::
:config-target: Volume Scheduler
cinder.scheduler.manager
cinder.scheduler.host_manager
cinder.scheduler.driver
cinder.scheduler.weights.volume_number
cinder.scheduler.weights.capacity
.. config-table::
:config-target: backup
:exclusive-list: backup_opts,backup_manager_opts
cinder.common.config
cinder.backup.api
cinder.backup.chunkeddriver
cinder.backup.driver
cinder.backup.manager
cinder.db.api
.. config-table::
:config-target: [nova]
cinder.compute.nova
.. config-table::
:config-target: images
:exclusive-list: image_opts,glance_core_properties_opts
cinder.image.glance
cinder.image.image_utils
cinder.volume.driver
cinder.common.config
.. config-table::
:config-target: NAS
cinder.volume.drivers.remotefs
.. config-table::
:config-target: common driver
:exclusive-list: volume_opts
cinder.volume.driver
.. _cinder-storage:
.. config-table::
:config-target: common
:exclusive-list: global_opts
cinder.common.config
.. config-table::
:config-target: [profiler]
osprofiler.opts
.. config-table::
:config-target: quota
cinder.quota
.. config-table::
:config-target: SAN
cinder.volume.drivers.san.san
.. config-table::
:config-target: iSER volume driver
:exclusive-list: iser_opts
cinder.volume.driver
.. config-table::
:config-target: NVMET volume driver
:exclusive-list: nvmet_opts
cinder.volume.driver
.. config-table::
:config-target: SCST volume driver
:exclusive-list: scst_opts
cinder.volume.driver
.. config-table::
:config-target: zones
:exclude-list: allow_force_upload_opt,volume_host_opt,az_cache_time_opt
cinder.volume.api

90
doc/source/configuration/tables/cinder-api.inc
View File

@ -1,90 +0,0 @@
..
Warning: Do not edit this file. It is automatically generated from the
software project's code and your changes will be overwritten.
The tool to generate this file lives in openstack-doc-tools repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools repository, or
ask for help on the documentation mailing list, IRC channel or meeting.
.. _cinder-api:
.. list-table:: Description of API configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[DEFAULT]**
-
* - ``api_rate_limit`` = ``True``
- (Boolean) Enables or disables rate limit of the API.
* - ``az_cache_duration`` = ``3600``
- (Integer) Cache volume availability zones in memory for the provided duration in seconds
* - ``backend_host`` = ``None``
- (String) Backend override of host value.
* - ``default_timeout`` = ``31536000``
- (Integer) Default timeout for CLI operations in minutes. For example, LUN migration is a typical long running operation, which depends on the LUN size and the load of the array. An upper bound in the specific deployment can be set to avoid unnecessary long wait. By default, it is 365 days long.
* - ``enable_v1_api`` = ``False``
- (Boolean) DEPRECATED: Deploy v1 of the Cinder API.
* - ``enable_v2_api`` = ``True``
- (Boolean) DEPRECATED: Deploy v2 of the Cinder API.
* - ``enable_v3_api`` = ``True``
- (Boolean) Deploy v3 of the Cinder API.
* - ``extra_capabilities`` = ``{}``
- (String) User defined capabilities, a JSON formatted string specifying key/value pairs. The key/value pairs can be used by the CapabilitiesFilter to select between backends when requests specify volume types. For example, specifying a service level or the geographical location of a backend, then creating a volume type to allow the user to select by these different properties.
* - ``ignore_pool_full_threshold`` = ``False``
- (Boolean) Force LUN creation even if the full threshold of pool is reached. By default, the value is False.
* - ``management_ips`` =
- (String) List of Management IP addresses (separated by commas)
* - ``message_ttl`` = ``2592000``
- (Integer) message minimum life in seconds.
* - ``osapi_max_limit`` = ``1000``
- (Integer) The maximum number of items that a collection resource returns in a single response
* - ``osapi_volume_base_URL`` = ``None``
- (String) Base URL that will be presented to users in links to the OpenStack Volume API
* - ``osapi_volume_ext_list`` =
- (List) 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']``
- (Multi-valued) osapi volume extension to load
* - ``osapi_volume_listen`` = ``0.0.0.0``
- (String) IP address on which OpenStack Volume API listens
* - ``osapi_volume_listen_port`` = ``8776``
- (Port number) Port on which OpenStack Volume API listens
* - ``osapi_volume_use_ssl`` = ``False``
- (Boolean) Wraps the socket in a SSL context if True is set. A certificate file and key file must be specified.
* - ``osapi_volume_workers`` = ``None``
- (Integer) Number of workers for OpenStack Volume API service. The default is equal to the number of CPUs available.
* - ``per_volume_size_limit`` = ``-1``
- (Integer) Max size allowed per volume, in gigabytes
* - ``public_endpoint`` = ``None``
- (String) Public url to use for versions endpoint. The default is None, which will use the request's host_url attribute to populate the URL base. If Cinder is operating behind a proxy, you will want to change this to represent the proxy's URL.
* - ``query_volume_filters`` = ``name, status, metadata, availability_zone, bootable, group_id``
- (List) Volume filter options which non-admin user could use to query volumes. Default values are: ['name', 'status', 'metadata', 'availability_zone' ,'bootable', 'group_id']
* - ``transfer_api_class`` = ``cinder.transfer.api.API``
- (String) The full class name of the volume transfer API class
* - ``volume_api_class`` = ``cinder.volume.api.API``
- (String) The full class name of the volume API class to use
* - ``volume_name_prefix`` = ``openstack-``
- (String) Prefix before volume name to differentiate DISCO volume created through openstack and the other ones
* - ``volume_name_template`` = ``volume-%s``
- (String) Template string to be used to generate volume names
* - ``volume_number_multiplier`` = ``-1.0``
- (Floating point) Multiplier used for weighing volume number. Negative numbers mean to spread vs stack.
* - ``volume_transfer_key_length`` = ``16``
- (Integer) The number of characters in the autogenerated auth key.
* - ``volume_transfer_salt_length`` = ``8``
- (Integer) The number of characters in the salt.
* - **[oslo_middleware]**
-
* - ``enable_proxy_headers_parsing`` = ``False``
- (Boolean) Whether the application is behind a proxy or not. This determines if the middleware should parse the headers or not.
* - ``max_request_body_size`` = ``114688``
- (Integer) The maximum body size for each request, in bytes.
* - ``secure_proxy_ssl_header`` = ``X-Forwarded-Proto``
- (String) DEPRECATED: The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by a SSL termination proxy.
* - **[oslo_versionedobjects]**
-
* - ``fatal_exception_format_errors`` = ``False``
- (Boolean) Make exception message format errors fatal

22
doc/source/configuration/tables/cinder-auth.inc
View File

@ -1,22 +0,0 @@
..
Warning: Do not edit this file. It is automatically generated from the
software project's code and your changes will be overwritten.
The tool to generate this file lives in openstack-doc-tools repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools repository, or
ask for help on the documentation mailing list, IRC channel or meeting.
.. _cinder-auth:
.. list-table:: Description of authorization configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[DEFAULT]**
-
* - ``auth_strategy`` = ``keystone``
- (String) The strategy to use for auth. Supports noauth or keystone.

48
doc/source/configuration/tables/cinder-backups.inc
View File

@ -1,48 +0,0 @@
..
Warning: Do not edit this file. It is automatically generated from the
software project's code and your changes will be overwritten.
The tool to generate this file lives in openstack-doc-tools repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools repository, or
ask for help on the documentation mailing list, IRC channel or meeting.
.. _cinder-backups:
.. list-table:: Description of backups configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[DEFAULT]**
-
* - ``backup_api_class`` = ``cinder.backup.api.API``
- (String) The full class name of the volume backup API class
* - ``backup_compression_algorithm`` = ``zlib``
- (String) Compression algorithm (None to disable)
* - ``backup_driver`` = ``cinder.backup.drivers.swift``
- (String) Driver to use for backups.
* - ``backup_manager`` = ``cinder.backup.manager.BackupManager``
- (String) Full class name for the Manager for volume backup
* - ``backup_metadata_version`` = ``2``
- (Integer) Backup metadata version to be used when backing up volume metadata. If this number is bumped, make sure the service doing the restore supports the new version.
* - ``backup_name_template`` = ``backup-%s``
- (String) Template string to be used to generate backup names
* - ``backup_object_number_per_notification`` = ``10``
- (Integer) The number of chunks or objects, for which one Ceilometer notification will be sent
* - ``backup_service_inithost_offload`` = ``True``
- (Boolean) Offload pending backup delete during backup service startup. If false, the backup service will remain down until all pending backups are deleted.
* - ``backup_timer_interval`` = ``120``
- (Integer) Interval, in seconds, between two progress notifications reporting the backup status
* - ``backup_use_same_host`` = ``False``
- (Boolean) Backup services use same backend.
* - ``backup_use_temp_snapshot`` = ``False``
- (Boolean) If this is set to True, the backup_use_temp_snapshot path will be used during the backup. Otherwise, it will use backup_use_temp_volume path.
* - ``snapshot_check_timeout`` = ``3600``
- (Integer) How long we check whether a snapshot is finished before we give up
* - ``snapshot_name_template`` = ``snapshot-%s``
- (String) Template string to be used to generate snapshot names
* - ``snapshot_same_host`` = ``True``
- (Boolean) Create volume from snapshot at the host where snapshot resides

162
doc/source/configuration/tables/cinder-common.inc
View File

@ -1,162 +0,0 @@
..
Warning: Do not edit this file. It is automatically generated from the
software project's code and your changes will be overwritten.
The tool to generate this file lives in openstack-doc-tools repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools repository, or
ask for help on the documentation mailing list, IRC channel or meeting.
.. _cinder-common:
.. list-table:: Description of common configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[DEFAULT]**
-
* - ``allow_availability_zone_fallback`` = ``False``
- (Boolean) If the requested Cinder availability zone is unavailable, fall back to the value of default_availability_zone, then storage_availability_zone, instead of failing.
* - ``chap`` = ``disabled``
- (String) CHAP authentication mode, effective only for iscsi (disabled|enabled)
* - ``chap_password`` =
- (String) Password for specified CHAP account name.
* - ``chap_username`` =
- (String) CHAP user name.
* - ``chiscsi_conf`` = ``/etc/chelsio-iscsi/chiscsi.conf``
- (String) Chiscsi (CXT) global defaults configuration file
* - ``cinder_internal_tenant_project_id`` = ``None``
- (String) ID of the project which will be used as the Cinder internal tenant.
* - ``cinder_internal_tenant_user_id`` = ``None``
- (String) ID of the user to be used in volume operations as the Cinder internal tenant.
* - ``cluster`` = ``None``
- (String) Name of this cluster. Used to group volume hosts that share the same backend configurations to work in HA Active-Active mode. Active-Active is not yet supported.
* - ``compute_api_class`` = ``cinder.compute.nova.API``
- (String) The full class name of the compute API class to use
* - ``connection_type`` = ``iscsi``
- (String) Connection type to the IBM Storage Array
* - ``consistencygroup_api_class`` = ``cinder.consistencygroup.api.API``
- (String) The full class name of the consistencygroup API class
* - ``default_availability_zone`` = ``None``
- (String) Default availability zone for new volumes. If not set, the storage_availability_zone option value is used as the default for new volumes.
* - ``default_group_type`` = ``None``
- (String) Default group type to use
* - ``default_volume_type`` = ``None``
- (String) Default volume type to use
* - ``driver_client_cert`` = ``None``
- (String) The path to the client certificate for verification, if the driver supports it.
* - ``driver_client_cert_key`` = ``None``
- (String) The path to the client certificate key for verification, if the driver supports it.
* - ``driver_data_namespace`` = ``None``
- (String) Namespace for driver private data values to be saved in.
* - ``driver_ssl_cert_path`` = ``None``
- (String) Can be used to specify a non default path to a CA_BUNDLE file or directory with certificates of trusted CAs, which will be used to validate the backend
* - ``driver_ssl_cert_verify`` = ``False``
- (Boolean) If set to True the http client will validate the SSL certificate of the backend endpoint.
* - ``enable_force_upload`` = ``False``
- (Boolean) Enables the Force option on upload_to_image. This enables running upload_volume on in-use volumes for backends that support it.
* - ``enable_new_services`` = ``True``
- (Boolean) Services to be added to the available pool on create
* - ``enable_unsupported_driver`` = ``False``
- (Boolean) Set this to True when you want to allow an unsupported driver to start. Drivers that haven't maintained a working CI system and testing are marked as unsupported until CI is working again. This also marks a driver as deprecated and may be removed in the next release.
* - ``end_time`` = ``None``
- (String) If this option is specified then the end time specified is used instead of the end time of the last completed audit period.
* - ``enforce_multipath_for_image_xfer`` = ``False``
- (Boolean) If this is set to True, attachment of volumes for image transfer will be aborted when multipathd is not running. Otherwise, it will fallback to single path.
* - ``executor_thread_pool_size`` = ``64``
- (Integer) Size of executor thread pool.
* - ``fatal_exception_format_errors`` = ``False``
- (Boolean) Make exception message format errors fatal.
* - ``group_api_class`` = ``cinder.group.api.API``
- (String) The full class name of the group API class
* - ``host`` = ``localhost``
- (String) Name of this node. This can be an opaque identifier. It is not necessarily a host name, FQDN, or IP address.
* - ``iet_conf`` = ``/etc/iet/ietd.conf``
- (String) IET configuration file
* - ``iscsi_secondary_ip_addresses`` =
- (List) The list of secondary IP addresses of the iSCSI daemon
* - ``max_over_subscription_ratio`` = ``20.0``
- (Floating point) Float representation of the over subscription ratio when thin provisioning is involved. Default ratio is 20.0, meaning provisioned capacity can be 20 times of the total physical capacity. If the ratio is 10.5, it means provisioned capacity can be 10.5 times of the total physical capacity. A ratio of 1.0 means provisioned capacity cannot exceed the total physical capacity. The ratio has to be a minimum of 1.0.
* - ``monkey_patch`` = ``False``
- (Boolean) Enable monkey patching
* - ``monkey_patch_modules`` =
- (List) List of modules/decorators to monkey patch
* - ``my_ip`` = ``10.0.0.1``
- (String) IP address of this host
* - ``no_snapshot_gb_quota`` = ``False``
- (Boolean) Whether snapshots count against gigabyte quota
* - ``num_shell_tries`` = ``3``
- (Integer) Number of times to attempt to run flakey shell commands
* - ``os_privileged_user_auth_url`` = ``None``
- (URI) Auth URL associated with the OpenStack privileged account.
* - ``os_privileged_user_name`` = ``None``
- (String) OpenStack privileged account username. Used for requests to other services (such as Nova) that require an account with special rights.
* - ``os_privileged_user_password`` = ``None``
- (String) Password associated with the OpenStack privileged account.
* - ``os_privileged_user_tenant`` = ``None``
- (String) Tenant name associated with the OpenStack privileged account.
* - ``periodic_fuzzy_delay`` = ``60``
- (Integer) Range, in seconds, to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0)
* - ``periodic_interval`` = ``60``
- (Integer) Interval, in seconds, between running periodic tasks
* - ``replication_device`` = ``None``
- (Unknown) Multi opt of dictionaries to represent a replication target device. This option may be specified multiple times in a single config section to specify multiple replication target devices. Each entry takes the standard dict config form: replication_device = target_device_id:<required>,key1:value1,key2:value2...
* - ``report_discard_supported`` = ``False``
- (Boolean) Report to clients of Cinder that the backend supports discard (aka. trim/unmap). This will not actually change the behavior of the backend or the client directly, it will only notify that it can be used.
* - ``report_interval`` = ``10``
- (Integer) Interval, in seconds, between nodes reporting state to datastore
* - ``reserved_percentage`` = ``0``
- (Integer) The percentage of backend capacity is reserved
* - ``rootwrap_config`` = ``/etc/cinder/rootwrap.conf``
- (String) Path to the rootwrap configuration file to use for running commands as root
* - ``send_actions`` = ``False``
- (Boolean) Send the volume and snapshot create and delete notifications generated in the specified period.
* - ``service_down_time`` = ``60``
- (Integer) Maximum time since last check-in for a service to be considered up
* - ``ssh_hosts_key_file`` = ``$state_path/ssh_known_hosts``
- (String) File containing SSH host keys for the systems with which Cinder needs to communicate. OPTIONAL: Default=$state_path/ssh_known_hosts
* - ``start_time`` = ``None``
- (String) If this option is specified then the start time specified is used instead of the start time of the last completed audit period.
* - ``state_path`` = ``/var/lib/cinder``
- (String) Top-level directory for maintaining cinder's state
* - ``storage_availability_zone`` = ``nova``
- (String) Availability zone of this node
* - ``storage_protocol`` = ``iscsi``
- (String) Protocol for transferring data between host and storage back-end.
* - ``strict_ssh_host_key_policy`` = ``False``
- (Boolean) Option to enable strict host key checking. When set to "True" Cinder will only connect to systems with a host key present in the configured "ssh_hosts_key_file". When set to "False" the host key will be saved upon first connection and used for subsequent connections. Default=False
* - ``suppress_requests_ssl_warnings`` = ``False``
- (Boolean) Suppress requests library SSL certificate warnings.
* - ``tcp_keepalive`` = ``True``
- (Boolean) Sets the value of TCP_KEEPALIVE (True/False) for each server socket.
* - ``tcp_keepalive_count`` = ``None``
- (Integer) Sets the value of TCP_KEEPCNT for each server socket. Not supported on OS X.
* - ``tcp_keepalive_interval`` = ``None``
- (Integer) Sets the value of TCP_KEEPINTVL in seconds for each server socket. Not supported on OS X.
* - ``until_refresh`` = ``0``
- (Integer) Count of reservations until usage is refreshed
* - ``use_chap_auth`` = ``False``
- (Boolean) Option to enable/disable CHAP authentication for targets.
* - ``use_forwarded_for`` = ``False``
- (Boolean) Treat X-Forwarded-For as the canonical remote address. Only enable this if you have a sanitizing proxy.
* - **[healthcheck]**
-
* - ``backends`` =
- (List) Additional backends that can perform health checks and report that information back as part of a request.
* - ``detailed`` = ``False``
- (Boolean) Show more detailed information as part of the response
* - ``disable_by_file_path`` = ``None``
- (String) Check the presence of a file to determine if an application is running on a port. Used by DisableByFileHealthcheck plugin.
* - ``disable_by_file_paths`` =
- (List) Check the presence of a file based on a port to determine if an application is running on a port. Expects a "port:path" list of strings. Used by DisableByFilesPortsHealthcheck plugin.
* - ``path`` = ``/healthcheck``
- (String) DEPRECATED: The path to respond to healtcheck requests on.
* - **[key_manager]**
-
* - ``backend`` = ``barbican``
- (String) The full class name of the key manager API class
* - ``fixed_key`` = ``None``
- (String) Fixed key returned by key manager, specified in hex

34
doc/source/configuration/tables/cinder-compute.inc
View File

@ -1,34 +0,0 @@
..
Warning: Do not edit this file. It is automatically generated from the
software project's code and your changes will be overwritten.
The tool to generate this file lives in openstack-doc-tools repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools repository, or
ask for help on the documentation mailing list, IRC channel or meeting.
.. _cinder-compute:
.. list-table:: Description of Compute configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[DEFAULT]**
-
* - ``nova_api_insecure`` = ``False``
- (Boolean) Allow to perform insecure SSL requests to nova
* - ``nova_ca_certificates_file`` = ``None``
- (String) Location of ca certificates file to use for nova client requests.
* - ``nova_catalog_admin_info`` = ``compute:Compute Service:adminURL``
- (String) Same as nova_catalog_info, but for admin endpoint.
* - ``nova_catalog_info`` = ``compute:Compute Service:publicURL``
- (String) Match this value when searching for nova in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:<endpoint_type>
* - ``nova_endpoint_admin_template`` = ``None``
- (String) Same as nova_endpoint_template, but for admin endpoint.
* - ``nova_endpoint_template`` = ``None``
- (String) Override service catalog lookup with template for nova endpoint e.g. http://localhost:8774/v2/%(project_id)s
* - ``os_region_name`` = ``None``
- (String) Region name of this node

28
doc/source/configuration/tables/cinder-coordination.inc
View File

@ -1,28 +0,0 @@
..
Warning: Do not edit this file. It is automatically generated from the
software project's code and your changes will be overwritten.
The tool to generate this file lives in openstack-doc-tools repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools repository, or
ask for help on the documentation mailing list, IRC channel or meeting.
.. _cinder-coordination:
.. list-table:: Description of Coordination configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[coordination]**
-
* - ``backend_url`` = ``file://$state_path``
- (String) The backend URL to use for distributed coordination.
* - ``heartbeat`` = ``1.0``
- (Floating point) Number of seconds between heartbeats for distributed coordination.
* - ``initial_reconnect_backoff`` = ``0.1``
- (Floating point) Initial number of seconds to wait after failed reconnection.
* - ``max_reconnect_backoff`` = ``60.0``
- (Floating point) Maximum number of seconds between sequential reconnection retries.

22
doc/source/configuration/tables/cinder-debug.inc
View File

@ -1,22 +0,0 @@
..
Warning: Do not edit this file. It is automatically generated from the
software project's code and your changes will be overwritten.
The tool to generate this file lives in openstack-doc-tools repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools repository, or
ask for help on the documentation mailing list, IRC channel or meeting.
.. _cinder-debug:
.. list-table:: Description of logging configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[DEFAULT]**
-
* - ``trace_flags`` = ``None``
- (List) List of options that control which trace info is written to the DEBUG log level to assist developers. Valid values are method and api.

52
doc/source/configuration/tables/cinder-images.inc
View File

@ -1,52 +0,0 @@
..
Warning: Do not edit this file. It is automatically generated from the
software project's code and your changes will be overwritten.
The tool to generate this file lives in openstack-doc-tools repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools repository, or
ask for help on the documentation mailing list, IRC channel or meeting.
.. _cinder-images:
.. list-table:: Description of images configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[DEFAULT]**
-
* - ``allowed_direct_url_schemes`` =
- (List) A list of url schemes that can be downloaded directly via the direct_url. Currently supported schemes: [file, cinder].
* - ``glance_api_insecure`` = ``False``
- (Boolean) Allow to perform insecure SSL (https) requests to glance (https will be used but cert validation will not be performed).
* - ``glance_api_servers`` = ``None``
- (List) A list of the URLs of glance API servers available to cinder ([http[s]://][hostname|ip]:port). If protocol is not specified it defaults to http.
* - ``glance_api_ssl_compression`` = ``False``
- (Boolean) 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.
* - ``glance_ca_certificates_file`` = ``None``
- (String) Location of ca certificates file to use for glance client requests.
* - ``glance_catalog_info`` = ``image:glance:publicURL``
- (String) Info to match when looking for glance in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:<endpoint_type> - Only used if glance_api_servers are not provided.
* - ``glance_core_properties`` = ``checksum, container_format, disk_format, image_name, image_id, min_disk, min_ram, name, size``
- (List) Default core properties of image
* - ``glance_num_retries`` = ``0``
- (Integer) Number retries when downloading an image from glance
* - ``glance_request_timeout`` = ``None``
- (Integer) http/https timeout value for glance operations. If no value (None) is supplied here, the glanceclient default value is used.
* - ``image_conversion_dir`` = ``$state_path/conversion``
- (String) Directory used for temporary storage during image conversion
* - ``image_upload_use_cinder_backend`` = ``False``
- (Boolean) If set to True, upload-to-image in raw format will create a cloned volume and register its location to the image service, instead of uploading the volume content. The cinder backend and locations support must be enabled in the image service.
* - ``image_upload_use_internal_tenant`` = ``False``
- (Boolean) If set to True, the image volume created by upload-to-image will be placed in the internal tenant. Otherwise, the image volume is created in the current context's tenant.
* - ``image_volume_cache_enabled`` = ``False``
- (Boolean) Enable the image volume cache for this backend.
* - ``image_volume_cache_max_count`` = ``0``
- (Integer) Max number of entries allowed in the image volume cache. 0 => unlimited.
* - ``image_volume_cache_max_size_gb`` = ``0``
- (Integer) Max size of the image volume cache for this backend in GB. 0 => unlimited.
* - ``use_multipath_for_image_xfer`` = ``False``
- (Boolean) Do we attach/detach volumes in cinder using multipath for volume to image and image to volume transfers?

40
doc/source/configuration/tables/cinder-nas.inc
View File

@ -1,40 +0,0 @@
..
Warning: Do not edit this file. It is automatically generated from the
software project's code and your changes will be overwritten.
The tool to generate this file lives in openstack-doc-tools repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools repository, or
ask for help on the documentation mailing list, IRC channel or meeting.
.. _cinder-nas:
.. list-table:: Description of NAS configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[DEFAULT]**
-
* - ``nas_host`` =
- (String) IP address or Hostname of NAS system.
* - ``nas_login`` = ``admin``
- (String) User name to connect to NAS system.
* - ``nas_mount_options`` = ``None``
- (String) Options used to mount the storage backend file system where Cinder volumes are stored.
* - ``nas_password`` =
- (String) Password to connect to NAS system.
* - ``nas_private_key`` =
- (String) Filename of private key to use for SSH authentication.
* - ``nas_secure_file_operations`` = ``auto``
- (String) Allow network-attached storage systems to operate in a secure environment where root level access is not permitted. If set to False, access is as the root user and insecure. If set to True, access is not as root. If set to auto, a check is done to determine if this is a new installation: True is used if so, otherwise False. Default is auto.
* - ``nas_secure_file_permissions`` = ``auto``
- (String) Set more secure file permissions on network-attached storage volume files to restrict broad other/world access. If set to False, volumes are created with open permissions. If set to True, volumes are created with permissions for the cinder user and group (660). If set to auto, a check is done to determine if this is a new installation: True is used if so, otherwise False. Default is auto.
* - ``nas_share_path`` =
- (String) Path to the share to use for storing Cinder volumes. For example: "/srv/export1" for an NFS server export available at 10.0.5.10:/srv/export1 .
* - ``nas_ssh_port`` = ``22``
- (Port number) SSH port to use to connect to NAS system.
* - ``nas_volume_prov_type`` = ``thin``
- (String) Provisioning type that will be used when creating volumes.

60
doc/source/configuration/tables/cinder-profiler.inc
View File

@ -1,60 +0,0 @@
..
Warning: Do not edit this file. It is automatically generated from the
software project's code and your changes will be overwritten.
The tool to generate this file lives in openstack-doc-tools repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools repository, or
ask for help on the documentation mailing list, IRC channel or meeting.
.. _cinder-profiler:
.. list-table:: Description of profiler configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[profiler]**
-
* - ``connection_string`` = ``messaging://``
- (String) Connection string for a notifier backend. Default value is messaging:// which sets the notifier to oslo_messaging.
Examples of possible values:
* messaging://: use oslo_messaging driver for sending notifications.
* mongodb://127.0.0.1:27017 : use mongodb driver for sending notifications.
* elasticsearch://127.0.0.1:9200 : use elasticsearch driver for sending notifications.
* - ``enabled`` = ``False``
- (Boolean) Enables the profiling for all services on this node. Default value is False (fully disable the profiling feature).
Possible values:
* True: Enables the feature
* False: Disables the feature. The profiling cannot be started via this project operations. If the profiling is triggered by another project, this project part will be empty.
* - ``es_doc_type`` = ``notification``
- (String) Document type for notification indexing in elasticsearch.
* - ``es_scroll_size`` = ``10000``
- (Integer) Elasticsearch splits large requests in batches. This parameter defines maximum size of each batch (for example: es_scroll_size=10000).
* - ``es_scroll_time`` = ``2m``
- (String) This parameter is a time value parameter (for example: es_scroll_time=2m), indicating for how long the nodes that participate in the search will maintain relevant resources in order to continue and support it.
* - ``hmac_keys`` = ``SECRET_KEY``
- (String) Secret key(s) to use for encrypting context data for performance profiling. This string value should have the following format: <key1>[,<key2>,...<keyn>], where each key is some random string. A user who triggers the profiling via the REST API has to set one of these keys in the headers of the REST API call to include profiling results of this node for this particular project.
Both "enabled" flag and "hmac_keys" config options should be set to enable profiling. Also, to generate correct profiling information across all services at least one key needs to be consistent between OpenStack projects. This ensures it can be used from client side to generate the trace, containing information from all possible resources.
* - ``sentinel_service_name`` = ``mymaster``
- (String) Redissentinel uses a service name to identify a master redis service. This parameter defines the name (for example: sentinal_service_name=mymaster).
* - ``socket_timeout`` = ``0.1``
- (Floating point) Redissentinel provides a timeout option on the connections. This parameter defines that timeout (for example: socket_timeout=0.1).
* - ``trace_sqlalchemy`` = ``False``
- (Boolean) Enables SQL requests profiling in services. Default value is False (SQL requests won't be traced).
Possible values:
* True: Enables SQL requests profiling. Each SQL query will be part of the trace and can the be analyzed by how much time was spent for that.
* False: Disables SQL requests profiling. The spent time is only shown on a higher level of operations. Single SQL queries cannot be analyzed this way.

42
doc/source/configuration/tables/cinder-quota.inc
View File

@ -1,42 +0,0 @@
..
Warning: Do not edit this file. It is automatically generated from the
software project's code and your changes will be overwritten.
The tool to generate this file lives in openstack-doc-tools repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools repository, or
ask for help on the documentation mailing list, IRC channel or meeting.
.. _cinder-quota:
.. list-table:: Description of quota configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[DEFAULT]**
-
* - ``max_age`` = ``0``
- (Integer) Number of seconds between subsequent usage refreshes
* - ``quota_backup_gigabytes`` = ``1000``
- (Integer) Total amount of storage, in gigabytes, allowed for backups per project
* - ``quota_backups`` = ``10``
- (Integer) Number of volume backups allowed per project
* - ``quota_consistencygroups`` = ``10``
- (Integer) Number of consistencygroups allowed per project
* - ``quota_driver`` = ``cinder.quota.DbQuotaDriver``
- (String) Default driver to use for quota checks
* - ``quota_gigabytes`` = ``1000``
- (Integer) Total amount of storage, in gigabytes, allowed for volumes and snapshots per project
* - ``quota_groups`` = ``10``
- (Integer) Number of groups allowed per project
* - ``quota_snapshots`` = ``10``
- (Integer) Number of volume snapshots allowed per project
* - ``quota_volumes`` = ``10``
- (Integer) Number of volumes allowed per project
* - ``reservation_expire`` = ``86400``
- (Integer) Number of seconds until a reservation expires
* - ``use_default_quota_class`` = ``True``
- (Boolean) Enables or disables use of default quota class with default quota.

42
doc/source/configuration/tables/cinder-san.inc
View File

@ -1,42 +0,0 @@
..
Warning: Do not edit this file. It is automatically generated from the
software project's code and your changes will be overwritten.
The tool to generate this file lives in openstack-doc-tools repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools repository, or
ask for help on the documentation mailing list, IRC channel or meeting.
.. _cinder-san:
.. list-table:: Description of SAN configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[DEFAULT]**
-
* - ``san_clustername`` =
- (String) Cluster name to use for creating volumes
* - ``san_ip`` =
- (String) IP address of SAN controller
* - ``san_is_local`` = ``False``
- (Boolean) Execute commands locally instead of over SSH; use if the volume service is running on the SAN device
* - ``san_login`` = ``admin``
- (String) Username for SAN controller
* - ``san_password`` =
- (String) Password for SAN controller
* - ``san_private_key`` =
- (String) Filename of private key to use for SSH authentication
* - ``san_ssh_port`` = ``22``
- (Port number) SSH port to use with SAN
* - ``san_thin_provision`` = ``True``
- (Boolean) Use thin provisioning for SAN volumes?
* - ``ssh_conn_timeout`` = ``30``
- (Integer) SSH connection timeout in seconds
* - ``ssh_max_pool_conn`` = ``5``
- (Integer) Maximum ssh connections in the pool
* - ``ssh_min_pool_conn`` = ``1``
- (Integer) Minimum ssh connections in the pool

24
doc/source/configuration/tables/cinder-scst.inc
View File

@ -1,24 +0,0 @@
..
Warning: Do not edit this file. It is automatically generated from the
software project's code and your changes will be overwritten.
The tool to generate this file lives in openstack-doc-tools repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools repository, or
ask for help on the documentation mailing list, IRC channel or meeting.
.. _cinder-scst:
.. list-table:: Description of SCST volume driver configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[DEFAULT]**
-
* - ``scst_target_driver`` = ``iscsi``
- (String) SCST target implementation can choose from multiple SCST target drivers.
* - ``scst_target_iqn_name`` = ``None``
- (String) Certain ISCSI targets have predefined target names, SCST target driver uses this name.

22
doc/source/configuration/tables/cinder-zones.inc
View File

@ -1,22 +0,0 @@
..
Warning: Do not edit this file. It is automatically generated from the
software project's code and your changes will be overwritten.
The tool to generate this file lives in openstack-doc-tools repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools repository, or
ask for help on the documentation mailing list, IRC channel or meeting.
.. _cinder-zones:
.. list-table:: Description of zones configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[DEFAULT]**
-
* - ``cloned_volume_same_az`` = ``True``
- (Boolean) Ensure that the new volumes are the same AZ as snapshot or source volume