openstack-manuals/doc/common/tables/manila-rpc.xml

<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
  <!--
###################################################################
 WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################

     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.

###################################################################
 WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
  <table rules="all" xml:id="config_table_manila_rpc">
    <caption>Description of RPC 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><option>rpc_backend</option> = <replaceable>rabbit</replaceable></td>
        <td>(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq.</td>
      </tr>
      <tr>
        <td><option>rpc_cast_timeout</option> = <replaceable>30</replaceable></td>
        <td>(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq.</td>
      </tr>
      <tr>
        <td><option>rpc_conn_pool_size</option> = <replaceable>30</replaceable></td>
        <td>(IntOpt) Size of RPC connection pool.</td>
      </tr>
      <tr>
        <td><option>rpc_poll_timeout</option> = <replaceable>1</replaceable></td>
        <td>(IntOpt) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired.</td>
      </tr>
      <tr>
        <td><option>rpc_response_timeout</option> = <replaceable>60</replaceable></td>
        <td>(IntOpt) Seconds to wait for a response from a call.</td>
      </tr>
      <tr>
        <td><option>share_topic</option> = <replaceable>manila-share</replaceable></td>
        <td>(StrOpt) The topic share nodes listen on.</td>
      </tr>
      <tr>
        <th colspan="2">[oslo_concurrency]</th>
      </tr>
      <tr>
        <td><option>disable_process_locking</option> = <replaceable>False</replaceable></td>
        <td>(BoolOpt) Enables or disables inter-process locks.</td>
      </tr>
      <tr>
        <td><option>lock_path</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) 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.</td>
      </tr>
      <tr>
        <th colspan="2">[oslo_messaging_amqp]</th>
      </tr>
      <tr>
        <td><option>allow_insecure_clients</option> = <replaceable>False</replaceable></td>
        <td>(BoolOpt) Accept clients using either SSL or plain TCP</td>
      </tr>
      <tr>
        <td><option>broadcast_prefix</option> = <replaceable>broadcast</replaceable></td>
        <td>(StrOpt) address prefix used when broadcasting to all servers</td>
      </tr>
      <tr>
        <td><option>container_name</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) Name for the AMQP container</td>
      </tr>
      <tr>
        <td><option>group_request_prefix</option> = <replaceable>unicast</replaceable></td>
        <td>(StrOpt) address prefix when sending to any server in group</td>
      </tr>
      <tr>
        <td><option>idle_timeout</option> = <replaceable>0</replaceable></td>
        <td>(IntOpt) Timeout for inactive connections (in seconds)</td>
      </tr>
      <tr>
        <td><option>password</option> = <replaceable></replaceable></td>
        <td>(StrOpt) Password for message broker authentication</td>
      </tr>
      <tr>
        <td><option>sasl_config_dir</option> = <replaceable></replaceable></td>
        <td>(StrOpt) Path to directory that contains the SASL configuration</td>
      </tr>
      <tr>
        <td><option>sasl_config_name</option> = <replaceable></replaceable></td>
        <td>(StrOpt) Name of configuration file (without .conf suffix)</td>
      </tr>
      <tr>
        <td><option>sasl_mechanisms</option> = <replaceable></replaceable></td>
        <td>(StrOpt) Space separated list of acceptable SASL mechanisms</td>
      </tr>
      <tr>
        <td><option>server_request_prefix</option> = <replaceable>exclusive</replaceable></td>
        <td>(StrOpt) address prefix used when sending to a specific server</td>
      </tr>
      <tr>
        <td><option>ssl_ca_file</option> = <replaceable></replaceable></td>
        <td>(StrOpt) CA certificate PEM file to verify server certificate</td>
      </tr>
      <tr>
        <td><option>ssl_cert_file</option> = <replaceable></replaceable></td>
        <td>(StrOpt) Identifying certificate PEM file to present to clients</td>
      </tr>
      <tr>
        <td><option>ssl_key_file</option> = <replaceable></replaceable></td>
        <td>(StrOpt) Private key PEM file used to sign cert_file certificate</td>
      </tr>
      <tr>
        <td><option>ssl_key_password</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) Password for decrypting ssl_key_file (if encrypted)</td>
      </tr>
      <tr>
        <td><option>trace</option> = <replaceable>False</replaceable></td>
        <td>(BoolOpt) Debug: dump AMQP frames to stdout</td>
      </tr>
      <tr>
        <td><option>username</option> = <replaceable></replaceable></td>
        <td>(StrOpt) User name for message broker authentication</td>
      </tr>
    </tbody>
  </table>
</para>