986a6a015f
The Sphinx build was issuing hundreds of warning for duplicate labels. The reason for this was because all of the tables we had were named as .rst files. This would cause Sphinx to process them twice and it would think there were duplicated sections. There were two ways this could be handled: 1) Exclude the tables directory from the docs build. 2) Name the files as they should have always been so they weren't build twice. Given that option 1 just masked the problem, I am implementing this patch using option 2. So, all the tables we are including in our documentation have been named from .rst to .inc and the .. include:: directives that use them have also been updated to use the new file name. Change-Id: If395eb652f7e3b789bcbd5e6d6d05954c23d8d8a
55 lines
3.7 KiB
PHP
55 lines
3.7 KiB
PHP
..
|
|
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_api_version`` = ``1``
|
|
- (Integer) Version of the glance API to use
|
|
* - ``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, and glance_api_version must be set to 2.
|
|
* - ``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?
|