157 lines
7.3 KiB
ReStructuredText
157 lines
7.3 KiB
ReStructuredText
..
|
|
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.
|
|
|
|
.. _nova-volumes:
|
|
|
|
.. list-table:: Description of volumes configuration options
|
|
:header-rows: 1
|
|
:class: config-ref-table
|
|
|
|
* - Configuration option = Default value
|
|
- Description
|
|
* - **[DEFAULT]**
|
|
-
|
|
* - ``block_device_allocate_retries`` = ``60``
|
|
- (Integer) Number of times to retry block device allocation on failures. Starting with Liberty, Cinder can use image volume cache. This may help with block device allocation performance. Look at the cinder image_volume_cache_enabled configuration option.
|
|
|
|
Possible values:
|
|
|
|
* 60 (default)
|
|
|
|
* If value is 0, then one attempt is made.
|
|
|
|
* Any negative value is treated as 0.
|
|
|
|
* For any value > 0, total attempts are (value + 1)
|
|
* - ``block_device_allocate_retries_interval`` = ``3``
|
|
- (Integer) Waiting time interval (seconds) between block device allocation retries on failures
|
|
* - ``my_block_storage_ip`` = ``$my_ip``
|
|
- (String) The IP address which is used to connect to the block storage network.
|
|
|
|
Possible values:
|
|
|
|
* String with valid IP address. Default is IP address of this host.
|
|
|
|
Related options:
|
|
|
|
* my_ip - if my_block_storage_ip is not set, then my_ip value is used.
|
|
* - ``volume_usage_poll_interval`` = ``0``
|
|
- (Integer) Interval in seconds for gathering volume usages
|
|
* - **[cinder]**
|
|
-
|
|
* - ``cafile`` = ``None``
|
|
- (String) PEM encoded Certificate Authority to use when verifying HTTPs connections.
|
|
* - ``catalog_info`` = ``volumev2:cinderv2:publicURL``
|
|
- (String) Info to match when looking for cinder in the service catalog.
|
|
|
|
Possible values:
|
|
|
|
* Format is separated values of the form: <service_type>:<service_name>:<endpoint_type>
|
|
|
|
Related options:
|
|
|
|
* endpoint_template - Setting this option will override catalog_info
|
|
* - ``certfile`` = ``None``
|
|
- (String) PEM encoded client certificate cert file
|
|
* - ``cross_az_attach`` = ``True``
|
|
- (Boolean) Allow attach between instance and volume in different availability zones.
|
|
|
|
If False, volumes attached to an instance must be in the same availability zone in Cinder as the instance availability zone in Nova. This also means care should be taken when booting an instance from a volume where source is not "volume" because Nova will attempt to create a volume using the same availability zone as what is assigned to the instance. If that AZ is not in Cinder (or allow_availability_zone_fallback=False in cinder.conf), the volume create request will fail and the instance will fail the build request. By default there is no availability zone restriction on volume attach.
|
|
* - ``endpoint_template`` = ``None``
|
|
- (String) If this option is set then it will override service catalog lookup with this template for cinder endpoint
|
|
|
|
Possible values:
|
|
|
|
* URL for cinder endpoint API e.g. http://localhost:8776/v1/%(project_id)s
|
|
|
|
Related options:
|
|
|
|
* catalog_info - If endpoint_template is not set, catalog_info will be used.
|
|
* - ``http_retries`` = ``3``
|
|
- (Integer) Number of times cinderclient should retry on any failed http call. 0 means connection is attempted only once. Setting it to any positive integer means that on failure connection is retried that many times e.g. setting it to 3 means total attempts to connect will be 4.
|
|
|
|
Possible values:
|
|
|
|
* Any integer value. 0 means connection is attempted only once
|
|
* - ``insecure`` = ``False``
|
|
- (Boolean) Verify HTTPS connections.
|
|
* - ``keyfile`` = ``None``
|
|
- (String) PEM encoded client certificate key file
|
|
* - ``os_region_name`` = ``None``
|
|
- (String) Region name of this node. This is used when picking the URL in the service catalog.
|
|
|
|
Possible values:
|
|
|
|
* Any string representing region name
|
|
* - ``timeout`` = ``None``
|
|
- (Integer) Timeout value for http requests
|
|
* - **[hyperv]**
|
|
-
|
|
* - ``force_volumeutils_v1`` = ``False``
|
|
- (Boolean) DEPRECATED: Force V1 volume utility class
|
|
* - ``volume_attach_retry_count`` = ``10``
|
|
- (Integer) Volume attach retry count
|
|
|
|
The number of times to retry to attach a volume. This option is used to avoid incorrectly returned no data when the system is under load. Volume attachment is retried until success or the given retry count is reached. To prepare the Hyper-V node to be able to attach to volumes provided by cinder you must first make sure the Windows iSCSI initiator service is running and started automatically.
|
|
|
|
Possible values:
|
|
|
|
* Positive integer values (Default: 10).
|
|
|
|
Related options:
|
|
|
|
* Time interval between attachment attempts is declared with volume_attach_retry_interval option.
|
|
* - ``volume_attach_retry_interval`` = ``5``
|
|
- (Integer) Volume attach retry interval
|
|
|
|
Interval between volume attachment attempts, in seconds.
|
|
|
|
Possible values:
|
|
|
|
* Time in seconds (Default: 5).
|
|
|
|
Related options:
|
|
|
|
* This options is meaningful when volume_attach_retry_count is greater than 1.
|
|
|
|
* The retry loop runs with volume_attach_retry_count and volume_attach_retry_interval configuration options.
|
|
* - **[libvirt]**
|
|
-
|
|
* - ``glusterfs_mount_point_base`` = ``$state_path/mnt``
|
|
- (String) Directory where the glusterfs volume is mounted on the compute node
|
|
* - ``nfs_mount_options`` = ``None``
|
|
- (String) Mount options passed to the NFS client. See section of the nfs man page for details
|
|
* - ``nfs_mount_point_base`` = ``$state_path/mnt``
|
|
- (String) Directory where the NFS volume is mounted on the compute node
|
|
* - ``num_aoe_discover_tries`` = ``3``
|
|
- (Integer) Number of times to rediscover AoE target to find volume
|
|
* - ``num_iscsi_scan_tries`` = ``5``
|
|
- (Integer) Number of times to rescan iSCSI target to find volume
|
|
* - ``num_iser_scan_tries`` = ``5``
|
|
- (Integer) Number of times to rescan iSER target to find volume
|
|
* - ``qemu_allowed_storage_drivers`` =
|
|
- (List) Protocols listed here will be accessed directly from QEMU. Currently supported protocols: [gluster]
|
|
* - ``rbd_secret_uuid`` = ``None``
|
|
- (String) The libvirt UUID of the secret for the rbd_uservolumes
|
|
* - ``rbd_user`` = ``None``
|
|
- (String) The RADOS client name for accessing rbd volumes
|
|
* - ``scality_sofs_config`` = ``None``
|
|
- (String) Path or URL to Scality SOFS configuration file
|
|
* - ``scality_sofs_mount_point`` = ``$state_path/scality``
|
|
- (String) Base dir where Scality SOFS shall be mounted
|
|
* - ``smbfs_mount_options`` =
|
|
- (String) Mount options passed to the SMBFS client. See mount.cifs man page for details. Note that the libvirt-qemu uid and gid must be specified.
|
|
* - ``smbfs_mount_point_base`` = ``$state_path/mnt``
|
|
- (String) Directory where the SMBFS shares are mounted on the compute node
|
|
* - **[xenserver]**
|
|
-
|
|
* - ``block_device_creation_timeout`` = ``10``
|
|
- (Integer) Time in secs to wait for a block device to be created
|