openstack-manuals/doc/common/tables/cinder-images.xml
Gauvain Pocentek e7cbc675ce update the config reference tables for liberty
Change-Id: I959cc6884633ada1deb55f44ca1fc6f230bdebd9
2015-10-29 07:45:04 +01:00

113 lines
5.6 KiB
XML

<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
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.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_images">
<caption>Description of images configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>allowed_direct_url_schemes</option> = <replaceable></replaceable></td>
<td>(ListOpt) A list of url schemes that can be downloaded directly via the direct_url. Currently supported schemes: [file].</td>
</tr>
<tr>
<td><option>glance_api_insecure</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Allow to perform insecure SSL (https) requests to glance</td>
</tr>
<tr>
<td><option>glance_api_servers</option> = <replaceable>$glance_host:$glance_port</replaceable></td>
<td>(ListOpt) A list of the glance API servers available to cinder ([hostname|ip]:port)</td>
</tr>
<tr>
<td><option>glance_api_ssl_compression</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) 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.</td>
</tr>
<tr>
<td><option>glance_api_version</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Version of the glance API to use</td>
</tr>
<tr>
<td><option>glance_ca_certificates_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Location of ca certificates file to use for glance client requests.</td>
</tr>
<tr>
<td><option>glance_core_properties</option> = <replaceable>checksum, container_format, disk_format, image_name, image_id, min_disk, min_ram, name, size</replaceable></td>
<td>(ListOpt) Default core properties of image</td>
</tr>
<tr>
<td><option>glance_host</option> = <replaceable>$my_ip</replaceable></td>
<td>(StrOpt) Default glance host name or IP</td>
</tr>
<tr>
<td><option>glance_num_retries</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) Number retries when downloading an image from glance</td>
</tr>
<tr>
<td><option>glance_port</option> = <replaceable>9292</replaceable></td>
<td>(IntOpt) Default glance port</td>
</tr>
<tr>
<td><option>glance_request_timeout</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) http/https timeout value for glance operations. If no value (None) is supplied here, the glanceclient default value is used.</td>
</tr>
<tr>
<td><option>image_conversion_dir</option> = <replaceable>$state_path/conversion</replaceable></td>
<td>(StrOpt) Directory used for temporary storage during image conversion</td>
</tr>
<tr>
<td><option>image_upload_use_cinder_backend</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) 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.</td>
</tr>
<tr>
<td><option>image_upload_use_internal_tenant</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) 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.</td>
</tr>
<tr>
<td><option>image_volume_cache_enabled</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enable the image volume cache for this backend.</td>
</tr>
<tr>
<td><option>image_volume_cache_max_count</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) Max number of entries allowed in the image volume cache. 0 =&gt; unlimited.</td>
</tr>
<tr>
<td><option>image_volume_cache_max_size_gb</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) Max size of the image volume cache for this backend in GB. 0 =&gt; unlimited.</td>
</tr>
<tr>
<td><option>use_multipath_for_image_xfer</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Do we attach/detach volumes in cinder using multipath for volume to image and image to volume transfers?</td>
</tr>
</tbody>
</table>
</para>