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