openstack/openstack-manuals
Code Issues Proposed changes

Move various plugin configuration info from the old networking install chapter to Cloud Admin Guide

Browse Source 
Move Big Switch, Nicira, OSV, PLUMgrid, Ryu, and neutron agent config info to ch_neworking
Add info about deleting nova-network before initializing networking install
Add crossreferences to Config Ref and Install Guide

author: nermina miller
backport: havana
Partial-Bug: 1244759

Change-Id: I5fe694de95da45879acccb5dfa45a331aa591403
This commit is contained in:
nerminamiller 2013-11-06 11:47:39 -05:00 committed by Diane Fleming
parent 8ad7e9ed6f
commit 1fe3fe0a31
8 changed files with 1350 additions and 507 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1359
doc/admin-guide-cloud/ch_networking.xml
View File

File diff suppressed because it is too large Load Diff

130
doc/admin-guide-cloud/section_networking_adv_features.xml
View File

@ -514,15 +514,15 @@
<para>Creates external
networks.</para></td>
<td>
<screen><prompt>$</prompt> <userinput>neutron net-create public --router:external=True</userinput>
<prompt>$</prompt> <userinput>neutron subnet-create public 172.16.1.0/24</userinput></screen>
<screen><prompt>#</prompt> <userinput>neutron net-create public --router:external=True</userinput>
<prompt>#</prompt> <userinput>neutron subnet-create public 172.16.1.0/24</userinput></screen>
</td>
</tr>
<tr>
<td>
<para>Lists external networks.</para></td>
<td>
<screen><prompt>$</prompt> <userinput>neutron net-list -- --router:external=True</userinput></screen>
<screen><prompt>#</prompt> <userinput>neutron net-list -- --router:external=True</userinput></screen>
</td>
</tr>
<tr>
@ -530,13 +530,13 @@
connects to multiple L2 networks
privately.</para></td>
<td>
<screen><prompt>$</prompt> <userinput>neutron net-create net1</userinput>
<prompt>$</prompt> <userinput>neutron subnet-create net1 10.0.0.0/24</userinput>
<prompt>$</prompt> <userinput>neutron net-create net2</userinput>
<prompt>$</prompt> <userinput>neutron subnet-create net2 10.0.1.0/24</userinput>
<prompt>$</prompt> <userinput>neutron router-create router1</userinput>
<prompt>$</prompt> <userinput>neutron router-interface-add router1 &lt;subnet1-uuid&gt;</userinput>
<prompt>$</prompt> <userinput>neutron router-interface-add router1 &lt;subnet2-uuid&gt;</userinput></screen>
<screen><prompt>#</prompt> <userinput>neutron net-create net1</userinput>
<prompt>#</prompt> <userinput>neutron subnet-create net1 10.0.0.0/24</userinput>
<prompt>#</prompt> <userinput>neutron net-create net2</userinput>
<prompt>#</prompt> <userinput>neutron subnet-create net2 10.0.1.0/24</userinput>
<prompt>#</prompt> <userinput>neutron router-create router1</userinput>
<prompt>#</prompt> <userinput>neutron router-interface-add router1 &lt;subnet1-uuid&gt;</userinput>
<prompt>#</prompt> <userinput>neutron router-interface-add router1 &lt;subnet2-uuid&gt;</userinput></screen>
</td>
</tr>
<tr>
@ -546,7 +546,7 @@
act as a NAT gateway for external
connectivity.</para></td>
<td>
<screen><prompt>$</prompt> <userinput>neutron router-gateway-set router1 &lt;ext-net-id&gt;</userinput></screen>
<screen><prompt>#</prompt> <userinput>neutron router-gateway-set router1 &lt;ext-net-id&gt;</userinput></screen>
<para>The router obtains an interface with
the gateway_ip address of the subnet,
and this interface is attached to a
@ -566,7 +566,7 @@
<td>
<para>Lists routers.</para></td>
<td>
<screen><prompt>$</prompt> <userinput>neutron router-list</userinput></screen>
<screen><prompt>#</prompt> <userinput>neutron router-list</userinput></screen>
</td>
</tr>
<tr>
@ -574,7 +574,7 @@
<para>Shows information for a specified
router.</para></td>
<td>
<screen><prompt>$</prompt> <userinput>neutron router-show &lt;router_id&gt;</userinput></screen>
<screen><prompt>#</prompt> <userinput>neutron router-show &lt;router_id&gt;</userinput></screen>
</td>
</tr>
<tr>
@ -590,7 +590,7 @@
represents the VM NIC to which the
floating IP should map.</para></td>
<td>
<screen><prompt>$</prompt> <userinput>neutron port-list -c id -c fixed_ips -- --device_id=&lt;instance_id&gt;</userinput></screen>
<screen><prompt>#</prompt> <userinput>neutron port-list -c id -c fixed_ips -- --device_id=&lt;instance_id&gt;</userinput></screen>
<para>This port must be on an Networking
subnet that is attached to a router
uplinked to the external network used
@ -610,8 +610,8 @@
<para>Creates a floating IP address and
associates it with a port.</para></td>
<td>
<screen><prompt>$</prompt> <userinput>neutron floatingip-create &lt;ext-net-id&gt;</userinput>
<prompt>$</prompt> <userinput>neutron floatingip-associate &lt;floatingip-id&gt; &lt;internal VM port-id&gt;</userinput></screen>
<screen><prompt>#</prompt> <userinput>neutron floatingip-create &lt;ext-net-id&gt;</userinput>
<prompt>#</prompt> <userinput>neutron floatingip-associate &lt;floatingip-id&gt; &lt;internal VM port-id&gt;</userinput></screen>
</td>
</tr>
<tr>
@ -620,14 +620,14 @@
associates it with a port, in a single
step.</para></td>
<td>
<screen><prompt>$</prompt> <userinput>neutron floatingip-create --port_id &lt;internal VM port-id&gt; &lt;ext-net-id&gt;</userinput></screen>
<screen><prompt>#</prompt> <userinput>neutron floatingip-create --port_id &lt;internal VM port-id&gt; &lt;ext-net-id&gt;</userinput></screen>
</td>
</tr>
<tr>
<td>
<para>Lists floating IPs.</para></td>
<td>
<screen><prompt>$</prompt> <userinput>neutron floatingip-list</userinput></screen>
<screen><prompt>#</prompt> <userinput>neutron floatingip-list</userinput></screen>
</td>
</tr>
<tr>
@ -635,7 +635,7 @@
<para>Finds floating IP for a specified VM
port.</para></td>
<td>
<screen><prompt>$</prompt> <userinput>neutron floatingip-list -- --port_id=ZZZ</userinput></screen>
<screen><prompt>#</prompt> <userinput>neutron floatingip-list -- --port_id=ZZZ</userinput></screen>
</td>
</tr>
<tr>
@ -643,7 +643,7 @@
<para>Disassociates a floating IP
address.</para></td>
<td>
<screen><prompt>$</prompt> <userinput>neutron floatingip-disassociate &lt;floatingip-id&gt;</userinput></screen>
<screen><prompt>#</prompt> <userinput>neutron floatingip-disassociate &lt;floatingip-id&gt;</userinput></screen>
</td>
</tr>
<tr>
@ -651,14 +651,14 @@
<para>Deletes the floating IP
address.</para></td>
<td>
<screen><prompt>$</prompt> <userinput>neutron floatingip-delete &lt;floatingip-id&gt;</userinput></screen>
<screen><prompt>#</prompt> <userinput>neutron floatingip-delete &lt;floatingip-id&gt;</userinput></screen>
</td>
</tr>
<tr>
<td>
<para>Clears the gateway.</para></td>
<td>
<screen><prompt>$</prompt> <userinput>neutron router-gateway-clear router1</userinput></screen>
<screen><prompt>#</prompt> <userinput>neutron router-gateway-clear router1</userinput></screen>
</td>
</tr>
<tr>
@ -666,14 +666,14 @@
<para>Removes the interfaces from the
router.</para></td>
<td>
<screen><prompt>$</prompt> <userinput>neutron router-interface-delete router1 &lt;subnet-id&gt;</userinput></screen>
<screen><prompt>#</prompt> <userinput>neutron router-interface-delete router1 &lt;subnet-id&gt;</userinput></screen>
</td>
</tr>
<tr>
<td>
<para>Deletes the router.</para></td>
<td>
<screen><prompt>$</prompt> <userinput>neutron router-delete router1</userinput></screen>
<screen><prompt>#</prompt> <userinput>neutron router-delete router1</userinput></screen>
</td>
</tr>
</tbody>
@ -889,51 +889,51 @@
<para>Creates a security group for our web
servers.</para></td>
<td>
<screen><prompt>$</prompt> <userinput>neutron security-group-create webservers --description "security group for webservers"</userinput></screen></td>
<screen><prompt>#</prompt> <userinput>neutron security-group-create webservers --description "security group for webservers"</userinput></screen></td>
</tr>
<tr>
<td><para>Lists security groups.</para></td>
<td><screen><prompt>$</prompt> <userinput>neutron security-group-list</userinput></screen>
<td><screen><prompt>#</prompt> <userinput>neutron security-group-list</userinput></screen>
</td>
</tr>
<tr>
<td>
<para>Creates a security group rule to
allow port 80 ingress.</para></td>
<td><screen><prompt>$</prompt> <userinput>neutron security-group-rule-create --direction ingress --protocol tcp --port_range_min 80 --port_range_max 80 &lt;security_group_uuid&gt;</userinput></screen>
<td><screen><prompt>#</prompt> <userinput>neutron security-group-rule-create --direction ingress --protocol tcp --port_range_min 80 --port_range_max 80 &lt;security_group_uuid&gt;</userinput></screen>
</td>
</tr>
<tr>
<td>
<para>Lists security group
rules.</para></td>
<td><screen><prompt>$</prompt> <userinput>neutron security-group-rule-list</userinput></screen>
<td><screen><prompt>#</prompt> <userinput>neutron security-group-rule-list</userinput></screen>
</td>
</tr>
<tr>
<td><para>Deletes a security group
rule.</para></td>
<td><screen><prompt>$</prompt> <userinput>neutron security-group-rule-delete &lt;security_group_rule_uuid&gt;</userinput></screen>
<td><screen><prompt>#</prompt> <userinput>neutron security-group-rule-delete &lt;security_group_rule_uuid&gt;</userinput></screen>
</td>
</tr>
<tr>
<td>
<para>Deletes a security
group.</para></td>
<td><screen><prompt>$</prompt> <userinput>neutron security-group-delete &lt;security_group_uuid&gt;</userinput></screen>
<td><screen><prompt>#</prompt> <userinput>neutron security-group-delete &lt;security_group_uuid&gt;</userinput></screen>
</td>
</tr>
<tr>
<td><para>Creates a port and associates two
security groups.</para></td>
<td><screen><prompt>$</prompt> <userinput>neutron port-create --security-group &lt;security_group_id1&gt; --security-group &lt;security_group_id2&gt; &lt;network_id&gt;</userinput></screen>
<td><screen><prompt>#</prompt> <userinput>neutron port-create --security-group &lt;security_group_id1&gt; --security-group &lt;security_group_id2&gt; &lt;network_id&gt;</userinput></screen>
</td>
</tr>
<tr>
<td>
<para>Removes security groups from a
port.</para></td>
<td><screen><prompt>$</prompt> <userinput>neutron port-update --no-security-groups &lt;port_id&gt;</userinput></screen>
<td><screen><prompt>#</prompt> <userinput>neutron port-update --no-security-groups &lt;port_id&gt;</userinput></screen>
</td>
</tr>
</tbody>
@ -980,15 +980,15 @@
option is required for pool
creation.</para></td>
<td>
<screen><prompt>$</prompt> <userinput>neutron lb-pool-create --lb-method ROUND_ROBIN --name mypool --protocol HTTP --subnet-id &lt;subnet-uuid&gt; <parameter>--provider &lt;provider_name&gt;</parameter></userinput></screen></td>
<screen><prompt>#</prompt> <userinput>neutron lb-pool-create --lb-method ROUND_ROBIN --name mypool --protocol HTTP --subnet-id &lt;subnet-uuid&gt; <parameter>--provider &lt;provider_name&gt;</parameter></userinput></screen></td>
</tr>
<tr>
<td>
<para>Associates two web servers with
pool.</para></td>
<td>
<screen><prompt>$</prompt> <userinput>neutron lb-member-create --address &lt;webserver one IP&gt; --protocol-port 80 mypool</userinput>
<prompt>$</prompt> <userinput>neutron lb-member-create --address &lt;webserver two IP&gt; --protocol-port 80 mypool</userinput></screen></td>
<screen><prompt>#</prompt> <userinput>neutron lb-member-create --address &lt;webserver one IP&gt; --protocol-port 80 mypool</userinput>
<prompt>#</prompt> <userinput>neutron lb-member-create --address &lt;webserver two IP&gt; --protocol-port 80 mypool</userinput></screen></td>
</tr>
<tr>
<td>
@ -996,13 +996,13 @@
make sure our instances are still running
on the specified
protocol-port.</para></td>
<td><screen><prompt>$</prompt> <userinput>neutron lb-healthmonitor-create --delay 3 --type HTTP --max-retries 3 --timeout 3</userinput></screen>
<td><screen><prompt>#</prompt> <userinput>neutron lb-healthmonitor-create --delay 3 --type HTTP --max-retries 3 --timeout 3</userinput></screen>
</td>
</tr>
<tr>
<td><para>Associates a health monitor with
pool.</para></td>
<td><screen><prompt>$</prompt> <userinput>neutron lb-healthmonitor-associate &lt;healthmonitor-uuid&gt; mypool</userinput></screen>
<td><screen><prompt>#</prompt> <userinput>neutron lb-healthmonitor-associate &lt;healthmonitor-uuid&gt; mypool</userinput></screen>
</td>
</tr>
<tr>
@ -1012,7 +1012,7 @@
directs the requests to one of the pool
members.</para></td>
<td>
<screen><prompt>$</prompt> <userinput>neutron lb-vip-create --name myvip --protocol-port 80 --protocol HTTP --subnet-id &lt;subnet-uuid&gt; mypool</userinput></screen>
<screen><prompt>#</prompt> <userinput>neutron lb-vip-create --name myvip --protocol-port 80 --protocol HTTP --subnet-id &lt;subnet-uuid&gt; mypool</userinput></screen>
</td>
</tr>
</tbody>
@ -1363,7 +1363,7 @@
<itemizedlist>
<listitem>
<para>Create a firewall rule:</para>
<screen><prompt>$</prompt> <userinput>neutron firewall-rule-create --protocol &lt;tcp|udp|icmp|any&gt; --destination-port &lt;port-range&gt; --action &lt;allow|deny&gt;</userinput></screen>
<screen><prompt>#</prompt> <userinput>neutron firewall-rule-create --protocol &lt;tcp|udp|icmp|any&gt; --destination-port &lt;port-range&gt; --action &lt;allow|deny&gt;</userinput></screen>
<para>The CLI requires that a protocol value be
provided. If the rule is protocol agnostic,
the 'any' value can be used.</para>
@ -1374,7 +1374,7 @@
</listitem>
<listitem>
<para>Create a firewall policy:</para>
<screen><prompt>$</prompt> <userinput>neutron firewall-policy-create --firewall-rules "&lt;firewall-rule ids or names separated by space&gt;" myfirewallpolicy</userinput></screen>
<screen><prompt>#</prompt> <userinput>neutron firewall-policy-create --firewall-rules "&lt;firewall-rule ids or names separated by space&gt;" myfirewallpolicy</userinput></screen>
<para>The order of the rules specified above is
important. A firewall policy can be created
without any rules and rules can be added later
@ -1394,15 +1394,14 @@
</listitem>
<listitem>
<para>Create a firewall:</para>
<screen><prompt>$</prompt> <userinput>neutron firewall-create &lt;firewall-policy-uuid&gt;</userinput></screen>
<screen><prompt>#</prompt> <userinput>neutron firewall-create &lt;firewall-policy-uuid&gt;</userinput></screen>
</listitem>
</itemizedlist>
<note>
<para>The FWaaS features and the above workflow can
also be accessed from the Horizon user interface.
This support is disabled by default, but can be
enabled by configuring
<filename>$HORIZON_DIR/openstack_dashboard/local/local_settings.py
<para>The FWaaS features and the above workflow can also be accessed from the
Horizon user interface. This support is disabled by default, but can be enabled
by configuring
<filename>#HORIZON_DIR/openstack_dashboard/local/local_settings.py
</filename> and setting
<programlisting language="ini">
'enable_firewall' = True
@ -1432,12 +1431,12 @@
<listitem>
<para>Create a port with a specific
allowed-address-pairs:</para>
<screen><prompt>$</prompt> <userinput>neutron port-create net1 --allowed-address-pairs type=dict list=true mac_address=&lt;mac_address&gt;,ip_address=&lt;ip_cidr&gt;</userinput></screen>
<screen><prompt>#</prompt> <userinput>neutron port-create net1 --allowed-address-pairs type=dict list=true mac_address=&lt;mac_address&gt;,ip_address=&lt;ip_cidr&gt;</userinput></screen>
</listitem>
<listitem>
<para>Update a port adding
allowed-address-pairs:</para>
<screen><prompt>$</prompt> <userinput>neutron port-update &lt;subnet-uuid&gt; --allowed-address-pairs type=dict list=true mac_address=&lt;mac_address&gt;,ip_address=&lt;ip_cidr&gt;</userinput></screen>
<screen><prompt>#</prompt> <userinput>neutron port-update &lt;subnet-uuid&gt; --allowed-address-pairs type=dict list=true mac_address=&lt;mac_address&gt;,ip_address=&lt;ip_cidr&gt;</userinput></screen>
</listitem>
</itemizedlist>
<note>
@ -1599,7 +1598,7 @@
<para>Creates QoS Queue
(admin-only).</para></td>
<td>
<screen><prompt>$</prompt> <userinput>neutron queue-create--min 10 --max 1000 myqueue</userinput></screen>
<screen><prompt>#</prompt> <userinput>neutron queue-create--min 10 --max 1000 myqueue</userinput></screen>
</td>
</tr>
<tr>
@ -1607,20 +1606,20 @@
<para>Associates a queue with a
network.</para></td>
<td>
<screen><prompt>$</prompt> <userinput>neutron net-create network --queue_id=&lt;queue_id&gt;</userinput></screen>
<screen><prompt>#</prompt> <userinput>neutron net-create network --queue_id=&lt;queue_id&gt;</userinput></screen>
</td>
</tr>
<tr>
<td>
<para>Creates a default system
queue.</para></td>
<td><screen><prompt>$</prompt> <userinput>neutron queue-create --default True --min 10 --max 2000 default</userinput></screen>
<td><screen><prompt>#</prompt> <userinput>neutron queue-create --default True --min 10 --max 2000 default</userinput></screen>
</td>
</tr>
<tr>
<td><para>Lists QoS
queues.</para></td>
<td><screen><prompt>$</prompt> <userinput>neutron queue-list</userinput></screen>
<td><screen><prompt>#</prompt> <userinput>neutron queue-list</userinput></screen>
</td>
</tr>
<tr>
@ -1628,7 +1627,7 @@
<para>Deletes a QoS
queue.</para></td>
<td>
<screen><prompt>$</prompt> <userinput>neutron queue-delete &lt;queue_id or name&gt;'</userinput></screen>
<screen><prompt>#</prompt> <userinput>neutron queue-delete &lt;queue_id or name&gt;'</userinput></screen>
</td>
</tr>
</tbody>
@ -1709,21 +1708,22 @@
<title>Nicira NVP L3 extension operations</title>
<para>Create external network and map it to a
specific NVP gateway service:</para>
<screen><prompt>$</prompt> <userinput>neutron net-create public --router:external=True --provider:network_type l3_ext \
<screen><prompt>#</prompt> <userinput>neutron net-create public --router:external=True --provider:network_type l3_ext \
--provider:physical_network &lt;L3-Gateway-Service-UUID&gt;</userinput></screen>
<para>Terminate traffic on a specific VLAN from a
NVP gateway service:</para>
<screen><prompt>$</prompt> <userinput>neutron net-create public --router:external=True --provider:network_type l3_ext \
<screen><prompt>#</prompt> <userinput>neutron net-create public --router:external=True --provider:network_type l3_ext \
--provider:physical_network &lt;L3-Gateway-Service-UUID&gt; -provider:segmentation_id &lt;VLAN_ID&gt;</userinput></screen>
</section>
</section>
</section>
<section xml:id="section_bigswitch_extensions">
<title>Big Switch Plugin Extensions</title>
<para>The following section explains the Big Switch Neutron plugin-specific extension.</para>
<title>Big Switch plug-in extensions</title>
<para>The following section explains the Big Switch Neutron plug-in-specific
extension.</para>
<section xml:id="section_bigswitch_extension_routerrules">
<title>Big Switch Router Rules</title>
<title>Big Switch router rules</title>
<para>Big Switch allows router rules to be added to each
tenant router. These rules can be used to enforce routing
policies such as denying traffic between subnets or traffic
@ -1731,7 +1731,7 @@
level, network segmentation policies can be enforced across
many VMs that have differing security groups.</para>
<section xml:id="section_bigswitch_routerrule_fields">
<title>Router Rule Attributes</title>
<title>Router rule attributes</title>
<para>Each tenant router has a set of router rules
associated with it. Each router rule has the attributes
in the following table. Router rules and their
@ -1740,7 +1740,7 @@
via the Horizon interface, or through the Neutron API.
</para>
<table rules="all">
<caption>Big Switch Router Rule Attributes</caption>
<caption>Big Switch Router rule attributes</caption>
<col width="20%"/>
<col width="15%"/>
<col width="25%"/>
@ -1790,7 +1790,7 @@
</table>
</section>
<section xml:id="section_bigswitch_routerrule_processorder">
<title>Order of Rule Processing</title>
<title>Order of rule processing</title>
<para>The order of router rules has no effect. Overlapping
rules are evaluated using longest prefix matching on
the source and destination fields. The source field
@ -1801,7 +1801,7 @@
source.</para>
</section>
<section xml:id="section_bigswitch_routerrule_walkthrough">
<title>Big Switch Router Rules Operations</title>
<title>Big Switch router rules operations</title>
<para>Router rules are configured with a router update
operation in Neutron. The update overrides any previous
rules so all of the rules must be provided at the same
@ -1809,17 +1809,17 @@
<para>Update a router with rules to permit traffic by
default but block traffic from external networks to the
10.10.10.0/24 subnet:</para>
<screen><prompt>$</prompt> <userinput>neutron router-update <replaceable>Router-UUID</replaceable> --router_rules type=dict list=true\
<screen><prompt>#</prompt> <userinput>neutron router-update <replaceable>Router-UUID</replaceable> --router_rules type=dict list=true\
source=any,destination=any,action=permit \
source=external,destination=10.10.10.0/24,action=deny</userinput></screen>
<para>Specify alternate next-hop addresses for a specific
subnet:</para>
<screen><prompt>$</prompt> <userinput>neutron router-update <replaceable>Router-UUID</replaceable> --router_rules type=dict list=true\
<screen><prompt>#</prompt> <userinput>neutron router-update <replaceable>Router-UUID</replaceable> --router_rules type=dict list=true\
source=any,destination=any,action=permit \
source=10.10.10.0/24,destination=any,action=permit,nexthops=10.10.10.254+10.10.10.253</userinput></screen>
<para>Block traffic between two subnets while
allowing everything else:</para>
<screen><prompt>$</prompt> <userinput>neutron router-update <replaceable>Router-UUID</replaceable> --router_rules type=dict list=true\
<screen><prompt>#</prompt> <userinput>neutron router-update <replaceable>Router-UUID</replaceable> --router_rules type=dict list=true\
source=any,destination=any,action=permit \
source=10.10.10.0/24,destination=10.20.20.20/24,action=deny</userinput></screen>
</section>

6
doc/admin-guide-cloud/section_networking_adv_operational_features.xml
View File

@ -17,10 +17,8 @@
<listitem>
<para>Provide logging settings in a logging
configuration file.</para>
<para>See <link
xlink:href="http://docs.python.org/howto/logging.html"
>Python Logging HOWTO</link> for logging
configuration file.</para>
<para>See <link xlink:href="http://docs.python.org/howto/logging.html">Python
logging how-to</link> to learn more about logging.</para>
</listitem>
<listitem>
<para>Provide logging setting in

94
doc/common/section_rpc-for-networking.xml
View File

@ -4,16 +4,17 @@
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>
<title>Configuration options for the Oslo RPC Messaging System</title>
<para>Many OpenStack Networking plug-ins use RPC to enable agents to communicate with the main
<systemitem class="service">neutron-server</systemitem> process. If your plugin requires
agents, they can use the same RPC mechanism used by other OpenStack components like Nova.
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>
@ -43,67 +44,50 @@ rpc_backend=neutron.openstack.common.rpc.impl_kombu
<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
<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="ini">
<programlisting language="ini">
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
<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="ini">
<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="ini">
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="ini">
<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="ini">
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="ini">
<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="ini">
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="ini">
<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="ini">
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>
<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
@ -115,7 +99,7 @@ qpid_protocol=ssl
<xi:include href="tables/neutron-zeromq.xml"/>
</section>
<section xml:id="networking-common-messaging-configuration">
<title>Common Configuration for Messaging</title>
<title>Common configuration for messaging</title>
<para>This section lists options that are common between the
<application>RabbitMQ</application>, <application>Qpid</application>

11
doc/config-reference/networking/section_networking-options-reference.xml
View File

@ -3,12 +3,11 @@
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>Networking Configuration Options</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. Below are common options, and the sections
following contain information about the various networking plugins and
less-commonly altered sections.</para>
<title>Networking configuration options</title>
<para>The options and descriptions listed in this introduction are autogenerated from the code in
the Networking service project, which provides software-defined networking between VMs run
in Compute. The list contains common options, while the subsections list the options for the
various networking plug-ins.</para>
<xi:include href="../../common/tables/neutron-common.xml"/>

158
doc/config-reference/networking/section_networking-plugins.xml
View File

@ -1,85 +1,81 @@
<?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"
<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
<title>Networking plug-ins</title>
<para>OpenStack Networking introduces the concept of a plug-in, which is a back-end
implementation of the OpenStack Networking API. A plug-in can use a variety of
technologies to implement the logical API requests. Some Networking plug-ins might
use basic Linux VLANs and IP tables, while others might use more advanced
technologies, such as L2-in-L3 tunneling or OpenFlow. The following 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-brocade">
<title>Brocade Configuration Options</title>
<xi:include href="../../common/tables/neutron-brocade.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 Plugin configuration options (deprecated)</title>
<xi:include href="../../common/tables/neutron-hyperv.xml"/>
</section>
<section xml:id="networking-plugin-hyperv_agent">
<title>CloudBase Hyper-V Agent configuration options</title>
<xi:include href="../../common/tables/neutron-hyperv_agent.xml"/>
</section>
<section xml:id="networking-plugin-linuxbridge">
<title>Linux bridge Plugin configuration options (deprecated)</title>
<xi:include href="../../common/tables/neutron-linuxbridge.xml"/>
</section>
<section xml:id="networking-plugin-linuxbridge_agent">
<title>Linux bridge Agent configuration options</title>
<xi:include href="../../common/tables/neutron-linuxbridge_agent.xml"/>
</section>
<section xml:id="networking-plugin-mlnx">
<title>Mellanox Configuration Options</title>
<xi:include href="../../common/tables/neutron-mlnx.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>
<xi:include href="section_networking-plugins-ml2.xml"/>
<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 Plugin configuration options (deprecated)</title>
<xi:include href="../../common/tables/neutron-openvswitch.xml"/>
</section>
<section xml:id="networking-plugin-openvswitch_agent">
<title>Open vSwitch Agent configuration options</title>
<xi:include href="../../common/tables/neutron-openvswitch_agent.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>
detail the configuration options for the various plug-ins 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-brocade">
<title>Brocade configuration options</title>
<xi:include href="../../common/tables/neutron-brocade.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 Plugin configuration options (deprecated)</title>
<xi:include href="../../common/tables/neutron-hyperv.xml"/>
</section>
<section xml:id="networking-plugin-hyperv_agent">
<title>CloudBase Hyper-V Agent configuration options</title>
<xi:include href="../../common/tables/neutron-hyperv_agent.xml"/>
</section>
<section xml:id="networking-plugin-linuxbridge">
<title>Linux bridge plug-in configuration options (deprecated)</title>
<xi:include href="../../common/tables/neutron-linuxbridge.xml"/>
</section>
<section xml:id="networking-plugin-linuxbridge_agent">
<title>Linux bridge Agent configuration options</title>
<xi:include href="../../common/tables/neutron-linuxbridge_agent.xml"/>
</section>
<section xml:id="networking-plugin-mlnx">
<title>Mellanox configuration options</title>
<xi:include href="../../common/tables/neutron-mlnx.xml"/>
</section>
<section xml:id="networking-plugin-meta">
<title>Meta plug-in configuration options</title>
<para>The meta plug-in allows you to use multiple plug-ins at the same
time.</para>
<xi:include href="../../common/tables/neutron-meta.xml"/>
</section>
<xi:include href="section_networking-plugins-ml2.xml"/>
<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 plug-in configuration options (deprecated)</title>
<xi:include href="../../common/tables/neutron-openvswitch.xml"/>
</section>
<section xml:id="networking-plugin-openvswitch_agent">
<title>Open vSwitch Agent configuration options</title>
<xi:include href="../../common/tables/neutron-openvswitch_agent.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>

79
doc/install-guide/section_neutron-install.xml
View File

@ -43,60 +43,59 @@
</thead>
<tbody>
<tr>
<td><para>OpenVSwitch</para></td>
<td><para>neutron.plugins.openvswitch.ovs_neutron_plugin.OVSNeutronPluginV2</para></td>
</tr>
<tr>
<td><para>LinuxBridge</para></td>
<td><para>neutron.plugins.linuxbridge.lb_neutron_plugin.LinuxBridgePluginV2</para></td>
</tr>
<tr>
<td><para>ml2</para></td>
<td><para>neutron.plugins.ml2.plugin.Ml2Plugin</para></td>
</tr>
<tr>
<td><para>RYU</para></td>
<td><para>neutron.plugins.ryu.ryu_neutron_plugin.RyuNeutronPluginV2</para></td>
</tr>
<tr>
<td><para>PLUMgrid</para></td>
<td><para>neutron.plugins.plumgrid.plumgrid_nos_plugin.plumgrid_plugin.NeutronPluginPLUMgridV2</para></td>
<td><para>BigSwitch</para></td>
<td><para>neutron.plugins.bigswitch.plugin.NeutronRestProxyV2</para></td>
</tr>
<tr>
<td><para>Brocade</para></td>
<td><para>neutron.plugins.brocade.NeutronPlugin.BrocadePluginV2</para></td>
</tr>
<tr>
<td><para>Hyper-V</para></td>
<td><para>neutron.plugins.hyperv.hyperv_neutron_plugin.HyperVNeutronPlugin</para></td>
</tr>
<tr>
<td><para>BigSwitch</para></td>
<td><para>neutron.plugins.bigswitch.plugin.NeutronRestProxyV2</para></td>
</tr>
<tr>
<td><para>Cisco</para></td>
<td><para>neutron.plugins.cisco.network_plugin.PluginV2</para></td>
</tr>
<tr>
<td><para>Midonet</para></td>
<td><para>neutron.plugins.midonet.plugin.MidonetPluginV2</para></td>
<td><para>Hyper-V</para></td>
<td><para>neutron.plugins.hyperv.hyperv_neutron_plugin.HyperVNeutronPlugin</para></td>
</tr>
<tr>
<td><para>Nec</para></td>
<td><para>neutron.plugins.nec.nec_plugin.NECPluginV2</para></td>
<td><para>LinuxBridge</para></td>
<td><para>neutron.plugins.linuxbridge.lb_neutron_plugin.LinuxBridgePluginV2</para></td>
</tr>
<tr>
<td><para>Mellanox</para></td>
<td><para>neutron.plugins.mlnx.mlnx_plugin.MellanoxEswitchPlugin</para></td>
</tr>
<tr>
<td><para>MetaPlugin</para></td>
<td><para>neutron.plugins.metaplugin.meta_neutron_plugin.MetaPluginV2</para></td>
</tr>
<tr>
<td><para>Mellanox</para></td>
<td><para>neutron.plugins.mlnx.mlnx_plugin.MellanoxEswitchPlugin</para></td>
<td><para>Midonet</para></td>
<td><para>neutron.plugins.midonet.plugin.MidonetPluginV2</para></td>
</tr>
<tr>
<td><para>ml2</para></td>
<td><para>neutron.plugins.ml2.plugin.Ml2Plugin</para></td>
</tr>
<tr>
<td><para>Nec</para></td>
<td><para>neutron.plugins.nec.nec_plugin.NECPluginV2</para></td>
</tr>
<tr>
<td><para>OpenVSwitch</para></td>
<td><para>neutron.plugins.openvswitch.ovs_neutron_plugin.OVSNeutronPluginV2</para></td>
</tr>
<tr>
<td><para>PLUMgrid</para></td>
<td><para>neutron.plugins.plumgrid.plumgrid_nos_plugin.plumgrid_plugin.NeutronPluginPLUMgridV2</para></td>
</tr>
<tr>
<td><para>RYU</para></td>
<td><para>neutron.plugins.ryu.ryu_neutron_plugin.RyuNeutronPluginV2</para></td>
</tr>
</tbody>
</table>
<para os="debian">Depending on the value of
<parameter>core_plugin</parameter>, the start-up scripts start
the daemons by using the corresponding plug-in configuration file
@ -502,7 +501,8 @@ firewall_driver = neutron.agent.linux.iptables_firewall.OVSHybridIptablesFirewal
<prompt>#</prompt> <userinput>chkconfig neutron-plugin-openvswitch-agent on</userinput></screen>
</step>
<step>
<para>Now, return whence you came!</para>
<para>Now, return to the general <acronym>OVS</acronym>
instructions.</para>
</step>
</procedure>
<section xml:id="install-neutron.install-plug-in.ovs.gre">
@ -633,8 +633,9 @@ bridge_mappings = physnet1:br-DATA_INTERFACE</programlisting>
<prompt>#</prompt> <userinput>neutron router-interface-add <replaceable>EXT_TO_INT_ID</replaceable> <replaceable>DEMO_NET_SUBNET_ID</replaceable></userinput></screen>
</step>
<step>
<para>Check your plug-ins special options page for remaining
steps. Then, return whence you came.</para>
<para>Check the special options page for your plug-in for
remaining steps. Now, return to the general
<acronym>OVS</acronym> instructions.</para>
</step>
</procedure>
<section
@ -677,7 +678,8 @@ router_id = <replaceable>EXT_TO_INT_ID</replaceable></programlisting>
segmentation id and copy the network type option for any
additional networks.</para>
</note>
<para>Return whence you came.</para>
<para>Now, return to the general <acronym>OVS</acronym>
instructions.</para>
</section>
<section
xml:id="install-neutron.configure-networks.plug-in-specific.ovs.vlan">
@ -1087,7 +1089,8 @@ security_group_api=neutron</programlisting>
</note>
</step>
<step>
<para>Now, return whence you came.</para>
<para>Now, return to the general <acronym>OVS</acronym>
instructions.</para>
</step>
</procedure>
<section

20
doc/install-guide/section_neutron-single-flat.xml
View File

@ -10,8 +10,8 @@
<para>The following diagram shows the set up. For simplicity, all
nodes should have one interface for management traffic and one
or more interfaces for traffic to and from VMs. The management
network is 100.1.1.0/24 with controller node at 100.1.1.2. The
example uses the Open vSwitch plug-in and agent.</para>
network is 100.1.1.0/24 with controller node at 100.1.1.2. The example uses the Open vSwitch
plugin and agent.</para>
<note>
<para>You can modify this set up to make use of another
supported plug-in and its agent.</para>
@ -49,9 +49,19 @@
other node resolves to the IP of the
controller node.</para>
<note>
<para>The nova-network service should not be
running. This is replaced by
Networking.</para>
<para>The <systemitem class="service">nova-network</systemitem> service
should not be running. This is replaced by Networking. To delete a network, use <code>nova-manage network delete</code>:</para>
<screen><prompt>#</prompt> <userinput>nova-manage network delete --help</userinput>
<computeroutput> Usage: nova-manage network delete &lt;args&gt; [options]
Options:
-h, --help show this help message and exit
--fixed_range=&lt;x.x.x.x/yy&gt;
Network to delete
--uuid=&lt;uuid&gt; UUID of network to delete</computeroutput></screen>
<para>Note that a network must first be disassociated from a project
using the <code>nova network-disassociate</code> command before it can be
deleted.</para>
</note></td>
</tr>
<tr>