openstack
/
neutron
Code Issues Proposed changes

doc: Fix wrong sections of ovs-agent config options 

The sections described in the documentation does not match the actual
section names in current neutron.

 * local_ip now belongs to the [ovs] section
 * tunnel_types now belongs to the [agent] section
 * l2_population now belongs to the [agent] section

Also the tunnel_types option is not explained in the example snippet.

Change-Id: Ic2bde217a03a884855d299f3142394a4229745bc
This commit is contained in:
Takashi Kajinami 2023-10-25 16:36:18 +09:00
parent dad8c3fecc
commit 34f7a5805e
6 changed files with 100 additions and 94 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
doc/source/install/compute-install-option2-obs.rst
View File

@ -13,13 +13,15 @@ networking infrastructure for instances and handles security groups.
complete the following actions:
* In the ``[ovs]`` section, map the provider virtual network to the
provider physical network interface:
provider physical network interface and configure the IP address of
the physical network interface that handles overlay networks:
.. path /etc/neutron/plugins/ml2/openvswitch_agent.ini
.. code-block:: ini
[ovs]
bridge_mappings = provider:PROVIDER_INTERFACE_NAME
local_ip = OVERLAY_INTERFACE_IP_ADDRESS
.. end
@ -27,26 +29,25 @@ networking infrastructure for instances and handles security groups.
provider physical network interface. See :doc:`environment-networking-obs`
for more information.
* In the ``[vxlan]`` section, configure the IP address of the physical
network interface that handles overlay networks and enable layer-2
population:
.. path /etc/neutron/plugins/ml2/openvswitch_agent.ini
.. code-block:: ini
[vxlan]
local_ip = OVERLAY_INTERFACE_IP_ADDRESS
l2_population = true
.. end
Replace ``OVERLAY_INTERFACE_IP_ADDRESS`` with the IP address of the
Also replace ``OVERLAY_INTERFACE_IP_ADDRESS`` with the IP address of the
underlying physical network interface that handles overlay networks. The
example architecture uses the management interface to tunnel traffic to
the other nodes. Therefore, replace ``OVERLAY_INTERFACE_IP_ADDRESS`` with
the management IP address of the compute node. See
:doc:`environment-networking-obs` for more information.
* In the ``[agent]`` section, enable VXLAN overlay networks and enable
layer-2 population:
.. path /etc/neutron/plugins/ml2/openvswitch_agent.ini
.. code-block:: ini
[agent]
tunnel_types = vxlan
l2_population = true
.. end
* In the ``[securitygroup]`` section, enable security groups and
configure the Open vSwitch native or the hybrid iptables firewall driver:

33
doc/source/install/compute-install-option2-rdo.rst
View File

@ -13,13 +13,15 @@ networking infrastructure for instances and handles security groups.
complete the following actions:
* In the ``[ovs]`` section, map the provider virtual network to the
provider physical network interface:
provider physical network interface and configure the IP address of
the physical network interface that handles overlay networks:
.. path /etc/neutron/plugins/ml2/openvswitch_agent.ini
.. code-block:: ini
[ovs]
bridge_mappings = provider:PROVIDER_INTERFACE_NAME
local_ip = OVERLAY_INTERFACE_IP_ADDRESS
.. end
@ -27,25 +29,24 @@ networking infrastructure for instances and handles security groups.
provider physical network interface. See :doc:`environment-networking-rdo`
for more information.
* In the ``[vxlan]`` section, configure the IP address of the physical
network interface that handles overlay networks and enable layer-2
population:
.. path /etc/neutron/plugins/ml2/openvswitch_agent.ini
.. code-block:: ini
[vxlan]
local_ip = OVERLAY_INTERFACE_IP_ADDRESS
l2_population = true
.. end
Replace ``OVERLAY_INTERFACE_IP_ADDRESS`` with the IP address of the
Also replace ``OVERLAY_INTERFACE_IP_ADDRESS`` with the IP address of the
underlying physical network interface that handles overlay networks. The
example architecture uses the management interface to tunnel traffic to
the other nodes. Therefore, replace ``OVERLAY_INTERFACE_IP_ADDRESS`` with
the management IP address of the compute node. See
:doc:`environment-networking-obs` for more information.
:doc:`environment-networking-rdo` for more information.
* In the ``[agent]`` section, enable VXLAN overlay networks and enable
layer-2 population:
.. path /etc/neutron/plugins/ml2/openvswitch_agent.ini
.. code-block:: ini
[agent]
tunnel_types = vxlan
l2_population = true
.. end
* In the ``[securitygroup]`` section, enable security groups and
configure the Open vSwitch native or the hybrid iptables firewall driver:

33
doc/source/install/compute-install-option2-ubuntu.rst
View File

@ -13,13 +13,15 @@ networking infrastructure for instances and handles security groups.
complete the following actions:
* In the ``[ovs]`` section, map the provider virtual network to the
provider physical network interface:
provider physical network interface and configure the IP address of
the physical network interface that handles overlay networks:
.. path /etc/neutron/plugins/ml2/openvswitch_agent.ini
.. code-block:: ini
[ovs]
bridge_mappings = provider:PROVIDER_INTERFACE_NAME
local_ip = OVERLAY_INTERFACE_IP_ADDRESS
.. end
@ -27,25 +29,24 @@ networking infrastructure for instances and handles security groups.
provider physical network interface.
See :doc:`environment-networking-ubuntu` for more information.
* In the ``[vxlan]`` section, configure the IP address of the physical
network interface that handles overlay networks and enable layer-2
population:
.. path /etc/neutron/plugins/ml2/openvswitch_agent.ini
.. code-block:: ini
[vxlan]
local_ip = OVERLAY_INTERFACE_IP_ADDRESS
l2_population = true
.. end
Replace ``OVERLAY_INTERFACE_IP_ADDRESS`` with the IP address of the
Also replace ``OVERLAY_INTERFACE_IP_ADDRESS`` with the IP address of the
underlying physical network interface that handles overlay networks. The
example architecture uses the management interface to tunnel traffic to
the other nodes. Therefore, replace ``OVERLAY_INTERFACE_IP_ADDRESS`` with
the management IP address of the compute node. See
:doc:`environment-networking-obs` for more information.
:doc:`environment-networking-ubuntu` for more information.
* In the ``[agent]`` section, enable VXLAN overlay networks and enable
layer-2 population:
.. path /etc/neutron/plugins/ml2/openvswitch_agent.ini
.. code-block:: ini
[agent]
tunnel_types = vxlan
l2_population = true
.. end
* In the ``[securitygroup]`` section, enable security groups and
configure the Open vSwitch native or the hybrid iptables firewall driver:

31
doc/source/install/controller-install-option2-obs.rst
View File

@ -237,13 +237,15 @@ networking infrastructure for instances and handles security groups.
complete the following actions:
* In the ``[ovs]`` section, map the provider virtual network to the
provider physical network interface:
provider physical network interface and configure the IP address of
the physical network interface that handles overlay networks:
.. path /etc/neutron/plugins/ml2/openvswitch_agent.ini
.. code-block:: ini
[ovs]
bridge_mappings = provider:PROVIDER_INTERFACE_NAME
local_ip = OVERLAY_INTERFACE_IP_ADDRESS
.. end
@ -251,26 +253,25 @@ networking infrastructure for instances and handles security groups.
provider physical network interface. See :doc:`environment-networking-obs`
for more information.
* In the ``[vxlan]`` section, enable VXLAN overlay networks, configure the
IP address of the physical network interface that handles overlay
networks, and enable layer-2 population:
.. path /etc/neutron/plugins/ml2/openvswitch_agent.ini
.. code-block:: ini
[vxlan]
local_ip = OVERLAY_INTERFACE_IP_ADDRESS
l2_population = true
.. end
Replace ``OVERLAY_INTERFACE_IP_ADDRESS`` with the IP address of the
Also replace ``OVERLAY_INTERFACE_IP_ADDRESS`` with the IP address of the
underlying physical network interface that handles overlay networks. The
example architecture uses the management interface to tunnel traffic to
the other nodes. Therefore, replace ``OVERLAY_INTERFACE_IP_ADDRESS`` with
the management IP address of the controller node. See
:doc:`environment-networking-obs` for more information.
* In the ``[agent]`` section, enable VXLAN overlay networks and enable
layer-2 population:
.. path /etc/neutron/plugins/ml2/openvswitch_agent.ini
.. code-block:: ini
[agent]
tunnel_types = vxlan
l2_population = true
.. end
* In the ``[securitygroup]`` section, enable security groups and
configure the Open vSwitch native or the hybrid iptables firewall driver:

31
doc/source/install/controller-install-option2-rdo.rst
View File

@ -239,13 +239,15 @@ networking infrastructure for instances and handles security groups.
complete the following actions:
* In the ``[ovs]`` section, map the provider virtual network to the
provider physical network interface:
provider physical network interface and configure the IP address of
the physical network interface that handles overlay networks:
.. path /etc/neutron/plugins/ml2/openvswitch_agent.ini
.. code-block:: ini
[ovs]
bridge_mappings = provider:PROVIDER_INTERFACE_NAME
local_ip = OVERLAY_INTERFACE_IP_ADDRESS
.. end
@ -253,26 +255,25 @@ networking infrastructure for instances and handles security groups.
provider physical network interface. See :doc:`environment-networking-rdo`
for more information.
* In the ``[vxlan]`` section, enable VXLAN overlay networks, configure the
IP address of the physical network interface that handles overlay
networks, and enable layer-2 population:
.. path /etc/neutron/plugins/ml2/openvswitch_agent.ini
.. code-block:: ini
[vxlan]
local_ip = OVERLAY_INTERFACE_IP_ADDRESS
l2_population = true
.. end
Replace ``OVERLAY_INTERFACE_IP_ADDRESS`` with the IP address of the
Also replace ``OVERLAY_INTERFACE_IP_ADDRESS`` with the IP address of the
underlying physical network interface that handles overlay networks. The
example architecture uses the management interface to tunnel traffic to
the other nodes. Therefore, replace ``OVERLAY_INTERFACE_IP_ADDRESS`` with
the management IP address of the controller node. See
:doc:`environment-networking-rdo` for more information.
* In the ``[agent]`` section, enable VXLAN overlay networks and enable
layer-2 population:
.. path /etc/neutron/plugins/ml2/openvswitch_agent.ini
.. code-block:: ini
[agent]
tunnel_types = vxlan
l2_population = true
.. end
* In the ``[securitygroup]`` section, enable security groups and
configure the Open vSwitch native or the hybrid iptables firewall driver:

35
doc/source/install/controller-install-option2-ubuntu.rst
View File

@ -240,40 +240,41 @@ networking infrastructure for instances and handles security groups.
complete the following actions:
* In the ``[ovs]`` section, map the provider virtual network to the
provider physical network interface:
provider physical network interface and configure the IP address of
the physical network interface that handles overlay networks:
.. path /etc/neutron/plugins/ml2/openvswitch_agent.ini
.. code-block:: ini
[ovs]
bridge_mappings = provider:PROVIDER_INTERFACE_NAME
local_ip = OVERLAY_INTERFACE_IP_ADDRESS
.. end
Replace ``PROVIDER_INTERFACE_NAME`` with the name of the underlying
provider physical network interface. See :doc:`environment-networking-ubuntu`
for more information.
provider physical network interface.
See :doc:`environment-networking-ubuntu` for more information.
* In the ``[vxlan]`` section, enable VXLAN overlay networks, configure the
IP address of the physical network interface that handles overlay
networks, and enable layer-2 population:
.. path /etc/neutron/plugins/ml2/linuxbridge_agent.ini
.. code-block:: ini
[vxlan]
local_ip = OVERLAY_INTERFACE_IP_ADDRESS
l2_population = true
.. end
Replace ``OVERLAY_INTERFACE_IP_ADDRESS`` with the IP address of the
Also replace ``OVERLAY_INTERFACE_IP_ADDRESS`` with the IP address of the
underlying physical network interface that handles overlay networks. The
example architecture uses the management interface to tunnel traffic to
the other nodes. Therefore, replace ``OVERLAY_INTERFACE_IP_ADDRESS`` with
the management IP address of the controller node. See
:doc:`environment-networking-ubuntu` for more information.
* In the ``[agent]`` section, enable VXLAN overlay networks and enable
layer-2 population:
.. path /etc/neutron/plugins/ml2/openvswitch_agent.ini
.. code-block:: ini
[agent]
tunnel_types = vxlan
l2_population = true
.. end
* In the ``[securitygroup]`` section, enable security groups and
configure the Open vSwitch native or the hybrid iptables firewall driver: