adding nautobot-sync post-inspection hook

Author: syedhaseebahmed

components/ironic/values.yaml

@@ -86,13 +86,16 @@ conf:
       rabbit_ha_queues: true
     pxe:
       loader_file_paths: "snponly.efi:/usr/lib/ipxe/snponly.efi"
+    redfish:
+      # Redfish inspection hooks - run hooks for redfish-based inspection
+      inspection_hooks: "$default_inspection_hooks,nautobot-sync"
     inspector:
       extra_kernel_params: ipa-collect-lldp=1
       # Agent inspection hooks - ports hook removed to prevent port manipulation during agent inspection
       # Default hooks include: ramdisk-error,validate-interfaces,ports,architecture
       # We override to exclude 'ports' from the default hooks
       default_hooks: "ramdisk-error,validate-interfaces,architecture"
-      hooks: "$default_hooks,pci-devices,parse-lldp,local-link-connection,resource-class"
+      hooks: "$default_hooks,pci-devices,parse-lldp,local-link-connection,resource-class,nautobot-sync"
     # enable sensors and metrics for redfish metrics - https://docs.openstack.org/ironic/latest/admin/drivers/redfish/metrics.html
     sensor_data:
       send_sensor_data: true
@@ -239,6 +242,9 @@ pod:
               sources:
                 - secret:
                     name: ironic-ks-etc
+                - secret:
+                    name: ironic-nautobot-token
+                    optional: true
     ironic_api:
       ironic_api:
         volumeMounts:

python/ironic-understack/ironic_understack/conf.py

@@ -10,7 +10,18 @@ def setup_conf():
             "device_types_dir",
             help="directory storing Device Type description YAML files",
             default="/var/lib/understack/device-types",
-        )
+        ),
+        cfg.StrOpt(
+            "nautobot_url",
+            help="Nautobot API URL",
+            default=None,
+        ),
+        cfg.StrOpt(
+            "nautobot_token",
+            help="Nautobot API token",
+            secret=True,
+            default=None,
+        ),
     ]
     cfg.CONF.register_group(grp)
     cfg.CONF.register_opts(opts, group=grp)

python/ironic-understack/ironic_understack/nautobot_sync.py

@@ -0,0 +1,153 @@
+"""Ironic inspection hook to sync device information to Nautobot."""
+
+import pynautobot
+from ironic import objects
+from ironic.drivers.modules.inspector.hooks import base
+from oslo_log import log as logging
+
+from ironic_understack.conf import CONF
+
+LOG = logging.getLogger(__name__)
+
+
+class NautobotSyncHook(base.InspectionHook):
+    """Hook to sync discovered device information to Nautobot."""
+
+    # Run after port information has been enriched with BIOS names and LLDP data
+    dependencies = ["update-baremetal-port", "port-bios-name"]
+
+    def __call__(self, task, inventory, plugin_data):
+        """Sync device inventory to Nautobot.
+
+        :param task: Ironic task context containing node and driver info
+        :param inventory: Hardware inventory dict from inspection
+        :param plugin_data: Shared data dict between hooks
+        """
+        try:
+            nautobot_url = CONF.ironic_understack.nautobot_url
+            nautobot_token = CONF.ironic_understack.nautobot_token
+
+            if not nautobot_url or not nautobot_token:
+                LOG.warning(
+                    "Nautobot URL or token not configured, skipping sync for node %s",
+                    task.node.uuid,
+                )
+                return
+
+            # Initialize Nautobot client
+            nautobot = pynautobot.api(url=nautobot_url, token=nautobot_token)
+
+            # Extract device information from inventory
+            device_data = self._extract_device_data(task, inventory)
+
+            # Sync to Nautobot
+            self._sync_to_nautobot(nautobot, device_data, task.node)
+
+            LOG.info(
+                "Successfully synced device information to Nautobot for node %s",
+                task.node.uuid,
+            )
+
+        except (KeyError, ValueError, TypeError) as e:
+            msg = (
+                f"Failed to extract device information from inventory for node "
+                f"{task.node.uuid}: {e}"
+            )
+            LOG.error(msg)
+            # Don't fail inspection, just log the error
+        except Exception as e:
+            msg = f"Failed to sync device to Nautobot for node {task.node.uuid}: {e}"
+            LOG.error(msg)
+            # Don't fail inspection, just log the error
+
+    def _extract_device_data(self, task, inventory):
+        """Extract relevant device data from inventory and baremetal ports."""
+        data = {
+            "serial": inventory.get("system_vendor", {}).get("serial_number"),
+            "manufacturer": inventory.get("system_vendor", {}).get("manufacturer"),
+            "model": inventory.get("system_vendor", {}).get("product_name"),
+            "uuid": task.node.uuid,
+            "name": task.node.name or task.node.uuid,
+        }
+
+        # Extract interface information from baremetal ports
+        # These ports have been enriched by
+        # update-baremetal-port and port-bios-name hooks
+        interfaces = []
+        try:
+            ports = objects.Port.list_by_node_id(task.context, task.node.id)
+            for port in ports:
+                interface_data = {
+                    "mac_address": port.address,
+                    "name": port.name,
+                    "bios_name": port.extra.get("bios_name"),
+                    "pxe_enabled": port.pxe_enabled,
+                }
+
+                # local_link_connection info from update-baremetal-port hook
+                if port.local_link_connection:
+                    interface_data["switch_id"] = port.local_link_connection.get(
+                        "switch_id"
+                    )
+                    interface_data["switch_info"] = port.local_link_connection.get(
+                        "switch_info"
+                    )
+                    interface_data["port_id"] = port.local_link_connection.get(
+                        "port_id"
+                    )
+
+                # Add physical_network (VLAN group) if available
+                if port.physical_network:
+                    interface_data["physical_network"] = port.physical_network
+
+                interfaces.append(interface_data)
+
+            LOG.debug(
+                "Extracted %d interfaces for node %s", len(interfaces), task.node.uuid
+            )
+        except Exception as e:
+            LOG.warning(
+                "Failed to extract interface data from ports for node %s: %s",
+                task.node.uuid,
+                e,
+            )
+
+        data["interfaces"] = interfaces
+
+        return data
+
+    def _sync_to_nautobot(self, nautobot, device_data, node):
+        """Sync device data to Nautobot."""
+        serial = device_data.get("serial")
+        if not serial:
+            LOG.warning("Node %s, cannot sync to Nautobot", node.uuid)
+            return
+
+        # Check if device exists in Nautobot
+        device = self._find_device(nautobot, serial)
+
+        if device:
+            LOG.info("Device %s already exists in Nautobot", serial)
+            # Update device if needed
+            self._update_device(nautobot, device, device_data)
+        else:
+            LOG.info("Device %s not found in Nautobot, would create", serial)
+            # Note: Creation requires location/rack info
+            # which we don't have from inspection
+            # This would need to be configured or derived from other sources
+
+    def _find_device(self, nautobot, serial):
+        """Find device in Nautobot by serial number."""
+        try:
+            devices = nautobot.dcim.devices.filter(serial=serial)
+            if devices:
+                return devices[0]
+        except Exception:
+            LOG.exception("Error querying Nautobot for device with serial %s", serial)
+        return None
+
+    def _update_device(self, nautobot, device, device_data):
+        """Update device information in Nautobot."""
+        # Update basic device info if needed
+        # This is a placeholder - actual update logic would depend on requirements
+        LOG.debug("Would update device %s with data: %s", device.id, device_data)