From f9e6355f29ed62357b4b59451d8c90e9e4937bb7 Mon Sep 17 00:00:00 2001 From: Doug Goldstein Date: Mon, 23 Sep 2024 13:42:53 -0500 Subject: [PATCH] docs: combine argo events info into one doc Combine the Argo Events information into one place. --- docs/component-argo-events.md | 19 ------------------- docs/component-understack-workflows.md | 24 ++++++++++++++++-------- mkdocs.yml | 1 - 3 files changed, 16 insertions(+), 28 deletions(-) delete mode 100644 docs/component-argo-events.md diff --git a/docs/component-argo-events.md b/docs/component-argo-events.md deleted file mode 100644 index e4bc207de..000000000 --- a/docs/component-argo-events.md +++ /dev/null @@ -1,19 +0,0 @@ -# Argo Events - -[Argo Events][argo-events] is a Kubernetes-native event-driven automation framework. We can use Argo Events to trigger -autmoations processes from any of the internal Understack (and potentially external) components. Currently we leverage a -few of the Argo Events components: - -## EventSource - -These define which sources we will consume events from, transform them into cloudevents, and then ship them over the -eventbus. For example by default, Understack is listening for Nautobot Webhook EventSources at: - -`nautobot-webhook-eventsource-svc.argo-events.svc.cluster.local:12000/nautobot` - -## Sensor - -These define the inputs we're listening for on the eventbus, and then responds by executing triggers. For example we -can trigger Argo Workflow submissions on cloudevents created by webhooks sent to the above mentioned EventSource. - -[argo-events]: diff --git a/docs/component-understack-workflows.md b/docs/component-understack-workflows.md index fdaeebdf0..27771b2d2 100644 --- a/docs/component-understack-workflows.md +++ b/docs/component-understack-workflows.md @@ -1,30 +1,38 @@ # Understack Workflows 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. +centered around [Argo Workflows][argo-wf] and [Argo Events][argo-events] to +drive automated operations based on events and other triggers in the system. -Due to the scoping of resources into different namespaces in the deployment -it is also split into multiple namespaces. +## Tools/Applications Used + +### Argo Events -Specifics about each workflow can be seen in the Workflows -section. +[Argo Events][argo-events] is a Kubernetes-native event-driven automation framework. +We can use Argo Events to trigger autmations processes from any of the internal +Understack and external sources. ## Kubernetes Resources +Due to the scoping of resources into different namespaces in the deployment +it is also split into multiple namespaces. + The resources here are grouped together by function. **eventbus** : [Argo Events][argo-events] uses an event bus to enqueue messages to process. **eventsources** -: Defines how [Argo Events][argo-events] reads or receives messages to process. +: These define how [Argo Events][argo-events] will receive or consume messages, + transform them into cloud events, and post them on the eventbus. **serviceaccounts** : Kubernetes Service Accounts that workflows will run as. **sensors** -: Defines messages of interest and what action to take on them. e.g. run a workflow. +: Defines how events are processed on the eventbus and the triggers, like workflow + execution, happens as a result. Sensors define what rules an event must match to + cause a trigger to occur. **secrets** : Defines secrets needed by sensors or workflows. diff --git a/mkdocs.yml b/mkdocs.yml index 2d555eda6..3765eb248 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -108,7 +108,6 @@ nav: - networking.md - Components: - component-overview.md - - component-argo-events.md - component-argo-workflows.md - component-understack-workflows.md - 'Deployment Guide':