Add vlan aware VMs support

With this patch ngs starts supporting attaching of trunk port to
baremetal server. Only VLAN Neutron network is supported.

Closes-Bug: #1653968

Co-Authored-By: Vasyl Saienko <vsaienko@mirantis.com>
Co-Authored-By: Will Szumski <will@stackhpc.com>
Co-Authored-By: Mark Goddard <mark@stackhpc.com>
Co-Authored-By: Seunghun Lee <seunghun@stackhpc.com>

Depends-On: https://review.opendev.org/c/openstack/ironic/+/941023

Change-Id: I978cb6b1ea8c049b40aaf1b305d0d0f033282299

Author: jumpojoy

devstack/plugin.sh

@@ -220,6 +220,7 @@ function ngs_configure_tempest {
     if [ $GENERIC_SWITCH_USER_MAX_SESSIONS -gt 0 ]; then
         iniset $TEMPEST_CONFIG ngs port_dlm_concurrency $(($GENERIC_SWITCH_USER_MAX_SESSIONS * 2))
     fi
+    iniset $TEMPEST_CONFIG baremetal_feature_enabled trunks_supported True
 }
 
 # check for service enabled

networking_generic_switch/devices/__init__.py

@@ -112,6 +112,14 @@ def __init__(self, device_cfg, device_name=""):
 
         self._validate_network_name_format()
 
+    @property
+    def support_trunk_on_ports(self):
+        return False
+
+    @property
+    def support_trunk_on_bond_ports(self):
+        return False
+
     def _validate_network_name_format(self):
         """Validate the network name format configuration option."""
         network_name_format = self.ngs_config['ngs_network_name_format']
@@ -223,17 +231,78 @@ def del_network(self, segmentation_id, network_id):
         pass
 
     @abc.abstractmethod
-    def plug_port_to_network(self, port_id, segmentation_id):
+    def plug_port_to_network(self, port_id, segmentation_id,
+                             trunk_details=None):
+        """Plug port into network.
+
+        :param port_id: Then name of the switch interface
+        :param segmentation_id: VLAN identifier of the network used as access
+               or native VLAN for port.
+
+        :param trunk_details: trunk information if port is a part of trunk
+        """
         pass
 
     @abc.abstractmethod
-    def delete_port(self, port_id, segmentation_id):
+    def delete_port(self, port_id, segmentation_id, trunk_details=None):
+        """Delete port from specific network.
+
+        :param port_id: Then name of the switch interface
+        :param segmentation_id: VLAN identifier of the network used as access
+               or native VLAN for port.
+
+        :param trunk_details: trunk information if port is a part of trunk
+        """
         pass
 
-    def plug_bond_to_network(self, bond_id, segmentation_id):
+    def plug_bond_to_network(self, bond_id, segmentation_id,
+                             trunk_details=None):
+        """Plug bond port into network.
+
+        :param port_id: Then name of the switch interface
+        :param segmentation_id: VLAN identifier of the network used as access
+               or native VLAN for port.
+
+        :param trunk_details: trunk information if port is a part of trunk
+        """
+        kwargs = {}
+        if trunk_details:
+            kwargs["trunk_details"] = trunk_details
         # Fall back to interface method.
-        return self.plug_port_to_network(bond_id, segmentation_id)
+        return self.plug_port_to_network(bond_id, segmentation_id, **kwargs)
 
-    def unplug_bond_from_network(self, bond_id, segmentation_id):
+    def unplug_bond_from_network(self, bond_id, segmentation_id,
+                                 trunk_details=None):
+        """Unplug bond port from network.
+
+        :param port_id: Then name of the switch interface
+        :param segmentation_id: VLAN identifier of the network used as access
+               or native VLAN for port.
+
+        :param trunk_details: trunk information if port is a part of trunk
+        """
+        kwargs = {}
+        if trunk_details:
+            kwargs["trunk_details"] = trunk_details
         # Fall back to interface method.
-        return self.delete_port(bond_id, segmentation_id)
+        return self.delete_port(bond_id, segmentation_id, **kwargs)
+
+    def add_subports_on_trunk(self, binding_profile, port_id, subports):
+        """Allow subports on trunk
+
+        :param binding_profile: Binding profile of parent port
+        :param port_id: The name of the switch port from
+               Local Link Information
+        :param subports: List with subports objects.
+        """
+        pass
+
+    def del_subports_on_trunk(self, binding_profile, port_id, subports):
+        """Allow subports on trunk
+
+        :param binding_profile: Binding profile of parent port
+        :param port_id: The name of the switch port from
+               Local Link Information
+        :param subports: List with subports objects.
+        """
+        pass

networking_generic_switch/devices/netmiko_devices/__init__.py

@@ -29,6 +29,7 @@
 from networking_generic_switch.devices import utils as device_utils
 from networking_generic_switch import exceptions as exc
 from networking_generic_switch import locking as ngs_lock
+from networking_generic_switch import utils as ngs_utils
 
 LOG = logging.getLogger(__name__)
 CONF = cfg.CONF
@@ -90,6 +91,22 @@ class NetmikoSwitch(devices.GenericSwitchDevice):
 
     SAVE_CONFIGURATION = None
 
+    SET_NATIVE_VLAN = None
+
+    DELETE_NATIVE_VLAN = None
+
+    SET_NATIVE_VLAN_BOND = None
+
+    DELETE_NATIVE_VLAN_BOND = None
+
+    ADD_NETWORK_TO_TRUNK = None
+
+    REMOVE_NETWORK_FROM_TRUNK = None
+
+    ADD_NETWORK_TO_BOND_TRUNK = None
+
+    DELETE_NETWORK_ON_BOND_TRUNK = None
+
     ERROR_MSG_PATTERNS = ()
     """Sequence of error message patterns.
 
@@ -145,6 +162,14 @@ def __init__(self, device_cfg, *args, **kwargs):
             self.locker.start()
             atexit.register(self.locker.stop)
 
+    @property
+    def support_trunk_on_ports(self):
+        return bool(self.ADD_NETWORK_TO_TRUNK)
+
+    @property
+    def support_trunk_on_bond_ports(self):
+        return bool(self.ADD_NETWORK_TO_BOND_TRUNK)
+
     def _format_commands(self, commands, **kwargs):
         if not commands:
             return []
@@ -277,7 +302,7 @@ def del_network(self, segmentation_id, network_id):
         return self.send_commands_to_device(cmds)
 
     @check_output('plug port')
-    def plug_port_to_network(self, port, segmentation_id):
+    def plug_port_to_network(self, port, segmentation_id, trunk_details=None):
         cmds = []
         if self._disable_inactive_ports() and self.ENABLE_PORT:
             cmds += self._format_commands(self.ENABLE_PORT, port=port)
@@ -287,18 +312,38 @@ def plug_port_to_network(self, port, segmentation_id):
                 self.DELETE_PORT,
                 port=port,
                 segmentation_id=ngs_port_default_vlan)
-        cmds += self._format_commands(
-            self.PLUG_PORT_TO_NETWORK,
-            port=port,
-            segmentation_id=segmentation_id)
+
+        if trunk_details:
+            cmds += self._format_commands(self.SET_NATIVE_VLAN,
+                                          port=port,
+                                          segmentation_id=segmentation_id)
+            for sub_port in trunk_details.get('sub_ports', []):
+                cmds += self._format_commands(
+                    self.ADD_NETWORK_TO_TRUNK, port=port,
+                    segmentation_id=sub_port['segmentation_id'])
+        else:
+            cmds += self._format_commands(
+                self.PLUG_PORT_TO_NETWORK,
+                port=port,
+                segmentation_id=segmentation_id)
+
         return self.send_commands_to_device(cmds)
 
     @check_output('unplug port')
-    def delete_port(self, port, segmentation_id):
+    def delete_port(self, port, segmentation_id, trunk_details=None):
         cmds = self._format_commands(self.DELETE_PORT,
                                      port=port,
                                      segmentation_id=segmentation_id)
         ngs_port_default_vlan = self._get_port_default_vlan()
+        if trunk_details:
+            cmds += self._format_commands(self.DELETE_NATIVE_VLAN,
+                                          port=port,
+                                          segmentation_id=segmentation_id)
+            for sub_port in trunk_details.get('sub_ports', []):
+                cmds += self._format_commands(
+                    self.REMOVE_NETWORK_FROM_TRUNK, port=port,
+                    segmentation_id=sub_port['segmentation_id'])
+
         if ngs_port_default_vlan:
             # NOTE(mgoddard): Pass network_id and segmentation_id for drivers
             # not yet using network_name.
@@ -315,14 +360,16 @@ def delete_port(self, port, segmentation_id):
                 segmentation_id=ngs_port_default_vlan)
         if self._disable_inactive_ports() and self.DISABLE_PORT:
             cmds += self._format_commands(self.DISABLE_PORT, port=port)
+
         return self.send_commands_to_device(cmds)
 
     @check_output('plug bond')
-    def plug_bond_to_network(self, bond, segmentation_id):
+    def plug_bond_to_network(self, bond, segmentation_id, trunk_details=None):
         # Fallback to regular plug port if no specialist PLUG_BOND_TO_NETWORK
         # commands set
         if not self.PLUG_BOND_TO_NETWORK:
-            return self.plug_port_to_network(bond, segmentation_id)
+            return self.plug_port_to_network(bond, segmentation_id,
+                                             trunk_details=trunk_details)
         cmds = []
         if self._disable_inactive_ports() and self.ENABLE_BOND:
             cmds += self._format_commands(self.ENABLE_BOND, bond=bond)
@@ -332,22 +379,44 @@ def plug_bond_to_network(self, bond, segmentation_id):
                 self.UNPLUG_BOND_FROM_NETWORK,
                 bond=bond,
                 segmentation_id=ngs_port_default_vlan)
-        cmds += self._format_commands(
-            self.PLUG_BOND_TO_NETWORK,
-            bond=bond,
-            segmentation_id=segmentation_id)
+
+        if trunk_details:
+            cmds += self._format_commands(self.SET_NATIVE_VLAN_BOND,
+                                          bond=bond,
+                                          segmentation_id=segmentation_id)
+            for sub_port in trunk_details.get('sub_ports', []):
+                cmds += self._format_commands(
+                    self.ADD_NETWORK_TO_BOND_TRUNK, bond=bond,
+                    segmentation_id=sub_port['segmentation_id'])
+        else:
+            cmds += self._format_commands(
+                self.PLUG_BOND_TO_NETWORK,
+                bond=bond,
+                segmentation_id=segmentation_id)
+
         return self.send_commands_to_device(cmds)
 
     @check_output('unplug bond')
-    def unplug_bond_from_network(self, bond, segmentation_id):
+    def unplug_bond_from_network(self, bond, segmentation_id,
+                                 trunk_details=None):
         # Fallback to regular port delete if no specialist
         # UNPLUG_BOND_FROM_NETWORK commands set
         if not self.UNPLUG_BOND_FROM_NETWORK:
-            return self.delete_port(bond, segmentation_id)
+            return self.delete_port(bond, segmentation_id,
+                                    trunk_details=trunk_details)
         cmds = self._format_commands(self.UNPLUG_BOND_FROM_NETWORK,
                                      bond=bond,
                                      segmentation_id=segmentation_id)
         ngs_port_default_vlan = self._get_port_default_vlan()
+        if trunk_details:
+            cmds += self._format_commands(self.DELETE_NATIVE_VLAN_BOND,
+                                          bond=bond,
+                                          segmentation_id=segmentation_id)
+            for sub_port in trunk_details.get('sub_ports', []):
+                cmds += self._format_commands(
+                    self.ADD_NETWORK_TO_BOND_TRUNK, bond=bond,
+                    segmentation_id=sub_port['segmentation_id'])
+
         if ngs_port_default_vlan:
             # NOTE(mgoddard): Pass network_id and segmentation_id for drivers
             # not yet using network_name.
@@ -364,6 +433,7 @@ def unplug_bond_from_network(self, bond, segmentation_id):
                 segmentation_id=ngs_port_default_vlan)
         if self._disable_inactive_ports() and self.DISABLE_BOND:
             cmds += self._format_commands(self.DISABLE_BOND, bond=bond)
+
         return self.send_commands_to_device(cmds)
 
     def send_config_set(self, net_connect, cmd_set):
@@ -417,3 +487,48 @@ def check_output(self, output, operation):
                 raise exc.GenericSwitchNetmikoConfigError(
                     config=device_utils.sanitise_config(self.config),
                     error=msg)
+
+    def add_subports_on_trunk(self, binding_profile, port_id, subports):
+        """Allow subports on trunk
+
+        :param binding_profile: Binding profile of parent port
+        :param port_id: The name of the switch port from
+               Local Link Information
+        :param subports: List with subports objects.
+        """
+        cmds = []
+        is_802_3ad = ngs_utils.is_802_3ad(binding_profile)
+
+        for sub_port in subports:
+            if is_802_3ad:
+                cmds += self._format_commands(
+                    self.ADD_NETWORK_TO_BOND_TRUNK, bond=port_id,
+                    segmentation_id=sub_port['segmentation_id'])
+            else:
+                cmds += self._format_commands(
+                    self.ADD_NETWORK_TO_TRUNK, port=port_id,
+                    segmentation_id=sub_port['segmentation_id'])
+        return self.send_commands_to_device(cmds)
+
+    def del_subports_on_trunk(self, binding_profile, port_id, subports):
+        """Allow subports on trunk
+
+        :param binding_profile: Binding profile of parent port
+        :param port_id: The name of the switch port from
+               Local Link Information
+        :param subports: List with subports objects.
+        """
+
+        cmds = []
+        is_802_3ad = ngs_utils.is_802_3ad(binding_profile)
+
+        for sub_port in subports:
+            if is_802_3ad:
+                cmds += self._format_commands(
+                    self.DELETE_NETWORK_ON_BOND_TRUNK, bond=port_id,
+                    segmentation_id=sub_port['segmentation_id'])
+            else:
+                cmds += self._format_commands(
+                    self.REMOVE_NETWORK_FROM_TRUNK, port=port_id,
+                    segmentation_id=sub_port['segmentation_id'])
+        return self.send_commands_to_device(cmds)

networking_generic_switch/devices/netmiko_devices/arista.py

@@ -37,3 +37,26 @@ class AristaEos(netmiko_devices.NetmikoSwitch):
         'no switchport mode trunk',
         'switchport trunk allowed vlan none'
     )
+
+    SET_NATIVE_VLAN = (
+        'interface {port}',
+        'switchport mode trunk',
+        'switchport trunk native vlan {segmentation_id}',
+        'switchport trunk allowed vlan add {segmentation_id}'
+    )
+
+    DELETE_NATIVE_VLAN = (
+        'interface {port}',
+        'no switchport trunk native vlan {segmentation_id}',
+        'switchport trunk allowed vlan remove {segmentation_id}',
+    )
+
+    ADD_NETWORK_TO_TRUNK = (
+        'interface {port}',
+        'switchport trunk allowed vlan add {segmentation_id}'
+    )
+
+    REMOVE_NETWORK_FROM_TRUNK = (
+        'interface {port}',
+        'switchport trunk allowed vlan remove {segmentation_id}'
+    )

networking_generic_switch/devices/netmiko_devices/cisco.py

@@ -39,6 +39,31 @@ class CiscoIos(netmiko_devices.NetmikoSwitch):
         'switchport trunk allowed vlan none'
     )
 
+    SET_NATIVE_VLAN = (
+        'interface {port}',
+        'switchport mode trunk',
+        'switchport trunk native vlan {segmentation_id}',
+        'switchport trunk allowed vlan add {segmentation_id}',
+    )
+
+    DELETE_NATIVE_VLAN = (
+        'interface {port}',
+        'no switchport mode trunk',
+        'no switchport trunk native vlan {segmentation_id}',
+        'switchport trunk allowed vlan remove {segmentation_id}',
+    )
+
+    ADD_NETWORK_TO_TRUNK = (
+        'interface {port}',
+        'switchport mode trunk',
+        'switchport trunk allowed vlan add {segmentation_id}',
+    )
+
+    REMOVE_NETWORK_FROM_TRUNK = (
+        'interface {port}',
+        'switchport trunk allowed vlan remove {segmentation_id}',
+    )
+
 
 class CiscoNxOS(netmiko_devices.NetmikoSwitch):
     """Netmiko device driver for Cisco Nexus switches running NX-OS."""