From 842f2f8e6cbd39c4eefddc9e1b74c0f7f8ea55ff Mon Sep 17 00:00:00 2001 From: Slawek Kaplonski Date: Thu, 26 Oct 2023 11:25:53 +0200 Subject: [PATCH] [Docs] Fix info about provider bridge name in the bridge_mappings Previously in all our install guides there were info that name of the physical interface should be put in the bridge_mappings config option in ths OVS agent's config. This wasn't correct as bridge_mappings expects there bridge name instead. Change-Id: I0698aa4621a15c1927ad2c352501cea02e6ee70c --- .../install/compute-install-option1-obs.rst | 21 ++++++++++++++----- .../install/compute-install-option1-rdo.rst | 19 +++++++++++++---- .../compute-install-option1-ubuntu.rst | 21 ++++++++++++++----- .../install/compute-install-option2-obs.rst | 21 ++++++++++++++----- .../install/compute-install-option2-rdo.rst | 21 ++++++++++++++----- .../compute-install-option2-ubuntu.rst | 21 ++++++++++++++----- .../controller-install-option1-obs.rst | 21 ++++++++++++++----- .../controller-install-option1-rdo.rst | 21 ++++++++++++++----- .../controller-install-option1-ubuntu.rst | 21 ++++++++++++++----- .../controller-install-option2-obs.rst | 21 ++++++++++++++----- .../controller-install-option2-rdo.rst | 21 ++++++++++++++----- .../controller-install-option2-ubuntu.rst | 21 ++++++++++++++----- 12 files changed, 191 insertions(+), 59 deletions(-) diff --git a/doc/source/install/compute-install-option1-obs.rst b/doc/source/install/compute-install-option1-obs.rst index 1cdad9186e7..f78239595e9 100644 --- a/doc/source/install/compute-install-option1-obs.rst +++ b/doc/source/install/compute-install-option1-obs.rst @@ -13,19 +13,30 @@ 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 bridge: .. path /etc/neutron/plugins/ml2/openvswitch_agent.ini .. code-block:: ini [ovs] - bridge_mappings = provider:PROVIDER_INTERFACE_NAME + bridge_mappings = provider:PROVIDER_BRIDGE_NAME .. end - Replace ``PROVIDER_INTERFACE_NAME`` with the name of the underlying - provider physical network interface. See :doc:`environment-networking-obs` - for more information. + Replace ``PROVIDER_BRIDGE_NAME`` with the name of the bridge connected to + the underlying provider physical network. + See :doc:`environment-networking-obs` + and :doc:`../admin/deploy-ovs-provider` for more information. + + * Ensure ``PROVIDER_BRIDGE_NAME`` external bridge is created and + ``PROVIDER_INTERFACE_NAME`` is added to that bridge + + .. code-block:: bash + + # ovs-vsctl add-br $PROVIDER_BRIDGE_NAME + # ovs-vsctl add-port $PROVIDER_BRIDGE_NAME $PROVIDER_INTERFACE_NAME + + .. end * In the ``[securitygroup]`` section, enable security groups and configure the Open vSwitch native or the hybrid iptables firewall driver: diff --git a/doc/source/install/compute-install-option1-rdo.rst b/doc/source/install/compute-install-option1-rdo.rst index 878f7d0fbe9..e91e84e2802 100644 --- a/doc/source/install/compute-install-option1-rdo.rst +++ b/doc/source/install/compute-install-option1-rdo.rst @@ -13,20 +13,31 @@ 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 bridge: .. path /etc/neutron/plugins/ml2/openvswitch_agent.ini .. code-block:: ini [ovs] - bridge_mappings = provider:PROVIDER_INTERFACE_NAME + bridge_mappings = provider:PROVIDER_BRIDGE_NAME .. end - Replace ``PROVIDER_INTERFACE_NAME`` with the name of the underlying - provider physical network interface. See :doc:`environment-networking-rdo` + Replace ``PROVIDER_BRIDGE_NAME`` with the name of the bridge connected to + the underlying provider physical network. + See :doc:`environment-networking-rdo` and :doc:`../admin/deploy-ovs-provider` for more information. + * Ensure ``PROVIDER_BRIDGE_NAME`` external bridge is created and + ``PROVIDER_INTERFACE_NAME`` is added to that bridge + + .. code-block:: bash + + # ovs-vsctl add-br $PROVIDER_BRIDGE_NAME + # ovs-vsctl add-port $PROVIDER_BRIDGE_NAME $PROVIDER_INTERFACE_NAME + + .. end + * In the ``[securitygroup]`` section, enable security groups and configure the Open vSwitch native or the hybrid iptables firewall driver: diff --git a/doc/source/install/compute-install-option1-ubuntu.rst b/doc/source/install/compute-install-option1-ubuntu.rst index 17f93525d4a..a047c4f1e81 100644 --- a/doc/source/install/compute-install-option1-ubuntu.rst +++ b/doc/source/install/compute-install-option1-ubuntu.rst @@ -13,19 +13,30 @@ 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 bridge: .. path /etc/neutron/plugins/ml2/openvswitch_agent.ini .. code-block:: ini [ovs] - bridge_mappings = provider:PROVIDER_INTERFACE_NAME + bridge_mappings = provider:PROVIDER_BRIDGE_NAME .. end - Replace ``PROVIDER_INTERFACE_NAME`` with the name of the underlying - provider physical network interface. See :doc:`environment-networking-ubuntu` - for more information. + Replace ``PROVIDER_BRIDGE_NAME`` with the name of the bridge connected to + the underlying provider physical network. + See :doc:`environment-networking-ubuntu` and + :doc:`../admin/deploy-ovs-provider` for more information. + + * Ensure ``PROVIDER_BRIDGE_NAME`` external bridge is created and + ``PROVIDER_INTERFACE_NAME`` is added to that bridge + + .. code-block:: bash + + # ovs-vsctl add-br $PROVIDER_BRIDGE_NAME + # ovs-vsctl add-port $PROVIDER_BRIDGE_NAME $PROVIDER_INTERFACE_NAME + + .. end * In the ``[securitygroup]`` section, enable security groups and configure the Open vSwitch native or the hybrid iptables firewall driver: diff --git a/doc/source/install/compute-install-option2-obs.rst b/doc/source/install/compute-install-option2-obs.rst index 23faf238061..9a7d0a7d111 100644 --- a/doc/source/install/compute-install-option2-obs.rst +++ b/doc/source/install/compute-install-option2-obs.rst @@ -13,21 +13,22 @@ 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 and configure the IP address of + provider physical bridge 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 + bridge_mappings = provider:PROVIDER_BRIDGE_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-obs` - for more information. + Replace ``PROVIDER_BRIDGE_NAME`` with the name of the bridge connected to + the underlying provider physical network. + See :doc:`environment-networking-obs` + and :doc:`../admin/deploy-ovs-provider` for more information. Also replace ``OVERLAY_INTERFACE_IP_ADDRESS`` with the IP address of the underlying physical network interface that handles overlay networks. The @@ -36,6 +37,16 @@ networking infrastructure for instances and handles security groups. the management IP address of the compute node. See :doc:`environment-networking-obs` for more information. + * Ensure ``PROVIDER_BRIDGE_NAME`` external bridge is created and + ``PROVIDER_INTERFACE_NAME`` is added to that bridge + + .. code-block:: bash + + # ovs-vsctl add-br $PROVIDER_BRIDGE_NAME + # ovs-vsctl add-port $PROVIDER_BRIDGE_NAME $PROVIDER_INTERFACE_NAME + + .. end + * In the ``[agent]`` section, enable VXLAN overlay networks and enable layer-2 population: diff --git a/doc/source/install/compute-install-option2-rdo.rst b/doc/source/install/compute-install-option2-rdo.rst index 1c05af2ab26..71811cd6024 100644 --- a/doc/source/install/compute-install-option2-rdo.rst +++ b/doc/source/install/compute-install-option2-rdo.rst @@ -13,21 +13,22 @@ 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 and configure the IP address of + provider physical bridge 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 + bridge_mappings = provider:PROVIDER_BRIDGE_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-rdo` - for more information. + Replace ``PROVIDER_BRIDGE_NAME`` with the name of the bridge connected to + the underlying provider physical network. + See :doc:`environment-networking-rdo` + and :doc:`../admin/deploy-ovs-provider` for more information. Also replace ``OVERLAY_INTERFACE_IP_ADDRESS`` with the IP address of the underlying physical network interface that handles overlay networks. The @@ -36,6 +37,16 @@ networking infrastructure for instances and handles security groups. the management IP address of the compute node. See :doc:`environment-networking-rdo` for more information. + * Ensure ``PROVIDER_BRIDGE_NAME`` external bridge is created and + ``PROVIDER_INTERFACE_NAME`` is added to that bridge + + .. code-block:: bash + + # ovs-vsctl add-br $PROVIDER_BRIDGE_NAME + # ovs-vsctl add-port $PROVIDER_BRIDGE_NAME $PROVIDER_INTERFACE_NAME + + .. end + * In the ``[agent]`` section, enable VXLAN overlay networks and enable layer-2 population: diff --git a/doc/source/install/compute-install-option2-ubuntu.rst b/doc/source/install/compute-install-option2-ubuntu.rst index 6c384cf3b34..77e0fa5270f 100644 --- a/doc/source/install/compute-install-option2-ubuntu.rst +++ b/doc/source/install/compute-install-option2-ubuntu.rst @@ -13,21 +13,22 @@ 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 and configure the IP address of + provider physical bridge 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 + bridge_mappings = provider:PROVIDER_BRIDGE_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. + Replace ``PROVIDER_BRIDGE_NAME`` with the name of the bridge connected to + the underlying provider physical network. + See :doc:`environment-networking-ubuntu` and + :doc:`../admin/deploy-ovs-provider` for more information. Also replace ``OVERLAY_INTERFACE_IP_ADDRESS`` with the IP address of the underlying physical network interface that handles overlay networks. The @@ -36,6 +37,16 @@ networking infrastructure for instances and handles security groups. the management IP address of the compute node. See :doc:`environment-networking-ubuntu` for more information. + * Ensure ``PROVIDER_BRIDGE_NAME`` external bridge is created and + ``PROVIDER_INTERFACE_NAME`` is added to that bridge + + .. code-block:: bash + + # ovs-vsctl add-br $PROVIDER_BRIDGE_NAME + # ovs-vsctl add-port $PROVIDER_BRIDGE_NAME $PROVIDER_INTERFACE_NAME + + .. end + * In the ``[agent]`` section, enable VXLAN overlay networks and enable layer-2 population: diff --git a/doc/source/install/controller-install-option1-obs.rst b/doc/source/install/controller-install-option1-obs.rst index adfdf2dabc5..f19d20b3378 100644 --- a/doc/source/install/controller-install-option1-obs.rst +++ b/doc/source/install/controller-install-option1-obs.rst @@ -226,19 +226,30 @@ 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 bridge: .. path /etc/neutron/plugins/ml2/openvswitch_agent.ini .. code-block:: ini [ovs] - bridge_mappings = provider:PROVIDER_INTERFACE_NAME + bridge_mappings = provider:PROVIDER_BRIDGE_NAME .. end - Replace ``PROVIDER_INTERFACE_NAME`` with the name of the underlying - provider physical network interface. See :doc:`environment-networking-obs` - for more information. + Replace ``PROVIDER_BRIDGE_NAME`` with the name of the bridge connected to + the underlying provider physical network. + See :doc:`environment-networking-obs` + and :doc:`../admin/deploy-ovs-provider` for more information. + + * Ensure ``PROVIDER_BRIDGE_NAME`` external bridge is created and + ``PROVIDER_INTERFACE_NAME`` is added to that bridge + + .. code-block:: bash + + # ovs-vsctl add-br $PROVIDER_BRIDGE_NAME + # ovs-vsctl add-port $PROVIDER_BRIDGE_NAME $PROVIDER_INTERFACE_NAME + + .. end * In the ``[securitygroup]`` section, enable security groups and configure the Open vSwitch native or the hybrid iptables firewall driver: diff --git a/doc/source/install/controller-install-option1-rdo.rst b/doc/source/install/controller-install-option1-rdo.rst index 495d185d9a9..e24857d43c0 100644 --- a/doc/source/install/controller-install-option1-rdo.rst +++ b/doc/source/install/controller-install-option1-rdo.rst @@ -224,19 +224,30 @@ 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 bridge: .. path /etc/neutron/plugins/ml2/openvswitch_agent.ini .. code-block:: ini [ovs] - bridge_mappings = provider:PROVIDER_INTERFACE_NAME + bridge_mappings = provider:PROVIDER_BRIDGE_NAME .. end - Replace ``PROVIDER_INTERFACE_NAME`` with the name of the underlying - provider physical network interface. See :doc:`environment-networking-rdo` - for more information. + Replace ``PROVIDER_BRIDGE_NAME`` with the name of the bridge connected to + the underlying provider physical network. + See :doc:`environment-networking-rdo` + and :doc:`../admin/deploy-ovs-provider` for more information. + + * Ensure ``PROVIDER_BRIDGE_NAME`` external bridge is created and + ``PROVIDER_INTERFACE_NAME`` is added to that bridge + + .. code-block:: bash + + # ovs-vsctl add-br $PROVIDER_BRIDGE_NAME + # ovs-vsctl add-port $PROVIDER_BRIDGE_NAME $PROVIDER_INTERFACE_NAME + + .. end * In the ``[securitygroup]`` section, enable security groups and configure the Open vSwitch native or the hybrid iptables firewall driver: diff --git a/doc/source/install/controller-install-option1-ubuntu.rst b/doc/source/install/controller-install-option1-ubuntu.rst index 34cf0d50671..ec7e8a56af1 100644 --- a/doc/source/install/controller-install-option1-ubuntu.rst +++ b/doc/source/install/controller-install-option1-ubuntu.rst @@ -225,19 +225,30 @@ 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 bridge: .. path /etc/neutron/plugins/ml2/openvswitch_agent.ini .. code-block:: ini [ovs] - bridge_mappings = provider:PROVIDER_INTERFACE_NAME + bridge_mappings = provider:PROVIDER_BRIDGE_NAME .. end - Replace ``PROVIDER_INTERFACE_NAME`` with the name of the underlying - provider physical network interface. See :doc:`environment-networking-ubuntu` - for more information. + Replace ``PROVIDER_BRIDGE_NAME`` with the name of the bridge connected to + the underlying provider physical network. + See :doc:`environment-networking-ubuntu` + and :doc:`../admin/deploy-ovs-provider` for more information. + + * Ensure ``PROVIDER_BRIDGE_NAME`` external bridge is created and + ``PROVIDER_INTERFACE_NAME`` is added to that bridge + + .. code-block:: bash + + # ovs-vsctl add-br $PROVIDER_BRIDGE_NAME + # ovs-vsctl add-port $PROVIDER_BRIDGE_NAME $PROVIDER_INTERFACE_NAME + + .. end * In the ``[securitygroup]`` section, enable security groups and configure the Open vSwitch native or the hybrid iptables firewall driver: diff --git a/doc/source/install/controller-install-option2-obs.rst b/doc/source/install/controller-install-option2-obs.rst index e2d4acc2451..340690d062e 100644 --- a/doc/source/install/controller-install-option2-obs.rst +++ b/doc/source/install/controller-install-option2-obs.rst @@ -237,21 +237,22 @@ 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 and configure the IP address of + provider physical bridge 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 + bridge_mappings = provider:PROVIDER_BRIDGE_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-obs` - for more information. + Replace ``PROVIDER_BRIDGE_NAME`` with the name of the bridge connected to + the underlying provider physical network. + See :doc:`environment-networking-obs` + and :doc:`../admin/deploy-ovs-provider` for more information. Also replace ``OVERLAY_INTERFACE_IP_ADDRESS`` with the IP address of the underlying physical network interface that handles overlay networks. The @@ -260,6 +261,16 @@ networking infrastructure for instances and handles security groups. the management IP address of the controller node. See :doc:`environment-networking-obs` for more information. + * Ensure ``PROVIDER_BRIDGE_NAME`` external bridge is created and + ``PROVIDER_INTERFACE_NAME`` is added to that bridge + + .. code-block:: bash + + # ovs-vsctl add-br $PROVIDER_BRIDGE_NAME + # ovs-vsctl add-port $PROVIDER_BRIDGE_NAME $PROVIDER_INTERFACE_NAME + + .. end + * In the ``[agent]`` section, enable VXLAN overlay networks and enable layer-2 population: diff --git a/doc/source/install/controller-install-option2-rdo.rst b/doc/source/install/controller-install-option2-rdo.rst index 13a510f73de..e9d7baec4b4 100644 --- a/doc/source/install/controller-install-option2-rdo.rst +++ b/doc/source/install/controller-install-option2-rdo.rst @@ -239,21 +239,22 @@ 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 and configure the IP address of + provider physical bridge 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 + bridge_mappings = provider:PROVIDER_BRIDGE_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-rdo` - for more information. + Replace ``PROVIDER_BRIDGE_NAME`` with the name of the bridge connected to + the underlying provider physical network. + See :doc:`environment-networking-rdo` + and :doc:`../admin/deploy-ovs-provider` for more information. Also replace ``OVERLAY_INTERFACE_IP_ADDRESS`` with the IP address of the underlying physical network interface that handles overlay networks. The @@ -262,6 +263,16 @@ networking infrastructure for instances and handles security groups. the management IP address of the controller node. See :doc:`environment-networking-rdo` for more information. + * Ensure ``PROVIDER_BRIDGE_NAME`` external bridge is created and + ``PROVIDER_INTERFACE_NAME`` is added to that bridge + + .. code-block:: bash + + # ovs-vsctl add-br $PROVIDER_BRIDGE_NAME + # ovs-vsctl add-port $PROVIDER_BRIDGE_NAME $PROVIDER_INTERFACE_NAME + + .. end + * In the ``[agent]`` section, enable VXLAN overlay networks and enable layer-2 population: diff --git a/doc/source/install/controller-install-option2-ubuntu.rst b/doc/source/install/controller-install-option2-ubuntu.rst index f12cba9c3ad..7646c80fa71 100644 --- a/doc/source/install/controller-install-option2-ubuntu.rst +++ b/doc/source/install/controller-install-option2-ubuntu.rst @@ -240,21 +240,22 @@ 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 and configure the IP address of + provider physical bridge 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 + bridge_mappings = provider:PROVIDER_BRIDGE_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. + Replace ``PROVIDER_BRIDGE_NAME`` with the name of the bridge connected to + the underlying provider physical network. + See :doc:`environment-networking-ubuntu` + and :doc:`../admin/deploy-ovs-provider` for more information. Also replace ``OVERLAY_INTERFACE_IP_ADDRESS`` with the IP address of the underlying physical network interface that handles overlay networks. The @@ -263,6 +264,16 @@ networking infrastructure for instances and handles security groups. the management IP address of the controller node. See :doc:`environment-networking-ubuntu` for more information. + * Ensure ``PROVIDER_BRIDGE_NAME`` external bridge is created and + ``PROVIDER_INTERFACE_NAME`` is added to that bridge + + .. code-block:: bash + + # ovs-vsctl add-br $PROVIDER_BRIDGE_NAME + # ovs-vsctl add-port $PROVIDER_BRIDGE_NAME $PROVIDER_INTERFACE_NAME + + .. end + * In the ``[agent]`` section, enable VXLAN overlay networks and enable layer-2 population: