Progress config reference for networking
This update structures and fleshes various sections of the configuration reference for networking and misc other changes, including: * making a new section for RPC as related to networking * splitting out plugin tables into a separate file * sectionin out tables for other sections * adding zeromq to the RPC section for compute patchset2/3: fixes whitespace patchset4 fixes based on review -thanks! Change-Id: Ic2dc88118f5057c985bfe4cf5671ac9c9f8b2c6e bp:restructure-documentation
This commit is contained in:
Tom Fifield
129
doc/src/docbkx/common/section_rpc-for-networking.xml
Normal file
129
doc/src/docbkx/common/section_rpc-for-networking.xml
Normal file
@@ -0,0 +1,129 @@
|
||||
<?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="networking-configuring-rpc">
|
||||
<?dbhtml stop-chunking?>
|
||||
<title>Configuring the Oslo RPC Messaging System</title>
|
||||
|
||||
<para>OpenStack projects use an open standard for messaging middleware
|
||||
known as AMQP. This messaging middleware enables the OpenStack
|
||||
services which will exist across 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="networking-configuration-rabbitmq">
|
||||
<title>Configuration for RabbitMQ</title>
|
||||
|
||||
<para>OpenStack Oslo RPC uses <application>RabbitMQ</application> by
|
||||
default. This section discusses the configuration options that are
|
||||
relevant when <application>RabbitMQ</application> is used. 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, it must be set to
|
||||
<literal>neutron.openstack.common.rpc.impl_kombu</literal>.</para>
|
||||
|
||||
|
||||
<programlisting language="bash">
|
||||
rpc_backend=neutron.openstack.common.rpc.impl_kombu
|
||||
</programlisting>
|
||||
|
||||
<para>The following tables describe the rest of the options that
|
||||
can be used when <application>RabbitMQ</application> is used
|
||||
as the messaging system. You can configure the messaging
|
||||
communication for different installation scenarios as well as
|
||||
tune RabbitMQ's retries and the size of the RPC thread pool.
|
||||
If you want to monitor notifications through RabbitMQ, you
|
||||
must set the <literal>notification_driver</literal> option in
|
||||
<filename>neutron.conf</filename> to
|
||||
<literal>neutron.notifier.rabbit_notifier</literal>.
|
||||
</para>
|
||||
|
||||
<xi:include href="tables/neutron-rabbitmq.xml"/>
|
||||
<xi:include href="tables/neutron-kombu.xml"/>
|
||||
</section>
|
||||
|
||||
<section xml:id="networking-configuration-qpid">
|
||||
<title>Configuration for Qpid</title>
|
||||
|
||||
<para>This section discusses the configuration options that are relevant
|
||||
if <application>Qpid</application> is used as the messaging system for
|
||||
OpenStack Oslo RPC. <application>Qpid</application> is not the default
|
||||
messaging system, so it must be enabled by setting the
|
||||
<literal>rpc_backend</literal> option in
|
||||
<filename>neutron.conf</filename>.</para>
|
||||
|
||||
<programlisting language="bash">
|
||||
rpc_backend=neutron.openstack.common.rpc.impl_qpid
|
||||
</programlisting>
|
||||
|
||||
<para>This next critical option points the compute nodes to the
|
||||
<application>Qpid</application> broker (server). Set
|
||||
<literal>qpid_hostname</literal> in <filename>neutron.conf</filename> to
|
||||
be the hostname where the broker is running.</para>
|
||||
|
||||
<note>
|
||||
<para>The -<literal>-qpid_hostname</literal> option accepts a value in
|
||||
the form of either a hostname or an IP address.</para>
|
||||
</note>
|
||||
|
||||
<programlisting language="bash">
|
||||
qpid_hostname=hostname.example.com
|
||||
</programlisting>
|
||||
|
||||
<para>If the <application>Qpid</application> broker is listening on a
|
||||
port other than the AMQP default of <literal>5672</literal>, you will
|
||||
need to set the <literal>qpid_port</literal> option:</para>
|
||||
|
||||
<programlisting language="bash">
|
||||
qpid_port=12345
|
||||
</programlisting>
|
||||
|
||||
<para>If you configure the <application>Qpid</application> broker to
|
||||
require authentication, you will need to add a username and password to
|
||||
the configuration:</para>
|
||||
|
||||
<programlisting language="bash">
|
||||
qpid_username=username
|
||||
qpid_password=password
|
||||
</programlisting>
|
||||
|
||||
<para>By default, TCP is used as the transport. If you would like to
|
||||
enable SSL, set the <literal>qpid_protocol</literal> option:</para>
|
||||
|
||||
<programlisting language="bash">
|
||||
qpid_protocol=ssl
|
||||
</programlisting>
|
||||
|
||||
<para>The following table lists the rest of the options used by the Qpid
|
||||
messaging driver for OpenStack Oslo RPC. It is not common that these
|
||||
options are used.</para>
|
||||
|
||||
<xi:include href="tables/neutron-qpid.xml"/>
|
||||
|
||||
</section>
|
||||
<section xml:id="networking-configuration-zeromq">
|
||||
<title>Configuration for ZeroMQ</title>
|
||||
<para>This section discusses the configuration options that are relevant
|
||||
if <application>ZeroMQ</application> is used as the messaging system for
|
||||
OpenStack Oslo RPC. <application>ZeroMQ</application> is not the default
|
||||
messaging system, so it must be enabled by setting the
|
||||
<literal>rpc_backend</literal> option in
|
||||
<filename>neutron.conf</filename>.</para>
|
||||
<xi:include href="tables/neutron-zeromq.xml"/>
|
||||
</section>
|
||||
<section xml:id="networking-common-messaging-configuration">
|
||||
<title>Common Configuration for Messaging</title>
|
||||
|
||||
<para>This section lists options that are common between the
|
||||
<application>RabbitMQ</application>, <application>Qpid</application>
|
||||
and <application>ZeroMq</application>
|
||||
messaging drivers.</para>
|
||||
|
||||
<xi:include href="tables/neutron-rpc.xml"/>
|
||||
<xi:include href="tables/neutron-notifier.xml"/>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
@@ -9,9 +9,10 @@
|
||||
<para>OpenStack projects use an open standard for messaging middleware
|
||||
known as AMQP. This messaging middleware enables the OpenStack
|
||||
services which will exist across multiple servers to talk to each other.
|
||||
OpenStack Oslo RPC supports two implementations of AMQP:
|
||||
<application>RabbitMQ</application> and
|
||||
<application>Qpid</application>.</para>
|
||||
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>Configuration for RabbitMQ</title>
|
||||
@@ -104,6 +105,18 @@ qpid_protocol=ssl
|
||||
<xi:include href="tables/nova-qpid.xml"/>
|
||||
|
||||
</section>
|
||||
<section xml:id="configuration-zeromq">
|
||||
<title>Configuration Options for ZeroMQ</title>
|
||||
<para>This section discusses the configuration options that are relevant
|
||||
if <application>ZeroMQ</application> is used as the messaging system for
|
||||
OpenStack Oslo RPC. <application>ZeroMQ</application> is not the default
|
||||
messaging system, so it must be enabled by setting the
|
||||
<literal>rpc_backend</literal> option in
|
||||
<filename>nova.conf</filename>.</para>
|
||||
|
||||
|
||||
<xi:include href="tables/nova-zeromq.xml"/>
|
||||
</section>
|
||||
|
||||
<section xml:id="common-messaging-configuration">
|
||||
<title>Common Configuration for Messaging</title>
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
<chapter 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="cli_help">
|
||||
xml:id="config_overview">
|
||||
<title>OpenStack Configuration Overview</title>
|
||||
<para>OpenStack is a collection of open source project to enable
|
||||
setting up cloud services. Each project uses similar
|
||||
|
||||
@@ -3,38 +3,96 @@
|
||||
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">
|
||||
<title>List of configuration options for Networking</title>
|
||||
<title>Configuration options for Networking</title>
|
||||
<para>These options and descriptions were generated from the code in
|
||||
the Networking service project which provides software defined networking
|
||||
between VMs run in Compute.</para>
|
||||
<xi:include href="../common/tables/neutron-agent.xml"/>
|
||||
<xi:include href="../common/tables/neutron-api.xml"/>
|
||||
<xi:include href="../common/tables/neutron-bigswitch.xml"/>
|
||||
<xi:include href="../common/tables/neutron-cisco.xml"/>
|
||||
between VMs run in Compute. Below are common options, and the sections
|
||||
following contain information about the various networking plugins and
|
||||
less-commonly altered sections.</para>
|
||||
|
||||
<xi:include href="../common/tables/neutron-common.xml"/>
|
||||
|
||||
<xi:include href="section_networking-plugins.xml"/>
|
||||
|
||||
<xi:include href="../common/section_rpc-for-networking.xml"/>
|
||||
|
||||
<section xml:id="networking-options-agent">
|
||||
<title>Agent</title>
|
||||
<para>Use the following options to alter agent-related settings.</para>
|
||||
<xi:include href="../common/tables/neutron-agent.xml"/>
|
||||
</section>
|
||||
|
||||
<section xml:id="networking-options-api">
|
||||
<title>API</title>
|
||||
<para>Use the following options to alter API-related settings.</para>
|
||||
<xi:include href="../common/tables/neutron-api.xml"/>
|
||||
</section>
|
||||
|
||||
<section xml:id="networking-options-db">
|
||||
<title>Database</title>
|
||||
<para>Use the following options to alter Database-related settings.</para>
|
||||
<xi:include href="../common/tables/neutron-db.xml"/>
|
||||
<xi:include href="../common/tables/neutron-hyperv.xml"/>
|
||||
<xi:include href="../common/tables/neutron-kombu.xml"/>
|
||||
<xi:include href="../common/tables/neutron-linuxbridge.xml"/>
|
||||
</section>
|
||||
|
||||
<section xml:id="networking-options-logging">
|
||||
<title>Logging</title>
|
||||
<para>Use the following options to alter logging settings.</para>
|
||||
<xi:include href="../common/tables/neutron-logging.xml"/>
|
||||
<xi:include href="../common/tables/neutron-meta.xml"/>
|
||||
</section>
|
||||
|
||||
<section xml:id="networking-options-metadata">
|
||||
<title>Metadata Agent</title>
|
||||
<para>Use the following options in the
|
||||
<filename>metadata_agent.ini</filename> file for the Metadata agent.</para>
|
||||
<xi:include href="../common/tables/neutron-metadata.xml"/>
|
||||
<xi:include href="../common/tables/neutron-midonet.xml"/>
|
||||
<xi:include href="../common/tables/neutron-nec.xml"/>
|
||||
<xi:include href="../common/tables/neutron-nicira.xml"/>
|
||||
<xi:include href="../common/tables/neutron-notifier.xml"/>
|
||||
<xi:include href="../common/tables/neutron-openvswitch.xml"/>
|
||||
<xi:include href="../common/tables/neutron-plumgrid.xml"/>
|
||||
</section>
|
||||
|
||||
<section xml:id="networking-options-policy">
|
||||
<title>Policy</title>
|
||||
<para>Use the following options in the
|
||||
<filename>neutron.conf</filename> file to change policy settings.</para>
|
||||
<xi:include href="../common/tables/neutron-policy.xml"/>
|
||||
<xi:include href="../common/tables/neutron-qpid.xml"/>
|
||||
</section>
|
||||
|
||||
<section xml:id="networking-options-quotas">
|
||||
<title>Quotas</title>
|
||||
<para>Use the following options in the
|
||||
<filename>neutron.conf</filename> file for the quota system.</para>
|
||||
<xi:include href="../common/tables/neutron-quotas.xml"/>
|
||||
<xi:include href="../common/tables/neutron-rabbitmq.xml"/>
|
||||
<xi:include href="../common/tables/neutron-rpc.xml"/>
|
||||
<xi:include href="../common/tables/neutron-ryu.xml"/>
|
||||
</section>
|
||||
|
||||
<section xml:id="networking-options-scheduler">
|
||||
<title>Scheduler</title>
|
||||
<para>Use the following options in the
|
||||
<filename>neutron.conf</filename> file to change scheduler settings.</para>
|
||||
<xi:include href="../common/tables/neutron-scheduler.xml"/>
|
||||
</section>
|
||||
|
||||
<section xml:id="networking-options-securitygroups">
|
||||
<title>Security Groups</title>
|
||||
<para>Use the following options in the configuration file
|
||||
for your driver to change security group settings.</para>
|
||||
<xi:include href="../common/tables/neutron-securitygroups.xml"/>
|
||||
</section>
|
||||
|
||||
<section xml:id="networking-options-ssl">
|
||||
<title>SSL</title>
|
||||
<para>Use the following options in the
|
||||
<filename>neutron.conf</filename> file to enable SSL.</para>
|
||||
<xi:include href="../common/tables/neutron-ssl.xml"/>
|
||||
</section>
|
||||
|
||||
<section xml:id="networking-options-testing">
|
||||
<title>Testing</title>
|
||||
<para>Use the following options to alter testing-related features.</para>
|
||||
<xi:include href="../common/tables/neutron-testing.xml"/>
|
||||
</section>
|
||||
|
||||
<section xml:id="networking-options-wsgi">
|
||||
<title>WSGI</title>
|
||||
<para>Use the following options in the
|
||||
<filename>neutron.conf</filename> file to configure the WSGI layer.</para>
|
||||
<xi:include href="../common/tables/neutron-wsgi.xml"/>
|
||||
<xi:include href="../common/tables/neutron-zeromq.xml"/>
|
||||
</section>
|
||||
|
||||
</chapter>
|
||||
|
||||
@@ -0,0 +1,69 @@
|
||||
<?xml version= "1.0" encoding= "UTF-8"?>
|
||||
<section xml:id="networking-options-plugins"
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
xmlns:ns5="http://www.w3.org/1999/xhtml"
|
||||
xmlns:ns4="http://www.w3.org/2000/svg"
|
||||
xmlns:ns3="http://www.w3.org/1998/Math/MathML"
|
||||
xmlns:ns="http://docbook.org/ns/docbook"
|
||||
version="5.0">
|
||||
<title>Networking Plugins</title>
|
||||
<para>
|
||||
OpenStack Networking introduces the concept of a plugin, which is a
|
||||
back-end implementation of the OpenStack Networking API. A plugin
|
||||
can use a variety of technologies to implement the logical API
|
||||
requests. Some OpenStack Networking plugins might use basic Linux
|
||||
VLANs and IP tables, while others might use more advanced technologies,
|
||||
such as L2-in-L3 tunneling or OpenFlow.
|
||||
|
||||
The follow sections detail the configuration options for the various
|
||||
plugins available.
|
||||
</para>
|
||||
<section xml:id="networking-plugin-bigswitch">
|
||||
<title>BigSwitch Configuration Options</title>
|
||||
<xi:include href="../common/tables/neutron-bigswitch.xml"/>
|
||||
</section>
|
||||
<section xml:id="networking-plugin-cisco">
|
||||
<title>CISCO Configuration Options</title>
|
||||
<xi:include href="../common/tables/neutron-cisco.xml"/>
|
||||
</section>
|
||||
<section xml:id="networking-plugin-hyperv">
|
||||
<title>CloudBase Hyper-V Configuration Options</title>
|
||||
<xi:include href="../common/tables/neutron-hyperv.xml"/>
|
||||
</section>
|
||||
<section xml:id="networking-plugin-linuxbridge">
|
||||
<title>Linux Bridge Configuration Options</title>
|
||||
<xi:include href="../common/tables/neutron-linuxbridge.xml"/>
|
||||
</section>
|
||||
<section xml:id="networking-plugin-meta">
|
||||
<title>Meta Plugin Configuration Options</title>
|
||||
<para>The Meta Plugin allows you to use multiple plugins at the same time.</para>
|
||||
<xi:include href="../common/tables/neutron-meta.xml"/>
|
||||
</section>
|
||||
<section xml:id="networking-plugin-midonet">
|
||||
<title>MidoNet Configuration Options</title>
|
||||
<xi:include href="../common/tables/neutron-midonet.xml"/>
|
||||
</section>
|
||||
<section xml:id="networking-plugin-nec">
|
||||
<title>NEC Configuration Options</title>
|
||||
<xi:include href="../common/tables/neutron-nec.xml"/>
|
||||
</section>
|
||||
<section xml:id="networking-plugin-nicira">
|
||||
<title>Nicira NVP Configuration Options</title>
|
||||
<xi:include href="../common/tables/neutron-nicira.xml"/>
|
||||
</section>
|
||||
<section xml:id="networking-plugin-openvswitch">
|
||||
<title>Open vSwitch Configuration Options</title>
|
||||
<xi:include href="../common/tables/neutron-openvswitch.xml"/>
|
||||
</section>
|
||||
<section xml:id="networking-plugin-plumgrid">
|
||||
<title>PLUMgrid Configuration Options</title>
|
||||
<xi:include href="../common/tables/neutron-plumgrid.xml"/>
|
||||
</section>
|
||||
<section xml:id="networking-plugin-ryu">
|
||||
<title>Ryu Configuration Options</title>
|
||||
<xi:include href="../common/tables/neutron-ryu.xml"/>
|
||||
</section>
|
||||
|
||||
</section>
|
||||
Reference in New Issue
Block a user