openstack-manuals/doc/common/tables/ironic-api.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_ironic_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">[api]</th>
      </tr>
      <tr>
        <td><option>host_ip</option> = <replaceable>0.0.0.0</replaceable></td>
        <td>(StrOpt) The IP address on which ironic-api listens.</td>
      </tr>
      <tr>
        <td><option>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>port</option> = <replaceable>6385</replaceable></td>
        <td>(IntOpt) The TCP port on which ironic-api listens.</td>
      </tr>
      <tr>
        <td><option>public_endpoint</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) Public URL to use when building the links to the API resources (for example, "https://ironic.rocks:6384"). If None the links will be built using the request's host URL. If the API is operating behind a proxy, you will want to change this to represent the proxy's URL. Defaults to None.</td>
      </tr>
      <tr>
        <th colspan="2">[cors]</th>
      </tr>
      <tr>
        <td><option>allow_credentials</option> = <replaceable>True</replaceable></td>
        <td>(BoolOpt) Indicate that the actual request can include user credentials</td>
      </tr>
      <tr>
        <td><option>allow_headers</option> = <replaceable>Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma</replaceable></td>
        <td>(ListOpt) Indicate which header field names may be used during the actual request.</td>
      </tr>
      <tr>
        <td><option>allow_methods</option> = <replaceable>GET, POST, PUT, DELETE, OPTIONS</replaceable></td>
        <td>(ListOpt) Indicate which methods can be used during the actual request.</td>
      </tr>
      <tr>
        <td><option>allowed_origin</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header.</td>
      </tr>
      <tr>
        <td><option>expose_headers</option> = <replaceable>Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma</replaceable></td>
        <td>(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.</td>
      </tr>
      <tr>
        <td><option>max_age</option> = <replaceable>3600</replaceable></td>
        <td>(IntOpt) Maximum cache age of CORS preflight requests.</td>
      </tr>
      <tr>
        <th colspan="2">[cors.subdomain]</th>
      </tr>
      <tr>
        <td><option>allow_credentials</option> = <replaceable>True</replaceable></td>
        <td>(BoolOpt) Indicate that the actual request can include user credentials</td>
      </tr>
      <tr>
        <td><option>allow_headers</option> = <replaceable>Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma</replaceable></td>
        <td>(ListOpt) Indicate which header field names may be used during the actual request.</td>
      </tr>
      <tr>
        <td><option>allow_methods</option> = <replaceable>GET, POST, PUT, DELETE, OPTIONS</replaceable></td>
        <td>(ListOpt) Indicate which methods can be used during the actual request.</td>
      </tr>
      <tr>
        <td><option>allowed_origin</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header.</td>
      </tr>
      <tr>
        <td><option>expose_headers</option> = <replaceable>Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma</replaceable></td>
        <td>(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.</td>
      </tr>
      <tr>
        <td><option>max_age</option> = <replaceable>3600</replaceable></td>
        <td>(IntOpt) Maximum cache age of CORS preflight requests.</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>