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

.. _heat-rpc:

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

   * - Configuration option = Default value
     - Description
   * - **[DEFAULT]**
     -
   * - ``engine_life_check_timeout`` = ``2``
     - (Integer) RPC timeout for the engine liveness check that is used for stack locking.
   * - ``rpc_backend`` = ``rabbit``
     - (String) The messaging driver to use, defaults to rabbit. Other drivers include amqp and zmq.
   * - ``rpc_cast_timeout`` = ``-1``
     - (Integer) Seconds to wait before a cast expires (TTL). The default value of -1 specifies an infinite linger period. The value of 0 specifies no linger period. Pending messages shall be discarded immediately when the socket is closed. Only supported by impl_zmq.
   * - ``rpc_conn_pool_size`` = ``30``
     - (Integer) Size of RPC connection pool.
   * - ``rpc_poll_timeout`` = ``1``
     - (Integer) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired.
   * - ``rpc_response_timeout`` = ``60``
     - (Integer) Seconds to wait for a response from a call.
   * - **[oslo_concurrency]**
     -
   * - ``disable_process_locking`` = ``False``
     - (Boolean) Enables or disables inter-process locks.
   * - ``lock_path`` = ``None``
     - (String) Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If external locks are used, a lock path must be set.
   * - **[oslo_messaging_amqp]**
     -
   * - ``allow_insecure_clients`` = ``False``
     - (Boolean) Accept clients using either SSL or plain TCP
   * - ``broadcast_prefix`` = ``broadcast``
     - (String) address prefix used when broadcasting to all servers
   * - ``container_name`` = ``None``
     - (String) Name for the AMQP container
   * - ``group_request_prefix`` = ``unicast``
     - (String) address prefix when sending to any server in group
   * - ``idle_timeout`` = ``0``
     - (Integer) Timeout for inactive connections (in seconds)
   * - ``password`` =
     - (String) Password for message broker authentication
   * - ``sasl_config_dir`` =
     - (String) Path to directory that contains the SASL configuration
   * - ``sasl_config_name`` =
     - (String) Name of configuration file (without .conf suffix)
   * - ``sasl_mechanisms`` =
     - (String) Space separated list of acceptable SASL mechanisms
   * - ``server_request_prefix`` = ``exclusive``
     - (String) address prefix used when sending to a specific server
   * - ``ssl_ca_file`` =
     - (String) CA certificate PEM file to verify server certificate
   * - ``ssl_cert_file`` =
     - (String) Identifying certificate PEM file to present to clients
   * - ``ssl_key_file`` =
     - (String) Private key PEM file used to sign cert_file certificate
   * - ``ssl_key_password`` = ``None``
     - (String) Password for decrypting ssl_key_file (if encrypted)
   * - ``trace`` = ``False``
     - (Boolean) Debug: dump AMQP frames to stdout
   * - ``username`` =
     - (String) User name for message broker authentication
   * - **[oslo_messaging_notifications]**
     -
   * - ``driver`` = ``[]``
     - (Multi-valued) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop
   * - ``topics`` = ``notifications``
     - (List) AMQP topic used for OpenStack notifications.
   * - ``transport_url`` = ``None``
     - (String) A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC.