[2023.1 Only][OVN] Add the bridge name and datapath type to the port

VIF details

In this 2023.1 branch only version the retrieval of the bridge_name
is done by checking either Chassis or Chassis_Private table. The ovn
metadata agent uses already present `has_chassis_private` attribute
to detect Chassis or Chassis_Private.
The mech_driver checks `agent_chassis_table` name to retrieve from
either Chassis_Private or Chassis

Same as in ML2/OVS, the ML2/OVN mechanism driver adds to the port
VIF details dictionary the OVS bridge the port is connected to
and the integration bridge datapath type.

Conflicts:
    neutron/common/_constants.py
    neutron/plugins/ml2/drivers/ovn/mech_driver/mech_driver.py
    neutron/tests/unit/plugins/ml2/drivers/ovn/mech_driver/test_mech_driver.py

Closes-Bug: #2045889
(cherry picked from commit baaf240)
Change-Id: Id299eb7faf540b41836513bfb566157c8996a355

Author: ralonsoh

neutron/agent/ovn/metadata/agent.py

@@ -309,13 +309,33 @@ def _load_config(self):
         LOG.debug("Loaded chassis name %s (UUID: %s) and ovn bridge %s.",
                   self.chassis, self.chassis_id, self.ovn_bridge)
 
+    def _update_chassis_config(self):
+        """Update the Chassis register information
+
+        This method should be called once the Metadata Agent has been
+        registered (method ``register_metadata_agent`` has been called) and
+        the corresponding Chasis or Chassis_Private register has been
+        created/updated. The Chassis table is used in an event when OVN does
+        not have the Chassis_Private.
+        """
+        external_ids = {ovn_const.OVN_AGENT_OVN_BRIDGE: self.ovn_bridge}
+        if self.has_chassis_private:
+            self.sb_idl.db_set(
+                'Chassis_Private', self.chassis,
+                ('external_ids', external_ids)).execute(check_error=True)
+        else:
+            self.sb_idl.db_set(
+                'Chassis', self.chassis,
+                ('external_ids', external_ids)).execute(check_error=True)
+
     @_sync_lock
     def resync(self):
         """Resync the agent.
 
         Reload the configuration and sync the agent again.
         """
         self._load_config()
+        self._update_chassis_config()
         self.sync()
 
     def start(self):
@@ -361,6 +381,7 @@ def start(self):
 
         # Register the agent with its corresponding Chassis
         self.register_metadata_agent()
+        self._update_chassis_config()
 
         self._proxy.wait()
 

neutron/common/_constants.py

@@ -89,3 +89,6 @@
 
 # Neutron-lib defines this with a /64 but it should be /128
 METADATA_V6_CIDR = constants.METADATA_V6_IP + '/128'
+
+# TODO(ralonsoh): move this constant to neutron_lib.plugins.ml2.ovs_constants
+DEFAULT_BR_INT = 'br-int'

neutron/common/ovn/constants.py

@@ -71,6 +71,8 @@
 OVN_NAME_PREFIX = 'neutron-'
 OVN_HA_CH_GROUP_EXTPORT_PREFIX = 'neutron-extport-'
 
+OVN_DATAPATH_TYPE = 'datapath-type'
+
 # TODO(froyo): Move this to neutron-lib as soon as possible, and when a new
 # release is created and pointed to in the requirements remove this code
 OVN_LB_HM_PORT_DISTRIBUTED = 'ovn-lb-hm:distributed'
@@ -83,6 +85,7 @@
 OVN_AGENT_NEUTRON_SB_CFG_KEY = 'neutron:ovn-neutron-agent-sb-cfg'
 OVN_AGENT_NEUTRON_DESC_KEY = 'neutron:description-neutron-agent'
 OVN_AGENT_NEUTRON_ID_KEY = 'neutron:ovn-neutron-agent-id'
+OVN_AGENT_OVN_BRIDGE = 'neutron:ovn-bridge'
 OVN_CONTROLLER_AGENT = 'OVN Controller agent'
 OVN_CONTROLLER_GW_AGENT = 'OVN Controller Gateway agent'
 OVN_METADATA_AGENT = 'OVN Metadata agent'

neutron/common/ovn/utils.py

@@ -40,6 +40,7 @@
 import tenacity
 
 from neutron._i18n import _
+from neutron.common import _constants as n_const
 from neutron.common.ovn import constants
 from neutron.common.ovn import exceptions as ovn_exc
 from neutron.common import utils as common_utils
@@ -702,6 +703,32 @@ def get_ovn_cms_options(chassis):
         constants.OVN_CMS_OPTIONS, '').split(',')]
 
 
+def get_ovn_bridge_from_chassis(chassis):
+    """Return the OVN bridge used by the local OVN controller
+
+    This information is stored in the Chassis or Chassis_Private register by
+    the OVN Metadata agent. The default value returned, if not present, is
+    "br-int".
+    NOTE: the default value is not reading the local ``OVS.integration_bridge``
+    configuration knob, that could be different.
+    """
+    return (chassis.external_ids.get(constants.OVN_AGENT_OVN_BRIDGE) or
+            n_const.DEFAULT_BR_INT)
+
+
+def get_datapath_type(hostname, sb_idl):
+    """Return the local OVS integration bridge datapath type
+
+    If the datapath type is not stored in the ``Chassis`` register or
+    the register is still not created, the default value returned is "".
+    """
+    chassis = sb_idl.db_find(
+        'Chassis', ('hostname', '=', hostname)).execute(check_error=True)
+    return (
+        chassis[0].get('other_config', {}).get(constants.OVN_DATAPATH_TYPE, '')
+        if chassis else '')
+
+
 def is_gateway_chassis(chassis):
     """Check if the given chassis is a gateway chassis"""
     return constants.CMS_OPT_CHASSIS_AS_GW in get_ovn_cms_options(chassis)

neutron/plugins/ml2/drivers/ovn/db_migration.py

@@ -11,6 +11,7 @@
 #    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 #    License for the specific language governing permissions and limitations
 #    under the License.
+import copy
 
 from neutron_lib.api.definitions import portbindings as pb_api
 from neutron_lib import context as n_context
@@ -20,6 +21,7 @@
 from oslo_log import log as logging
 from sqlalchemy.orm import exc as sqla_exc
 
+from neutron.common import _constants as n_const
 from neutron.db.models.plugins.ml2 import geneveallocation
 from neutron.db.models.plugins.ml2 import vxlanallocation
 from neutron.objects import network as network_obj
@@ -29,10 +31,6 @@
 
 LOG = logging.getLogger(__name__)
 
-VIF_DETAILS_TO_REMOVE = (
-    pb_api.VIF_DETAILS_BRIDGE_NAME,
-)
-
 
 def migrate_neutron_database_to_ovn():
     """Change DB content from OVS to OVN mech driver.
@@ -74,18 +72,22 @@ def migrate_neutron_database_to_ovn():
                 with db_api.CONTEXT_WRITER.using(ctx):
                     pb = port_obj.PortBinding.get_object(ctx, port_id=port_id,
                                                          host=host)
-                    if not pb or not pb.vif_details:
+                    if not pb:
                         continue
 
-                    vif_details = pb.vif_details.copy()
-                    for detail in VIF_DETAILS_TO_REMOVE:
-                        try:
-                            del vif_details[detail]
-                        except KeyError:
-                            pass
-                    if vif_details == pb.vif_details:
+                    # Update the OVS bridge name in the VIF details: now all
+                    # port are directly connected to the integration bridge.
+                    # Because the name of each host integration bridge is not
+                    # know by the Neutron API at this point, the default value
+                    # "br-int" will be used.
+                    # The OVS datapath type is unchanged.
+                    vif_details = copy.deepcopy(pb.vif_details) or {}
+                    if (vif_details.get(pb_api.VIF_DETAILS_BRIDGE_NAME) ==
+                            n_const.DEFAULT_BR_INT):
                         continue
 
+                    vif_details[pb_api.VIF_DETAILS_BRIDGE_NAME] = (
+                        n_const.DEFAULT_BR_INT)
                     pb.vif_details = vif_details
                     pb.update()
             except (exceptions.ObjectNotFound,

neutron/plugins/ml2/drivers/ovn/mech_driver/mech_driver.py

@@ -190,7 +190,7 @@ def get_supported_vif_types(self):
         vif_types = set()
         for ch in self.sb_ovn.chassis_list().execute(check_error=True):
             other_config = ovn_utils.get_ovn_chassis_other_config(ch)
-            dp_type = other_config.get('datapath-type', '')
+            dp_type = other_config.get(ovn_const.OVN_DATAPATH_TYPE, '')
             if dp_type == ovn_const.CHASSIS_DATAPATH_NETDEV:
                 vif_types.add(portbindings.VIF_TYPE_VHOST_USER)
             else:
@@ -988,7 +988,7 @@ def bind_port(self, context):
             return
         chassis = agent.chassis
         other_config = ovn_utils.get_ovn_chassis_other_config(chassis)
-        datapath_type = other_config.get('datapath-type', '')
+        datapath_type = other_config.get(ovn_const.OVN_DATAPATH_TYPE, '')
         iface_types = other_config.get('iface-types', '')
         iface_types = iface_types.split(',') if iface_types else []
         chassis_physnets = self.sb_ovn._get_chassis_physnets(chassis)
@@ -1035,13 +1035,25 @@ def bind_port(self, context):
                     vif_type = portbindings.VIF_TYPE_VHOST_USER
                     port[portbindings.VIF_DETAILS].update({
                         portbindings.VHOST_USER_SOCKET: vhost_user_socket})
-                    vif_details = dict(self.vif_details[vif_type])
+                    vif_details = copy.deepcopy(self.vif_details[vif_type])
                     vif_details[portbindings.VHOST_USER_SOCKET] = (
                         vhost_user_socket)
                 else:
                     vif_type = portbindings.VIF_TYPE_OVS
-                    vif_details = self.vif_details[vif_type]
+                    vif_details = copy.deepcopy(self.vif_details[vif_type])
 
+                if self.agent_chassis_table == 'Chassis_Private':
+                    chassis_to_retrieve = agent.chassis_private
+                else:
+                    chassis_to_retrieve = agent.chassis
+                ovn_bridge = ovn_utils.get_ovn_bridge_from_chassis(
+                    chassis_to_retrieve)
+
+                dp_type = ovn_utils.get_datapath_type(bind_host, self.sb_ovn)
+                vif_details.update({
+                    portbindings.VIF_DETAILS_BRIDGE_NAME: ovn_bridge,
+                    portbindings.OVS_DATAPATH_TYPE: dp_type,
+                })
                 context.set_binding(segment_to_bind[api.ID], vif_type,
                                     vif_details)
                 break

neutron/tests/functional/agent/ovn/metadata/test_metadata_agent.py

@@ -110,6 +110,11 @@ def _start_metadata_agent(self):
         with mock.patch.object(metadata_server.UnixDomainMetadataProxy,
                                'wait'):
             agt.start()
+            external_ids = agt.sb_idl.db_get(
+                'Chassis_Private', agt.chassis, 'external_ids').execute(
+                check_error=True)
+            self.assertEqual(external_ids[ovn_const.OVN_AGENT_OVN_BRIDGE],
+                             self.OVN_BRIDGE)
 
         # Metadata agent will open connections to OVS and SB databases.
         # Close connections to them when the test ends,

neutron/tests/functional/plugins/ml2/drivers/ovn/mech_driver/test_mech_driver.py

@@ -43,41 +43,48 @@
     portbindings.CAP_PORT_FILTER: True,
     portbindings.VIF_DETAILS_CONNECTIVITY: portbindings.CONNECTIVITY_L2,
     portbindings.VIF_DETAILS_BOUND_DRIVERS: {'0': 'ovn'},
+    portbindings.VIF_DETAILS_BRIDGE_NAME: 'br-int',
+    portbindings.OVS_DATAPATH_TYPE: 'system',
 }
 VHOSTUSER_VIF_DETAILS = {
     portbindings.CAP_PORT_FILTER: False,
     'vhostuser_mode': VHU_MODE,
     'vhostuser_ovs_plug': True,
     portbindings.VIF_DETAILS_CONNECTIVITY: portbindings.CONNECTIVITY_L2,
     portbindings.VIF_DETAILS_BOUND_DRIVERS: {'0': 'ovn'},
+    portbindings.VIF_DETAILS_BRIDGE_NAME: 'br-int',
+    portbindings.OVS_DATAPATH_TYPE: 'netdev',
 }
 
 
 class TestPortBinding(base.TestOVNFunctionalBase):
 
-    def setUp(self):
-        super(TestPortBinding, self).setUp()
+    def setUp(self, **kwargs):
+        super().setUp(**kwargs)
         self.ovs_host = 'ovs-host'
         self.dpdk_host = 'dpdk-host'
         self.invalid_dpdk_host = 'invalid-host'
         self.insecure_host = 'insecure-host'
         self.smartnic_dpu_host = 'smartnic-dpu-host'
         self.smartnic_dpu_serial = 'fake-smartnic-dpu-serial'
-        self.add_fake_chassis(self.ovs_host)
+        self.add_fake_chassis(
+            self.ovs_host,
+            other_config={ovn_const.OVN_DATAPATH_TYPE: 'system'})
         self.add_fake_chassis(
             self.dpdk_host,
-            other_config={'datapath-type': 'netdev',
+            other_config={ovn_const.OVN_DATAPATH_TYPE: 'netdev',
                           'iface-types': 'dummy,dummy-internal,dpdkvhostuser'})
 
         self.add_fake_chassis(
             self.invalid_dpdk_host,
-            other_config={'datapath-type': 'netdev',
+            other_config={ovn_const.OVN_DATAPATH_TYPE: 'netdev',
                           'iface-types': 'dummy,dummy-internal,geneve,vxlan'})
         self.add_fake_chassis(
             self.smartnic_dpu_host,
             other_config={ovn_const.OVN_CMS_OPTIONS: '{}={}'.format(
                 ovn_const.CMS_OPT_CARD_SERIAL_NUMBER,
-                self.smartnic_dpu_serial)})
+                self.smartnic_dpu_serial),
+                ovn_const.OVN_DATAPATH_TYPE: 'system'})
         self.n1 = self._make_network(self.fmt, 'n1', True)
         res = self._create_subnet(self.fmt, self.n1['network']['id'],
                                   '10.0.0.0/24')
@@ -151,9 +158,13 @@ def test_port_binding_create_port(self):
         self._verify_vif_details(port_id, self.dpdk_host, 'vhostuser',
                                  expected_vif_details)
 
+        expected_vif_details = copy.deepcopy(VHOSTUSER_VIF_DETAILS)
+        expected_vif_details.pop('vhostuser_mode')
+        expected_vif_details.pop('vhostuser_ovs_plug')
+        expected_vif_details[portbindings.CAP_PORT_FILTER] = True
         port_id = self._create_or_update_port(hostname=self.invalid_dpdk_host)
         self._verify_vif_details(port_id, self.invalid_dpdk_host, 'ovs',
-                                 OVS_VIF_DETAILS)
+                                 expected_vif_details)
 
     def test_port_binding_create_remote_managed_port(self):
         pci_vendor_info = 'fake-pci-vendor-info'
@@ -205,8 +216,12 @@ def test_port_binding_update_port(self):
 
         port_id = self._create_or_update_port(port_id=port_id,
                                               hostname=self.invalid_dpdk_host)
+        expected_vif_details = copy.deepcopy(VHOSTUSER_VIF_DETAILS)
+        expected_vif_details.pop('vhostuser_mode')
+        expected_vif_details.pop('vhostuser_ovs_plug')
+        expected_vif_details[portbindings.CAP_PORT_FILTER] = True
         self._verify_vif_details(port_id, self.invalid_dpdk_host, 'ovs',
-                                 OVS_VIF_DETAILS)
+                                 expected_vif_details)
 
     def test_port_binding_update_remote_managed_port(self):
         port_id = self._create_or_update_port(

neutron/tests/unit/fake_resources.py

@@ -184,6 +184,7 @@ def __init__(self, **kwargs):
         self.get_extport_chassis_from_cms_options = mock.Mock(return_value=[])
         self.is_col_present = mock.Mock()
         self.is_col_present.return_value = False
+        self.db_find = mock.MagicMock()
         self.db_set = mock.Mock()
         self.lookup = mock.MagicMock()
         self.chassis_list = mock.MagicMock()
@@ -858,7 +859,8 @@ class FakeChassis(object):
     def create(attrs=None, az_list=None, chassis_as_gw=False,
                bridge_mappings=None, rp_bandwidths=None,
                rp_inventory_defaults=None, rp_hypervisors=None,
-               card_serial_number=None, chassis_as_extport=False):
+               card_serial_number=None, chassis_as_extport=False,
+               datapath_type=None):
         cms_opts = []
         if az_list:
             cms_opts.append("%s=%s" % (ovn_const.CMS_OPT_AVAILABILITY_ZONES,
@@ -903,6 +905,9 @@ def create(attrs=None, az_list=None, chassis_as_gw=False,
         if bridge_mappings:
             other_config['ovn-bridge-mappings'] = ','.join(bridge_mappings)
 
+        if datapath_type:
+            other_config[ovn_const.OVN_DATAPATH_TYPE] = datapath_type
+
         chassis_attrs = {
             'encaps': [],
             'external_ids': '',