From ddbeb8a1b09eefcb97903167090fe1b557dc9541 Mon Sep 17 00:00:00 2001 From: Tom Fifield Date: Sat, 10 Aug 2013 14:02:36 +1000 Subject: [PATCH] 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 --- .../common/section_rpc-for-networking.xml | 129 ++++++++++++++++++ doc/src/docbkx/common/section_rpc.xml | 19 ++- .../openstack-config/ch_config-overview.xml | 2 +- .../ch_networking-options-reference.xml | 100 +++++++++++--- .../section_networking-plugins.xml | 69 ++++++++++ 5 files changed, 294 insertions(+), 25 deletions(-) create mode 100644 doc/src/docbkx/common/section_rpc-for-networking.xml create mode 100644 doc/src/docbkx/openstack-config/section_networking-plugins.xml diff --git a/doc/src/docbkx/common/section_rpc-for-networking.xml b/doc/src/docbkx/common/section_rpc-for-networking.xml new file mode 100644 index 0000000000..b83904c416 --- /dev/null +++ b/doc/src/docbkx/common/section_rpc-for-networking.xml @@ -0,0 +1,129 @@ + +
+ + Configuring the Oslo RPC Messaging System + + 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: + RabbitMQ, + Qpid, and + ZeroMQ + +
+ Configuration for RabbitMQ + + OpenStack Oslo RPC uses RabbitMQ by + default. This section discusses the configuration options that are + relevant when RabbitMQ is used. The + rpc_backend option is not required as long as + RabbitMQ is the default messaging system. + However, if it is included the configuration, it must be set to + neutron.openstack.common.rpc.impl_kombu. + + + +rpc_backend=neutron.openstack.common.rpc.impl_kombu + + + The following tables describe the rest of the options that + can be used when RabbitMQ 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 notification_driver option in + neutron.conf to + neutron.notifier.rabbit_notifier. + + + + +
+ +
+ Configuration for Qpid + + This section discusses the configuration options that are relevant + if Qpid is used as the messaging system for + OpenStack Oslo RPC. Qpid is not the default + messaging system, so it must be enabled by setting the + rpc_backend option in + neutron.conf. + + +rpc_backend=neutron.openstack.common.rpc.impl_qpid + + + This next critical option points the compute nodes to the + Qpid broker (server). Set + qpid_hostname in neutron.conf to + be the hostname where the broker is running. + + + The --qpid_hostname option accepts a value in + the form of either a hostname or an IP address. + + + +qpid_hostname=hostname.example.com + + + If the Qpid broker is listening on a + port other than the AMQP default of 5672, you will + need to set the qpid_port option: + + +qpid_port=12345 + + + If you configure the Qpid broker to + require authentication, you will need to add a username and password to + the configuration: + + +qpid_username=username +qpid_password=password + + + By default, TCP is used as the transport. If you would like to + enable SSL, set the qpid_protocol option: + + +qpid_protocol=ssl + + + 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. + + + +
+
+ Configuration for ZeroMQ + This section discusses the configuration options that are relevant + if ZeroMQ is used as the messaging system for + OpenStack Oslo RPC. ZeroMQ is not the default + messaging system, so it must be enabled by setting the + rpc_backend option in + neutron.conf. + +
+
+ Common Configuration for Messaging + + This section lists options that are common between the + RabbitMQ, Qpid + and ZeroMq + messaging drivers. + + + +
+
+ diff --git a/doc/src/docbkx/common/section_rpc.xml b/doc/src/docbkx/common/section_rpc.xml index 61831bbdfc..8f49f3a1d2 100644 --- a/doc/src/docbkx/common/section_rpc.xml +++ b/doc/src/docbkx/common/section_rpc.xml @@ -9,9 +9,10 @@ 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: - RabbitMQ and - Qpid. + OpenStack Oslo RPC supports three implementations of AMQP: + RabbitMQ, + Qpid, and + ZeroMQ.
Configuration for RabbitMQ @@ -104,6 +105,18 @@ qpid_protocol=ssl
+
+ Configuration Options for ZeroMQ + This section discusses the configuration options that are relevant + if ZeroMQ is used as the messaging system for + OpenStack Oslo RPC. ZeroMQ is not the default + messaging system, so it must be enabled by setting the + rpc_backend option in + nova.conf. + + + +
Common Configuration for Messaging diff --git a/doc/src/docbkx/openstack-config/ch_config-overview.xml b/doc/src/docbkx/openstack-config/ch_config-overview.xml index 953c5c52cb..6f6fc61383 100644 --- a/doc/src/docbkx/openstack-config/ch_config-overview.xml +++ b/doc/src/docbkx/openstack-config/ch_config-overview.xml @@ -2,7 +2,7 @@ + xml:id="config_overview"> OpenStack Configuration Overview OpenStack is a collection of open source project to enable setting up cloud services. Each project uses similar diff --git a/doc/src/docbkx/openstack-config/ch_networking-options-reference.xml b/doc/src/docbkx/openstack-config/ch_networking-options-reference.xml index 80b2580a83..4e152771cb 100644 --- a/doc/src/docbkx/openstack-config/ch_networking-options-reference.xml +++ b/doc/src/docbkx/openstack-config/ch_networking-options-reference.xml @@ -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"> - List of configuration options for Networking + Configuration options for Networking These options and descriptions were generated from the code in the Networking service project which provides software defined networking -between VMs run in Compute. - - - - +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. + + + + + + +
+Agent +Use the following options to alter agent-related settings. + +
+ +
+API +Use the following options to alter API-related settings. + +
+ +
+Database +Use the following options to alter Database-related settings. - - - +
+ +
+Logging +Use the following options to alter logging settings. - +
+ +
+Metadata Agent +Use the following options in the +metadata_agent.ini file for the Metadata agent. - - - - - - +
+ +
+Policy +Use the following options in the +neutron.conf file to change policy settings. - +
+ +
+Quotas +Use the following options in the +neutron.conf file for the quota system. - - - +
+ +
+Scheduler +Use the following options in the +neutron.conf file to change scheduler settings. +
+ +
+Security Groups +Use the following options in the configuration file +for your driver to change security group settings. +
+ +
+SSL +Use the following options in the +neutron.conf file to enable SSL. +
+ +
+Testing +Use the following options to alter testing-related features. +
+ +
+WSGI +Use the following options in the +neutron.conf file to configure the WSGI layer. - +
+ diff --git a/doc/src/docbkx/openstack-config/section_networking-plugins.xml b/doc/src/docbkx/openstack-config/section_networking-plugins.xml new file mode 100644 index 0000000000..7f895f9de3 --- /dev/null +++ b/doc/src/docbkx/openstack-config/section_networking-plugins.xml @@ -0,0 +1,69 @@ + +
+Networking Plugins + +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. + +
+BigSwitch Configuration Options + +
+
+CISCO Configuration Options + +
+
+CloudBase Hyper-V Configuration Options + +
+
+Linux Bridge Configuration Options + +
+
+Meta Plugin Configuration Options +The Meta Plugin allows you to use multiple plugins at the same time. + +
+
+MidoNet Configuration Options + +
+
+NEC Configuration Options + +
+
+Nicira NVP Configuration Options + +
+
+Open vSwitch Configuration Options + +
+
+PLUMgrid Configuration Options + +
+
+Ryu Configuration Options + +
+ +