From 8a3ec139a1368a513a6cb5490830da87cd042301 Mon Sep 17 00:00:00 2001 From: Doug Goldstein Date: Mon, 23 Sep 2024 10:57:11 -0500 Subject: [PATCH 1/3] docs: update info about workflows Updated the names and paths where the understack workflows data lives at. --- docs/component-understack-workflows.md | 31 +++++++++++++++++--------- 1 file changed, 20 insertions(+), 11 deletions(-) diff --git a/docs/component-understack-workflows.md b/docs/component-understack-workflows.md index 5310c067..0ba01684 100644 --- a/docs/component-understack-workflows.md +++ b/docs/component-understack-workflows.md @@ -1,18 +1,19 @@ # Understack Workflows -This is the Kubernetes installation of the Argo Workflows -and their associated support bits to add the actual workflows, -sensors and triggers into a Kubernetes cluster. +Understack Workflows is a collection of code, scripts, container definitions +centered around [Argo Workflows][argo-wf] to drive automated operations +based on events and other triggers in the system. -Due to the scoping of resources into different namespaces, this -must also be split into multiple namespaces. +Due to the scoping of resources into different namespaces in the deployment +it is also split into multiple namespaces. -This code lives in `apps/understack-workflows` of this repo. - -Specifics about the workflows can be seen in the Workflows +Specifics about each workflow can be seen in the Workflows section. -## eventsource-openstack +## workflows/openstack + +This is where Kubernetes manifests are stored for interacting with +resources in the `openstack` namespace. The resources managed here are: @@ -34,11 +35,19 @@ execute a Workflow. 1. An [Argo Events][argo-events] Sensors and Triggers that execute workflows. -## workflowtemplates +## workflows/argo-events + +This is where Kubernetes manifests are stored for the actual workflow +templates. 1. A Kubernetes Role Binding allowing the `sensor-submit-workflow` the access it needs to run Workflows. -1. A number of Workflow Templates. +1. [Workflow Templates](./workflows/argo-events.md) + +## python/understack-workflows + +The code that is installed into the `ironic-nautobot-client` container +which is used for many of the workflows lives here. [argo-events]: [argo-wf]: From eaae21c1af94bbd63fb186562c3b503a794e7578 Mon Sep 17 00:00:00 2001 From: Doug Goldstein Date: Mon, 23 Sep 2024 11:11:55 -0500 Subject: [PATCH 2/3] ci: sensors don't seem to be allowed in the schema Sensors aren't being detected as a valid kind in the schema. --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 412a1289..b13a7742 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -40,7 +40,7 @@ repos: args: - --schemafile - https://raw.githubusercontent.com/argoproj/argo-workflows/master/api/jsonschema/schema.json - files: "workflows/argo-events/(sensors|workflowtemplates)/.*.(yml|yaml)$" + files: "workflows/argo-events/workflowtemplates/.*.(yml|yaml)$" - repo: https://github.com/igorshubovych/markdownlint-cli rev: v0.37.0 hooks: From 7501d822dee49b843fc533f9435c3287c9a8861e Mon Sep 17 00:00:00 2001 From: Doug Goldstein Date: Mon, 23 Sep 2024 11:12:25 -0500 Subject: [PATCH 3/3] fix(workflows): the name parameter was removed The name parameter was removed so this now results in us being unable to execute the workflow by this sensor. --- workflows/argo-events/sensors/nb-oob-interface-update.yaml | 4 ---- 1 file changed, 4 deletions(-) diff --git a/workflows/argo-events/sensors/nb-oob-interface-update.yaml b/workflows/argo-events/sensors/nb-oob-interface-update.yaml index 05f84801..0f8895ea 100644 --- a/workflows/argo-events/sensors/nb-oob-interface-update.yaml +++ b/workflows/argo-events/sensors/nb-oob-interface-update.yaml @@ -51,10 +51,6 @@ spec: src: dataKey: body.data.device.id dependencyName: nautobot-dep - - dest: spec.arguments.parameters.2.value - src: - dataKey: body.data.device.name - dependencyName: nautobot-dep source: resource: apiVersion: argoproj.io/v1alpha1