From bb13263e4a6230fe6dc5921eb6e581e616b54867 Mon Sep 17 00:00:00 2001 From: Tianchu Zhao Date: Sun, 23 Feb 2025 05:34:12 +0000 Subject: [PATCH 1/5] docs: label user action Signed-off-by: Tianchu Zhao --- docs/workflow-actor.md | 28 ++++++++++++++++++++++++++++ mkdocs.yml | 1 + 2 files changed, 29 insertions(+) create mode 100644 docs/workflow-actor.md diff --git a/docs/workflow-actor.md b/docs/workflow-actor.md new file mode 100644 index 000000000000..702f49bbed69 --- /dev/null +++ b/docs/workflow-actor.md @@ -0,0 +1,28 @@ +# Workflow Actor + +> v3.6.5 and after + +If argo workflow has setup [sso](argo-server-sso.md), when you perform an action on the argo workflow related resource (workflow, cronworkflow, workflowTemplate, clusterWorkflowTemplate) via the CLI or UI, an attempt will be made to label it with the user and their action. + +```yaml +apiVersion: argoproj.io/v1alpha1 +kind: Workflow +metadata: + name: my-wf + labels: + workflows.argoproj.io/actor: admin + # labels must be DNS formatted, so the "@" is replaces by '.at.' + workflows.argoproj.io/creator-email: admin.at.your.org + workflows.argoproj.io/actor-preferred-username: admin-preferred-username + workflows.argoproj.io/action: Update +``` + +Available actions: +- Update +- Suspend +- Stop +- Terminate +- Resume + +!!! NOTE + Labels only contain `[-_.0-9a-zA-Z]`, so any other characters will be turned into `-`. diff --git a/mkdocs.yml b/mkdocs.yml index c32b5996dca1..0a2e7a0de39d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -135,6 +135,7 @@ nav: - estimated-duration.md - progress.md - workflow-creator.md + - workflow-actor.md - Patterns: - empty-dir.md - cron-backfill.md From 41ef40f3e6c1b54c231bc8d4834dea1743506bf3 Mon Sep 17 00:00:00 2001 From: Tianchu Zhao Date: Mon, 24 Feb 2025 08:07:52 +0000 Subject: [PATCH 2/5] fix: spelling Signed-off-by: Tianchu Zhao --- .spelling | 1 + 1 file changed, 1 insertion(+) diff --git a/.spelling b/.spelling index f744bd451252..dbc77d49d403 100644 --- a/.spelling +++ b/.spelling @@ -257,6 +257,7 @@ v3.4. v3.4.4 v3.5 v3.6 +v3.6.5 v3.7 validator vendored From 0769f58ccb9d2fcde35fd72360d4269b8c462816 Mon Sep 17 00:00:00 2001 From: Tianchu Zhao Date: Mon, 24 Feb 2025 08:13:20 +0000 Subject: [PATCH 3/5] fix: spelling Signed-off-by: Tianchu Zhao --- .spelling | 1 + docs/workflow-actor.md | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/.spelling b/.spelling index dbc77d49d403..0fad47f95a77 100644 --- a/.spelling +++ b/.spelling @@ -118,6 +118,7 @@ ServiceAccount Sharding Singer.io Snyk +SSO Sumit Tekton Traefik diff --git a/docs/workflow-actor.md b/docs/workflow-actor.md index 702f49bbed69..788e44191a95 100644 --- a/docs/workflow-actor.md +++ b/docs/workflow-actor.md @@ -2,7 +2,7 @@ > v3.6.5 and after -If argo workflow has setup [sso](argo-server-sso.md), when you perform an action on the argo workflow related resource (workflow, cronworkflow, workflowTemplate, clusterWorkflowTemplate) via the CLI or UI, an attempt will be made to label it with the user and their action. +If argo workflow has setup [SSO](argo-server-sso.md), when you perform an action on the argo workflow related resource (Workflow, CronWorkflow, WorkflowTemplate, ClusterWorkflowTemplate) via the CLI or UI, an attempt will be made to label it with the user and their action. ```yaml apiVersion: argoproj.io/v1alpha1 From 966cc4c154f14e2a85d3acc326cded1d11c1712c Mon Sep 17 00:00:00 2001 From: Tianchu Zhao Date: Mon, 24 Feb 2025 08:19:52 +0000 Subject: [PATCH 4/5] fix: spelling Signed-off-by: Tianchu Zhao --- .spelling | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.spelling b/.spelling index 0fad47f95a77..9bc694271835 100644 --- a/.spelling +++ b/.spelling @@ -113,12 +113,12 @@ Risc-V Roadmap RoleBinding SDKs +SSO SageMaker ServiceAccount Sharding Singer.io Snyk -SSO Sumit Tekton Traefik From 14c968a9f0433d7e95614952f5b3aef54d27d0fb Mon Sep 17 00:00:00 2001 From: Tianchu Zhao Date: Mon, 24 Feb 2025 08:34:24 +0000 Subject: [PATCH 5/5] fix: spelling Signed-off-by: Tianchu Zhao --- docs/workflow-actor.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/workflow-actor.md b/docs/workflow-actor.md index 788e44191a95..be5fb9684cf6 100644 --- a/docs/workflow-actor.md +++ b/docs/workflow-actor.md @@ -18,6 +18,7 @@ metadata: ``` Available actions: + - Update - Suspend - Stop