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

.. _senlin-api:

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

   * - Configuration option = Default value
     - Description
   * - **[authentication]**
     -
   * - ``auth_url`` =
     - (String) Complete public identity V3 API endpoint.
   * - ``service_password`` =
     - (String) Password specified for the Senlin service user.
   * - ``service_project_domain`` = ``Default``
     - (String) Name of the domain for the service project.
   * - ``service_project_name`` = ``service``
     - (String) Name of the service project.
   * - ``service_user_domain`` = ``Default``
     - (String) Name of the domain for the service user.
   * - ``service_username`` = ``senlin``
     - (String) Senlin service user name
   * - **[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.
   * - **[oslo_policy]**
     -
   * - ``policy_default_rule`` = ``default``
     - (String) Default rule. Enforced when a requested rule is not found.
   * - ``policy_dirs`` = ``['policy.d']``
     - (Multi-valued) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.
   * - ``policy_file`` = ``policy.json``
     - (String) The JSON file that defines policies.
   * - **[revision]**
     -
   * - ``senlin_api_revision`` = ``1.0``
     - (String) Senlin API revision.
   * - ``senlin_engine_revision`` = ``1.0``
     - (String) Senlin engine revision.
   * - **[senlin_api]**
     -
   * - ``api_paste_config`` = ``api-paste.ini``
     - (String) The API paste config file to use.
   * - ``backlog`` = ``4096``
     - (Integer) Number of backlog requests to configure the socket with.
   * - ``bind_host`` = ``0.0.0.0``
     - (IP) Address to bind the server. Useful when selecting a particular network interface.
   * - ``bind_port`` = ``8778``
     - (Port number) The port on which the server will listen.
   * - ``cert_file`` = ``None``
     - (String) Location of the SSL certificate file to use for SSL mode.
   * - ``client_socket_timeout`` = ``900``
     - (Integer) 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' indicates waiting forever.
   * - ``key_file`` = ``None``
     - (String) Location of the SSL key file to use for enabling SSL mode.
   * - ``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).
   * - ``max_json_body_size`` = ``1048576``
     - (Integer) Maximum raw byte size of JSON request body. Should be larger than max_template_size.
   * - ``tcp_keepidle`` = ``600``
     - (Integer) The value for the socket option TCP_KEEPIDLE. This is the time in seconds that the connection must be idle before TCP starts sending keepalive probes.
   * - ``workers`` = ``0``
     - (Integer) Number of workers for Senlin service.
   * - ``wsgi_keep_alive`` = ``True``
     - (Boolean) If false, closes the client socket explicitly.