capturing baremetal.node.provision_set.end when baremetal node transitioning from inspect to manage

Author: syedhaseebahmed

components/site-workflows/kustomization.yaml

@@ -22,7 +22,8 @@ resources:
   - sensors/sensor-neutron-olso-event.yaml
   - sensors/sensor-ironic-reclean.yaml
   - sensors/sensor-ironic-node-port.yaml
-  - sensors/sensor-ironic-oslo-event.yaml
+  - sensors/sensor-ironic-oslo-deploying-event.yaml
+  - sensors/sensor-ironic-oslo-inspecting-event.yaml
 
 helmCharts:
   - name: nautobot-token

components/site-workflows/sensors/sensor-ironic-oslo-event.yaml renamed to components/site-workflows/sensors/sensor-ironic-oslo-deploying-event.yaml

@@ -2,7 +2,7 @@
 apiVersion: argoproj.io/v1alpha1
 kind: Sensor
 metadata:
-  name: ironic-oslo-event
+  name: ironic-oslo-deploying-event
   annotations:
     workflows.argoproj.io/title: Process oslo_events for ironic project
     workflows.argoproj.io/description: |+
@@ -13,11 +13,11 @@ metadata:
       Resulting code should be very similar to:
 
       ```
-      argo -n argo-events submit --from workflowtemplate/ironic-oslo-event \
+      argo -n argo-events submit --from workflowtemplate/openstack-oslo-event \
       -p event-json "JSON-payload" -p device_id=<UUID> -p project_id=<UUID>
       ```
 
-      Defined in `workflows/argo-events/sensors/sensor-ironic-oslo-event.yaml`
+      Defined in `workflows/argo-events/sensors/sensor-sensor-ironic-oslo-deploying-event.yaml`
 spec:
   dependencies:
   - eventName: openstack

components/site-workflows/sensors/sensor-ironic-oslo-inspecting-event.yaml

@@ -0,0 +1,84 @@
+---
+apiVersion: argoproj.io/v1alpha1
+kind: Sensor
+metadata:
+  name: ironic-oslo-inspecting-event
+  annotations:
+    workflows.argoproj.io/title: Process oslo_events for ironic project
+    workflows.argoproj.io/description: |+
+      Triggers on the following Ironic Events:
+
+      - baremetal.node.provision_set.end which happens after a state change on the node
+
+      Resulting code should be very similar to:
+
+      ```
+      argo -n argo-events submit --from workflowtemplate/openstack-oslo-event \
+      -p event-json "JSON-payload" -p device_id=<UUID> -p project_id=<UUID>
+      ```
+
+      Defined in `workflows/argo-events/sensors/sensor-ironic-oslo-inspecting-event.yaml`
+spec:
+  dependencies:
+  - eventName: openstack
+    eventSourceName: openstack-ironic
+    name: ironic-dep
+    transform:
+      # the event is a string-ified JSON so we need to decode it
+      # replace the whole event body
+      jq: |
+        (
+        .body = (.body["oslo.message"] | fromjson) |
+        .body.ironic_object = .body.payload["ironic_object.data"]
+        )
+    filters:
+      # applies each of the items in data with 'and' but there's only one
+      dataLogicalOperator: "and"
+      data:
+        - path: "body.event_type"
+          type: "string"
+          value:
+            - "baremetal.node.provision_set.end"
+        - path: "body.ironic_object.previous_provision_state"
+          type: "string"
+          value:
+            - "inspecting"
+  template:
+    serviceAccountName: sensor-submit-workflow
+  triggers:
+    - template:
+        name: update-nautobot
+        k8s:
+          operation: create
+          parameters:
+            # first parameter is the parsed oslo.message
+            - dest: spec.arguments.parameters.0.value # event-json
+              src:
+                dataKey: body
+                dependencyName: ironic-dep
+          source:
+            # create a workflow in argo-events prefixed with ironic-prov-
+            resource:
+              apiVersion: argoproj.io/v1alpha1
+              kind: Workflow
+              metadata:
+                generateName: update-nautobot-
+                namespace: argo-events
+              spec:
+                serviceAccountName: workflow
+                entrypoint: main
+                # defines the parameters being replaced above
+                arguments:
+                  parameters:
+                    - name: event-json
+                templates:
+                - name: main
+                  steps:
+                  - - name: oslo-events
+                      templateRef:
+                        name: update-nautobot-on-openstack-oslo-event
+                        template: main
+                      arguments:
+                        parameters:
+                        - name: event-json
+                          value: "{{workflow.parameters.event-json}}"

python/understack-workflows/pyproject.toml

@@ -40,6 +40,7 @@ sync-network-segment-range = "understack_workflows.main.sync_ucvni_group_range:m
 openstack-oslo-event = "understack_workflows.main.openstack_oslo_event:main"
 netapp-create-svm = "understack_workflows.main.netapp_create_svm:main"
 netapp-configure-interfaces = "understack_workflows.main.netapp_configure_net:main"
+update-nautobot-on-openstack-oslo-event = "understack_workflows.main.update_nautobot:main"
 
 [dependency-groups]
 test = [

python/understack-workflows/understack_workflows/ironic/client.py

@@ -1,15 +1,31 @@
+from ironicclient.common.apiclient import exceptions as ironic_exceptions
+from ironicclient.v1.client import Client as IronicV1Client
+
+from understack_workflows.helpers import setup_logger
 from understack_workflows.openstack.client import get_ironic_client
 
+logger = setup_logger(__name__)
+
 
 class IronicClient:
     def __init__(
         self,
+        ironic_client: IronicV1Client | None = None,
     ) -> None:
         """Initialize our ironicclient wrapper."""
         self.logged_in = False
+        self._client = ironic_client
+        self._client_factory = get_ironic_client
+
+    @property
+    def client(self) -> IronicV1Client:
+        """Get the ironic client, creating it lazily if needed."""
+        if self._client is None:
+            self._client = self._client_factory()
+        return self._client
 
     def login(self):
-        self.client = get_ironic_client()
+        self._client = get_ironic_client()
         self.logged_in = True
 
     def create_node(self, node_data: dict):
@@ -66,3 +82,37 @@ def list_ports(self, node_id: str):
     def _ensure_logged_in(self):
         if not self.logged_in:
             self.login()
+
+    def get_node_inventory(self, node_ident: str) -> dict:
+        """Fetch node inventory data from Ironic API.
+
+        Args:
+            node_ident: Node UUID, name, or other identifier
+
+        Returns:
+            Dict containing node inventory data
+
+        Raises:
+            ironic_exceptions.NotFound: If node doesn't exist
+            ironic_exceptions.ClientException: For other API errors
+        """
+        try:
+            logger.info("Fetching inventory for node: %s", node_ident)
+
+            # Call the inventory API endpoint
+            inventory = self.client.node.get_inventory(node_ident)
+
+            logger.info("Successfully retrieved inventory for node %s", node_ident)
+            return inventory
+
+        except ironic_exceptions.NotFound:
+            logger.error("Node not found: %s", node_ident)
+            raise
+        except ironic_exceptions.ClientException as e:
+            logger.error("Ironic API error for node %s: %s", node_ident, e)
+            raise
+        except Exception as e:
+            logger.error(
+                "Unexpected error fetching inventory for %s: %s", node_ident, e
+            )
+            raise