openstack-manuals/doc/common/tables/cinder-api.xml

<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
  <!-- Warning: Do not edit this file. It is automatically
     generated and your changes will be overwritten.
     The tool to do so lives in openstack-doc-tools repository. -->
  <table rules="all" xml:id="config_table_cinder_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 cinder-api</td>
      </tr>
      <tr>
        <td><option>api_rate_limit</option> = <replaceable>True</replaceable></td>
        <td>(BoolOpt) Enables or disables rate limit of the API.</td>
      </tr>
      <tr>
        <td><option>az_cache_duration</option> = <replaceable>3600</replaceable></td>
        <td>(IntOpt) Cache volume availability zones in memory for the provided duration in seconds</td>
      </tr>
      <tr>
        <td><option>backend_host</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) Backend override of host value.</td>
      </tr>
      <tr>
        <td><option>default_timeout</option> = <replaceable>525600</replaceable></td>
        <td>(IntOpt) Default timeout for CLI operations in minutes. For example, LUN migration is a typical long running operation, which depends on the LUN size and the load of the array. An upper bound in the specific deployment can be set to avoid unnecessary long wait. By default, it is 365 days long.</td>
      </tr>
      <tr>
        <td><option>enable_v1_api</option> = <replaceable>True</replaceable></td>
        <td>(BoolOpt) DEPRECATED: Deploy v1 of the Cinder API.</td>
      </tr>
      <tr>
        <td><option>enable_v2_api</option> = <replaceable>True</replaceable></td>
        <td>(BoolOpt) Deploy v2 of the Cinder API.</td>
      </tr>
      <tr>
        <td><option>extra_capabilities</option> = <replaceable>{}</replaceable></td>
        <td>(StrOpt) User defined capabilities, a JSON formatted string specifying key/value pairs. The key/value pairs can be used by the CapabilitiesFilter to select between backends when requests specify volume types. For example, specifying a service level or the geographical location of a backend, then creating a volume type to allow the user to select by these different properties.</td>
      </tr>
      <tr>
        <td><option>ignore_pool_full_threshold</option> = <replaceable>False</replaceable></td>
        <td>(BoolOpt) Force LUN creation even if the full threshold of pool is reached.</td>
      </tr>
      <tr>
        <td><option>management_ips</option> = <replaceable></replaceable></td>
        <td>(StrOpt) List of Management IP addresses (separated by commas)</td>
      </tr>
      <tr>
        <td><option>max_header_line</option> = <replaceable>16384</replaceable></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><option>osapi_max_limit</option> = <replaceable>1000</replaceable></td>
        <td>(IntOpt) The maximum number of items that a collection resource returns in a single response</td>
      </tr>
      <tr>
        <td><option>osapi_max_request_body_size</option> = <replaceable>114688</replaceable></td>
        <td>(IntOpt) Max size for body of a request</td>
      </tr>
      <tr>
        <td><option>osapi_volume_base_URL</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) Base URL that will be presented to users in links to the OpenStack Volume API</td>
      </tr>
      <tr>
        <td><option>osapi_volume_ext_list</option> = <replaceable></replaceable></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><option>osapi_volume_extension</option> = <replaceable>['cinder.api.contrib.standard_extensions']</replaceable></td>
        <td>(MultiStrOpt) osapi volume extension to load</td>
      </tr>
      <tr>
        <td><option>osapi_volume_listen</option> = <replaceable>0.0.0.0</replaceable></td>
        <td>(StrOpt) IP address on which OpenStack Volume API listens</td>
      </tr>
      <tr>
        <td><option>osapi_volume_listen_port</option> = <replaceable>8776</replaceable></td>
        <td>(IntOpt) Port on which OpenStack Volume API listens</td>
      </tr>
      <tr>
        <td><option>osapi_volume_workers</option> = <replaceable>None</replaceable></td>
        <td>(IntOpt) Number of workers for OpenStack Volume API service. The default is equal to the number of CPUs available.</td>
      </tr>
      <tr>
        <td><option>per_volume_size_limit</option> = <replaceable>-1</replaceable></td>
        <td>(IntOpt) Max size allowed per volume, in gigabytes</td>
      </tr>
      <tr>
        <td><option>public_endpoint</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) Public url to use for versions endpoint. The default is None, which will use the request's host_url attribute to populate the URL base. If Cinder is operating behind a proxy, you will want to change this to represent the proxy's URL.</td>
      </tr>
      <tr>
        <td><option>query_volume_filters</option> = <replaceable>name, status, metadata, availability_zone</replaceable></td>
        <td>(ListOpt) Volume filter options which non-admin user could use to query volumes. Default values are: ['name', 'status', 'metadata', 'availability_zone']</td>
      </tr>
      <tr>
        <td><option>transfer_api_class</option> = <replaceable>cinder.transfer.api.API</replaceable></td>
        <td>(StrOpt) The full class name of the volume transfer API class</td>
      </tr>
      <tr>
        <td><option>volume_api_class</option> = <replaceable>cinder.volume.api.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>volume-%s</replaceable></td>
        <td>(StrOpt) Template string to be used to generate volume names</td>
      </tr>
      <tr>
        <td><option>volume_number_multiplier</option> = <replaceable>-1.0</replaceable></td>
        <td>(FloatOpt) Multiplier used for weighing volume number. Negative numbers mean to spread vs stack.</td>
      </tr>
      <tr>
        <td><option>volume_transfer_key_length</option> = <replaceable>16</replaceable></td>
        <td>(IntOpt) The number of characters in the autogenerated auth key.</td>
      </tr>
      <tr>
        <td><option>volume_transfer_salt_length</option> = <replaceable>8</replaceable></td>
        <td>(IntOpt) The number of characters in the salt.</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>
      <tr>
        <th colspan="2">[oslo_versionedobjects]</th>
      </tr>
      <tr>
        <td><option>fatal_exception_format_errors</option> = <replaceable>False</replaceable></td>
        <td>(BoolOpt) Make exception message format errors fatal</td>
      </tr>
    </tbody>
  </table>
</para>