Compare Ironic ports by mac address, not by name

Author: stevekeay

python/understack-workflows/understack_workflows/data_center.py

@@ -20,10 +20,10 @@ class Switch:
 
     @property
     def vlan_group_name(self) -> str | None:
-        # TODO: remove domain
+        name = self.name.split(".")[0]
         for switch_name_suffix, vlan_group_suffix in VLAN_GROUP_SUFFIXES.items():
-            if self.name.endswith(switch_name_suffix):
-                cabinet_name = self.name.removesuffix(switch_name_suffix)
+            if name.endswith(switch_name_suffix):
+                cabinet_name = name.removesuffix(switch_name_suffix)
                 return f"{cabinet_name}-{vlan_group_suffix}"
         return None
 

python/understack-workflows/understack_workflows/port_configuration.py

@@ -8,7 +8,6 @@ class PortConfiguration(BaseModel):
     address: Annotated[
         str, StringConstraints(to_lower=True)
     ]  # ironicclient's Port class lowercases this attribute
-    uuid: str|None  # using a str here to due to ironicclient Port attribute
     node_uuid: str  # using a str here due to ironicclient Port attribute
     name: str  # port name
     pxe_enabled: bool

python/understack-workflows/understack_workflows/sync_interfaces.py

@@ -18,50 +18,52 @@ def update_ironic_baremetal_ports(
         ironic_client = IronicClient()
     logger.info("Syncing Interfaces / Ports for Device %s ...", device_uuid)
 
-    discovered_ports = dict_by_name(
-        make_port_infos(discovered_interfaces, pxe_interface_name, device_uuid)
+    discovered_ports = dict_by_mac_address(
+        make_port_infos(discovered_interfaces, pxe_interface_name, device_uuid, ironic_node.name)
     )
     logger.debug("Actual ports according to BMC: %s", discovered_ports)
 
     logger.info("Fetching Ironic Ports ...")
-    ironic_ports = dict_by_name(
+    ironic_ports = dict_by_mac_address(
         ironic_client.list_ports(device_uuid)
     )
 
-    for name, interface in ironic_ports.items():
-        if name not in discovered_ports:
+    for mac_address, ironic_port in ironic_ports.items():
+        if mac_address not in discovered_ports:
             logger.info(
                 "Server Interface %s no longer exists, "
                 "deleting corresponding Ironic Port %s",
-                interface.name,
-                interface.uuid,
+                mac_address,
+                ironic_port.uuid,
             )
-            response = ironic_client.delete_port(interface.uuid)
+            response = ironic_client.delete_port(ironic_port.uuid)
             logger.debug("Deleted: %s", response)
 
-    for name, actual_port in discovered_ports.items():
-        if name in ironic_ports:
-            patch = get_patch(actual_port, ironic_ports[name])
+    for mac_address, actual_port in discovered_ports.items():
+        ironic_port = ironic_ports.get(mac_address)
+        if ironic_port:
+            patch = get_patch(actual_port, ironic_port)
             if patch:
-                logger.info("Updating Ironic Port %s ...", actual_port)
-                response = ironic_client.update_port(name, patch)
+                logger.info("Updating Ironic Port %s, setting %s", ironic_port, patch)
+                response = ironic_client.update_port(ironic_port.uuid, patch)
                 logger.debug("Updated: %s", response)
             else:
-                logger.debug("No changes required for Ironic Port %s", name)
+                logger.debug("No changes required for Ironic Port %s", mac_address)
         else:
             logger.info("Creating Ironic Port %s ...", actual_port)
             response = ironic_client.create_port(actual_port.dict())
             logger.debug("Created: %s", response)
 
 
-def dict_by_name(items: list) -> dict:
-    return {item.name: item for item in items}
+def dict_by_mac_address(items: list) -> dict:
+    return {item.address: item for item in items}
 
 
 def make_port_infos(
     interfaces: list[InterfaceInfo],
     pxe_interface_name: str,
     device_id: str,
+    device_name: str,
 ) -> list[PortConfiguration]:
     """Get Nautobot interfaces for a device.
 
@@ -71,7 +73,7 @@ def make_port_infos(
 
     """
     return [
-        port_configuration(interface, pxe_interface_name, device_id)
+        port_configuration(interface, pxe_interface_name, device_id, device_name)
         for interface in interfaces
         if (
                 interface.mac_address and
@@ -82,11 +84,11 @@ def make_port_infos(
 
 
 def port_configuration(
-    interface: InterfaceInfo, pxe_interface_name: str, device_id: str
+        interface: InterfaceInfo, pxe_interface_name: str, device_id: str, device_name: str
 ) -> PortConfiguration:
     # Interface names have device UUID prepended because Ironic wants them
     # globally unique across all devices.
-    name = f"{device_id} {interface.name}"
+    name = f"{device_name} {interface.name}"
     pxe_enabled = interface.name == pxe_interface_name
 
     if interface.remote_switch_mac_address and interface.remote_switch_port_name:
@@ -105,7 +107,6 @@ def port_configuration(
         local_link_connection = {}
 
     return PortConfiguration(
-        uuid=None,
         node_uuid=device_id,
         address=interface.mac_address.lower(),
         name=name,