feat(controller): Add podMetadata field to workflow spec. Resolves #4985

(#5031) Signed-off-by: Dylan Hellems <[email protected]>
argoproj · Feb 10, 2021 · f461b04 · f461b04
1 parent 3b63e7d
commit f461b04
Show file tree

Hide file tree

Showing 15 changed files with 770 additions and 763 deletions.
diff --git a/api/jsonschema/schema.json b/api/jsonschema/schema.json
@@ -5280,6 +5280,10 @@
           "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.PodGC",
           "description": "PodGC describes the strategy to use when to deleting completed pods"
         },
+        "podMetadata": {
+          "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Metadata",
+          "description": "PodMetadata defines additional metadata that should be applied to workflow pods"
+        },
         "podPriority": {
           "description": "Priority to apply to workflow pods.",
           "type": "integer"
@@ -5744,6 +5748,10 @@
           "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.PodGC",
           "description": "PodGC describes the strategy to use when to deleting completed pods"
         },
+        "podMetadata": {
+          "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Metadata",
+          "description": "PodMetadata defines additional metadata that should be applied to workflow pods"
+        },
         "podPriority": {
           "description": "Priority to apply to workflow pods.",
           "type": "integer"

diff --git a/api/openapi-spec/swagger.json b/api/openapi-spec/swagger.json
@@ -8691,6 +8691,10 @@
           "description": "PodGC describes the strategy to use when to deleting completed pods",
           "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.PodGC"
         },
+        "podMetadata": {
+          "description": "PodMetadata defines additional metadata that should be applied to workflow pods",
+          "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Metadata"
+        },
         "podPriority": {
           "description": "Priority to apply to workflow pods.",
           "type": "integer"
@@ -9153,6 +9157,10 @@
           "description": "PodGC describes the strategy to use when to deleting completed pods",
           "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.PodGC"
         },
+        "podMetadata": {
+          "description": "PodMetadata defines additional metadata that should be applied to workflow pods",
+          "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Metadata"
+        },
         "podPriority": {
           "description": "Priority to apply to workflow pods.",
           "type": "integer"

diff --git a/docs/fields.md b/docs/fields.md
diff --git a/examples/pod-metadata-wf-field.yaml b/examples/pod-metadata-wf-field.yaml
@@ -0,0 +1,33 @@
+# This template demonstrates how pod annotations and labels may be set at the workflow level for all pods
+apiVersion: argoproj.io/v1alpha1
+kind: Workflow
+metadata:
+  generateName: steps-
+spec:
+  entrypoint: hello-hello-hello
+
+  podMetadata:
+    annotations:
+        iam.amazonaws.com/role: role-arn
+    labels:
+        app: whalesay
+        tier: demo
+
+  templates:
+  - name: hello-hello-hello
+    steps:
+    - - name: hello1
+        template: whalesay
+        arguments:
+          parameters:
+          - name: message
+            value: "hello1"
+
+  - name: whalesay
+    inputs:
+      parameters:
+      - name: message
+    container:
+      image: docker/whalesay
+      command: [cowsay]
+      args: ["{{inputs.parameters.message}}"]
diff --git a/manifests/base/crds/full/argoproj.io_clusterworkflowtemplates.yaml b/manifests/base/crds/full/argoproj.io_clusterworkflowtemplates.yaml
@@ -797,6 +797,17 @@ spec:
                   strategy:
                     type: string
                 type: object
+              podMetadata:
+                properties:
+                  annotations:
+                    additionalProperties:
+                      type: string
+                    type: object
+                  labels:
+                    additionalProperties:
+                      type: string
+                    type: object
+                type: object
               podPriority:
                 format: int32
                 type: integer

diff --git a/manifests/base/crds/full/argoproj.io_cronworkflows.yaml b/manifests/base/crds/full/argoproj.io_cronworkflows.yaml
@@ -818,6 +818,17 @@ spec:
                       strategy:
                         type: string
                     type: object
+                  podMetadata:
+                    properties:
+                      annotations:
+                        additionalProperties:
+                          type: string
+                        type: object
+                      labels:
+                        additionalProperties:
+                          type: string
+                        type: object
+                    type: object
                   podPriority:
                     format: int32
                     type: integer

diff --git a/manifests/base/crds/full/argoproj.io_workflows.yaml b/manifests/base/crds/full/argoproj.io_workflows.yaml
@@ -806,6 +806,17 @@ spec:
                   strategy:
                     type: string
                 type: object
+              podMetadata:
+                properties:
+                  annotations:
+                    additionalProperties:
+                      type: string
+                    type: object
+                  labels:
+                    additionalProperties:
+                      type: string
+                    type: object
+                type: object
               podPriority:
                 format: int32
                 type: integer
@@ -13920,6 +13931,17 @@ spec:
                       strategy:
                         type: string
                     type: object
+                  podMetadata:
+                    properties:
+                      annotations:
+                        additionalProperties:
+                          type: string
+                        type: object
+                      labels:
+                        additionalProperties:
+                          type: string
+                        type: object
+                    type: object
                   podPriority:
                     format: int32
                     type: integer

diff --git a/manifests/base/crds/full/argoproj.io_workflowtemplates.yaml b/manifests/base/crds/full/argoproj.io_workflowtemplates.yaml
@@ -796,6 +796,17 @@ spec:
                   strategy:
                     type: string
                 type: object
+              podMetadata:
+                properties:
+                  annotations:
+                    additionalProperties:
+                      type: string
+                    type: object
+                  labels:
+                    additionalProperties:
+                      type: string
+                    type: object
+                type: object
               podPriority:
                 format: int32
                 type: integer