openstack/openstack-manuals
Code Issues Proposed changes

Merge "Add RST glossary term markup"

Browse Source
This commit is contained in:
Jenkins 2015-08-03 08:56:15 +00:00 committed by Gerrit Code Review
commit 492b063a08
1 changed files with 28 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
doc/install-guide-rst/source/neutron-network-node.rst
View File

@ -3,7 +3,7 @@ Install and configure network node
================================== ==================================
The network node primarily handles internal and external routing and The network node primarily handles internal and external routing and
DHCP services for virtual networks. :term:`DHCP` services for virtual networks.
**To configure prerequisites** **To configure prerequisites**
@ -167,13 +167,14 @@ configure certain kernel networking parameters.
**To configure the Modular Layer 2 (ML2) plug-in** **To configure the Modular Layer 2 (ML2) plug-in**
The ML2 plug-in uses the Open vSwitch (OVS) mechanism (agent) to build The ML2 plug-in uses the :term:`Open vSwitch (OVS) <Open vSwitch>` mechanism
the virtual networking framework for instances. (agent) to build the virtual networking framework for instances.
#. Open the :file:`/etc/neutron/plugins/ml2/ml2_conf.ini` file and edit the #. Open the :file:`/etc/neutron/plugins/ml2/ml2_conf.ini` file and edit the
``[ml2]`` section. Enable the flat, VLAN, generic routing ``[ml2]`` section. Enable the :term:`flat <flat network>`, :term:`VLAN <VLAN
encapsulation (GRE), and virtual extensible LAN (VXLAN) network type network>`, :term:`generic routing encapsulation (GRE)`, and
drivers, GRE tenant networks, and the OVS mechanism driver: :term:`virtual extensible LAN (VXLAN)` network type drivers, GRE tenant
networks, and the OVS mechanism driver:
.. code-block:: ini .. code-block:: ini
@ -202,7 +203,7 @@ the virtual networking framework for instances.
tunnel_id_ranges = 1:1000 tunnel_id_ranges = 1:1000
#. In the ``[securitygroup]`` section, enable security groups, enable #. In the ``[securitygroup]`` section, enable security groups, enable
ipset, and configure the OVS iptables firewall driver: :term:`ipset`, and configure the OVS :term:`iptables` firewall driver:
.. code-block:: ini .. code-block:: ini
@ -236,7 +237,7 @@ the virtual networking framework for instances.
**To configure the Layer-3 (L3) agent** **To configure the Layer-3 (L3) agent**
The Layer-3 (L3) agent provides routing services for virtual networks. The :term:`Layer-3 (L3) agent` provides routing services for virtual networks.
#. Open the :file:`/etc/neutron/l3_agent.ini` file edit the ``[DEFAULT]`` #. Open the :file:`/etc/neutron/l3_agent.ini` file edit the ``[DEFAULT]``
section. Configure the interface driver, external section. Configure the interface driver, external
@ -266,7 +267,7 @@ The Layer-3 (L3) agent provides routing services for virtual networks.
**To configure the DHCP agent** **To configure the DHCP agent**
The DHCP agent provides DHCP services for virtual networks. The :term:`DHCP agent` provides DHCP services for virtual networks.
#. Open the :file:`/etc/neutron/dhcp_agent.ini` file and edit the ``[DEFAULT]`` #. Open the :file:`/etc/neutron/dhcp_agent.ini` file and edit the ``[DEFAULT]``
section, configure the interface and DHCP drivers and enable deletion of section, configure the interface and DHCP drivers and enable deletion of
@ -293,19 +294,19 @@ The DHCP agent provides DHCP services for virtual networks.
Tunneling protocols such as GRE include additional packet headers that Tunneling protocols such as GRE include additional packet headers that
increase overhead and decrease space available for the payload or user increase overhead and decrease space available for the payload or user
data. Without knowledge of the virtual network infrastructure, instances data. Without knowledge of the virtual network infrastructure, instances
attempt to send packets using the default Ethernet maximum transmission attempt to send packets using the default Ethernet :term:`maximum
unit (MTU) of 1500 bytes. Internet protocol (IP) networks contain the transmission unit (MTU)` of 1500 bytes. :term:`Internet protocol (IP)`
path MTU discovery (PMTUD) mechanism to detect end-to-end MTU and adjust networks contain the :term:`path MTU discovery (PMTUD)` mechanism to detect
packet size accordingly. However, some operating systems and networks end-to-end MTU and adjust packet size accordingly. However, some operating
block or otherwise lack support for PMTUD causing performance systems and networks block or otherwise lack support for PMTUD causing
degradation or connectivity failure. performance degradation or connectivity failure.
Ideally, you can prevent these problems by enabling jumbo frames on the Ideally, you can prevent these problems by enabling :term:`jumbo frames
physical network that contains your tenant virtual networks. Jumbo <jumbo frame>` on the physical network that contains your tenant virtual
frames support MTUs up to approximately 9000 bytes which negates the networks. Jumbo frames support MTUs up to approximately 9000 bytes which
impact of GRE overhead on virtual networks. However, many network negates the impact of GRE overhead on virtual networks. However, many
devices lack support for jumbo frames and OpenStack administrators often network devices lack support for jumbo frames and OpenStack administrators
lack control over network infrastructure. Given the latter often lack control over network infrastructure. Given the latter
complications, you can also prevent MTU problems by reducing the complications, you can also prevent MTU problems by reducing the
instance MTU to account for GRE overhead. Determining the proper MTU instance MTU to account for GRE overhead. Determining the proper MTU
value often takes experimentation, but 1454 bytes works in most value often takes experimentation, but 1454 bytes works in most
@ -319,7 +320,7 @@ The DHCP agent provides DHCP services for virtual networks.
method. method.
#. Open the :file:`/etc/neutron/dhcp_agent.ini` file and edit the #. Open the :file:`/etc/neutron/dhcp_agent.ini` file and edit the
``[DEFAULT]`` section. Enable the dnsmasq configuration file: ``[DEFAULT]`` section. Enable the :term:`dnsmasq` configuration file:
.. code-block:: ini .. code-block:: ini
@ -342,8 +343,8 @@ The DHCP agent provides DHCP services for virtual networks.
**To configure the metadata agent** **To configure the metadata agent**
The metadata agent provides configuration information such as The :term:`metadata agent <Metadata agent>` provides configuration information
credentials to instances. such as credentials to instances.
#. Open the :file:`/etc/neutron/metadata_agent.ini` file and edit the #. Open the :file:`/etc/neutron/metadata_agent.ini` file and edit the
``[DEFAULT]`` section, configure access parameters: ``[DEFAULT]`` section, configure access parameters:
@ -408,7 +409,7 @@ credentials to instances.
Replace ``METADATA_SECRET`` with the secret you chose for the metadata Replace ``METADATA_SECRET`` with the secret you chose for the metadata
proxy. proxy.
#. On the *controller* node, restart the Compute API service: #. On the *controller* node, restart the Compute :term:`API` service:
.. only:: rdo or obs .. only:: rdo or obs
@ -466,8 +467,8 @@ the virtual and physical external networks in your environment.
.. note:: .. note::
Depending on your network interface driver, you may need to disable Depending on your network interface driver, you may need to disable
generic receive offload (GRO) to achieve suitable throughput between :term:`generic receive offload (GRO)` to achieve suitable throughput
your instances and the external network. between your instances and the external network.
To temporarily disable GRO on the external network interface while To temporarily disable GRO on the external network interface while
testing your environment: testing your environment: