feat(workflows): add sensor and workflow for ironic port events

Added a workflow template that executes the openstack-oslo-event script
using the input as the oslo.message body JSON payload. Add a sensor that
triggers on the baremetal.port.create.end, baremetal.port.update.end,
and baremetal.port.delete.end events and executes the workflowtemplate.

Author: cardoe

workflows/argo-events/kustomization.yaml

@@ -20,6 +20,7 @@ resources:
   - workflowtemplates/keystone-event-project.yaml
   - workflowtemplates/enroll-server.yaml
   - workflowtemplates/reclean-server.yaml
+  - workflowtemplates/openstack-oslo-event.yaml
   # Alert automation
   - sensors/alertmanager-webhook-sensor.yaml
   - eventsources/alertmanager-webhook-eventsource.yaml

workflows/argo-events/workflowtemplates/openstack-oslo-event.yaml

@@ -0,0 +1,58 @@
+apiVersion: argoproj.io/v1alpha1
+metadata:
+  name: openstack-oslo-event
+  annotations:
+    workflows.argoproj.io/title: OpenStack OSLO event dispatcher
+    workflows.argoproj.io/description: |
+      Updates Nautobot with data from an OpenStack OSLO event.
+
+      This script takes the JSON parsed body of 'oslo.message' from
+      an OSLO event. This can be decoded with `jq -r '."oslo.message" | fromjson'`
+
+      To test this workflow you can run it with the following:
+
+      ```
+      argo -n argo-events submit --from workflowtemplate/openstack-oslo-event \
+      -p event-json "$(jq -r '."oslo.message" | fromjson')"
+      ```
+
+      Defined in `workflows/argo-events/workflowtemplates/openstack-oslo-event.yaml`
+kind: WorkflowTemplate
+spec:
+  entrypoint: main
+  serviceAccountName: workflow
+  arguments:
+    parameters:
+      - name: event-json
+        value: "{}"  # default to empty dict
+  templates:
+    - name: main
+      inputs:
+        parameters:
+          - name: event-json
+        artifacts:
+          - name: event-data
+            path: /tmp/event.json
+            raw:
+              data: "{{inputs.parameters.event-json}}"
+      container:
+        image: ghcr.io/rackerlabs/understack/ironic-nautobot-client:latest
+        command:
+          - openstack-oslo-event
+        args:
+          - "--file"
+          - "/tmp/event.json"
+        volumeMounts:
+          - mountPath: /etc/nb-token/
+            name: nb-token
+            readOnly: true
+          - mountPath: /etc/openstack
+            name: openstack-svc-acct
+            readOnly: true
+      volumes:
+        - name: nb-token
+          secret:
+            secretName: nautobot-token
+        - name: openstack-svc-acct
+          secret:
+            secretName: openstack-svc-acct

workflows/openstack/kustomization.yaml

@@ -20,5 +20,6 @@ resources:
   - sensors/sensor-k8s-neutron-deployment.yaml
   - sensors/sensor-neutron-event-network-segment-range.yaml
   - sensors/sensor-ironic-reclean.yaml
+  - sensors/sensor-ironic-node-port.yaml
   - secrets/nautobot-token.yaml
   - secrets/openstack-svc-acct.yaml

workflows/openstack/sensors/sensor-ironic-node-port.yaml

@@ -0,0 +1,74 @@
+---
+apiVersion: argoproj.io/v1alpha1
+kind: Sensor
+metadata:
+  name: ironic-node-port
+  annotations:
+    workflows.argoproj.io/title: Update Nautobot from Ironic Node Port Events
+    workflows.argoproj.io/description: |+
+      Triggers on the following Ironic Events:
+
+      - baremetal.port.create.end which happens when a baremetal port is created
+      - baremetal.port.update.end which happens after a port is updated
+      - baremetal.port.delete.end which happens when a port is deleted
+
+      Resulting code should be very similar to:
+
+      ```
+      argo -n argo-events submit --from workflowtemplate/openstack-oslo-event \
+      -p event-json "JSON-payload"
+      ```
+
+      Defined in `workflows/argo-events/sensors/ironic-node-port.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)
+    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.port.create.end"
+            - "baremetal.port.update.end"
+            - "baremetal.port.delete.end"
+  template:
+    serviceAccountName: sensor-submit-workflow
+  triggers:
+    - template:
+        name: ironic-node-port
+        # uses 'argo' CLI instead of 'kubectl'
+        argoWorkflow:
+          # sets the operation to 'argo submit'
+          operation: submit
+          # edits source section
+          parameters:
+            # first parameter is the parsed oslo.message
+            - dest: spec.arguments.parameters.0.value
+              src:
+                dataKey: body
+                dependencyName: ironic-dep
+          source:
+            # create a workflow in argo-events prefixed with ironic-node-update-
+            resource:
+              apiVersion: argoproj.io/v1alpha1
+              kind: Workflow
+              metadata:
+                generateName: ironic-node-port-
+                namespace: argo-events
+              spec:
+                # defines the parameters being replaced above
+                arguments:
+                  parameters:
+                    - name: event-json
+                # references the workflow
+                workflowTemplateRef:
+                  name: openstack-oslo-event