96931557e0
The mapping file and xml table have been generated using the autohelp.py script from openstack-doc-tools. Change-Id: Iec1d8b7d17a5b2b666b0faf7aed141c7179d0440
92 lines
4.6 KiB
XML
92 lines
4.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>
|
|
<th>Configuration option = Default value</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<th colspan="2">[DEFAULT]</th>
|
|
</tr>
|
|
<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>(StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.</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>max_header_line = 16384</td>
|
|
<td>(IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs).</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_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>osapi_volume_extension = ['cinder.api.contrib.standard_extensions']</td>
|
|
<td>(MultiStrOpt) osapi volume extension to load</td>
|
|
</tr>
|
|
<tr>
|
|
<td>osapi_volume_listen = 0.0.0.0</td>
|
|
<td>(StrOpt) IP address for OpenStack Volume API to listen</td>
|
|
</tr>
|
|
<tr>
|
|
<td>osapi_volume_listen_port = 8776</td>
|
|
<td>(IntOpt) port for os volume api to listen</td>
|
|
</tr>
|
|
<tr>
|
|
<td>osapi_volume_workers = None</td>
|
|
<td>(IntOpt) Number of workers for OpenStack Volume API service</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>
|
|
</tbody>
|
|
</table>
|
|
</para>
|