131 lines
6.0 KiB
XML
131 lines
6.0 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_manila_api">
|
|
<caption>Description of API 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>api_paste_config</option> = <replaceable>api-paste.ini</replaceable></td>
|
|
<td>(StrOpt) File name for the paste.deploy config for manila-api.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>api_rate_limit</option> = <replaceable>True</replaceable></td>
|
|
<td>(BoolOpt) Whether to rate limit the API.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>enable_v1_api</option> = <replaceable>False</replaceable></td>
|
|
<td>(BoolOpt) Deploy v1 of the Manila API. This option is deprecated, is not used, and will be removed in a future release.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>enable_v2_api</option> = <replaceable>False</replaceable></td>
|
|
<td>(BoolOpt) Deploy v2 of the Manila API. This option is deprecated, is not used, and will be removed in a future release.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>max_header_line</option> = <replaceable>16384</replaceable></td>
|
|
<td>(IntOpt) Maximum line size of message headers to be accepted. Option 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><option>osapi_max_limit</option> = <replaceable>1000</replaceable></td>
|
|
<td>(IntOpt) The maximum number of items returned in a single response from a collection resource.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>osapi_share_base_URL</option> = <replaceable>None</replaceable></td>
|
|
<td>(StrOpt) Base URL to be presented to users in links to the Share API</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>osapi_share_ext_list</option> = <replaceable></replaceable></td>
|
|
<td>(ListOpt) Specify list of extensions to load when using osapi_share_extension option with manila.api.contrib.select_extensions.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>osapi_share_extension</option> = <replaceable>['manila.api.contrib.standard_extensions']</replaceable></td>
|
|
<td>(MultiStrOpt) The osapi share extension to load.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>osapi_share_listen</option> = <replaceable>::</replaceable></td>
|
|
<td>(StrOpt) IP address for OpenStack Share API to listen on.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>osapi_share_listen_port</option> = <replaceable>8786</replaceable></td>
|
|
<td>(PortOpt) Port for OpenStack Share API to listen on.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>osapi_share_workers</option> = <replaceable>1</replaceable></td>
|
|
<td>(IntOpt) Number of workers for OpenStack Share API service.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>share_api_class</option> = <replaceable>manila.share.api.API</replaceable></td>
|
|
<td>(StrOpt) The full class name of the share API class to use.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>volume_api_class</option> = <replaceable>manila.volume.cinder.API</replaceable></td>
|
|
<td>(StrOpt) The full class name of the Volume API class to use.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>volume_name_template</option> = <replaceable>manila-share-%s</replaceable></td>
|
|
<td>(StrOpt) Volume name template.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>volume_snapshot_name_template</option> = <replaceable>manila-snapshot-%s</replaceable></td>
|
|
<td>(StrOpt) Volume snapshot name template.</td>
|
|
</tr>
|
|
<tr>
|
|
<th colspan="2">[oslo_middleware]</th>
|
|
</tr>
|
|
<tr>
|
|
<td><option>max_request_body_size</option> = <replaceable>114688</replaceable></td>
|
|
<td>(IntOpt) The maximum body size for each request, in bytes.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>secure_proxy_ssl_header</option> = <replaceable>X-Forwarded-Proto</replaceable></td>
|
|
<td>(StrOpt) The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by an SSL termination proxy.</td>
|
|
</tr>
|
|
<tr>
|
|
<th colspan="2">[oslo_policy]</th>
|
|
</tr>
|
|
<tr>
|
|
<td><option>policy_default_rule</option> = <replaceable>default</replaceable></td>
|
|
<td>(StrOpt) Default rule. Enforced when a requested rule is not found.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>policy_dirs</option> = <replaceable>['policy.d']</replaceable></td>
|
|
<td>(MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>policy_file</option> = <replaceable>policy.json</replaceable></td>
|
|
<td>(StrOpt) The JSON file that defines policies.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</para>
|