openstack-manuals/doc/common/tables/cinder-api.xml
Tom Fifield bb680dfdc7 Update conf option tables for cinder
This re-runs the autodoc tool to generate new flagmappings for
cinder from the recent trunk. It starts to separate out
the 'storage' category into various driver components.

Change-Id: Iaa8770001fcb182403ce9f1b756d4732d06bc3f6
2013-10-07 12:30:27 +00:00

80 lines
3.6 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for api</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<td>Configuration option=Default value</td>
<td>Description</td>
</tr>
</thead>
<tbody>
<tr>
<td>api_paste_config=api-paste.ini</td>
<td>(StrOpt) File name for the paste.deploy config for cinder-api</td>
</tr>
<tr>
<td>api_rate_limit=True</td>
<td>(BoolOpt) whether to rate limit the api</td>
</tr>
<tr>
<td>backdoor_port=None</td>
<td>(IntOpt) port for eventlet backdoor to listen</td>
</tr>
<tr>
<td>enable_v1_api=True</td>
<td>(BoolOpt) Deploy v1 of the Cinder API. </td>
</tr>
<tr>
<td>enable_v2_api=True</td>
<td>(BoolOpt) Deploy v2 of the Cinder API. </td>
</tr>
<tr>
<td>osapi_max_limit=1000</td>
<td>(IntOpt) the maximum number of items returned in a single response from a collection resource</td>
</tr>
<tr>
<td>osapi_max_request_body_size=114688</td>
<td>(IntOpt) Max size for body of a request</td>
</tr>
<tr>
<td>osapi_volume_base_URL=None</td>
<td>(StrOpt) Base URL that will be presented to users in links to the OpenStack Volume API</td>
</tr>
<tr>
<td>osapi_volume_extension=['cinder.api.contrib.standard_extensions']</td>
<td>(MultiStrOpt) osapi volume extension to load</td>
</tr>
<tr>
<td>osapi_volume_ext_list=</td>
<td>(ListOpt) Specify list of extensions to load when using osapi_volume_extension option with cinder.api.contrib.select_extensions</td>
</tr>
<tr>
<td>transfer_api_class=cinder.transfer.api.API</td>
<td>(StrOpt) The full class name of the volume transfer API class</td>
</tr>
<tr>
<td>volume_api_class=cinder.volume.api.API</td>
<td>(StrOpt) The full class name of the volume API class to use</td>
</tr>
<tr>
<td>volume_name_template=volume-%s</td>
<td>(StrOpt) Template string to be used to generate volume names</td>
</tr>
<tr>
<td>volume_transfer_key_length=16</td>
<td>(IntOpt) The number of characters in the autogenerated auth key.</td>
</tr>
<tr>
<td>volume_transfer_salt_length=8</td>
<td>(IntOpt) The number of characters in the salt.</td>
</tr>
</tbody>
</table>
</para>