openstack-manuals/doc/config-reference/compute/section_rpc.xml
Gauvain Pocentek a8e0a7f97d Rework the config reference tables
Try to use the same categories for options found in multiple projects.

Change-Id: If582194081854b06542ca32335c6225ac94de013
Closes-Bug: #1363485
2014-10-03 08:39:38 +02:00

93 lines
4.8 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="configuring-rpc">
<?dbhtml stop-chunking?>
<title>Configure the Oslo RPC messaging system</title>
<para>OpenStack projects use AMQP, an open standard for messaging
middleware. OpenStack services that run on multiple servers to
talk to each other. OpenStack Oslo RPC supports three
implementations of AMQP: <application>RabbitMQ</application>,
<application>Qpid</application>, and
<application>ZeroMQ</application>.</para>
<section xml:id="configuration-rabbitmq">
<title>Configure RabbitMQ</title>
<para>OpenStack Oslo RPC uses <application>RabbitMQ</application>
by default. Use these options to configure the
<application>RabbitMQ</application> message system. The
<literal>rpc_backend</literal> option is not required as long
as <application>RabbitMQ</application> is the default messaging
system. However, if it is included the configuration, you must
set it to
<literal>nova.openstack.common.rpc.impl_kombu</literal>.</para>
<programlisting language="ini">rpc_backend=nova.openstack.common.rpc.impl_kombu</programlisting>
<para>You can use these additional options to configure the
<application>RabbitMQ</application> messaging system. You can
configure messaging communication for different installation
scenarios, tune retries for RabbitMQ, and define the size of the
RPC thread pool. To monitor notifications through RabbitMQ, you
must set the <option>notification_driver</option> option to
<literal>nova.openstack.common.notifier.rpc_notifier</literal> in the
<filename>nova.conf</filename> file. The default for sending
usage data is sixty seconds plus a random number of seconds from
zero to sixty.</para>
<xi:include href="../../common/tables/nova-rabbitmq.xml"/>
</section>
<section xml:id="configuration-qpid">
<title>Configure Qpid</title>
<para>Use these options to configure the
<application>Qpid</application> messaging system for OpenStack
Oslo RPC. <application>Qpid</application> is not the default
messaging system, so you must enable it by setting the
<option>rpc_backend</option> option in the
<filename>nova.conf</filename> file.</para>
<programlisting language="ini">rpc_backend=nova.openstack.common.rpc.impl_qpid</programlisting>
<para>This critical option points the compute nodes to the
<application>Qpid</application> broker (server). Set
<option>qpid_hostname</option> to the host name where the
broker runs in the <filename>nova.conf</filename> file.</para>
<note>
<para>The <parameter>--qpid_hostname</parameter> option accepts a host
name or IP address value.</para>
</note>
<programlisting language="ini">qpid_hostname=hostname.example.com</programlisting>
<para>If the <application>Qpid</application> broker listens on a
port other than the AMQP default of <literal>5672</literal>, you
must set the <option>qpid_port</option> option to that
value:</para>
<programlisting language="ini">qpid_port=12345</programlisting>
<para>If you configure the <application>Qpid</application> broker
to require authentication, you must add a user name and password
to the configuration:</para>
<programlisting language="ini">qpid_username=username
qpid_password=password</programlisting>
<para>By default, TCP is used as the transport. To enable SSL, set
the <option>qpid_protocol</option> option:</para>
<programlisting language="ini">qpid_protocol=ssl</programlisting>
<para>This table lists additional options that you use to
configure the Qpid messaging driver for OpenStack Oslo RPC.
These options are used infrequently.</para>
<xi:include href="../../common/tables/nova-qpid.xml"/>
</section>
<section xml:id="configuration-zeromq">
<title>Configure ZeroMQ</title>
<para>Use these options to configure the
<application>ZeroMQ</application> messaging system for
OpenStack Oslo RPC. <application>ZeroMQ</application> is not the
default messaging system, so you must enable it by setting the
<option>rpc_backend</option> option in the
<filename>nova.conf</filename> file.</para>
<xi:include href="../../common/tables/nova-zeromq.xml"/>
</section>
<section xml:id="common-messaging-configuration">
<title>Configure messaging</title>
<para>Use these options to configure the
<application>RabbitMQ</application> and
<application>Qpid</application> messaging drivers.</para>
<xi:include href="../../common/tables/nova-amqp.xml"/>
<xi:include href="../../common/tables/nova-rpc.xml"/>
</section>
</section>