openstack-manuals/doc/common/tables/trove-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_trove_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>admin_roles</option> = <replaceable>admin</replaceable></td>
        <td>(ListOpt) Roles to add to an admin user.</td>
      </tr>
      <tr>
        <td><option>api_paste_config</option> = <replaceable>api-paste.ini</replaceable></td>
        <td>(StrOpt) File name for the paste.deploy config for trove-api.</td>
      </tr>
      <tr>
        <td><option>bind_host</option> = <replaceable>0.0.0.0</replaceable></td>
        <td>(StrOpt) IP address the API server will listen on.</td>
      </tr>
      <tr>
        <td><option>bind_port</option> = <replaceable>8779</replaceable></td>
        <td>(IntOpt) Port the API server will listen on.</td>
      </tr>
      <tr>
        <td><option>black_list_regex</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) Exclude IP addresses that match this regular expression.</td>
      </tr>
      <tr>
        <td><option>db_api_implementation</option> = <replaceable>trove.db.sqlalchemy.api</replaceable></td>
        <td>(StrOpt) API Implementation for Trove database access.</td>
      </tr>
      <tr>
        <td><option>hostname_require_valid_ip</option> = <replaceable>True</replaceable></td>
        <td>(BoolOpt) Require user hostnames to be valid IP addresses.</td>
      </tr>
      <tr>
        <td><option>http_delete_rate</option> = <replaceable>200</replaceable></td>
        <td>(IntOpt) Maximum number of HTTP 'DELETE' requests (per minute).</td>
      </tr>
      <tr>
        <td><option>http_get_rate</option> = <replaceable>200</replaceable></td>
        <td>(IntOpt) Maximum number of HTTP 'GET' requests (per minute).</td>
      </tr>
      <tr>
        <td><option>http_mgmt_post_rate</option> = <replaceable>200</replaceable></td>
        <td>(IntOpt) Maximum number of management HTTP 'POST' requests (per minute).</td>
      </tr>
      <tr>
        <td><option>http_post_rate</option> = <replaceable>200</replaceable></td>
        <td>(IntOpt) Maximum number of HTTP 'POST' requests (per minute).</td>
      </tr>
      <tr>
        <td><option>http_put_rate</option> = <replaceable>200</replaceable></td>
        <td>(IntOpt) Maximum number of HTTP 'PUT' requests (per minute).</td>
      </tr>
      <tr>
        <td><option>instances_page_size</option> = <replaceable>20</replaceable></td>
        <td>(IntOpt) Page size for listing instances.</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>os_region_name</option> = <replaceable>RegionOne</replaceable></td>
        <td>(StrOpt) Region name of this node. Used when searching catalog.</td>
      </tr>
      <tr>
        <td><option>region</option> = <replaceable>LOCAL_DEV</replaceable></td>
        <td>(StrOpt) The region this service is located.</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>trove_api_workers</option> = <replaceable>None</replaceable></td>
        <td>(IntOpt) Number of workers for the API service. The default will be the number of CPUs available.</td>
      </tr>
      <tr>
        <td><option>trove_auth_url</option> = <replaceable>http://0.0.0.0:5000/v2.0</replaceable></td>
        <td>(StrOpt) Trove authentication URL.</td>
      </tr>
      <tr>
        <td><option>trove_conductor_workers</option> = <replaceable>None</replaceable></td>
        <td>(IntOpt) Number of workers for the Conductor service. The default will be the number of CPUs available.</td>
      </tr>
      <tr>
        <td><option>trove_security_group_name_prefix</option> = <replaceable>SecGroup</replaceable></td>
        <td>(StrOpt) Prefix to use when creating Security Groups.</td>
      </tr>
      <tr>
        <td><option>trove_security_group_rule_cidr</option> = <replaceable>0.0.0.0/0</replaceable></td>
        <td>(StrOpt) CIDR to use when creating Security Group Rules.</td>
      </tr>
      <tr>
        <td><option>trove_security_groups_support</option> = <replaceable>True</replaceable></td>
        <td>(BoolOpt) Whether Trove should add Security Groups on create.</td>
      </tr>
      <tr>
        <td><option>users_page_size</option> = <replaceable>20</replaceable></td>
        <td>(IntOpt) Page size for listing users.</td>
      </tr>
    </tbody>
  </table>
</para>