..
    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.

.. _trove-api:

.. list-table:: Description of API configuration options
   :header-rows: 1
   :class: config-ref-table

   * - Configuration option = Default value
     - Description
   * - **[DEFAULT]**
     -
   * - ``admin_roles`` = ``admin``
     - (List) Roles to add to an admin user.
   * - ``api_paste_config`` = ``api-paste.ini``
     - (String) File name for the paste.deploy config for trove-api.
   * - ``bind_host`` = ``0.0.0.0``
     - (IP) IP address the API server will listen on.
   * - ``bind_port`` = ``8779``
     - (Port number) Port the API server will listen on.
   * - ``black_list_regex`` = ``None``
     - (String) Exclude IP addresses that match this regular expression.
   * - ``db_api_implementation`` = ``trove.db.sqlalchemy.api``
     - (String) API Implementation for Trove database access.
   * - ``hostname_require_valid_ip`` = ``True``
     - (Boolean) Require user hostnames to be valid IP addresses.
   * - ``http_delete_rate`` = ``200``
     - (Integer) Maximum number of HTTP 'DELETE' requests (per minute).
   * - ``http_get_rate`` = ``200``
     - (Integer) Maximum number of HTTP 'GET' requests (per minute).
   * - ``http_mgmt_post_rate`` = ``200``
     - (Integer) Maximum number of management HTTP 'POST' requests (per minute).
   * - ``http_post_rate`` = ``200``
     - (Integer) Maximum number of HTTP 'POST' requests (per minute).
   * - ``http_put_rate`` = ``200``
     - (Integer) Maximum number of HTTP 'PUT' requests (per minute).
   * - ``injected_config_location`` = ``/etc/trove/conf.d``
     - (String) Path to folder on the Guest where config files will be injected during instance creation.
   * - ``instances_page_size`` = ``20``
     - (Integer) Page size for listing instances.
   * - ``max_header_line`` = ``16384``
     - (Integer) 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).
   * - ``os_region_name`` = ``RegionOne``
     - (String) Region name of this node. Used when searching catalog.
   * - ``region`` = ``LOCAL_DEV``
     - (String) The region this service is located.
   * - ``tcp_keepidle`` = ``600``
     - (Integer) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X.
   * - ``trove_api_workers`` = ``None``
     - (Integer) Number of workers for the API service. The default will be the number of CPUs available.
   * - ``trove_auth_url`` = ``http://0.0.0.0:5000/v2.0``
     - (URI) Trove authentication URL.
   * - ``trove_conductor_workers`` = ``None``
     - (Integer) Number of workers for the Conductor service. The default will be the number of CPUs available.
   * - ``trove_security_group_name_prefix`` = ``SecGroup``
     - (String) Prefix to use when creating Security Groups.
   * - ``trove_security_group_rule_cidr`` = ``0.0.0.0/0``
     - (String) CIDR to use when creating Security Group Rules.
   * - ``trove_security_groups_support`` = ``True``
     - (Boolean) Whether Trove should add Security Groups on create.
   * - ``users_page_size`` = ``20``
     - (Integer) Page size for listing users.
   * - **[oslo_middleware]**
     -
   * - ``enable_proxy_headers_parsing`` = ``False``
     - (Boolean) Whether the application is behind a proxy or not. This determines if the middleware should parse the headers or not.
   * - ``max_request_body_size`` = ``114688``
     - (Integer) The maximum body size for each request, in bytes.
   * - ``secure_proxy_ssl_header`` = ``X-Forwarded-Proto``
     - (String) DEPRECATED: The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by a SSL termination proxy.