openstack-manuals/doc/common/tables/manila-rabbitmq.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_manila_rabbitmq">
    <caption>Description of RabbitMQ 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">[oslo_messaging_rabbit]</th>
      </tr>
      <tr>
        <td><option>amqp_auto_delete</option> = <replaceable>False</replaceable></td>
        <td>(BoolOpt) Auto-delete queues in AMQP.</td>
      </tr>
      <tr>
        <td><option>amqp_durable_queues</option> = <replaceable>False</replaceable></td>
        <td>(BoolOpt) Use durable queues in AMQP.</td>
      </tr>
      <tr>
        <td><option>fake_rabbit</option> = <replaceable>False</replaceable></td>
        <td>(BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake</td>
      </tr>
      <tr>
        <td><option>heartbeat_rate</option> = <replaceable>2</replaceable></td>
        <td>(IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat.</td>
      </tr>
      <tr>
        <td><option>heartbeat_timeout_threshold</option> = <replaceable>60</replaceable></td>
        <td>(IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disable the heartbeat). EXPERIMENTAL</td>
      </tr>
      <tr>
        <td><option>kombu_reconnect_delay</option> = <replaceable>1.0</replaceable></td>
        <td>(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.</td>
      </tr>
      <tr>
        <td><option>kombu_reconnect_timeout</option> = <replaceable>60</replaceable></td>
        <td>(IntOpt) How long to wait before considering a reconnect attempt to have failed. This value should not be longer than rpc_response_timeout.</td>
      </tr>
      <tr>
        <td><option>kombu_ssl_ca_certs</option> = <replaceable></replaceable></td>
        <td>(StrOpt) SSL certification authority file (valid only if SSL enabled).</td>
      </tr>
      <tr>
        <td><option>kombu_ssl_certfile</option> = <replaceable></replaceable></td>
        <td>(StrOpt) SSL cert file (valid only if SSL enabled).</td>
      </tr>
      <tr>
        <td><option>kombu_ssl_keyfile</option> = <replaceable></replaceable></td>
        <td>(StrOpt) SSL key file (valid only if SSL enabled).</td>
      </tr>
      <tr>
        <td><option>kombu_ssl_version</option> = <replaceable></replaceable></td>
        <td>(StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions.</td>
      </tr>
      <tr>
        <td><option>rabbit_ha_queues</option> = <replaceable>False</replaceable></td>
        <td>(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database.</td>
      </tr>
      <tr>
        <td><option>rabbit_host</option> = <replaceable>localhost</replaceable></td>
        <td>(StrOpt) The RabbitMQ broker address where a single node is used.</td>
      </tr>
      <tr>
        <td><option>rabbit_hosts</option> = <replaceable>$rabbit_host:$rabbit_port</replaceable></td>
        <td>(ListOpt) RabbitMQ HA cluster host:port pairs.</td>
      </tr>
      <tr>
        <td><option>rabbit_login_method</option> = <replaceable>AMQPLAIN</replaceable></td>
        <td>(StrOpt) The RabbitMQ login method.</td>
      </tr>
      <tr>
        <td><option>rabbit_max_retries</option> = <replaceable>0</replaceable></td>
        <td>(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).</td>
      </tr>
      <tr>
        <td><option>rabbit_password</option> = <replaceable>guest</replaceable></td>
        <td>(StrOpt) The RabbitMQ password.</td>
      </tr>
      <tr>
        <td><option>rabbit_port</option> = <replaceable>5672</replaceable></td>
        <td>(IntOpt) The RabbitMQ broker port where a single node is used.</td>
      </tr>
      <tr>
        <td><option>rabbit_retry_backoff</option> = <replaceable>2</replaceable></td>
        <td>(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.</td>
      </tr>
      <tr>
        <td><option>rabbit_retry_interval</option> = <replaceable>1</replaceable></td>
        <td>(IntOpt) How frequently to retry connecting with RabbitMQ.</td>
      </tr>
      <tr>
        <td><option>rabbit_use_ssl</option> = <replaceable>False</replaceable></td>
        <td>(BoolOpt) Connect over SSL for RabbitMQ.</td>
      </tr>
      <tr>
        <td><option>rabbit_userid</option> = <replaceable>guest</replaceable></td>
        <td>(StrOpt) The RabbitMQ userid.</td>
      </tr>
      <tr>
        <td><option>rabbit_virtual_host</option> = <replaceable>/</replaceable></td>
        <td>(StrOpt) The RabbitMQ virtual host.</td>
      </tr>
      <tr>
        <td><option>send_single_reply</option> = <replaceable>False</replaceable></td>
        <td>(BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release.</td>
      </tr>
    </tbody>
  </table>
</para>