feat: set template display name in yaml (#14077)

Signed-off-by: MenD32 <[email protected]> Co-authored-by: MenD32 <[email protected]> Signed-off-by: Alex Collins <[email protected]>
argoproj · Jan 27, 2025 · 4eff7ad · 4eff7ad
1 parent b2dd1df
commit 4eff7ad
Show file tree

Hide file tree

Showing 27 changed files with 684 additions and 203 deletions.
diff --git a/api/jsonschema/schema.json b/api/jsonschema/schema.json
diff --git a/api/openapi-spec/swagger.json b/api/openapi-spec/swagger.json
diff --git a/docs/executor_swagger.md b/docs/executor_swagger.md
@@ -3807,6 +3807,7 @@ of the first container processes are calculated.
 |------|------|---------|:--------:| ------- |-------------|---------|
 | activeDeadlineSeconds | [IntOrString](#int-or-string)| `IntOrString` |  | |  |  |
 | affinity | [Affinity](#affinity)| `Affinity` |  | |  |  |
+| annotations | map of string| `map[string]string` |  | | Annotations is a list of annotations to add to the template at runtime |  |
 | archiveLocation | [ArtifactLocation](#artifact-location)| `ArtifactLocation` |  | |  |  |
 | automountServiceAccountToken | boolean| `bool` |  | | AutomountServiceAccountToken indicates whether a service account token should be automatically mounted in pods.</br>ServiceAccountName of ExecutorConfig must be specified if this value is false. |  |
 | container | [Container](#container)| `Container` |  | |  |  |

diff --git a/docs/fields.md b/docs/fields.md
@@ -1723,6 +1723,7 @@ Template is a reusable and composable unit of execution in a workflow
 |:----------:|:----------:|---------------|
 |`activeDeadlineSeconds`|[`IntOrString`](#intorstring)|Optional duration in seconds relative to the StartTime that the pod may be active on a node before the system actively tries to terminate the pod; value must be positive integer This field is only applicable to container and script templates.|
 |`affinity`|[`Affinity`](#affinity)|Affinity sets the pod's scheduling constraints Overrides the affinity set at the workflow level (if any)|
+|`annotations`|`Map< string , string >`|Annotations is a list of annotations to add to the template at runtime|
 |`archiveLocation`|[`ArtifactLocation`](#artifactlocation)|Location in which all files related to the step will be stored (logs, artifacts, etc...). Can be overridden by individual items in Outputs. If omitted, will use the default artifact repository location configured in the controller, appended with the <workflowname>/<nodename> in the key.|
 |`automountServiceAccountToken`|`boolean`|AutomountServiceAccountToken indicates whether a service account token should be automatically mounted in pods. ServiceAccountName of ExecutorConfig must be specified if this value is false.|
 |`container`|[`Container`](#container)|Container is the main container image to run in the pod|

diff --git a/docs/walk-through/annotations.md b/docs/walk-through/annotations.md
@@ -0,0 +1,66 @@
+# Annotations
+
+Argo Workflows now supports annotations as a new field in workflow templates.
+
+## Adding Annotations to a template
+
+To add annotations to a workflow template, include the `annotations` field in template definition, for example:
+
+```yaml
+apiVersion: argoproj.io/v1alpha1
+kind: WorkflowTemplate
+metadata:
+    name: example-workflow-template
+spec:
+    entrypoint: whalesay
+    templates:
+    - name: whalesay
+      annotations:
+        workflows.argoproj.io/display-name: "my-custom-display-name"
+      container:
+          image: docker/whalesay
+          command: [cowsay]
+          args: ["hello world"]
+```
+
+In this example, the annotation `workflows.argoproj.io/display-name` is used to change the node name in the UI to "my-custom-display-name".
+
+## Annotation Templates
+
+Annotations can also be created dynamically using parameters. This allows you to dynamically set annotation values based on input parameters.
+
+Here is an example:
+
+```yaml
+apiVersion: argoproj.io/v1alpha1
+kind: WorkflowTemplate
+metadata:
+  name: templated-annotations-workflow
+spec:
+  entrypoint: whalesay
+  arguments:
+    parameters:
+      - name: display-name
+        value: "default-display-name"
+  templates:
+  - name: whalesay
+    annotations:
+      workflows.argoproj.io/display-name: "{{inputs.parameters.display-name}}"
+    inputs:
+      parameters:
+        - name: display-name
+    container:
+      image: docker/whalesay
+      command: [cowsay]
+      args: ["hello world"]
+```
+
+In this example, the annotation `workflows.argoproj.io/display-name` is set using the `display-name` parameter. You can override this parameter when submitting the workflow to dynamically change the annotation value.
+
+## Supported Annotation Types
+
+Here is a table of all supported annotation types in Argo Workflows:
+
+| Annotation Key                               | Description                                                                 |
+|----------------------------------------------|-----------------------------------------------------------------------------|
+| `workflows.argoproj.io/display-name`         | Changes the node name in the UI.                                            |
diff --git a/docs/walk-through/loops.md b/docs/walk-through/loops.md
@@ -150,6 +150,8 @@ spec:
 
   # This template is the same as in the previous example
   - name: cat-os-release
+    annotations: 
+      workflows.argoproj.io/display-name: "os-{{inputs.parameters.image}}-{{inputs.parameters.tag}}" # this sets a custom name for the node in the UI, based on the template's parameters
     inputs:
       parameters:
       - name: image

diff --git a/examples/loops-param-argument.yaml b/examples/loops-param-argument.yaml
@@ -34,6 +34,8 @@ spec:
         withParam: "{{inputs.parameters.os-list}}"
 
   - name: cat-os-release
+    annotations: 
+      workflows.argoproj.io/display-name: "os-{{inputs.parameters.image}}-{{inputs.parameters.tag}}"
     inputs:
       parameters:
       - name: image

diff --git a/manifests/base/crds/full/argoproj.io_clusterworkflowtemplates.yaml b/manifests/base/crds/full/argoproj.io_clusterworkflowtemplates.yaml
diff --git a/manifests/base/crds/full/argoproj.io_cronworkflows.yaml b/manifests/base/crds/full/argoproj.io_cronworkflows.yaml
diff --git a/manifests/base/crds/full/argoproj.io_workflows.yaml b/manifests/base/crds/full/argoproj.io_workflows.yaml
diff --git a/manifests/base/crds/full/argoproj.io_workflowtasksets.yaml b/manifests/base/crds/full/argoproj.io_workflowtasksets.yaml
diff --git a/manifests/base/crds/full/argoproj.io_workflowtemplates.yaml b/manifests/base/crds/full/argoproj.io_workflowtemplates.yaml
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -88,6 +88,7 @@ nav:
           - walk-through/exit-handlers.md
           - walk-through/timeouts.md
           # template types
+          - walk-through/annotations.md
           - walk-through/suspending.md
           - walk-through/kubernetes-resources.md
           # container configuration