openstack-manuals/doc/common/tables/nova-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_nova_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 nova-api</td>
      </tr>
      <tr>
        <td><option>api_rate_limit</option> = <replaceable>False</replaceable></td>
        <td>(BoolOpt) Whether to use per-user rate limiting for the api. This option is only used by v2 api. Rate limiting is removed from v3 api.</td>
      </tr>
      <tr>
        <td><option>client_socket_timeout</option> = <replaceable>900</replaceable></td>
        <td>(IntOpt) Timeout for client connections' socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of '0' means wait forever.</td>
      </tr>
      <tr>
        <td><option>enable_new_services</option> = <replaceable>True</replaceable></td>
        <td>(BoolOpt) Services to be added to the available pool on create</td>
      </tr>
      <tr>
        <td><option>enabled_apis</option> = <replaceable>ec2, osapi_compute, metadata</replaceable></td>
        <td>(ListOpt) A list of APIs to enable by default</td>
      </tr>
      <tr>
        <td><option>enabled_ssl_apis</option> = <replaceable></replaceable></td>
        <td>(ListOpt) A list of APIs with enabled SSL</td>
      </tr>
      <tr>
        <td><option>instance_name_template</option> = <replaceable>instance-%08x</replaceable></td>
        <td>(StrOpt) Template string to be used to generate instance names</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>multi_instance_display_name_template</option> = <replaceable>%(name)s-%(count)d</replaceable></td>
        <td>(StrOpt) When creating multiple instances with a single request using the os-multiple-create API extension, this template will be used to build the display name for each instance. The benefit is that the instances end up with different hostnames. To restore legacy behavior of every instance having the same name, set this option to "%(name)s".  Valid keys for the template are: name, uuid, count.</td>
      </tr>
      <tr>
        <td><option>non_inheritable_image_properties</option> = <replaceable>cache_in_nova, bittorrent</replaceable></td>
        <td>(ListOpt) These are image properties which a snapshot should not inherit from an instance</td>
      </tr>
      <tr>
        <td><option>null_kernel</option> = <replaceable>nokernel</replaceable></td>
        <td>(StrOpt) Kernel image that indicates not to use a kernel, but to use a raw disk image instead</td>
      </tr>
      <tr>
        <td><option>osapi_compute_ext_list</option> = <replaceable></replaceable></td>
        <td>(ListOpt) Specify list of extensions to load when using osapi_compute_extension option with nova.api.openstack.compute.contrib.select_extensions</td>
      </tr>
      <tr>
        <td><option>osapi_compute_extension</option> = <replaceable>['nova.api.openstack.compute.contrib.standard_extensions']</replaceable></td>
        <td>(MultiStrOpt) osapi compute extension to load</td>
      </tr>
      <tr>
        <td><option>osapi_compute_link_prefix</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) Base URL that will be presented to users in links to the OpenStack Compute API</td>
      </tr>
      <tr>
        <td><option>osapi_compute_listen</option> = <replaceable>0.0.0.0</replaceable></td>
        <td>(StrOpt) The IP address on which the OpenStack API will listen.</td>
      </tr>
      <tr>
        <td><option>osapi_compute_listen_port</option> = <replaceable>8774</replaceable></td>
        <td>(IntOpt) The port on which the OpenStack API will listen.</td>
      </tr>
      <tr>
        <td><option>osapi_compute_workers</option> = <replaceable>None</replaceable></td>
        <td>(IntOpt) Number of workers for OpenStack API service. The default will be the number of CPUs available.</td>
      </tr>
      <tr>
        <td><option>osapi_hide_server_address_states</option> = <replaceable>building</replaceable></td>
        <td>(ListOpt) List of instance states that should hide network info</td>
      </tr>
      <tr>
        <td><option>servicegroup_driver</option> = <replaceable>db</replaceable></td>
        <td>(StrOpt) The driver for servicegroup service (valid options are: db, zk, mc)</td>
      </tr>
      <tr>
        <td><option>snapshot_name_template</option> = <replaceable>snapshot-%s</replaceable></td>
        <td>(StrOpt) Template string to be used to generate snapshot names</td>
      </tr>
      <tr>
        <td><option>tcp_keepidle</option> = <replaceable>600</replaceable></td>
        <td>(IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X.</td>
      </tr>
      <tr>
        <td><option>use_forwarded_for</option> = <replaceable>False</replaceable></td>
        <td>(BoolOpt) Treat X-Forwarded-For as the canonical remote address. Only enable this if you have a sanitizing proxy.</td>
      </tr>
      <tr>
        <td><option>wsgi_default_pool_size</option> = <replaceable>1000</replaceable></td>
        <td>(IntOpt) Size of the pool of greenthreads used by wsgi</td>
      </tr>
      <tr>
        <td><option>wsgi_keep_alive</option> = <replaceable>True</replaceable></td>
        <td>(BoolOpt) If False, closes the client socket connection explicitly.</td>
      </tr>
      <tr>
        <td><option>wsgi_log_format</option> = <replaceable>%(client_ip)s "%(request_line)s" status: %(status_code)s len: %(body_length)s time: %(wall_seconds).7f</replaceable></td>
        <td>(StrOpt) A python format string that is used as the template to generate log lines. The following values can be formatted into it: client_ip, date_time, request_line, status_code, body_length, wall_seconds.</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_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>