feat(controller): Inline templates

Signed-off-by: Alex Collins <alex_collins@intuit.com>

api/jsonschema/schema.json

@@ -3429,6 +3429,10 @@
           "description": "Hooks hold the lifecycle hook which is invoked at lifecycle of task, irrespective of the success, failure, or error status of the primary task",
           "type": "object"
         },
+        "inline": {
+          "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Template",
+          "description": "Inline is the template. Template must be empty if this is declared (and vice-versa)."
+        },
         "name": {
           "description": "Name is the name of the target",
           "type": "string"
@@ -5884,6 +5888,10 @@
           "description": "Hooks holds the lifecycle hook which is invoked at lifecycle of step, irrespective of the success, failure, or error status of the primary step",
           "type": "object"
         },
+        "inline": {
+          "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Template",
+          "description": "Inline is the template. Template must be empty if this is declared (and vice-versa)."
+        },
         "name": {
           "description": "Name of the step",
           "type": "string"

api/openapi-spec/swagger.json

@@ -6862,6 +6862,10 @@
             "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.LifecycleHook"
           }
         },
+        "inline": {
+          "description": "Inline is the template. Template must be empty if this is declared (and vice-versa).",
+          "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Template"
+        },
         "name": {
           "description": "Name is the name of the target",
           "type": "string"
@@ -9310,6 +9314,10 @@
             "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.LifecycleHook"
           }
         },
+        "inline": {
+          "description": "Inline is the template. Template must be empty if this is declared (and vice-versa).",
+          "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Template"
+        },
         "name": {
           "description": "Name of the step",
           "type": "string"

docs/templates.md

@@ -0,0 +1,23 @@
+# Templates
+
+See [core concepts](core-concepts.md) for DAG, steps, container templates. 
+
+## Container Set Template
+
+See [container set template](container-set-template.md).
+
+## Inline Templates
+
+![alpha](assets/alpha.svg)
+
+> v3.2 and after
+
+You can inline other templates within DAG and steps.
+
+Examples:
+
+* [DAG](examples/dag-inline-workflow.yaml)
+* [Steps](examples/steps-inline-workflow.yaml)
+
+!!! Warning
+    You can only inline once. Inlining a DAG within a DAG will not work.

examples/dag-inline-clusterworkflowtemplate.yaml

@@ -0,0 +1,18 @@
+apiVersion: argoproj.io/v1alpha1
+kind: ClusterWorkflowTemplate
+metadata:
+  name: dag-inline
+  annotations:
+    workflows.argoproj.io/description: |
+      This examples demonstrates running a DAG with inline templates.
+    workflows.argoproj.io/version: ">= 3.2.0"
+spec:
+  entrypoint: main
+  templates:
+    - name: main
+      dag:
+        tasks:
+          - name: a
+            inline:
+              container:
+                image: argoproj/argosay:v2

examples/dag-inline-cronworkflow.yaml

@@ -0,0 +1,13 @@
+apiVersion: argoproj.io/v1alpha1
+kind: CronWorkflow
+metadata:
+  name: dag-inline
+  annotations:
+    workflows.argoproj.io/description: |
+      This example demonstrates running cron workflow that has a DAG with inline templates.
+    workflows.argoproj.io/version: ">= 3.2.0"
+spec:
+  schedule: "*/5 * * * *"
+  workflowSpec:
+    workflowTemplateRef:
+      name: dag-inline

examples/dag-inline-workflow.yaml

@@ -0,0 +1,22 @@
+apiVersion: argoproj.io/v1alpha1
+kind: Workflow
+metadata:
+  generateName: dag-inline-
+  labels:
+    workflows.argoproj.io/test: "true"
+  annotations:
+    workflows.argoproj.io/description: |
+      This example demonstrates running a DAG with inline templates.
+    workflows.argoproj.io/version: ">= 3.2.0"
+    workflows.argoproj.io/verify.py: |
+      assert status["phase"] == "Succeeded"
+spec:
+  entrypoint: main
+  templates:
+    - name: main
+      dag:
+        tasks:
+          - name: a
+            inline:
+              container:
+                image: argoproj/argosay:v2

examples/dag-inline-workflowtemplate.yaml

@@ -0,0 +1,18 @@
+apiVersion: argoproj.io/v1alpha1
+kind: WorkflowTemplate
+metadata:
+  name: dag-inline
+  annotations:
+    workflows.argoproj.io/description: |
+      This example demonstrates running a DAG with inline templates.
+    workflows.argoproj.io/version: ">= 3.2.0"
+spec:
+  entrypoint: main
+  templates:
+    - name: main
+      dag:
+        tasks:
+          - name: a
+            inline:
+              container:
+                image: argoproj/argosay:v2

examples/steps-inline-workflow.yaml

@@ -0,0 +1,21 @@
+apiVersion: argoproj.io/v1alpha1
+kind: Workflow
+metadata:
+  generateName: steps-inline-
+  labels:
+    workflows.argoproj.io/test: "true"
+  annotations:
+    workflows.argoproj.io/description: |
+      This workflow demonstrates running a steps with inline templates.
+    workflows.argoproj.io/version: ">= 3.2.0"
+    workflows.argoproj.io/verify.py: |
+      assert status["phase"] == "Succeeded"
+spec:
+  entrypoint: main
+  templates:
+    - name: main
+      steps:
+        - - name: a
+            inline:
+              container:
+                image: argoproj/argosay:v2

manifests/base/crds/full/argoproj.io_clusterworkflowtemplates.yaml

@@ -3385,6 +3385,7 @@ spec:
                                 - template
                                 type: object
                               type: object
+                            inline: {}
                             name:
                               type: string
                             onExit:
@@ -9536,6 +9537,7 @@ spec:
                                   - template
                                   type: object
                                 type: object
+                              inline: {}
                               name:
                                 type: string
                               onExit:

manifests/base/crds/full/argoproj.io_cronworkflows.yaml

@@ -3406,6 +3406,7 @@ spec:
                                     - template
                                     type: object
                                   type: object
+                                inline: {}
                                 name:
                                   type: string
                                 onExit:
@@ -9557,6 +9558,7 @@ spec:
                                       - template
                                       type: object
                                     type: object
+                                  inline: {}
                                   name:
                                     type: string
                                   onExit:

manifests/base/crds/full/argoproj.io_workflows.yaml

@@ -3394,6 +3394,7 @@ spec:
                                 - template
                                 type: object
                               type: object
+                            inline: {}
                             name:
                               type: string
                             onExit:
@@ -9545,6 +9546,7 @@ spec:
                                   - template
                                   type: object
                                 type: object
+                              inline: {}
                               name:
                                 type: string
                               onExit:
@@ -18399,6 +18401,7 @@ spec:
                                   - template
                                   type: object
                                 type: object
+                              inline: {}
                               name:
                                 type: string
                               onExit:
@@ -25502,6 +25505,7 @@ spec:
                                     - template
                                     type: object
                                   type: object
+                                inline: {}
                                 name:
                                   type: string
                                 onExit:
@@ -31653,6 +31657,7 @@ spec:
                                       - template
                                       type: object
                                     type: object
+                                  inline: {}
                                   name:
                                     type: string
                                   onExit:

manifests/base/crds/full/argoproj.io_workflowtasksets.yaml

@@ -2437,6 +2437,7 @@ spec:
                                       - template
                                       type: object
                                     type: object
+                                  inline: {}
                                   name:
                                     type: string
                                   onExit:

manifests/base/crds/full/argoproj.io_workflowtemplates.yaml

@@ -3384,6 +3384,7 @@ spec:
                                 - template
                                 type: object
                               type: object
+                            inline: {}
                             name:
                               type: string
                             onExit:
@@ -9535,6 +9536,7 @@ spec:
                                   - template
                                   type: object
                                 type: object
+                              inline: {}
                               name:
                                 type: string
                               onExit:

mkdocs.yml

@@ -40,7 +40,9 @@ nav:
           - cluster-workflow-templates.md
           - cron-workflows.md
           - cron-backfill.md
+          - templates.md
           - container-set-template.md
+          - template-defaults.md
           - work-avoidance.md
           - enhanced-depends-logic.md
           - data-sourcing-and-transformation.md

pkg/apis/workflow/v1alpha1/common.go

@@ -31,8 +31,12 @@ type WorkflowSpecHolder interface {
 
 // TemplateReferenceHolder is an object that holds a reference to other templates; e.g. WorkflowStep, DAGTask, and NodeStatus
 type TemplateReferenceHolder interface {
-	GetTemplateName() string
+	// GetTemplate returns the template. This maybe nil. This is first precedence.
+	GetTemplate() *Template
+	// GetTemplateRef returns the template ref. This maybe nil. This is second precedence.
 	GetTemplateRef() *TemplateRef
+	// GetTemplateName returns the template name. This maybe empty. This is last precedence.
+	GetTemplateName() string
 }
 
 // SubmitOpts are workflow submission options