From 06196b1bbb149d033913bd03e7a2765ef5c07fbf Mon Sep 17 00:00:00 2001 From: Simon Behar Date: Tue, 7 Apr 2020 15:40:36 -0700 Subject: [PATCH 1/4] docs: Added doc generator code --- Makefile | 6 +- docs/fields.md | 3187 ++++++++++++++++++++++++------------------------ hack/docgen.py | 239 ++++ 3 files changed, 1838 insertions(+), 1594 deletions(-) create mode 100644 hack/docgen.py diff --git a/Makefile b/Makefile index 3e275a58a8f3..06779a06f7ef 100644 --- a/Makefile +++ b/Makefile @@ -218,7 +218,7 @@ codegen: $(HOME)/go/bin/mockery ./hack/generate-proto.sh ./hack/update-codegen.sh - make api/openapi-spec/swagger.json + make docs find . -path '*/mocks/*' -type f -not -path '*/vendor/*' -exec ./hack/update-mocks.sh {} ';' rm -rf ./vendor @@ -432,6 +432,10 @@ $(HOME)/go/bin/swagger: api/openapi-spec/swagger.json: $(HOME)/go/bin/swagger $(SWAGGER_FILES) dist/MANIFESTS_VERSION hack/swaggify.sh swagger mixin -c 412 $(SWAGGER_FILES) | sed 's/VERSION/$(MANIFESTS_VERSION)/' | ./hack/swaggify.sh > api/openapi-spec/swagger.json +.PHONY: docs +docs: api/openapi-spec/swagger.json + python3 ./hack/docgen.py + # pre-push .PHONY: pre-commit diff --git a/docs/fields.md b/docs/fields.md index 19263c50f9a9..30504143b598 100644 --- a/docs/fields.md +++ b/docs/fields.md @@ -1,4 +1,5 @@ + # Argo Fields @@ -9,209 +10,209 @@ Workflow is the definition of a workflow resource Examples (click to open)
-- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) +- [`dns-config.yaml`](../examples/dns-config.yaml) -- [`default-pdb-support.yaml`](../examples/default-pdb-support.yaml) +- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) -- [`loops.yaml`](../examples/loops.yaml) +- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) -- [`retry-container.yaml`](../examples/retry-container.yaml) +- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) -- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) +- [`pod-spec-patch.yaml`](../examples/pod-spec-patch.yaml) -- [`retry-on-error.yaml`](../examples/retry-on-error.yaml) +- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) -- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) +- [`loops.yaml`](../examples/loops.yaml) - [`coinflip-recursive.yaml`](../examples/coinflip-recursive.yaml) -- [`continue-on-fail.yaml`](../examples/continue-on-fail.yaml) +- [`secrets.yaml`](../examples/secrets.yaml) -- [`input-artifact-s3.yaml`](../examples/input-artifact-s3.yaml) +- [`dag-nested.yaml`](../examples/dag-nested.yaml) -- [`steps.yaml`](../examples/steps.yaml) +- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) -- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) +- [`parallelism-limit.yaml`](../examples/parallelism-limit.yaml) - [`suspend-template.yaml`](../examples/suspend-template.yaml) -- [`volumes-emptydir.yaml`](../examples/volumes-emptydir.yaml) - -- [`timeouts-step.yaml`](../examples/timeouts-step.yaml) +- [`loops-dag.yaml`](../examples/loops-dag.yaml) -- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) +- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) -- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) +- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) -- [`retry-with-steps.yaml`](../examples/workflow-template/retry-with-steps.yaml) +- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) - [`archive-location.yaml`](../examples/archive-location.yaml) -- [`ci.yaml`](../examples/ci.yaml) +- [`parallelism-template-limit.yaml`](../examples/parallelism-template-limit.yaml) -- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) +- [`coinflip.yaml`](../examples/coinflip.yaml) -- [`sidecar-dind.yaml`](../examples/sidecar-dind.yaml) +- [`retry-backoff.yaml`](../examples/retry-backoff.yaml) -- [`input-artifact-gcs.yaml`](../examples/input-artifact-gcs.yaml) +- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) -- [`scripts-python.yaml`](../examples/scripts-python.yaml) +- [`steps.yaml`](../examples/workflow-template/steps.yaml) -- [`parallelism-template-limit.yaml`](../examples/parallelism-template-limit.yaml) +- [`retry-with-steps.yaml`](../examples/workflow-template/retry-with-steps.yaml) -- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) +- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) -- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) +- [`retry-container-to-completion.yaml`](../examples/retry-container-to-completion.yaml) -- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) +- [`status-reference.yaml`](../examples/status-reference.yaml) -- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) +- [`retry-script.yaml`](../examples/retry-script.yaml) -- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) +- [`sidecar-dind.yaml`](../examples/sidecar-dind.yaml) -- [`dag-continue-on-fail.yaml`](../examples/dag-continue-on-fail.yaml) +- [`conditionals.yaml`](../examples/conditionals.yaml) -- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) +- [`output-parameter.yaml`](../examples/output-parameter.yaml) -- [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) +- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) -- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) +- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) -- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) +- [`dag-continue-on-fail.yaml`](../examples/dag-continue-on-fail.yaml) -- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) +- [`loops-maps.yaml`](../examples/loops-maps.yaml) -- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) +- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) -- [`retry-backoff.yaml`](../examples/retry-backoff.yaml) +- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) - [`dag-targets.yaml`](../examples/dag-targets.yaml) -- [`resubmit.yaml`](../examples/resubmit.yaml) +- [`scripts-python.yaml`](../examples/scripts-python.yaml) -- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) +- [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) -- [`image-pull-secrets.yaml`](../examples/image-pull-secrets.yaml) +- [`forever.yaml`](../examples/forever.yaml) -- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) +- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) -- [`steps.yaml`](../examples/workflow-template/steps.yaml) +- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) -- [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) +- [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) -- [`dag-nested.yaml`](../examples/dag-nested.yaml) +- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) -- [`pod-spec-patch.yaml`](../examples/pod-spec-patch.yaml) +- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) -- [`hello-world.yaml`](../examples/hello-world.yaml) +- [`input-artifact-s3.yaml`](../examples/input-artifact-s3.yaml) -- [`coinflip.yaml`](../examples/coinflip.yaml) +- [`default-pdb-support.yaml`](../examples/default-pdb-support.yaml) -- [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) +- [`continue-on-fail.yaml`](../examples/continue-on-fail.yaml) -- [`loops-dag.yaml`](../examples/loops-dag.yaml) +- [`timeouts-step.yaml`](../examples/timeouts-step.yaml) -- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) +- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) -- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) +- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) -- [`daemon-step.yaml`](../examples/daemon-step.yaml) +- [`image-pull-secrets.yaml`](../examples/image-pull-secrets.yaml) -- [`k8s-set-owner-reference.yaml`](../examples/k8s-set-owner-reference.yaml) +- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) -- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) +- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) -- [`exit-handlers.yaml`](../examples/exit-handlers.yaml) +- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) -- [`retry-with-steps.yaml`](../examples/retry-with-steps.yaml) +- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) -- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) +- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) -- [`global-parameters.yaml`](../examples/global-parameters.yaml) +- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) -- [`k8s-owner-reference.yaml`](../examples/k8s-owner-reference.yaml) +- [`k8s-set-owner-reference.yaml`](../examples/k8s-set-owner-reference.yaml) -- [`timeouts-workflow.yaml`](../examples/timeouts-workflow.yaml) +- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) -- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) +- [`global-parameters.yaml`](../examples/global-parameters.yaml) -- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) +- [`hello-world.yaml`](../examples/hello-world.yaml) -- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) +- [`input-artifact-gcs.yaml`](../examples/input-artifact-gcs.yaml) -- [`sidecar-nginx.yaml`](../examples/sidecar-nginx.yaml) +- [`init-container.yaml`](../examples/init-container.yaml) -- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) +- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) -- [`input-artifact-oss.yaml`](../examples/input-artifact-oss.yaml) +- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) -- [`retry-container-to-completion.yaml`](../examples/retry-container-to-completion.yaml) +- [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) -- [`dag.yaml`](../examples/workflow-template/dag.yaml) +- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) -- [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) +- [`gc-ttl.yaml`](../examples/gc-ttl.yaml) + +- [`pod-gc-strategy.yaml`](../examples/pod-gc-strategy.yaml) - [`node-selector.yaml`](../examples/node-selector.yaml) -- [`dns-config.yaml`](../examples/dns-config.yaml) +- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) -- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) +- [`resubmit.yaml`](../examples/resubmit.yaml) -- [`gc-ttl.yaml`](../examples/gc-ttl.yaml) +- [`k8s-owner-reference.yaml`](../examples/k8s-owner-reference.yaml) -- [`sidecar.yaml`](../examples/sidecar.yaml) +- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) -- [`secrets.yaml`](../examples/secrets.yaml) +- [`volumes-emptydir.yaml`](../examples/volumes-emptydir.yaml) -- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) +- [`steps.yaml`](../examples/steps.yaml) -- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) +- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) -- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) +- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) -- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) +- [`dag.yaml`](../examples/workflow-template/dag.yaml) -- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) +- [`exit-handlers.yaml`](../examples/exit-handlers.yaml) -- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) +- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) -- [`init-container.yaml`](../examples/init-container.yaml) +- [`global-outputs.yaml`](../examples/global-outputs.yaml) -- [`retry-script.yaml`](../examples/retry-script.yaml) +- [`input-artifact-oss.yaml`](../examples/input-artifact-oss.yaml) -- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) +- [`ci.yaml`](../examples/ci.yaml) -- [`output-parameter.yaml`](../examples/output-parameter.yaml) +- [`sidecar.yaml`](../examples/sidecar.yaml) -- [`global-outputs.yaml`](../examples/global-outputs.yaml) +- [`retry-on-error.yaml`](../examples/retry-on-error.yaml) -- [`template-on-exit.yaml`](../examples/template-on-exit.yaml) +- [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) -- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) +- [`retry-with-steps.yaml`](../examples/retry-with-steps.yaml) -- [`forever.yaml`](../examples/forever.yaml) +- [`template-on-exit.yaml`](../examples/template-on-exit.yaml) -- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) +- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) -- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) +- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) -- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) +- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) -- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) +- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) -- [`parallelism-limit.yaml`](../examples/parallelism-limit.yaml) +- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) -- [`conditionals.yaml`](../examples/conditionals.yaml) +- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) -- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) +- [`daemon-step.yaml`](../examples/daemon-step.yaml) -- [`pod-gc-strategy.yaml`](../examples/pod-gc-strategy.yaml) +- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) -- [`status-reference.yaml`](../examples/status-reference.yaml) +- [`timeouts-workflow.yaml`](../examples/timeouts-workflow.yaml) -- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) +- [`sidecar-nginx.yaml`](../examples/sidecar-nginx.yaml) -- [`loops-maps.yaml`](../examples/loops-maps.yaml) +- [`retry-container.yaml`](../examples/retry-container.yaml) ### Fields @@ -261,217 +262,217 @@ WorkflowSpec is the specification of a Workflow. Examples with this field (click to open)
-- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) - -- [`cron-workflow.yaml`](../examples/cron-workflow.yaml) - -- [`testvolume.yaml`](../examples/testvolume.yaml) +- [`dns-config.yaml`](../examples/dns-config.yaml) -- [`default-pdb-support.yaml`](../examples/default-pdb-support.yaml) +- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) -- [`loops.yaml`](../examples/loops.yaml) +- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) -- [`retry-container.yaml`](../examples/retry-container.yaml) +- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) -- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) +- [`pod-spec-patch.yaml`](../examples/pod-spec-patch.yaml) -- [`retry-on-error.yaml`](../examples/retry-on-error.yaml) +- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) -- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) +- [`loops.yaml`](../examples/loops.yaml) - [`coinflip-recursive.yaml`](../examples/coinflip-recursive.yaml) -- [`continue-on-fail.yaml`](../examples/continue-on-fail.yaml) - -- [`input-artifact-s3.yaml`](../examples/input-artifact-s3.yaml) +- [`secrets.yaml`](../examples/secrets.yaml) -- [`steps.yaml`](../examples/steps.yaml) +- [`dag-nested.yaml`](../examples/dag-nested.yaml) -- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) +- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) -- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) +- [`parallelism-limit.yaml`](../examples/parallelism-limit.yaml) - [`suspend-template.yaml`](../examples/suspend-template.yaml) -- [`volumes-emptydir.yaml`](../examples/volumes-emptydir.yaml) - -- [`timeouts-step.yaml`](../examples/timeouts-step.yaml) +- [`loops-dag.yaml`](../examples/loops-dag.yaml) -- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) +- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) -- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) +- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) -- [`retry-with-steps.yaml`](../examples/workflow-template/retry-with-steps.yaml) +- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) - [`archive-location.yaml`](../examples/archive-location.yaml) -- [`ci.yaml`](../examples/ci.yaml) +- [`parallelism-template-limit.yaml`](../examples/parallelism-template-limit.yaml) -- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) +- [`coinflip.yaml`](../examples/coinflip.yaml) -- [`sidecar-dind.yaml`](../examples/sidecar-dind.yaml) +- [`retry-backoff.yaml`](../examples/retry-backoff.yaml) -- [`input-artifact-gcs.yaml`](../examples/input-artifact-gcs.yaml) +- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) -- [`scripts-python.yaml`](../examples/scripts-python.yaml) +- [`steps.yaml`](../examples/workflow-template/steps.yaml) -- [`parallelism-template-limit.yaml`](../examples/parallelism-template-limit.yaml) +- [`retry-with-steps.yaml`](../examples/workflow-template/retry-with-steps.yaml) -- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) +- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) -- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) +- [`retry-container-to-completion.yaml`](../examples/retry-container-to-completion.yaml) -- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) +- [`status-reference.yaml`](../examples/status-reference.yaml) -- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) +- [`retry-script.yaml`](../examples/retry-script.yaml) -- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) +- [`sidecar-dind.yaml`](../examples/sidecar-dind.yaml) -- [`dag-continue-on-fail.yaml`](../examples/dag-continue-on-fail.yaml) +- [`conditionals.yaml`](../examples/conditionals.yaml) -- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) +- [`output-parameter.yaml`](../examples/output-parameter.yaml) -- [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) +- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) -- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) +- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) -- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) +- [`dag-continue-on-fail.yaml`](../examples/dag-continue-on-fail.yaml) -- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) +- [`loops-maps.yaml`](../examples/loops-maps.yaml) -- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) +- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) -- [`retry-backoff.yaml`](../examples/retry-backoff.yaml) +- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) - [`dag-targets.yaml`](../examples/dag-targets.yaml) -- [`resubmit.yaml`](../examples/resubmit.yaml) - -- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) +- [`testvolume.yaml`](../examples/testvolume.yaml) -- [`image-pull-secrets.yaml`](../examples/image-pull-secrets.yaml) +- [`scripts-python.yaml`](../examples/scripts-python.yaml) -- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) +- [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) -- [`steps.yaml`](../examples/workflow-template/steps.yaml) +- [`forever.yaml`](../examples/forever.yaml) -- [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) +- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) -- [`dag-nested.yaml`](../examples/dag-nested.yaml) +- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) -- [`pod-spec-patch.yaml`](../examples/pod-spec-patch.yaml) +- [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) -- [`hello-world.yaml`](../examples/hello-world.yaml) +- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) -- [`coinflip.yaml`](../examples/coinflip.yaml) +- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) -- [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) +- [`input-artifact-s3.yaml`](../examples/input-artifact-s3.yaml) -- [`loops-dag.yaml`](../examples/loops-dag.yaml) +- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) -- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) +- [`default-pdb-support.yaml`](../examples/default-pdb-support.yaml) -- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) +- [`continue-on-fail.yaml`](../examples/continue-on-fail.yaml) -- [`daemon-step.yaml`](../examples/daemon-step.yaml) +- [`timeouts-step.yaml`](../examples/timeouts-step.yaml) -- [`k8s-set-owner-reference.yaml`](../examples/k8s-set-owner-reference.yaml) +- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) -- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) +- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) -- [`exit-handlers.yaml`](../examples/exit-handlers.yaml) +- [`image-pull-secrets.yaml`](../examples/image-pull-secrets.yaml) -- [`retry-with-steps.yaml`](../examples/retry-with-steps.yaml) +- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) -- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) +- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) -- [`global-parameters.yaml`](../examples/global-parameters.yaml) +- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) -- [`k8s-owner-reference.yaml`](../examples/k8s-owner-reference.yaml) +- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) -- [`timeouts-workflow.yaml`](../examples/timeouts-workflow.yaml) +- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) -- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) +- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) -- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) +- [`k8s-set-owner-reference.yaml`](../examples/k8s-set-owner-reference.yaml) -- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) +- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) -- [`sidecar-nginx.yaml`](../examples/sidecar-nginx.yaml) +- [`global-parameters.yaml`](../examples/global-parameters.yaml) -- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) +- [`cron-workflow.yaml`](../examples/cron-workflow.yaml) -- [`input-artifact-oss.yaml`](../examples/input-artifact-oss.yaml) +- [`hello-world.yaml`](../examples/hello-world.yaml) -- [`retry-container-to-completion.yaml`](../examples/retry-container-to-completion.yaml) +- [`input-artifact-gcs.yaml`](../examples/input-artifact-gcs.yaml) -- [`dag.yaml`](../examples/workflow-template/dag.yaml) +- [`init-container.yaml`](../examples/init-container.yaml) -- [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) +- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) -- [`node-selector.yaml`](../examples/node-selector.yaml) +- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) -- [`dns-config.yaml`](../examples/dns-config.yaml) +- [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) -- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) +- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) - [`gc-ttl.yaml`](../examples/gc-ttl.yaml) -- [`sidecar.yaml`](../examples/sidecar.yaml) +- [`pod-gc-strategy.yaml`](../examples/pod-gc-strategy.yaml) -- [`secrets.yaml`](../examples/secrets.yaml) +- [`node-selector.yaml`](../examples/node-selector.yaml) -- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) +- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) -- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) +- [`resubmit.yaml`](../examples/resubmit.yaml) -- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) +- [`k8s-owner-reference.yaml`](../examples/k8s-owner-reference.yaml) -- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) +- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) -- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) +- [`volumes-emptydir.yaml`](../examples/volumes-emptydir.yaml) -- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) +- [`steps.yaml`](../examples/steps.yaml) -- [`init-container.yaml`](../examples/init-container.yaml) +- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) -- [`retry-script.yaml`](../examples/retry-script.yaml) +- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) -- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) +- [`dag.yaml`](../examples/workflow-template/dag.yaml) -- [`output-parameter.yaml`](../examples/output-parameter.yaml) +- [`exit-handlers.yaml`](../examples/exit-handlers.yaml) + +- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) + +- [`templates.yaml`](../examples/workflow-template/templates.yaml) - [`global-outputs.yaml`](../examples/global-outputs.yaml) -- [`template-on-exit.yaml`](../examples/template-on-exit.yaml) +- [`input-artifact-oss.yaml`](../examples/input-artifact-oss.yaml) -- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) +- [`ci.yaml`](../examples/ci.yaml) -- [`forever.yaml`](../examples/forever.yaml) +- [`sidecar.yaml`](../examples/sidecar.yaml) -- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) +- [`retry-on-error.yaml`](../examples/retry-on-error.yaml) -- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) +- [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) -- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) +- [`retry-with-steps.yaml`](../examples/retry-with-steps.yaml) -- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) +- [`template-on-exit.yaml`](../examples/template-on-exit.yaml) -- [`parallelism-limit.yaml`](../examples/parallelism-limit.yaml) +- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) -- [`conditionals.yaml`](../examples/conditionals.yaml) +- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) -- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) +- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) -- [`pod-gc-strategy.yaml`](../examples/pod-gc-strategy.yaml) +- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) -- [`status-reference.yaml`](../examples/status-reference.yaml) +- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) -- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) +- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) -- [`templates.yaml`](../examples/workflow-template/templates.yaml) +- [`daemon-step.yaml`](../examples/daemon-step.yaml) -- [`loops-maps.yaml`](../examples/loops-maps.yaml) +- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) + +- [`timeouts-workflow.yaml`](../examples/timeouts-workflow.yaml) + +- [`sidecar-nginx.yaml`](../examples/sidecar-nginx.yaml) + +- [`retry-container.yaml`](../examples/retry-container.yaml) ### Fields @@ -493,14 +494,14 @@ WorkflowSpec is the specification of a Workflow. |`nodeSelector`|`Map< string , string >`|NodeSelector is a selector which will result in all pods of the workflowto be scheduled on the selected node(s). This is able to be overridden bya nodeSelector specified in the template.| |`onExit`|`string`|OnExit is a template reference which is invoked at the end of theworkflow, irrespective of the success, failure, or error of theprimary io.argoproj.workflow.v1alpha1.| |`parallelism`|`int64`|Parallelism limits the max total parallel pods that can execute at the same time in a workflow| -|`podDisruptionBudget`|[`PodDisruptionBudgetSpec`](#poddisruptionbudgetspec)|PodDisruptionBudget holds the number of concurrent disruptions that you allow for Workflow's Pods.Controller will automatically add the selector with workflow name, if selector is empty.Optional: Defaults to empty.+optional| +|`podDisruptionBudget`|[`PodDisruptionBudgetSpec`](#poddisruptionbudgetspec)|PodDisruptionBudget holds the number of concurrent disruptions that you allow for Workflow's Pods.Controller will automatically add the selector with workflow name, if selector is empty.Optional: Defaults to empty.| |`podGC`|[`PodGC`](#podgc)|PodGC describes the strategy to use when to deleting completed pods| |`podPriority`|`int32`|Priority to apply to workflow pods.| |`podPriorityClassName`|`string`|PriorityClassName to apply to workflow pods.| |`podSpecPatch`|`string`|PodSpecPatch holds strategic merge patch to apply against the pod spec. Allows parameterization ofcontainer fields which are not strings (e.g. resource limits).| |`priority`|`int32`|Priority is used if controller is configured to process limited number of workflows in parallel. Workflows with higher priority are processed first.| -|`schedulerName`|`string`|Set scheduler name for all pods.Will be overridden if container/script template's scheduler name is set.Default scheduler will be used if neither specified.+optional| -|`securityContext`|[`PodSecurityContext`](#podsecuritycontext)|SecurityContext holds pod-level security attributes and common container settings.Optional: Defaults to empty. See type description for default values of each field.+optional| +|`schedulerName`|`string`|Set scheduler name for all pods.Will be overridden if container/script template's scheduler name is set.Default scheduler will be used if neither specified.| +|`securityContext`|[`PodSecurityContext`](#podsecuritycontext)|SecurityContext holds pod-level security attributes and common container settings.Optional: Defaults to empty. See type description for default values of each field.| |`serviceAccountName`|`string`|ServiceAccountName is the name of the ServiceAccount to run all pods of the workflow as.| |`shutdown`|`string`|Shutdown will shutdown the workflow according to its ShutdownStrategy| |`suspend`|`boolean`|Suspend will suspend the workflow and prevent execution of any future steps in the workflow| @@ -538,217 +539,217 @@ CronWorkflowSpec is the specification of a CronWorkflow Examples with this field (click to open)
-- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) - -- [`cron-workflow.yaml`](../examples/cron-workflow.yaml) - -- [`testvolume.yaml`](../examples/testvolume.yaml) +- [`dns-config.yaml`](../examples/dns-config.yaml) -- [`default-pdb-support.yaml`](../examples/default-pdb-support.yaml) +- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) -- [`loops.yaml`](../examples/loops.yaml) +- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) -- [`retry-container.yaml`](../examples/retry-container.yaml) +- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) -- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) +- [`pod-spec-patch.yaml`](../examples/pod-spec-patch.yaml) -- [`retry-on-error.yaml`](../examples/retry-on-error.yaml) +- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) -- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) +- [`loops.yaml`](../examples/loops.yaml) - [`coinflip-recursive.yaml`](../examples/coinflip-recursive.yaml) -- [`continue-on-fail.yaml`](../examples/continue-on-fail.yaml) - -- [`input-artifact-s3.yaml`](../examples/input-artifact-s3.yaml) +- [`secrets.yaml`](../examples/secrets.yaml) -- [`steps.yaml`](../examples/steps.yaml) +- [`dag-nested.yaml`](../examples/dag-nested.yaml) -- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) +- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) -- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) +- [`parallelism-limit.yaml`](../examples/parallelism-limit.yaml) - [`suspend-template.yaml`](../examples/suspend-template.yaml) -- [`volumes-emptydir.yaml`](../examples/volumes-emptydir.yaml) - -- [`timeouts-step.yaml`](../examples/timeouts-step.yaml) +- [`loops-dag.yaml`](../examples/loops-dag.yaml) -- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) +- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) -- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) +- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) -- [`retry-with-steps.yaml`](../examples/workflow-template/retry-with-steps.yaml) +- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) - [`archive-location.yaml`](../examples/archive-location.yaml) -- [`ci.yaml`](../examples/ci.yaml) +- [`parallelism-template-limit.yaml`](../examples/parallelism-template-limit.yaml) -- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) +- [`coinflip.yaml`](../examples/coinflip.yaml) -- [`sidecar-dind.yaml`](../examples/sidecar-dind.yaml) +- [`retry-backoff.yaml`](../examples/retry-backoff.yaml) -- [`input-artifact-gcs.yaml`](../examples/input-artifact-gcs.yaml) +- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) -- [`scripts-python.yaml`](../examples/scripts-python.yaml) +- [`steps.yaml`](../examples/workflow-template/steps.yaml) -- [`parallelism-template-limit.yaml`](../examples/parallelism-template-limit.yaml) +- [`retry-with-steps.yaml`](../examples/workflow-template/retry-with-steps.yaml) -- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) +- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) -- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) +- [`retry-container-to-completion.yaml`](../examples/retry-container-to-completion.yaml) -- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) +- [`status-reference.yaml`](../examples/status-reference.yaml) -- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) +- [`retry-script.yaml`](../examples/retry-script.yaml) -- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) +- [`sidecar-dind.yaml`](../examples/sidecar-dind.yaml) -- [`dag-continue-on-fail.yaml`](../examples/dag-continue-on-fail.yaml) +- [`conditionals.yaml`](../examples/conditionals.yaml) -- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) +- [`output-parameter.yaml`](../examples/output-parameter.yaml) -- [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) +- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) -- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) +- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) -- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) +- [`dag-continue-on-fail.yaml`](../examples/dag-continue-on-fail.yaml) -- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) +- [`loops-maps.yaml`](../examples/loops-maps.yaml) -- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) +- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) -- [`retry-backoff.yaml`](../examples/retry-backoff.yaml) +- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) - [`dag-targets.yaml`](../examples/dag-targets.yaml) -- [`resubmit.yaml`](../examples/resubmit.yaml) +- [`testvolume.yaml`](../examples/testvolume.yaml) -- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) +- [`scripts-python.yaml`](../examples/scripts-python.yaml) -- [`image-pull-secrets.yaml`](../examples/image-pull-secrets.yaml) +- [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) -- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) +- [`forever.yaml`](../examples/forever.yaml) -- [`steps.yaml`](../examples/workflow-template/steps.yaml) +- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) -- [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) +- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) -- [`dag-nested.yaml`](../examples/dag-nested.yaml) +- [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) -- [`pod-spec-patch.yaml`](../examples/pod-spec-patch.yaml) +- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) -- [`hello-world.yaml`](../examples/hello-world.yaml) +- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) -- [`coinflip.yaml`](../examples/coinflip.yaml) +- [`input-artifact-s3.yaml`](../examples/input-artifact-s3.yaml) -- [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) +- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) -- [`loops-dag.yaml`](../examples/loops-dag.yaml) +- [`default-pdb-support.yaml`](../examples/default-pdb-support.yaml) -- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) +- [`continue-on-fail.yaml`](../examples/continue-on-fail.yaml) -- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) +- [`timeouts-step.yaml`](../examples/timeouts-step.yaml) -- [`daemon-step.yaml`](../examples/daemon-step.yaml) - -- [`k8s-set-owner-reference.yaml`](../examples/k8s-set-owner-reference.yaml) +- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) -- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) +- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) -- [`exit-handlers.yaml`](../examples/exit-handlers.yaml) +- [`image-pull-secrets.yaml`](../examples/image-pull-secrets.yaml) -- [`retry-with-steps.yaml`](../examples/retry-with-steps.yaml) +- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) -- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) +- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) -- [`global-parameters.yaml`](../examples/global-parameters.yaml) +- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) -- [`k8s-owner-reference.yaml`](../examples/k8s-owner-reference.yaml) +- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) -- [`timeouts-workflow.yaml`](../examples/timeouts-workflow.yaml) +- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) -- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) +- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) -- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) +- [`k8s-set-owner-reference.yaml`](../examples/k8s-set-owner-reference.yaml) -- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) +- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) -- [`sidecar-nginx.yaml`](../examples/sidecar-nginx.yaml) +- [`global-parameters.yaml`](../examples/global-parameters.yaml) -- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) +- [`cron-workflow.yaml`](../examples/cron-workflow.yaml) -- [`input-artifact-oss.yaml`](../examples/input-artifact-oss.yaml) +- [`hello-world.yaml`](../examples/hello-world.yaml) -- [`retry-container-to-completion.yaml`](../examples/retry-container-to-completion.yaml) +- [`input-artifact-gcs.yaml`](../examples/input-artifact-gcs.yaml) -- [`dag.yaml`](../examples/workflow-template/dag.yaml) +- [`init-container.yaml`](../examples/init-container.yaml) -- [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) +- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) -- [`node-selector.yaml`](../examples/node-selector.yaml) +- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) -- [`dns-config.yaml`](../examples/dns-config.yaml) +- [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) -- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) +- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) - [`gc-ttl.yaml`](../examples/gc-ttl.yaml) -- [`sidecar.yaml`](../examples/sidecar.yaml) +- [`pod-gc-strategy.yaml`](../examples/pod-gc-strategy.yaml) -- [`secrets.yaml`](../examples/secrets.yaml) +- [`node-selector.yaml`](../examples/node-selector.yaml) -- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) +- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) -- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) +- [`resubmit.yaml`](../examples/resubmit.yaml) -- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) +- [`k8s-owner-reference.yaml`](../examples/k8s-owner-reference.yaml) -- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) +- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) -- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) +- [`volumes-emptydir.yaml`](../examples/volumes-emptydir.yaml) -- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) +- [`steps.yaml`](../examples/steps.yaml) -- [`init-container.yaml`](../examples/init-container.yaml) +- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) -- [`retry-script.yaml`](../examples/retry-script.yaml) +- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) -- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) +- [`dag.yaml`](../examples/workflow-template/dag.yaml) -- [`output-parameter.yaml`](../examples/output-parameter.yaml) +- [`exit-handlers.yaml`](../examples/exit-handlers.yaml) + +- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) + +- [`templates.yaml`](../examples/workflow-template/templates.yaml) - [`global-outputs.yaml`](../examples/global-outputs.yaml) -- [`template-on-exit.yaml`](../examples/template-on-exit.yaml) +- [`input-artifact-oss.yaml`](../examples/input-artifact-oss.yaml) -- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) +- [`ci.yaml`](../examples/ci.yaml) -- [`forever.yaml`](../examples/forever.yaml) +- [`sidecar.yaml`](../examples/sidecar.yaml) -- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) +- [`retry-on-error.yaml`](../examples/retry-on-error.yaml) -- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) +- [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) -- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) +- [`retry-with-steps.yaml`](../examples/retry-with-steps.yaml) -- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) +- [`template-on-exit.yaml`](../examples/template-on-exit.yaml) -- [`parallelism-limit.yaml`](../examples/parallelism-limit.yaml) +- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) -- [`conditionals.yaml`](../examples/conditionals.yaml) +- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) -- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) +- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) -- [`pod-gc-strategy.yaml`](../examples/pod-gc-strategy.yaml) +- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) -- [`status-reference.yaml`](../examples/status-reference.yaml) +- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) -- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) +- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) -- [`templates.yaml`](../examples/workflow-template/templates.yaml) +- [`daemon-step.yaml`](../examples/daemon-step.yaml) -- [`loops-maps.yaml`](../examples/loops-maps.yaml) +- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) + +- [`timeouts-workflow.yaml`](../examples/timeouts-workflow.yaml) + +- [`sidecar-nginx.yaml`](../examples/sidecar-nginx.yaml) + +- [`retry-container.yaml`](../examples/retry-container.yaml) ### Fields @@ -781,217 +782,217 @@ WorkflowTemplateSpec is a spec of WorkflowTemplate. Examples with this field (click to open)
-- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) +- [`dns-config.yaml`](../examples/dns-config.yaml) -- [`cron-workflow.yaml`](../examples/cron-workflow.yaml) +- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) -- [`testvolume.yaml`](../examples/testvolume.yaml) +- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) -- [`default-pdb-support.yaml`](../examples/default-pdb-support.yaml) +- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) -- [`loops.yaml`](../examples/loops.yaml) +- [`pod-spec-patch.yaml`](../examples/pod-spec-patch.yaml) -- [`retry-container.yaml`](../examples/retry-container.yaml) +- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) -- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) +- [`loops.yaml`](../examples/loops.yaml) -- [`retry-on-error.yaml`](../examples/retry-on-error.yaml) +- [`coinflip-recursive.yaml`](../examples/coinflip-recursive.yaml) -- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) +- [`secrets.yaml`](../examples/secrets.yaml) -- [`coinflip-recursive.yaml`](../examples/coinflip-recursive.yaml) +- [`dag-nested.yaml`](../examples/dag-nested.yaml) -- [`continue-on-fail.yaml`](../examples/continue-on-fail.yaml) +- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) -- [`input-artifact-s3.yaml`](../examples/input-artifact-s3.yaml) +- [`parallelism-limit.yaml`](../examples/parallelism-limit.yaml) -- [`steps.yaml`](../examples/steps.yaml) +- [`suspend-template.yaml`](../examples/suspend-template.yaml) -- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) +- [`loops-dag.yaml`](../examples/loops-dag.yaml) -- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) +- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) -- [`suspend-template.yaml`](../examples/suspend-template.yaml) +- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) -- [`volumes-emptydir.yaml`](../examples/volumes-emptydir.yaml) +- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) -- [`timeouts-step.yaml`](../examples/timeouts-step.yaml) +- [`archive-location.yaml`](../examples/archive-location.yaml) -- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) +- [`parallelism-template-limit.yaml`](../examples/parallelism-template-limit.yaml) -- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) +- [`coinflip.yaml`](../examples/coinflip.yaml) -- [`retry-with-steps.yaml`](../examples/workflow-template/retry-with-steps.yaml) +- [`retry-backoff.yaml`](../examples/retry-backoff.yaml) -- [`archive-location.yaml`](../examples/archive-location.yaml) +- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) -- [`ci.yaml`](../examples/ci.yaml) +- [`steps.yaml`](../examples/workflow-template/steps.yaml) -- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) +- [`retry-with-steps.yaml`](../examples/workflow-template/retry-with-steps.yaml) -- [`sidecar-dind.yaml`](../examples/sidecar-dind.yaml) +- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) -- [`input-artifact-gcs.yaml`](../examples/input-artifact-gcs.yaml) +- [`retry-container-to-completion.yaml`](../examples/retry-container-to-completion.yaml) -- [`scripts-python.yaml`](../examples/scripts-python.yaml) +- [`status-reference.yaml`](../examples/status-reference.yaml) -- [`parallelism-template-limit.yaml`](../examples/parallelism-template-limit.yaml) +- [`retry-script.yaml`](../examples/retry-script.yaml) -- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) +- [`sidecar-dind.yaml`](../examples/sidecar-dind.yaml) -- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) +- [`conditionals.yaml`](../examples/conditionals.yaml) -- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) +- [`output-parameter.yaml`](../examples/output-parameter.yaml) -- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) +- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) -- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) +- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) - [`dag-continue-on-fail.yaml`](../examples/dag-continue-on-fail.yaml) -- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) +- [`loops-maps.yaml`](../examples/loops-maps.yaml) -- [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) +- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) -- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) +- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) -- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) +- [`dag-targets.yaml`](../examples/dag-targets.yaml) -- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) +- [`testvolume.yaml`](../examples/testvolume.yaml) -- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) +- [`scripts-python.yaml`](../examples/scripts-python.yaml) -- [`retry-backoff.yaml`](../examples/retry-backoff.yaml) +- [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) -- [`dag-targets.yaml`](../examples/dag-targets.yaml) +- [`forever.yaml`](../examples/forever.yaml) -- [`resubmit.yaml`](../examples/resubmit.yaml) +- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) -- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) +- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) -- [`image-pull-secrets.yaml`](../examples/image-pull-secrets.yaml) +- [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) -- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) +- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) -- [`steps.yaml`](../examples/workflow-template/steps.yaml) +- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) -- [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) +- [`input-artifact-s3.yaml`](../examples/input-artifact-s3.yaml) -- [`dag-nested.yaml`](../examples/dag-nested.yaml) +- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) -- [`pod-spec-patch.yaml`](../examples/pod-spec-patch.yaml) +- [`default-pdb-support.yaml`](../examples/default-pdb-support.yaml) -- [`hello-world.yaml`](../examples/hello-world.yaml) +- [`continue-on-fail.yaml`](../examples/continue-on-fail.yaml) -- [`coinflip.yaml`](../examples/coinflip.yaml) +- [`timeouts-step.yaml`](../examples/timeouts-step.yaml) -- [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) +- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) -- [`loops-dag.yaml`](../examples/loops-dag.yaml) +- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) -- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) +- [`image-pull-secrets.yaml`](../examples/image-pull-secrets.yaml) -- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) +- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) -- [`daemon-step.yaml`](../examples/daemon-step.yaml) +- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) -- [`k8s-set-owner-reference.yaml`](../examples/k8s-set-owner-reference.yaml) +- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) -- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) +- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) -- [`exit-handlers.yaml`](../examples/exit-handlers.yaml) +- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) -- [`retry-with-steps.yaml`](../examples/retry-with-steps.yaml) +- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) -- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) +- [`k8s-set-owner-reference.yaml`](../examples/k8s-set-owner-reference.yaml) -- [`global-parameters.yaml`](../examples/global-parameters.yaml) +- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) -- [`k8s-owner-reference.yaml`](../examples/k8s-owner-reference.yaml) +- [`global-parameters.yaml`](../examples/global-parameters.yaml) -- [`timeouts-workflow.yaml`](../examples/timeouts-workflow.yaml) +- [`cron-workflow.yaml`](../examples/cron-workflow.yaml) -- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) +- [`hello-world.yaml`](../examples/hello-world.yaml) -- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) +- [`input-artifact-gcs.yaml`](../examples/input-artifact-gcs.yaml) -- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) +- [`init-container.yaml`](../examples/init-container.yaml) -- [`sidecar-nginx.yaml`](../examples/sidecar-nginx.yaml) +- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) -- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) +- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) -- [`input-artifact-oss.yaml`](../examples/input-artifact-oss.yaml) +- [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) -- [`retry-container-to-completion.yaml`](../examples/retry-container-to-completion.yaml) +- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) -- [`dag.yaml`](../examples/workflow-template/dag.yaml) +- [`gc-ttl.yaml`](../examples/gc-ttl.yaml) -- [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) +- [`pod-gc-strategy.yaml`](../examples/pod-gc-strategy.yaml) - [`node-selector.yaml`](../examples/node-selector.yaml) -- [`dns-config.yaml`](../examples/dns-config.yaml) +- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) -- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) +- [`resubmit.yaml`](../examples/resubmit.yaml) -- [`gc-ttl.yaml`](../examples/gc-ttl.yaml) +- [`k8s-owner-reference.yaml`](../examples/k8s-owner-reference.yaml) -- [`sidecar.yaml`](../examples/sidecar.yaml) +- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) -- [`secrets.yaml`](../examples/secrets.yaml) +- [`volumes-emptydir.yaml`](../examples/volumes-emptydir.yaml) -- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) +- [`steps.yaml`](../examples/steps.yaml) -- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) +- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) -- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) +- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) -- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) +- [`dag.yaml`](../examples/workflow-template/dag.yaml) -- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) +- [`exit-handlers.yaml`](../examples/exit-handlers.yaml) -- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) +- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) -- [`init-container.yaml`](../examples/init-container.yaml) +- [`templates.yaml`](../examples/workflow-template/templates.yaml) -- [`retry-script.yaml`](../examples/retry-script.yaml) +- [`global-outputs.yaml`](../examples/global-outputs.yaml) -- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) +- [`input-artifact-oss.yaml`](../examples/input-artifact-oss.yaml) -- [`output-parameter.yaml`](../examples/output-parameter.yaml) +- [`ci.yaml`](../examples/ci.yaml) -- [`global-outputs.yaml`](../examples/global-outputs.yaml) +- [`sidecar.yaml`](../examples/sidecar.yaml) -- [`template-on-exit.yaml`](../examples/template-on-exit.yaml) +- [`retry-on-error.yaml`](../examples/retry-on-error.yaml) -- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) +- [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) -- [`forever.yaml`](../examples/forever.yaml) +- [`retry-with-steps.yaml`](../examples/retry-with-steps.yaml) -- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) +- [`template-on-exit.yaml`](../examples/template-on-exit.yaml) -- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) +- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) -- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) +- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) -- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) +- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) -- [`parallelism-limit.yaml`](../examples/parallelism-limit.yaml) +- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) -- [`conditionals.yaml`](../examples/conditionals.yaml) +- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) -- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) +- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) -- [`pod-gc-strategy.yaml`](../examples/pod-gc-strategy.yaml) +- [`daemon-step.yaml`](../examples/daemon-step.yaml) -- [`status-reference.yaml`](../examples/status-reference.yaml) +- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) -- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) +- [`timeouts-workflow.yaml`](../examples/timeouts-workflow.yaml) -- [`templates.yaml`](../examples/workflow-template/templates.yaml) +- [`sidecar-nginx.yaml`](../examples/sidecar-nginx.yaml) -- [`loops-maps.yaml`](../examples/loops-maps.yaml) +- [`retry-container.yaml`](../examples/retry-container.yaml) ### Fields @@ -1006,113 +1007,113 @@ Arguments to a template Examples with this field (click to open)
-- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) +- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) -- [`steps.yaml`](../examples/workflow-template/steps.yaml) +- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) -- [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) +- [`conditionals.yaml`](../examples/conditionals.yaml) -- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) +- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) -- [`ci.yaml`](../examples/ci.yaml) +- [`output-parameter.yaml`](../examples/output-parameter.yaml) -- [`dag-nested.yaml`](../examples/dag-nested.yaml) +- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) -- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) +- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) -- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) +- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) - [`pod-spec-patch.yaml`](../examples/pod-spec-patch.yaml) -- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) - -- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) - -- [`scripts-python.yaml`](../examples/scripts-python.yaml) - -- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) +- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) - [`loops.yaml`](../examples/loops.yaml) -- [`loops-dag.yaml`](../examples/loops-dag.yaml) +- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) -- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) +- [`steps.yaml`](../examples/steps.yaml) -- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) +- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) -- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) +- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) -- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) +- [`dag-nested.yaml`](../examples/dag-nested.yaml) -- [`daemon-step.yaml`](../examples/daemon-step.yaml) +- [`dag.yaml`](../examples/workflow-template/dag.yaml) -- [`output-parameter.yaml`](../examples/output-parameter.yaml) +- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) -- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) +- [`templates.yaml`](../examples/workflow-template/templates.yaml) - [`global-outputs.yaml`](../examples/global-outputs.yaml) -- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) +- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) -- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) +- [`ci.yaml`](../examples/ci.yaml) -- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) +- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) + +- [`loops-maps.yaml`](../examples/loops-maps.yaml) - [`global-parameters.yaml`](../examples/global-parameters.yaml) -- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) +- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) -- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) +- [`loops-dag.yaml`](../examples/loops-dag.yaml) -- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) +- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) -- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) +- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) -- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) +- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) -- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) +- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) -- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) +- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) -- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) +- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) -- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) +- [`dag-targets.yaml`](../examples/dag-targets.yaml) -- [`steps.yaml`](../examples/steps.yaml) +- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) -- [`conditionals.yaml`](../examples/conditionals.yaml) +- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) -- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) +- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) -- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) +- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) -- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) +- [`daemon-step.yaml`](../examples/daemon-step.yaml) -- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) +- [`scripts-python.yaml`](../examples/scripts-python.yaml) -- [`dag.yaml`](../examples/workflow-template/dag.yaml) +- [`steps.yaml`](../examples/workflow-template/steps.yaml) -- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) +- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) -- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) +- [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) -- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) +- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) -- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) +- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) -- [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) +- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) -- [`dag-targets.yaml`](../examples/dag-targets.yaml) +- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) -- [`templates.yaml`](../examples/workflow-template/templates.yaml) +- [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) - [`node-selector.yaml`](../examples/node-selector.yaml) -- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) +- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) -- [`loops-maps.yaml`](../examples/loops-maps.yaml) +- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) -- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) +- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) + +- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) + +- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) ### Fields @@ -1177,215 +1178,215 @@ Template is a reusable and composable unit of execution in a workflow Examples with this field (click to open)
-- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) - -- [`cron-workflow.yaml`](../examples/cron-workflow.yaml) +- [`dns-config.yaml`](../examples/dns-config.yaml) -- [`default-pdb-support.yaml`](../examples/default-pdb-support.yaml) +- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) -- [`loops.yaml`](../examples/loops.yaml) +- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) -- [`retry-container.yaml`](../examples/retry-container.yaml) +- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) -- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) +- [`pod-spec-patch.yaml`](../examples/pod-spec-patch.yaml) -- [`retry-on-error.yaml`](../examples/retry-on-error.yaml) +- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) -- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) +- [`loops.yaml`](../examples/loops.yaml) - [`coinflip-recursive.yaml`](../examples/coinflip-recursive.yaml) -- [`continue-on-fail.yaml`](../examples/continue-on-fail.yaml) - -- [`input-artifact-s3.yaml`](../examples/input-artifact-s3.yaml) +- [`secrets.yaml`](../examples/secrets.yaml) -- [`steps.yaml`](../examples/steps.yaml) +- [`dag-nested.yaml`](../examples/dag-nested.yaml) -- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) +- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) -- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) +- [`parallelism-limit.yaml`](../examples/parallelism-limit.yaml) - [`suspend-template.yaml`](../examples/suspend-template.yaml) -- [`volumes-emptydir.yaml`](../examples/volumes-emptydir.yaml) - -- [`timeouts-step.yaml`](../examples/timeouts-step.yaml) +- [`loops-dag.yaml`](../examples/loops-dag.yaml) -- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) +- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) -- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) +- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) -- [`retry-with-steps.yaml`](../examples/workflow-template/retry-with-steps.yaml) +- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) - [`archive-location.yaml`](../examples/archive-location.yaml) -- [`ci.yaml`](../examples/ci.yaml) +- [`parallelism-template-limit.yaml`](../examples/parallelism-template-limit.yaml) -- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) +- [`coinflip.yaml`](../examples/coinflip.yaml) -- [`sidecar-dind.yaml`](../examples/sidecar-dind.yaml) +- [`retry-backoff.yaml`](../examples/retry-backoff.yaml) -- [`input-artifact-gcs.yaml`](../examples/input-artifact-gcs.yaml) +- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) -- [`scripts-python.yaml`](../examples/scripts-python.yaml) +- [`steps.yaml`](../examples/workflow-template/steps.yaml) -- [`parallelism-template-limit.yaml`](../examples/parallelism-template-limit.yaml) +- [`retry-with-steps.yaml`](../examples/workflow-template/retry-with-steps.yaml) -- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) +- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) -- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) +- [`retry-container-to-completion.yaml`](../examples/retry-container-to-completion.yaml) -- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) +- [`status-reference.yaml`](../examples/status-reference.yaml) -- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) +- [`retry-script.yaml`](../examples/retry-script.yaml) -- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) +- [`sidecar-dind.yaml`](../examples/sidecar-dind.yaml) -- [`dag-continue-on-fail.yaml`](../examples/dag-continue-on-fail.yaml) +- [`conditionals.yaml`](../examples/conditionals.yaml) -- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) +- [`output-parameter.yaml`](../examples/output-parameter.yaml) -- [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) +- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) -- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) +- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) -- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) +- [`dag-continue-on-fail.yaml`](../examples/dag-continue-on-fail.yaml) -- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) +- [`loops-maps.yaml`](../examples/loops-maps.yaml) -- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) +- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) -- [`retry-backoff.yaml`](../examples/retry-backoff.yaml) +- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) - [`dag-targets.yaml`](../examples/dag-targets.yaml) -- [`resubmit.yaml`](../examples/resubmit.yaml) +- [`scripts-python.yaml`](../examples/scripts-python.yaml) -- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) +- [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) -- [`image-pull-secrets.yaml`](../examples/image-pull-secrets.yaml) +- [`forever.yaml`](../examples/forever.yaml) -- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) +- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) -- [`steps.yaml`](../examples/workflow-template/steps.yaml) +- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) -- [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) +- [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) -- [`dag-nested.yaml`](../examples/dag-nested.yaml) +- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) -- [`pod-spec-patch.yaml`](../examples/pod-spec-patch.yaml) +- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) -- [`hello-world.yaml`](../examples/hello-world.yaml) +- [`input-artifact-s3.yaml`](../examples/input-artifact-s3.yaml) -- [`coinflip.yaml`](../examples/coinflip.yaml) +- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) -- [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) +- [`default-pdb-support.yaml`](../examples/default-pdb-support.yaml) -- [`loops-dag.yaml`](../examples/loops-dag.yaml) +- [`continue-on-fail.yaml`](../examples/continue-on-fail.yaml) -- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) +- [`timeouts-step.yaml`](../examples/timeouts-step.yaml) -- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) +- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) -- [`daemon-step.yaml`](../examples/daemon-step.yaml) +- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) -- [`k8s-set-owner-reference.yaml`](../examples/k8s-set-owner-reference.yaml) +- [`image-pull-secrets.yaml`](../examples/image-pull-secrets.yaml) -- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) +- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) -- [`exit-handlers.yaml`](../examples/exit-handlers.yaml) +- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) -- [`retry-with-steps.yaml`](../examples/retry-with-steps.yaml) +- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) -- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) +- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) -- [`global-parameters.yaml`](../examples/global-parameters.yaml) +- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) -- [`k8s-owner-reference.yaml`](../examples/k8s-owner-reference.yaml) +- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) -- [`timeouts-workflow.yaml`](../examples/timeouts-workflow.yaml) +- [`k8s-set-owner-reference.yaml`](../examples/k8s-set-owner-reference.yaml) -- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) +- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) -- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) +- [`global-parameters.yaml`](../examples/global-parameters.yaml) -- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) +- [`cron-workflow.yaml`](../examples/cron-workflow.yaml) -- [`sidecar-nginx.yaml`](../examples/sidecar-nginx.yaml) +- [`hello-world.yaml`](../examples/hello-world.yaml) + +- [`input-artifact-gcs.yaml`](../examples/input-artifact-gcs.yaml) + +- [`init-container.yaml`](../examples/init-container.yaml) + +- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) -- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) +- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) -- [`input-artifact-oss.yaml`](../examples/input-artifact-oss.yaml) +- [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) -- [`retry-container-to-completion.yaml`](../examples/retry-container-to-completion.yaml) +- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) -- [`dag.yaml`](../examples/workflow-template/dag.yaml) +- [`gc-ttl.yaml`](../examples/gc-ttl.yaml) -- [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) +- [`pod-gc-strategy.yaml`](../examples/pod-gc-strategy.yaml) - [`node-selector.yaml`](../examples/node-selector.yaml) -- [`dns-config.yaml`](../examples/dns-config.yaml) +- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) -- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) +- [`resubmit.yaml`](../examples/resubmit.yaml) -- [`gc-ttl.yaml`](../examples/gc-ttl.yaml) +- [`k8s-owner-reference.yaml`](../examples/k8s-owner-reference.yaml) -- [`sidecar.yaml`](../examples/sidecar.yaml) +- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) -- [`secrets.yaml`](../examples/secrets.yaml) +- [`volumes-emptydir.yaml`](../examples/volumes-emptydir.yaml) -- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) +- [`steps.yaml`](../examples/steps.yaml) -- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) +- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) -- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) +- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) -- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) +- [`dag.yaml`](../examples/workflow-template/dag.yaml) -- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) +- [`exit-handlers.yaml`](../examples/exit-handlers.yaml) -- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) +- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) -- [`init-container.yaml`](../examples/init-container.yaml) +- [`templates.yaml`](../examples/workflow-template/templates.yaml) -- [`retry-script.yaml`](../examples/retry-script.yaml) +- [`global-outputs.yaml`](../examples/global-outputs.yaml) -- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) +- [`input-artifact-oss.yaml`](../examples/input-artifact-oss.yaml) -- [`output-parameter.yaml`](../examples/output-parameter.yaml) +- [`ci.yaml`](../examples/ci.yaml) -- [`global-outputs.yaml`](../examples/global-outputs.yaml) +- [`sidecar.yaml`](../examples/sidecar.yaml) -- [`template-on-exit.yaml`](../examples/template-on-exit.yaml) +- [`retry-on-error.yaml`](../examples/retry-on-error.yaml) -- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) +- [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) -- [`forever.yaml`](../examples/forever.yaml) +- [`retry-with-steps.yaml`](../examples/retry-with-steps.yaml) -- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) +- [`template-on-exit.yaml`](../examples/template-on-exit.yaml) -- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) +- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) -- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) +- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) -- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) +- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) -- [`parallelism-limit.yaml`](../examples/parallelism-limit.yaml) +- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) -- [`conditionals.yaml`](../examples/conditionals.yaml) +- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) -- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) +- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) -- [`pod-gc-strategy.yaml`](../examples/pod-gc-strategy.yaml) +- [`daemon-step.yaml`](../examples/daemon-step.yaml) -- [`status-reference.yaml`](../examples/status-reference.yaml) +- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) -- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) +- [`timeouts-workflow.yaml`](../examples/timeouts-workflow.yaml) -- [`templates.yaml`](../examples/workflow-template/templates.yaml) +- [`sidecar-nginx.yaml`](../examples/sidecar-nginx.yaml) -- [`loops-maps.yaml`](../examples/loops-maps.yaml) +- [`retry-container.yaml`](../examples/retry-container.yaml) ### Fields @@ -1415,12 +1416,12 @@ Template is a reusable and composable unit of execution in a workflow |`resource`|[`ResourceTemplate`](#resourcetemplate)|Resource template subtype which can run k8s resources| |`resubmitPendingPods`|`boolean`|ResubmitPendingPods is a flag to enable resubmitting pods that remain Pending after initial submission| |`retryStrategy`|[`RetryStrategy`](#retrystrategy)|RetryStrategy describes how to retry a template when it fails| -|`schedulerName`|`string`|If specified, the pod will be dispatched by specified scheduler.Or it will be dispatched by workflow scope scheduler if specified.If neither specified, the pod will be dispatched by default scheduler.+optional| +|`schedulerName`|`string`|If specified, the pod will be dispatched by specified scheduler.Or it will be dispatched by workflow scope scheduler if specified.If neither specified, the pod will be dispatched by default scheduler.| |`script`|[`ScriptTemplate`](#scripttemplate)|Script runs a portion of code against an interpreter| -|`securityContext`|[`PodSecurityContext`](#podsecuritycontext)|SecurityContext holds pod-level security attributes and common container settings.Optional: Defaults to empty. See type description for default values of each field.+optional| +|`securityContext`|[`PodSecurityContext`](#podsecuritycontext)|SecurityContext holds pod-level security attributes and common container settings.Optional: Defaults to empty. See type description for default values of each field.| |`serviceAccountName`|`string`|ServiceAccountName to apply to workflow pods| |`sidecars`|`Array<`[`UserContainer`](#usercontainer)`>`|Sidecars is a list of containers which run alongside the main containerSidecars are automatically killed when the main container completes| -|`steps`|`Array>`|Steps define a series of sequential/parallel workflow steps| +|`steps`|`Array<`[`ParallelSteps`](#parallelsteps)`>`|Steps define a series of sequential/parallel workflow steps| |`suspend`|[`SuspendTemplate`](#suspendtemplate)|Suspend template subtype which can suspend a workflow when reaching the step| |~`template`~|~`string`~|~Template is the name of the template which is used as the base of this template.~ DEPRECATED: This field is not used.| |~`templateRef`~|~[`TemplateRef`](#templateref)~|~TemplateRef is the reference to the template resource which is used as the base of this template.~ DEPRECATED: This field is not used.| @@ -1491,43 +1492,43 @@ Outputs hold parameters, artifacts, and results from a step Examples with this field (click to open)
-- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) +- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) -- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) +- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) -- [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) +- [`output-parameter.yaml`](../examples/output-parameter.yaml) -- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) +- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) -- [`output-parameter.yaml`](../examples/output-parameter.yaml) +- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) -- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) +- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) - [`global-outputs.yaml`](../examples/global-outputs.yaml) -- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) +- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) -- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) +- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) -- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) +- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) -- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) +- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) -- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) +- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) - [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) -- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) - - [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) -- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) +- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) -- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) +- [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) + +- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) - [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) -- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) +- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) ### Fields @@ -1544,43 +1545,43 @@ Artifact indicates an artifact to place at a specified path Examples with this field (click to open)
-- [`ci.yaml`](../examples/ci.yaml) +- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) -- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) +- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) -- [`input-artifact-gcs.yaml`](../examples/input-artifact-gcs.yaml) +- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) - [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) -- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) - -- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) - -- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) - - [`global-outputs.yaml`](../examples/global-outputs.yaml) -- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) +- [`input-artifact-oss.yaml`](../examples/input-artifact-oss.yaml) -- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) +- [`ci.yaml`](../examples/ci.yaml) + +- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) - [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) -- [`input-artifact-s3.yaml`](../examples/input-artifact-s3.yaml) +- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) -- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) +- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) -- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) +- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) -- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) +- [`input-artifact-gcs.yaml`](../examples/input-artifact-gcs.yaml) -- [`input-artifact-oss.yaml`](../examples/input-artifact-oss.yaml) +- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) + +- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) - [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) -- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) +- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) -- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) +- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) + +- [`input-artifact-s3.yaml`](../examples/input-artifact-s3.yaml) ### Fields @@ -1602,107 +1603,107 @@ Parameter indicate a passed string parameter to a service template with an optio Examples with this field (click to open)
-- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) - -- [`steps.yaml`](../examples/workflow-template/steps.yaml) - -- [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) +- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) -- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) +- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) -- [`ci.yaml`](../examples/ci.yaml) +- [`conditionals.yaml`](../examples/conditionals.yaml) -- [`dag-nested.yaml`](../examples/dag-nested.yaml) +- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) -- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) +- [`output-parameter.yaml`](../examples/output-parameter.yaml) -- [`pod-spec-patch.yaml`](../examples/pod-spec-patch.yaml) +- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) -- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) +- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) -- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) +- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) -- [`scripts-python.yaml`](../examples/scripts-python.yaml) +- [`pod-spec-patch.yaml`](../examples/pod-spec-patch.yaml) -- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) +- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) - [`loops.yaml`](../examples/loops.yaml) -- [`loops-dag.yaml`](../examples/loops-dag.yaml) +- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) -- [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) +- [`steps.yaml`](../examples/steps.yaml) -- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) +- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) -- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) +- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) -- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) +- [`dag-nested.yaml`](../examples/dag-nested.yaml) -- [`daemon-step.yaml`](../examples/daemon-step.yaml) +- [`dag.yaml`](../examples/workflow-template/dag.yaml) -- [`output-parameter.yaml`](../examples/output-parameter.yaml) +- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) -- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) +- [`templates.yaml`](../examples/workflow-template/templates.yaml) - [`global-outputs.yaml`](../examples/global-outputs.yaml) -- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) +- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) -- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) +- [`ci.yaml`](../examples/ci.yaml) + +- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) + +- [`loops-maps.yaml`](../examples/loops-maps.yaml) - [`global-parameters.yaml`](../examples/global-parameters.yaml) -- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) +- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) -- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) +- [`loops-dag.yaml`](../examples/loops-dag.yaml) -- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) +- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) -- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) +- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) -- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) +- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) -- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) +- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) -- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) +- [`dag-targets.yaml`](../examples/dag-targets.yaml) -- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) +- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) -- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) +- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) -- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) +- [`daemon-step.yaml`](../examples/daemon-step.yaml) -- [`steps.yaml`](../examples/steps.yaml) +- [`scripts-python.yaml`](../examples/scripts-python.yaml) -- [`conditionals.yaml`](../examples/conditionals.yaml) +- [`steps.yaml`](../examples/workflow-template/steps.yaml) -- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) +- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) -- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) +- [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) -- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) +- [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) -- [`dag.yaml`](../examples/workflow-template/dag.yaml) +- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) -- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) +- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) -- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) +- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) -- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) +- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) - [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) -- [`templates.yaml`](../examples/workflow-template/templates.yaml) +- [`node-selector.yaml`](../examples/node-selector.yaml) -- [`dag-targets.yaml`](../examples/dag-targets.yaml) +- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) -- [`node-selector.yaml`](../examples/node-selector.yaml) +- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) -- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) +- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) -- [`loops-maps.yaml`](../examples/loops-maps.yaml) +- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) -- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) +- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) ### Fields @@ -1765,41 +1766,41 @@ DAGTemplate is a template subtype for directed acyclic graph templates Examples with this field (click to open)
-- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) - -- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) +- [`dag.yaml`](../examples/workflow-template/dag.yaml) -- [`dag-continue-on-fail.yaml`](../examples/dag-continue-on-fail.yaml) +- [`templates.yaml`](../examples/workflow-template/templates.yaml) - [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) -- [`loops-dag.yaml`](../examples/loops-dag.yaml) +- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) -- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) +- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) -- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) +- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) -- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) +- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) -- [`templates.yaml`](../examples/workflow-template/templates.yaml) +- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) + +- [`dag-continue-on-fail.yaml`](../examples/dag-continue-on-fail.yaml) - [`dag-targets.yaml`](../examples/dag-targets.yaml) -- [`resubmit.yaml`](../examples/resubmit.yaml) +- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) -- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) +- [`resubmit.yaml`](../examples/resubmit.yaml) -- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) +- [`loops-dag.yaml`](../examples/loops-dag.yaml) -- [`dag-nested.yaml`](../examples/dag-nested.yaml) +- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) -- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) +- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) -- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) +- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) -- [`dag.yaml`](../examples/workflow-template/dag.yaml) +- [`dag-nested.yaml`](../examples/dag-nested.yaml) -- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) +- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) ### Fields @@ -1832,107 +1833,107 @@ Inputs are the mechanism for passing parameters, artifacts, volumes from one tem Examples with this field (click to open)
-- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) - -- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) - -- [`ci.yaml`](../examples/ci.yaml) - -- [`dag-nested.yaml`](../examples/dag-nested.yaml) +- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) -- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) +- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) -- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) +- [`conditionals.yaml`](../examples/conditionals.yaml) -- [`input-artifact-gcs.yaml`](../examples/input-artifact-gcs.yaml) +- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) -- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) +- [`output-parameter.yaml`](../examples/output-parameter.yaml) -- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) +- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) -- [`scripts-python.yaml`](../examples/scripts-python.yaml) +- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) -- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) +- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) -- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) +- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) - [`loops.yaml`](../examples/loops.yaml) -- [`loops-dag.yaml`](../examples/loops-dag.yaml) +- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) -- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) +- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) -- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) +- [`steps.yaml`](../examples/steps.yaml) -- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) +- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) -- [`daemon-step.yaml`](../examples/daemon-step.yaml) +- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) -- [`output-parameter.yaml`](../examples/output-parameter.yaml) +- [`dag-nested.yaml`](../examples/dag-nested.yaml) -- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) +- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) + +- [`templates.yaml`](../examples/workflow-template/templates.yaml) - [`global-outputs.yaml`](../examples/global-outputs.yaml) -- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) +- [`input-artifact-oss.yaml`](../examples/input-artifact-oss.yaml) -- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) +- [`ci.yaml`](../examples/ci.yaml) -- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) +- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) -- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) +- [`loops-maps.yaml`](../examples/loops-maps.yaml) -- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) +- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) -- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) +- [`loops-dag.yaml`](../examples/loops-dag.yaml) -- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) +- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) - [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) -- [`input-artifact-s3.yaml`](../examples/input-artifact-s3.yaml) - -- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) +- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) -- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) +- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) -- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) +- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) -- [`steps.yaml`](../examples/steps.yaml) +- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) -- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) +- [`input-artifact-gcs.yaml`](../examples/input-artifact-gcs.yaml) -- [`conditionals.yaml`](../examples/conditionals.yaml) +- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) -- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) +- [`dag-targets.yaml`](../examples/dag-targets.yaml) -- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) +- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) -- [`input-artifact-oss.yaml`](../examples/input-artifact-oss.yaml) +- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) -- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) +- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) -- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) +- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) -- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) +- [`daemon-step.yaml`](../examples/daemon-step.yaml) -- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) +- [`scripts-python.yaml`](../examples/scripts-python.yaml) -- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) +- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) -- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) +- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) -- [`templates.yaml`](../examples/workflow-template/templates.yaml) +- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) -- [`dag-targets.yaml`](../examples/dag-targets.yaml) +- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) - [`node-selector.yaml`](../examples/node-selector.yaml) -- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) +- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) -- [`loops-maps.yaml`](../examples/loops-maps.yaml) +- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) -- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) +- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) + +- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) + +- [`input-artifact-s3.yaml`](../examples/input-artifact-s3.yaml) + +- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) ### Fields @@ -1948,217 +1949,217 @@ Pod metdata Examples with this field (click to open)
-- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) +- [`dns-config.yaml`](../examples/dns-config.yaml) -- [`cron-workflow.yaml`](../examples/cron-workflow.yaml) +- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) -- [`testvolume.yaml`](../examples/testvolume.yaml) +- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) -- [`default-pdb-support.yaml`](../examples/default-pdb-support.yaml) +- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) -- [`loops.yaml`](../examples/loops.yaml) +- [`pod-spec-patch.yaml`](../examples/pod-spec-patch.yaml) -- [`retry-container.yaml`](../examples/retry-container.yaml) +- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) -- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) +- [`loops.yaml`](../examples/loops.yaml) -- [`retry-on-error.yaml`](../examples/retry-on-error.yaml) +- [`coinflip-recursive.yaml`](../examples/coinflip-recursive.yaml) -- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) +- [`secrets.yaml`](../examples/secrets.yaml) -- [`coinflip-recursive.yaml`](../examples/coinflip-recursive.yaml) +- [`dag-nested.yaml`](../examples/dag-nested.yaml) -- [`continue-on-fail.yaml`](../examples/continue-on-fail.yaml) +- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) -- [`input-artifact-s3.yaml`](../examples/input-artifact-s3.yaml) +- [`parallelism-limit.yaml`](../examples/parallelism-limit.yaml) -- [`steps.yaml`](../examples/steps.yaml) +- [`suspend-template.yaml`](../examples/suspend-template.yaml) -- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) +- [`loops-dag.yaml`](../examples/loops-dag.yaml) -- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) +- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) -- [`suspend-template.yaml`](../examples/suspend-template.yaml) +- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) -- [`volumes-emptydir.yaml`](../examples/volumes-emptydir.yaml) +- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) -- [`timeouts-step.yaml`](../examples/timeouts-step.yaml) +- [`archive-location.yaml`](../examples/archive-location.yaml) -- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) +- [`parallelism-template-limit.yaml`](../examples/parallelism-template-limit.yaml) -- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) +- [`coinflip.yaml`](../examples/coinflip.yaml) -- [`retry-with-steps.yaml`](../examples/workflow-template/retry-with-steps.yaml) +- [`retry-backoff.yaml`](../examples/retry-backoff.yaml) -- [`archive-location.yaml`](../examples/archive-location.yaml) +- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) -- [`ci.yaml`](../examples/ci.yaml) +- [`steps.yaml`](../examples/workflow-template/steps.yaml) -- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) +- [`retry-with-steps.yaml`](../examples/workflow-template/retry-with-steps.yaml) -- [`sidecar-dind.yaml`](../examples/sidecar-dind.yaml) +- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) -- [`input-artifact-gcs.yaml`](../examples/input-artifact-gcs.yaml) +- [`retry-container-to-completion.yaml`](../examples/retry-container-to-completion.yaml) -- [`scripts-python.yaml`](../examples/scripts-python.yaml) +- [`status-reference.yaml`](../examples/status-reference.yaml) -- [`parallelism-template-limit.yaml`](../examples/parallelism-template-limit.yaml) +- [`retry-script.yaml`](../examples/retry-script.yaml) -- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) +- [`sidecar-dind.yaml`](../examples/sidecar-dind.yaml) -- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) +- [`conditionals.yaml`](../examples/conditionals.yaml) -- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) +- [`output-parameter.yaml`](../examples/output-parameter.yaml) -- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) +- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) -- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) +- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) - [`dag-continue-on-fail.yaml`](../examples/dag-continue-on-fail.yaml) -- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) +- [`loops-maps.yaml`](../examples/loops-maps.yaml) -- [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) +- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) -- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) +- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) -- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) +- [`dag-targets.yaml`](../examples/dag-targets.yaml) -- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) +- [`testvolume.yaml`](../examples/testvolume.yaml) -- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) +- [`scripts-python.yaml`](../examples/scripts-python.yaml) -- [`retry-backoff.yaml`](../examples/retry-backoff.yaml) +- [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) -- [`dag-targets.yaml`](../examples/dag-targets.yaml) +- [`forever.yaml`](../examples/forever.yaml) -- [`resubmit.yaml`](../examples/resubmit.yaml) +- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) -- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) +- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) -- [`image-pull-secrets.yaml`](../examples/image-pull-secrets.yaml) +- [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) -- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) +- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) -- [`steps.yaml`](../examples/workflow-template/steps.yaml) +- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) -- [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) +- [`input-artifact-s3.yaml`](../examples/input-artifact-s3.yaml) -- [`dag-nested.yaml`](../examples/dag-nested.yaml) +- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) -- [`pod-spec-patch.yaml`](../examples/pod-spec-patch.yaml) +- [`default-pdb-support.yaml`](../examples/default-pdb-support.yaml) -- [`hello-world.yaml`](../examples/hello-world.yaml) +- [`continue-on-fail.yaml`](../examples/continue-on-fail.yaml) -- [`coinflip.yaml`](../examples/coinflip.yaml) +- [`timeouts-step.yaml`](../examples/timeouts-step.yaml) -- [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) +- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) -- [`loops-dag.yaml`](../examples/loops-dag.yaml) +- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) -- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) +- [`image-pull-secrets.yaml`](../examples/image-pull-secrets.yaml) -- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) +- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) -- [`daemon-step.yaml`](../examples/daemon-step.yaml) +- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) -- [`k8s-set-owner-reference.yaml`](../examples/k8s-set-owner-reference.yaml) +- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) -- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) +- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) -- [`exit-handlers.yaml`](../examples/exit-handlers.yaml) +- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) -- [`retry-with-steps.yaml`](../examples/retry-with-steps.yaml) +- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) -- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) +- [`k8s-set-owner-reference.yaml`](../examples/k8s-set-owner-reference.yaml) -- [`global-parameters.yaml`](../examples/global-parameters.yaml) +- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) -- [`k8s-owner-reference.yaml`](../examples/k8s-owner-reference.yaml) +- [`global-parameters.yaml`](../examples/global-parameters.yaml) -- [`timeouts-workflow.yaml`](../examples/timeouts-workflow.yaml) +- [`cron-workflow.yaml`](../examples/cron-workflow.yaml) -- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) +- [`hello-world.yaml`](../examples/hello-world.yaml) -- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) +- [`input-artifact-gcs.yaml`](../examples/input-artifact-gcs.yaml) -- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) +- [`init-container.yaml`](../examples/init-container.yaml) -- [`sidecar-nginx.yaml`](../examples/sidecar-nginx.yaml) +- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) -- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) +- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) -- [`input-artifact-oss.yaml`](../examples/input-artifact-oss.yaml) +- [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) -- [`retry-container-to-completion.yaml`](../examples/retry-container-to-completion.yaml) +- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) -- [`dag.yaml`](../examples/workflow-template/dag.yaml) +- [`gc-ttl.yaml`](../examples/gc-ttl.yaml) -- [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) +- [`pod-gc-strategy.yaml`](../examples/pod-gc-strategy.yaml) - [`node-selector.yaml`](../examples/node-selector.yaml) -- [`dns-config.yaml`](../examples/dns-config.yaml) +- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) -- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) +- [`resubmit.yaml`](../examples/resubmit.yaml) -- [`gc-ttl.yaml`](../examples/gc-ttl.yaml) +- [`k8s-owner-reference.yaml`](../examples/k8s-owner-reference.yaml) -- [`sidecar.yaml`](../examples/sidecar.yaml) +- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) -- [`secrets.yaml`](../examples/secrets.yaml) +- [`volumes-emptydir.yaml`](../examples/volumes-emptydir.yaml) -- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) +- [`steps.yaml`](../examples/steps.yaml) -- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) +- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) -- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) +- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) -- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) +- [`dag.yaml`](../examples/workflow-template/dag.yaml) -- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) +- [`exit-handlers.yaml`](../examples/exit-handlers.yaml) -- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) +- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) -- [`init-container.yaml`](../examples/init-container.yaml) +- [`templates.yaml`](../examples/workflow-template/templates.yaml) -- [`retry-script.yaml`](../examples/retry-script.yaml) +- [`global-outputs.yaml`](../examples/global-outputs.yaml) -- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) +- [`input-artifact-oss.yaml`](../examples/input-artifact-oss.yaml) -- [`output-parameter.yaml`](../examples/output-parameter.yaml) +- [`ci.yaml`](../examples/ci.yaml) -- [`global-outputs.yaml`](../examples/global-outputs.yaml) +- [`sidecar.yaml`](../examples/sidecar.yaml) -- [`template-on-exit.yaml`](../examples/template-on-exit.yaml) +- [`retry-on-error.yaml`](../examples/retry-on-error.yaml) -- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) +- [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) -- [`forever.yaml`](../examples/forever.yaml) +- [`retry-with-steps.yaml`](../examples/retry-with-steps.yaml) -- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) +- [`template-on-exit.yaml`](../examples/template-on-exit.yaml) -- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) +- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) -- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) +- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) -- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) +- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) -- [`parallelism-limit.yaml`](../examples/parallelism-limit.yaml) +- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) -- [`conditionals.yaml`](../examples/conditionals.yaml) +- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) -- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) +- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) -- [`pod-gc-strategy.yaml`](../examples/pod-gc-strategy.yaml) +- [`daemon-step.yaml`](../examples/daemon-step.yaml) -- [`status-reference.yaml`](../examples/status-reference.yaml) +- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) -- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) +- [`timeouts-workflow.yaml`](../examples/timeouts-workflow.yaml) -- [`templates.yaml`](../examples/workflow-template/templates.yaml) +- [`sidecar-nginx.yaml`](../examples/sidecar-nginx.yaml) -- [`loops-maps.yaml`](../examples/loops-maps.yaml) +- [`retry-container.yaml`](../examples/retry-container.yaml) ### Fields @@ -2174,15 +2175,15 @@ ResourceTemplate is a template subtype to manipulate kubernetes resources Examples with this field (click to open)
-- [`k8s-owner-reference.yaml`](../examples/k8s-owner-reference.yaml) +- [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) - [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) -- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) +- [`k8s-set-owner-reference.yaml`](../examples/k8s-set-owner-reference.yaml) -- [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) +- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) -- [`k8s-set-owner-reference.yaml`](../examples/k8s-set-owner-reference.yaml) +- [`k8s-owner-reference.yaml`](../examples/k8s-owner-reference.yaml) ### Fields @@ -2202,23 +2203,23 @@ RetryStrategy provides controls on how to retry a workflow step Examples with this field (click to open)
-- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) +- [`retry-on-error.yaml`](../examples/retry-on-error.yaml) -- [`retry-script.yaml`](../examples/retry-script.yaml) +- [`templates.yaml`](../examples/workflow-template/templates.yaml) -- [`retry-container.yaml`](../examples/retry-container.yaml) +- [`retry-script.yaml`](../examples/retry-script.yaml) -- [`templates.yaml`](../examples/workflow-template/templates.yaml) +- [`retry-with-steps.yaml`](../examples/retry-with-steps.yaml) - [`retry-backoff.yaml`](../examples/retry-backoff.yaml) -- [`retry-on-error.yaml`](../examples/retry-on-error.yaml) +- [`retry-container-to-completion.yaml`](../examples/retry-container-to-completion.yaml) -- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) +- [`retry-container.yaml`](../examples/retry-container.yaml) -- [`retry-with-steps.yaml`](../examples/retry-with-steps.yaml) +- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) -- [`retry-container-to-completion.yaml`](../examples/retry-container-to-completion.yaml) +- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) ### Fields @@ -2235,31 +2236,31 @@ ScriptTemplate is a template subtype to enable scripting through code steps Examples with this field (click to open)
-- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) - - [`scripts-python.yaml`](../examples/scripts-python.yaml) -- [`status-reference.yaml`](../examples/status-reference.yaml) - -- [`retry-script.yaml`](../examples/retry-script.yaml) - -- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) +- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) - [`coinflip.yaml`](../examples/coinflip.yaml) -- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) +- [`retry-script.yaml`](../examples/retry-script.yaml) + +- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) - [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) -- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) +- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) -- [`coinflip-recursive.yaml`](../examples/coinflip-recursive.yaml) +- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) - [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) -- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) +- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) -- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) +- [`status-reference.yaml`](../examples/status-reference.yaml) + +- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) + +- [`coinflip-recursive.yaml`](../examples/coinflip-recursive.yaml) ### Fields @@ -2275,113 +2276,113 @@ WorkflowStep is a reference to a template to execute in a series of step Examples with this field (click to open)
-- [`steps.yaml`](../examples/workflow-template/steps.yaml) +- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) -- [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) +- [`conditionals.yaml`](../examples/conditionals.yaml) -- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) +- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) -- [`ci.yaml`](../examples/ci.yaml) +- [`output-parameter.yaml`](../examples/output-parameter.yaml) -- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) +- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) -- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) +- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) -- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) +- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) -- [`scripts-python.yaml`](../examples/scripts-python.yaml) +- [`loops.yaml`](../examples/loops.yaml) -- [`parallelism-template-limit.yaml`](../examples/parallelism-template-limit.yaml) +- [`coinflip-recursive.yaml`](../examples/coinflip-recursive.yaml) -- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) +- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) -- [`loops.yaml`](../examples/loops.yaml) +- [`steps.yaml`](../examples/steps.yaml) -- [`coinflip.yaml`](../examples/coinflip.yaml) +- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) -- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) +- [`exit-handlers.yaml`](../examples/exit-handlers.yaml) -- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) +- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) -- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) +- [`templates.yaml`](../examples/workflow-template/templates.yaml) -- [`daemon-step.yaml`](../examples/daemon-step.yaml) +- [`global-outputs.yaml`](../examples/global-outputs.yaml) -- [`output-parameter.yaml`](../examples/output-parameter.yaml) +- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) -- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) +- [`ci.yaml`](../examples/ci.yaml) -- [`global-outputs.yaml`](../examples/global-outputs.yaml) +- [`parallelism-limit.yaml`](../examples/parallelism-limit.yaml) -- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) +- [`loops-maps.yaml`](../examples/loops-maps.yaml) -- [`exit-handlers.yaml`](../examples/exit-handlers.yaml) +- [`suspend-template.yaml`](../examples/suspend-template.yaml) -- [`retry-with-steps.yaml`](../examples/retry-with-steps.yaml) +- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) -- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) +- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) -- [`coinflip-recursive.yaml`](../examples/coinflip-recursive.yaml) +- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) -- [`template-on-exit.yaml`](../examples/template-on-exit.yaml) +- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) -- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) +- [`parallelism-template-limit.yaml`](../examples/parallelism-template-limit.yaml) -- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) +- [`coinflip.yaml`](../examples/coinflip.yaml) -- [`continue-on-fail.yaml`](../examples/continue-on-fail.yaml) +- [`retry-with-steps.yaml`](../examples/retry-with-steps.yaml) -- [`timeouts-workflow.yaml`](../examples/timeouts-workflow.yaml) +- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) -- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) +- [`template-on-exit.yaml`](../examples/template-on-exit.yaml) -- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) +- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) -- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) +- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) -- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) +- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) -- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) +- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) -- [`steps.yaml`](../examples/steps.yaml) +- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) -- [`parallelism-limit.yaml`](../examples/parallelism-limit.yaml) +- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) -- [`conditionals.yaml`](../examples/conditionals.yaml) +- [`daemon-step.yaml`](../examples/daemon-step.yaml) -- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) +- [`scripts-python.yaml`](../examples/scripts-python.yaml) -- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) +- [`retry-with-steps.yaml`](../examples/workflow-template/retry-with-steps.yaml) -- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) +- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) -- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) +- [`steps.yaml`](../examples/workflow-template/steps.yaml) -- [`suspend-template.yaml`](../examples/suspend-template.yaml) +- [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) - [`pod-gc-strategy.yaml`](../examples/pod-gc-strategy.yaml) -- [`status-reference.yaml`](../examples/status-reference.yaml) +- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) -- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) +- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) -- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) +- [`timeouts-workflow.yaml`](../examples/timeouts-workflow.yaml) - [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) -- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) +- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) -- [`templates.yaml`](../examples/workflow-template/templates.yaml) +- [`resubmit.yaml`](../examples/resubmit.yaml) -- [`retry-with-steps.yaml`](../examples/workflow-template/retry-with-steps.yaml) +- [`status-reference.yaml`](../examples/status-reference.yaml) -- [`resubmit.yaml`](../examples/resubmit.yaml) +- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) -- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) +- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) -- [`loops-maps.yaml`](../examples/loops-maps.yaml) +- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) -- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) +- [`continue-on-fail.yaml`](../examples/continue-on-fail.yaml) ### Fields @@ -2405,9 +2406,9 @@ SuspendTemplate is a template subtype to suspend a workflow at a predetermined p Examples with this field (click to open)
-- [`cron-workflow.yaml`](../examples/cron-workflow.yaml) - - [`suspend-template.yaml`](../examples/suspend-template.yaml) + +- [`cron-workflow.yaml`](../examples/cron-workflow.yaml) ### Fields @@ -2422,17 +2423,17 @@ TemplateRef is a reference of template resource. Examples with this field (click to open)
-- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) +- [`steps.yaml`](../examples/workflow-template/steps.yaml) -- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) +- [`retry-with-steps.yaml`](../examples/workflow-template/retry-with-steps.yaml) - [`templates.yaml`](../examples/workflow-template/templates.yaml) -- [`steps.yaml`](../examples/workflow-template/steps.yaml) - - [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) -- [`retry-with-steps.yaml`](../examples/workflow-template/retry-with-steps.yaml) +- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) + +- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) - [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) @@ -2472,29 +2473,29 @@ ValueFrom describes a location in which to obtain the value to a parameter Examples with this field (click to open)
-- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) - -- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) - -- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) +- [`global-outputs.yaml`](../examples/global-outputs.yaml) - [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) -- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) +- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) + +- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) - [`output-parameter.yaml`](../examples/output-parameter.yaml) -- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) +- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) -- [`secrets.yaml`](../examples/secrets.yaml) +- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) -- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) +- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) -- [`global-outputs.yaml`](../examples/global-outputs.yaml) +- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) + +- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) -- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) +- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) -- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) +- [`secrets.yaml`](../examples/secrets.yaml) ### Fields @@ -2560,11 +2561,11 @@ MetricLabel is a single label for a prometheus metric Examples with this field (click to open)
+- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) + - [`custom-metrics.yaml`](../examples/custom-metrics.yaml) - [`forever.yaml`](../examples/forever.yaml) - -- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) ### Fields @@ -2612,10 +2613,10 @@ GitArtifact is the location of an git artifact Examples with this field (click to open)
-- [`ci.yaml`](../examples/ci.yaml) - - [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) +- [`ci.yaml`](../examples/ci.yaml) + - [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) - [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) @@ -2657,23 +2658,23 @@ HTTPArtifact allows an file served on HTTP to be placed as an input artifact in Examples with this field (click to open)
-- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) +- [`daemon-step.yaml`](../examples/daemon-step.yaml) -- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) +- [`input-artifact-oss.yaml`](../examples/input-artifact-oss.yaml) + +- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) - [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) - [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) -- [`daemon-step.yaml`](../examples/daemon-step.yaml) +- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) - [`sidecar.yaml`](../examples/sidecar.yaml) - [`sidecar-nginx.yaml`](../examples/sidecar-nginx.yaml) -- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) - -- [`input-artifact-oss.yaml`](../examples/input-artifact-oss.yaml) +- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) - [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) @@ -2733,41 +2734,41 @@ DAGTask represents a node in the graph during DAG execution Examples with this field (click to open)
-- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) - -- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) +- [`dag.yaml`](../examples/workflow-template/dag.yaml) -- [`dag-continue-on-fail.yaml`](../examples/dag-continue-on-fail.yaml) +- [`templates.yaml`](../examples/workflow-template/templates.yaml) - [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) -- [`loops-dag.yaml`](../examples/loops-dag.yaml) +- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) -- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) +- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) -- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) +- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) -- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) +- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) -- [`templates.yaml`](../examples/workflow-template/templates.yaml) +- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) + +- [`dag-continue-on-fail.yaml`](../examples/dag-continue-on-fail.yaml) - [`dag-targets.yaml`](../examples/dag-targets.yaml) -- [`resubmit.yaml`](../examples/resubmit.yaml) +- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) -- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) +- [`resubmit.yaml`](../examples/resubmit.yaml) -- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) +- [`loops-dag.yaml`](../examples/loops-dag.yaml) -- [`dag-nested.yaml`](../examples/dag-nested.yaml) +- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) -- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) +- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) -- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) +- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) -- [`dag.yaml`](../examples/workflow-template/dag.yaml) +- [`dag-nested.yaml`](../examples/dag-nested.yaml) -- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) +- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) ### Fields @@ -2809,49 +2810,49 @@ ContinueOn defines if a workflow should continue even if a task or step fails/er Examples with this field (click to open)
+- [`continue-on-fail.yaml`](../examples/continue-on-fail.yaml) + - [`dag-continue-on-fail.yaml`](../examples/dag-continue-on-fail.yaml) - [`status-reference.yaml`](../examples/status-reference.yaml) - -- [`continue-on-fail.yaml`](../examples/continue-on-fail.yaml) ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`error`|`boolean`|+optional| -|`failed`|`boolean`|+optional| +|`error`|`boolean`|| +|`failed`|`boolean`|| ## Item -_No description available_ +
Examples with this field (click to open)
-- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) +- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) - [`parallelism-template-limit.yaml`](../examples/parallelism-template-limit.yaml) -- [`timeouts-workflow.yaml`](../examples/timeouts-workflow.yaml) +- [`ci.yaml`](../examples/ci.yaml) -- [`loops.yaml`](../examples/loops.yaml) +- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) -- [`loops-dag.yaml`](../examples/loops-dag.yaml) +- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) -- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) +- [`parallelism-limit.yaml`](../examples/parallelism-limit.yaml) -- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) +- [`timeouts-workflow.yaml`](../examples/timeouts-workflow.yaml) -- [`ci.yaml`](../examples/ci.yaml) +- [`loops-maps.yaml`](../examples/loops-maps.yaml) -- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) +- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) -- [`parallelism-limit.yaml`](../examples/parallelism-limit.yaml) +- [`loops.yaml`](../examples/loops.yaml) -- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) +- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) -- [`loops-maps.yaml`](../examples/loops-maps.yaml) +- [`loops-dag.yaml`](../examples/loops-dag.yaml)
### Fields @@ -2970,7 +2971,7 @@ S3Bucket contains the access information required for interfacing with an S3 buc ## ItemValue -_No description available_ + ### Fields | Field Name | Field Type | Description | @@ -3006,238 +3007,238 @@ ObjectMeta is metadata that all persisted resources must have, which includes al Examples with this field (click to open)
-- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) +- [`dns-config.yaml`](../examples/dns-config.yaml) -- [`cron-workflow.yaml`](../examples/cron-workflow.yaml) +- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) -- [`testvolume.yaml`](../examples/testvolume.yaml) +- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) -- [`default-pdb-support.yaml`](../examples/default-pdb-support.yaml) +- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) -- [`loops.yaml`](../examples/loops.yaml) +- [`pod-spec-patch.yaml`](../examples/pod-spec-patch.yaml) -- [`retry-container.yaml`](../examples/retry-container.yaml) +- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) -- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) +- [`loops.yaml`](../examples/loops.yaml) -- [`retry-on-error.yaml`](../examples/retry-on-error.yaml) +- [`coinflip-recursive.yaml`](../examples/coinflip-recursive.yaml) -- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) +- [`secrets.yaml`](../examples/secrets.yaml) -- [`coinflip-recursive.yaml`](../examples/coinflip-recursive.yaml) +- [`dag-nested.yaml`](../examples/dag-nested.yaml) -- [`continue-on-fail.yaml`](../examples/continue-on-fail.yaml) +- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) -- [`input-artifact-s3.yaml`](../examples/input-artifact-s3.yaml) +- [`parallelism-limit.yaml`](../examples/parallelism-limit.yaml) -- [`steps.yaml`](../examples/steps.yaml) +- [`suspend-template.yaml`](../examples/suspend-template.yaml) -- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) +- [`loops-dag.yaml`](../examples/loops-dag.yaml) -- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) +- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) -- [`suspend-template.yaml`](../examples/suspend-template.yaml) +- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) -- [`volumes-emptydir.yaml`](../examples/volumes-emptydir.yaml) +- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) -- [`timeouts-step.yaml`](../examples/timeouts-step.yaml) +- [`archive-location.yaml`](../examples/archive-location.yaml) -- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) +- [`parallelism-template-limit.yaml`](../examples/parallelism-template-limit.yaml) -- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) +- [`coinflip.yaml`](../examples/coinflip.yaml) -- [`retry-with-steps.yaml`](../examples/workflow-template/retry-with-steps.yaml) +- [`retry-backoff.yaml`](../examples/retry-backoff.yaml) -- [`archive-location.yaml`](../examples/archive-location.yaml) +- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) -- [`ci.yaml`](../examples/ci.yaml) +- [`steps.yaml`](../examples/workflow-template/steps.yaml) -- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) +- [`retry-with-steps.yaml`](../examples/workflow-template/retry-with-steps.yaml) -- [`sidecar-dind.yaml`](../examples/sidecar-dind.yaml) +- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) -- [`input-artifact-gcs.yaml`](../examples/input-artifact-gcs.yaml) +- [`retry-container-to-completion.yaml`](../examples/retry-container-to-completion.yaml) -- [`scripts-python.yaml`](../examples/scripts-python.yaml) +- [`status-reference.yaml`](../examples/status-reference.yaml) -- [`parallelism-template-limit.yaml`](../examples/parallelism-template-limit.yaml) +- [`retry-script.yaml`](../examples/retry-script.yaml) -- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) +- [`sidecar-dind.yaml`](../examples/sidecar-dind.yaml) -- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) +- [`conditionals.yaml`](../examples/conditionals.yaml) -- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) +- [`output-parameter.yaml`](../examples/output-parameter.yaml) -- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) +- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) -- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) +- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) - [`dag-continue-on-fail.yaml`](../examples/dag-continue-on-fail.yaml) -- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) +- [`loops-maps.yaml`](../examples/loops-maps.yaml) -- [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) +- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) -- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) +- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) -- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) +- [`dag-targets.yaml`](../examples/dag-targets.yaml) -- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) +- [`testvolume.yaml`](../examples/testvolume.yaml) -- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) +- [`scripts-python.yaml`](../examples/scripts-python.yaml) -- [`retry-backoff.yaml`](../examples/retry-backoff.yaml) +- [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) -- [`dag-targets.yaml`](../examples/dag-targets.yaml) +- [`forever.yaml`](../examples/forever.yaml) -- [`resubmit.yaml`](../examples/resubmit.yaml) +- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) -- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) +- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) -- [`image-pull-secrets.yaml`](../examples/image-pull-secrets.yaml) +- [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) -- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) +- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) -- [`steps.yaml`](../examples/workflow-template/steps.yaml) +- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) -- [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) +- [`input-artifact-s3.yaml`](../examples/input-artifact-s3.yaml) -- [`dag-nested.yaml`](../examples/dag-nested.yaml) +- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) -- [`pod-spec-patch.yaml`](../examples/pod-spec-patch.yaml) +- [`default-pdb-support.yaml`](../examples/default-pdb-support.yaml) -- [`hello-world.yaml`](../examples/hello-world.yaml) +- [`continue-on-fail.yaml`](../examples/continue-on-fail.yaml) -- [`coinflip.yaml`](../examples/coinflip.yaml) +- [`timeouts-step.yaml`](../examples/timeouts-step.yaml) -- [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) +- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) -- [`loops-dag.yaml`](../examples/loops-dag.yaml) +- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) -- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) +- [`image-pull-secrets.yaml`](../examples/image-pull-secrets.yaml) -- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) +- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) -- [`daemon-step.yaml`](../examples/daemon-step.yaml) +- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) -- [`k8s-set-owner-reference.yaml`](../examples/k8s-set-owner-reference.yaml) +- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) -- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) +- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) -- [`exit-handlers.yaml`](../examples/exit-handlers.yaml) +- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) -- [`retry-with-steps.yaml`](../examples/retry-with-steps.yaml) +- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) -- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) +- [`k8s-set-owner-reference.yaml`](../examples/k8s-set-owner-reference.yaml) -- [`global-parameters.yaml`](../examples/global-parameters.yaml) +- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) -- [`k8s-owner-reference.yaml`](../examples/k8s-owner-reference.yaml) +- [`global-parameters.yaml`](../examples/global-parameters.yaml) -- [`timeouts-workflow.yaml`](../examples/timeouts-workflow.yaml) +- [`cron-workflow.yaml`](../examples/cron-workflow.yaml) -- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) +- [`hello-world.yaml`](../examples/hello-world.yaml) -- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) +- [`input-artifact-gcs.yaml`](../examples/input-artifact-gcs.yaml) -- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) +- [`init-container.yaml`](../examples/init-container.yaml) -- [`sidecar-nginx.yaml`](../examples/sidecar-nginx.yaml) +- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) -- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) +- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) -- [`input-artifact-oss.yaml`](../examples/input-artifact-oss.yaml) +- [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) -- [`retry-container-to-completion.yaml`](../examples/retry-container-to-completion.yaml) +- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) -- [`dag.yaml`](../examples/workflow-template/dag.yaml) +- [`gc-ttl.yaml`](../examples/gc-ttl.yaml) -- [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) +- [`pod-gc-strategy.yaml`](../examples/pod-gc-strategy.yaml) - [`node-selector.yaml`](../examples/node-selector.yaml) -- [`dns-config.yaml`](../examples/dns-config.yaml) +- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) -- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) +- [`resubmit.yaml`](../examples/resubmit.yaml) -- [`gc-ttl.yaml`](../examples/gc-ttl.yaml) +- [`k8s-owner-reference.yaml`](../examples/k8s-owner-reference.yaml) -- [`sidecar.yaml`](../examples/sidecar.yaml) +- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) -- [`secrets.yaml`](../examples/secrets.yaml) +- [`volumes-emptydir.yaml`](../examples/volumes-emptydir.yaml) -- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) +- [`steps.yaml`](../examples/steps.yaml) -- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) +- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) -- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) +- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) -- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) +- [`dag.yaml`](../examples/workflow-template/dag.yaml) -- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) +- [`exit-handlers.yaml`](../examples/exit-handlers.yaml) -- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) +- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) -- [`init-container.yaml`](../examples/init-container.yaml) +- [`templates.yaml`](../examples/workflow-template/templates.yaml) -- [`retry-script.yaml`](../examples/retry-script.yaml) +- [`global-outputs.yaml`](../examples/global-outputs.yaml) -- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) +- [`input-artifact-oss.yaml`](../examples/input-artifact-oss.yaml) -- [`output-parameter.yaml`](../examples/output-parameter.yaml) +- [`ci.yaml`](../examples/ci.yaml) -- [`global-outputs.yaml`](../examples/global-outputs.yaml) +- [`sidecar.yaml`](../examples/sidecar.yaml) -- [`template-on-exit.yaml`](../examples/template-on-exit.yaml) +- [`retry-on-error.yaml`](../examples/retry-on-error.yaml) -- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) +- [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) -- [`forever.yaml`](../examples/forever.yaml) +- [`retry-with-steps.yaml`](../examples/retry-with-steps.yaml) -- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) +- [`template-on-exit.yaml`](../examples/template-on-exit.yaml) -- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) +- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) -- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) +- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) -- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) +- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) -- [`parallelism-limit.yaml`](../examples/parallelism-limit.yaml) +- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) -- [`conditionals.yaml`](../examples/conditionals.yaml) +- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) -- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) +- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) -- [`pod-gc-strategy.yaml`](../examples/pod-gc-strategy.yaml) +- [`daemon-step.yaml`](../examples/daemon-step.yaml) -- [`status-reference.yaml`](../examples/status-reference.yaml) +- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) -- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) +- [`timeouts-workflow.yaml`](../examples/timeouts-workflow.yaml) -- [`templates.yaml`](../examples/workflow-template/templates.yaml) +- [`sidecar-nginx.yaml`](../examples/sidecar-nginx.yaml) -- [`loops-maps.yaml`](../examples/loops-maps.yaml) +- [`retry-container.yaml`](../examples/retry-container.yaml) ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`annotations`|`Map< string , string >`|Annotations is an unstructured key value map stored with a resource that may beset by external tools to store and retrieve arbitrary metadata. They are notqueryable and should be preserved when modifying objects.More info: http://kubernetes.io/docs/user-guide/annotations+optional| -|`clusterName`|`string`|The name of the cluster which the object belongs to.This is used to distinguish resources with same name and namespace in different clusters.This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.+optional| -|`creationTimestamp`|[`Time`](#time)|CreationTimestamp is a timestamp representing the server time when this object wascreated. It is not guaranteed to be set in happens-before order across separate operations.Clients may not set this value. It is represented in RFC3339 form and is in UTC.Populated by the system.Read-only.Null for lists.More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata+optional| -|`deletionGracePeriodSeconds`|`int64`|Number of seconds allowed for this object to gracefully terminate beforeit will be removed from the system. Only set when deletionTimestamp is also set.May only be shortened.Read-only.+optional| -|`deletionTimestamp`|[`Time`](#time)|DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. Thisfield is set by the server when a graceful deletion is requested by the user, and is notdirectly settable by a client. The resource is expected to be deleted (no longer visiblefrom resource lists, and not reachable by name) after the time in this field, once thefinalizers list is empty. As long as the finalizers list contains items, deletion is blocked.Once the deletionTimestamp is set, this value may not be unset or be set further into thefuture, although it may be shortened or the resource may be deleted prior to this time.For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will reactby sending a graceful termination signal to the containers in the pod. After that 30 seconds,the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,remove the pod from the API. In the presence of network partitions, this object may stillexist after this timestamp, until an administrator or automated process can determine theresource is fully terminated.If not set, graceful deletion of the object has not been requested.Populated by the system when a graceful deletion is requested.Read-only.More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata+optional| -|`finalizers`|`Array< string >`|Must be empty before the object is deleted from the registry. Each entryis an identifier for the responsible component that will remove the entryfrom the list. If the deletionTimestamp of the object is non-nil, entriesin this list can only be removed.+optional| -|`generateName`|`string`|GenerateName is an optional prefix, used by the server, to generate a uniquename ONLY IF the Name field has not been provided.If this field is used, the name returned to the client will be differentthan the name passed. This value will also be combined with a unique suffix.The provided value has the same validation rules as the Name field,and may be truncated by the length of the suffix required to make the valueunique on the server.If this field is specified and the generated name exists, the server willNOT return a 409 - instead, it will either return 201 Created or 500 with ReasonServerTimeout indicating a unique name could not be found in the time allotted, and the clientshould retry (optionally after the time indicated in the Retry-After header).Applied only if Name is not specified.More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency+optional| -|`generation`|`int64`|A sequence number representing a specific generation of the desired state.Populated by the system. Read-only.+optional| -|`labels`|`Map< string , string >`|Map of string keys and values that can be used to organize and categorize(scope and select) objects. May match selectors of replication controllersand services.More info: http://kubernetes.io/docs/user-guide/labels+optional| -|`managedFields`|`Array<`[`ManagedFieldsEntry`](#managedfieldsentry)`>`|ManagedFields maps workflow-id and version to the set of fieldsthat are managed by that io.argoproj.workflow.v1alpha1. This is mostly for internalhousekeeping, and users typically shouldn't need to set orunderstand this field. A workflow can be the user's name, acontroller's name, or the name of a specific apply path like"ci-cd". The set of fields is always in the version that theworkflow used when modifying the object.+optional| -|`name`|`string`|Name must be unique within a namespace. Is required when creating resources, althoughsome resources may allow a client to request the generation of an appropriate nameautomatically. Name is primarily intended for creation idempotence and configurationdefinition.Cannot be updated.More info: http://kubernetes.io/docs/user-guide/identifiers#names+optional| -|`namespace`|`string`|Namespace defines the space within each name must be unique. An empty namespace isequivalent to the "default" namespace, but "default" is the canonical representation.Not all objects are required to be scoped to a namespace - the value of this field forthose objects will be empty.Must be a DNS_LABEL.Cannot be updated.More info: http://kubernetes.io/docs/user-guide/namespaces+optional| -|`ownerReferences`|`Array<`[`OwnerReference`](#ownerreference)`>`|List of objects depended by this object. If ALL objects in the list havebeen deleted, this object will be garbage collected. If this object is managed by a controller,then an entry in this list will point to this controller, with the controller field set to true.There cannot be more than one managing controller.+optional| -|`resourceVersion`|`string`|An opaque value that represents the internal version of this object that canbe used by clients to determine when objects have changed. May be used for optimisticconcurrency, change detection, and the watch operation on a resource or set of resources.Clients must treat these values as opaque and passed unmodified back to the server.They may only be valid for a particular resource or set of resources.Populated by the system.Read-only.Value must be treated as opaque by clients and .More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency+optional| -|~`selfLink`~|~`string`~|~SelfLink is a URL representing this object.Populated by the system.Read-only.~ DEPRECATEDKubernetes will stop propagating this field in 1.20 release and the field is plannedto be removed in 1.21 release.+optional| -|`uid`|`string`|UID is the unique in time and space value for this object. It is typically generated bythe server on successful creation of a resource and is not allowed to change on PUToperations.Populated by the system.Read-only.More info: http://kubernetes.io/docs/user-guide/identifiers#uids+optional| +|`annotations`|`Map< string , string >`|Annotations is an unstructured key value map stored with a resource that may beset by external tools to store and retrieve arbitrary metadata. They are notqueryable and should be preserved when modifying objects.More info: http://kubernetes.io/docs/user-guide/annotations| +|`clusterName`|`string`|The name of the cluster which the object belongs to.This is used to distinguish resources with same name and namespace in different clusters.This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.| +|`creationTimestamp`|[`Time`](#time)|CreationTimestamp is a timestamp representing the server time when this object wascreated. It is not guaranteed to be set in happens-before order across separate operations.Clients may not set this value. It is represented in RFC3339 form and is in UTC.Populated by the system.Read-only.Null for lists.More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata| +|`deletionGracePeriodSeconds`|`int64`|Number of seconds allowed for this object to gracefully terminate beforeit will be removed from the system. Only set when deletionTimestamp is also set.May only be shortened.Read-only.| +|`deletionTimestamp`|[`Time`](#time)|DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. Thisfield is set by the server when a graceful deletion is requested by the user, and is notdirectly settable by a client. The resource is expected to be deleted (no longer visiblefrom resource lists, and not reachable by name) after the time in this field, once thefinalizers list is empty. As long as the finalizers list contains items, deletion is blocked.Once the deletionTimestamp is set, this value may not be unset or be set further into thefuture, although it may be shortened or the resource may be deleted prior to this time.For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will reactby sending a graceful termination signal to the containers in the pod. After that 30 seconds,the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,remove the pod from the API. In the presence of network partitions, this object may stillexist after this timestamp, until an administrator or automated process can determine theresource is fully terminated.If not set, graceful deletion of the object has not been requested.Populated by the system when a graceful deletion is requested.Read-only.More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata| +|`finalizers`|`Array< string >`|Must be empty before the object is deleted from the registry. Each entryis an identifier for the responsible component that will remove the entryfrom the list. If the deletionTimestamp of the object is non-nil, entriesin this list can only be removed.| +|`generateName`|`string`|GenerateName is an optional prefix, used by the server, to generate a uniquename ONLY IF the Name field has not been provided.If this field is used, the name returned to the client will be differentthan the name passed. This value will also be combined with a unique suffix.The provided value has the same validation rules as the Name field,and may be truncated by the length of the suffix required to make the valueunique on the server.If this field is specified and the generated name exists, the server willNOT return a 409 - instead, it will either return 201 Created or 500 with ReasonServerTimeout indicating a unique name could not be found in the time allotted, and the clientshould retry (optionally after the time indicated in the Retry-After header).Applied only if Name is not specified.More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency| +|`generation`|`int64`|A sequence number representing a specific generation of the desired state.Populated by the system. Read-only.| +|`labels`|`Map< string , string >`|Map of string keys and values that can be used to organize and categorize(scope and select) objects. May match selectors of replication controllersand services.More info: http://kubernetes.io/docs/user-guide/labels| +|`managedFields`|`Array<`[`ManagedFieldsEntry`](#managedfieldsentry)`>`|ManagedFields maps workflow-id and version to the set of fieldsthat are managed by that io.argoproj.workflow.v1alpha1. This is mostly for internalhousekeeping, and users typically shouldn't need to set orunderstand this field. A workflow can be the user's name, acontroller's name, or the name of a specific apply path like"ci-cd". The set of fields is always in the version that theworkflow used when modifying the object.| +|`name`|`string`|Name must be unique within a namespace. Is required when creating resources, althoughsome resources may allow a client to request the generation of an appropriate nameautomatically. Name is primarily intended for creation idempotence and configurationdefinition.Cannot be updated.More info: http://kubernetes.io/docs/user-guide/identifiers#names| +|`namespace`|`string`|Namespace defines the space within each name must be unique. An empty namespace isequivalent to the "default" namespace, but "default" is the canonical representation.Not all objects are required to be scoped to a namespace - the value of this field forthose objects will be empty.Must be a DNS_LABEL.Cannot be updated.More info: http://kubernetes.io/docs/user-guide/namespaces| +|`ownerReferences`|`Array<`[`OwnerReference`](#ownerreference)`>`|List of objects depended by this object. If ALL objects in the list havebeen deleted, this object will be garbage collected. If this object is managed by a controller,then an entry in this list will point to this controller, with the controller field set to true.There cannot be more than one managing controller.| +|`resourceVersion`|`string`|An opaque value that represents the internal version of this object that canbe used by clients to determine when objects have changed. May be used for optimisticconcurrency, change detection, and the watch operation on a resource or set of resources.Clients must treat these values as opaque and passed unmodified back to the server.They may only be valid for a particular resource or set of resources.Populated by the system.Read-only.Value must be treated as opaque by clients and .More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency| +|~`selfLink`~|~`string`~|~SelfLink is a URL representing this object.Populated by the system.Read-only.~ DEPRECATEDKubernetes will stop propagating this field in 1.20 release and the field is plannedto be removed in 1.21 release.| +|`uid`|`string`|UID is the unique in time and space value for this object. It is typically generated bythe server on successful creation of a resource and is not allowed to change on PUToperations.Populated by the system.Read-only.More info: http://kubernetes.io/docs/user-guide/identifiers#uids| ## Affinity @@ -3246,9 +3247,9 @@ Affinity is a group of affinity scheduling rules. ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`nodeAffinity`|[`NodeAffinity`](#nodeaffinity)|Describes node affinity scheduling rules for the pod.+optional| -|`podAffinity`|[`PodAffinity`](#podaffinity)|Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).+optional| -|`podAntiAffinity`|[`PodAntiAffinity`](#podantiaffinity)|Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).+optional| +|`nodeAffinity`|[`NodeAffinity`](#nodeaffinity)|Describes node affinity scheduling rules for the pod.| +|`podAffinity`|[`PodAffinity`](#podaffinity)|Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).| +|`podAntiAffinity`|[`PodAntiAffinity`](#podantiaffinity)|Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).| ## PodDNSConfig @@ -3263,9 +3264,9 @@ PodDNSConfig defines the DNS parameters of a pod in addition tothose generated f ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`nameservers`|`Array< string >`|A list of DNS name server IP addresses.This will be appended to the base nameservers generated from DNSPolicy.Duplicated nameservers will be removed.+optional| -|`options`|`Array<`[`PodDNSConfigOption`](#poddnsconfigoption)`>`|A list of DNS resolver options.This will be merged with the base options generated from DNSPolicy.Duplicated entries will be removed. Resolution options given in Optionswill override those that appear in the base DNSPolicy.+optional| -|`searches`|`Array< string >`|A list of DNS search domains for host-name lookup.This will be appended to the base search paths generated from DNSPolicy.Duplicated search paths will be removed.+optional| +|`nameservers`|`Array< string >`|A list of DNS name server IP addresses.This will be appended to the base nameservers generated from DNSPolicy.Duplicated nameservers will be removed.| +|`options`|`Array<`[`PodDNSConfigOption`](#poddnsconfigoption)`>`|A list of DNS resolver options.This will be merged with the base options generated from DNSPolicy.Duplicated entries will be removed. Resolution options given in Optionswill override those that appear in the base DNSPolicy.| +|`searches`|`Array< string >`|A list of DNS search domains for host-name lookup.This will be appended to the base search paths generated from DNSPolicy.Duplicated search paths will be removed.| ## HostAlias @@ -3290,7 +3291,7 @@ LocalObjectReference contains enough information to let you locate thereferenced ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`name`|`string`|Name of the referent.More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#namesTODO: Add other useful fields. apiVersion, kind, uid?+optional| +|`name`|`string`|Name of the referent.More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#namesTODO: Add other useful fields. apiVersion, kind, uid?| ## PodDisruptionBudgetSpec @@ -3299,9 +3300,9 @@ PodDisruptionBudgetSpec is a description of a PodDisruptionBudget. ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`maxUnavailable`|[`IntOrString`](#intorstring)|An eviction is allowed if at most "maxUnavailable" pods selected by"selector" are unavailable after the eviction, i.e. even in absence ofthe evicted pod. For example, one can prevent all voluntary evictionsby specifying 0. This is a mutually exclusive setting with "minAvailable".+optional| -|`minAvailable`|[`IntOrString`](#intorstring)|An eviction is allowed if at least "minAvailable" pods selected by"selector" will still be available after the eviction, i.e. even in theabsence of the evicted pod. So for example you can prevent all voluntaryevictions by specifying "100%".+optional| -|`selector`|[`LabelSelector`](#labelselector)|Label query over pods whose evictions are managed by the disruptionbudget.+optional| +|`maxUnavailable`|[`IntOrString`](#intorstring)|An eviction is allowed if at most "maxUnavailable" pods selected by"selector" are unavailable after the eviction, i.e. even in absence ofthe evicted pod. For example, one can prevent all voluntary evictionsby specifying 0. This is a mutually exclusive setting with "minAvailable".| +|`minAvailable`|[`IntOrString`](#intorstring)|An eviction is allowed if at least "minAvailable" pods selected by"selector" will still be available after the eviction, i.e. even in theabsence of the evicted pod. So for example you can prevent all voluntaryevictions by specifying "100%".| +|`selector`|[`LabelSelector`](#labelselector)|Label query over pods whose evictions are managed by the disruptionbudget.| ## PodSecurityContext @@ -3316,14 +3317,14 @@ PodSecurityContext holds pod-level security attributes and common container sett ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`fsGroup`|`int64`|1. The owning GID will be the FSGroup2. The setgid bit is set (new files created in the volume will be owned by FSGroup)3. The permission bits are OR'd with rw-rw----If unset, the Kubelet will not modify the ownership and permissions of any volume.+optional| -|`runAsGroup`|`int64`|The GID to run the entrypoint of the container process.Uses runtime default if unset.May also be set in SecurityContext. If set in both SecurityContext andPodSecurityContext, the value specified in SecurityContext takes precedencefor that container.+optional| -|`runAsNonRoot`|`boolean`|Indicates that the container must run as a non-root user.If true, the Kubelet will validate the image at runtime to ensure that itdoes not run as UID 0 (root) and fail to start the container if it does.If unset or false, no such validation will be performed.May also be set in SecurityContext. If set in both SecurityContext andPodSecurityContext, the value specified in SecurityContext takes precedence.+optional| -|`runAsUser`|`int64`|The UID to run the entrypoint of the container process.Defaults to user specified in image metadata if unspecified.May also be set in SecurityContext. If set in both SecurityContext andPodSecurityContext, the value specified in SecurityContext takes precedencefor that container.+optional| -|`seLinuxOptions`|[`SELinuxOptions`](#selinuxoptions)|The SELinux context to be applied to all containers.If unspecified, the container runtime will allocate a random SELinux context for eachcontainer. May also be set in SecurityContext. If set inboth SecurityContext and PodSecurityContext, the value specified in SecurityContexttakes precedence for that container.+optional| -|`supplementalGroups`|`Array< string >`|A list of groups applied to the first process run in each container, in additionto the container's primary GID. If unspecified, no groups will be added toany container.+optional| -|`sysctls`|`Array<`[`Sysctl`](#sysctl)`>`|Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupportedsysctls (by the container runtime) might fail to launch.+optional| -|`windowsOptions`|[`WindowsSecurityContextOptions`](#windowssecuritycontextoptions)|The Windows specific settings applied to all containers.If unspecified, the options within a container's SecurityContext will be used.If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.+optional| +|`fsGroup`|`int64`|1. The owning GID will be the FSGroup2. The setgid bit is set (new files created in the volume will be owned by FSGroup)3. The permission bits are OR'd with rw-rw----If unset, the Kubelet will not modify the ownership and permissions of any volume.| +|`runAsGroup`|`int64`|The GID to run the entrypoint of the container process.Uses runtime default if unset.May also be set in SecurityContext. If set in both SecurityContext andPodSecurityContext, the value specified in SecurityContext takes precedencefor that container.| +|`runAsNonRoot`|`boolean`|Indicates that the container must run as a non-root user.If true, the Kubelet will validate the image at runtime to ensure that itdoes not run as UID 0 (root) and fail to start the container if it does.If unset or false, no such validation will be performed.May also be set in SecurityContext. If set in both SecurityContext andPodSecurityContext, the value specified in SecurityContext takes precedence.| +|`runAsUser`|`int64`|The UID to run the entrypoint of the container process.Defaults to user specified in image metadata if unspecified.May also be set in SecurityContext. If set in both SecurityContext andPodSecurityContext, the value specified in SecurityContext takes precedencefor that container.| +|`seLinuxOptions`|[`SELinuxOptions`](#selinuxoptions)|The SELinux context to be applied to all containers.If unspecified, the container runtime will allocate a random SELinux context for eachcontainer. May also be set in SecurityContext. If set inboth SecurityContext and PodSecurityContext, the value specified in SecurityContexttakes precedence for that container.| +|`supplementalGroups`|`Array< string >`|A list of groups applied to the first process run in each container, in additionto the container's primary GID. If unspecified, no groups will be added toany container.| +|`sysctls`|`Array<`[`Sysctl`](#sysctl)`>`|Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupportedsysctls (by the container runtime) might fail to launch.| +|`windowsOptions`|[`WindowsSecurityContextOptions`](#windowssecuritycontextoptions)|The Windows specific settings applied to all containers.If unspecified, the options within a container's SecurityContext will be used.If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.| ## Toleration @@ -3332,11 +3333,11 @@ The pod this Toleration is attached to tolerates any taint that matchesthe tripl ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`effect`|`string`|Effect indicates the taint effect to match. Empty means match all taint effects.When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.+optional| -|`key`|`string`|Key is the taint key that the toleration applies to. Empty means match all taint keys.If the key is empty, operator must be Exists; this combination means to match all values and all keys.+optional| -|`operator`|`string`|Operator represents a key's relationship to the value.Valid operators are Exists and Equal. Defaults to Equal.Exists is equivalent to wildcard for value, so that a pod cantolerate all taints of a particular category.+optional| -|`tolerationSeconds`|`int64`|TolerationSeconds represents the period of time the toleration (which must beof effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,it is not set, which means tolerate the taint forever (do not evict). Zero andnegative values will be treated as 0 (evict immediately) by the system.+optional| -|`value`|`string`|Value is the taint value the toleration matches to.If the operator is Exists, the value should be empty, otherwise just a regular string.+optional| +|`effect`|`string`|Effect indicates the taint effect to match. Empty means match all taint effects.When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.| +|`key`|`string`|Key is the taint key that the toleration applies to. Empty means match all taint keys.If the key is empty, operator must be Exists; this combination means to match all values and all keys.| +|`operator`|`string`|Operator represents a key's relationship to the value.Valid operators are Exists and Equal. Defaults to Equal.Exists is equivalent to wildcard for value, so that a pod cantolerate all taints of a particular category.| +|`tolerationSeconds`|`int64`|TolerationSeconds represents the period of time the toleration (which must beof effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,it is not set, which means tolerate the taint forever (do not evict). Zero andnegative values will be treated as 0 (evict immediately) by the system.| +|`value`|`string`|Value is the taint value the toleration matches to.If the operator is Exists, the value should be empty, otherwise just a regular string.| ## PersistentVolumeClaim @@ -3351,21 +3352,21 @@ PersistentVolumeClaim is a user's request for and claim to a persistent volume Examples with this field (click to open)
-- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) - - [`ci.yaml`](../examples/ci.yaml) +- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) + - [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) -- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) +- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`metadata`|[`ObjectMeta`](#objectmeta)|Standard object's metadata.More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata+optional| -|`spec`|[`PersistentVolumeClaimSpec`](#persistentvolumeclaimspec)|Spec defines the desired characteristics of a volume requested by a pod author.More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims+optional| -|`status`|[`PersistentVolumeClaimStatus`](#persistentvolumeclaimstatus)|Status represents the current information/status of a persistent volume claim.Read-only.More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims+optional| +|`metadata`|[`ObjectMeta`](#objectmeta)|Standard object's metadata.More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata| +|`spec`|[`PersistentVolumeClaimSpec`](#persistentvolumeclaimspec)|Spec defines the desired characteristics of a volume requested by a pod author.More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims| +|`status`|[`PersistentVolumeClaimStatus`](#persistentvolumeclaimstatus)|Status represents the current information/status of a persistent volume claim.Read-only.More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims| ## Volume @@ -3374,13 +3375,13 @@ Volume represents a named volume in a pod that may be accessed by any container Examples with this field (click to open)
-- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) - -- [`secrets.yaml`](../examples/secrets.yaml) - - [`volumes-emptydir.yaml`](../examples/volumes-emptydir.yaml) +- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) + - [`init-container.yaml`](../examples/init-container.yaml) + +- [`secrets.yaml`](../examples/secrets.yaml) ### Fields @@ -3406,13 +3407,13 @@ ObjectReference contains enough information to let you inspect or modify the ref ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`apiVersion`|`string`|API version of the referent.+optional| -|`fieldPath`|`string`|If referring to a piece of an object instead of an entire object, this stringshould contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].For example, if the object reference is to a container within a pod, this would take on a value like:"spec.containers{name}" (where "name" refers to the name of the container that triggeredthe event) or if no container name is specified "spec.containers[2]" (container withindex 2 in this pod). This syntax is chosen only to have some well-defined way ofreferencing a part of an object.TODO: this design is not final and this field is subject to change in the future.+optional| -|`kind`|`string`|Kind of the referent.More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds+optional| -|`name`|`string`|Name of the referent.More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names+optional| -|`namespace`|`string`|Namespace of the referent.More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/+optional| -|`resourceVersion`|`string`|Specific resourceVersion to which this reference is made, if any.More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency+optional| -|`uid`|`string`|UID of the referent.More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids+optional| +|`apiVersion`|`string`|API version of the referent.| +|`fieldPath`|`string`|If referring to a piece of an object instead of an entire object, this stringshould contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].For example, if the object reference is to a container within a pod, this would take on a value like:"spec.containers{name}" (where "name" refers to the name of the container that triggeredthe event) or if no container name is specified "spec.containers[2]" (container withindex 2 in this pod). This syntax is chosen only to have some well-defined way ofreferencing a part of an object.TODO: this design is not final and this field is subject to change in the future.| +|`kind`|`string`|Kind of the referent.More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds| +|`name`|`string`|Name of the referent.More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names| +|`namespace`|`string`|Namespace of the referent.More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/| +|`resourceVersion`|`string`|Specific resourceVersion to which this reference is made, if any.More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency| +|`uid`|`string`|UID of the referent.More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids| ## Container @@ -3421,218 +3422,218 @@ A single application container that you want to run within a pod. Examples with this field (click to open)
-- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) - -- [`cron-workflow.yaml`](../examples/cron-workflow.yaml) +- [`dns-config.yaml`](../examples/dns-config.yaml) -- [`default-pdb-support.yaml`](../examples/default-pdb-support.yaml) +- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) -- [`loops.yaml`](../examples/loops.yaml) +- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) -- [`retry-container.yaml`](../examples/retry-container.yaml) +- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) -- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) +- [`pod-spec-patch.yaml`](../examples/pod-spec-patch.yaml) -- [`retry-on-error.yaml`](../examples/retry-on-error.yaml) +- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) -- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) +- [`loops.yaml`](../examples/loops.yaml) - [`coinflip-recursive.yaml`](../examples/coinflip-recursive.yaml) -- [`continue-on-fail.yaml`](../examples/continue-on-fail.yaml) - -- [`input-artifact-s3.yaml`](../examples/input-artifact-s3.yaml) - -- [`steps.yaml`](../examples/steps.yaml) +- [`secrets.yaml`](../examples/secrets.yaml) -- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) +- [`dag-nested.yaml`](../examples/dag-nested.yaml) -- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) +- [`parallelism-limit.yaml`](../examples/parallelism-limit.yaml) - [`suspend-template.yaml`](../examples/suspend-template.yaml) -- [`volumes-emptydir.yaml`](../examples/volumes-emptydir.yaml) +- [`loops-dag.yaml`](../examples/loops-dag.yaml) -- [`timeouts-step.yaml`](../examples/timeouts-step.yaml) +- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) -- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) +- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) + +- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) - [`archive-location.yaml`](../examples/archive-location.yaml) -- [`ci.yaml`](../examples/ci.yaml) +- [`parallelism-template-limit.yaml`](../examples/parallelism-template-limit.yaml) -- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) +- [`coinflip.yaml`](../examples/coinflip.yaml) -- [`sidecar-dind.yaml`](../examples/sidecar-dind.yaml) +- [`retry-backoff.yaml`](../examples/retry-backoff.yaml) -- [`input-artifact-gcs.yaml`](../examples/input-artifact-gcs.yaml) +- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) -- [`scripts-python.yaml`](../examples/scripts-python.yaml) +- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) -- [`parallelism-template-limit.yaml`](../examples/parallelism-template-limit.yaml) +- [`retry-container-to-completion.yaml`](../examples/retry-container-to-completion.yaml) -- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) +- [`status-reference.yaml`](../examples/status-reference.yaml) -- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) +- [`sidecar-dind.yaml`](../examples/sidecar-dind.yaml) -- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) +- [`conditionals.yaml`](../examples/conditionals.yaml) -- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) +- [`output-parameter.yaml`](../examples/output-parameter.yaml) -- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) +- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) - [`dag-continue-on-fail.yaml`](../examples/dag-continue-on-fail.yaml) -- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) +- [`loops-maps.yaml`](../examples/loops-maps.yaml) -- [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) +- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) -- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) +- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) -- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) +- [`dag-targets.yaml`](../examples/dag-targets.yaml) -- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) +- [`scripts-python.yaml`](../examples/scripts-python.yaml) -- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) +- [`forever.yaml`](../examples/forever.yaml) -- [`retry-backoff.yaml`](../examples/retry-backoff.yaml) +- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) -- [`dag-targets.yaml`](../examples/dag-targets.yaml) +- [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) -- [`resubmit.yaml`](../examples/resubmit.yaml) +- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) -- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) +- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) -- [`image-pull-secrets.yaml`](../examples/image-pull-secrets.yaml) +- [`input-artifact-s3.yaml`](../examples/input-artifact-s3.yaml) -- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) +- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) -- [`dag-nested.yaml`](../examples/dag-nested.yaml) +- [`default-pdb-support.yaml`](../examples/default-pdb-support.yaml) -- [`pod-spec-patch.yaml`](../examples/pod-spec-patch.yaml) +- [`continue-on-fail.yaml`](../examples/continue-on-fail.yaml) -- [`hello-world.yaml`](../examples/hello-world.yaml) +- [`timeouts-step.yaml`](../examples/timeouts-step.yaml) -- [`coinflip.yaml`](../examples/coinflip.yaml) +- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) -- [`loops-dag.yaml`](../examples/loops-dag.yaml) +- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) -- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) +- [`image-pull-secrets.yaml`](../examples/image-pull-secrets.yaml) -- [`daemon-step.yaml`](../examples/daemon-step.yaml) +- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) -- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) +- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) -- [`exit-handlers.yaml`](../examples/exit-handlers.yaml) +- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) -- [`retry-with-steps.yaml`](../examples/retry-with-steps.yaml) +- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) -- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) +- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) - [`global-parameters.yaml`](../examples/global-parameters.yaml) -- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) +- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) -- [`timeouts-workflow.yaml`](../examples/timeouts-workflow.yaml) +- [`cron-workflow.yaml`](../examples/cron-workflow.yaml) -- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) +- [`hello-world.yaml`](../examples/hello-world.yaml) -- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) +- [`input-artifact-gcs.yaml`](../examples/input-artifact-gcs.yaml) -- [`sidecar-nginx.yaml`](../examples/sidecar-nginx.yaml) +- [`init-container.yaml`](../examples/init-container.yaml) -- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) +- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) -- [`input-artifact-oss.yaml`](../examples/input-artifact-oss.yaml) +- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) -- [`retry-container-to-completion.yaml`](../examples/retry-container-to-completion.yaml) +- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) -- [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) +- [`gc-ttl.yaml`](../examples/gc-ttl.yaml) + +- [`pod-gc-strategy.yaml`](../examples/pod-gc-strategy.yaml) - [`node-selector.yaml`](../examples/node-selector.yaml) -- [`dns-config.yaml`](../examples/dns-config.yaml) +- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) -- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) +- [`resubmit.yaml`](../examples/resubmit.yaml) -- [`gc-ttl.yaml`](../examples/gc-ttl.yaml) +- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) -- [`sidecar.yaml`](../examples/sidecar.yaml) +- [`volumes-emptydir.yaml`](../examples/volumes-emptydir.yaml) -- [`secrets.yaml`](../examples/secrets.yaml) +- [`steps.yaml`](../examples/steps.yaml) -- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) +- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) + +- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) + +- [`exit-handlers.yaml`](../examples/exit-handlers.yaml) - [`loops-param-result.yaml`](../examples/loops-param-result.yaml) -- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) +- [`templates.yaml`](../examples/workflow-template/templates.yaml) -- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) +- [`global-outputs.yaml`](../examples/global-outputs.yaml) -- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) +- [`input-artifact-oss.yaml`](../examples/input-artifact-oss.yaml) -- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) +- [`ci.yaml`](../examples/ci.yaml) -- [`init-container.yaml`](../examples/init-container.yaml) +- [`sidecar.yaml`](../examples/sidecar.yaml) -- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) +- [`retry-on-error.yaml`](../examples/retry-on-error.yaml) -- [`output-parameter.yaml`](../examples/output-parameter.yaml) +- [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) -- [`global-outputs.yaml`](../examples/global-outputs.yaml) +- [`retry-with-steps.yaml`](../examples/retry-with-steps.yaml) - [`template-on-exit.yaml`](../examples/template-on-exit.yaml) -- [`forever.yaml`](../examples/forever.yaml) - -- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) +- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) -- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) +- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) -- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) +- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) -- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) +- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) -- [`parallelism-limit.yaml`](../examples/parallelism-limit.yaml) +- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) -- [`conditionals.yaml`](../examples/conditionals.yaml) +- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) -- [`pod-gc-strategy.yaml`](../examples/pod-gc-strategy.yaml) +- [`daemon-step.yaml`](../examples/daemon-step.yaml) -- [`status-reference.yaml`](../examples/status-reference.yaml) +- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) -- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) +- [`timeouts-workflow.yaml`](../examples/timeouts-workflow.yaml) -- [`templates.yaml`](../examples/workflow-template/templates.yaml) +- [`sidecar-nginx.yaml`](../examples/sidecar-nginx.yaml) -- [`loops-maps.yaml`](../examples/loops-maps.yaml) +- [`retry-container.yaml`](../examples/retry-container.yaml) ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`args`|`Array< string >`|Arguments to the entrypoint.The docker image's CMD is used if this is not provided.Variable references $(VAR_NAME) are expanded using the container's environment. If a variablecannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntaxcan be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded,regardless of whether the variable exists or not.Cannot be updated.More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell+optional| -|`command`|`Array< string >`|Entrypoint array. Not executed within a shell.The docker image's ENTRYPOINT is used if this is not provided.Variable references $(VAR_NAME) are expanded using the container's environment. If a variablecannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntaxcan be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded,regardless of whether the variable exists or not.Cannot be updated.More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell+optional| -|`env`|`Array<`[`EnvVar`](#envvar)`>`|List of environment variables to set in the container.Cannot be updated.+optional| -|`envFrom`|`Array<`[`EnvFromSource`](#envfromsource)`>`|List of sources to populate environment variables in the container.The keys defined within a source must be a C_IDENTIFIER. All invalid keyswill be reported as an event when the container is starting. When a key exists in multiplesources, the value associated with the last source will take precedence.Values defined by an Env with a duplicate key will take precedence.Cannot be updated.+optional| -|`image`|`string`|Docker image name.More info: https://kubernetes.io/docs/concepts/containers/imagesThis field is optional to allow higher level config management to default or overridecontainer images in workload controllers like Deployments and StatefulSets.+optional| -|`imagePullPolicy`|`string`|Image pull policy.One of Always, Never, IfNotPresent.Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.Cannot be updated.More info: https://kubernetes.io/docs/concepts/containers/images#updating-images+optional| -|`lifecycle`|[`Lifecycle`](#lifecycle)|Actions that the management system should take in response to container lifecycle events.Cannot be updated.+optional| -|`livenessProbe`|[`Probe`](#probe)|Periodic probe of container liveness.Container will be restarted if the probe fails.Cannot be updated.More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes+optional| +|`args`|`Array< string >`|Arguments to the entrypoint.The docker image's CMD is used if this is not provided.Variable references $(VAR_NAME) are expanded using the container's environment. If a variablecannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntaxcan be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded,regardless of whether the variable exists or not.Cannot be updated.More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell| +|`command`|`Array< string >`|Entrypoint array. Not executed within a shell.The docker image's ENTRYPOINT is used if this is not provided.Variable references $(VAR_NAME) are expanded using the container's environment. If a variablecannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntaxcan be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded,regardless of whether the variable exists or not.Cannot be updated.More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell| +|`env`|`Array<`[`EnvVar`](#envvar)`>`|List of environment variables to set in the container.Cannot be updated.| +|`envFrom`|`Array<`[`EnvFromSource`](#envfromsource)`>`|List of sources to populate environment variables in the container.The keys defined within a source must be a C_IDENTIFIER. All invalid keyswill be reported as an event when the container is starting. When a key exists in multiplesources, the value associated with the last source will take precedence.Values defined by an Env with a duplicate key will take precedence.Cannot be updated.| +|`image`|`string`|Docker image name.More info: https://kubernetes.io/docs/concepts/containers/imagesThis field is optional to allow higher level config management to default or overridecontainer images in workload controllers like Deployments and StatefulSets.| +|`imagePullPolicy`|`string`|Image pull policy.One of Always, Never, IfNotPresent.Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.Cannot be updated.More info: https://kubernetes.io/docs/concepts/containers/images#updating-images| +|`lifecycle`|[`Lifecycle`](#lifecycle)|Actions that the management system should take in response to container lifecycle events.Cannot be updated.| +|`livenessProbe`|[`Probe`](#probe)|Periodic probe of container liveness.Container will be restarted if the probe fails.Cannot be updated.More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes| |`name`|`string`|Name of the container specified as a DNS_LABEL.Each container in a pod must have a unique name (DNS_LABEL).Cannot be updated.| -|`ports`|`Array<`[`ContainerPort`](#containerport)`>`|List of ports to expose from the container. Exposing a port here givesthe system additional information about the network connections acontainer uses, but is primarily informational. Not specifying a port hereDOES NOT prevent that port from being exposed. Any port which islistening on the default "0.0.0.0" address inside a container will beaccessible from the network.Cannot be updated.+optional| -|`readinessProbe`|[`Probe`](#probe)|Periodic probe of container service readiness.Container will be removed from service endpoints if the probe fails.Cannot be updated.More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes+optional| -|`resources`|[`ResourceRequirements`](#resourcerequirements)|Compute Resources required by this container.Cannot be updated.More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/+optional| -|`securityContext`|[`SecurityContext`](#securitycontext)|Security options the pod should run with.More info: https://kubernetes.io/docs/concepts/policy/security-context/More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/+optional| -|`startupProbe`|[`Probe`](#probe)|StartupProbe indicates that the Pod has successfully initialized.If specified, no other probes are executed until this completes successfully.If this probe fails, the Pod will be restarted, just as if the livenessProbe failed.This can be used to provide different probe parameters at the beginning of a Pod's lifecycle,when it might take a long time to load data or warm a cache, than during steady-state operation.This cannot be updated.This is an alpha feature enabled by the StartupProbe feature flag.More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes+optional| -|`stdin`|`boolean`|Whether this container should allocate a buffer for stdin in the container runtime. If thisis not set, reads from stdin in the container will always result in EOF.Default is false.+optional| -|`stdinOnce`|`boolean`|Whether the container runtime should close the stdin channel after it has been opened bya single attach. When stdin is true the stdin stream will remain open across multiple attachsessions. If stdinOnce is set to true, stdin is opened on container start, is empty until thefirst client attaches to stdin, and then remains open and accepts data until the client disconnects,at which time stdin is closed and remains closed until the container is restarted. If thisflag is false, a container processes that reads from stdin will never receive an EOF.Default is false+optional| -|`terminationMessagePath`|`string`|Optional: Path at which the file to which the container's termination messagewill be written is mounted into the container's filesystem.Message written is intended to be brief final status, such as an assertion failure message.Will be truncated by the node if greater than 4096 bytes. The total message length acrossall containers will be limited to 12kb.Defaults to /dev/termination-log.Cannot be updated.+optional| -|`terminationMessagePolicy`|`string`|Indicate how the termination message should be populated. File will use the contents ofterminationMessagePath to populate the container status message on both success and failure.FallbackToLogsOnError will use the last chunk of container log output if the terminationmessage file is empty and the container exited with an error.The log output is limited to 2048 bytes or 80 lines, whichever is smaller.Defaults to File.Cannot be updated.+optional| -|`tty`|`boolean`|Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.Default is false.+optional| +|`ports`|`Array<`[`ContainerPort`](#containerport)`>`|List of ports to expose from the container. Exposing a port here givesthe system additional information about the network connections acontainer uses, but is primarily informational. Not specifying a port hereDOES NOT prevent that port from being exposed. Any port which islistening on the default "0.0.0.0" address inside a container will beaccessible from the network.Cannot be updated.| +|`readinessProbe`|[`Probe`](#probe)|Periodic probe of container service readiness.Container will be removed from service endpoints if the probe fails.Cannot be updated.More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes| +|`resources`|[`ResourceRequirements`](#resourcerequirements)|Compute Resources required by this container.Cannot be updated.More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/| +|`securityContext`|[`SecurityContext`](#securitycontext)|Security options the pod should run with.More info: https://kubernetes.io/docs/concepts/policy/security-context/More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/| +|`startupProbe`|[`Probe`](#probe)|StartupProbe indicates that the Pod has successfully initialized.If specified, no other probes are executed until this completes successfully.If this probe fails, the Pod will be restarted, just as if the livenessProbe failed.This can be used to provide different probe parameters at the beginning of a Pod's lifecycle,when it might take a long time to load data or warm a cache, than during steady-state operation.This cannot be updated.This is an alpha feature enabled by the StartupProbe feature flag.More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes| +|`stdin`|`boolean`|Whether this container should allocate a buffer for stdin in the container runtime. If thisis not set, reads from stdin in the container will always result in EOF.Default is false.| +|`stdinOnce`|`boolean`|Whether the container runtime should close the stdin channel after it has been opened bya single attach. When stdin is true the stdin stream will remain open across multiple attachsessions. If stdinOnce is set to true, stdin is opened on container start, is empty until thefirst client attaches to stdin, and then remains open and accepts data until the client disconnects,at which time stdin is closed and remains closed until the container is restarted. If thisflag is false, a container processes that reads from stdin will never receive an EOF.Default is false| +|`terminationMessagePath`|`string`|Optional: Path at which the file to which the container's termination messagewill be written is mounted into the container's filesystem.Message written is intended to be brief final status, such as an assertion failure message.Will be truncated by the node if greater than 4096 bytes. The total message length acrossall containers will be limited to 12kb.Defaults to /dev/termination-log.Cannot be updated.| +|`terminationMessagePolicy`|`string`|Indicate how the termination message should be populated. File will use the contents ofterminationMessagePath to populate the container status message on both success and failure.FallbackToLogsOnError will use the last chunk of container log output if the terminationmessage file is empty and the container exited with an error.The log output is limited to 2048 bytes or 80 lines, whichever is smaller.Defaults to File.Cannot be updated.| +|`tty`|`boolean`|Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.Default is false.| |`volumeDevices`|`Array<`[`VolumeDevice`](#volumedevice)`>`|volumeDevices is the list of block devices to be used by the container.This is a beta feature.| -|`volumeMounts`|`Array<`[`VolumeMount`](#volumemount)`>`|Pod volumes to mount into the container's filesystem.Cannot be updated.+optional| -|`workingDir`|`string`|Container's working directory.If not specified, the container runtime's default will be used, whichmight be configured in the container image.Cannot be updated.+optional| +|`volumeMounts`|`Array<`[`VolumeMount`](#volumemount)`>`|Pod volumes to mount into the container's filesystem.Cannot be updated.| +|`workingDir`|`string`|Container's working directory.If not specified, the container runtime's default will be used, whichmight be configured in the container image.Cannot be updated.| ## SecretKeySelector @@ -3641,9 +3642,9 @@ SecretKeySelector selects a key of a Secret. Examples with this field (click to open)
-- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) - - [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) + +- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) ### Fields @@ -3651,7 +3652,7 @@ SecretKeySelector selects a key of a Secret. |:----------:|:----------:|---------------| |`key`|`string`|The key of the secret to select from. Must be a valid secret key.| |`localObjectReference`|[`LocalObjectReference`](#localobjectreference)|The name of the secret in the pod's namespace to select from.| -|`optional`|`boolean`|Specify whether the Secret or its key must be defined+optional| +|`optional`|`boolean`|Specify whether the Secret or its key must be defined| ## ConfigMapKeySelector @@ -3668,7 +3669,7 @@ Selects a key from a ConfigMap. |:----------:|:----------:|---------------| |`key`|`string`|The key to select.| |`localObjectReference`|[`LocalObjectReference`](#localobjectreference)|The ConfigMap to select from.| -|`optional`|`boolean`|Specify whether the ConfigMap or its key must be defined+optional| +|`optional`|`boolean`|Specify whether the ConfigMap or its key must be defined| ## ManagedFieldsEntry @@ -3679,10 +3680,10 @@ ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the res |:----------:|:----------:|---------------| |`apiVersion`|`string`|APIVersion defines the version of this resource that this field setapplies to. The format is "group/version" just like the top-levelAPIVersion field. It is necessary to track the version of a fieldset because it cannot be automatically converted.| |`fieldsType`|`string`|FieldsType is the discriminator for the different fields format and version.There is currently only one possible value: "FieldsV1"| -|`fieldsV1`|[`FieldsV1`](#fieldsv1)|FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.+optional| +|`fieldsV1`|[`FieldsV1`](#fieldsv1)|FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.| |`manager`|`string`|Manager is an identifier of the workflow managing these fields.| |`operation`|`string`|Operation is the type of operation which lead to this ManagedFieldsEntry being created.The only valid values for this field are 'Apply' and 'Update'.| -|`time`|[`Time`](#time)|Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'+optional| +|`time`|[`Time`](#time)|Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'| ## OwnerReference @@ -3698,8 +3699,8 @@ OwnerReference contains enough information to let you identify an owningobject. | Field Name | Field Type | Description | |:----------:|:----------:|---------------| |`apiVersion`|`string`|API version of the referent.| -|`blockOwnerDeletion`|`boolean`|If true, AND if the owner has the "foregroundDeletion" finalizer, thenthe owner cannot be deleted from the key-value store until thisreference is removed.Defaults to false.To set this field, a user needs "delete" permission of the owner,otherwise 422 (Unprocessable Entity) will be returned.+optional| -|`controller`|`boolean`|If true, this reference points to the managing controller.+optional| +|`blockOwnerDeletion`|`boolean`|If true, AND if the owner has the "foregroundDeletion" finalizer, thenthe owner cannot be deleted from the key-value store until thisreference is removed.Defaults to false.To set this field, a user needs "delete" permission of the owner,otherwise 422 (Unprocessable Entity) will be returned.| +|`controller`|`boolean`|If true, this reference points to the managing controller.| |`kind`|`string`|Kind of the referent.More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds| |`name`|`string`|Name of the referent.More info: http://kubernetes.io/docs/user-guide/identifiers#names| |`uid`|`string`|UID of the referent.More info: http://kubernetes.io/docs/user-guide/identifiers#uids| @@ -3711,8 +3712,8 @@ Node affinity is a group of node affinity scheduling rules. ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`preferredDuringSchedulingIgnoredDuringExecution`|`Array<`[`PreferredSchedulingTerm`](#preferredschedulingterm)`>`|The scheduler will prefer to schedule pods to nodes that satisfythe affinity expressions specified by this field, but it may choosea node that violates one or more of the expressions. The node that ismost preferred is the one with the greatest sum of weights, i.e.for each node that meets all of the scheduling requirements (resourcerequest, requiredDuringScheduling affinity expressions, etc.),compute a sum by iterating through the elements of this field and adding"weight" to the sum if the node matches the corresponding matchExpressions; thenode(s) with the highest sum are the most preferred.+optional| -|`requiredDuringSchedulingIgnoredDuringExecution`|[`NodeSelector`](#nodeselector)|If the affinity requirements specified by this field are not met atscheduling time, the pod will not be scheduled onto the node.If the affinity requirements specified by this field cease to be metat some point during pod execution (e.g. due to an update), the systemmay or may not try to eventually evict the pod from its node.+optional| +|`preferredDuringSchedulingIgnoredDuringExecution`|`Array<`[`PreferredSchedulingTerm`](#preferredschedulingterm)`>`|The scheduler will prefer to schedule pods to nodes that satisfythe affinity expressions specified by this field, but it may choosea node that violates one or more of the expressions. The node that ismost preferred is the one with the greatest sum of weights, i.e.for each node that meets all of the scheduling requirements (resourcerequest, requiredDuringScheduling affinity expressions, etc.),compute a sum by iterating through the elements of this field and adding"weight" to the sum if the node matches the corresponding matchExpressions; thenode(s) with the highest sum are the most preferred.| +|`requiredDuringSchedulingIgnoredDuringExecution`|[`NodeSelector`](#nodeselector)|If the affinity requirements specified by this field are not met atscheduling time, the pod will not be scheduled onto the node.If the affinity requirements specified by this field cease to be metat some point during pod execution (e.g. due to an update), the systemmay or may not try to eventually evict the pod from its node.| ## PodAffinity @@ -3721,8 +3722,8 @@ Pod affinity is a group of inter pod affinity scheduling rules. ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`preferredDuringSchedulingIgnoredDuringExecution`|`Array<`[`WeightedPodAffinityTerm`](#weightedpodaffinityterm)`>`|The scheduler will prefer to schedule pods to nodes that satisfythe affinity expressions specified by this field, but it may choosea node that violates one or more of the expressions. The node that ismost preferred is the one with the greatest sum of weights, i.e.for each node that meets all of the scheduling requirements (resourcerequest, requiredDuringScheduling affinity expressions, etc.),compute a sum by iterating through the elements of this field and adding"weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; thenode(s) with the highest sum are the most preferred.+optional| -|`requiredDuringSchedulingIgnoredDuringExecution`|`Array<`[`PodAffinityTerm`](#podaffinityterm)`>`|If the affinity requirements specified by this field are not met atscheduling time, the pod will not be scheduled onto the node.If the affinity requirements specified by this field cease to be metat some point during pod execution (e.g. due to a pod label update), thesystem may or may not try to eventually evict the pod from its node.When there are multiple elements, the lists of nodes corresponding to eachpodAffinityTerm are intersected, i.e. all terms must be satisfied.+optional| +|`preferredDuringSchedulingIgnoredDuringExecution`|`Array<`[`WeightedPodAffinityTerm`](#weightedpodaffinityterm)`>`|The scheduler will prefer to schedule pods to nodes that satisfythe affinity expressions specified by this field, but it may choosea node that violates one or more of the expressions. The node that ismost preferred is the one with the greatest sum of weights, i.e.for each node that meets all of the scheduling requirements (resourcerequest, requiredDuringScheduling affinity expressions, etc.),compute a sum by iterating through the elements of this field and adding"weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; thenode(s) with the highest sum are the most preferred.| +|`requiredDuringSchedulingIgnoredDuringExecution`|`Array<`[`PodAffinityTerm`](#podaffinityterm)`>`|If the affinity requirements specified by this field are not met atscheduling time, the pod will not be scheduled onto the node.If the affinity requirements specified by this field cease to be metat some point during pod execution (e.g. due to a pod label update), thesystem may or may not try to eventually evict the pod from its node.When there are multiple elements, the lists of nodes corresponding to eachpodAffinityTerm are intersected, i.e. all terms must be satisfied.| ## PodAntiAffinity @@ -3731,8 +3732,8 @@ Pod anti affinity is a group of inter pod anti affinity scheduling rules. ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`preferredDuringSchedulingIgnoredDuringExecution`|`Array<`[`WeightedPodAffinityTerm`](#weightedpodaffinityterm)`>`|The scheduler will prefer to schedule pods to nodes that satisfythe anti-affinity expressions specified by this field, but it may choosea node that violates one or more of the expressions. The node that ismost preferred is the one with the greatest sum of weights, i.e.for each node that meets all of the scheduling requirements (resourcerequest, requiredDuringScheduling anti-affinity expressions, etc.),compute a sum by iterating through the elements of this field and adding"weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; thenode(s) with the highest sum are the most preferred.+optional| -|`requiredDuringSchedulingIgnoredDuringExecution`|`Array<`[`PodAffinityTerm`](#podaffinityterm)`>`|If the anti-affinity requirements specified by this field are not met atscheduling time, the pod will not be scheduled onto the node.If the anti-affinity requirements specified by this field cease to be metat some point during pod execution (e.g. due to a pod label update), thesystem may or may not try to eventually evict the pod from its node.When there are multiple elements, the lists of nodes corresponding to eachpodAffinityTerm are intersected, i.e. all terms must be satisfied.+optional| +|`preferredDuringSchedulingIgnoredDuringExecution`|`Array<`[`WeightedPodAffinityTerm`](#weightedpodaffinityterm)`>`|The scheduler will prefer to schedule pods to nodes that satisfythe anti-affinity expressions specified by this field, but it may choosea node that violates one or more of the expressions. The node that ismost preferred is the one with the greatest sum of weights, i.e.for each node that meets all of the scheduling requirements (resourcerequest, requiredDuringScheduling anti-affinity expressions, etc.),compute a sum by iterating through the elements of this field and adding"weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; thenode(s) with the highest sum are the most preferred.| +|`requiredDuringSchedulingIgnoredDuringExecution`|`Array<`[`PodAffinityTerm`](#podaffinityterm)`>`|If the anti-affinity requirements specified by this field are not met atscheduling time, the pod will not be scheduled onto the node.If the anti-affinity requirements specified by this field cease to be metat some point during pod execution (e.g. due to a pod label update), thesystem may or may not try to eventually evict the pod from its node.When there are multiple elements, the lists of nodes corresponding to eachpodAffinityTerm are intersected, i.e. all terms must be satisfied.| ## PodDNSConfigOption @@ -3748,11 +3749,11 @@ PodDNSConfigOption defines DNS resolver options of a pod. | Field Name | Field Type | Description | |:----------:|:----------:|---------------| |`name`|`string`|Required.| -|`value`|`string`|+optional| +|`value`|`string`|| ## IntOrString -_No description available_ + ### Fields | Field Name | Field Type | Description | @@ -3768,8 +3769,8 @@ A label selector is a label query over a set of resources. The result of matchLa ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`matchExpressions`|`Array<`[`LabelSelectorRequirement`](#labelselectorrequirement)`>`|matchExpressions is a list of label selector requirements. The requirements are ANDed.+optional| -|`matchLabels`|`Map< string , string >`|matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabelsmap is equivalent to an element of matchExpressions, whose key field is "key", theoperator is "In", and the values array contains only "value". The requirements are ANDed.+optional| +|`matchExpressions`|`Array<`[`LabelSelectorRequirement`](#labelselectorrequirement)`>`|matchExpressions is a list of label selector requirements. The requirements are ANDed.| +|`matchLabels`|`Map< string , string >`|matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabelsmap is equivalent to an element of matchExpressions, whose key field is "key", theoperator is "In", and the values array contains only "value". The requirements are ANDed.| ## SELinuxOptions @@ -3778,10 +3779,10 @@ SELinuxOptions are the labels to be applied to the container ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`level`|`string`|Level is SELinux level label that applies to the container.+optional| -|`role`|`string`|Role is a SELinux role label that applies to the container.+optional| -|`type`|`string`|Type is a SELinux type label that applies to the container.+optional| -|`user`|`string`|User is a SELinux user label that applies to the container.+optional| +|`level`|`string`|Level is SELinux level label that applies to the container.| +|`role`|`string`|Role is a SELinux role label that applies to the container.| +|`type`|`string`|Type is a SELinux type label that applies to the container.| +|`user`|`string`|User is a SELinux user label that applies to the container.| ## Sysctl @@ -3800,9 +3801,9 @@ WindowsSecurityContextOptions contain Windows-specific options and credentials. ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`gmsaCredentialSpec`|`string`|GMSACredentialSpec is where the GMSA admission webhook(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of theGMSA credential spec named by the GMSACredentialSpecName field.This field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag.+optional| -|`gmsaCredentialSpecName`|`string`|GMSACredentialSpecName is the name of the GMSA credential spec to use.This field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag.+optional| -|`runAsUserName`|`string`|The UserName in Windows to run the entrypoint of the container process.Defaults to the user specified in image metadata if unspecified.May also be set in PodSecurityContext. If set in both SecurityContext andPodSecurityContext, the value specified in SecurityContext takes precedence.This field is alpha-level and it is only honored by servers that enable the WindowsRunAsUserName feature flag.+optional| +|`gmsaCredentialSpec`|`string`|GMSACredentialSpec is where the GMSA admission webhook(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of theGMSA credential spec named by the GMSACredentialSpecName field.This field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag.| +|`gmsaCredentialSpecName`|`string`|GMSACredentialSpecName is the name of the GMSA credential spec to use.This field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag.| +|`runAsUserName`|`string`|The UserName in Windows to run the entrypoint of the container process.Defaults to the user specified in image metadata if unspecified.May also be set in PodSecurityContext. If set in both SecurityContext andPodSecurityContext, the value specified in SecurityContext takes precedence.This field is alpha-level and it is only honored by servers that enable the WindowsRunAsUserName feature flag.| ## PersistentVolumeClaimSpec @@ -3811,229 +3812,229 @@ PersistentVolumeClaimSpec describes the common attributes of storage devicesand Examples with this field (click to open)
-- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) +- [`dns-config.yaml`](../examples/dns-config.yaml) -- [`cron-workflow.yaml`](../examples/cron-workflow.yaml) +- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) -- [`testvolume.yaml`](../examples/testvolume.yaml) +- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) -- [`default-pdb-support.yaml`](../examples/default-pdb-support.yaml) +- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) + +- [`pod-spec-patch.yaml`](../examples/pod-spec-patch.yaml) + +- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) - [`loops.yaml`](../examples/loops.yaml) -- [`retry-container.yaml`](../examples/retry-container.yaml) +- [`coinflip-recursive.yaml`](../examples/coinflip-recursive.yaml) + +- [`secrets.yaml`](../examples/secrets.yaml) -- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) +- [`dag-nested.yaml`](../examples/dag-nested.yaml) -- [`retry-on-error.yaml`](../examples/retry-on-error.yaml) +- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) -- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) +- [`parallelism-limit.yaml`](../examples/parallelism-limit.yaml) -- [`coinflip-recursive.yaml`](../examples/coinflip-recursive.yaml) +- [`suspend-template.yaml`](../examples/suspend-template.yaml) -- [`continue-on-fail.yaml`](../examples/continue-on-fail.yaml) +- [`loops-dag.yaml`](../examples/loops-dag.yaml) -- [`input-artifact-s3.yaml`](../examples/input-artifact-s3.yaml) +- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) -- [`steps.yaml`](../examples/steps.yaml) +- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) -- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) +- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) -- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) +- [`archive-location.yaml`](../examples/archive-location.yaml) -- [`suspend-template.yaml`](../examples/suspend-template.yaml) +- [`parallelism-template-limit.yaml`](../examples/parallelism-template-limit.yaml) -- [`volumes-emptydir.yaml`](../examples/volumes-emptydir.yaml) +- [`coinflip.yaml`](../examples/coinflip.yaml) -- [`timeouts-step.yaml`](../examples/timeouts-step.yaml) +- [`retry-backoff.yaml`](../examples/retry-backoff.yaml) -- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) +- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) -- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) +- [`steps.yaml`](../examples/workflow-template/steps.yaml) - [`retry-with-steps.yaml`](../examples/workflow-template/retry-with-steps.yaml) -- [`archive-location.yaml`](../examples/archive-location.yaml) +- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) -- [`ci.yaml`](../examples/ci.yaml) +- [`retry-container-to-completion.yaml`](../examples/retry-container-to-completion.yaml) -- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) +- [`status-reference.yaml`](../examples/status-reference.yaml) + +- [`retry-script.yaml`](../examples/retry-script.yaml) - [`sidecar-dind.yaml`](../examples/sidecar-dind.yaml) -- [`input-artifact-gcs.yaml`](../examples/input-artifact-gcs.yaml) +- [`conditionals.yaml`](../examples/conditionals.yaml) -- [`scripts-python.yaml`](../examples/scripts-python.yaml) +- [`output-parameter.yaml`](../examples/output-parameter.yaml) -- [`parallelism-template-limit.yaml`](../examples/parallelism-template-limit.yaml) +- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) -- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) +- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) -- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) +- [`dag-continue-on-fail.yaml`](../examples/dag-continue-on-fail.yaml) -- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) +- [`loops-maps.yaml`](../examples/loops-maps.yaml) -- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) +- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) -- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) +- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) -- [`dag-continue-on-fail.yaml`](../examples/dag-continue-on-fail.yaml) +- [`dag-targets.yaml`](../examples/dag-targets.yaml) -- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) +- [`testvolume.yaml`](../examples/testvolume.yaml) -- [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) +- [`scripts-python.yaml`](../examples/scripts-python.yaml) -- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) +- [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) -- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) +- [`forever.yaml`](../examples/forever.yaml) -- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) +- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) -- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) +- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) -- [`retry-backoff.yaml`](../examples/retry-backoff.yaml) +- [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) -- [`dag-targets.yaml`](../examples/dag-targets.yaml) +- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) -- [`resubmit.yaml`](../examples/resubmit.yaml) +- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) -- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) +- [`input-artifact-s3.yaml`](../examples/input-artifact-s3.yaml) -- [`image-pull-secrets.yaml`](../examples/image-pull-secrets.yaml) +- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) -- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) +- [`default-pdb-support.yaml`](../examples/default-pdb-support.yaml) -- [`steps.yaml`](../examples/workflow-template/steps.yaml) +- [`continue-on-fail.yaml`](../examples/continue-on-fail.yaml) -- [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) +- [`timeouts-step.yaml`](../examples/timeouts-step.yaml) -- [`dag-nested.yaml`](../examples/dag-nested.yaml) +- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) -- [`pod-spec-patch.yaml`](../examples/pod-spec-patch.yaml) +- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) -- [`hello-world.yaml`](../examples/hello-world.yaml) +- [`image-pull-secrets.yaml`](../examples/image-pull-secrets.yaml) -- [`coinflip.yaml`](../examples/coinflip.yaml) +- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) -- [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) +- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) -- [`loops-dag.yaml`](../examples/loops-dag.yaml) +- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) -- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) +- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) -- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) +- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) -- [`daemon-step.yaml`](../examples/daemon-step.yaml) +- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) - [`k8s-set-owner-reference.yaml`](../examples/k8s-set-owner-reference.yaml) -- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) - -- [`exit-handlers.yaml`](../examples/exit-handlers.yaml) - -- [`retry-with-steps.yaml`](../examples/retry-with-steps.yaml) - -- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) +- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) - [`global-parameters.yaml`](../examples/global-parameters.yaml) -- [`k8s-owner-reference.yaml`](../examples/k8s-owner-reference.yaml) - -- [`timeouts-workflow.yaml`](../examples/timeouts-workflow.yaml) +- [`cron-workflow.yaml`](../examples/cron-workflow.yaml) -- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) +- [`hello-world.yaml`](../examples/hello-world.yaml) -- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) +- [`input-artifact-gcs.yaml`](../examples/input-artifact-gcs.yaml) -- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) +- [`init-container.yaml`](../examples/init-container.yaml) -- [`sidecar-nginx.yaml`](../examples/sidecar-nginx.yaml) +- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) -- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) +- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) -- [`input-artifact-oss.yaml`](../examples/input-artifact-oss.yaml) +- [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) -- [`retry-container-to-completion.yaml`](../examples/retry-container-to-completion.yaml) +- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) -- [`dag.yaml`](../examples/workflow-template/dag.yaml) +- [`gc-ttl.yaml`](../examples/gc-ttl.yaml) -- [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) +- [`pod-gc-strategy.yaml`](../examples/pod-gc-strategy.yaml) - [`node-selector.yaml`](../examples/node-selector.yaml) -- [`dns-config.yaml`](../examples/dns-config.yaml) +- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) -- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) +- [`resubmit.yaml`](../examples/resubmit.yaml) -- [`gc-ttl.yaml`](../examples/gc-ttl.yaml) +- [`k8s-owner-reference.yaml`](../examples/k8s-owner-reference.yaml) -- [`sidecar.yaml`](../examples/sidecar.yaml) +- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) -- [`secrets.yaml`](../examples/secrets.yaml) +- [`volumes-emptydir.yaml`](../examples/volumes-emptydir.yaml) -- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) +- [`steps.yaml`](../examples/steps.yaml) -- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) +- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) -- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) +- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) -- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) +- [`dag.yaml`](../examples/workflow-template/dag.yaml) -- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) +- [`exit-handlers.yaml`](../examples/exit-handlers.yaml) -- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) +- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) -- [`init-container.yaml`](../examples/init-container.yaml) +- [`templates.yaml`](../examples/workflow-template/templates.yaml) -- [`retry-script.yaml`](../examples/retry-script.yaml) +- [`global-outputs.yaml`](../examples/global-outputs.yaml) -- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) +- [`input-artifact-oss.yaml`](../examples/input-artifact-oss.yaml) -- [`output-parameter.yaml`](../examples/output-parameter.yaml) +- [`ci.yaml`](../examples/ci.yaml) -- [`global-outputs.yaml`](../examples/global-outputs.yaml) +- [`sidecar.yaml`](../examples/sidecar.yaml) -- [`template-on-exit.yaml`](../examples/template-on-exit.yaml) +- [`retry-on-error.yaml`](../examples/retry-on-error.yaml) -- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) +- [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) -- [`forever.yaml`](../examples/forever.yaml) +- [`retry-with-steps.yaml`](../examples/retry-with-steps.yaml) -- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) +- [`template-on-exit.yaml`](../examples/template-on-exit.yaml) -- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) +- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) -- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) +- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) -- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) +- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) -- [`parallelism-limit.yaml`](../examples/parallelism-limit.yaml) +- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) -- [`conditionals.yaml`](../examples/conditionals.yaml) +- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) -- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) +- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) -- [`pod-gc-strategy.yaml`](../examples/pod-gc-strategy.yaml) +- [`daemon-step.yaml`](../examples/daemon-step.yaml) -- [`status-reference.yaml`](../examples/status-reference.yaml) +- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) -- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) +- [`timeouts-workflow.yaml`](../examples/timeouts-workflow.yaml) -- [`templates.yaml`](../examples/workflow-template/templates.yaml) +- [`sidecar-nginx.yaml`](../examples/sidecar-nginx.yaml) -- [`loops-maps.yaml`](../examples/loops-maps.yaml) +- [`retry-container.yaml`](../examples/retry-container.yaml) ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`accessModes`|`Array< string >`|AccessModes contains the desired access modes the volume should have.More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1+optional| -|`dataSource`|[`TypedLocalObjectReference`](#typedlocalobjectreference)|This field requires the VolumeSnapshotDataSource alpha feature gate to beenabled and currently VolumeSnapshot is the only supported data source.If the provisioner can support VolumeSnapshot data source, it will createa new volume and data will be restored to the volume at the same time.If the provisioner does not support VolumeSnapshot data source, volume willnot be created and the failure will be reported as an event.In the future, we plan to support more data source types and the behaviorof the provisioner may change.+optional| -|`resources`|[`ResourceRequirements`](#resourcerequirements)|Resources represents the minimum resources the volume should have.More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources+optional| -|`selector`|[`LabelSelector`](#labelselector)|A label query over volumes to consider for binding.+optional| -|`storageClassName`|`string`|Name of the StorageClass required by the claim.More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1+optional| -|`volumeMode`|`string`|volumeMode defines what type of volume is required by the claim.Value of Filesystem is implied when not included in claim spec.This is a beta feature.+optional| -|`volumeName`|`string`|VolumeName is the binding reference to the PersistentVolume backing this claim.+optional| +|`accessModes`|`Array< string >`|AccessModes contains the desired access modes the volume should have.More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1| +|`dataSource`|[`TypedLocalObjectReference`](#typedlocalobjectreference)|This field requires the VolumeSnapshotDataSource alpha feature gate to beenabled and currently VolumeSnapshot is the only supported data source.If the provisioner can support VolumeSnapshot data source, it will createa new volume and data will be restored to the volume at the same time.If the provisioner does not support VolumeSnapshot data source, volume willnot be created and the failure will be reported as an event.In the future, we plan to support more data source types and the behaviorof the provisioner may change.| +|`resources`|[`ResourceRequirements`](#resourcerequirements)|Resources represents the minimum resources the volume should have.More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources| +|`selector`|[`LabelSelector`](#labelselector)|A label query over volumes to consider for binding.| +|`storageClassName`|`string`|Name of the StorageClass required by the claim.More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1| +|`volumeMode`|`string`|volumeMode defines what type of volume is required by the claim.Value of Filesystem is implied when not included in claim spec.This is a beta feature.| +|`volumeName`|`string`|VolumeName is the binding reference to the PersistentVolume backing this claim.| ## PersistentVolumeClaimStatus @@ -4042,10 +4043,10 @@ PersistentVolumeClaimStatus is the current status of a persistent volume claim. ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`accessModes`|`Array< string >`|AccessModes contains the actual access modes the volume backing the PVC has.More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1+optional| -|`capacity`|[`Quantity`](#quantity)|Represents the actual resources of the underlying volume.+optional| -|`conditions`|`Array<`[`PersistentVolumeClaimCondition`](#persistentvolumeclaimcondition)`>`|Current Condition of persistent volume claim. If underlying persistent volume is beingresized then the Condition will be set to 'ResizeStarted'.+optional| -|`phase`|`string`|Phase represents the current phase of PersistentVolumeClaim.+optional| +|`accessModes`|`Array< string >`|AccessModes contains the actual access modes the volume backing the PVC has.More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1| +|`capacity`|[`Quantity`](#quantity)|Represents the actual resources of the underlying volume.| +|`conditions`|`Array<`[`PersistentVolumeClaimCondition`](#persistentvolumeclaimcondition)`>`|Current Condition of persistent volume claim. If underlying persistent volume is beingresized then the Condition will be set to 'ResizeStarted'.| +|`phase`|`string`|Phase represents the current phase of PersistentVolumeClaim.| ## VolumeSource @@ -4054,34 +4055,34 @@ Represents the source of a volume to mount.Only one of its members may be specif ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`awsElasticBlockStore`|[`AWSElasticBlockStoreVolumeSource`](#awselasticblockstorevolumesource)|AWSElasticBlockStore represents an AWS Disk resource that is attached to akubelet's host machine and then exposed to the pod.More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore+optional| -|`azureDisk`|[`AzureDiskVolumeSource`](#azurediskvolumesource)|AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.+optional| -|`azureFile`|[`AzureFileVolumeSource`](#azurefilevolumesource)|AzureFile represents an Azure File Service mount on the host and bind mount to the pod.+optional| -|`cephfs`|[`CephFSVolumeSource`](#cephfsvolumesource)|CephFS represents a Ceph FS mount on the host that shares a pod's lifetime+optional| -|`cinder`|[`CinderVolumeSource`](#cindervolumesource)|Cinder represents a cinder volume attached and mounted on kubelets host machine.More info: https://examples.k8s.io/mysql-cinder-pd/README.md+optional| -|`configMap`|[`ConfigMapVolumeSource`](#configmapvolumesource)|ConfigMap represents a configMap that should populate this volume+optional| -|`csi`|[`CSIVolumeSource`](#csivolumesource)|CSI (Container Storage Interface) represents storage that is handled by an external CSI driver (Alpha feature).+optional| -|`downwardAPI`|[`DownwardAPIVolumeSource`](#downwardapivolumesource)|DownwardAPI represents downward API about the pod that should populate this volume+optional| -|`emptyDir`|[`EmptyDirVolumeSource`](#emptydirvolumesource)|EmptyDir represents a temporary directory that shares a pod's lifetime.More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir+optional| -|`fc`|[`FCVolumeSource`](#fcvolumesource)|FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.+optional| -|`flexVolume`|[`FlexVolumeSource`](#flexvolumesource)|FlexVolume represents a generic volume resource that isprovisioned/attached using an exec based plugin.+optional| -|`flocker`|[`FlockerVolumeSource`](#flockervolumesource)|Flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running+optional| -|`gcePersistentDisk`|[`GCEPersistentDiskVolumeSource`](#gcepersistentdiskvolumesource)|GCEPersistentDisk represents a GCE Disk resource that is attached to akubelet's host machine and then exposed to the pod.More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk+optional| -|~`gitRepo`~|~[`GitRepoVolumeSource`](#gitrepovolumesource)~|~GitRepo represents a git repository at a particular revision.~ DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount anEmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDirinto the Pod's container.+optional| -|`glusterfs`|[`GlusterfsVolumeSource`](#glusterfsvolumesource)|Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime.More info: https://examples.k8s.io/volumes/glusterfs/README.md+optional| -|`hostPath`|[`HostPathVolumeSource`](#hostpathvolumesource)|HostPath represents a pre-existing file or directory on the hostmachine that is directly exposed to the container. This is generallyused for system agents or other privileged things that are allowedto see the host machine. Most containers will NOT need this.More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath---TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can notmount host directories as read/write.+optional| -|`iscsi`|[`ISCSIVolumeSource`](#iscsivolumesource)|ISCSI represents an ISCSI Disk resource that is attached to akubelet's host machine and then exposed to the pod.More info: https://examples.k8s.io/volumes/iscsi/README.md+optional| -|`nfs`|[`NFSVolumeSource`](#nfsvolumesource)|NFS represents an NFS mount on the host that shares a pod's lifetimeMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs+optional| -|`persistentVolumeClaim`|[`PersistentVolumeClaimVolumeSource`](#persistentvolumeclaimvolumesource)|PersistentVolumeClaimVolumeSource represents a reference to aPersistentVolumeClaim in the same namespace.More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims+optional| +|`awsElasticBlockStore`|[`AWSElasticBlockStoreVolumeSource`](#awselasticblockstorevolumesource)|AWSElasticBlockStore represents an AWS Disk resource that is attached to akubelet's host machine and then exposed to the pod.More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore| +|`azureDisk`|[`AzureDiskVolumeSource`](#azurediskvolumesource)|AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.| +|`azureFile`|[`AzureFileVolumeSource`](#azurefilevolumesource)|AzureFile represents an Azure File Service mount on the host and bind mount to the pod.| +|`cephfs`|[`CephFSVolumeSource`](#cephfsvolumesource)|CephFS represents a Ceph FS mount on the host that shares a pod's lifetime| +|`cinder`|[`CinderVolumeSource`](#cindervolumesource)|Cinder represents a cinder volume attached and mounted on kubelets host machine.More info: https://examples.k8s.io/mysql-cinder-pd/README.md| +|`configMap`|[`ConfigMapVolumeSource`](#configmapvolumesource)|ConfigMap represents a configMap that should populate this volume| +|`csi`|[`CSIVolumeSource`](#csivolumesource)|CSI (Container Storage Interface) represents storage that is handled by an external CSI driver (Alpha feature).| +|`downwardAPI`|[`DownwardAPIVolumeSource`](#downwardapivolumesource)|DownwardAPI represents downward API about the pod that should populate this volume| +|`emptyDir`|[`EmptyDirVolumeSource`](#emptydirvolumesource)|EmptyDir represents a temporary directory that shares a pod's lifetime.More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir| +|`fc`|[`FCVolumeSource`](#fcvolumesource)|FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.| +|`flexVolume`|[`FlexVolumeSource`](#flexvolumesource)|FlexVolume represents a generic volume resource that isprovisioned/attached using an exec based plugin.| +|`flocker`|[`FlockerVolumeSource`](#flockervolumesource)|Flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running| +|`gcePersistentDisk`|[`GCEPersistentDiskVolumeSource`](#gcepersistentdiskvolumesource)|GCEPersistentDisk represents a GCE Disk resource that is attached to akubelet's host machine and then exposed to the pod.More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk| +|~`gitRepo`~|~[`GitRepoVolumeSource`](#gitrepovolumesource)~|~GitRepo represents a git repository at a particular revision.~ DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount anEmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDirinto the Pod's container.| +|`glusterfs`|[`GlusterfsVolumeSource`](#glusterfsvolumesource)|Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime.More info: https://examples.k8s.io/volumes/glusterfs/README.md| +|`hostPath`|[`HostPathVolumeSource`](#hostpathvolumesource)|HostPath represents a pre-existing file or directory on the hostmachine that is directly exposed to the container. This is generallyused for system agents or other privileged things that are allowedto see the host machine. Most containers will NOT need this.More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath---TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can notmount host directories as read/write.| +|`iscsi`|[`ISCSIVolumeSource`](#iscsivolumesource)|ISCSI represents an ISCSI Disk resource that is attached to akubelet's host machine and then exposed to the pod.More info: https://examples.k8s.io/volumes/iscsi/README.md| +|`nfs`|[`NFSVolumeSource`](#nfsvolumesource)|NFS represents an NFS mount on the host that shares a pod's lifetimeMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs| +|`persistentVolumeClaim`|[`PersistentVolumeClaimVolumeSource`](#persistentvolumeclaimvolumesource)|PersistentVolumeClaimVolumeSource represents a reference to aPersistentVolumeClaim in the same namespace.More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims| |`photonPersistentDisk`|[`PhotonPersistentDiskVolumeSource`](#photonpersistentdiskvolumesource)|PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine| -|`portworxVolume`|[`PortworxVolumeSource`](#portworxvolumesource)|PortworxVolume represents a portworx volume attached and mounted on kubelets host machine+optional| +|`portworxVolume`|[`PortworxVolumeSource`](#portworxvolumesource)|PortworxVolume represents a portworx volume attached and mounted on kubelets host machine| |`projected`|[`ProjectedVolumeSource`](#projectedvolumesource)|Items for all in one resources secrets, configmaps, and downward API| -|`quobyte`|[`QuobyteVolumeSource`](#quobytevolumesource)|Quobyte represents a Quobyte mount on the host that shares a pod's lifetime+optional| -|`rbd`|[`RBDVolumeSource`](#rbdvolumesource)|RBD represents a Rados Block Device mount on the host that shares a pod's lifetime.More info: https://examples.k8s.io/volumes/rbd/README.md+optional| -|`scaleIO`|[`ScaleIOVolumeSource`](#scaleiovolumesource)|ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.+optional| -|`secret`|[`SecretVolumeSource`](#secretvolumesource)|Secret represents a secret that should populate this volume.More info: https://kubernetes.io/docs/concepts/storage/volumes#secret+optional| -|`storageos`|[`StorageOSVolumeSource`](#storageosvolumesource)|StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.+optional| -|`vsphereVolume`|[`VsphereVirtualDiskVolumeSource`](#vspherevirtualdiskvolumesource)|VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine+optional| +|`quobyte`|[`QuobyteVolumeSource`](#quobytevolumesource)|Quobyte represents a Quobyte mount on the host that shares a pod's lifetime| +|`rbd`|[`RBDVolumeSource`](#rbdvolumesource)|RBD represents a Rados Block Device mount on the host that shares a pod's lifetime.More info: https://examples.k8s.io/volumes/rbd/README.md| +|`scaleIO`|[`ScaleIOVolumeSource`](#scaleiovolumesource)|ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.| +|`secret`|[`SecretVolumeSource`](#secretvolumesource)|Secret represents a secret that should populate this volume.More info: https://kubernetes.io/docs/concepts/storage/volumes#secret| +|`storageos`|[`StorageOSVolumeSource`](#storageosvolumesource)|StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.| +|`vsphereVolume`|[`VsphereVirtualDiskVolumeSource`](#vspherevirtualdiskvolumesource)|VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine| ## EnvVar @@ -4090,17 +4091,17 @@ EnvVar represents an environment variable present in a Container. Examples with this field (click to open)
-- [`secrets.yaml`](../examples/secrets.yaml) - - [`sidecar-dind.yaml`](../examples/sidecar-dind.yaml) + +- [`secrets.yaml`](../examples/secrets.yaml) ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| |`name`|`string`|Name of the environment variable. Must be a C_IDENTIFIER.| -|`value`|`string`|Variable references $(VAR_NAME) are expandedusing the previous defined environment variables in the container andany service environment variables. If a variable cannot be resolved,the reference in the input string will be unchanged. The $(VAR_NAME)syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escapedreferences will never be expanded, regardless of whether the variableexists or not.Defaults to "".+optional| -|`valueFrom`|[`EnvVarSource`](#envvarsource)|Source for the environment variable's value. Cannot be used if value is not empty.+optional| +|`value`|`string`|Variable references $(VAR_NAME) are expandedusing the previous defined environment variables in the container andany service environment variables. If a variable cannot be resolved,the reference in the input string will be unchanged. The $(VAR_NAME)syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escapedreferences will never be expanded, regardless of whether the variableexists or not.Defaults to "".| +|`valueFrom`|[`EnvVarSource`](#envvarsource)|Source for the environment variable's value. Cannot be used if value is not empty.| ## EnvFromSource @@ -4109,9 +4110,9 @@ EnvFromSource represents the source of a set of ConfigMaps ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`configMapRef`|[`ConfigMapEnvSource`](#configmapenvsource)|The ConfigMap to select from+optional| -|`prefix`|`string`|An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.+optional| -|`secretRef`|[`SecretEnvSource`](#secretenvsource)|The Secret to select from+optional| +|`configMapRef`|[`ConfigMapEnvSource`](#configmapenvsource)|The ConfigMap to select from| +|`prefix`|`string`|An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.| +|`secretRef`|[`SecretEnvSource`](#secretenvsource)|The Secret to select from| ## Lifecycle @@ -4120,8 +4121,8 @@ Lifecycle describes actions that the management system should take in response t ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`postStart`|[`Handler`](#handler)|PostStart is called immediately after a container is created. If the handler fails,the container is terminated and restarted according to its restart policy.Other management of the container blocks until the hook completes.More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks+optional| -|`preStop`|[`Handler`](#handler)|PreStop is called immediately before a container is terminated due to anAPI request or management event such as liveness/startup probe failure,preemption, resource contention, etc. The handler is not called if thecontainer crashes or exits. The reason for termination is passed to thehandler. The Pod's termination grace period countdown begins before thePreStop hooked is executed. Regardless of the outcome of the handler, thecontainer will eventually terminate within the Pod's termination graceperiod. Other management of the container blocks until the hook completesor until the termination grace period is reached.More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks+optional| +|`postStart`|[`Handler`](#handler)|PostStart is called immediately after a container is created. If the handler fails,the container is terminated and restarted according to its restart policy.Other management of the container blocks until the hook completes.More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks| +|`preStop`|[`Handler`](#handler)|PreStop is called immediately before a container is terminated due to anAPI request or management event such as liveness/startup probe failure,preemption, resource contention, etc. The handler is not called if thecontainer crashes or exits. The reason for termination is passed to thehandler. The Pod's termination grace period countdown begins before thePreStop hooked is executed. Regardless of the outcome of the handler, thecontainer will eventually terminate within the Pod's termination graceperiod. Other management of the container blocks until the hook completesor until the termination grace period is reached.More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks| ## Probe @@ -4130,12 +4131,12 @@ Probe describes a health check to be performed against a container to determine ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`failureThreshold`|`int32`|Minimum consecutive failures for the probe to be considered failed after having succeeded.Defaults to 3. Minimum value is 1.+optional| +|`failureThreshold`|`int32`|Minimum consecutive failures for the probe to be considered failed after having succeeded.Defaults to 3. Minimum value is 1.| |`handler`|[`Handler`](#handler)|The action taken to determine the health of a container| -|`initialDelaySeconds`|`int32`|Number of seconds after the container has started before liveness probes are initiated.More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes+optional| -|`periodSeconds`|`int32`|How often (in seconds) to perform the probe.Default to 10 seconds. Minimum value is 1.+optional| -|`successThreshold`|`int32`|Minimum consecutive successes for the probe to be considered successful after having failed.Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.+optional| -|`timeoutSeconds`|`int32`|Number of seconds after which the probe times out.Defaults to 1 second. Minimum value is 1.More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes+optional| +|`initialDelaySeconds`|`int32`|Number of seconds after the container has started before liveness probes are initiated.More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes| +|`periodSeconds`|`int32`|How often (in seconds) to perform the probe.Default to 10 seconds. Minimum value is 1.| +|`successThreshold`|`int32`|Minimum consecutive successes for the probe to be considered successful after having failed.Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.| +|`timeoutSeconds`|`int32`|Number of seconds after which the probe times out.Defaults to 1 second. Minimum value is 1.More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes| ## ContainerPort @@ -4145,10 +4146,10 @@ ContainerPort represents a network port in a single container. | Field Name | Field Type | Description | |:----------:|:----------:|---------------| |`containerPort`|`int32`|Number of port to expose on the pod's IP address.This must be a valid port number, 0 < x < 65536.| -|`hostIP`|`string`|What host IP to bind the external port to.+optional| -|`hostPort`|`int32`|Number of port to expose on the host.If specified, this must be a valid port number, 0 < x < 65536.If HostNetwork is specified, this must match ContainerPort.Most containers do not need this.+optional| -|`name`|`string`|If specified, this must be an IANA_SVC_NAME and unique within the pod. Eachnamed port in a pod must have a unique name. Name for the port that can bereferred to by services.+optional| -|`protocol`|`string`|Protocol for port. Must be UDP, TCP, or SCTP.Defaults to "TCP".+optional| +|`hostIP`|`string`|What host IP to bind the external port to.| +|`hostPort`|`int32`|Number of port to expose on the host.If specified, this must be a valid port number, 0 < x < 65536.If HostNetwork is specified, this must match ContainerPort.Most containers do not need this.| +|`name`|`string`|If specified, this must be an IANA_SVC_NAME and unique within the pod. Eachnamed port in a pod must have a unique name. Name for the port that can bereferred to by services.| +|`protocol`|`string`|Protocol for port. Must be UDP, TCP, or SCTP.Defaults to "TCP".| ## ResourceRequirements @@ -4157,30 +4158,30 @@ ResourceRequirements describes the compute resource requirements. Examples with this field (click to open)
-- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) +- [`dns-config.yaml`](../examples/dns-config.yaml) - [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) +- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) + - [`ci.yaml`](../examples/ci.yaml) +- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) + - [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) -- [`dns-config.yaml`](../examples/dns-config.yaml) +- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) - [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) -- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) - - [`testvolume.yaml`](../examples/testvolume.yaml) - -- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`limits`|[`Quantity`](#quantity)|Limits describes the maximum amount of compute resources allowed.More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/+optional| -|`requests`|[`Quantity`](#quantity)|Requests describes the minimum amount of compute resources required.If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,otherwise to an implementation-defined value.More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/+optional| +|`limits`|[`Quantity`](#quantity)|Limits describes the maximum amount of compute resources allowed.More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/| +|`requests`|[`Quantity`](#quantity)|Requests describes the minimum amount of compute resources required.If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,otherwise to an implementation-defined value.More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/| ## SecurityContext @@ -4195,16 +4196,16 @@ SecurityContext holds security configuration that will be applied to a container ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`allowPrivilegeEscalation`|`boolean`|AllowPrivilegeEscalation controls whether a process can gain moreprivileges than its parent process. This bool directly controls ifthe no_new_privs flag will be set on the container process.AllowPrivilegeEscalation is true always when the container is:1) run as Privileged2) has CAP_SYS_ADMIN+optional| -|`capabilities`|[`Capabilities`](#capabilities)|The capabilities to add/drop when running containers.Defaults to the default set of capabilities granted by the container runtime.+optional| -|`privileged`|`boolean`|Run container in privileged mode.Processes in privileged containers are essentially equivalent to root on the host.Defaults to false.+optional| -|`procMount`|`string`|procMount denotes the type of proc mount to use for the containers.The default is DefaultProcMount which uses the container runtime defaults forreadonly paths and masked paths.This requires the ProcMountType feature flag to be enabled.+optional| -|`readOnlyRootFilesystem`|`boolean`|Whether this container has a read-only root filesystem.Default is false.+optional| -|`runAsGroup`|`int64`|The GID to run the entrypoint of the container process.Uses runtime default if unset.May also be set in PodSecurityContext. If set in both SecurityContext andPodSecurityContext, the value specified in SecurityContext takes precedence.+optional| -|`runAsNonRoot`|`boolean`|Indicates that the container must run as a non-root user.If true, the Kubelet will validate the image at runtime to ensure that itdoes not run as UID 0 (root) and fail to start the container if it does.If unset or false, no such validation will be performed.May also be set in PodSecurityContext. If set in both SecurityContext andPodSecurityContext, the value specified in SecurityContext takes precedence.+optional| -|`runAsUser`|`int64`|The UID to run the entrypoint of the container process.Defaults to user specified in image metadata if unspecified.May also be set in PodSecurityContext. If set in both SecurityContext andPodSecurityContext, the value specified in SecurityContext takes precedence.+optional| -|`seLinuxOptions`|[`SELinuxOptions`](#selinuxoptions)|The SELinux context to be applied to the container.If unspecified, the container runtime will allocate a random SELinux context for eachcontainer. May also be set in PodSecurityContext. If set in both SecurityContext andPodSecurityContext, the value specified in SecurityContext takes precedence.+optional| -|`windowsOptions`|[`WindowsSecurityContextOptions`](#windowssecuritycontextoptions)|The Windows specific settings applied to all containers.If unspecified, the options from the PodSecurityContext will be used.If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.+optional| +|`allowPrivilegeEscalation`|`boolean`|AllowPrivilegeEscalation controls whether a process can gain moreprivileges than its parent process. This bool directly controls ifthe no_new_privs flag will be set on the container process.AllowPrivilegeEscalation is true always when the container is:1) run as Privileged2) has CAP_SYS_ADMIN| +|`capabilities`|[`Capabilities`](#capabilities)|The capabilities to add/drop when running containers.Defaults to the default set of capabilities granted by the container runtime.| +|`privileged`|`boolean`|Run container in privileged mode.Processes in privileged containers are essentially equivalent to root on the host.Defaults to false.| +|`procMount`|`string`|procMount denotes the type of proc mount to use for the containers.The default is DefaultProcMount which uses the container runtime defaults forreadonly paths and masked paths.This requires the ProcMountType feature flag to be enabled.| +|`readOnlyRootFilesystem`|`boolean`|Whether this container has a read-only root filesystem.Default is false.| +|`runAsGroup`|`int64`|The GID to run the entrypoint of the container process.Uses runtime default if unset.May also be set in PodSecurityContext. If set in both SecurityContext andPodSecurityContext, the value specified in SecurityContext takes precedence.| +|`runAsNonRoot`|`boolean`|Indicates that the container must run as a non-root user.If true, the Kubelet will validate the image at runtime to ensure that itdoes not run as UID 0 (root) and fail to start the container if it does.If unset or false, no such validation will be performed.May also be set in PodSecurityContext. If set in both SecurityContext andPodSecurityContext, the value specified in SecurityContext takes precedence.| +|`runAsUser`|`int64`|The UID to run the entrypoint of the container process.Defaults to user specified in image metadata if unspecified.May also be set in PodSecurityContext. If set in both SecurityContext andPodSecurityContext, the value specified in SecurityContext takes precedence.| +|`seLinuxOptions`|[`SELinuxOptions`](#selinuxoptions)|The SELinux context to be applied to the container.If unspecified, the container runtime will allocate a random SELinux context for eachcontainer. May also be set in PodSecurityContext. If set in both SecurityContext andPodSecurityContext, the value specified in SecurityContext takes precedence.| +|`windowsOptions`|[`WindowsSecurityContextOptions`](#windowssecuritycontextoptions)|The Windows specific settings applied to all containers.If unspecified, the options from the PodSecurityContext will be used.If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.| ## VolumeDevice @@ -4223,32 +4224,32 @@ VolumeMount describes a mounting of a Volume within a container. Examples with this field (click to open)
-- [`volumes-emptydir.yaml`](../examples/volumes-emptydir.yaml) - -- [`init-container.yaml`](../examples/init-container.yaml) - -- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) - - [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) - [`ci.yaml`](../examples/ci.yaml) -- [`secrets.yaml`](../examples/secrets.yaml) +- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) + +- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) - [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) -- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) +- [`volumes-emptydir.yaml`](../examples/volumes-emptydir.yaml) + +- [`init-container.yaml`](../examples/init-container.yaml) + +- [`secrets.yaml`](../examples/secrets.yaml) ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| |`mountPath`|`string`|Path within the container at which the volume should be mounted. Mustnot contain ':'.| -|`mountPropagation`|`string`|mountPropagation determines how mounts are propagated from the hostto container and the other way around.When not set, MountPropagationNone is used.This field is beta in 1.10.+optional| +|`mountPropagation`|`string`|mountPropagation determines how mounts are propagated from the hostto container and the other way around.When not set, MountPropagationNone is used.This field is beta in 1.10.| |`name`|`string`|This must match the Name of a Volume.| -|`readOnly`|`boolean`|Mounted read-only if true, read-write otherwise (false or unspecified).Defaults to false.+optional| -|`subPath`|`string`|Path within the volume from which the container's volume should be mounted.Defaults to "" (volume's root).+optional| -|`subPathExpr`|`string`|Expanded path within the volume from which the container's volume should be mounted.Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.Defaults to "" (volume's root).SubPathExpr and SubPath are mutually exclusive.This field is beta in 1.15.+optional| +|`readOnly`|`boolean`|Mounted read-only if true, read-write otherwise (false or unspecified).Defaults to false.| +|`subPath`|`string`|Path within the volume from which the container's volume should be mounted.Defaults to "" (volume's root).| +|`subPathExpr`|`string`|Expanded path within the volume from which the container's volume should be mounted.Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.Defaults to "" (volume's root).SubPathExpr and SubPath are mutually exclusive.This field is beta in 1.15.| ## FieldsV1 @@ -4295,8 +4296,8 @@ Defines a set of pods (namely those matching the labelSelectorrelative to the gi ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`labelSelector`|[`LabelSelector`](#labelselector)|A label query over a set of resources, in this case pods.+optional| -|`namespaces`|`Array< string >`|namespaces specifies which namespaces the labelSelector applies to (matches against);null or empty list means "this pod's namespace"+optional| +|`labelSelector`|[`LabelSelector`](#labelselector)|A label query over a set of resources, in this case pods.| +|`namespaces`|`Array< string >`|namespaces specifies which namespaces the labelSelector applies to (matches against);null or empty list means "this pod's namespace"| |`topologyKey`|`string`|This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matchingthe labelSelector in the specified namespaces, where co-located is defined as running on a nodewhose value of the label with key topologyKey matches that of any node on which any of theselected pods is running.Empty topologyKey is not allowed.| ## LabelSelectorRequirement @@ -4308,7 +4309,7 @@ A label selector requirement is a selector that contains values, a key, and an o |:----------:|:----------:|---------------| |`key`|`string`|key is the label key that the selector applies to.| |`operator`|`string`|operator represents a key's relationship to a set of values.Valid operators are In, NotIn, Exists and DoesNotExist.| -|`values`|`Array< string >`|values is an array of string values. If the operator is In or NotIn,the values array must be non-empty. If the operator is Exists or DoesNotExist,the values array must be empty. This array is replaced during a strategicmerge patch.+optional| +|`values`|`Array< string >`|values is an array of string values. If the operator is In or NotIn,the values array must be non-empty. If the operator is Exists or DoesNotExist,the values array must be empty. This array is replaced during a strategicmerge patch.| ## TypedLocalObjectReference @@ -4317,7 +4318,7 @@ TypedLocalObjectReference contains enough information to let you locate thetyped ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`apiGroup`|`string`|APIGroup is the group for the resource being referenced.If APIGroup is not specified, the specified Kind must be in the core API group.For any other third-party types, APIGroup is required.+optional| +|`apiGroup`|`string`|APIGroup is the group for the resource being referenced.If APIGroup is not specified, the specified Kind must be in the core API group.For any other third-party types, APIGroup is required.| |`kind`|`string`|Kind is the type of resource being referenced| |`name`|`string`|Name is the name of resource being referenced| @@ -4337,10 +4338,10 @@ PersistentVolumeClaimCondition contails details about state of pvc ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`lastProbeTime`|[`Time`](#time)|Last time we probed the condition.+optional| -|`lastTransitionTime`|[`Time`](#time)|Last time the condition transitioned from one status to another.+optional| -|`message`|`string`|Human-readable message indicating details about last transition.+optional| -|`reason`|`string`|Unique, this should be a short, machine understandable string that gives the reasonfor condition's last transition. If it reports "ResizeStarted" that means the underlyingpersistent volume is being resized.+optional| +|`lastProbeTime`|[`Time`](#time)|Last time we probed the condition.| +|`lastTransitionTime`|[`Time`](#time)|Last time the condition transitioned from one status to another.| +|`message`|`string`|Human-readable message indicating details about last transition.| +|`reason`|`string`|Unique, this should be a short, machine understandable string that gives the reasonfor condition's last transition. If it reports "ResizeStarted" that means the underlyingpersistent volume is being resized.| |`status`|`string`|_No desription available_| |`type`|`string`|_No desription available_| @@ -4351,9 +4352,9 @@ Represents a Persistent Disk resource in AWS.An AWS EBS disk must exist before m ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`fsType`|`string`|Filesystem type of the volume that you want to mount.Tip: Ensure that the filesystem type is supported by the host operating system.Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstoreTODO: how do we prevent errors in the filesystem from compromising the machine+optional| -|`partition`|`int32`|The partition in the volume that you want to mount.If omitted, the default is to mount by volume name.Examples: For volume /dev/sda1, you specify the partition as "1".Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).+optional| -|`readOnly`|`boolean`|Specify "true" to force and set the ReadOnly property in VolumeMounts to "true".If omitted, the default is "false".More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore+optional| +|`fsType`|`string`|Filesystem type of the volume that you want to mount.Tip: Ensure that the filesystem type is supported by the host operating system.Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstoreTODO: how do we prevent errors in the filesystem from compromising the machine| +|`partition`|`int32`|The partition in the volume that you want to mount.If omitted, the default is to mount by volume name.Examples: For volume /dev/sda1, you specify the partition as "1".Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).| +|`readOnly`|`boolean`|Specify "true" to force and set the ReadOnly property in VolumeMounts to "true".If omitted, the default is "false".More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore| |`volumeID`|`string`|Unique ID of the persistent disk resource in AWS (Amazon EBS volume).More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore| ## AzureDiskVolumeSource @@ -4363,12 +4364,12 @@ AzureDisk represents an Azure Data Disk mount on the host and bind mount to the ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`cachingMode`|`string`|Host Caching mode: None, Read Only, Read Write.+optional| +|`cachingMode`|`string`|Host Caching mode: None, Read Only, Read Write.| |`diskName`|`string`|The Name of the data disk in the blob storage| |`diskURI`|`string`|The URI the data disk in the blob storage| -|`fsType`|`string`|Filesystem type to mount.Must be a filesystem type supported by the host operating system.Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.+optional| +|`fsType`|`string`|Filesystem type to mount.Must be a filesystem type supported by the host operating system.Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.| |`kind`|`string`|Expected values Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared| -|`readOnly`|`boolean`|Defaults to false (read/write). ReadOnly here will forcethe ReadOnly setting in VolumeMounts.+optional| +|`readOnly`|`boolean`|Defaults to false (read/write). ReadOnly here will forcethe ReadOnly setting in VolumeMounts.| ## AzureFileVolumeSource @@ -4377,7 +4378,7 @@ AzureFile represents an Azure File Service mount on the host and bind mount to t ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`readOnly`|`boolean`|Defaults to false (read/write). ReadOnly here will forcethe ReadOnly setting in VolumeMounts.+optional| +|`readOnly`|`boolean`|Defaults to false (read/write). ReadOnly here will forcethe ReadOnly setting in VolumeMounts.| |`secretName`|`string`|the name of secret that contains Azure Storage Account Name and Key| |`shareName`|`string`|Share Name| @@ -4389,11 +4390,11 @@ Represents a Ceph Filesystem mount that lasts the lifetime of a podCephfs volume | Field Name | Field Type | Description | |:----------:|:----------:|---------------| |`monitors`|`Array< string >`|Required: Monitors is a collection of Ceph monitorsMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it| -|`path`|`string`|Optional: Used as the mounted root, rather than the full Ceph tree, default is /+optional| -|`readOnly`|`boolean`|Optional: Defaults to false (read/write). ReadOnly here will forcethe ReadOnly setting in VolumeMounts.More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it+optional| -|`secretFile`|`string`|Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secretMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it+optional| -|`secretRef`|[`LocalObjectReference`](#localobjectreference)|Optional: SecretRef is reference to the authentication secret for User, default is empty.More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it+optional| -|`user`|`string`|Optional: User is the rados user name, default is adminMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it+optional| +|`path`|`string`|Optional: Used as the mounted root, rather than the full Ceph tree, default is /| +|`readOnly`|`boolean`|Optional: Defaults to false (read/write). ReadOnly here will forcethe ReadOnly setting in VolumeMounts.More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it| +|`secretFile`|`string`|Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secretMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it| +|`secretRef`|[`LocalObjectReference`](#localobjectreference)|Optional: SecretRef is reference to the authentication secret for User, default is empty.More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it| +|`user`|`string`|Optional: User is the rados user name, default is adminMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it| ## CinderVolumeSource @@ -4402,9 +4403,9 @@ Represents a cinder volume resource in Openstack.A Cinder volume must exist befo ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`fsType`|`string`|Filesystem type to mount.Must be a filesystem type supported by the host operating system.Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.More info: https://examples.k8s.io/mysql-cinder-pd/README.md+optional| -|`readOnly`|`boolean`|Optional: Defaults to false (read/write). ReadOnly here will forcethe ReadOnly setting in VolumeMounts.More info: https://examples.k8s.io/mysql-cinder-pd/README.md+optional| -|`secretRef`|[`LocalObjectReference`](#localobjectreference)|Optional: points to a secret object containing parameters used to connectto OpenStack.+optional| +|`fsType`|`string`|Filesystem type to mount.Must be a filesystem type supported by the host operating system.Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.More info: https://examples.k8s.io/mysql-cinder-pd/README.md| +|`readOnly`|`boolean`|Optional: Defaults to false (read/write). ReadOnly here will forcethe ReadOnly setting in VolumeMounts.More info: https://examples.k8s.io/mysql-cinder-pd/README.md| +|`secretRef`|[`LocalObjectReference`](#localobjectreference)|Optional: points to a secret object containing parameters used to connectto OpenStack.| |`volumeID`|`string`|volume id used to identify the volume in cinder.More info: https://examples.k8s.io/mysql-cinder-pd/README.md| ## ConfigMapVolumeSource @@ -4414,10 +4415,10 @@ Adapts a ConfigMap into a volume.The contents of the target ConfigMap's Data fie ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`defaultMode`|`int32`|Optional: mode bits to use on created files by default. Must be avalue between 0 and 0777. Defaults to 0644.Directories within the path are not affected by this setting.This might be in conflict with other options that affect the filemode, like fsGroup, and the result can be other mode bits set.+optional| -|`items`|`Array<`[`KeyToPath`](#keytopath)`>`|If unspecified, each key-value pair in the Data field of the referencedConfigMap will be projected into the volume as a file whose name is thekey and content is the value. If specified, the listed keys will beprojected into the specified paths, and unlisted keys will not bepresent. If a key is specified which is not present in the ConfigMap,the volume setup will error unless it is marked optional. Paths must berelative and may not contain the '..' path or start with '..'.+optional| +|`defaultMode`|`int32`|Optional: mode bits to use on created files by default. Must be avalue between 0 and 0777. Defaults to 0644.Directories within the path are not affected by this setting.This might be in conflict with other options that affect the filemode, like fsGroup, and the result can be other mode bits set.| +|`items`|`Array<`[`KeyToPath`](#keytopath)`>`|If unspecified, each key-value pair in the Data field of the referencedConfigMap will be projected into the volume as a file whose name is thekey and content is the value. If specified, the listed keys will beprojected into the specified paths, and unlisted keys will not bepresent. If a key is specified which is not present in the ConfigMap,the volume setup will error unless it is marked optional. Paths must berelative and may not contain the '..' path or start with '..'.| |`localObjectReference`|[`LocalObjectReference`](#localobjectreference)|_No desription available_| -|`optional`|`boolean`|Specify whether the ConfigMap or its keys must be defined+optional| +|`optional`|`boolean`|Specify whether the ConfigMap or its keys must be defined| ## CSIVolumeSource @@ -4427,10 +4428,10 @@ Represents a source location of a volume to mount, managed by an external CSI dr | Field Name | Field Type | Description | |:----------:|:----------:|---------------| |`driver`|`string`|Driver is the name of the CSI driver that handles this volume.Consult with your admin for the correct name as registered in the cluster.| -|`fsType`|`string`|Filesystem type to mount. Ex. "ext4", "xfs", "ntfs".If not provided, the empty value is passed to the associated CSI driverwhich will determine the default filesystem to apply.+optional| -|`nodePublishSecretRef`|[`LocalObjectReference`](#localobjectreference)|NodePublishSecretRef is a reference to the secret object containingsensitive information to pass to the CSI driver to complete the CSINodePublishVolume and NodeUnpublishVolume calls.This field is optional, and may be empty if no secret is required. If thesecret object contains more than one secret, all secret references are passed.+optional| -|`readOnly`|`boolean`|Specifies a read-only configuration for the volume.Defaults to false (read/write).+optional| -|`volumeAttributes`|`Map< string , string >`|VolumeAttributes stores driver-specific properties that are passed to the CSIdriver. Consult your driver's documentation for supported values.+optional| +|`fsType`|`string`|Filesystem type to mount. Ex. "ext4", "xfs", "ntfs".If not provided, the empty value is passed to the associated CSI driverwhich will determine the default filesystem to apply.| +|`nodePublishSecretRef`|[`LocalObjectReference`](#localobjectreference)|NodePublishSecretRef is a reference to the secret object containingsensitive information to pass to the CSI driver to complete the CSINodePublishVolume and NodeUnpublishVolume calls.This field is optional, and may be empty if no secret is required. If thesecret object contains more than one secret, all secret references are passed.| +|`readOnly`|`boolean`|Specifies a read-only configuration for the volume.Defaults to false (read/write).| +|`volumeAttributes`|`Map< string , string >`|VolumeAttributes stores driver-specific properties that are passed to the CSIdriver. Consult your driver's documentation for supported values.| ## DownwardAPIVolumeSource @@ -4439,8 +4440,8 @@ DownwardAPIVolumeSource represents a volume containing downward API io.argoproj. ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`defaultMode`|`int32`|Optional: mode bits to use on created files by default. Must be avalue between 0 and 0777. Defaults to 0644.Directories within the path are not affected by this setting.This might be in conflict with other options that affect the filemode, like fsGroup, and the result can be other mode bits set.+optional| -|`items`|`Array<`[`DownwardAPIVolumeFile`](#downwardapivolumefile)`>`|Items is a list of downward API volume file+optional| +|`defaultMode`|`int32`|Optional: mode bits to use on created files by default. Must be avalue between 0 and 0777. Defaults to 0644.Directories within the path are not affected by this setting.This might be in conflict with other options that affect the filemode, like fsGroup, and the result can be other mode bits set.| +|`items`|`Array<`[`DownwardAPIVolumeFile`](#downwardapivolumefile)`>`|Items is a list of downward API volume file| ## EmptyDirVolumeSource @@ -4457,8 +4458,8 @@ Represents an empty directory for a pod.Empty directory volumes support ownershi ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`medium`|`string`|What type of storage medium should back this directory.The default is "" which means to use the node's default medium.Must be an empty string (default) or Memory.More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir+optional| -|`sizeLimit`|[`Quantity`](#quantity)|Total amount of local storage required for this EmptyDir volume.The size limit is also applicable for memory medium.The maximum usage on memory medium EmptyDir would be the minimum value betweenthe SizeLimit specified here and the sum of memory limits of all containers in a pod.The default is nil which means that the limit is undefined.More info: http://kubernetes.io/docs/user-guide/volumes#emptydir+optional| +|`medium`|`string`|What type of storage medium should back this directory.The default is "" which means to use the node's default medium.Must be an empty string (default) or Memory.More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir| +|`sizeLimit`|[`Quantity`](#quantity)|Total amount of local storage required for this EmptyDir volume.The size limit is also applicable for memory medium.The maximum usage on memory medium EmptyDir would be the minimum value betweenthe SizeLimit specified here and the sum of memory limits of all containers in a pod.The default is nil which means that the limit is undefined.More info: http://kubernetes.io/docs/user-guide/volumes#emptydir| ## FCVolumeSource @@ -4467,11 +4468,11 @@ Represents a Fibre Channel volume.Fibre Channel volumes can only be mounted as r ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`fsType`|`string`|Filesystem type to mount.Must be a filesystem type supported by the host operating system.Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.TODO: how do we prevent errors in the filesystem from compromising the machine+optional| -|`lun`|`int32`|Optional: FC target lun number+optional| -|`readOnly`|`boolean`|Optional: Defaults to false (read/write). ReadOnly here will forcethe ReadOnly setting in VolumeMounts.+optional| -|`targetWWNs`|`Array< string >`|Optional: FC target worldwide names (WWNs)+optional| -|`wwids`|`Array< string >`|Optional: FC volume world wide identifiers (wwids)Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.+optional| +|`fsType`|`string`|Filesystem type to mount.Must be a filesystem type supported by the host operating system.Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.TODO: how do we prevent errors in the filesystem from compromising the machine| +|`lun`|`int32`|Optional: FC target lun number| +|`readOnly`|`boolean`|Optional: Defaults to false (read/write). ReadOnly here will forcethe ReadOnly setting in VolumeMounts.| +|`targetWWNs`|`Array< string >`|Optional: FC target worldwide names (WWNs)| +|`wwids`|`Array< string >`|Optional: FC volume world wide identifiers (wwids)Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.| ## FlexVolumeSource @@ -4481,10 +4482,10 @@ FlexVolume represents a generic volume resource that isprovisioned/attached usin | Field Name | Field Type | Description | |:----------:|:----------:|---------------| |`driver`|`string`|Driver is the name of the driver to use for this volume.| -|`fsType`|`string`|Filesystem type to mount.Must be a filesystem type supported by the host operating system.Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.+optional| -|`options`|`Map< string , string >`|Optional: Extra command options if any.+optional| -|`readOnly`|`boolean`|Optional: Defaults to false (read/write). ReadOnly here will forcethe ReadOnly setting in VolumeMounts.+optional| -|`secretRef`|[`LocalObjectReference`](#localobjectreference)|Optional: SecretRef is reference to the secret object containingsensitive information to pass to the plugin scripts. This may beempty if no secret object is specified. If the secret objectcontains more than one secret, all secrets are passed to the pluginscripts.+optional| +|`fsType`|`string`|Filesystem type to mount.Must be a filesystem type supported by the host operating system.Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.| +|`options`|`Map< string , string >`|Optional: Extra command options if any.| +|`readOnly`|`boolean`|Optional: Defaults to false (read/write). ReadOnly here will forcethe ReadOnly setting in VolumeMounts.| +|`secretRef`|[`LocalObjectReference`](#localobjectreference)|Optional: SecretRef is reference to the secret object containingsensitive information to pass to the plugin scripts. This may beempty if no secret object is specified. If the secret objectcontains more than one secret, all secrets are passed to the pluginscripts.| ## FlockerVolumeSource @@ -4493,8 +4494,8 @@ Represents a Flocker volume mounted by the Flocker agent.One and only one of dat ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`datasetName`|`string`|Name of the dataset stored as metadata -> name on the dataset for Flockershould be considered as deprecated+optional| -|`datasetUUID`|`string`|UUID of the dataset. This is unique identifier of a Flocker dataset+optional| +|`datasetName`|`string`|Name of the dataset stored as metadata -> name on the dataset for Flockershould be considered as deprecated| +|`datasetUUID`|`string`|UUID of the dataset. This is unique identifier of a Flocker dataset| ## GCEPersistentDiskVolumeSource @@ -4503,10 +4504,10 @@ Represents a Persistent Disk resource in Google Compute Engine.A GCE PD must exi ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`fsType`|`string`|Filesystem type of the volume that you want to mount.Tip: Ensure that the filesystem type is supported by the host operating system.Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdiskTODO: how do we prevent errors in the filesystem from compromising the machine+optional| -|`partition`|`int32`|The partition in the volume that you want to mount.If omitted, the default is to mount by volume name.Examples: For volume /dev/sda1, you specify the partition as "1".Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk+optional| +|`fsType`|`string`|Filesystem type of the volume that you want to mount.Tip: Ensure that the filesystem type is supported by the host operating system.Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdiskTODO: how do we prevent errors in the filesystem from compromising the machine| +|`partition`|`int32`|The partition in the volume that you want to mount.If omitted, the default is to mount by volume name.Examples: For volume /dev/sda1, you specify the partition as "1".Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk| |`pdName`|`string`|Unique name of the PD resource in GCE. Used to identify the disk in GCE.More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk| -|`readOnly`|`boolean`|ReadOnly here will force the ReadOnly setting in VolumeMounts.Defaults to false.More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk+optional| +|`readOnly`|`boolean`|ReadOnly here will force the ReadOnly setting in VolumeMounts.Defaults to false.More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk| ## GitRepoVolumeSource @@ -4515,9 +4516,9 @@ Represents a volume that is populated with the contents of a git repository.Git ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`directory`|`string`|Target directory name.Must not contain or start with '..'. If '.' is supplied, the volume directory will be thegit repository. Otherwise, if specified, the volume will contain the git repository inthe subdirectory with the given name.+optional| +|`directory`|`string`|Target directory name.Must not contain or start with '..'. If '.' is supplied, the volume directory will be thegit repository. Otherwise, if specified, the volume will contain the git repository inthe subdirectory with the given name.| |`repository`|`string`|Repository URL| -|`revision`|`string`|Commit hash for the specified revision.+optional| +|`revision`|`string`|Commit hash for the specified revision.| ## GlusterfsVolumeSource @@ -4528,7 +4529,7 @@ Represents a Glusterfs mount that lasts the lifetime of a pod.Glusterfs volumes |:----------:|:----------:|---------------| |`endpoints`|`string`|EndpointsName is the endpoint name that details Glusterfs topology.More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod| |`path`|`string`|Path is the Glusterfs volume path.More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod| -|`readOnly`|`boolean`|ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions.Defaults to false.More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod+optional| +|`readOnly`|`boolean`|ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions.Defaults to false.More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod| ## HostPathVolumeSource @@ -4538,7 +4539,7 @@ Represents a host path mapped into a pod.Host path volumes do not support owners | Field Name | Field Type | Description | |:----------:|:----------:|---------------| |`path`|`string`|Path of the directory on the host.If the path is a symlink, it will follow the link to the real path.More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath| -|`type`|`string`|Type for HostPath VolumeDefaults to ""More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath+optional| +|`type`|`string`|Type for HostPath VolumeDefaults to ""More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath| ## ISCSIVolumeSource @@ -4547,16 +4548,16 @@ Represents an ISCSI disk.ISCSI volumes can only be mounted as read/write once.IS ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`chapAuthDiscovery`|`boolean`|whether support iSCSI Discovery CHAP authentication+optional| -|`chapAuthSession`|`boolean`|whether support iSCSI Session CHAP authentication+optional| -|`fsType`|`string`|Filesystem type of the volume that you want to mount.Tip: Ensure that the filesystem type is supported by the host operating system.Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsiTODO: how do we prevent errors in the filesystem from compromising the machine+optional| -|`initiatorName`|`string`|Custom iSCSI Initiator Name.If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface: will be created for the connection.+optional| +|`chapAuthDiscovery`|`boolean`|whether support iSCSI Discovery CHAP authentication| +|`chapAuthSession`|`boolean`|whether support iSCSI Session CHAP authentication| +|`fsType`|`string`|Filesystem type of the volume that you want to mount.Tip: Ensure that the filesystem type is supported by the host operating system.Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsiTODO: how do we prevent errors in the filesystem from compromising the machine| +|`initiatorName`|`string`|Custom iSCSI Initiator Name.If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface: will be created for the connection.| |`iqn`|`string`|Target iSCSI Qualified Name.| -|`iscsiInterface`|`string`|iSCSI Interface Name that uses an iSCSI transport.Defaults to 'default' (tcp).+optional| +|`iscsiInterface`|`string`|iSCSI Interface Name that uses an iSCSI transport.Defaults to 'default' (tcp).| |`lun`|`int32`|iSCSI Target Lun number.| -|`portals`|`Array< string >`|iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the portis other than default (typically TCP ports 860 and 3260).+optional| -|`readOnly`|`boolean`|ReadOnly here will force the ReadOnly setting in VolumeMounts.Defaults to false.+optional| -|`secretRef`|[`LocalObjectReference`](#localobjectreference)|CHAP Secret for iSCSI target and initiator authentication+optional| +|`portals`|`Array< string >`|iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the portis other than default (typically TCP ports 860 and 3260).| +|`readOnly`|`boolean`|ReadOnly here will force the ReadOnly setting in VolumeMounts.Defaults to false.| +|`secretRef`|[`LocalObjectReference`](#localobjectreference)|CHAP Secret for iSCSI target and initiator authentication| |`targetPortal`|`string`|iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the portis other than default (typically TCP ports 860 and 3260).| ## NFSVolumeSource @@ -4567,7 +4568,7 @@ Represents an NFS mount that lasts the lifetime of a pod.NFS volumes do not supp | Field Name | Field Type | Description | |:----------:|:----------:|---------------| |`path`|`string`|Path that is exported by the NFS server.More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs| -|`readOnly`|`boolean`|ReadOnly here will forcethe NFS export to be mounted with read-only permissions.Defaults to false.More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs+optional| +|`readOnly`|`boolean`|ReadOnly here will forcethe NFS export to be mounted with read-only permissions.Defaults to false.More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs| |`server`|`string`|Server is the hostname or IP address of the NFS server.More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs| ## PersistentVolumeClaimVolumeSource @@ -4584,7 +4585,7 @@ PersistentVolumeClaimVolumeSource references the user's PVC in the same namespac | Field Name | Field Type | Description | |:----------:|:----------:|---------------| |`claimName`|`string`|ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume.More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims| -|`readOnly`|`boolean`|Will force the ReadOnly setting in VolumeMounts.Default false.+optional| +|`readOnly`|`boolean`|Will force the ReadOnly setting in VolumeMounts.Default false.| ## PhotonPersistentDiskVolumeSource @@ -4604,7 +4605,7 @@ PortworxVolumeSource represents a Portworx volume resource. | Field Name | Field Type | Description | |:----------:|:----------:|---------------| |`fsType`|`string`|FSType represents the filesystem type to mountMust be a filesystem type supported by the host operating system.Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.| -|`readOnly`|`boolean`|Defaults to false (read/write). ReadOnly here will forcethe ReadOnly setting in VolumeMounts.+optional| +|`readOnly`|`boolean`|Defaults to false (read/write). ReadOnly here will forcethe ReadOnly setting in VolumeMounts.| |`volumeID`|`string`|VolumeID uniquely identifies a Portworx volume| ## ProjectedVolumeSource @@ -4614,7 +4615,7 @@ Represents a projected volume source ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`defaultMode`|`int32`|Mode bits to use on created files by default. Must be a value between0 and 0777.Directories within the path are not affected by this setting.This might be in conflict with other options that affect the filemode, like fsGroup, and the result can be other mode bits set.+optional| +|`defaultMode`|`int32`|Mode bits to use on created files by default. Must be a value between0 and 0777.Directories within the path are not affected by this setting.This might be in conflict with other options that affect the filemode, like fsGroup, and the result can be other mode bits set.| |`sources`|`Array<`[`VolumeProjection`](#volumeprojection)`>`|list of volume projections| ## QuobyteVolumeSource @@ -4624,11 +4625,11 @@ Represents a Quobyte mount that lasts the lifetime of a pod.Quobyte volumes do n ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`group`|`string`|Group to map volume access toDefault is no group+optional| -|`readOnly`|`boolean`|ReadOnly here will force the Quobyte volume to be mounted with read-only permissions.Defaults to false.+optional| +|`group`|`string`|Group to map volume access toDefault is no group| +|`readOnly`|`boolean`|ReadOnly here will force the Quobyte volume to be mounted with read-only permissions.Defaults to false.| |`registry`|`string`|Registry represents a single or multiple Quobyte Registry servicesspecified as a string as host:port pair (multiple entries are separated with commas)which acts as the central registry for volumes| -|`tenant`|`string`|Tenant owning the given Quobyte volume in the BackendUsed with dynamically provisioned Quobyte volumes, value is set by the plugin+optional| -|`user`|`string`|User to map volume access toDefaults to serivceaccount user+optional| +|`tenant`|`string`|Tenant owning the given Quobyte volume in the BackendUsed with dynamically provisioned Quobyte volumes, value is set by the plugin| +|`user`|`string`|User to map volume access toDefaults to serivceaccount user| |`volume`|`string`|Volume is a string that references an already created Quobyte volume by name.| ## RBDVolumeSource @@ -4638,14 +4639,14 @@ Represents a Rados Block Device mount that lasts the lifetime of a pod.RBD volum ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`fsType`|`string`|Filesystem type of the volume that you want to mount.Tip: Ensure that the filesystem type is supported by the host operating system.Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.More info: https://kubernetes.io/docs/concepts/storage/volumes#rbdTODO: how do we prevent errors in the filesystem from compromising the machine+optional| +|`fsType`|`string`|Filesystem type of the volume that you want to mount.Tip: Ensure that the filesystem type is supported by the host operating system.Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.More info: https://kubernetes.io/docs/concepts/storage/volumes#rbdTODO: how do we prevent errors in the filesystem from compromising the machine| |`image`|`string`|The rados image name.More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it| -|`keyring`|`string`|Keyring is the path to key ring for RBDUser.Default is /etc/ceph/keyring.More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it+optional| +|`keyring`|`string`|Keyring is the path to key ring for RBDUser.Default is /etc/ceph/keyring.More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it| |`monitors`|`Array< string >`|A collection of Ceph monitors.More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it| -|`pool`|`string`|The rados pool name.Default is rbd.More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it+optional| -|`readOnly`|`boolean`|ReadOnly here will force the ReadOnly setting in VolumeMounts.Defaults to false.More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it+optional| -|`secretRef`|[`LocalObjectReference`](#localobjectreference)|SecretRef is name of the authentication secret for RBDUser. If providedoverrides keyring.Default is nil.More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it+optional| -|`user`|`string`|The rados user name.Default is admin.More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it+optional| +|`pool`|`string`|The rados pool name.Default is rbd.More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it| +|`readOnly`|`boolean`|ReadOnly here will force the ReadOnly setting in VolumeMounts.Defaults to false.More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it| +|`secretRef`|[`LocalObjectReference`](#localobjectreference)|SecretRef is name of the authentication secret for RBDUser. If providedoverrides keyring.Default is nil.More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it| +|`user`|`string`|The rados user name.Default is admin.More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it| ## ScaleIOVolumeSource @@ -4654,14 +4655,14 @@ ScaleIOVolumeSource represents a persistent ScaleIO volume ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`fsType`|`string`|Filesystem type to mount.Must be a filesystem type supported by the host operating system.Ex. "ext4", "xfs", "ntfs".Default is "xfs".+optional| +|`fsType`|`string`|Filesystem type to mount.Must be a filesystem type supported by the host operating system.Ex. "ext4", "xfs", "ntfs".Default is "xfs".| |`gateway`|`string`|The host address of the ScaleIO API Gateway.| -|`protectionDomain`|`string`|The name of the ScaleIO Protection Domain for the configured storage.+optional| -|`readOnly`|`boolean`|Defaults to false (read/write). ReadOnly here will forcethe ReadOnly setting in VolumeMounts.+optional| +|`protectionDomain`|`string`|The name of the ScaleIO Protection Domain for the configured storage.| +|`readOnly`|`boolean`|Defaults to false (read/write). ReadOnly here will forcethe ReadOnly setting in VolumeMounts.| |`secretRef`|[`LocalObjectReference`](#localobjectreference)|SecretRef references to the secret for ScaleIO user and othersensitive information. If this is not provided, Login operation will fail.| -|`sslEnabled`|`boolean`|Flag to enable/disable SSL communication with Gateway, default false+optional| -|`storageMode`|`string`|Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.Default is ThinProvisioned.+optional| -|`storagePool`|`string`|The ScaleIO Storage Pool associated with the protection domain.+optional| +|`sslEnabled`|`boolean`|Flag to enable/disable SSL communication with Gateway, default false| +|`storageMode`|`string`|Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.Default is ThinProvisioned.| +|`storagePool`|`string`|The ScaleIO Storage Pool associated with the protection domain.| |`system`|`string`|The name of the storage system as configured in ScaleIO.| |`volumeName`|`string`|The name of a volume already created in the ScaleIO systemthat is associated with this volume source.| @@ -4678,10 +4679,10 @@ Adapts a Secret into a volume.The contents of the target Secret's Data field wil ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`defaultMode`|`int32`|Optional: mode bits to use on created files by default. Must be avalue between 0 and 0777. Defaults to 0644.Directories within the path are not affected by this setting.This might be in conflict with other options that affect the filemode, like fsGroup, and the result can be other mode bits set.+optional| -|`items`|`Array<`[`KeyToPath`](#keytopath)`>`|If unspecified, each key-value pair in the Data field of the referencedSecret will be projected into the volume as a file whose name is thekey and content is the value. If specified, the listed keys will beprojected into the specified paths, and unlisted keys will not bepresent. If a key is specified which is not present in the Secret,the volume setup will error unless it is marked optional. Paths must berelative and may not contain the '..' path or start with '..'.+optional| -|`optional`|`boolean`|Specify whether the Secret or its keys must be defined+optional| -|`secretName`|`string`|Name of the secret in the pod's namespace to use.More info: https://kubernetes.io/docs/concepts/storage/volumes#secret+optional| +|`defaultMode`|`int32`|Optional: mode bits to use on created files by default. Must be avalue between 0 and 0777. Defaults to 0644.Directories within the path are not affected by this setting.This might be in conflict with other options that affect the filemode, like fsGroup, and the result can be other mode bits set.| +|`items`|`Array<`[`KeyToPath`](#keytopath)`>`|If unspecified, each key-value pair in the Data field of the referencedSecret will be projected into the volume as a file whose name is thekey and content is the value. If specified, the listed keys will beprojected into the specified paths, and unlisted keys will not bepresent. If a key is specified which is not present in the Secret,the volume setup will error unless it is marked optional. Paths must berelative and may not contain the '..' path or start with '..'.| +|`optional`|`boolean`|Specify whether the Secret or its keys must be defined| +|`secretName`|`string`|Name of the secret in the pod's namespace to use.More info: https://kubernetes.io/docs/concepts/storage/volumes#secret| ## StorageOSVolumeSource @@ -4690,11 +4691,11 @@ Represents a StorageOS persistent volume resource. ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`fsType`|`string`|Filesystem type to mount.Must be a filesystem type supported by the host operating system.Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.+optional| -|`readOnly`|`boolean`|Defaults to false (read/write). ReadOnly here will forcethe ReadOnly setting in VolumeMounts.+optional| -|`secretRef`|[`LocalObjectReference`](#localobjectreference)|SecretRef specifies the secret to use for obtaining the StorageOS APIcredentials. If not specified, default values will be attempted.+optional| +|`fsType`|`string`|Filesystem type to mount.Must be a filesystem type supported by the host operating system.Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.| +|`readOnly`|`boolean`|Defaults to false (read/write). ReadOnly here will forcethe ReadOnly setting in VolumeMounts.| +|`secretRef`|[`LocalObjectReference`](#localobjectreference)|SecretRef specifies the secret to use for obtaining the StorageOS APIcredentials. If not specified, default values will be attempted.| |`volumeName`|`string`|VolumeName is the human-readable name of the StorageOS volume. Volumenames are only unique within a namespace.| -|`volumeNamespace`|`string`|VolumeNamespace specifies the scope of the volume within StorageOS. If nonamespace is specified then the Pod's namespace will be used. This allows theKubernetes name scoping to be mirrored within StorageOS for tighter integration.Set VolumeName to any name to override the default behaviour.Set to "default" if you are not using namespaces within StorageOS.Namespaces that do not pre-exist within StorageOS will be created.+optional| +|`volumeNamespace`|`string`|VolumeNamespace specifies the scope of the volume within StorageOS. If nonamespace is specified then the Pod's namespace will be used. This allows theKubernetes name scoping to be mirrored within StorageOS for tighter integration.Set VolumeName to any name to override the default behaviour.Set to "default" if you are not using namespaces within StorageOS.Namespaces that do not pre-exist within StorageOS will be created.| ## VsphereVirtualDiskVolumeSource @@ -4703,9 +4704,9 @@ Represents a vSphere volume resource. ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`fsType`|`string`|Filesystem type to mount.Must be a filesystem type supported by the host operating system.Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.+optional| -|`storagePolicyID`|`string`|Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.+optional| -|`storagePolicyName`|`string`|Storage Policy Based Management (SPBM) profile name.+optional| +|`fsType`|`string`|Filesystem type to mount.Must be a filesystem type supported by the host operating system.Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.| +|`storagePolicyID`|`string`|Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.| +|`storagePolicyName`|`string`|Storage Policy Based Management (SPBM) profile name.| |`volumePath`|`string`|Path that identifies vSphere volume vmdk| ## EnvVarSource @@ -4715,38 +4716,38 @@ EnvVarSource represents a source for the value of an EnvVar. Examples with this field (click to open)
-- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) - -- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) - -- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) +- [`global-outputs.yaml`](../examples/global-outputs.yaml) - [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) -- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) +- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) + +- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) - [`output-parameter.yaml`](../examples/output-parameter.yaml) -- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) +- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) -- [`secrets.yaml`](../examples/secrets.yaml) +- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) -- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) +- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) -- [`global-outputs.yaml`](../examples/global-outputs.yaml) +- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) -- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) +- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) -- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) +- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) + +- [`secrets.yaml`](../examples/secrets.yaml) ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`configMapKeyRef`|[`ConfigMapKeySelector`](#configmapkeyselector)|Selects a key of a ConfigMap.+optional| -|`fieldRef`|[`ObjectFieldSelector`](#objectfieldselector)|Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations,spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP.+optional| -|`resourceFieldRef`|[`ResourceFieldSelector`](#resourcefieldselector)|Selects a resource of the container: only resources limits and requests(limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.+optional| -|`secretKeyRef`|[`SecretKeySelector`](#secretkeyselector)|Selects a key of a secret in the pod's namespace+optional| +|`configMapKeyRef`|[`ConfigMapKeySelector`](#configmapkeyselector)|Selects a key of a ConfigMap.| +|`fieldRef`|[`ObjectFieldSelector`](#objectfieldselector)|Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations,spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP.| +|`resourceFieldRef`|[`ResourceFieldSelector`](#resourcefieldselector)|Selects a resource of the container: only resources limits and requests(limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.| +|`secretKeyRef`|[`SecretKeySelector`](#secretkeyselector)|Selects a key of a secret in the pod's namespace| ## ConfigMapEnvSource @@ -4756,7 +4757,7 @@ ConfigMapEnvSource selects a ConfigMap to populate the environmentvariables with | Field Name | Field Type | Description | |:----------:|:----------:|---------------| |`localObjectReference`|[`LocalObjectReference`](#localobjectreference)|The ConfigMap to select from.| -|`optional`|`boolean`|Specify whether the ConfigMap must be defined+optional| +|`optional`|`boolean`|Specify whether the ConfigMap must be defined| ## SecretEnvSource @@ -4766,7 +4767,7 @@ SecretEnvSource selects a Secret to populate the environmentvariables with.The c | Field Name | Field Type | Description | |:----------:|:----------:|---------------| |`localObjectReference`|[`LocalObjectReference`](#localobjectreference)|The Secret to select from.| -|`optional`|`boolean`|Specify whether the Secret must be defined+optional| +|`optional`|`boolean`|Specify whether the Secret must be defined| ## Handler @@ -4775,9 +4776,9 @@ Handler defines a specific action that should be takenTODO: pass structured data ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`exec`|[`ExecAction`](#execaction)|One and only one of the following should be specified.Exec specifies the action to take.+optional| -|`httpGet`|[`HTTPGetAction`](#httpgetaction)|HTTPGet specifies the http request to perform.+optional| -|`tcpSocket`|[`TCPSocketAction`](#tcpsocketaction)|TCPSocket specifies an action involving a TCP port.TCP hooks not yet supportedTODO: implement a realistic TCP lifecycle hook+optional| +|`exec`|[`ExecAction`](#execaction)|One and only one of the following should be specified.Exec specifies the action to take.| +|`httpGet`|[`HTTPGetAction`](#httpgetaction)|HTTPGet specifies the http request to perform.| +|`tcpSocket`|[`TCPSocketAction`](#tcpsocketaction)|TCPSocket specifies an action involving a TCP port.TCP hooks not yet supportedTODO: implement a realistic TCP lifecycle hook| ## Capabilities @@ -4786,8 +4787,8 @@ Adds and removes POSIX capabilities from running containers. ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`add`|`Array< string >`|Added capabilities+optional| -|`drop`|`Array< string >`|Removed capabilities+optional| +|`add`|`Array< string >`|Added capabilities| +|`drop`|`Array< string >`|Removed capabilities| ## NodeSelectorTerm @@ -4796,8 +4797,8 @@ A null or empty node selector term matches no objects. The requirements ofthem a ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`matchExpressions`|`Array<`[`NodeSelectorRequirement`](#nodeselectorrequirement)`>`|A list of node selector requirements by node's labels.+optional| -|`matchFields`|`Array<`[`NodeSelectorRequirement`](#nodeselectorrequirement)`>`|A list of node selector requirements by node's fields.+optional| +|`matchExpressions`|`Array<`[`NodeSelectorRequirement`](#nodeselectorrequirement)`>`|A list of node selector requirements by node's labels.| +|`matchFields`|`Array<`[`NodeSelectorRequirement`](#nodeselectorrequirement)`>`|A list of node selector requirements by node's fields.| ## KeyToPath @@ -4807,7 +4808,7 @@ Maps a string key to a path within a volume. | Field Name | Field Type | Description | |:----------:|:----------:|---------------| |`key`|`string`|The key to project.| -|`mode`|`int32`|Optional: mode bits to use on this file, must be a value between 0and 0777. If not specified, the volume defaultMode will be used.This might be in conflict with other options that affect the filemode, like fsGroup, and the result can be other mode bits set.+optional| +|`mode`|`int32`|Optional: mode bits to use on this file, must be a value between 0and 0777. If not specified, the volume defaultMode will be used.This might be in conflict with other options that affect the filemode, like fsGroup, and the result can be other mode bits set.| |`path`|`string`|The relative path of the file to map the key to.May not be an absolute path.May not contain the path element '..'.May not start with the string '..'.| ## DownwardAPIVolumeFile @@ -4817,10 +4818,10 @@ DownwardAPIVolumeFile represents information to create the file containing the p ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`fieldRef`|[`ObjectFieldSelector`](#objectfieldselector)|Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.+optional| -|`mode`|`int32`|Optional: mode bits to use on this file, must be a value between 0and 0777. If not specified, the volume defaultMode will be used.This might be in conflict with other options that affect the filemode, like fsGroup, and the result can be other mode bits set.+optional| +|`fieldRef`|[`ObjectFieldSelector`](#objectfieldselector)|Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.| +|`mode`|`int32`|Optional: mode bits to use on this file, must be a value between 0and 0777. If not specified, the volume defaultMode will be used.This might be in conflict with other options that affect the filemode, like fsGroup, and the result can be other mode bits set.| |`path`|`string`|Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'| -|`resourceFieldRef`|[`ResourceFieldSelector`](#resourcefieldselector)|Selects a resource of the container: only resources limits and requests(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.+optional| +|`resourceFieldRef`|[`ResourceFieldSelector`](#resourcefieldselector)|Selects a resource of the container: only resources limits and requests(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.| ## VolumeProjection @@ -4829,10 +4830,10 @@ Projection that may be projected along with other supported volume types ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`configMap`|[`ConfigMapProjection`](#configmapprojection)|information about the configMap data to project+optional| -|`downwardAPI`|[`DownwardAPIProjection`](#downwardapiprojection)|information about the downwardAPI data to project+optional| -|`secret`|[`SecretProjection`](#secretprojection)|information about the secret data to project+optional| -|`serviceAccountToken`|[`ServiceAccountTokenProjection`](#serviceaccounttokenprojection)|information about the serviceAccountToken data to project+optional| +|`configMap`|[`ConfigMapProjection`](#configmapprojection)|information about the configMap data to project| +|`downwardAPI`|[`DownwardAPIProjection`](#downwardapiprojection)|information about the downwardAPI data to project| +|`secret`|[`SecretProjection`](#secretprojection)|information about the secret data to project| +|`serviceAccountToken`|[`ServiceAccountTokenProjection`](#serviceaccounttokenprojection)|information about the serviceAccountToken data to project| ## ObjectFieldSelector @@ -4841,7 +4842,7 @@ ObjectFieldSelector selects an APIVersioned field of an object. ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`apiVersion`|`string`|Version of the schema the FieldPath is written in terms of, defaults to "v1".+optional| +|`apiVersion`|`string`|Version of the schema the FieldPath is written in terms of, defaults to "v1".| |`fieldPath`|`string`|Path of the field to select in the specified API version.| ## ResourceFieldSelector @@ -4851,8 +4852,8 @@ ResourceFieldSelector represents container resources (cpu, memory) and their out ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`containerName`|`string`|Container name: required for volumes, optional for env vars+optional| -|`divisor`|[`Quantity`](#quantity)|Specifies the output format of the exposed resources, defaults to "1"+optional| +|`containerName`|`string`|Container name: required for volumes, optional for env vars| +|`divisor`|[`Quantity`](#quantity)|Specifies the output format of the exposed resources, defaults to "1"| |`resource`|`string`|Required: resource to select| ## ExecAction @@ -4862,7 +4863,7 @@ ExecAction describes a "run in container" action. ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`command`|`Array< string >`|Command is the command line to execute inside the container, the working directory for thecommand is root ('/') in the container's filesystem. The command is simply exec'd, it isnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To usea shell, you need to explicitly call out to that shell.Exit status of 0 is treated as live/healthy and non-zero is unhealthy.+optional| +|`command`|`Array< string >`|Command is the command line to execute inside the container, the working directory for thecommand is root ('/') in the container's filesystem. The command is simply exec'd, it isnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To usea shell, you need to explicitly call out to that shell.Exit status of 0 is treated as live/healthy and non-zero is unhealthy.| ## HTTPGetAction @@ -4871,23 +4872,23 @@ HTTPGetAction describes an action based on HTTP Get requests. Examples with this field (click to open)
+- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) + - [`daemon-step.yaml`](../examples/daemon-step.yaml) - [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) -- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) - - [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`host`|`string`|Host name to connect to, defaults to the pod IP. You probably want to set"Host" in httpHeaders instead.+optional| -|`httpHeaders`|`Array<`[`HTTPHeader`](#httpheader)`>`|Custom headers to set in the request. HTTP allows repeated headers.+optional| -|`path`|`string`|Path to access on the HTTP server.+optional| +|`host`|`string`|Host name to connect to, defaults to the pod IP. You probably want to set"Host" in httpHeaders instead.| +|`httpHeaders`|`Array<`[`HTTPHeader`](#httpheader)`>`|Custom headers to set in the request. HTTP allows repeated headers.| +|`path`|`string`|Path to access on the HTTP server.| |`port`|[`IntOrString`](#intorstring)|Name or number of the port to access on the container.Number must be in the range 1 to 65535.Name must be an IANA_SVC_NAME.| -|`scheme`|`string`|Scheme to use for connecting to the host.Defaults to HTTP.+optional| +|`scheme`|`string`|Scheme to use for connecting to the host.Defaults to HTTP.| ## TCPSocketAction @@ -4896,7 +4897,7 @@ TCPSocketAction describes an action based on opening a socket ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`host`|`string`|Optional: Host name to connect to, defaults to the pod IP.+optional| +|`host`|`string`|Optional: Host name to connect to, defaults to the pod IP.| |`port`|[`IntOrString`](#intorstring)|Number or name of the port to access on the container.Number must be in the range 1 to 65535.Name must be an IANA_SVC_NAME.| ## NodeSelectorRequirement @@ -4908,7 +4909,7 @@ A node selector requirement is a selector that contains values, a key, and an op |:----------:|:----------:|---------------| |`key`|`string`|The label key that the selector applies to.| |`operator`|`string`|Represents a key's relationship to a set of values.Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.| -|`values`|`Array< string >`|An array of string values. If the operator is In or NotIn,the values array must be non-empty. If the operator is Exists or DoesNotExist,the values array must be empty. If the operator is Gt or Lt, the valuesarray must have a single element, which will be interpreted as an integer.This array is replaced during a strategic merge patch.+optional| +|`values`|`Array< string >`|An array of string values. If the operator is In or NotIn,the values array must be non-empty. If the operator is Exists or DoesNotExist,the values array must be empty. If the operator is Gt or Lt, the valuesarray must have a single element, which will be interpreted as an integer.This array is replaced during a strategic merge patch.| ## ConfigMapProjection @@ -4917,9 +4918,9 @@ Adapts a ConfigMap into a projected volume.The contents of the target ConfigMap' ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`items`|`Array<`[`KeyToPath`](#keytopath)`>`|If unspecified, each key-value pair in the Data field of the referencedConfigMap will be projected into the volume as a file whose name is thekey and content is the value. If specified, the listed keys will beprojected into the specified paths, and unlisted keys will not bepresent. If a key is specified which is not present in the ConfigMap,the volume setup will error unless it is marked optional. Paths must berelative and may not contain the '..' path or start with '..'.+optional| +|`items`|`Array<`[`KeyToPath`](#keytopath)`>`|If unspecified, each key-value pair in the Data field of the referencedConfigMap will be projected into the volume as a file whose name is thekey and content is the value. If specified, the listed keys will beprojected into the specified paths, and unlisted keys will not bepresent. If a key is specified which is not present in the ConfigMap,the volume setup will error unless it is marked optional. Paths must berelative and may not contain the '..' path or start with '..'.| |`localObjectReference`|[`LocalObjectReference`](#localobjectreference)|_No desription available_| -|`optional`|`boolean`|Specify whether the ConfigMap or its keys must be defined+optional| +|`optional`|`boolean`|Specify whether the ConfigMap or its keys must be defined| ## DownwardAPIProjection @@ -4928,7 +4929,7 @@ Represents downward API info for projecting into a projected volume.Note that th ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`items`|`Array<`[`DownwardAPIVolumeFile`](#downwardapivolumefile)`>`|Items is a list of DownwardAPIVolume file+optional| +|`items`|`Array<`[`DownwardAPIVolumeFile`](#downwardapivolumefile)`>`|Items is a list of DownwardAPIVolume file| ## SecretProjection @@ -4943,9 +4944,9 @@ Adapts a secret into a projected volume.The contents of the target Secret's Data ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`items`|`Array<`[`KeyToPath`](#keytopath)`>`|If unspecified, each key-value pair in the Data field of the referencedSecret will be projected into the volume as a file whose name is thekey and content is the value. If specified, the listed keys will beprojected into the specified paths, and unlisted keys will not bepresent. If a key is specified which is not present in the Secret,the volume setup will error unless it is marked optional. Paths must berelative and may not contain the '..' path or start with '..'.+optional| +|`items`|`Array<`[`KeyToPath`](#keytopath)`>`|If unspecified, each key-value pair in the Data field of the referencedSecret will be projected into the volume as a file whose name is thekey and content is the value. If specified, the listed keys will beprojected into the specified paths, and unlisted keys will not bepresent. If a key is specified which is not present in the Secret,the volume setup will error unless it is marked optional. Paths must berelative and may not contain the '..' path or start with '..'.| |`localObjectReference`|[`LocalObjectReference`](#localobjectreference)|_No desription available_| -|`optional`|`boolean`|Specify whether the Secret or its key must be defined+optional| +|`optional`|`boolean`|Specify whether the Secret or its key must be defined| ## ServiceAccountTokenProjection @@ -4954,8 +4955,8 @@ ServiceAccountTokenProjection represents a projected service account tokenvolume ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`audience`|`string`|Audience is the intended audience of the token. A recipient of a tokenmust identify itself with an identifier specified in the audience of thetoken, and otherwise should reject the token. The audience defaults to theidentifier of the apiserver.+optional| -|`expirationSeconds`|`int64`|ExpirationSeconds is the requested duration of validity of the serviceaccount token. As the token approaches expiration, the kubelet volumeplugin will proactively rotate the service account token. The kubelet willstart trying to rotate the token if the token is older than 80 percent ofits time to live or if the token is older than 24 hours.Defaults to 1 hourand must be at least 10 minutes.+optional| +|`audience`|`string`|Audience is the intended audience of the token. A recipient of a tokenmust identify itself with an identifier specified in the audience of thetoken, and otherwise should reject the token. The audience defaults to theidentifier of the apiserver.| +|`expirationSeconds`|`int64`|ExpirationSeconds is the requested duration of validity of the serviceaccount token. As the token approaches expiration, the kubelet volumeplugin will proactively rotate the service account token. The kubelet willstart trying to rotate the token if the token is older than 80 percent ofits time to live or if the token is older than 24 hours.Defaults to 1 hourand must be at least 10 minutes.| |`path`|`string`|Path is the path relative to the mount point of the file to project thetoken into.| ## HTTPHeader diff --git a/hack/docgen.py b/hack/docgen.py new file mode 100644 index 000000000000..c767a679573c --- /dev/null +++ b/hack/docgen.py @@ -0,0 +1,239 @@ +import json +import re +from pathlib import Path + +SECTION_HEADER = """ + +# %s +""" + +FIELD_HEADER = """ + +## %s + +%s""" + +FIELD_TABLE_HEADER = """ + +### Fields +| Field Name | Field Type | Description | +|:----------:|:----------:|---------------|""" + +TABLE_ROW = """ +|`%s`|%s|%s|""" + +DEP_TABLE_ROW = """ +|~`%s`~|~%s~|%s|""" + +DROPDOWN_OPENER = """ +
+%s (click to open) +
""" + +LIST_ELEMENT = """ + +- %s""" + +DROPDOWN_CLOSER = """ +
""" + + +def clean_title(title): + if "\n+" in title: + return title[:title.find("\n+")] + return title + + +def clean_desc(desc): + desc = desc.replace("\n", "") + dep = "" + if 'DEPRECATED' in desc: + dep = " " + desc[desc.find("DEPRECATED"):] + + if '+patch' in desc: + desc = desc[:desc.find("+patch")] + if '+proto' in desc: + desc = desc[:desc.find("+proto")] + if '+option' in desc: + desc = desc[:desc.find("+option")] + + if dep != "" and 'DEPRECATED' not in desc: + desc += dep + return desc + + +def get_row(name, _type, desc): + if 'DEPRECATED' in desc: + dep = desc.find('DEPRECATED') + return DEP_TABLE_ROW % (name, _type, "~" + desc[:dep] + "~ " + desc[dep:]) + else: + return TABLE_ROW % (name, _type, desc) + + +def get_name_from_full_name(ref): + return ref.split('.')[-1] + + +def get_desc(key, defs): + if 'description' in defs[key]: + return clean_desc(defs[key]['description']) + elif 'title' in defs[key]: + return clean_desc(clean_title(defs[key]['title'])) + return "_No description available_" + + +def link(text, link_to): + return "[%s](%s)" % (text, link_to) + + +def get_desc_from_field(field): + if 'description' in field: + return field['description'] + elif 'title' in field: + return field['title'] + return "_No desription available_" + + +def get_examples(examples, summary): + out = DROPDOWN_OPENER % summary + for example in examples: + name = example.split("/")[-1] + out += LIST_ELEMENT % link("`%s`" % name, "../" + example) + out += DROPDOWN_CLOSER + return out + + +def get_key_value_field_types(field): + key_type, val_type = "string", "string" + if 'type' in field['additionalProperties']: + key_type = field['additionalProperties']['type'] + if 'format' in field['additionalProperties']: + val_type = field['additionalProperties']['format'] + return key_type, val_type + + +def get_object_type(field, json_field_name, add_to_queue): + obj_type_raw = field['type'] + if obj_type_raw == "array": + if '$ref' in field['items']: + ref = field['items']['$ref'][14:] + add_to_queue(ref, json_field_name) + + if ref == "io.argoproj.workflow.v1alpha1.WorkflowStep": + return "`Array>`" % link("`%s`" % get_name_from_full_name(ref), + "#" + get_name_from_full_name(ref).lower()) + + return "`Array<`%s`>`" % link("`%s`" % get_name_from_full_name(ref), + "#" + get_name_from_full_name(ref).lower()) + + return "`Array< %s >`" % get_name_from_full_name(field['items']['type']) + + elif obj_type_raw == "object": + if '$ref' in field['additionalProperties']: + ref = field['additionalProperties']['$ref'][14:] + add_to_queue(ref, json_field_name) + return link("`%s`" % get_name_from_full_name(ref), "#" + get_name_from_full_name(ref).lower()) + + else: + return "`Map< %s , %s >`" % get_key_value_field_types(field) + + elif 'format' in field: + return "`%s`" % field['format'] + + return "`%s`" % field['type'] + + +class DocGeneratorContext: + + def __init__(self): + self.defs = {} + self.completed_fields = set() + self.json_name = {} + self.queue = ['io.argoproj.workflow.v1alpha1.Workflow', 'io.argoproj.workflow.v1alpha1.CronWorkflow', + 'io.argoproj.workflow.v1alpha1.WorkflowTemplate'] + self.external = [] + self.index = {} + + def run(self): + self.load_files() + + out = SECTION_HEADER % "Argo Fields" + while self.queue: + out += self.get_template(self.queue.pop(0)) + + out += SECTION_HEADER % "External Fields" + while self.external: + out += self.get_template(self.external.pop(0)) + + return out + + def load_files(self): + with open('api/openapi-spec/swagger.json') as swagger: + s = json.load(swagger) + self.defs = s['definitions'] + + for file_name_poisx in Path('examples').rglob('*.yaml'): + file_name = str(file_name_poisx) + with open(file_name) as wf: + wf_text = wf.read() + kinds = re.findall(r"kind: ([a-zA-Z]+)", wf_text) + for kind in kinds: + if kind not in self.index: + self.index[kind] = set() + self.index[kind].add(file_name) + + finds = re.findall(r"([a-zA-Z]+?):", wf_text) + for find in finds: + if find not in self.index: + self.index[find] = set() + self.index[find].add(file_name) + + def add_to_queue(self, ref, json_field_name): + if ref == "io.argoproj.workflow.v1alpha1.ParallelSteps": + ref = "io.argoproj.workflow.v1alpha1.WorkflowStep" + if ref not in self.completed_fields: + self.completed_fields.add(ref) + self.json_name[ref] = json_field_name + if "io.argoproj.workflow" in ref: + self.queue.append(ref) + else: + self.external.append(ref) + + def get_template(self, key): + out = FIELD_HEADER % (get_name_from_full_name(key), get_desc(key, self.defs)) + + if get_name_from_full_name(key) in self.index: + out += get_examples(self.index[get_name_from_full_name(key)], "Examples") + + if key in self.json_name and self.json_name[key] in self.index: + out += get_examples(self.index[self.json_name[key]], "Examples with this field") + + if 'properties' not in self.defs[key]: + return out + + out += FIELD_TABLE_HEADER + for json_field_name, field in self.defs[key]['properties'].items(): + if '$ref' in field: + + ref = field['$ref'][14:] + self.add_to_queue(ref, json_field_name) + + desc = get_desc_from_field(field) + out += get_row(json_field_name, + link("`%s`" % get_name_from_full_name(ref), "#" + get_name_from_full_name(ref).lower()), + clean_desc(desc)) + + else: + obj_type = get_object_type(field, json_field_name, lambda r, j: self.add_to_queue(r, j)) + desc = get_desc_from_field(field) + + out += get_row(json_field_name, obj_type, clean_desc(desc)) + + return out + +# This file should be run with `make docs` on the root directory + +ctx = DocGeneratorContext() +fields = ctx.run() +with open('docs/fields.md', 'w') as file: + file.write(fields) From 6c3896b95634617f457759f15ae26e85b5443a62 Mon Sep 17 00:00:00 2001 From: Simon Behar Date: Thu, 9 Apr 2020 10:35:10 -0700 Subject: [PATCH 2/4] Python -> Go --- Makefile | 2 +- docs/fields.md | 2764 +++++++++++++++++++++++++----------------------- hack/docgen.go | 344 ++++++ hack/docgen.py | 239 ----- hack/main.go | 10 + 5 files changed, 1772 insertions(+), 1587 deletions(-) create mode 100644 hack/docgen.go delete mode 100644 hack/docgen.py create mode 100644 hack/main.go diff --git a/Makefile b/Makefile index 441934714b6a..72c3de7a71fa 100644 --- a/Makefile +++ b/Makefile @@ -455,7 +455,7 @@ api/openapi-spec/swagger.json: $(HOME)/go/bin/swagger $(SWAGGER_FILES) dist/MANI .PHONY: docs docs: api/openapi-spec/swagger.json - python3 ./hack/docgen.py + go run ./hack docgen # pre-push diff --git a/docs/fields.md b/docs/fields.md index 6d08cfbda915..fe70eedd6aec 100644 --- a/docs/fields.md +++ b/docs/fields.md @@ -1,3 +1,4 @@ +go run ./hack docgen # Argo Fields @@ -6,225 +7,227 @@ ## Workflow Workflow is the definition of a workflow resource +
Examples (click to open)
-- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) +- [`archive-location.yaml`](../examples/archive-location.yaml) -- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) +- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) -- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) +- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) -- [`retry-container-to-completion.yaml`](../examples/retry-container-to-completion.yaml) +- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) -- [`coinflip.yaml`](../examples/coinflip.yaml) +- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) -- [`init-container.yaml`](../examples/init-container.yaml) +- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) -- [`coinflip-recursive.yaml`](../examples/coinflip-recursive.yaml) +- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) -- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) +- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) -- [`steps.yaml`](../examples/workflow-template/steps.yaml) +- [`ci.yaml`](../examples/ci.yaml) -- [`suspend-template.yaml`](../examples/suspend-template.yaml) +- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) -- [`dag.yaml`](../examples/workflow-template/dag.yaml) +- [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) -- [`sidecar-dind.yaml`](../examples/sidecar-dind.yaml) +- [`coinflip-recursive.yaml`](../examples/coinflip-recursive.yaml) -- [`retry-script.yaml`](../examples/retry-script.yaml) +- [`coinflip.yaml`](../examples/coinflip.yaml) -- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) +- [`conditionals.yaml`](../examples/conditionals.yaml) -- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) +- [`continue-on-fail.yaml`](../examples/continue-on-fail.yaml) -- [`node-selector.yaml`](../examples/node-selector.yaml) +- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) -- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) +- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) -- [`retry-on-error.yaml`](../examples/retry-on-error.yaml) +- [`daemon-step.yaml`](../examples/daemon-step.yaml) -- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) +- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) -- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) +- [`dag-continue-on-fail.yaml`](../examples/dag-continue-on-fail.yaml) -- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) +- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) -- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) +- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) -- [`gc-ttl.yaml`](../examples/gc-ttl.yaml) +- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) -- [`loops-dag.yaml`](../examples/loops-dag.yaml) +- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) -- [`output-parameter.yaml`](../examples/output-parameter.yaml) +- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) -- [`resubmit.yaml`](../examples/resubmit.yaml) +- [`dag-nested.yaml`](../examples/dag-nested.yaml) -- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) +- [`dag-targets.yaml`](../examples/dag-targets.yaml) -- [`image-pull-secrets.yaml`](../examples/image-pull-secrets.yaml) +- [`default-pdb-support.yaml`](../examples/default-pdb-support.yaml) -- [`dag-nested.yaml`](../examples/dag-nested.yaml) +- [`dns-config.yaml`](../examples/dns-config.yaml) -- [`volumes-emptydir.yaml`](../examples/volumes-emptydir.yaml) +- [`exit-handlers.yaml`](../examples/exit-handlers.yaml) -- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) +- [`forever.yaml`](../examples/forever.yaml) -- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) +- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) -- [`pod-spec-patch.yaml`](../examples/pod-spec-patch.yaml) +- [`gc-ttl.yaml`](../examples/gc-ttl.yaml) -- [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) +- [`global-outputs.yaml`](../examples/global-outputs.yaml) -- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) +- [`global-parameters.yaml`](../examples/global-parameters.yaml) -- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) +- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) -- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) +- [`hello-world.yaml`](../examples/hello-world.yaml) -- [`parallelism-limit.yaml`](../examples/parallelism-limit.yaml) +- [`image-pull-secrets.yaml`](../examples/image-pull-secrets.yaml) -- [`archive-location.yaml`](../examples/archive-location.yaml) +- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) -- [`timeouts-workflow.yaml`](../examples/timeouts-workflow.yaml) +- [`init-container.yaml`](../examples/init-container.yaml) -- [`timeouts-step.yaml`](../examples/timeouts-step.yaml) +- [`input-artifact-gcs.yaml`](../examples/input-artifact-gcs.yaml) -- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) +- [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) -- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) +- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) -- [`loops.yaml`](../examples/loops.yaml) +- [`input-artifact-oss.yaml`](../examples/input-artifact-oss.yaml) -- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) +- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) -- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) +- [`input-artifact-s3.yaml`](../examples/input-artifact-s3.yaml) -- [`input-artifact-oss.yaml`](../examples/input-artifact-oss.yaml) +- [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) -- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) +- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) -- [`exit-handlers.yaml`](../examples/exit-handlers.yaml) +- [`k8s-owner-reference.yaml`](../examples/k8s-owner-reference.yaml) -- [`global-parameters.yaml`](../examples/global-parameters.yaml) +- [`k8s-set-owner-reference.yaml`](../examples/k8s-set-owner-reference.yaml) -- [`global-outputs.yaml`](../examples/global-outputs.yaml) +- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) -- [`ci.yaml`](../examples/ci.yaml) +- [`loops-dag.yaml`](../examples/loops-dag.yaml) -- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) +- [`loops-maps.yaml`](../examples/loops-maps.yaml) -- [`k8s-owner-reference.yaml`](../examples/k8s-owner-reference.yaml) +- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) -- [`retry-with-steps.yaml`](../examples/retry-with-steps.yaml) +- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) -- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) +- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) -- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) +- [`loops.yaml`](../examples/loops.yaml) -- [`retry-backoff.yaml`](../examples/retry-backoff.yaml) +- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) -- [`default-pdb-support.yaml`](../examples/default-pdb-support.yaml) +- [`node-selector.yaml`](../examples/node-selector.yaml) -- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) +- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) -- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) +- [`output-parameter.yaml`](../examples/output-parameter.yaml) -- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) +- [`parallelism-limit.yaml`](../examples/parallelism-limit.yaml) -- [`status-reference.yaml`](../examples/status-reference.yaml) +- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) -- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) +- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) - [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) -- [`pod-gc-strategy.yaml`](../examples/pod-gc-strategy.yaml) - -- [`continue-on-fail.yaml`](../examples/continue-on-fail.yaml) +- [`parallelism-template-limit.yaml`](../examples/parallelism-template-limit.yaml) -- [`hello-world.yaml`](../examples/hello-world.yaml) +- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) -- [`sidecar.yaml`](../examples/sidecar.yaml) +- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) -- [`loops-maps.yaml`](../examples/loops-maps.yaml) +- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) -- [`sidecar-nginx.yaml`](../examples/sidecar-nginx.yaml) +- [`pod-gc-strategy.yaml`](../examples/pod-gc-strategy.yaml) -- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) +- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) -- [`template-on-exit.yaml`](../examples/template-on-exit.yaml) +- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) -- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) +- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) -- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) +- [`pod-spec-patch.yaml`](../examples/pod-spec-patch.yaml) -- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) +- [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) -- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) +- [`resubmit.yaml`](../examples/resubmit.yaml) -- [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) +- [`retry-backoff.yaml`](../examples/retry-backoff.yaml) -- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) +- [`retry-container-to-completion.yaml`](../examples/retry-container-to-completion.yaml) -- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) +- [`retry-container.yaml`](../examples/retry-container.yaml) -- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) +- [`retry-on-error.yaml`](../examples/retry-on-error.yaml) -- [`dag-targets.yaml`](../examples/dag-targets.yaml) +- [`retry-script.yaml`](../examples/retry-script.yaml) -- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) +- [`retry-with-steps.yaml`](../examples/retry-with-steps.yaml) -- [`scripts-python.yaml`](../examples/scripts-python.yaml) +- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) -- [`dns-config.yaml`](../examples/dns-config.yaml) +- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) -- [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) +- [`scripts-python.yaml`](../examples/scripts-python.yaml) -- [`daemon-step.yaml`](../examples/daemon-step.yaml) +- [`secrets.yaml`](../examples/secrets.yaml) -- [`parallelism-template-limit.yaml`](../examples/parallelism-template-limit.yaml) +- [`sidecar-dind.yaml`](../examples/sidecar-dind.yaml) -- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) +- [`sidecar-nginx.yaml`](../examples/sidecar-nginx.yaml) -- [`k8s-set-owner-reference.yaml`](../examples/k8s-set-owner-reference.yaml) +- [`sidecar.yaml`](../examples/sidecar.yaml) -- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) +- [`status-reference.yaml`](../examples/status-reference.yaml) - [`steps.yaml`](../examples/steps.yaml) -- [`input-artifact-s3.yaml`](../examples/input-artifact-s3.yaml) +- [`suspend-template.yaml`](../examples/suspend-template.yaml) -- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) +- [`template-on-exit.yaml`](../examples/template-on-exit.yaml) -- [`retry-container.yaml`](../examples/retry-container.yaml) +- [`timeouts-step.yaml`](../examples/timeouts-step.yaml) -- [`forever.yaml`](../examples/forever.yaml) +- [`timeouts-workflow.yaml`](../examples/timeouts-workflow.yaml) -- [`dag-continue-on-fail.yaml`](../examples/dag-continue-on-fail.yaml) +- [`volumes-emptydir.yaml`](../examples/volumes-emptydir.yaml) -- [`secrets.yaml`](../examples/secrets.yaml) +- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) -- [`conditionals.yaml`](../examples/conditionals.yaml) +- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) -- [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) +- [`dag.yaml`](../examples/workflow-template/dag.yaml) + +- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) - [`retry-with-steps.yaml`](../examples/workflow-template/retry-with-steps.yaml) -- [`input-artifact-gcs.yaml`](../examples/input-artifact-gcs.yaml) +- [`steps.yaml`](../examples/workflow-template/steps.yaml)
### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`metadata`|[`ObjectMeta`](#objectmeta)|_No desription available_| -|`spec`|[`WorkflowSpec`](#workflowspec)|_No desription available_| -|`status`|[`WorkflowStatus`](#workflowstatus)|_No desription available_| +|`metadata`|[`ObjectMeta`](#objectmeta)|_No description available_| +|`spec`|[`WorkflowSpec`](#workflowspec)|_No description available_| +|`status`|[`WorkflowStatus`](#workflowstatus)|_No description available_| ## CronWorkflow CronWorkflow is the definition of a scheduled workflow resource +
Examples (click to open)
@@ -235,13 +238,14 @@ CronWorkflow is the definition of a scheduled workflow resource ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`metadata`|[`ObjectMeta`](#objectmeta)|_No desription available_| -|`spec`|[`CronWorkflowSpec`](#cronworkflowspec)|_No desription available_| -|`status`|[`CronWorkflowStatus`](#cronworkflowstatus)|_No desription available_| +|`metadata`|[`ObjectMeta`](#objectmeta)|_No description available_| +|`spec`|[`CronWorkflowSpec`](#cronworkflowspec)|_No description available_| +|`status`|[`CronWorkflowStatus`](#cronworkflowstatus)|_No description available_| ## WorkflowTemplate WorkflowTemplate is the definition of a workflow template resource +
Examples (click to open)
@@ -252,227 +256,228 @@ WorkflowTemplate is the definition of a workflow template resource ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`metadata`|[`ObjectMeta`](#objectmeta)|_No desription available_| -|`spec`|[`WorkflowTemplateSpec`](#workflowtemplatespec)|_No desription available_| +|`metadata`|[`ObjectMeta`](#objectmeta)|_No description available_| +|`spec`|[`WorkflowTemplateSpec`](#workflowtemplatespec)|_No description available_| ## WorkflowSpec WorkflowSpec is the specification of a Workflow. +
Examples with this field (click to open)
-- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) +- [`archive-location.yaml`](../examples/archive-location.yaml) -- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) +- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) -- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) +- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) -- [`retry-container-to-completion.yaml`](../examples/retry-container-to-completion.yaml) +- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) -- [`coinflip.yaml`](../examples/coinflip.yaml) +- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) -- [`init-container.yaml`](../examples/init-container.yaml) +- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) -- [`coinflip-recursive.yaml`](../examples/coinflip-recursive.yaml) +- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) -- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) +- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) -- [`steps.yaml`](../examples/workflow-template/steps.yaml) +- [`ci.yaml`](../examples/ci.yaml) -- [`suspend-template.yaml`](../examples/suspend-template.yaml) +- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) -- [`dag.yaml`](../examples/workflow-template/dag.yaml) +- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) -- [`sidecar-dind.yaml`](../examples/sidecar-dind.yaml) +- [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) -- [`retry-script.yaml`](../examples/retry-script.yaml) +- [`coinflip-recursive.yaml`](../examples/coinflip-recursive.yaml) -- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) +- [`coinflip.yaml`](../examples/coinflip.yaml) -- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) +- [`conditionals.yaml`](../examples/conditionals.yaml) -- [`node-selector.yaml`](../examples/node-selector.yaml) +- [`continue-on-fail.yaml`](../examples/continue-on-fail.yaml) -- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) +- [`cron-workflow.yaml`](../examples/cron-workflow.yaml) -- [`retry-on-error.yaml`](../examples/retry-on-error.yaml) +- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) -- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) +- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) -- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) +- [`daemon-step.yaml`](../examples/daemon-step.yaml) -- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) +- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) -- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) +- [`dag-continue-on-fail.yaml`](../examples/dag-continue-on-fail.yaml) -- [`gc-ttl.yaml`](../examples/gc-ttl.yaml) +- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) -- [`loops-dag.yaml`](../examples/loops-dag.yaml) +- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) -- [`output-parameter.yaml`](../examples/output-parameter.yaml) +- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) -- [`resubmit.yaml`](../examples/resubmit.yaml) +- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) -- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) - -- [`image-pull-secrets.yaml`](../examples/image-pull-secrets.yaml) +- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) - [`dag-nested.yaml`](../examples/dag-nested.yaml) -- [`volumes-emptydir.yaml`](../examples/volumes-emptydir.yaml) - -- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) +- [`dag-targets.yaml`](../examples/dag-targets.yaml) -- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) +- [`default-pdb-support.yaml`](../examples/default-pdb-support.yaml) -- [`pod-spec-patch.yaml`](../examples/pod-spec-patch.yaml) +- [`dns-config.yaml`](../examples/dns-config.yaml) -- [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) +- [`exit-handlers.yaml`](../examples/exit-handlers.yaml) -- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) +- [`forever.yaml`](../examples/forever.yaml) -- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) +- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) -- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) +- [`gc-ttl.yaml`](../examples/gc-ttl.yaml) -- [`parallelism-limit.yaml`](../examples/parallelism-limit.yaml) +- [`global-outputs.yaml`](../examples/global-outputs.yaml) -- [`archive-location.yaml`](../examples/archive-location.yaml) +- [`global-parameters.yaml`](../examples/global-parameters.yaml) -- [`timeouts-workflow.yaml`](../examples/timeouts-workflow.yaml) +- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) -- [`timeouts-step.yaml`](../examples/timeouts-step.yaml) +- [`hello-world.yaml`](../examples/hello-world.yaml) -- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) +- [`image-pull-secrets.yaml`](../examples/image-pull-secrets.yaml) -- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) +- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) -- [`loops.yaml`](../examples/loops.yaml) +- [`init-container.yaml`](../examples/init-container.yaml) -- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) +- [`input-artifact-gcs.yaml`](../examples/input-artifact-gcs.yaml) -- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) +- [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) -- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) +- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) - [`input-artifact-oss.yaml`](../examples/input-artifact-oss.yaml) -- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) +- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) -- [`exit-handlers.yaml`](../examples/exit-handlers.yaml) +- [`input-artifact-s3.yaml`](../examples/input-artifact-s3.yaml) -- [`global-parameters.yaml`](../examples/global-parameters.yaml) +- [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) -- [`global-outputs.yaml`](../examples/global-outputs.yaml) +- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) -- [`ci.yaml`](../examples/ci.yaml) +- [`k8s-owner-reference.yaml`](../examples/k8s-owner-reference.yaml) -- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) +- [`k8s-set-owner-reference.yaml`](../examples/k8s-set-owner-reference.yaml) -- [`k8s-owner-reference.yaml`](../examples/k8s-owner-reference.yaml) +- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) -- [`retry-with-steps.yaml`](../examples/retry-with-steps.yaml) +- [`loops-dag.yaml`](../examples/loops-dag.yaml) -- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) +- [`loops-maps.yaml`](../examples/loops-maps.yaml) -- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) +- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) -- [`testvolume.yaml`](../examples/testvolume.yaml) +- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) -- [`retry-backoff.yaml`](../examples/retry-backoff.yaml) +- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) -- [`default-pdb-support.yaml`](../examples/default-pdb-support.yaml) +- [`loops.yaml`](../examples/loops.yaml) -- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) +- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) -- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) +- [`node-selector.yaml`](../examples/node-selector.yaml) -- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) +- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) -- [`status-reference.yaml`](../examples/status-reference.yaml) +- [`output-parameter.yaml`](../examples/output-parameter.yaml) -- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) +- [`parallelism-limit.yaml`](../examples/parallelism-limit.yaml) -- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) +- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) -- [`pod-gc-strategy.yaml`](../examples/pod-gc-strategy.yaml) +- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) -- [`continue-on-fail.yaml`](../examples/continue-on-fail.yaml) +- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) -- [`hello-world.yaml`](../examples/hello-world.yaml) +- [`parallelism-template-limit.yaml`](../examples/parallelism-template-limit.yaml) -- [`sidecar.yaml`](../examples/sidecar.yaml) +- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) -- [`loops-maps.yaml`](../examples/loops-maps.yaml) +- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) -- [`sidecar-nginx.yaml`](../examples/sidecar-nginx.yaml) +- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) -- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) +- [`pod-gc-strategy.yaml`](../examples/pod-gc-strategy.yaml) -- [`template-on-exit.yaml`](../examples/template-on-exit.yaml) +- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) -- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) +- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) -- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) +- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) -- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) +- [`pod-spec-patch.yaml`](../examples/pod-spec-patch.yaml) -- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) +- [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) -- [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) +- [`resubmit.yaml`](../examples/resubmit.yaml) -- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) +- [`retry-backoff.yaml`](../examples/retry-backoff.yaml) -- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) +- [`retry-container-to-completion.yaml`](../examples/retry-container-to-completion.yaml) -- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) +- [`retry-container.yaml`](../examples/retry-container.yaml) -- [`dag-targets.yaml`](../examples/dag-targets.yaml) +- [`retry-on-error.yaml`](../examples/retry-on-error.yaml) -- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) +- [`retry-script.yaml`](../examples/retry-script.yaml) -- [`scripts-python.yaml`](../examples/scripts-python.yaml) +- [`retry-with-steps.yaml`](../examples/retry-with-steps.yaml) -- [`dns-config.yaml`](../examples/dns-config.yaml) +- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) -- [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) +- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) -- [`daemon-step.yaml`](../examples/daemon-step.yaml) +- [`scripts-python.yaml`](../examples/scripts-python.yaml) -- [`parallelism-template-limit.yaml`](../examples/parallelism-template-limit.yaml) +- [`secrets.yaml`](../examples/secrets.yaml) -- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) +- [`sidecar-dind.yaml`](../examples/sidecar-dind.yaml) -- [`k8s-set-owner-reference.yaml`](../examples/k8s-set-owner-reference.yaml) +- [`sidecar-nginx.yaml`](../examples/sidecar-nginx.yaml) -- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) +- [`sidecar.yaml`](../examples/sidecar.yaml) -- [`cron-workflow.yaml`](../examples/cron-workflow.yaml) +- [`status-reference.yaml`](../examples/status-reference.yaml) - [`steps.yaml`](../examples/steps.yaml) -- [`input-artifact-s3.yaml`](../examples/input-artifact-s3.yaml) +- [`suspend-template.yaml`](../examples/suspend-template.yaml) -- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) +- [`template-on-exit.yaml`](../examples/template-on-exit.yaml) -- [`retry-container.yaml`](../examples/retry-container.yaml) +- [`testvolume.yaml`](../examples/testvolume.yaml) -- [`forever.yaml`](../examples/forever.yaml) +- [`timeouts-step.yaml`](../examples/timeouts-step.yaml) -- [`dag-continue-on-fail.yaml`](../examples/dag-continue-on-fail.yaml) +- [`timeouts-workflow.yaml`](../examples/timeouts-workflow.yaml) -- [`secrets.yaml`](../examples/secrets.yaml) +- [`volumes-emptydir.yaml`](../examples/volumes-emptydir.yaml) -- [`conditionals.yaml`](../examples/conditionals.yaml) +- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) -- [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) +- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) + +- [`dag.yaml`](../examples/workflow-template/dag.yaml) + +- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) - [`retry-with-steps.yaml`](../examples/workflow-template/retry-with-steps.yaml) -- [`templates.yaml`](../examples/workflow-template/templates.yaml) +- [`steps.yaml`](../examples/workflow-template/steps.yaml) -- [`input-artifact-gcs.yaml`](../examples/input-artifact-gcs.yaml) +- [`templates.yaml`](../examples/workflow-template/templates.yaml)
### Fields @@ -535,221 +540,222 @@ WorkflowStatus contains overall status information about a workflow ## CronWorkflowSpec CronWorkflowSpec is the specification of a CronWorkflow +
Examples with this field (click to open)
-- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) - -- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) +- [`archive-location.yaml`](../examples/archive-location.yaml) -- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) +- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) -- [`retry-container-to-completion.yaml`](../examples/retry-container-to-completion.yaml) +- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) -- [`coinflip.yaml`](../examples/coinflip.yaml) +- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) -- [`init-container.yaml`](../examples/init-container.yaml) +- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) -- [`coinflip-recursive.yaml`](../examples/coinflip-recursive.yaml) +- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) -- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) +- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) -- [`steps.yaml`](../examples/workflow-template/steps.yaml) +- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) -- [`suspend-template.yaml`](../examples/suspend-template.yaml) +- [`ci.yaml`](../examples/ci.yaml) -- [`dag.yaml`](../examples/workflow-template/dag.yaml) +- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) -- [`sidecar-dind.yaml`](../examples/sidecar-dind.yaml) +- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) -- [`retry-script.yaml`](../examples/retry-script.yaml) +- [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) -- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) +- [`coinflip-recursive.yaml`](../examples/coinflip-recursive.yaml) -- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) +- [`coinflip.yaml`](../examples/coinflip.yaml) -- [`node-selector.yaml`](../examples/node-selector.yaml) +- [`conditionals.yaml`](../examples/conditionals.yaml) -- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) +- [`continue-on-fail.yaml`](../examples/continue-on-fail.yaml) -- [`retry-on-error.yaml`](../examples/retry-on-error.yaml) +- [`cron-workflow.yaml`](../examples/cron-workflow.yaml) -- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) +- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) -- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) +- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) -- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) +- [`daemon-step.yaml`](../examples/daemon-step.yaml) -- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) +- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) -- [`gc-ttl.yaml`](../examples/gc-ttl.yaml) +- [`dag-continue-on-fail.yaml`](../examples/dag-continue-on-fail.yaml) -- [`loops-dag.yaml`](../examples/loops-dag.yaml) +- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) -- [`output-parameter.yaml`](../examples/output-parameter.yaml) +- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) -- [`resubmit.yaml`](../examples/resubmit.yaml) +- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) -- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) +- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) -- [`image-pull-secrets.yaml`](../examples/image-pull-secrets.yaml) +- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) - [`dag-nested.yaml`](../examples/dag-nested.yaml) -- [`volumes-emptydir.yaml`](../examples/volumes-emptydir.yaml) - -- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) +- [`dag-targets.yaml`](../examples/dag-targets.yaml) -- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) +- [`default-pdb-support.yaml`](../examples/default-pdb-support.yaml) -- [`pod-spec-patch.yaml`](../examples/pod-spec-patch.yaml) +- [`dns-config.yaml`](../examples/dns-config.yaml) -- [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) +- [`exit-handlers.yaml`](../examples/exit-handlers.yaml) -- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) +- [`forever.yaml`](../examples/forever.yaml) -- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) +- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) -- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) +- [`gc-ttl.yaml`](../examples/gc-ttl.yaml) -- [`parallelism-limit.yaml`](../examples/parallelism-limit.yaml) +- [`global-outputs.yaml`](../examples/global-outputs.yaml) -- [`archive-location.yaml`](../examples/archive-location.yaml) +- [`global-parameters.yaml`](../examples/global-parameters.yaml) -- [`timeouts-workflow.yaml`](../examples/timeouts-workflow.yaml) +- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) -- [`timeouts-step.yaml`](../examples/timeouts-step.yaml) +- [`hello-world.yaml`](../examples/hello-world.yaml) -- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) +- [`image-pull-secrets.yaml`](../examples/image-pull-secrets.yaml) -- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) +- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) -- [`loops.yaml`](../examples/loops.yaml) +- [`init-container.yaml`](../examples/init-container.yaml) -- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) +- [`input-artifact-gcs.yaml`](../examples/input-artifact-gcs.yaml) -- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) +- [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) -- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) +- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) - [`input-artifact-oss.yaml`](../examples/input-artifact-oss.yaml) -- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) +- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) -- [`exit-handlers.yaml`](../examples/exit-handlers.yaml) +- [`input-artifact-s3.yaml`](../examples/input-artifact-s3.yaml) -- [`global-parameters.yaml`](../examples/global-parameters.yaml) +- [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) -- [`global-outputs.yaml`](../examples/global-outputs.yaml) +- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) -- [`ci.yaml`](../examples/ci.yaml) +- [`k8s-owner-reference.yaml`](../examples/k8s-owner-reference.yaml) -- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) +- [`k8s-set-owner-reference.yaml`](../examples/k8s-set-owner-reference.yaml) -- [`k8s-owner-reference.yaml`](../examples/k8s-owner-reference.yaml) +- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) -- [`retry-with-steps.yaml`](../examples/retry-with-steps.yaml) +- [`loops-dag.yaml`](../examples/loops-dag.yaml) -- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) +- [`loops-maps.yaml`](../examples/loops-maps.yaml) -- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) +- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) -- [`testvolume.yaml`](../examples/testvolume.yaml) +- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) -- [`retry-backoff.yaml`](../examples/retry-backoff.yaml) +- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) -- [`default-pdb-support.yaml`](../examples/default-pdb-support.yaml) +- [`loops.yaml`](../examples/loops.yaml) -- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) +- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) -- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) +- [`node-selector.yaml`](../examples/node-selector.yaml) -- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) +- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) -- [`status-reference.yaml`](../examples/status-reference.yaml) +- [`output-parameter.yaml`](../examples/output-parameter.yaml) -- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) +- [`parallelism-limit.yaml`](../examples/parallelism-limit.yaml) -- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) +- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) -- [`pod-gc-strategy.yaml`](../examples/pod-gc-strategy.yaml) +- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) -- [`continue-on-fail.yaml`](../examples/continue-on-fail.yaml) +- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) -- [`hello-world.yaml`](../examples/hello-world.yaml) +- [`parallelism-template-limit.yaml`](../examples/parallelism-template-limit.yaml) -- [`sidecar.yaml`](../examples/sidecar.yaml) +- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) -- [`loops-maps.yaml`](../examples/loops-maps.yaml) +- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) -- [`sidecar-nginx.yaml`](../examples/sidecar-nginx.yaml) +- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) -- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) +- [`pod-gc-strategy.yaml`](../examples/pod-gc-strategy.yaml) -- [`template-on-exit.yaml`](../examples/template-on-exit.yaml) +- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) -- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) +- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) -- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) +- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) -- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) +- [`pod-spec-patch.yaml`](../examples/pod-spec-patch.yaml) -- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) +- [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) -- [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) +- [`resubmit.yaml`](../examples/resubmit.yaml) -- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) +- [`retry-backoff.yaml`](../examples/retry-backoff.yaml) -- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) +- [`retry-container-to-completion.yaml`](../examples/retry-container-to-completion.yaml) -- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) +- [`retry-container.yaml`](../examples/retry-container.yaml) -- [`dag-targets.yaml`](../examples/dag-targets.yaml) +- [`retry-on-error.yaml`](../examples/retry-on-error.yaml) -- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) +- [`retry-script.yaml`](../examples/retry-script.yaml) -- [`scripts-python.yaml`](../examples/scripts-python.yaml) +- [`retry-with-steps.yaml`](../examples/retry-with-steps.yaml) -- [`dns-config.yaml`](../examples/dns-config.yaml) +- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) -- [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) +- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) -- [`daemon-step.yaml`](../examples/daemon-step.yaml) +- [`scripts-python.yaml`](../examples/scripts-python.yaml) -- [`parallelism-template-limit.yaml`](../examples/parallelism-template-limit.yaml) +- [`secrets.yaml`](../examples/secrets.yaml) -- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) +- [`sidecar-dind.yaml`](../examples/sidecar-dind.yaml) -- [`k8s-set-owner-reference.yaml`](../examples/k8s-set-owner-reference.yaml) +- [`sidecar-nginx.yaml`](../examples/sidecar-nginx.yaml) -- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) +- [`sidecar.yaml`](../examples/sidecar.yaml) -- [`cron-workflow.yaml`](../examples/cron-workflow.yaml) +- [`status-reference.yaml`](../examples/status-reference.yaml) - [`steps.yaml`](../examples/steps.yaml) -- [`input-artifact-s3.yaml`](../examples/input-artifact-s3.yaml) +- [`suspend-template.yaml`](../examples/suspend-template.yaml) -- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) +- [`template-on-exit.yaml`](../examples/template-on-exit.yaml) -- [`retry-container.yaml`](../examples/retry-container.yaml) +- [`testvolume.yaml`](../examples/testvolume.yaml) -- [`forever.yaml`](../examples/forever.yaml) +- [`timeouts-step.yaml`](../examples/timeouts-step.yaml) -- [`dag-continue-on-fail.yaml`](../examples/dag-continue-on-fail.yaml) +- [`timeouts-workflow.yaml`](../examples/timeouts-workflow.yaml) -- [`secrets.yaml`](../examples/secrets.yaml) +- [`volumes-emptydir.yaml`](../examples/volumes-emptydir.yaml) -- [`conditionals.yaml`](../examples/conditionals.yaml) +- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) -- [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) +- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) + +- [`dag.yaml`](../examples/workflow-template/dag.yaml) + +- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) - [`retry-with-steps.yaml`](../examples/workflow-template/retry-with-steps.yaml) -- [`templates.yaml`](../examples/workflow-template/templates.yaml) +- [`steps.yaml`](../examples/workflow-template/steps.yaml) -- [`input-artifact-gcs.yaml`](../examples/input-artifact-gcs.yaml) +- [`templates.yaml`](../examples/workflow-template/templates.yaml)
### Fields @@ -778,342 +784,344 @@ CronWorkflowStatus is the status of a CronWorkflow ## WorkflowTemplateSpec WorkflowTemplateSpec is a spec of WorkflowTemplate. +
Examples with this field (click to open)
-- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) - -- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) +- [`archive-location.yaml`](../examples/archive-location.yaml) -- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) +- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) -- [`retry-container-to-completion.yaml`](../examples/retry-container-to-completion.yaml) +- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) -- [`coinflip.yaml`](../examples/coinflip.yaml) +- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) -- [`init-container.yaml`](../examples/init-container.yaml) +- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) -- [`coinflip-recursive.yaml`](../examples/coinflip-recursive.yaml) +- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) -- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) +- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) -- [`steps.yaml`](../examples/workflow-template/steps.yaml) +- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) -- [`suspend-template.yaml`](../examples/suspend-template.yaml) +- [`ci.yaml`](../examples/ci.yaml) -- [`dag.yaml`](../examples/workflow-template/dag.yaml) +- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) -- [`sidecar-dind.yaml`](../examples/sidecar-dind.yaml) +- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) -- [`retry-script.yaml`](../examples/retry-script.yaml) +- [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) -- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) +- [`coinflip-recursive.yaml`](../examples/coinflip-recursive.yaml) -- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) +- [`coinflip.yaml`](../examples/coinflip.yaml) -- [`node-selector.yaml`](../examples/node-selector.yaml) +- [`conditionals.yaml`](../examples/conditionals.yaml) -- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) +- [`continue-on-fail.yaml`](../examples/continue-on-fail.yaml) -- [`retry-on-error.yaml`](../examples/retry-on-error.yaml) +- [`cron-workflow.yaml`](../examples/cron-workflow.yaml) -- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) +- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) -- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) +- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) -- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) +- [`daemon-step.yaml`](../examples/daemon-step.yaml) -- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) +- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) -- [`gc-ttl.yaml`](../examples/gc-ttl.yaml) +- [`dag-continue-on-fail.yaml`](../examples/dag-continue-on-fail.yaml) -- [`loops-dag.yaml`](../examples/loops-dag.yaml) +- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) -- [`output-parameter.yaml`](../examples/output-parameter.yaml) +- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) -- [`resubmit.yaml`](../examples/resubmit.yaml) +- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) -- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) +- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) -- [`image-pull-secrets.yaml`](../examples/image-pull-secrets.yaml) +- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) - [`dag-nested.yaml`](../examples/dag-nested.yaml) -- [`volumes-emptydir.yaml`](../examples/volumes-emptydir.yaml) - -- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) +- [`dag-targets.yaml`](../examples/dag-targets.yaml) -- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) +- [`default-pdb-support.yaml`](../examples/default-pdb-support.yaml) -- [`pod-spec-patch.yaml`](../examples/pod-spec-patch.yaml) +- [`dns-config.yaml`](../examples/dns-config.yaml) -- [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) +- [`exit-handlers.yaml`](../examples/exit-handlers.yaml) -- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) +- [`forever.yaml`](../examples/forever.yaml) -- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) +- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) -- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) +- [`gc-ttl.yaml`](../examples/gc-ttl.yaml) -- [`parallelism-limit.yaml`](../examples/parallelism-limit.yaml) +- [`global-outputs.yaml`](../examples/global-outputs.yaml) -- [`archive-location.yaml`](../examples/archive-location.yaml) +- [`global-parameters.yaml`](../examples/global-parameters.yaml) -- [`timeouts-workflow.yaml`](../examples/timeouts-workflow.yaml) +- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) -- [`timeouts-step.yaml`](../examples/timeouts-step.yaml) +- [`hello-world.yaml`](../examples/hello-world.yaml) -- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) +- [`image-pull-secrets.yaml`](../examples/image-pull-secrets.yaml) -- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) +- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) -- [`loops.yaml`](../examples/loops.yaml) +- [`init-container.yaml`](../examples/init-container.yaml) -- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) +- [`input-artifact-gcs.yaml`](../examples/input-artifact-gcs.yaml) -- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) +- [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) -- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) +- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) - [`input-artifact-oss.yaml`](../examples/input-artifact-oss.yaml) -- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) - -- [`exit-handlers.yaml`](../examples/exit-handlers.yaml) - -- [`global-parameters.yaml`](../examples/global-parameters.yaml) +- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) -- [`global-outputs.yaml`](../examples/global-outputs.yaml) +- [`input-artifact-s3.yaml`](../examples/input-artifact-s3.yaml) -- [`ci.yaml`](../examples/ci.yaml) +- [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) -- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) +- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) - [`k8s-owner-reference.yaml`](../examples/k8s-owner-reference.yaml) -- [`retry-with-steps.yaml`](../examples/retry-with-steps.yaml) +- [`k8s-set-owner-reference.yaml`](../examples/k8s-set-owner-reference.yaml) -- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) +- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) -- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) +- [`loops-dag.yaml`](../examples/loops-dag.yaml) -- [`testvolume.yaml`](../examples/testvolume.yaml) +- [`loops-maps.yaml`](../examples/loops-maps.yaml) -- [`retry-backoff.yaml`](../examples/retry-backoff.yaml) +- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) -- [`default-pdb-support.yaml`](../examples/default-pdb-support.yaml) +- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) -- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) +- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) -- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) +- [`loops.yaml`](../examples/loops.yaml) -- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) +- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) -- [`status-reference.yaml`](../examples/status-reference.yaml) +- [`node-selector.yaml`](../examples/node-selector.yaml) -- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) +- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) -- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) +- [`output-parameter.yaml`](../examples/output-parameter.yaml) -- [`pod-gc-strategy.yaml`](../examples/pod-gc-strategy.yaml) +- [`parallelism-limit.yaml`](../examples/parallelism-limit.yaml) -- [`continue-on-fail.yaml`](../examples/continue-on-fail.yaml) +- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) -- [`hello-world.yaml`](../examples/hello-world.yaml) +- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) -- [`sidecar.yaml`](../examples/sidecar.yaml) +- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) -- [`loops-maps.yaml`](../examples/loops-maps.yaml) +- [`parallelism-template-limit.yaml`](../examples/parallelism-template-limit.yaml) -- [`sidecar-nginx.yaml`](../examples/sidecar-nginx.yaml) +- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) -- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) +- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) -- [`template-on-exit.yaml`](../examples/template-on-exit.yaml) +- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) -- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) +- [`pod-gc-strategy.yaml`](../examples/pod-gc-strategy.yaml) -- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) +- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) -- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) +- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) -- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) +- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) -- [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) +- [`pod-spec-patch.yaml`](../examples/pod-spec-patch.yaml) -- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) +- [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) -- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) +- [`resubmit.yaml`](../examples/resubmit.yaml) -- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) +- [`retry-backoff.yaml`](../examples/retry-backoff.yaml) -- [`dag-targets.yaml`](../examples/dag-targets.yaml) +- [`retry-container-to-completion.yaml`](../examples/retry-container-to-completion.yaml) -- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) +- [`retry-container.yaml`](../examples/retry-container.yaml) -- [`scripts-python.yaml`](../examples/scripts-python.yaml) +- [`retry-on-error.yaml`](../examples/retry-on-error.yaml) -- [`dns-config.yaml`](../examples/dns-config.yaml) +- [`retry-script.yaml`](../examples/retry-script.yaml) -- [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) +- [`retry-with-steps.yaml`](../examples/retry-with-steps.yaml) -- [`daemon-step.yaml`](../examples/daemon-step.yaml) +- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) -- [`parallelism-template-limit.yaml`](../examples/parallelism-template-limit.yaml) +- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) -- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) +- [`scripts-python.yaml`](../examples/scripts-python.yaml) -- [`k8s-set-owner-reference.yaml`](../examples/k8s-set-owner-reference.yaml) +- [`secrets.yaml`](../examples/secrets.yaml) -- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) +- [`sidecar-dind.yaml`](../examples/sidecar-dind.yaml) -- [`cron-workflow.yaml`](../examples/cron-workflow.yaml) +- [`sidecar-nginx.yaml`](../examples/sidecar-nginx.yaml) + +- [`sidecar.yaml`](../examples/sidecar.yaml) + +- [`status-reference.yaml`](../examples/status-reference.yaml) - [`steps.yaml`](../examples/steps.yaml) -- [`input-artifact-s3.yaml`](../examples/input-artifact-s3.yaml) +- [`suspend-template.yaml`](../examples/suspend-template.yaml) -- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) +- [`template-on-exit.yaml`](../examples/template-on-exit.yaml) -- [`retry-container.yaml`](../examples/retry-container.yaml) +- [`testvolume.yaml`](../examples/testvolume.yaml) -- [`forever.yaml`](../examples/forever.yaml) +- [`timeouts-step.yaml`](../examples/timeouts-step.yaml) -- [`dag-continue-on-fail.yaml`](../examples/dag-continue-on-fail.yaml) +- [`timeouts-workflow.yaml`](../examples/timeouts-workflow.yaml) -- [`secrets.yaml`](../examples/secrets.yaml) +- [`volumes-emptydir.yaml`](../examples/volumes-emptydir.yaml) -- [`conditionals.yaml`](../examples/conditionals.yaml) +- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) -- [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) +- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) + +- [`dag.yaml`](../examples/workflow-template/dag.yaml) + +- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) - [`retry-with-steps.yaml`](../examples/workflow-template/retry-with-steps.yaml) -- [`templates.yaml`](../examples/workflow-template/templates.yaml) +- [`steps.yaml`](../examples/workflow-template/steps.yaml) -- [`input-artifact-gcs.yaml`](../examples/input-artifact-gcs.yaml) +- [`templates.yaml`](../examples/workflow-template/templates.yaml)
### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`workflowSpec`|[`WorkflowSpec`](#workflowspec)|_No desription available_| +|`workflowSpec`|[`WorkflowSpec`](#workflowspec)|_No description available_| ## Arguments Arguments to a template +
Examples with this field (click to open)
-- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) +- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) -- [`dag-nested.yaml`](../examples/dag-nested.yaml) +- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) -- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) +- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) -- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) +- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) -- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) +- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) -- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) +- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) -- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) +- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) -- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) +- [`ci.yaml`](../examples/ci.yaml) -- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) +- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) -- [`pod-spec-patch.yaml`](../examples/pod-spec-patch.yaml) +- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) - [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) -- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) +- [`conditionals.yaml`](../examples/conditionals.yaml) -- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) +- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) -- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) +- [`daemon-step.yaml`](../examples/daemon-step.yaml) -- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) +- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) -- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) +- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) + +- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) + +- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) + +- [`dag-nested.yaml`](../examples/dag-nested.yaml) - [`dag-targets.yaml`](../examples/dag-targets.yaml) -- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) +- [`global-outputs.yaml`](../examples/global-outputs.yaml) -- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) +- [`global-parameters.yaml`](../examples/global-parameters.yaml) -- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) +- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) -- [`scripts-python.yaml`](../examples/scripts-python.yaml) +- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) -- [`steps.yaml`](../examples/workflow-template/steps.yaml) +- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) -- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) +- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) -- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) +- [`loops-dag.yaml`](../examples/loops-dag.yaml) -- [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) +- [`loops-maps.yaml`](../examples/loops-maps.yaml) -- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) +- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) -- [`dag.yaml`](../examples/workflow-template/dag.yaml) +- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) -- [`daemon-step.yaml`](../examples/daemon-step.yaml) +- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) - [`loops.yaml`](../examples/loops.yaml) -- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) +- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) -- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) +- [`node-selector.yaml`](../examples/node-selector.yaml) -- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) +- [`output-parameter.yaml`](../examples/output-parameter.yaml) -- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) +- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) -- [`loops-maps.yaml`](../examples/loops-maps.yaml) +- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) -- [`steps.yaml`](../examples/steps.yaml) +- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) -- [`global-parameters.yaml`](../examples/global-parameters.yaml) +- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) - [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) -- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) - -- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) +- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) -- [`node-selector.yaml`](../examples/node-selector.yaml) +- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) -- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) +- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) -- [`ci.yaml`](../examples/ci.yaml) +- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) -- [`global-outputs.yaml`](../examples/global-outputs.yaml) +- [`pod-spec-patch.yaml`](../examples/pod-spec-patch.yaml) -- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) +- [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) - [`scripts-bash.yaml`](../examples/scripts-bash.yaml) -- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) +- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) -- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) +- [`scripts-python.yaml`](../examples/scripts-python.yaml) -- [`conditionals.yaml`](../examples/conditionals.yaml) +- [`steps.yaml`](../examples/steps.yaml) -- [`loops-dag.yaml`](../examples/loops-dag.yaml) +- [`dag.yaml`](../examples/workflow-template/dag.yaml) -- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) +- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) -- [`output-parameter.yaml`](../examples/output-parameter.yaml) +- [`steps.yaml`](../examples/workflow-template/steps.yaml) - [`templates.yaml`](../examples/workflow-template/templates.yaml) - -- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) - -- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml)
### Fields @@ -1129,8 +1137,8 @@ _No description available_ ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`configMap`|`string`|_No desription available_| -|`key`|`string`|_No desription available_| +|`configMap`|`string`|_No description available_| +|`key`|`string`|_No description available_| ## ExecutorConfig @@ -1144,6 +1152,7 @@ ExecutorConfig holds configurations of an executor container. ## Metrics Metrics are a list of metrics emitted from a Workflow/Template +
Examples with this field (click to open)
@@ -1159,6 +1168,7 @@ Metrics are a list of metrics emitted from a Workflow/Template ## PodGC PodGC describes how to delete completed pods as they complete +
Examples with this field (click to open)
@@ -1174,219 +1184,220 @@ PodGC describes how to delete completed pods as they complete ## Template Template is a reusable and composable unit of execution in a workflow +
Examples with this field (click to open)
-- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) - -- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) +- [`archive-location.yaml`](../examples/archive-location.yaml) -- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) +- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) -- [`retry-container-to-completion.yaml`](../examples/retry-container-to-completion.yaml) +- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) -- [`coinflip.yaml`](../examples/coinflip.yaml) +- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) -- [`init-container.yaml`](../examples/init-container.yaml) +- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) -- [`coinflip-recursive.yaml`](../examples/coinflip-recursive.yaml) +- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) -- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) +- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) -- [`steps.yaml`](../examples/workflow-template/steps.yaml) +- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) -- [`suspend-template.yaml`](../examples/suspend-template.yaml) +- [`ci.yaml`](../examples/ci.yaml) -- [`dag.yaml`](../examples/workflow-template/dag.yaml) +- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) -- [`sidecar-dind.yaml`](../examples/sidecar-dind.yaml) +- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) -- [`retry-script.yaml`](../examples/retry-script.yaml) +- [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) -- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) +- [`coinflip-recursive.yaml`](../examples/coinflip-recursive.yaml) -- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) +- [`coinflip.yaml`](../examples/coinflip.yaml) -- [`node-selector.yaml`](../examples/node-selector.yaml) +- [`conditionals.yaml`](../examples/conditionals.yaml) -- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) +- [`continue-on-fail.yaml`](../examples/continue-on-fail.yaml) -- [`retry-on-error.yaml`](../examples/retry-on-error.yaml) +- [`cron-workflow.yaml`](../examples/cron-workflow.yaml) -- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) +- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) -- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) +- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) -- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) +- [`daemon-step.yaml`](../examples/daemon-step.yaml) -- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) +- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) -- [`gc-ttl.yaml`](../examples/gc-ttl.yaml) +- [`dag-continue-on-fail.yaml`](../examples/dag-continue-on-fail.yaml) -- [`loops-dag.yaml`](../examples/loops-dag.yaml) +- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) -- [`output-parameter.yaml`](../examples/output-parameter.yaml) +- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) -- [`resubmit.yaml`](../examples/resubmit.yaml) +- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) -- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) +- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) -- [`image-pull-secrets.yaml`](../examples/image-pull-secrets.yaml) +- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) - [`dag-nested.yaml`](../examples/dag-nested.yaml) -- [`volumes-emptydir.yaml`](../examples/volumes-emptydir.yaml) +- [`dag-targets.yaml`](../examples/dag-targets.yaml) -- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) +- [`default-pdb-support.yaml`](../examples/default-pdb-support.yaml) -- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) +- [`dns-config.yaml`](../examples/dns-config.yaml) -- [`pod-spec-patch.yaml`](../examples/pod-spec-patch.yaml) +- [`exit-handlers.yaml`](../examples/exit-handlers.yaml) -- [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) +- [`forever.yaml`](../examples/forever.yaml) -- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) +- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) -- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) +- [`gc-ttl.yaml`](../examples/gc-ttl.yaml) -- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) +- [`global-outputs.yaml`](../examples/global-outputs.yaml) -- [`parallelism-limit.yaml`](../examples/parallelism-limit.yaml) +- [`global-parameters.yaml`](../examples/global-parameters.yaml) -- [`archive-location.yaml`](../examples/archive-location.yaml) +- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) -- [`timeouts-workflow.yaml`](../examples/timeouts-workflow.yaml) +- [`hello-world.yaml`](../examples/hello-world.yaml) -- [`timeouts-step.yaml`](../examples/timeouts-step.yaml) +- [`image-pull-secrets.yaml`](../examples/image-pull-secrets.yaml) -- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) +- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) -- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) +- [`init-container.yaml`](../examples/init-container.yaml) -- [`loops.yaml`](../examples/loops.yaml) +- [`input-artifact-gcs.yaml`](../examples/input-artifact-gcs.yaml) -- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) - -- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) +- [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) -- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) +- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) - [`input-artifact-oss.yaml`](../examples/input-artifact-oss.yaml) -- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) +- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) -- [`exit-handlers.yaml`](../examples/exit-handlers.yaml) +- [`input-artifact-s3.yaml`](../examples/input-artifact-s3.yaml) -- [`global-parameters.yaml`](../examples/global-parameters.yaml) +- [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) -- [`global-outputs.yaml`](../examples/global-outputs.yaml) +- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) -- [`ci.yaml`](../examples/ci.yaml) +- [`k8s-owner-reference.yaml`](../examples/k8s-owner-reference.yaml) -- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) +- [`k8s-set-owner-reference.yaml`](../examples/k8s-set-owner-reference.yaml) -- [`k8s-owner-reference.yaml`](../examples/k8s-owner-reference.yaml) +- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) -- [`retry-with-steps.yaml`](../examples/retry-with-steps.yaml) +- [`loops-dag.yaml`](../examples/loops-dag.yaml) -- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) +- [`loops-maps.yaml`](../examples/loops-maps.yaml) -- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) +- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) -- [`retry-backoff.yaml`](../examples/retry-backoff.yaml) +- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) -- [`default-pdb-support.yaml`](../examples/default-pdb-support.yaml) +- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) -- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) +- [`loops.yaml`](../examples/loops.yaml) -- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) +- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) -- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) +- [`node-selector.yaml`](../examples/node-selector.yaml) -- [`status-reference.yaml`](../examples/status-reference.yaml) +- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) -- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) +- [`output-parameter.yaml`](../examples/output-parameter.yaml) -- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) +- [`parallelism-limit.yaml`](../examples/parallelism-limit.yaml) -- [`pod-gc-strategy.yaml`](../examples/pod-gc-strategy.yaml) +- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) -- [`continue-on-fail.yaml`](../examples/continue-on-fail.yaml) +- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) -- [`hello-world.yaml`](../examples/hello-world.yaml) +- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) -- [`sidecar.yaml`](../examples/sidecar.yaml) +- [`parallelism-template-limit.yaml`](../examples/parallelism-template-limit.yaml) -- [`loops-maps.yaml`](../examples/loops-maps.yaml) +- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) -- [`sidecar-nginx.yaml`](../examples/sidecar-nginx.yaml) +- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) -- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) +- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) -- [`template-on-exit.yaml`](../examples/template-on-exit.yaml) +- [`pod-gc-strategy.yaml`](../examples/pod-gc-strategy.yaml) -- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) +- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) -- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) +- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) -- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) +- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) -- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) +- [`pod-spec-patch.yaml`](../examples/pod-spec-patch.yaml) -- [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) +- [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) -- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) +- [`resubmit.yaml`](../examples/resubmit.yaml) -- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) +- [`retry-backoff.yaml`](../examples/retry-backoff.yaml) -- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) +- [`retry-container-to-completion.yaml`](../examples/retry-container-to-completion.yaml) -- [`dag-targets.yaml`](../examples/dag-targets.yaml) +- [`retry-container.yaml`](../examples/retry-container.yaml) -- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) +- [`retry-on-error.yaml`](../examples/retry-on-error.yaml) -- [`scripts-python.yaml`](../examples/scripts-python.yaml) +- [`retry-script.yaml`](../examples/retry-script.yaml) -- [`dns-config.yaml`](../examples/dns-config.yaml) +- [`retry-with-steps.yaml`](../examples/retry-with-steps.yaml) -- [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) +- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) -- [`daemon-step.yaml`](../examples/daemon-step.yaml) +- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) -- [`parallelism-template-limit.yaml`](../examples/parallelism-template-limit.yaml) +- [`scripts-python.yaml`](../examples/scripts-python.yaml) -- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) +- [`secrets.yaml`](../examples/secrets.yaml) -- [`k8s-set-owner-reference.yaml`](../examples/k8s-set-owner-reference.yaml) +- [`sidecar-dind.yaml`](../examples/sidecar-dind.yaml) -- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) +- [`sidecar-nginx.yaml`](../examples/sidecar-nginx.yaml) -- [`cron-workflow.yaml`](../examples/cron-workflow.yaml) +- [`sidecar.yaml`](../examples/sidecar.yaml) + +- [`status-reference.yaml`](../examples/status-reference.yaml) - [`steps.yaml`](../examples/steps.yaml) -- [`input-artifact-s3.yaml`](../examples/input-artifact-s3.yaml) +- [`suspend-template.yaml`](../examples/suspend-template.yaml) -- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) +- [`template-on-exit.yaml`](../examples/template-on-exit.yaml) -- [`retry-container.yaml`](../examples/retry-container.yaml) +- [`timeouts-step.yaml`](../examples/timeouts-step.yaml) -- [`forever.yaml`](../examples/forever.yaml) +- [`timeouts-workflow.yaml`](../examples/timeouts-workflow.yaml) -- [`dag-continue-on-fail.yaml`](../examples/dag-continue-on-fail.yaml) +- [`volumes-emptydir.yaml`](../examples/volumes-emptydir.yaml) -- [`secrets.yaml`](../examples/secrets.yaml) +- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) -- [`conditionals.yaml`](../examples/conditionals.yaml) +- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) -- [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) +- [`dag.yaml`](../examples/workflow-template/dag.yaml) + +- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) - [`retry-with-steps.yaml`](../examples/workflow-template/retry-with-steps.yaml) -- [`templates.yaml`](../examples/workflow-template/templates.yaml) +- [`steps.yaml`](../examples/workflow-template/steps.yaml) -- [`input-artifact-gcs.yaml`](../examples/input-artifact-gcs.yaml) +- [`templates.yaml`](../examples/workflow-template/templates.yaml)
### Fields @@ -1431,6 +1442,7 @@ Template is a reusable and composable unit of execution in a workflow ## TTLStrategy TTLStrategy is the strategy for the time to live depending on if the workflow succeeded or failed +
Examples with this field (click to open)
@@ -1488,47 +1500,48 @@ NodeStatus contains status information about an individual node in the workflow ## Outputs Outputs hold parameters, artifacts, and results from a step +
Examples with this field (click to open)
-- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) - -- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) - -- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) +- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) -- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) +- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) -- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) +- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) -- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) +- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) -- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) +- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) -- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) +- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) -- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) +- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) - [`global-outputs.yaml`](../examples/global-outputs.yaml) -- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) +- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) -- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) +- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) + +- [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) - [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) -- [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) +- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) -- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) +- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) -- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) +- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) - [`output-parameter.yaml`](../examples/output-parameter.yaml) -- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) +- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) -- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) +- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) + +- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml)
### Fields @@ -1541,47 +1554,48 @@ Outputs hold parameters, artifacts, and results from a step ## Artifact Artifact indicates an artifact to place at a specified path +
Examples with this field (click to open)
-- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) +- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) -- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) +- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) -- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) +- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) -- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) +- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) -- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) +- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) -- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) +- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) -- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) +- [`ci.yaml`](../examples/ci.yaml) -- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) +- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) -- [`input-artifact-oss.yaml`](../examples/input-artifact-oss.yaml) +- [`global-outputs.yaml`](../examples/global-outputs.yaml) -- [`input-artifact-s3.yaml`](../examples/input-artifact-s3.yaml) +- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) -- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) +- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) -- [`global-outputs.yaml`](../examples/global-outputs.yaml) +- [`input-artifact-gcs.yaml`](../examples/input-artifact-gcs.yaml) -- [`ci.yaml`](../examples/ci.yaml) +- [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) -- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) +- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) -- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) +- [`input-artifact-oss.yaml`](../examples/input-artifact-oss.yaml) -- [`input-artifact-gcs.yaml`](../examples/input-artifact-gcs.yaml) +- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) -- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) +- [`input-artifact-s3.yaml`](../examples/input-artifact-s3.yaml) -- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) +- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) -- [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) +- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml)
### Fields @@ -1599,111 +1613,112 @@ Artifact indicates an artifact to place at a specified path ## Parameter Parameter indicate a passed string parameter to a service template with an optional default value +
Examples with this field (click to open)
-- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) +- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) -- [`dag-nested.yaml`](../examples/dag-nested.yaml) +- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) -- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) +- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) -- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) +- [`ci.yaml`](../examples/ci.yaml) -- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) +- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) -- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) +- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) -- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) +- [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) -- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) +- [`conditionals.yaml`](../examples/conditionals.yaml) -- [`pod-spec-patch.yaml`](../examples/pod-spec-patch.yaml) +- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) -- [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) +- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) -- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) +- [`daemon-step.yaml`](../examples/daemon-step.yaml) -- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) +- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) + +- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) + +- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) - [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) -- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) +- [`dag-nested.yaml`](../examples/dag-nested.yaml) - [`dag-targets.yaml`](../examples/dag-targets.yaml) -- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) +- [`global-outputs.yaml`](../examples/global-outputs.yaml) -- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) +- [`global-parameters.yaml`](../examples/global-parameters.yaml) -- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) +- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) -- [`scripts-python.yaml`](../examples/scripts-python.yaml) +- [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) -- [`steps.yaml`](../examples/workflow-template/steps.yaml) +- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) -- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) +- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) -- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) +- [`loops-dag.yaml`](../examples/loops-dag.yaml) -- [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) +- [`loops-maps.yaml`](../examples/loops-maps.yaml) -- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) +- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) -- [`dag.yaml`](../examples/workflow-template/dag.yaml) +- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) -- [`daemon-step.yaml`](../examples/daemon-step.yaml) +- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) - [`loops.yaml`](../examples/loops.yaml) -- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) +- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) -- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) +- [`node-selector.yaml`](../examples/node-selector.yaml) -- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) +- [`output-parameter.yaml`](../examples/output-parameter.yaml) -- [`loops-maps.yaml`](../examples/loops-maps.yaml) - -- [`steps.yaml`](../examples/steps.yaml) +- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) -- [`global-parameters.yaml`](../examples/global-parameters.yaml) +- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) -- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) +- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) -- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) +- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) -- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) +- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) -- [`node-selector.yaml`](../examples/node-selector.yaml) +- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) -- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) +- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) -- [`ci.yaml`](../examples/ci.yaml) +- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) -- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) +- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) -- [`global-outputs.yaml`](../examples/global-outputs.yaml) +- [`pod-spec-patch.yaml`](../examples/pod-spec-patch.yaml) -- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) +- [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) - [`scripts-bash.yaml`](../examples/scripts-bash.yaml) -- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) +- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) -- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) +- [`scripts-python.yaml`](../examples/scripts-python.yaml) -- [`conditionals.yaml`](../examples/conditionals.yaml) +- [`steps.yaml`](../examples/steps.yaml) -- [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) +- [`dag.yaml`](../examples/workflow-template/dag.yaml) -- [`loops-dag.yaml`](../examples/loops-dag.yaml) +- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) -- [`output-parameter.yaml`](../examples/output-parameter.yaml) +- [`steps.yaml`](../examples/workflow-template/steps.yaml) - [`templates.yaml`](../examples/workflow-template/templates.yaml) - -- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml)
### Fields @@ -1718,6 +1733,7 @@ Parameter indicate a passed string parameter to a service template with an optio ## Prometheus Prometheus is a prometheus metric to be emitted +
Examples with this field (click to open)
@@ -1739,6 +1755,7 @@ Prometheus is a prometheus metric to be emitted ## ArtifactLocation ArtifactLocation describes a location for a single or multiple artifacts.It is used as single artifact in the context of inputs/outputs (e.g. outputs.artifacts.artname).It is also used to describe the location of multiple artifacts such as the archive locationof a single workflow step, which the executor will use as a default location to store its files. +
Examples with this field (click to open)
@@ -1762,45 +1779,46 @@ ArtifactLocation describes a location for a single or multiple artifacts.It is u ## DAGTemplate DAGTemplate is a template subtype for directed acyclic graph templates +
Examples with this field (click to open)
-- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) +- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) -- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) +- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) -- [`dag.yaml`](../examples/workflow-template/dag.yaml) +- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) -- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) +- [`dag-continue-on-fail.yaml`](../examples/dag-continue-on-fail.yaml) -- [`dag-targets.yaml`](../examples/dag-targets.yaml) +- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) -- [`dag-nested.yaml`](../examples/dag-nested.yaml) +- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) - [`dag-diamond.yaml`](../examples/dag-diamond.yaml) -- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) +- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) -- [`loops-dag.yaml`](../examples/loops-dag.yaml) +- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) -- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) +- [`dag-nested.yaml`](../examples/dag-nested.yaml) -- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) +- [`dag-targets.yaml`](../examples/dag-targets.yaml) -- [`templates.yaml`](../examples/workflow-template/templates.yaml) +- [`loops-dag.yaml`](../examples/loops-dag.yaml) -- [`resubmit.yaml`](../examples/resubmit.yaml) +- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) -- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) +- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) -- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) +- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) -- [`dag-continue-on-fail.yaml`](../examples/dag-continue-on-fail.yaml) +- [`resubmit.yaml`](../examples/resubmit.yaml) -- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) +- [`dag.yaml`](../examples/workflow-template/dag.yaml) -- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) +- [`templates.yaml`](../examples/workflow-template/templates.yaml)
### Fields @@ -1813,6 +1831,7 @@ DAGTemplate is a template subtype for directed acyclic graph templates ## UserContainer UserContainer is a container specified by a user. +
Examples with this field (click to open)
@@ -1823,117 +1842,118 @@ UserContainer is a container specified by a user. ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`container`|[`Container`](#container)|_No desription available_| +|`container`|[`Container`](#container)|_No description available_| |`mirrorVolumeMounts`|`boolean`|MirrorVolumeMounts will mount the same volumes specified in the main containerto the container (including artifacts), at the same mountPaths. This enablesdind daemon to partially see the same filesystem as the main container inorder to use features such as docker volume binding| ## Inputs Inputs are the mechanism for passing parameters, artifacts, volumes from one template to another +
Examples with this field (click to open)
-- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) - -- [`dag-nested.yaml`](../examples/dag-nested.yaml) - -- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) +- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) - [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) -- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) +- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) -- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) +- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) -- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) +- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) -- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) +- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) - [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) -- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) - -- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) +- [`ci.yaml`](../examples/ci.yaml) -- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) +- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) -- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) +- [`conditionals.yaml`](../examples/conditionals.yaml) -- [`dag-targets.yaml`](../examples/dag-targets.yaml) +- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) -- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) +- [`daemon-step.yaml`](../examples/daemon-step.yaml) -- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) +- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) -- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) +- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) -- [`scripts-python.yaml`](../examples/scripts-python.yaml) +- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) -- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) +- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) -- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) +- [`dag-nested.yaml`](../examples/dag-nested.yaml) -- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) +- [`dag-targets.yaml`](../examples/dag-targets.yaml) -- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) +- [`global-outputs.yaml`](../examples/global-outputs.yaml) -- [`daemon-step.yaml`](../examples/daemon-step.yaml) +- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) -- [`loops.yaml`](../examples/loops.yaml) +- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) -- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) +- [`input-artifact-gcs.yaml`](../examples/input-artifact-gcs.yaml) -- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) +- [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) -- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) +- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) - [`input-artifact-oss.yaml`](../examples/input-artifact-oss.yaml) -- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) +- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) -- [`loops-maps.yaml`](../examples/loops-maps.yaml) +- [`input-artifact-s3.yaml`](../examples/input-artifact-s3.yaml) -- [`steps.yaml`](../examples/steps.yaml) +- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) -- [`input-artifact-s3.yaml`](../examples/input-artifact-s3.yaml) +- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) -- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) +- [`loops-dag.yaml`](../examples/loops-dag.yaml) -- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) +- [`loops-maps.yaml`](../examples/loops-maps.yaml) -- [`node-selector.yaml`](../examples/node-selector.yaml) +- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) -- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) +- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) -- [`ci.yaml`](../examples/ci.yaml) +- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) -- [`global-outputs.yaml`](../examples/global-outputs.yaml) +- [`loops.yaml`](../examples/loops.yaml) -- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) +- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) -- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) +- [`node-selector.yaml`](../examples/node-selector.yaml) + +- [`output-parameter.yaml`](../examples/output-parameter.yaml) + +- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) - [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) -- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) +- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) -- [`conditionals.yaml`](../examples/conditionals.yaml) +- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) -- [`loops-dag.yaml`](../examples/loops-dag.yaml) +- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) -- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) +- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) -- [`output-parameter.yaml`](../examples/output-parameter.yaml) +- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) -- [`templates.yaml`](../examples/workflow-template/templates.yaml) +- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) -- [`input-artifact-gcs.yaml`](../examples/input-artifact-gcs.yaml) +- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) -- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) +- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) -- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) +- [`scripts-python.yaml`](../examples/scripts-python.yaml) -- [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) +- [`steps.yaml`](../examples/steps.yaml) + +- [`templates.yaml`](../examples/workflow-template/templates.yaml)
### Fields @@ -1945,244 +1965,246 @@ Inputs are the mechanism for passing parameters, artifacts, volumes from one tem ## Metadata Pod metdata +
Examples with this field (click to open)
-- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) - -- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) +- [`archive-location.yaml`](../examples/archive-location.yaml) -- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) +- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) -- [`retry-container-to-completion.yaml`](../examples/retry-container-to-completion.yaml) +- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) -- [`coinflip.yaml`](../examples/coinflip.yaml) +- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) -- [`init-container.yaml`](../examples/init-container.yaml) +- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) -- [`coinflip-recursive.yaml`](../examples/coinflip-recursive.yaml) +- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) -- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) +- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) -- [`steps.yaml`](../examples/workflow-template/steps.yaml) +- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) -- [`suspend-template.yaml`](../examples/suspend-template.yaml) +- [`ci.yaml`](../examples/ci.yaml) -- [`dag.yaml`](../examples/workflow-template/dag.yaml) +- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) -- [`sidecar-dind.yaml`](../examples/sidecar-dind.yaml) +- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) -- [`retry-script.yaml`](../examples/retry-script.yaml) +- [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) -- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) +- [`coinflip-recursive.yaml`](../examples/coinflip-recursive.yaml) -- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) +- [`coinflip.yaml`](../examples/coinflip.yaml) -- [`node-selector.yaml`](../examples/node-selector.yaml) +- [`conditionals.yaml`](../examples/conditionals.yaml) -- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) +- [`continue-on-fail.yaml`](../examples/continue-on-fail.yaml) -- [`retry-on-error.yaml`](../examples/retry-on-error.yaml) +- [`cron-workflow.yaml`](../examples/cron-workflow.yaml) -- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) +- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) -- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) +- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) -- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) +- [`daemon-step.yaml`](../examples/daemon-step.yaml) -- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) +- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) -- [`gc-ttl.yaml`](../examples/gc-ttl.yaml) +- [`dag-continue-on-fail.yaml`](../examples/dag-continue-on-fail.yaml) -- [`loops-dag.yaml`](../examples/loops-dag.yaml) +- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) -- [`output-parameter.yaml`](../examples/output-parameter.yaml) +- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) -- [`resubmit.yaml`](../examples/resubmit.yaml) +- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) -- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) +- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) -- [`image-pull-secrets.yaml`](../examples/image-pull-secrets.yaml) +- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) - [`dag-nested.yaml`](../examples/dag-nested.yaml) -- [`volumes-emptydir.yaml`](../examples/volumes-emptydir.yaml) - -- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) +- [`dag-targets.yaml`](../examples/dag-targets.yaml) -- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) +- [`default-pdb-support.yaml`](../examples/default-pdb-support.yaml) -- [`pod-spec-patch.yaml`](../examples/pod-spec-patch.yaml) +- [`dns-config.yaml`](../examples/dns-config.yaml) -- [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) +- [`exit-handlers.yaml`](../examples/exit-handlers.yaml) -- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) +- [`forever.yaml`](../examples/forever.yaml) -- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) +- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) -- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) +- [`gc-ttl.yaml`](../examples/gc-ttl.yaml) -- [`parallelism-limit.yaml`](../examples/parallelism-limit.yaml) +- [`global-outputs.yaml`](../examples/global-outputs.yaml) -- [`archive-location.yaml`](../examples/archive-location.yaml) +- [`global-parameters.yaml`](../examples/global-parameters.yaml) -- [`timeouts-workflow.yaml`](../examples/timeouts-workflow.yaml) +- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) -- [`timeouts-step.yaml`](../examples/timeouts-step.yaml) +- [`hello-world.yaml`](../examples/hello-world.yaml) -- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) +- [`image-pull-secrets.yaml`](../examples/image-pull-secrets.yaml) -- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) +- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) -- [`loops.yaml`](../examples/loops.yaml) +- [`init-container.yaml`](../examples/init-container.yaml) -- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) +- [`input-artifact-gcs.yaml`](../examples/input-artifact-gcs.yaml) -- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) +- [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) -- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) +- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) - [`input-artifact-oss.yaml`](../examples/input-artifact-oss.yaml) -- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) +- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) -- [`exit-handlers.yaml`](../examples/exit-handlers.yaml) +- [`input-artifact-s3.yaml`](../examples/input-artifact-s3.yaml) -- [`global-parameters.yaml`](../examples/global-parameters.yaml) +- [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) -- [`global-outputs.yaml`](../examples/global-outputs.yaml) +- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) -- [`ci.yaml`](../examples/ci.yaml) +- [`k8s-owner-reference.yaml`](../examples/k8s-owner-reference.yaml) -- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) +- [`k8s-set-owner-reference.yaml`](../examples/k8s-set-owner-reference.yaml) -- [`k8s-owner-reference.yaml`](../examples/k8s-owner-reference.yaml) +- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) -- [`retry-with-steps.yaml`](../examples/retry-with-steps.yaml) +- [`loops-dag.yaml`](../examples/loops-dag.yaml) -- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) +- [`loops-maps.yaml`](../examples/loops-maps.yaml) -- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) +- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) -- [`testvolume.yaml`](../examples/testvolume.yaml) +- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) -- [`retry-backoff.yaml`](../examples/retry-backoff.yaml) +- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) -- [`default-pdb-support.yaml`](../examples/default-pdb-support.yaml) +- [`loops.yaml`](../examples/loops.yaml) -- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) +- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) -- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) +- [`node-selector.yaml`](../examples/node-selector.yaml) -- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) +- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) -- [`status-reference.yaml`](../examples/status-reference.yaml) +- [`output-parameter.yaml`](../examples/output-parameter.yaml) -- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) +- [`parallelism-limit.yaml`](../examples/parallelism-limit.yaml) + +- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) + +- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) - [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) -- [`pod-gc-strategy.yaml`](../examples/pod-gc-strategy.yaml) +- [`parallelism-template-limit.yaml`](../examples/parallelism-template-limit.yaml) -- [`continue-on-fail.yaml`](../examples/continue-on-fail.yaml) +- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) -- [`hello-world.yaml`](../examples/hello-world.yaml) +- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) -- [`sidecar.yaml`](../examples/sidecar.yaml) +- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) -- [`loops-maps.yaml`](../examples/loops-maps.yaml) +- [`pod-gc-strategy.yaml`](../examples/pod-gc-strategy.yaml) -- [`sidecar-nginx.yaml`](../examples/sidecar-nginx.yaml) +- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) -- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) +- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) -- [`template-on-exit.yaml`](../examples/template-on-exit.yaml) +- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) -- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) +- [`pod-spec-patch.yaml`](../examples/pod-spec-patch.yaml) -- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) +- [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) -- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) +- [`resubmit.yaml`](../examples/resubmit.yaml) -- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) +- [`retry-backoff.yaml`](../examples/retry-backoff.yaml) -- [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) +- [`retry-container-to-completion.yaml`](../examples/retry-container-to-completion.yaml) -- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) +- [`retry-container.yaml`](../examples/retry-container.yaml) -- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) +- [`retry-on-error.yaml`](../examples/retry-on-error.yaml) -- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) +- [`retry-script.yaml`](../examples/retry-script.yaml) -- [`dag-targets.yaml`](../examples/dag-targets.yaml) +- [`retry-with-steps.yaml`](../examples/retry-with-steps.yaml) -- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) +- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) -- [`scripts-python.yaml`](../examples/scripts-python.yaml) +- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) -- [`dns-config.yaml`](../examples/dns-config.yaml) +- [`scripts-python.yaml`](../examples/scripts-python.yaml) -- [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) +- [`secrets.yaml`](../examples/secrets.yaml) -- [`daemon-step.yaml`](../examples/daemon-step.yaml) +- [`sidecar-dind.yaml`](../examples/sidecar-dind.yaml) -- [`parallelism-template-limit.yaml`](../examples/parallelism-template-limit.yaml) +- [`sidecar-nginx.yaml`](../examples/sidecar-nginx.yaml) -- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) +- [`sidecar.yaml`](../examples/sidecar.yaml) -- [`k8s-set-owner-reference.yaml`](../examples/k8s-set-owner-reference.yaml) +- [`status-reference.yaml`](../examples/status-reference.yaml) -- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) +- [`steps.yaml`](../examples/steps.yaml) -- [`cron-workflow.yaml`](../examples/cron-workflow.yaml) +- [`suspend-template.yaml`](../examples/suspend-template.yaml) -- [`steps.yaml`](../examples/steps.yaml) +- [`template-on-exit.yaml`](../examples/template-on-exit.yaml) -- [`input-artifact-s3.yaml`](../examples/input-artifact-s3.yaml) +- [`testvolume.yaml`](../examples/testvolume.yaml) -- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) +- [`timeouts-step.yaml`](../examples/timeouts-step.yaml) -- [`retry-container.yaml`](../examples/retry-container.yaml) +- [`timeouts-workflow.yaml`](../examples/timeouts-workflow.yaml) -- [`forever.yaml`](../examples/forever.yaml) +- [`volumes-emptydir.yaml`](../examples/volumes-emptydir.yaml) -- [`dag-continue-on-fail.yaml`](../examples/dag-continue-on-fail.yaml) +- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) -- [`secrets.yaml`](../examples/secrets.yaml) +- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) -- [`conditionals.yaml`](../examples/conditionals.yaml) +- [`dag.yaml`](../examples/workflow-template/dag.yaml) -- [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) +- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) - [`retry-with-steps.yaml`](../examples/workflow-template/retry-with-steps.yaml) -- [`templates.yaml`](../examples/workflow-template/templates.yaml) +- [`steps.yaml`](../examples/workflow-template/steps.yaml) -- [`input-artifact-gcs.yaml`](../examples/input-artifact-gcs.yaml) +- [`templates.yaml`](../examples/workflow-template/templates.yaml)
### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`annotations`|`Map< string , string >`|_No desription available_| -|`labels`|`Map< string , string >`|_No desription available_| +|`annotations`|`Map< string , string >`|_No description available_| +|`labels`|`Map< string , string >`|_No description available_| ## ResourceTemplate ResourceTemplate is a template subtype to manipulate kubernetes resources +
Examples with this field (click to open)
-- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) - -- [`k8s-set-owner-reference.yaml`](../examples/k8s-set-owner-reference.yaml) - - [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) +- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) + - [`k8s-owner-reference.yaml`](../examples/k8s-owner-reference.yaml) +- [`k8s-set-owner-reference.yaml`](../examples/k8s-set-owner-reference.yaml) + - [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml)
@@ -2199,27 +2221,28 @@ ResourceTemplate is a template subtype to manipulate kubernetes resources ## RetryStrategy RetryStrategy provides controls on how to retry a workflow step +
Examples with this field (click to open)
-- [`retry-container-to-completion.yaml`](../examples/retry-container-to-completion.yaml) +- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) - [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) -- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) - - [`retry-backoff.yaml`](../examples/retry-backoff.yaml) -- [`retry-with-steps.yaml`](../examples/retry-with-steps.yaml) +- [`retry-container-to-completion.yaml`](../examples/retry-container-to-completion.yaml) -- [`templates.yaml`](../examples/workflow-template/templates.yaml) +- [`retry-container.yaml`](../examples/retry-container.yaml) + +- [`retry-on-error.yaml`](../examples/retry-on-error.yaml) - [`retry-script.yaml`](../examples/retry-script.yaml) -- [`retry-container.yaml`](../examples/retry-container.yaml) +- [`retry-with-steps.yaml`](../examples/retry-with-steps.yaml) -- [`retry-on-error.yaml`](../examples/retry-on-error.yaml) +- [`templates.yaml`](../examples/workflow-template/templates.yaml)
### Fields @@ -2232,157 +2255,159 @@ RetryStrategy provides controls on how to retry a workflow step ## ScriptTemplate ScriptTemplate is a template subtype to enable scripting through code steps +
Examples with this field (click to open)
-- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) - -- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) - -- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) +- [`coinflip-recursive.yaml`](../examples/coinflip-recursive.yaml) - [`coinflip.yaml`](../examples/coinflip.yaml) -- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) - -- [`coinflip-recursive.yaml`](../examples/coinflip-recursive.yaml) +- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) - [`loops-param-result.yaml`](../examples/loops-param-result.yaml) -- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) +- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) -- [`status-reference.yaml`](../examples/status-reference.yaml) +- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) + +- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) - [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) -- [`scripts-python.yaml`](../examples/scripts-python.yaml) +- [`retry-script.yaml`](../examples/retry-script.yaml) -- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) +- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) -- [`retry-script.yaml`](../examples/retry-script.yaml) +- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) + +- [`scripts-python.yaml`](../examples/scripts-python.yaml) + +- [`status-reference.yaml`](../examples/status-reference.yaml)
### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`container`|[`Container`](#container)|_No desription available_| +|`container`|[`Container`](#container)|_No description available_| |`source`|`string`|Source contains the source code of the script to execute| ## WorkflowStep WorkflowStep is a reference to a template to execute in a series of step +
Examples with this field (click to open)
-- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) +- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) -- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) +- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) -- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) +- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) -- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) +- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) -- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) +- [`ci.yaml`](../examples/ci.yaml) + +- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) - [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) -- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) +- [`coinflip-recursive.yaml`](../examples/coinflip-recursive.yaml) - [`coinflip.yaml`](../examples/coinflip.yaml) -- [`parallelism-limit.yaml`](../examples/parallelism-limit.yaml) - -- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) +- [`conditionals.yaml`](../examples/conditionals.yaml) -- [`coinflip-recursive.yaml`](../examples/coinflip-recursive.yaml) +- [`continue-on-fail.yaml`](../examples/continue-on-fail.yaml) -- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) +- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) - [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) -- [`timeouts-workflow.yaml`](../examples/timeouts-workflow.yaml) +- [`daemon-step.yaml`](../examples/daemon-step.yaml) -- [`status-reference.yaml`](../examples/status-reference.yaml) +- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) -- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) +- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) -- [`scripts-python.yaml`](../examples/scripts-python.yaml) +- [`exit-handlers.yaml`](../examples/exit-handlers.yaml) -- [`steps.yaml`](../examples/workflow-template/steps.yaml) +- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) -- [`suspend-template.yaml`](../examples/suspend-template.yaml) +- [`global-outputs.yaml`](../examples/global-outputs.yaml) -- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) +- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) -- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) +- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) -- [`pod-gc-strategy.yaml`](../examples/pod-gc-strategy.yaml) +- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) -- [`continue-on-fail.yaml`](../examples/continue-on-fail.yaml) +- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) -- [`daemon-step.yaml`](../examples/daemon-step.yaml) +- [`loops-maps.yaml`](../examples/loops-maps.yaml) -- [`loops.yaml`](../examples/loops.yaml) +- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) -- [`parallelism-template-limit.yaml`](../examples/parallelism-template-limit.yaml) +- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) -- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) +- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) -- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) +- [`loops.yaml`](../examples/loops.yaml) -- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) +- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) -- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) +- [`output-parameter.yaml`](../examples/output-parameter.yaml) -- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) +- [`parallelism-limit.yaml`](../examples/parallelism-limit.yaml) -- [`steps.yaml`](../examples/steps.yaml) +- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) -- [`loops-maps.yaml`](../examples/loops-maps.yaml) +- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) -- [`exit-handlers.yaml`](../examples/exit-handlers.yaml) +- [`parallelism-template-limit.yaml`](../examples/parallelism-template-limit.yaml) - [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) -- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) +- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) -- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) +- [`pod-gc-strategy.yaml`](../examples/pod-gc-strategy.yaml) -- [`ci.yaml`](../examples/ci.yaml) +- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) -- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) +- [`resubmit.yaml`](../examples/resubmit.yaml) -- [`global-outputs.yaml`](../examples/global-outputs.yaml) +- [`retry-with-steps.yaml`](../examples/retry-with-steps.yaml) -- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) +- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) -- [`template-on-exit.yaml`](../examples/template-on-exit.yaml) +- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) -- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) +- [`scripts-python.yaml`](../examples/scripts-python.yaml) -- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) +- [`status-reference.yaml`](../examples/status-reference.yaml) -- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) +- [`steps.yaml`](../examples/steps.yaml) -- [`conditionals.yaml`](../examples/conditionals.yaml) +- [`suspend-template.yaml`](../examples/suspend-template.yaml) -- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) +- [`template-on-exit.yaml`](../examples/template-on-exit.yaml) -- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) +- [`timeouts-workflow.yaml`](../examples/timeouts-workflow.yaml) -- [`output-parameter.yaml`](../examples/output-parameter.yaml) +- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) -- [`retry-with-steps.yaml`](../examples/workflow-template/retry-with-steps.yaml) +- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) -- [`retry-with-steps.yaml`](../examples/retry-with-steps.yaml) +- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) -- [`templates.yaml`](../examples/workflow-template/templates.yaml) +- [`retry-with-steps.yaml`](../examples/workflow-template/retry-with-steps.yaml) -- [`resubmit.yaml`](../examples/resubmit.yaml) +- [`steps.yaml`](../examples/workflow-template/steps.yaml) -- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) +- [`templates.yaml`](../examples/workflow-template/templates.yaml)
### Fields @@ -2402,13 +2427,14 @@ WorkflowStep is a reference to a template to execute in a series of step ## SuspendTemplate SuspendTemplate is a template subtype to suspend a workflow at a predetermined point in time +
Examples with this field (click to open)
-- [`suspend-template.yaml`](../examples/suspend-template.yaml) - - [`cron-workflow.yaml`](../examples/cron-workflow.yaml) + +- [`suspend-template.yaml`](../examples/suspend-template.yaml)
### Fields @@ -2419,25 +2445,26 @@ SuspendTemplate is a template subtype to suspend a workflow at a predetermined p ## TemplateRef TemplateRef is a reference of template resource. +
Examples with this field (click to open)
+- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) + - [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) -- [`retry-with-steps.yaml`](../examples/workflow-template/retry-with-steps.yaml) +- [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) + +- [`dag.yaml`](../examples/workflow-template/dag.yaml) - [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) -- [`templates.yaml`](../examples/workflow-template/templates.yaml) +- [`retry-with-steps.yaml`](../examples/workflow-template/retry-with-steps.yaml) - [`steps.yaml`](../examples/workflow-template/steps.yaml) -- [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) - -- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) - -- [`dag.yaml`](../examples/workflow-template/dag.yaml) +- [`templates.yaml`](../examples/workflow-template/templates.yaml)
### Fields @@ -2451,51 +2478,53 @@ TemplateRef is a reference of template resource. ## ArchiveStrategy ArchiveStrategy describes how to archive files/directory when saving artifacts +
Examples with this field (click to open)
-- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) - - [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) + +- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml)
### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`none`|[`NoneStrategy`](#nonestrategy)|_No desription available_| -|`tar`|[`TarStrategy`](#tarstrategy)|_No desription available_| +|`none`|[`NoneStrategy`](#nonestrategy)|_No description available_| +|`tar`|[`TarStrategy`](#tarstrategy)|_No description available_| ## ValueFrom ValueFrom describes a location in which to obtain the value to a parameter +
Examples with this field (click to open)
-- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) - -- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) +- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) -- [`secrets.yaml`](../examples/secrets.yaml) +- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) -- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) +- [`global-outputs.yaml`](../examples/global-outputs.yaml) - [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) -- [`output-parameter.yaml`](../examples/output-parameter.yaml) +- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) + +- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) - [`nested-workflow.yaml`](../examples/nested-workflow.yaml) -- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) +- [`output-parameter.yaml`](../examples/output-parameter.yaml) -- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) +- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) -- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) +- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) -- [`global-outputs.yaml`](../examples/global-outputs.yaml) +- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) -- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) +- [`secrets.yaml`](../examples/secrets.yaml)
### Fields @@ -2510,6 +2539,7 @@ ValueFrom describes a location in which to obtain the value to a parameter ## Counter Counter is a Counter prometheus metric +
Examples with this field (click to open)
@@ -2525,6 +2555,7 @@ Counter is a Counter prometheus metric ## Gauge Gauge is a Gauge prometheus metric +
Examples with this field (click to open)
@@ -2541,6 +2572,7 @@ Gauge is a Gauge prometheus metric ## Histogram Histogram is a Histogram prometheus metric +
Examples with this field (click to open)
@@ -2557,26 +2589,28 @@ Histogram is a Histogram prometheus metric ## MetricLabel MetricLabel is a single label for a prometheus metric +
Examples with this field (click to open)
-- [`forever.yaml`](../examples/forever.yaml) - - [`custom-metrics.yaml`](../examples/custom-metrics.yaml) +- [`forever.yaml`](../examples/forever.yaml) + - [`pod-metadata.yaml`](../examples/pod-metadata.yaml)
### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`key`|`string`|_No desription available_| -|`value`|`string`|_No desription available_| +|`key`|`string`|_No description available_| +|`value`|`string`|_No description available_| ## ArtifactoryArtifact ArtifactoryArtifact is the location of an artifactory artifact +
Examples with this field (click to open)
@@ -2587,12 +2621,13 @@ ArtifactoryArtifact is the location of an artifactory artifact ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`artifactoryAuth`|[`ArtifactoryAuth`](#artifactoryauth)|_No desription available_| +|`artifactoryAuth`|[`ArtifactoryAuth`](#artifactoryauth)|_No description available_| |`url`|`string`|URL of the artifact| ## GCSArtifact GCSArtifact is the location of a GCS artifact +
Examples with this field (click to open)
@@ -2603,12 +2638,13 @@ GCSArtifact is the location of a GCS artifact ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`gCSBucket`|[`GCSBucket`](#gcsbucket)|_No desription available_| +|`gCSBucket`|[`GCSBucket`](#gcsbucket)|_No description available_| |`key`|`string`|Key is the path in the bucket where the artifact resides| ## GitArtifact GitArtifact is the location of an git artifact +
Examples with this field (click to open)
@@ -2617,9 +2653,9 @@ GitArtifact is the location of an git artifact - [`ci.yaml`](../examples/ci.yaml) -- [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) - - [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) + +- [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml)
### Fields @@ -2637,6 +2673,7 @@ GitArtifact is the location of an git artifact ## HDFSArtifact HDFSArtifact is the location of an HDFS artifact +
Examples with this field (click to open)
@@ -2648,35 +2685,36 @@ HDFSArtifact is the location of an HDFS artifact | Field Name | Field Type | Description | |:----------:|:----------:|---------------| |`force`|`boolean`|Force copies a file forcibly even if it exists (default: false)| -|`hDFSConfig`|[`HDFSConfig`](#hdfsconfig)|_No desription available_| +|`hDFSConfig`|[`HDFSConfig`](#hdfsconfig)|_No description available_| |`path`|`string`|Path is a file path in HDFS| ## HTTPArtifact HTTPArtifact allows an file served on HTTP to be placed as an input artifact in a container +
Examples with this field (click to open)
-- [`daemon-step.yaml`](../examples/daemon-step.yaml) +- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) + +- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) - [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) -- [`sidecar.yaml`](../examples/sidecar.yaml) +- [`daemon-step.yaml`](../examples/daemon-step.yaml) -- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) +- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) -- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) +- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) -- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) +- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) - [`input-artifact-oss.yaml`](../examples/input-artifact-oss.yaml) -- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) - - [`sidecar-nginx.yaml`](../examples/sidecar-nginx.yaml) -- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) +- [`sidecar.yaml`](../examples/sidecar.yaml)
### Fields @@ -2687,6 +2725,7 @@ HTTPArtifact allows an file served on HTTP to be placed as an input artifact in ## OSSArtifact OSSArtifact is the location of an OSS artifact +
Examples with this field (click to open)
@@ -2698,18 +2737,19 @@ OSSArtifact is the location of an OSS artifact | Field Name | Field Type | Description | |:----------:|:----------:|---------------| |`key`|`string`|Key is the path in the bucket where the artifact resides| -|`oSSBucket`|[`OSSBucket`](#ossbucket)|_No desription available_| +|`oSSBucket`|[`OSSBucket`](#ossbucket)|_No description available_| ## RawArtifact RawArtifact allows raw string content to be placed as an artifact in a container +
Examples with this field (click to open)
-- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) - - [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) + +- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml)
### Fields @@ -2725,50 +2765,51 @@ S3Artifact is the location of an S3 artifact | Field Name | Field Type | Description | |:----------:|:----------:|---------------| |`key`|`string`|Key is the key in the bucket where the artifact resides| -|`s3Bucket`|[`S3Bucket`](#s3bucket)|_No desription available_| +|`s3Bucket`|[`S3Bucket`](#s3bucket)|_No description available_| ## DAGTask DAGTask represents a node in the graph during DAG execution +
Examples with this field (click to open)
-- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) +- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) -- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) +- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) -- [`dag.yaml`](../examples/workflow-template/dag.yaml) +- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) -- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) +- [`dag-continue-on-fail.yaml`](../examples/dag-continue-on-fail.yaml) -- [`dag-targets.yaml`](../examples/dag-targets.yaml) +- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) -- [`dag-nested.yaml`](../examples/dag-nested.yaml) +- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) - [`dag-diamond.yaml`](../examples/dag-diamond.yaml) -- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) +- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) -- [`loops-dag.yaml`](../examples/loops-dag.yaml) +- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) -- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) +- [`dag-nested.yaml`](../examples/dag-nested.yaml) -- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) +- [`dag-targets.yaml`](../examples/dag-targets.yaml) -- [`templates.yaml`](../examples/workflow-template/templates.yaml) +- [`loops-dag.yaml`](../examples/loops-dag.yaml) -- [`resubmit.yaml`](../examples/resubmit.yaml) +- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) -- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) +- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) -- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) +- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) -- [`dag-continue-on-fail.yaml`](../examples/dag-continue-on-fail.yaml) +- [`resubmit.yaml`](../examples/resubmit.yaml) -- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) +- [`dag.yaml`](../examples/workflow-template/dag.yaml) -- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) +- [`templates.yaml`](../examples/workflow-template/templates.yaml)
### Fields @@ -2789,6 +2830,7 @@ DAGTask represents a node in the graph during DAG execution ## Backoff Backoff is a backoff strategy to use within retryStrategy +
Examples with this field (click to open)
@@ -2806,6 +2848,7 @@ Backoff is a backoff strategy to use within retryStrategy ## ContinueOn ContinueOn defines if a workflow should continue even if a task or step fails/errors.It can be specified if the workflow should continue when the pod errors, fails or both. +
Examples with this field (click to open)
@@ -2826,48 +2869,50 @@ ContinueOn defines if a workflow should continue even if a task or step fails/er ## Item +
Examples with this field (click to open)
-- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) +- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) -- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) +- [`ci.yaml`](../examples/ci.yaml) -- [`loops.yaml`](../examples/loops.yaml) +- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) -- [`parallelism-template-limit.yaml`](../examples/parallelism-template-limit.yaml) +- [`loops-dag.yaml`](../examples/loops-dag.yaml) -- [`parallelism-limit.yaml`](../examples/parallelism-limit.yaml) +- [`loops-maps.yaml`](../examples/loops-maps.yaml) -- [`timeouts-workflow.yaml`](../examples/timeouts-workflow.yaml) +- [`loops.yaml`](../examples/loops.yaml) -- [`loops-dag.yaml`](../examples/loops-dag.yaml) +- [`parallelism-limit.yaml`](../examples/parallelism-limit.yaml) -- [`loops-maps.yaml`](../examples/loops-maps.yaml) +- [`parallelism-template-limit.yaml`](../examples/parallelism-template-limit.yaml) -- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) +- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) -- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) +- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) -- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) +- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) -- [`ci.yaml`](../examples/ci.yaml) +- [`timeouts-workflow.yaml`](../examples/timeouts-workflow.yaml)
### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`boolVal`|`boolean`|_No desription available_| -|`listVal`|`Array<`[`ItemValue`](#itemvalue)`>`|_No desription available_| -|`mapVal`|[`ItemValue`](#itemvalue)|_No desription available_| -|`numVal`|`string`|_No desription available_| -|`strVal`|`string`|_No desription available_| -|`type`|`int64`|_No desription available_| +|`boolVal`|`boolean`|_No description available_| +|`listVal`|`Array<`[`ItemValue`](#itemvalue)`>`|_No description available_| +|`mapVal`|[`ItemValue`](#itemvalue)|_No description available_| +|`numVal`|`string`|_No description available_| +|`strVal`|`string`|_No description available_| +|`type`|`int64`|_No description available_| ## Sequence Sequence expands a workflow step into numeric range +
Examples with this field (click to open)
@@ -2886,18 +2931,20 @@ Sequence expands a workflow step into numeric range ## NoneStrategy NoneStrategy indicates to skip tar process and upload the files or directory tree as independentfiles. Note that if the artifact is a directory, the artifact driver must support the ability tosave/load the directory appropriately. +
Examples with this field (click to open)
-- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) - - [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) + +- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml)
## TarStrategy TarStrategy will tar and gzip the file or directory when saving +
Examples with this field (click to open)
@@ -2938,7 +2985,7 @@ HDFSConfig is configurations for HDFS | Field Name | Field Type | Description | |:----------:|:----------:|---------------| |`addresses`|`Array< string >`|Addresses is accessible addresses of HDFS name nodes| -|`hDFSKrbConfig`|[`HDFSKrbConfig`](#hdfskrbconfig)|_No desription available_| +|`hDFSKrbConfig`|[`HDFSKrbConfig`](#hdfskrbconfig)|_No description available_| |`hdfsUser`|`string`|HDFSUser is the user to access HDFS file system.It is ignored if either ccache or keytab is used.| ## OSSBucket @@ -2976,12 +3023,12 @@ S3Bucket contains the access information required for interfacing with an S3 buc ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`boolVal`|`boolean`|_No desription available_| -|`listVal`|`Array< string >`|_No desription available_| -|`mapVal`|`Map< string , string >`|_No desription available_| -|`numVal`|`string`|_No desription available_| -|`strVal`|`string`|_No desription available_| -|`type`|`int64`|_No desription available_| +|`boolVal`|`boolean`|_No description available_| +|`listVal`|`Array< string >`|_No description available_| +|`mapVal`|`Map< string , string >`|_No description available_| +|`numVal`|`string`|_No description available_| +|`strVal`|`string`|_No description available_| +|`type`|`int64`|_No description available_| ## HDFSKrbConfig @@ -3003,221 +3050,222 @@ HDFSKrbConfig is auth configurations for Kerberos ## ObjectMeta ObjectMeta is metadata that all persisted resources must have, which includes all objectsusers must create. +
Examples with this field (click to open)
-- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) - -- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) +- [`archive-location.yaml`](../examples/archive-location.yaml) -- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) +- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) -- [`retry-container-to-completion.yaml`](../examples/retry-container-to-completion.yaml) +- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) -- [`coinflip.yaml`](../examples/coinflip.yaml) +- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) -- [`init-container.yaml`](../examples/init-container.yaml) +- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) -- [`coinflip-recursive.yaml`](../examples/coinflip-recursive.yaml) +- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) -- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) +- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) -- [`steps.yaml`](../examples/workflow-template/steps.yaml) +- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) -- [`suspend-template.yaml`](../examples/suspend-template.yaml) +- [`ci.yaml`](../examples/ci.yaml) -- [`dag.yaml`](../examples/workflow-template/dag.yaml) +- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) -- [`sidecar-dind.yaml`](../examples/sidecar-dind.yaml) +- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) -- [`retry-script.yaml`](../examples/retry-script.yaml) +- [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) -- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) +- [`coinflip-recursive.yaml`](../examples/coinflip-recursive.yaml) -- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) +- [`coinflip.yaml`](../examples/coinflip.yaml) -- [`node-selector.yaml`](../examples/node-selector.yaml) +- [`conditionals.yaml`](../examples/conditionals.yaml) -- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) +- [`continue-on-fail.yaml`](../examples/continue-on-fail.yaml) -- [`retry-on-error.yaml`](../examples/retry-on-error.yaml) +- [`cron-workflow.yaml`](../examples/cron-workflow.yaml) -- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) +- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) -- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) +- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) -- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) +- [`daemon-step.yaml`](../examples/daemon-step.yaml) -- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) +- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) -- [`gc-ttl.yaml`](../examples/gc-ttl.yaml) +- [`dag-continue-on-fail.yaml`](../examples/dag-continue-on-fail.yaml) -- [`loops-dag.yaml`](../examples/loops-dag.yaml) +- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) -- [`output-parameter.yaml`](../examples/output-parameter.yaml) +- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) -- [`resubmit.yaml`](../examples/resubmit.yaml) +- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) -- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) +- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) -- [`image-pull-secrets.yaml`](../examples/image-pull-secrets.yaml) +- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) - [`dag-nested.yaml`](../examples/dag-nested.yaml) -- [`volumes-emptydir.yaml`](../examples/volumes-emptydir.yaml) - -- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) +- [`dag-targets.yaml`](../examples/dag-targets.yaml) -- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) +- [`default-pdb-support.yaml`](../examples/default-pdb-support.yaml) -- [`pod-spec-patch.yaml`](../examples/pod-spec-patch.yaml) +- [`dns-config.yaml`](../examples/dns-config.yaml) -- [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) +- [`exit-handlers.yaml`](../examples/exit-handlers.yaml) -- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) +- [`forever.yaml`](../examples/forever.yaml) -- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) +- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) -- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) +- [`gc-ttl.yaml`](../examples/gc-ttl.yaml) -- [`parallelism-limit.yaml`](../examples/parallelism-limit.yaml) +- [`global-outputs.yaml`](../examples/global-outputs.yaml) -- [`archive-location.yaml`](../examples/archive-location.yaml) +- [`global-parameters.yaml`](../examples/global-parameters.yaml) -- [`timeouts-workflow.yaml`](../examples/timeouts-workflow.yaml) +- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) -- [`timeouts-step.yaml`](../examples/timeouts-step.yaml) +- [`hello-world.yaml`](../examples/hello-world.yaml) -- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) +- [`image-pull-secrets.yaml`](../examples/image-pull-secrets.yaml) -- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) +- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) -- [`loops.yaml`](../examples/loops.yaml) +- [`init-container.yaml`](../examples/init-container.yaml) -- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) +- [`input-artifact-gcs.yaml`](../examples/input-artifact-gcs.yaml) -- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) +- [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) -- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) +- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) - [`input-artifact-oss.yaml`](../examples/input-artifact-oss.yaml) -- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) +- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) -- [`exit-handlers.yaml`](../examples/exit-handlers.yaml) +- [`input-artifact-s3.yaml`](../examples/input-artifact-s3.yaml) -- [`global-parameters.yaml`](../examples/global-parameters.yaml) +- [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) -- [`global-outputs.yaml`](../examples/global-outputs.yaml) +- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) -- [`ci.yaml`](../examples/ci.yaml) +- [`k8s-owner-reference.yaml`](../examples/k8s-owner-reference.yaml) -- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) +- [`k8s-set-owner-reference.yaml`](../examples/k8s-set-owner-reference.yaml) -- [`k8s-owner-reference.yaml`](../examples/k8s-owner-reference.yaml) +- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) -- [`retry-with-steps.yaml`](../examples/retry-with-steps.yaml) +- [`loops-dag.yaml`](../examples/loops-dag.yaml) -- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) +- [`loops-maps.yaml`](../examples/loops-maps.yaml) -- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) +- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) -- [`testvolume.yaml`](../examples/testvolume.yaml) +- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) -- [`retry-backoff.yaml`](../examples/retry-backoff.yaml) +- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) -- [`default-pdb-support.yaml`](../examples/default-pdb-support.yaml) +- [`loops.yaml`](../examples/loops.yaml) -- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) +- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) -- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) +- [`node-selector.yaml`](../examples/node-selector.yaml) -- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) +- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) -- [`status-reference.yaml`](../examples/status-reference.yaml) +- [`output-parameter.yaml`](../examples/output-parameter.yaml) -- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) +- [`parallelism-limit.yaml`](../examples/parallelism-limit.yaml) -- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) +- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) -- [`pod-gc-strategy.yaml`](../examples/pod-gc-strategy.yaml) +- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) -- [`continue-on-fail.yaml`](../examples/continue-on-fail.yaml) +- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) -- [`hello-world.yaml`](../examples/hello-world.yaml) +- [`parallelism-template-limit.yaml`](../examples/parallelism-template-limit.yaml) -- [`sidecar.yaml`](../examples/sidecar.yaml) +- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) -- [`loops-maps.yaml`](../examples/loops-maps.yaml) +- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) -- [`sidecar-nginx.yaml`](../examples/sidecar-nginx.yaml) +- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) -- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) +- [`pod-gc-strategy.yaml`](../examples/pod-gc-strategy.yaml) -- [`template-on-exit.yaml`](../examples/template-on-exit.yaml) +- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) -- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) +- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) -- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) +- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) -- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) +- [`pod-spec-patch.yaml`](../examples/pod-spec-patch.yaml) -- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) +- [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) -- [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) +- [`resubmit.yaml`](../examples/resubmit.yaml) -- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) +- [`retry-backoff.yaml`](../examples/retry-backoff.yaml) -- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) +- [`retry-container-to-completion.yaml`](../examples/retry-container-to-completion.yaml) -- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) +- [`retry-container.yaml`](../examples/retry-container.yaml) -- [`dag-targets.yaml`](../examples/dag-targets.yaml) +- [`retry-on-error.yaml`](../examples/retry-on-error.yaml) -- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) +- [`retry-script.yaml`](../examples/retry-script.yaml) -- [`scripts-python.yaml`](../examples/scripts-python.yaml) +- [`retry-with-steps.yaml`](../examples/retry-with-steps.yaml) -- [`dns-config.yaml`](../examples/dns-config.yaml) +- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) -- [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) +- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) -- [`daemon-step.yaml`](../examples/daemon-step.yaml) +- [`scripts-python.yaml`](../examples/scripts-python.yaml) -- [`parallelism-template-limit.yaml`](../examples/parallelism-template-limit.yaml) +- [`secrets.yaml`](../examples/secrets.yaml) -- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) +- [`sidecar-dind.yaml`](../examples/sidecar-dind.yaml) -- [`k8s-set-owner-reference.yaml`](../examples/k8s-set-owner-reference.yaml) +- [`sidecar-nginx.yaml`](../examples/sidecar-nginx.yaml) -- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) +- [`sidecar.yaml`](../examples/sidecar.yaml) -- [`cron-workflow.yaml`](../examples/cron-workflow.yaml) +- [`status-reference.yaml`](../examples/status-reference.yaml) - [`steps.yaml`](../examples/steps.yaml) -- [`input-artifact-s3.yaml`](../examples/input-artifact-s3.yaml) +- [`suspend-template.yaml`](../examples/suspend-template.yaml) -- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) +- [`template-on-exit.yaml`](../examples/template-on-exit.yaml) -- [`retry-container.yaml`](../examples/retry-container.yaml) +- [`testvolume.yaml`](../examples/testvolume.yaml) -- [`forever.yaml`](../examples/forever.yaml) +- [`timeouts-step.yaml`](../examples/timeouts-step.yaml) -- [`dag-continue-on-fail.yaml`](../examples/dag-continue-on-fail.yaml) +- [`timeouts-workflow.yaml`](../examples/timeouts-workflow.yaml) -- [`secrets.yaml`](../examples/secrets.yaml) +- [`volumes-emptydir.yaml`](../examples/volumes-emptydir.yaml) -- [`conditionals.yaml`](../examples/conditionals.yaml) +- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) -- [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) +- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) + +- [`dag.yaml`](../examples/workflow-template/dag.yaml) + +- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) - [`retry-with-steps.yaml`](../examples/workflow-template/retry-with-steps.yaml) -- [`templates.yaml`](../examples/workflow-template/templates.yaml) +- [`steps.yaml`](../examples/workflow-template/steps.yaml) -- [`input-artifact-gcs.yaml`](../examples/input-artifact-gcs.yaml) +- [`templates.yaml`](../examples/workflow-template/templates.yaml)
### Fields @@ -3254,6 +3302,7 @@ Affinity is a group of affinity scheduling rules. ## PodDNSConfig PodDNSConfig defines the DNS parameters of a pod in addition tothose generated from DNSPolicy. +
Examples with this field (click to open)
@@ -3281,6 +3330,7 @@ HostAlias holds the mapping between IP and hostnames that will be injected as an ## LocalObjectReference LocalObjectReference contains enough information to let you locate thereferenced object inside the same namespace. +
Examples with this field (click to open)
@@ -3307,6 +3357,7 @@ PodDisruptionBudgetSpec is a description of a PodDisruptionBudget. ## PodSecurityContext PodSecurityContext holds pod-level security attributes and common container settings.Some fields are also present in container.securityContext. Field values ofcontainer.securityContext take precedence over field values of PodSecurityContext. +
Examples with this field (click to open)
@@ -3342,12 +3393,14 @@ The pod this Toleration is attached to tolerates any taint that matchesthe tripl ## PersistentVolumeClaim PersistentVolumeClaim is a user's request for and claim to a persistent volume +
Examples (click to open)
- [`testvolume.yaml`](../examples/testvolume.yaml)
+
Examples with this field (click to open)
@@ -3356,9 +3409,9 @@ PersistentVolumeClaim is a user's request for and claim to a persistent volume - [`ci.yaml`](../examples/ci.yaml) -- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) - - [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) + +- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml)
### Fields @@ -3371,17 +3424,18 @@ PersistentVolumeClaim is a user's request for and claim to a persistent volume ## Volume Volume represents a named volume in a pod that may be accessed by any container in the pod. +
Examples with this field (click to open)
-- [`volumes-emptydir.yaml`](../examples/volumes-emptydir.yaml) - - [`init-container.yaml`](../examples/init-container.yaml) -- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) - - [`secrets.yaml`](../examples/secrets.yaml) + +- [`volumes-emptydir.yaml`](../examples/volumes-emptydir.yaml) + +- [`volumes-existing.yaml`](../examples/volumes-existing.yaml)
### Fields @@ -3402,7 +3456,7 @@ Time is a wrapper around time.Time which supports correctmarshaling to YAML and ## ObjectReference -ObjectReference contains enough information to let you inspect or modify the referred object. +ObjectReference contains enough information to let you inspect or modify the referred object.+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object ### Fields | Field Name | Field Type | Description | @@ -3418,195 +3472,196 @@ ObjectReference contains enough information to let you inspect or modify the ref ## Container A single application container that you want to run within a pod. +
Examples with this field (click to open)
-- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) +- [`archive-location.yaml`](../examples/archive-location.yaml) -- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) +- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) -- [`retry-container-to-completion.yaml`](../examples/retry-container-to-completion.yaml) +- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) -- [`coinflip.yaml`](../examples/coinflip.yaml) +- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) -- [`init-container.yaml`](../examples/init-container.yaml) +- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) -- [`coinflip-recursive.yaml`](../examples/coinflip-recursive.yaml) +- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) -- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) +- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) -- [`suspend-template.yaml`](../examples/suspend-template.yaml) +- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) -- [`sidecar-dind.yaml`](../examples/sidecar-dind.yaml) +- [`ci.yaml`](../examples/ci.yaml) -- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) +- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) -- [`node-selector.yaml`](../examples/node-selector.yaml) +- [`coinflip-recursive.yaml`](../examples/coinflip-recursive.yaml) -- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) +- [`coinflip.yaml`](../examples/coinflip.yaml) -- [`retry-on-error.yaml`](../examples/retry-on-error.yaml) +- [`conditionals.yaml`](../examples/conditionals.yaml) -- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) +- [`continue-on-fail.yaml`](../examples/continue-on-fail.yaml) -- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) +- [`cron-workflow.yaml`](../examples/cron-workflow.yaml) -- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) +- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) -- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) +- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) -- [`gc-ttl.yaml`](../examples/gc-ttl.yaml) +- [`daemon-step.yaml`](../examples/daemon-step.yaml) -- [`loops-dag.yaml`](../examples/loops-dag.yaml) +- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) -- [`output-parameter.yaml`](../examples/output-parameter.yaml) +- [`dag-continue-on-fail.yaml`](../examples/dag-continue-on-fail.yaml) -- [`resubmit.yaml`](../examples/resubmit.yaml) +- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) -- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) +- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) -- [`image-pull-secrets.yaml`](../examples/image-pull-secrets.yaml) +- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) + +- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) + +- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) - [`dag-nested.yaml`](../examples/dag-nested.yaml) -- [`volumes-emptydir.yaml`](../examples/volumes-emptydir.yaml) +- [`dag-targets.yaml`](../examples/dag-targets.yaml) -- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) +- [`default-pdb-support.yaml`](../examples/default-pdb-support.yaml) -- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) +- [`dns-config.yaml`](../examples/dns-config.yaml) -- [`pod-spec-patch.yaml`](../examples/pod-spec-patch.yaml) +- [`exit-handlers.yaml`](../examples/exit-handlers.yaml) -- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) +- [`forever.yaml`](../examples/forever.yaml) -- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) +- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) -- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) +- [`gc-ttl.yaml`](../examples/gc-ttl.yaml) -- [`parallelism-limit.yaml`](../examples/parallelism-limit.yaml) +- [`global-outputs.yaml`](../examples/global-outputs.yaml) -- [`archive-location.yaml`](../examples/archive-location.yaml) +- [`global-parameters.yaml`](../examples/global-parameters.yaml) -- [`timeouts-workflow.yaml`](../examples/timeouts-workflow.yaml) +- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) -- [`timeouts-step.yaml`](../examples/timeouts-step.yaml) +- [`hello-world.yaml`](../examples/hello-world.yaml) -- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) +- [`image-pull-secrets.yaml`](../examples/image-pull-secrets.yaml) -- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) +- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) -- [`loops.yaml`](../examples/loops.yaml) +- [`init-container.yaml`](../examples/init-container.yaml) -- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) +- [`input-artifact-gcs.yaml`](../examples/input-artifact-gcs.yaml) -- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) +- [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) -- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) +- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) - [`input-artifact-oss.yaml`](../examples/input-artifact-oss.yaml) -- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) +- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) -- [`exit-handlers.yaml`](../examples/exit-handlers.yaml) +- [`input-artifact-s3.yaml`](../examples/input-artifact-s3.yaml) -- [`global-parameters.yaml`](../examples/global-parameters.yaml) +- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) -- [`global-outputs.yaml`](../examples/global-outputs.yaml) +- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) -- [`ci.yaml`](../examples/ci.yaml) +- [`loops-dag.yaml`](../examples/loops-dag.yaml) -- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) +- [`loops-maps.yaml`](../examples/loops-maps.yaml) -- [`retry-with-steps.yaml`](../examples/retry-with-steps.yaml) +- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) -- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) +- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) -- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) +- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) -- [`retry-backoff.yaml`](../examples/retry-backoff.yaml) +- [`loops.yaml`](../examples/loops.yaml) -- [`default-pdb-support.yaml`](../examples/default-pdb-support.yaml) +- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) -- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) +- [`node-selector.yaml`](../examples/node-selector.yaml) -- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) +- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) -- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) +- [`output-parameter.yaml`](../examples/output-parameter.yaml) -- [`status-reference.yaml`](../examples/status-reference.yaml) +- [`parallelism-limit.yaml`](../examples/parallelism-limit.yaml) -- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) +- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) -- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) +- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) -- [`pod-gc-strategy.yaml`](../examples/pod-gc-strategy.yaml) +- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) -- [`continue-on-fail.yaml`](../examples/continue-on-fail.yaml) +- [`parallelism-template-limit.yaml`](../examples/parallelism-template-limit.yaml) -- [`hello-world.yaml`](../examples/hello-world.yaml) +- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) -- [`sidecar.yaml`](../examples/sidecar.yaml) +- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) -- [`loops-maps.yaml`](../examples/loops-maps.yaml) +- [`pod-gc-strategy.yaml`](../examples/pod-gc-strategy.yaml) -- [`sidecar-nginx.yaml`](../examples/sidecar-nginx.yaml) +- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) -- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) +- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) -- [`template-on-exit.yaml`](../examples/template-on-exit.yaml) +- [`pod-spec-patch.yaml`](../examples/pod-spec-patch.yaml) -- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) +- [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) -- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) +- [`resubmit.yaml`](../examples/resubmit.yaml) -- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) +- [`retry-backoff.yaml`](../examples/retry-backoff.yaml) -- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) +- [`retry-container-to-completion.yaml`](../examples/retry-container-to-completion.yaml) -- [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) +- [`retry-container.yaml`](../examples/retry-container.yaml) -- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) +- [`retry-on-error.yaml`](../examples/retry-on-error.yaml) -- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) +- [`retry-with-steps.yaml`](../examples/retry-with-steps.yaml) -- [`dag-targets.yaml`](../examples/dag-targets.yaml) +- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) -- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) +- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) - [`scripts-python.yaml`](../examples/scripts-python.yaml) -- [`dns-config.yaml`](../examples/dns-config.yaml) - -- [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) - -- [`daemon-step.yaml`](../examples/daemon-step.yaml) +- [`secrets.yaml`](../examples/secrets.yaml) -- [`parallelism-template-limit.yaml`](../examples/parallelism-template-limit.yaml) +- [`sidecar-dind.yaml`](../examples/sidecar-dind.yaml) -- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) +- [`sidecar-nginx.yaml`](../examples/sidecar-nginx.yaml) -- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) +- [`sidecar.yaml`](../examples/sidecar.yaml) -- [`cron-workflow.yaml`](../examples/cron-workflow.yaml) +- [`status-reference.yaml`](../examples/status-reference.yaml) - [`steps.yaml`](../examples/steps.yaml) -- [`input-artifact-s3.yaml`](../examples/input-artifact-s3.yaml) +- [`suspend-template.yaml`](../examples/suspend-template.yaml) -- [`retry-container.yaml`](../examples/retry-container.yaml) +- [`template-on-exit.yaml`](../examples/template-on-exit.yaml) -- [`forever.yaml`](../examples/forever.yaml) +- [`timeouts-step.yaml`](../examples/timeouts-step.yaml) -- [`dag-continue-on-fail.yaml`](../examples/dag-continue-on-fail.yaml) +- [`timeouts-workflow.yaml`](../examples/timeouts-workflow.yaml) -- [`secrets.yaml`](../examples/secrets.yaml) +- [`volumes-emptydir.yaml`](../examples/volumes-emptydir.yaml) -- [`conditionals.yaml`](../examples/conditionals.yaml) +- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) -- [`templates.yaml`](../examples/workflow-template/templates.yaml) +- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) -- [`input-artifact-gcs.yaml`](../examples/input-artifact-gcs.yaml) +- [`templates.yaml`](../examples/workflow-template/templates.yaml)
### Fields @@ -3638,6 +3693,7 @@ A single application container that you want to run within a pod. ## SecretKeySelector SecretKeySelector selects a key of a Secret. +
Examples with this field (click to open)
@@ -3657,6 +3713,7 @@ SecretKeySelector selects a key of a Secret. ## ConfigMapKeySelector Selects a key from a ConfigMap. +
Examples with this field (click to open)
@@ -3688,6 +3745,7 @@ ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the res ## OwnerReference OwnerReference contains enough information to let you identify an owningobject. An owning object must be in the same namespace as the dependent, orbe cluster-scoped, so there is no namespace field. +
Examples with this field (click to open)
@@ -3738,6 +3796,7 @@ Pod anti affinity is a group of inter pod anti affinity scheduling rules. ## PodDNSConfigOption PodDNSConfigOption defines DNS resolver options of a pod. +
Examples with this field (click to open)
@@ -3758,9 +3817,9 @@ PodDNSConfigOption defines DNS resolver options of a pod. ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`intVal`|`int32`|_No desription available_| -|`strVal`|`string`|_No desription available_| -|`type`|`int64`|_No desription available_| +|`intVal`|`int32`|_No description available_| +|`strVal`|`string`|_No description available_| +|`type`|`int64`|_No description available_| ## LabelSelector @@ -3808,221 +3867,222 @@ WindowsSecurityContextOptions contain Windows-specific options and credentials. ## PersistentVolumeClaimSpec PersistentVolumeClaimSpec describes the common attributes of storage devicesand allows a Source for provider-specific attributes +
Examples with this field (click to open)
-- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) - -- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) +- [`archive-location.yaml`](../examples/archive-location.yaml) -- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) +- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) -- [`retry-container-to-completion.yaml`](../examples/retry-container-to-completion.yaml) +- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) -- [`coinflip.yaml`](../examples/coinflip.yaml) +- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) -- [`init-container.yaml`](../examples/init-container.yaml) +- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) -- [`coinflip-recursive.yaml`](../examples/coinflip-recursive.yaml) +- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) -- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) +- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) -- [`steps.yaml`](../examples/workflow-template/steps.yaml) +- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) -- [`suspend-template.yaml`](../examples/suspend-template.yaml) +- [`ci.yaml`](../examples/ci.yaml) -- [`dag.yaml`](../examples/workflow-template/dag.yaml) +- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) -- [`sidecar-dind.yaml`](../examples/sidecar-dind.yaml) +- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) -- [`retry-script.yaml`](../examples/retry-script.yaml) +- [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) -- [`cluster-wftmpl-dag.yaml`](../examples/cluster-workflow-template/cluster-wftmpl-dag.yaml) +- [`coinflip-recursive.yaml`](../examples/coinflip-recursive.yaml) -- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) +- [`coinflip.yaml`](../examples/coinflip.yaml) -- [`node-selector.yaml`](../examples/node-selector.yaml) +- [`conditionals.yaml`](../examples/conditionals.yaml) -- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) +- [`continue-on-fail.yaml`](../examples/continue-on-fail.yaml) -- [`retry-on-error.yaml`](../examples/retry-on-error.yaml) +- [`cron-workflow.yaml`](../examples/cron-workflow.yaml) -- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) +- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) -- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) +- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) -- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) +- [`daemon-step.yaml`](../examples/daemon-step.yaml) -- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) +- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) -- [`gc-ttl.yaml`](../examples/gc-ttl.yaml) +- [`dag-continue-on-fail.yaml`](../examples/dag-continue-on-fail.yaml) -- [`loops-dag.yaml`](../examples/loops-dag.yaml) +- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) -- [`output-parameter.yaml`](../examples/output-parameter.yaml) +- [`dag-diamond-steps.yaml`](../examples/dag-diamond-steps.yaml) -- [`resubmit.yaml`](../examples/resubmit.yaml) +- [`dag-diamond.yaml`](../examples/dag-diamond.yaml) -- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) +- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) -- [`image-pull-secrets.yaml`](../examples/image-pull-secrets.yaml) +- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) - [`dag-nested.yaml`](../examples/dag-nested.yaml) -- [`volumes-emptydir.yaml`](../examples/volumes-emptydir.yaml) - -- [`arguments-parameters.yaml`](../examples/arguments-parameters.yaml) +- [`dag-targets.yaml`](../examples/dag-targets.yaml) -- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) +- [`default-pdb-support.yaml`](../examples/default-pdb-support.yaml) -- [`pod-spec-patch.yaml`](../examples/pod-spec-patch.yaml) +- [`dns-config.yaml`](../examples/dns-config.yaml) -- [`mixed-cluster-namespaced-wftmpl-steps.yaml`](../examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml) +- [`exit-handlers.yaml`](../examples/exit-handlers.yaml) -- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) +- [`forever.yaml`](../examples/forever.yaml) -- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) +- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) -- [`dag-multiroot.yaml`](../examples/dag-multiroot.yaml) +- [`gc-ttl.yaml`](../examples/gc-ttl.yaml) -- [`parallelism-limit.yaml`](../examples/parallelism-limit.yaml) +- [`global-outputs.yaml`](../examples/global-outputs.yaml) -- [`archive-location.yaml`](../examples/archive-location.yaml) +- [`global-parameters.yaml`](../examples/global-parameters.yaml) -- [`timeouts-workflow.yaml`](../examples/timeouts-workflow.yaml) +- [`hdfs-artifact.yaml`](../examples/hdfs-artifact.yaml) -- [`timeouts-step.yaml`](../examples/timeouts-step.yaml) +- [`hello-world.yaml`](../examples/hello-world.yaml) -- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) +- [`image-pull-secrets.yaml`](../examples/image-pull-secrets.yaml) -- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) +- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) -- [`loops.yaml`](../examples/loops.yaml) +- [`init-container.yaml`](../examples/init-container.yaml) -- [`clustertemplates.yaml`](../examples/cluster-workflow-template/clustertemplates.yaml) +- [`input-artifact-gcs.yaml`](../examples/input-artifact-gcs.yaml) -- [`dag-coinflip.yaml`](../examples/dag-coinflip.yaml) +- [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) -- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) +- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) - [`input-artifact-oss.yaml`](../examples/input-artifact-oss.yaml) -- [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) +- [`input-artifact-raw.yaml`](../examples/input-artifact-raw.yaml) -- [`exit-handlers.yaml`](../examples/exit-handlers.yaml) +- [`input-artifact-s3.yaml`](../examples/input-artifact-s3.yaml) -- [`global-parameters.yaml`](../examples/global-parameters.yaml) +- [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) -- [`global-outputs.yaml`](../examples/global-outputs.yaml) +- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) -- [`ci.yaml`](../examples/ci.yaml) +- [`k8s-owner-reference.yaml`](../examples/k8s-owner-reference.yaml) -- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) +- [`k8s-set-owner-reference.yaml`](../examples/k8s-set-owner-reference.yaml) -- [`k8s-owner-reference.yaml`](../examples/k8s-owner-reference.yaml) +- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) -- [`retry-with-steps.yaml`](../examples/retry-with-steps.yaml) +- [`loops-dag.yaml`](../examples/loops-dag.yaml) -- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) +- [`loops-maps.yaml`](../examples/loops-maps.yaml) -- [`dag-disable-failFast.yaml`](../examples/dag-disable-failFast.yaml) +- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) -- [`testvolume.yaml`](../examples/testvolume.yaml) +- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) -- [`retry-backoff.yaml`](../examples/retry-backoff.yaml) +- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) -- [`default-pdb-support.yaml`](../examples/default-pdb-support.yaml) +- [`loops.yaml`](../examples/loops.yaml) -- [`input-artifact-http.yaml`](../examples/input-artifact-http.yaml) +- [`nested-workflow.yaml`](../examples/nested-workflow.yaml) -- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) +- [`node-selector.yaml`](../examples/node-selector.yaml) -- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) +- [`output-artifact-s3.yaml`](../examples/output-artifact-s3.yaml) -- [`status-reference.yaml`](../examples/status-reference.yaml) +- [`output-parameter.yaml`](../examples/output-parameter.yaml) -- [`loops-sequence.yaml`](../examples/loops-sequence.yaml) +- [`parallelism-limit.yaml`](../examples/parallelism-limit.yaml) -- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) +- [`parallelism-nested-dag.yaml`](../examples/parallelism-nested-dag.yaml) -- [`pod-gc-strategy.yaml`](../examples/pod-gc-strategy.yaml) +- [`parallelism-nested-workflow.yaml`](../examples/parallelism-nested-workflow.yaml) -- [`continue-on-fail.yaml`](../examples/continue-on-fail.yaml) +- [`parallelism-nested.yaml`](../examples/parallelism-nested.yaml) -- [`hello-world.yaml`](../examples/hello-world.yaml) +- [`parallelism-template-limit.yaml`](../examples/parallelism-template-limit.yaml) -- [`sidecar.yaml`](../examples/sidecar.yaml) +- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) -- [`loops-maps.yaml`](../examples/loops-maps.yaml) +- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) -- [`sidecar-nginx.yaml`](../examples/sidecar-nginx.yaml) +- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) -- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) +- [`pod-gc-strategy.yaml`](../examples/pod-gc-strategy.yaml) -- [`template-on-exit.yaml`](../examples/template-on-exit.yaml) +- [`pod-metadata.yaml`](../examples/pod-metadata.yaml) -- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) +- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) -- [`artifactory-artifact.yaml`](../examples/artifactory-artifact.yaml) +- [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) -- [`arguments-artifacts.yaml`](../examples/arguments-artifacts.yaml) +- [`pod-spec-patch.yaml`](../examples/pod-spec-patch.yaml) -- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) +- [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) -- [`input-artifact-git.yaml`](../examples/input-artifact-git.yaml) +- [`resubmit.yaml`](../examples/resubmit.yaml) -- [`loops-param-argument.yaml`](../examples/loops-param-argument.yaml) +- [`retry-backoff.yaml`](../examples/retry-backoff.yaml) -- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) +- [`retry-container-to-completion.yaml`](../examples/retry-container-to-completion.yaml) -- [`artifact-disable-archive.yaml`](../examples/artifact-disable-archive.yaml) +- [`retry-container.yaml`](../examples/retry-container.yaml) -- [`dag-targets.yaml`](../examples/dag-targets.yaml) +- [`retry-on-error.yaml`](../examples/retry-on-error.yaml) -- [`loops-param-result.yaml`](../examples/loops-param-result.yaml) +- [`retry-script.yaml`](../examples/retry-script.yaml) -- [`scripts-python.yaml`](../examples/scripts-python.yaml) +- [`retry-with-steps.yaml`](../examples/retry-with-steps.yaml) -- [`dns-config.yaml`](../examples/dns-config.yaml) +- [`scripts-bash.yaml`](../examples/scripts-bash.yaml) -- [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) +- [`scripts-javascript.yaml`](../examples/scripts-javascript.yaml) -- [`daemon-step.yaml`](../examples/daemon-step.yaml) +- [`scripts-python.yaml`](../examples/scripts-python.yaml) -- [`parallelism-template-limit.yaml`](../examples/parallelism-template-limit.yaml) +- [`secrets.yaml`](../examples/secrets.yaml) -- [`artifact-passing.yaml`](../examples/artifact-passing.yaml) +- [`sidecar-dind.yaml`](../examples/sidecar-dind.yaml) -- [`k8s-set-owner-reference.yaml`](../examples/k8s-set-owner-reference.yaml) +- [`sidecar-nginx.yaml`](../examples/sidecar-nginx.yaml) -- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) +- [`sidecar.yaml`](../examples/sidecar.yaml) -- [`cron-workflow.yaml`](../examples/cron-workflow.yaml) +- [`status-reference.yaml`](../examples/status-reference.yaml) - [`steps.yaml`](../examples/steps.yaml) -- [`input-artifact-s3.yaml`](../examples/input-artifact-s3.yaml) +- [`suspend-template.yaml`](../examples/suspend-template.yaml) -- [`parameter-aggregation-script.yaml`](../examples/parameter-aggregation-script.yaml) +- [`template-on-exit.yaml`](../examples/template-on-exit.yaml) -- [`retry-container.yaml`](../examples/retry-container.yaml) +- [`testvolume.yaml`](../examples/testvolume.yaml) -- [`forever.yaml`](../examples/forever.yaml) +- [`timeouts-step.yaml`](../examples/timeouts-step.yaml) -- [`dag-continue-on-fail.yaml`](../examples/dag-continue-on-fail.yaml) +- [`timeouts-workflow.yaml`](../examples/timeouts-workflow.yaml) -- [`secrets.yaml`](../examples/secrets.yaml) +- [`volumes-emptydir.yaml`](../examples/volumes-emptydir.yaml) -- [`conditionals.yaml`](../examples/conditionals.yaml) +- [`volumes-existing.yaml`](../examples/volumes-existing.yaml) -- [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) +- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) + +- [`dag.yaml`](../examples/workflow-template/dag.yaml) + +- [`hello-world.yaml`](../examples/workflow-template/hello-world.yaml) - [`retry-with-steps.yaml`](../examples/workflow-template/retry-with-steps.yaml) -- [`templates.yaml`](../examples/workflow-template/templates.yaml) +- [`steps.yaml`](../examples/workflow-template/steps.yaml) -- [`input-artifact-gcs.yaml`](../examples/input-artifact-gcs.yaml) +- [`templates.yaml`](../examples/workflow-template/templates.yaml)
### Fields @@ -4087,6 +4147,7 @@ Represents the source of a volume to mount.Only one of its members may be specif ## EnvVar EnvVar represents an environment variable present in a Container. +
Examples with this field (click to open)
@@ -4154,27 +4215,28 @@ ContainerPort represents a network port in a single container. ## ResourceRequirements ResourceRequirements describes the compute resource requirements. +
Examples with this field (click to open)
-- [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) +- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) -- [`testvolume.yaml`](../examples/testvolume.yaml) +- [`ci.yaml`](../examples/ci.yaml) -- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) +- [`dns-config.yaml`](../examples/dns-config.yaml) - [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) -- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) +- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) - [`pod-spec-patch-wf-tmpl.yaml`](../examples/pod-spec-patch-wf-tmpl.yaml) -- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) +- [`pod-spec-yaml-patch.yaml`](../examples/pod-spec-yaml-patch.yaml) -- [`ci.yaml`](../examples/ci.yaml) +- [`testvolume.yaml`](../examples/testvolume.yaml) -- [`dns-config.yaml`](../examples/dns-config.yaml) +- [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml)
### Fields @@ -4186,6 +4248,7 @@ ResourceRequirements describes the compute resource requirements. ## SecurityContext SecurityContext holds security configuration that will be applied to a container.Some fields are present in both SecurityContext and PodSecurityContext. When bothare set, the values in SecurityContext take precedence. +
Examples with this field (click to open)
@@ -4220,10 +4283,17 @@ volumeDevice describes a mapping of a raw block device within a container. ## VolumeMount VolumeMount describes a mounting of a Volume within a container. +
Examples with this field (click to open)
+- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) + +- [`ci.yaml`](../examples/ci.yaml) + +- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) + - [`init-container.yaml`](../examples/init-container.yaml) - [`secrets.yaml`](../examples/secrets.yaml) @@ -4233,12 +4303,6 @@ VolumeMount describes a mounting of a Volume within a container. - [`volumes-existing.yaml`](../examples/volumes-existing.yaml) - [`volumes-pvc.yaml`](../examples/volumes-pvc.yaml) - -- [`fun-with-gifs.yaml`](../examples/fun-with-gifs.yaml) - -- [`ci-output-artifact.yaml`](../examples/ci-output-artifact.yaml) - -- [`ci.yaml`](../examples/ci.yaml)
### Fields @@ -4329,7 +4393,7 @@ Quantity is a fixed-point representation of a number.It provides convenient mars ### Fields | Field Name | Field Type | Description | |:----------:|:----------:|---------------| -|`string`|`string`|_No desription available_| +|`string`|`string`|_No description available_| ## PersistentVolumeClaimCondition @@ -4342,8 +4406,8 @@ PersistentVolumeClaimCondition contails details about state of pvc |`lastTransitionTime`|[`Time`](#time)|Last time the condition transitioned from one status to another.| |`message`|`string`|Human-readable message indicating details about last transition.| |`reason`|`string`|Unique, this should be a short, machine understandable string that gives the reasonfor condition's last transition. If it reports "ResizeStarted" that means the underlyingpersistent volume is being resized.| -|`status`|`string`|_No desription available_| -|`type`|`string`|_No desription available_| +|`status`|`string`|_No description available_| +|`type`|`string`|_No description available_| ## AWSElasticBlockStoreVolumeSource @@ -4417,7 +4481,7 @@ Adapts a ConfigMap into a volume.The contents of the target ConfigMap's Data fie |:----------:|:----------:|---------------| |`defaultMode`|`int32`|Optional: mode bits to use on created files by default. Must be avalue between 0 and 0777. Defaults to 0644.Directories within the path are not affected by this setting.This might be in conflict with other options that affect the filemode, like fsGroup, and the result can be other mode bits set.| |`items`|`Array<`[`KeyToPath`](#keytopath)`>`|If unspecified, each key-value pair in the Data field of the referencedConfigMap will be projected into the volume as a file whose name is thekey and content is the value. If specified, the listed keys will beprojected into the specified paths, and unlisted keys will not bepresent. If a key is specified which is not present in the ConfigMap,the volume setup will error unless it is marked optional. Paths must berelative and may not contain the '..' path or start with '..'.| -|`localObjectReference`|[`LocalObjectReference`](#localobjectreference)|_No desription available_| +|`localObjectReference`|[`LocalObjectReference`](#localobjectreference)|_No description available_| |`optional`|`boolean`|Specify whether the ConfigMap or its keys must be defined| ## CSIVolumeSource @@ -4446,13 +4510,14 @@ DownwardAPIVolumeSource represents a volume containing downward API io.argoproj. ## EmptyDirVolumeSource Represents an empty directory for a pod.Empty directory volumes support ownership management and SELinux relabeling. +
Examples with this field (click to open)
-- [`volumes-emptydir.yaml`](../examples/volumes-emptydir.yaml) - - [`init-container.yaml`](../examples/init-container.yaml) + +- [`volumes-emptydir.yaml`](../examples/volumes-emptydir.yaml)
### Fields @@ -4574,6 +4639,7 @@ Represents an NFS mount that lasts the lifetime of a pod.NFS volumes do not supp ## PersistentVolumeClaimVolumeSource PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace.This volume finds the bound PV and mounts that volume for the pod. APersistentVolumeClaimVolumeSource is, essentially, a wrapper around anothertype of volume that is owned by someone else (the system). +
Examples with this field (click to open)
@@ -4669,6 +4735,7 @@ ScaleIOVolumeSource represents a persistent ScaleIO volume ## SecretVolumeSource Adapts a Secret into a volume.The contents of the target Secret's Data field will be presented in a volumeas files using the keys in the Data field as the file names.Secret volumes support ownership management and SELinux relabeling. +
Examples with this field (click to open)
@@ -4712,33 +4779,34 @@ Represents a vSphere volume resource. ## EnvVarSource EnvVarSource represents a source for the value of an EnvVar. +
Examples with this field (click to open)
-- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) - -- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) +- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) -- [`secrets.yaml`](../examples/secrets.yaml) +- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) -- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) +- [`global-outputs.yaml`](../examples/global-outputs.yaml) - [`k8s-jobs.yaml`](../examples/k8s-jobs.yaml) -- [`output-parameter.yaml`](../examples/output-parameter.yaml) +- [`k8s-orchestration.yaml`](../examples/k8s-orchestration.yaml) + +- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) - [`nested-workflow.yaml`](../examples/nested-workflow.yaml) -- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) +- [`output-parameter.yaml`](../examples/output-parameter.yaml) -- [`k8s-wait-wf.yaml`](../examples/k8s-wait-wf.yaml) +- [`parameter-aggregation-dag.yaml`](../examples/parameter-aggregation-dag.yaml) -- [`artifact-path-placeholders.yaml`](../examples/artifact-path-placeholders.yaml) +- [`parameter-aggregation.yaml`](../examples/parameter-aggregation.yaml) -- [`global-outputs.yaml`](../examples/global-outputs.yaml) +- [`pod-spec-from-previous-step.yaml`](../examples/pod-spec-from-previous-step.yaml) -- [`custom-metrics.yaml`](../examples/custom-metrics.yaml) +- [`secrets.yaml`](../examples/secrets.yaml)
### Fields @@ -4868,17 +4936,18 @@ ExecAction describes a "run in container" action. ## HTTPGetAction HTTPGetAction describes an action based on HTTP Get requests. +
Examples with this field (click to open)
-- [`daemon-step.yaml`](../examples/daemon-step.yaml) +- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) -- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml) +- [`daemon-step.yaml`](../examples/daemon-step.yaml) - [`dag-daemon-task.yaml`](../examples/dag-daemon-task.yaml) -- [`daemon-nginx.yaml`](../examples/daemon-nginx.yaml) +- [`influxdb-ci.yaml`](../examples/influxdb-ci.yaml)
### Fields @@ -4919,7 +4988,7 @@ Adapts a ConfigMap into a projected volume.The contents of the target ConfigMap' | Field Name | Field Type | Description | |:----------:|:----------:|---------------| |`items`|`Array<`[`KeyToPath`](#keytopath)`>`|If unspecified, each key-value pair in the Data field of the referencedConfigMap will be projected into the volume as a file whose name is thekey and content is the value. If specified, the listed keys will beprojected into the specified paths, and unlisted keys will not bepresent. If a key is specified which is not present in the ConfigMap,the volume setup will error unless it is marked optional. Paths must berelative and may not contain the '..' path or start with '..'.| -|`localObjectReference`|[`LocalObjectReference`](#localobjectreference)|_No desription available_| +|`localObjectReference`|[`LocalObjectReference`](#localobjectreference)|_No description available_| |`optional`|`boolean`|Specify whether the ConfigMap or its keys must be defined| ## DownwardAPIProjection @@ -4934,6 +5003,7 @@ Represents downward API info for projecting into a projected volume.Note that th ## SecretProjection Adapts a secret into a projected volume.The contents of the target Secret's Data field will be presented in aprojected volume as files using the keys in the Data field as the file names.Note that this is identical to a secret volume source without the defaultmode. +
Examples with this field (click to open)
@@ -4945,7 +5015,7 @@ Adapts a secret into a projected volume.The contents of the target Secret's Data | Field Name | Field Type | Description | |:----------:|:----------:|---------------| |`items`|`Array<`[`KeyToPath`](#keytopath)`>`|If unspecified, each key-value pair in the Data field of the referencedSecret will be projected into the volume as a file whose name is thekey and content is the value. If specified, the listed keys will beprojected into the specified paths, and unlisted keys will not bepresent. If a key is specified which is not present in the Secret,the volume setup will error unless it is marked optional. Paths must berelative and may not contain the '..' path or start with '..'.| -|`localObjectReference`|[`LocalObjectReference`](#localobjectreference)|_No desription available_| +|`localObjectReference`|[`LocalObjectReference`](#localobjectreference)|_No description available_| |`optional`|`boolean`|Specify whether the Secret or its key must be defined| ## ServiceAccountTokenProjection @@ -4967,4 +5037,4 @@ HTTPHeader describes a custom header to be used in HTTP probes | Field Name | Field Type | Description | |:----------:|:----------:|---------------| |`name`|`string`|The header field name| -|`value`|`string`|The header field value| \ No newline at end of file +|`value`|`string`|The header field value| diff --git a/hack/docgen.go b/hack/docgen.go new file mode 100644 index 000000000000..579fa530bfc2 --- /dev/null +++ b/hack/docgen.go @@ -0,0 +1,344 @@ +package main + +import ( + "encoding/json" + "fmt" + "io/ioutil" + "os" + "path/filepath" + "regexp" + "sort" + "strings" +) + +const sectionHeader = ` + +# %s +` + +const fieldHeader = ` + +## %s + +%s` + +const fieldTableHeader = ` + +### Fields +| Field Name | Field Type | Description | +|:----------:|:----------:|---------------|` + +const tableRow = ` +|` + "`%s`" + `|%s|%s|` + +const depTableRow = ` +|~` + "`%s`" + `~|~%s~|%s|` + +const dropdownOpener = ` + +
+%s (click to open) +
` + +const listElement = ` + +- %s` + +const dropdownCloser = ` +
` + +func cleanTitle(title string) string { + if index := strings.Index(title, "+g"); index != -1 { + return title[:index] + } + return title +} + +func cleanDesc(desc string) string { + desc = strings.ReplaceAll(desc, "\n", "") + dep := "" + if index := strings.Index(desc, "DEPRECATED"); index != -1 { + dep = " " + desc[:index] + } + + if index := strings.Index(desc, "+patch"); index != -1 { + desc = desc[:index] + } + if index := strings.Index(desc, "+proto"); index != -1 { + desc = desc[:index] + } + if index := strings.Index(desc, "+option"); index != -1 { + desc = desc[:index] + } + + if dep != "" && !strings.Contains(desc, "DEPRECATED") { + desc += dep + } + return desc +} + +func getRow(name, objType, desc string) string { + if index := strings.Index(desc, "DEPRECATED"); index != -1 { + return fmt.Sprintf(depTableRow, name, objType, "~"+desc[:index]+"~ "+desc[index:]) + } + return fmt.Sprintf(tableRow, name, objType, desc) +} + +func getNameFromFullName(fullName string) string { + split := strings.Split(fullName, ".") + return split[len(split)-1] +} + +func link(text, linkTo string) string { + return fmt.Sprintf("[%s](%s)", text, linkTo) +} + +func getDescFromField(field map[string]interface{}) string { + if val, ok := field["description"]; ok { + return cleanDesc(val.(string)) + } else if val, ok := field["title"]; ok { + return cleanDesc(cleanTitle(val.(string))) + } + return "_No description available_" +} + +func getExamples(examples Set, summary string) string { + out := fmt.Sprintf(dropdownOpener, summary) + for _, example := range sortedSetKeys(examples) { + split := strings.Split(example, "/") + name := split[len(split)-1] + out += fmt.Sprintf(listElement, link(fmt.Sprintf("`%s`", name), "../"+example)) + } + out += dropdownCloser + return out +} + +func getKeyValueFieldTypes(field map[string]interface{}) (string, string) { + keyType, valType := "string", "string" + addProps := field["additionalProperties"].(map[string]interface{}) + if val, ok := addProps["type"]; ok { + keyType = val.(string) + } + if val, ok := addProps["format"]; ok { + valType = val.(string) + } + return keyType, valType +} + +func getObjectType(field map[string]interface{}, addToQueue func(string)) string { + objTypeRaw := field["type"].(string) + if objTypeRaw == "array" { + if ref, ok := field["items"].(map[string]interface{})["$ref"]; ok { + refString := ref.(string)[14:] + addToQueue(refString) + + name := getNameFromFullName(refString) + if refString == "io.argoproj.workflow.v1alpha1.WorkflowStep" { + return fmt.Sprintf("`Array>`", link(fmt.Sprintf("`%s`", name), fmt.Sprintf("#"+strings.ToLower(name)))) + } + return fmt.Sprintf("`Array<`%s`>`", link(fmt.Sprintf("`%s`", name), fmt.Sprintf("#"+strings.ToLower(name)))) + } + fullName := field["items"].(map[string]interface{})["type"].(string) + return fmt.Sprintf("`Array< %s >`", getNameFromFullName(fullName)) + } else if objTypeRaw == "object" { + if ref, ok := field["additionalProperties"].(map[string]interface{})["$ref"]; ok { + refString := ref.(string)[14:] + addToQueue(refString) + name := getNameFromFullName(refString) + return link(fmt.Sprintf("`%s`", name), "#"+strings.ToLower(name)) + } + key, val := getKeyValueFieldTypes(field) + return fmt.Sprintf("`Map< %s , %s >`", key, val) + } else if format, ok := field["format"].(string); ok { + return fmt.Sprintf("`%s`", format) + } + return fmt.Sprintf("`%s`", field["type"].(string)) +} + +func glob(dir string, ext string) ([]string, error) { + var files []string + err := filepath.Walk(dir, func(path string, f os.FileInfo, err error) error { + if filepath.Ext(path) == ext { + files = append(files, path) + } + return nil + }) + return files, err +} + +func sortedMapInterfaceKeys(in map[string]interface{}) []string { + var stringList []string + for key := range in { + stringList = append(stringList, key) + } + sort.Strings(stringList) + return stringList +} + +func sortedSetKeys(in Set) []string { + var stringList []string + for key := range in { + stringList = append(stringList, key) + } + sort.Strings(stringList) + return stringList +} + +type DocGeneratorContext struct { + doneFields Set + queue []string + external []string + index map[string]Set + jsonName map[string]string + defs map[string]interface{} +} + +type Set map[string]bool + +func NewDocGeneratorContext() *DocGeneratorContext { + return &DocGeneratorContext{ + doneFields: make(Set), + queue: []string{"io.argoproj.workflow.v1alpha1.Workflow", "io.argoproj.workflow.v1alpha1.CronWorkflow", + "io.argoproj.workflow.v1alpha1.WorkflowTemplate"}, + external: []string{}, + index: make(map[string]Set), + jsonName: make(map[string]string), + defs: make(map[string]interface{}), + } +} + +func (c *DocGeneratorContext) loadFiles() { + bytes, err := ioutil.ReadFile("api/openapi-spec/swagger.json") + if err != nil { + panic(err) + } + swagger := make(map[string]interface{}) + err = json.Unmarshal(bytes, &swagger) + if err != nil { + panic(err) + } + c.defs = swagger["definitions"].(map[string]interface{}) + + files, err := glob("examples/", ".yaml") + if err != nil { + panic(err) + } + for _, fileName := range files { + bytes, err := ioutil.ReadFile(fileName) + if err != nil { + panic(err) + } + + r := regexp.MustCompile(`kind: ([a-zA-Z]+)`) + kinds := r.FindAllStringSubmatch(string(bytes), -1) + for _, kind := range kinds { + if set, ok := c.index[kind[1]]; ok { + set[fileName] = true + } else { + c.index[kind[1]] = make(Set) + c.index[kind[1]][fileName] = true + } + } + + r = regexp.MustCompile(`([a-zA-Z]+?):`) + finds := r.FindAllStringSubmatch(string(bytes), -1) + for _, find := range finds { + if set, ok := c.index[find[1]]; ok { + set[fileName] = true + } else { + c.index[find[1]] = make(Set) + c.index[find[1]][fileName] = true + } + } + } +} + +func (c *DocGeneratorContext) addToQueue(ref, jsonFieldName string) { + if ref == "io.argoproj.workflow.v1alpha1.ParallelSteps" { + ref = "io.argoproj.workflow.v1alpha1.WorkflowStep" + } + if _, ok := c.doneFields[ref]; !ok { + c.doneFields[ref] = true + c.jsonName[ref] = jsonFieldName + if strings.Contains(ref, "io.argoproj.workflow") { + c.queue = append(c.queue, ref) + } else { + c.external = append(c.external, ref) + } + } +} + +func (c *DocGeneratorContext) getDesc(key string) string { + obj := c.defs[key].(map[string]interface{}) + if val, ok := obj["description"]; ok { + return cleanDesc(val.(string)) + } else if val, ok := obj["title"]; ok { + return cleanDesc(cleanTitle(val.(string))) + } + return "_No description available_" +} + +func (c *DocGeneratorContext) getTemplate(key string) string { + name := getNameFromFullName(key) + out := fmt.Sprintf(fieldHeader, name, c.getDesc(key)) + + if set, ok := c.index[name]; ok { + out += getExamples(set, "Examples") + } + if jsonName, ok := c.jsonName[key]; ok { + if set, ok := c.index[jsonName]; ok { + out += getExamples(set, "Examples with this field") + } + } + + var properties map[string]interface{} + if props, ok := c.defs[key].(map[string]interface{})["properties"]; ok { + properties = props.(map[string]interface{}) + } else { + return out + } + + out += fieldTableHeader + for _, jsonFieldName := range sortedMapInterfaceKeys(properties) { + field := properties[jsonFieldName].(map[string]interface{}) + if ref, ok := field["$ref"]; ok { + refString := ref.(string)[14:] + c.addToQueue(refString, jsonFieldName) + + desc := getDescFromField(field) + refName := getNameFromFullName(refString) + out += getRow(jsonFieldName, link(fmt.Sprintf("`%s`", refName), "#"+strings.ToLower(refName)), cleanDesc(desc)) + } else { + objType := getObjectType(field, func(ref string) { c.addToQueue(ref, jsonFieldName) }) + desc := getDescFromField(field) + out += getRow(jsonFieldName, objType, cleanDesc(desc)) + } + } + return out +} + +func (c *DocGeneratorContext) generate() string { + c.loadFiles() + + out := fmt.Sprintf(sectionHeader, "Argo Fields") + for len(c.queue) > 0 { + temp := c.queue[0] + c.queue = c.queue[1:] + out += c.getTemplate(temp) + } + + out += fmt.Sprintf(sectionHeader, "External Fields") + for len(c.external) > 0 { + temp := c.external[0] + c.external = c.external[1:] + out += c.getTemplate(temp) + } + + return out +} + +func generateDocs() { + c := NewDocGeneratorContext() + //c.generate() + fmt.Println(c.generate()) +} diff --git a/hack/docgen.py b/hack/docgen.py deleted file mode 100644 index c767a679573c..000000000000 --- a/hack/docgen.py +++ /dev/null @@ -1,239 +0,0 @@ -import json -import re -from pathlib import Path - -SECTION_HEADER = """ - -# %s -""" - -FIELD_HEADER = """ - -## %s - -%s""" - -FIELD_TABLE_HEADER = """ - -### Fields -| Field Name | Field Type | Description | -|:----------:|:----------:|---------------|""" - -TABLE_ROW = """ -|`%s`|%s|%s|""" - -DEP_TABLE_ROW = """ -|~`%s`~|~%s~|%s|""" - -DROPDOWN_OPENER = """ -
-%s (click to open) -
""" - -LIST_ELEMENT = """ - -- %s""" - -DROPDOWN_CLOSER = """ -
""" - - -def clean_title(title): - if "\n+" in title: - return title[:title.find("\n+")] - return title - - -def clean_desc(desc): - desc = desc.replace("\n", "") - dep = "" - if 'DEPRECATED' in desc: - dep = " " + desc[desc.find("DEPRECATED"):] - - if '+patch' in desc: - desc = desc[:desc.find("+patch")] - if '+proto' in desc: - desc = desc[:desc.find("+proto")] - if '+option' in desc: - desc = desc[:desc.find("+option")] - - if dep != "" and 'DEPRECATED' not in desc: - desc += dep - return desc - - -def get_row(name, _type, desc): - if 'DEPRECATED' in desc: - dep = desc.find('DEPRECATED') - return DEP_TABLE_ROW % (name, _type, "~" + desc[:dep] + "~ " + desc[dep:]) - else: - return TABLE_ROW % (name, _type, desc) - - -def get_name_from_full_name(ref): - return ref.split('.')[-1] - - -def get_desc(key, defs): - if 'description' in defs[key]: - return clean_desc(defs[key]['description']) - elif 'title' in defs[key]: - return clean_desc(clean_title(defs[key]['title'])) - return "_No description available_" - - -def link(text, link_to): - return "[%s](%s)" % (text, link_to) - - -def get_desc_from_field(field): - if 'description' in field: - return field['description'] - elif 'title' in field: - return field['title'] - return "_No desription available_" - - -def get_examples(examples, summary): - out = DROPDOWN_OPENER % summary - for example in examples: - name = example.split("/")[-1] - out += LIST_ELEMENT % link("`%s`" % name, "../" + example) - out += DROPDOWN_CLOSER - return out - - -def get_key_value_field_types(field): - key_type, val_type = "string", "string" - if 'type' in field['additionalProperties']: - key_type = field['additionalProperties']['type'] - if 'format' in field['additionalProperties']: - val_type = field['additionalProperties']['format'] - return key_type, val_type - - -def get_object_type(field, json_field_name, add_to_queue): - obj_type_raw = field['type'] - if obj_type_raw == "array": - if '$ref' in field['items']: - ref = field['items']['$ref'][14:] - add_to_queue(ref, json_field_name) - - if ref == "io.argoproj.workflow.v1alpha1.WorkflowStep": - return "`Array>`" % link("`%s`" % get_name_from_full_name(ref), - "#" + get_name_from_full_name(ref).lower()) - - return "`Array<`%s`>`" % link("`%s`" % get_name_from_full_name(ref), - "#" + get_name_from_full_name(ref).lower()) - - return "`Array< %s >`" % get_name_from_full_name(field['items']['type']) - - elif obj_type_raw == "object": - if '$ref' in field['additionalProperties']: - ref = field['additionalProperties']['$ref'][14:] - add_to_queue(ref, json_field_name) - return link("`%s`" % get_name_from_full_name(ref), "#" + get_name_from_full_name(ref).lower()) - - else: - return "`Map< %s , %s >`" % get_key_value_field_types(field) - - elif 'format' in field: - return "`%s`" % field['format'] - - return "`%s`" % field['type'] - - -class DocGeneratorContext: - - def __init__(self): - self.defs = {} - self.completed_fields = set() - self.json_name = {} - self.queue = ['io.argoproj.workflow.v1alpha1.Workflow', 'io.argoproj.workflow.v1alpha1.CronWorkflow', - 'io.argoproj.workflow.v1alpha1.WorkflowTemplate'] - self.external = [] - self.index = {} - - def run(self): - self.load_files() - - out = SECTION_HEADER % "Argo Fields" - while self.queue: - out += self.get_template(self.queue.pop(0)) - - out += SECTION_HEADER % "External Fields" - while self.external: - out += self.get_template(self.external.pop(0)) - - return out - - def load_files(self): - with open('api/openapi-spec/swagger.json') as swagger: - s = json.load(swagger) - self.defs = s['definitions'] - - for file_name_poisx in Path('examples').rglob('*.yaml'): - file_name = str(file_name_poisx) - with open(file_name) as wf: - wf_text = wf.read() - kinds = re.findall(r"kind: ([a-zA-Z]+)", wf_text) - for kind in kinds: - if kind not in self.index: - self.index[kind] = set() - self.index[kind].add(file_name) - - finds = re.findall(r"([a-zA-Z]+?):", wf_text) - for find in finds: - if find not in self.index: - self.index[find] = set() - self.index[find].add(file_name) - - def add_to_queue(self, ref, json_field_name): - if ref == "io.argoproj.workflow.v1alpha1.ParallelSteps": - ref = "io.argoproj.workflow.v1alpha1.WorkflowStep" - if ref not in self.completed_fields: - self.completed_fields.add(ref) - self.json_name[ref] = json_field_name - if "io.argoproj.workflow" in ref: - self.queue.append(ref) - else: - self.external.append(ref) - - def get_template(self, key): - out = FIELD_HEADER % (get_name_from_full_name(key), get_desc(key, self.defs)) - - if get_name_from_full_name(key) in self.index: - out += get_examples(self.index[get_name_from_full_name(key)], "Examples") - - if key in self.json_name and self.json_name[key] in self.index: - out += get_examples(self.index[self.json_name[key]], "Examples with this field") - - if 'properties' not in self.defs[key]: - return out - - out += FIELD_TABLE_HEADER - for json_field_name, field in self.defs[key]['properties'].items(): - if '$ref' in field: - - ref = field['$ref'][14:] - self.add_to_queue(ref, json_field_name) - - desc = get_desc_from_field(field) - out += get_row(json_field_name, - link("`%s`" % get_name_from_full_name(ref), "#" + get_name_from_full_name(ref).lower()), - clean_desc(desc)) - - else: - obj_type = get_object_type(field, json_field_name, lambda r, j: self.add_to_queue(r, j)) - desc = get_desc_from_field(field) - - out += get_row(json_field_name, obj_type, clean_desc(desc)) - - return out - -# This file should be run with `make docs` on the root directory - -ctx = DocGeneratorContext() -fields = ctx.run() -with open('docs/fields.md', 'w') as file: - file.write(fields) diff --git a/hack/main.go b/hack/main.go new file mode 100644 index 000000000000..e261782d07be --- /dev/null +++ b/hack/main.go @@ -0,0 +1,10 @@ +package main + +import "os" + +func main() { + switch os.Args[1] { + case "docgen": + generateDocs() + } +} From bfcfc2ffaf57ebed49919100bbe33c2f32c3a332 Mon Sep 17 00:00:00 2001 From: Simon Behar Date: Thu, 9 Apr 2020 10:38:30 -0700 Subject: [PATCH 3/4] Changes --- docs/fields.md | 1 - hack/docgen.go | 6 ++++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/fields.md b/docs/fields.md index fe70eedd6aec..90de4695cafd 100644 --- a/docs/fields.md +++ b/docs/fields.md @@ -1,4 +1,3 @@ -go run ./hack docgen # Argo Fields diff --git a/hack/docgen.go b/hack/docgen.go index 579fa530bfc2..705f4459e56c 100644 --- a/hack/docgen.go +++ b/hack/docgen.go @@ -339,6 +339,8 @@ func (c *DocGeneratorContext) generate() string { func generateDocs() { c := NewDocGeneratorContext() - //c.generate() - fmt.Println(c.generate()) + err := ioutil.WriteFile("docs/fields.md", []byte(c.generate()), 0644) + if err != nil { + panic(err) + } } From 4c4e668e8421c897b9bd5de2abea6845815753ec Mon Sep 17 00:00:00 2001 From: Simon Behar Date: Thu, 9 Apr 2020 10:58:50 -0700 Subject: [PATCH 4/4] clean --- hack/docgen.go | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/hack/docgen.go b/hack/docgen.go index 705f4459e56c..0f9c64153571 100644 --- a/hack/docgen.go +++ b/hack/docgen.go @@ -322,15 +322,15 @@ func (c *DocGeneratorContext) generate() string { out := fmt.Sprintf(sectionHeader, "Argo Fields") for len(c.queue) > 0 { - temp := c.queue[0] - c.queue = c.queue[1:] + var temp string + temp, c.queue = c.queue[0], c.queue[1:] out += c.getTemplate(temp) } out += fmt.Sprintf(sectionHeader, "External Fields") for len(c.external) > 0 { - temp := c.external[0] - c.external = c.external[1:] + var temp string + temp, c.external = c.external[0], c.external[1:] out += c.getTemplate(temp) }