Skip to content

Commit

Permalink
docs: combine argo events info into one doc
Browse files Browse the repository at this point in the history
Combine the Argo Events information into one place.
  • Loading branch information
cardoe committed Sep 23, 2024
1 parent b6d584a commit f9e6355
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 28 deletions.
19 changes: 0 additions & 19 deletions docs/component-argo-events.md

This file was deleted.

24 changes: 16 additions & 8 deletions docs/component-understack-workflows.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 0 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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':
Expand Down

0 comments on commit f9e6355

Please sign in to comment.