Field Reference

Workflow

Workflow is the definition of a workflow resource

Examples (click to open)

• archive-location.yaml

• arguments-artifacts.yaml

• arguments-parameters-from-configmap.yaml

• arguments-parameters.yaml

• artifact-disable-archive.yaml

• artifact-gc-workflow.yaml

• artifact-passing-subpath.yaml

• artifact-passing.yaml

• artifact-path-placeholders.yaml

• artifact-repository-ref.yaml

• artifactory-artifact.yaml

• ci-output-artifact.yaml

• ci.yaml

• cluster-wftmpl-dag.yaml

• mixed-cluster-namespaced-wftmpl-steps.yaml

• workflow-template-ref-with-entrypoint-arg-passing.yaml

• workflow-template-ref.yaml

• coinflip-recursive.yaml

• coinflip.yaml

• colored-logs.yaml

• conditional-artifacts.yaml

• conditional-parameters.yaml

• conditionals-complex.yaml

• conditionals.yaml

• graph-workflow.yaml

• outputs-result-workflow.yaml

• parallel-workflow.yaml

• sequence-workflow.yaml

• workspace-workflow.yaml

• continue-on-fail.yaml

• cron-backfill.yaml

• custom-metrics.yaml

• daemon-nginx.yaml

• daemon-step.yaml

• daemoned-stateful-set-with-service.yaml

• dag-coinflip.yaml

• dag-conditional-artifacts.yaml

• dag-conditional-parameters.yaml

• dag-continue-on-fail.yaml

• dag-custom-metrics.yaml

• dag-daemon-task.yaml

• dag-diamond-steps.yaml

• dag-diamond.yaml

• dag-disable-failFast.yaml

• dag-enhanced-depends.yaml

• dag-inline-workflow.yaml

• dag-multiroot.yaml

• dag-nested.yaml

• dag-targets.yaml

• dag-task-level-timeout.yaml

• data-transformations.yaml

• default-pdb-support.yaml

• dns-config.yaml

• exit-code-output-variable.yaml

• exit-handler-dag-level.yaml

• exit-handler-slack.yaml

• exit-handler-step-level.yaml

• exit-handler-with-artifacts.yaml

• exit-handler-with-param.yaml

• exit-handlers.yaml

• expression-destructure-json-complex.yaml

• expression-destructure-json.yaml

• expression-reusing-verbose-snippets.yaml

• expression-tag-template-workflow.yaml

• fibonacci-seq-conditional-param.yaml

• forever.yaml

• fun-with-gifs.yaml

• gc-ttl.yaml

• global-outputs.yaml

• global-parameters-from-configmap-referenced-as-local-variable.yaml

• global-parameters-from-configmap.yaml

• global-parameters.yaml

• handle-large-output-results.yaml

• hdfs-artifact.yaml

• hello-hybrid.yaml

• hello-windows.yaml

• hello-world.yaml

• http-hello-world.yaml

• http-success-condition.yaml

• image-pull-secrets.yaml

• influxdb-ci.yaml

• init-container.yaml

• input-artifact-azure.yaml

• input-artifact-gcs.yaml

• input-artifact-git.yaml

• input-artifact-http.yaml

• input-artifact-oss.yaml

• input-artifact-raw.yaml

• input-artifact-s3.yaml

• intermediate-parameters.yaml

• k8s-jobs.yaml

• k8s-orchestration.yaml

• k8s-owner-reference.yaml

• k8s-patch-json-pod.yaml

• k8s-patch-json-workflow.yaml

• k8s-patch-merge-pod.yaml

• k8s-patch-pod.yaml

• k8s-resource-log-selector.yaml

• k8s-set-owner-reference.yaml

• k8s-wait-wf.yaml

• key-only-artifact.yaml

• label-value-from-workflow.yaml

• life-cycle-hooks-tmpl-level.yaml

• life-cycle-hooks-wf-level.yaml

• loops-arbitrary-sequential-steps.yaml

• loops-dag.yaml

• loops-maps.yaml

• loops-param-argument.yaml

• loops-param-result.yaml

• loops-sequence.yaml

• loops.yaml

• map-reduce.yaml

• nested-workflow.yaml

• node-selector.yaml

• output-artifact-azure.yaml

• output-artifact-gcs.yaml

• output-artifact-s3.yaml

• output-parameter.yaml

• parallelism-limit.yaml

• parallelism-nested-dag.yaml

• parallelism-nested-workflow.yaml

• parallelism-nested.yaml

• parallelism-template-limit.yaml

• parameter-aggregation-dag.yaml

• parameter-aggregation-script.yaml

• parameter-aggregation.yaml

• pod-gc-strategy-with-label-selector.yaml

• pod-gc-strategy.yaml

• pod-metadata-wf-field.yaml

• pod-metadata.yaml

• pod-spec-from-previous-step.yaml

• pod-spec-patch-wf-tmpl.yaml

• pod-spec-patch.yaml

• pod-spec-yaml-patch.yaml

• recursive-for-loop.yaml

• resource-delete-with-flags.yaml

• resource-flags.yaml

• resubmit.yaml

• retry-backoff.yaml

• retry-conditional.yaml

• retry-container-to-completion.yaml

• retry-container.yaml

• retry-on-error.yaml

• retry-script.yaml

• retry-with-steps.yaml

• scripts-bash.yaml

• scripts-javascript.yaml

• scripts-python.yaml

• secrets.yaml

• sidecar-dind.yaml

• sidecar-nginx.yaml

• sidecar.yaml

• status-reference.yaml

• step-level-timeout.yaml

• steps-inline-workflow.yaml

• steps.yaml

• suspend-template-outputs.yaml

• suspend-template.yaml

• synchronization-mutex-tmpl-level-legacy.yaml

• synchronization-mutex-tmpl-level.yaml

• synchronization-mutex-wf-level-legacy.yaml

• synchronization-mutex-wf-level.yaml

• template-defaults.yaml

• template-on-exit.yaml

• timeouts-step.yaml

• timeouts-workflow.yaml

• title-and-description-with-markdown.yaml

• volumes-emptydir.yaml

• volumes-existing.yaml

• volumes-pvc.yaml

• webhdfs-input-output-artifacts.yaml

• withsequence-nested-result.yaml

• work-avoidance.yaml

• workflow-of-workflows.yaml

• dag.yaml

• hello-world.yaml

• retry-with-steps.yaml

• steps.yaml

• workflow-archive-logs.yaml

• workflow-template-ref-with-entrypoint-arg-passing.yaml

• workflow-template-ref.yaml

Fields

Field Name	Field Type	Description
apiVersion	string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#resources
kind	string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata	ObjectMeta	No description available
spec	WorkflowSpec	No description available
status	WorkflowStatus	No description available

CronWorkflow

CronWorkflow is the definition of a scheduled workflow resource

Examples (click to open)

• cron-backfill.yaml

• cron-when.yaml

• cron-workflow-multiple-schedules.yaml

• cron-workflow.yaml

• dag-inline-cronworkflow.yaml

Fields

Field Name	Field Type	Description
apiVersion	string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#resources
kind	string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata	ObjectMeta	No description available
spec	CronWorkflowSpec	No description available
status	CronWorkflowStatus	No description available

WorkflowTemplate

WorkflowTemplate is the definition of a workflow template resource

Examples (click to open)

• artifacts-workflowtemplate.yaml

• buildkit-template.yaml

• ci-workflowtemplate.yaml

• cron-backfill.yaml

• dag-inline-workflowtemplate.yaml

• event-consumer-workflowtemplate.yaml

• templates.yaml

Fields

Field Name	Field Type	Description
apiVersion	string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#resources
kind	string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata	ObjectMeta	No description available
spec	WorkflowSpec	No description available

WorkflowEventBinding

WorkflowEventBinding is the definition of an event resource

Examples (click to open)

• event-consumer-workfloweventbinding.yaml

Fields

Field Name	Field Type	Description
apiVersion	string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#resources
kind	string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata	ObjectMeta	No description available
spec	WorkflowEventBindingSpec	No description available

WorkflowSpec

WorkflowSpec is the specification of a Workflow.

Examples with this field (click to open)

• archive-location.yaml

• arguments-artifacts.yaml

• arguments-parameters-from-configmap.yaml

• arguments-parameters.yaml

• artifact-disable-archive.yaml

• artifact-gc-workflow.yaml

• artifact-passing-subpath.yaml

• artifact-passing.yaml

• artifact-path-placeholders.yaml

• artifact-repository-ref.yaml

• artifactory-artifact.yaml

• artifacts-workflowtemplate.yaml

• buildkit-template.yaml

• ci-output-artifact.yaml

• ci-workflowtemplate.yaml

• ci.yaml

• cluster-wftmpl-dag.yaml

• clustertemplates.yaml

• mixed-cluster-namespaced-wftmpl-steps.yaml

• workflow-template-ref-with-entrypoint-arg-passing.yaml

• workflow-template-ref.yaml

• coinflip-recursive.yaml

• coinflip.yaml

• colored-logs.yaml

• conditional-artifacts.yaml

• conditional-parameters.yaml

• conditionals-complex.yaml

• conditionals.yaml

• graph-workflow.yaml

• outputs-result-workflow.yaml

• parallel-workflow.yaml

• sequence-workflow.yaml

• workspace-workflow.yaml

• continue-on-fail.yaml

• cron-backfill.yaml

• cron-when.yaml

• cron-workflow-multiple-schedules.yaml

• cron-workflow.yaml

• custom-metrics.yaml

• daemon-nginx.yaml

• daemon-step.yaml

• dag-coinflip.yaml

• dag-conditional-artifacts.yaml

• dag-conditional-parameters.yaml

• dag-continue-on-fail.yaml

• dag-custom-metrics.yaml

• dag-daemon-task.yaml

• dag-diamond-steps.yaml

• dag-diamond.yaml

• dag-disable-failFast.yaml

• dag-enhanced-depends.yaml

• dag-inline-clusterworkflowtemplate.yaml

• dag-inline-cronworkflow.yaml

• dag-inline-workflow.yaml

• dag-inline-workflowtemplate.yaml

• dag-multiroot.yaml

• dag-nested.yaml

• dag-targets.yaml

• dag-task-level-timeout.yaml

• data-transformations.yaml

• default-pdb-support.yaml

• dns-config.yaml

• exit-code-output-variable.yaml

• exit-handler-dag-level.yaml

• exit-handler-slack.yaml

• exit-handler-step-level.yaml

• exit-handler-with-artifacts.yaml

• exit-handler-with-param.yaml

• exit-handlers.yaml

• expression-destructure-json-complex.yaml

• expression-destructure-json.yaml

• expression-reusing-verbose-snippets.yaml

• expression-tag-template-workflow.yaml

• fibonacci-seq-conditional-param.yaml

• forever.yaml

• fun-with-gifs.yaml

• gc-ttl.yaml

• global-outputs.yaml

• global-parameters-from-configmap-referenced-as-local-variable.yaml

• global-parameters-from-configmap.yaml

• global-parameters.yaml

• handle-large-output-results.yaml

• hdfs-artifact.yaml

• hello-hybrid.yaml

• hello-windows.yaml

• hello-world.yaml

• http-hello-world.yaml

• http-success-condition.yaml

• image-pull-secrets.yaml

• influxdb-ci.yaml

• init-container.yaml

• input-artifact-azure.yaml

• input-artifact-gcs.yaml

• input-artifact-git.yaml

• input-artifact-http.yaml

• input-artifact-oss.yaml

• input-artifact-raw.yaml

• input-artifact-s3.yaml

• intermediate-parameters.yaml

• k8s-owner-reference.yaml

• k8s-patch-json-pod.yaml

• k8s-patch-json-workflow.yaml

• k8s-patch-merge-pod.yaml

• k8s-wait-wf.yaml

• key-only-artifact.yaml

• label-value-from-workflow.yaml

• life-cycle-hooks-tmpl-level.yaml

• life-cycle-hooks-wf-level.yaml

• loops-arbitrary-sequential-steps.yaml

• loops-dag.yaml

• loops-maps.yaml

• loops-param-argument.yaml

• loops-param-result.yaml

• loops-sequence.yaml

• loops.yaml

• map-reduce.yaml

• nested-workflow.yaml

• node-selector.yaml

• output-artifact-azure.yaml

• output-artifact-gcs.yaml

• output-artifact-s3.yaml

• output-parameter.yaml

• parallelism-limit.yaml

• parallelism-nested-dag.yaml

• parallelism-nested-workflow.yaml

• parallelism-nested.yaml

• parallelism-template-limit.yaml

• parameter-aggregation-dag.yaml

• parameter-aggregation-script.yaml

• parameter-aggregation.yaml

• pod-gc-strategy-with-label-selector.yaml

• pod-gc-strategy.yaml

• pod-metadata-wf-field.yaml

• pod-metadata.yaml

• pod-spec-from-previous-step.yaml

• pod-spec-patch-wf-tmpl.yaml

• pod-spec-patch.yaml

• pod-spec-yaml-patch.yaml

• recursive-for-loop.yaml

• resubmit.yaml

• retry-backoff.yaml

• retry-conditional.yaml

• retry-container-to-completion.yaml

• retry-container.yaml

• retry-on-error.yaml

• retry-script.yaml

• retry-with-steps.yaml

• scripts-bash.yaml

• scripts-javascript.yaml

• scripts-python.yaml

• secrets.yaml

• sidecar-dind.yaml

• sidecar-nginx.yaml

• sidecar.yaml

• status-reference.yaml

• step-level-timeout.yaml

• steps-inline-workflow.yaml

• steps.yaml

• suspend-template-outputs.yaml

• suspend-template.yaml

• synchronization-mutex-tmpl-level-legacy.yaml

• synchronization-mutex-tmpl-level.yaml

• synchronization-mutex-wf-level-legacy.yaml

• synchronization-mutex-wf-level.yaml

• template-defaults.yaml

• template-on-exit.yaml

• timeouts-step.yaml

• timeouts-workflow.yaml

• title-and-description-with-markdown.yaml

• volumes-emptydir.yaml

• volumes-existing.yaml

• volumes-pvc.yaml

• webhdfs-input-output-artifacts.yaml

• withsequence-nested-result.yaml

• work-avoidance.yaml

• event-consumer-workfloweventbinding.yaml

• event-consumer-workflowtemplate.yaml

• workflow-of-workflows.yaml

• dag.yaml

• hello-world.yaml

• retry-with-steps.yaml

• steps.yaml

• templates.yaml

• workflow-archive-logs.yaml

• workflow-template-ref-with-entrypoint-arg-passing.yaml

• workflow-template-ref.yaml

Fields

Field Name	Field Type	Description
activeDeadlineSeconds	integer	Optional duration in seconds relative to the workflow start time which the workflow is allowed to run before the controller terminates the io.argoproj.workflow.v1alpha1. A value of zero is used to terminate a Running workflow
affinity	Affinity	Affinity sets the scheduling constraints for all pods in the io.argoproj.workflow.v1alpha1. Can be overridden by an affinity specified in the template
archiveLogs	boolean	ArchiveLogs indicates if the container logs should be archived
arguments	Arguments	Arguments contain the parameters and artifacts sent to the workflow entrypoint Parameters are referencable globally using the 'workflow' variable prefix. e.g. {{io.argoproj.workflow.v1alpha1.parameters.myparam}}
artifactGC	WorkflowLevelArtifactGC	ArtifactGC describes the strategy to use when deleting artifacts from completed or deleted workflows (applies to all output Artifacts unless Artifact.ArtifactGC is specified, which overrides this)
artifactRepositoryRef	ArtifactRepositoryRef	ArtifactRepositoryRef specifies the configMap name and key containing the artifact repository config.
automountServiceAccountToken	boolean	AutomountServiceAccountToken indicates whether a service account token should be automatically mounted in pods. ServiceAccountName of ExecutorConfig must be specified if this value is false.
dnsConfig	PodDNSConfig	PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.
dnsPolicy	string	Set DNS policy for workflow pods. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.
entrypoint	string	Entrypoint is a template reference to the starting point of the io.argoproj.workflow.v1alpha1.
executor	ExecutorConfig	Executor holds configurations of executor containers of the io.argoproj.workflow.v1alpha1.
hooks	LifecycleHook	Hooks holds the lifecycle hook which is invoked at lifecycle of step, irrespective of the success, failure, or error status of the primary step
hostAliases	Array<HostAlias>	No description available
hostNetwork	boolean	Host networking requested for this workflow pod. Default to false.
imagePullSecrets	Array<LocalObjectReference>	ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because Secrets can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet. More info: https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod
metrics	Metrics	Metrics are a list of metrics emitted from this Workflow
nodeSelector	Map< string , string >	NodeSelector is a selector which will result in all pods of the workflow to be scheduled on the selected node(s). This is able to be overridden by a nodeSelector specified in the template.
onExit	string	OnExit is a template reference which is invoked at the end of the workflow, irrespective of the success, failure, or error of the primary io.argoproj.workflow.v1alpha1.
parallelism	integer	Parallelism limits the max total parallel pods that can execute at the same time in a workflow
podDisruptionBudget	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 describes the strategy to use when deleting completed pods
podMetadata	Metadata	PodMetadata defines additional metadata that should be applied to workflow pods
~~podPriority~~	~~integer~~	~~Priority to apply to workflow pods.~~ DEPRECATED: Use PodPriorityClassName instead.
podPriorityClassName	string	PriorityClassName to apply to workflow pods.
podSpecPatch	string	PodSpecPatch holds strategic merge patch to apply against the pod spec. Allows parameterization of container fields which are not strings (e.g. resource limits).
priority	integer	Priority is used if controller is configured to process limited number of workflows in parallel. Workflows with higher priority are processed first.
retryStrategy	RetryStrategy	RetryStrategy for all templates in the io.argoproj.workflow.v1alpha1.
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	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
synchronization	Synchronization	Synchronization holds synchronization lock configuration for this Workflow
templateDefaults	Template	TemplateDefaults holds default template values that will apply to all templates in the Workflow, unless overridden on the template-level
templates	Array<Template>	Templates is a list of workflow templates used in a workflow
tolerations	Array<Toleration>	Tolerations to apply to workflow pods.
ttlStrategy	TTLStrategy	TTLStrategy limits the lifetime of a Workflow that has finished execution depending on if it Succeeded or Failed. If this struct is set, once the Workflow finishes, it will be deleted after the time to live expires. If this field is unset, the controller config map will hold the default values.
volumeClaimGC	VolumeClaimGC	VolumeClaimGC describes the strategy to use when deleting volumes from completed workflows
volumeClaimTemplates	Array<PersistentVolumeClaim>	VolumeClaimTemplates is a list of claims that containers are allowed to reference. The Workflow controller will create the claims at the beginning of the workflow and delete the claims upon completion of the workflow
volumes	Array<Volume>	Volumes is a list of volumes that can be mounted by containers in a io.argoproj.workflow.v1alpha1.
workflowMetadata	WorkflowMetadata	WorkflowMetadata contains some metadata of the workflow to refer to
workflowTemplateRef	WorkflowTemplateRef	WorkflowTemplateRef holds a reference to a WorkflowTemplate for execution

WorkflowStatus

WorkflowStatus contains overall status information about a workflow

Fields

Field Name	Field Type	Description
artifactGCStatus	ArtGCStatus	ArtifactGCStatus maintains the status of Artifact Garbage Collection
artifactRepositoryRef	ArtifactRepositoryRefStatus	ArtifactRepositoryRef is used to cache the repository to use so we do not need to determine it everytime we reconcile.
compressedNodes	string	Compressed and base64 decoded Nodes map
conditions	Array<Condition>	Conditions is a list of conditions the Workflow may have
estimatedDuration	integer	EstimatedDuration in seconds.
finishedAt	Time	Time at which this workflow completed
message	string	A human readable message indicating details about why the workflow is in this condition.
nodes	NodeStatus	Nodes is a mapping between a node ID and the node's status.
offloadNodeStatusVersion	string	Whether on not node status has been offloaded to a database. If exists, then Nodes and CompressedNodes will be empty. This will actually be populated with a hash of the offloaded data.
outputs	Outputs	Outputs captures output values and artifact locations produced by the workflow via global outputs
persistentVolumeClaims	Array<Volume>	PersistentVolumeClaims tracks all PVCs that were created as part of the io.argoproj.workflow.v1alpha1. The contents of this list are drained at the end of the workflow.
phase	string	Phase a simple, high-level summary of where the workflow is in its lifecycle. Will be "" (Unknown), "Pending", or "Running" before the workflow is completed, and "Succeeded", "Failed" or "Error" once the workflow has completed.
progress	string	Progress to completion
resourcesDuration	Map< integer , int64 >	ResourcesDuration is the total for the workflow
startedAt	Time	Time at which this workflow started
storedTemplates	Template	StoredTemplates is a mapping between a template ref and the node's status.
storedWorkflowTemplateSpec	WorkflowSpec	StoredWorkflowSpec stores the WorkflowTemplate spec for future execution.
synchronization	SynchronizationStatus	Synchronization stores the status of synchronization locks
taskResultsCompletionStatus	Map< boolean , string >	TaskResultsCompletionStatus tracks task result completion status (mapped by node ID). Used to prevent premature archiving and garbage collection.

CronWorkflowSpec

CronWorkflowSpec is the specification of a CronWorkflow

Examples with this field (click to open)

• archive-location.yaml

• arguments-artifacts.yaml

• arguments-parameters-from-configmap.yaml

• arguments-parameters.yaml

• artifact-disable-archive.yaml

• artifact-gc-workflow.yaml

• artifact-passing-subpath.yaml

• artifact-passing.yaml

• artifact-path-placeholders.yaml

• artifact-repository-ref.yaml

• artifactory-artifact.yaml

• artifacts-workflowtemplate.yaml

• buildkit-template.yaml

• ci-output-artifact.yaml

• ci-workflowtemplate.yaml

• ci.yaml

• cluster-wftmpl-dag.yaml

• clustertemplates.yaml

• mixed-cluster-namespaced-wftmpl-steps.yaml

• workflow-template-ref-with-entrypoint-arg-passing.yaml

• workflow-template-ref.yaml

• coinflip-recursive.yaml

• coinflip.yaml

• colored-logs.yaml

• conditional-artifacts.yaml

• conditional-parameters.yaml

• conditionals-complex.yaml

• conditionals.yaml

• graph-workflow.yaml

• outputs-result-workflow.yaml

• parallel-workflow.yaml

• sequence-workflow.yaml

• workspace-workflow.yaml

• continue-on-fail.yaml

• cron-backfill.yaml

• cron-when.yaml

• cron-workflow-multiple-schedules.yaml

• cron-workflow.yaml

• custom-metrics.yaml

• daemon-nginx.yaml

• daemon-step.yaml

• dag-coinflip.yaml

• dag-conditional-artifacts.yaml

• dag-conditional-parameters.yaml

• dag-continue-on-fail.yaml

• dag-custom-metrics.yaml

• dag-daemon-task.yaml

• dag-diamond-steps.yaml

• dag-diamond.yaml

• dag-disable-failFast.yaml

• dag-enhanced-depends.yaml

• dag-inline-clusterworkflowtemplate.yaml

• dag-inline-cronworkflow.yaml

• dag-inline-workflow.yaml

• dag-inline-workflowtemplate.yaml

• dag-multiroot.yaml

• dag-nested.yaml

• dag-targets.yaml

• dag-task-level-timeout.yaml

• data-transformations.yaml

• default-pdb-support.yaml

• dns-config.yaml

• exit-code-output-variable.yaml

• exit-handler-dag-level.yaml

• exit-handler-slack.yaml

• exit-handler-step-level.yaml

• exit-handler-with-artifacts.yaml

• exit-handler-with-param.yaml

• exit-handlers.yaml

• expression-destructure-json-complex.yaml

• expression-destructure-json.yaml

• expression-reusing-verbose-snippets.yaml

• expression-tag-template-workflow.yaml

• fibonacci-seq-conditional-param.yaml

• forever.yaml

• fun-with-gifs.yaml

• gc-ttl.yaml

• global-outputs.yaml

• global-parameters-from-configmap-referenced-as-local-variable.yaml

• global-parameters-from-configmap.yaml

• global-parameters.yaml

• handle-large-output-results.yaml

• hdfs-artifact.yaml

• hello-hybrid.yaml

• hello-windows.yaml

• hello-world.yaml

• http-hello-world.yaml

• http-success-condition.yaml

• image-pull-secrets.yaml

• influxdb-ci.yaml

• init-container.yaml

• input-artifact-azure.yaml

• input-artifact-gcs.yaml

• input-artifact-git.yaml

• input-artifact-http.yaml

• input-artifact-oss.yaml

• input-artifact-raw.yaml

• input-artifact-s3.yaml

• intermediate-parameters.yaml

• k8s-owner-reference.yaml

• k8s-patch-json-pod.yaml

• k8s-patch-json-workflow.yaml

• k8s-patch-merge-pod.yaml

• k8s-wait-wf.yaml

• key-only-artifact.yaml

• label-value-from-workflow.yaml

• life-cycle-hooks-tmpl-level.yaml

• life-cycle-hooks-wf-level.yaml

• loops-arbitrary-sequential-steps.yaml

• loops-dag.yaml

• loops-maps.yaml

• loops-param-argument.yaml

• loops-param-result.yaml

• loops-sequence.yaml

• loops.yaml

• map-reduce.yaml

• nested-workflow.yaml

• node-selector.yaml

• output-artifact-azure.yaml

• output-artifact-gcs.yaml

• output-artifact-s3.yaml

• output-parameter.yaml

• parallelism-limit.yaml

• parallelism-nested-dag.yaml

• parallelism-nested-workflow.yaml

• parallelism-nested.yaml

• parallelism-template-limit.yaml

• parameter-aggregation-dag.yaml

• parameter-aggregation-script.yaml

• parameter-aggregation.yaml

• pod-gc-strategy-with-label-selector.yaml

• pod-gc-strategy.yaml

• pod-metadata-wf-field.yaml

• pod-metadata.yaml

• pod-spec-from-previous-step.yaml

• pod-spec-patch-wf-tmpl.yaml

• pod-spec-patch.yaml

• pod-spec-yaml-patch.yaml

• recursive-for-loop.yaml

• resubmit.yaml

• retry-backoff.yaml

• retry-conditional.yaml

• retry-container-to-completion.yaml

• retry-container.yaml

• retry-on-error.yaml

• retry-script.yaml

• retry-with-steps.yaml

• scripts-bash.yaml

• scripts-javascript.yaml

• scripts-python.yaml

• secrets.yaml

• sidecar-dind.yaml

• sidecar-nginx.yaml

• sidecar.yaml

• status-reference.yaml

• step-level-timeout.yaml

• steps-inline-workflow.yaml

• steps.yaml

• suspend-template-outputs.yaml

• suspend-template.yaml

• synchronization-mutex-tmpl-level-legacy.yaml

• synchronization-mutex-tmpl-level.yaml

• synchronization-mutex-wf-level-legacy.yaml

• synchronization-mutex-wf-level.yaml

• template-defaults.yaml

• template-on-exit.yaml

• timeouts-step.yaml

• timeouts-workflow.yaml

• title-and-description-with-markdown.yaml

• volumes-emptydir.yaml

• volumes-existing.yaml

• volumes-pvc.yaml

• webhdfs-input-output-artifacts.yaml

• withsequence-nested-result.yaml

• work-avoidance.yaml

• event-consumer-workfloweventbinding.yaml

• event-consumer-workflowtemplate.yaml

• workflow-of-workflows.yaml

• dag.yaml

• hello-world.yaml

• retry-with-steps.yaml

• steps.yaml

• templates.yaml

• workflow-archive-logs.yaml

• workflow-template-ref-with-entrypoint-arg-passing.yaml

• workflow-template-ref.yaml

Fields

Field Name	Field Type	Description
concurrencyPolicy	string	ConcurrencyPolicy is the K8s-style concurrency policy that will be used
failedJobsHistoryLimit	integer	FailedJobsHistoryLimit is the number of failed jobs to be kept at a time
schedule	string	Schedule is a schedule to run the Workflow in Cron format. Deprecated, use Schedules
schedules	Array< string >	v3.6 and after: Schedules is a list of schedules to run the Workflow in Cron format
startingDeadlineSeconds	integer	StartingDeadlineSeconds is the K8s-style deadline that will limit the time a CronWorkflow will be run after its original scheduled time if it is missed.
stopStrategy	StopStrategy	v3.6 and after: StopStrategy defines if the CronWorkflow should stop scheduling based on a condition
successfulJobsHistoryLimit	integer	SuccessfulJobsHistoryLimit is the number of successful jobs to be kept at a time
suspend	boolean	Suspend is a flag that will stop new CronWorkflows from running if set to true
timezone	string	Timezone is the timezone against which the cron schedule will be calculated, e.g. "Asia/Tokyo". Default is machine's local time.
when	string	v3.6 and after: When is an expression that determines if a run should be scheduled.
workflowMetadata	ObjectMeta	WorkflowMetadata contains some metadata of the workflow to be run
workflowSpec	WorkflowSpec	WorkflowSpec is the spec of the workflow to be run

CronWorkflowStatus

CronWorkflowStatus is the status of a CronWorkflow

Fields

Field Name	Field Type	Description
active	Array<ObjectReference>	Active is a list of active workflows stemming from this CronWorkflow
conditions	Array<Condition>	Conditions is a list of conditions the CronWorkflow may have
failed	integer	v3.6 and after: Failed counts how many times child workflows failed
lastScheduledTime	Time	LastScheduleTime is the last time the CronWorkflow was scheduled
phase	string	v3.6 and after: Phase is an enum of Active or Stopped. It changes to Stopped when stopStrategy.expression is true
succeeded	integer	v3.6 and after: Succeeded counts how many times child workflows succeeded

WorkflowEventBindingSpec

No description available

Fields

Field Name	Field Type	Description
event	Event	Event is the event to bind to
submit	Submit	Submit is the workflow template to submit

Arguments

Arguments to a template

Examples with this field (click to open)

• arguments-artifacts.yaml

• arguments-parameters.yaml

• artifact-disable-archive.yaml

• artifact-passing-subpath.yaml

• artifact-passing.yaml

• artifact-path-placeholders.yaml

• artifactory-artifact.yaml

• buildkit-template.yaml

• ci-output-artifact.yaml

• ci-workflowtemplate.yaml

• ci.yaml

• cluster-wftmpl-dag.yaml

• clustertemplates.yaml

• mixed-cluster-namespaced-wftmpl-steps.yaml

• workflow-template-ref-with-entrypoint-arg-passing.yaml

• conditionals.yaml

• outputs-result-workflow.yaml

• cron-backfill.yaml

• daemon-nginx.yaml

• daemon-step.yaml

• dag-custom-metrics.yaml

• dag-daemon-task.yaml

• dag-diamond-steps.yaml

• dag-diamond.yaml

• dag-multiroot.yaml

• dag-nested.yaml

• dag-targets.yaml

• dag-task-level-timeout.yaml

• data-transformations.yaml

• exit-code-output-variable.yaml

• exit-handler-dag-level.yaml

• exit-handler-step-level.yaml

• exit-handler-with-artifacts.yaml

• exit-handler-with-param.yaml

• expression-destructure-json-complex.yaml

• expression-destructure-json.yaml

• expression-reusing-verbose-snippets.yaml

• expression-tag-template-workflow.yaml

• fibonacci-seq-conditional-param.yaml

• global-outputs.yaml

• global-parameters-from-configmap-referenced-as-local-variable.yaml

• global-parameters-from-configmap.yaml

• global-parameters.yaml

• handle-large-output-results.yaml

• hdfs-artifact.yaml

• http-hello-world.yaml

• http-success-condition.yaml

• influxdb-ci.yaml

• k8s-wait-wf.yaml

• label-value-from-workflow.yaml

• loops-arbitrary-sequential-steps.yaml

• loops-dag.yaml

• loops-maps.yaml

• loops-param-argument.yaml

• loops-param-result.yaml

• loops-sequence.yaml

• loops.yaml

• map-reduce.yaml

• nested-workflow.yaml

• node-selector.yaml

• output-parameter.yaml

• parallelism-nested-dag.yaml

• parallelism-nested-workflow.yaml

• parallelism-nested.yaml

• parameter-aggregation-dag.yaml

• parameter-aggregation-script.yaml

• parameter-aggregation.yaml

• pod-metadata-wf-field.yaml

• pod-metadata.yaml

• pod-spec-from-previous-step.yaml

• pod-spec-patch-wf-tmpl.yaml

• pod-spec-patch.yaml

• pod-spec-yaml-patch.yaml

• recursive-for-loop.yaml

• retry-conditional.yaml

• scripts-bash.yaml

• scripts-javascript.yaml

• scripts-python.yaml

• step-level-timeout.yaml

• steps.yaml

• suspend-template-outputs.yaml

• synchronization-mutex-tmpl-level-legacy.yaml

• synchronization-mutex-tmpl-level.yaml

• work-avoidance.yaml

• event-consumer-workfloweventbinding.yaml

• event-consumer-workflowtemplate.yaml

• workflow-of-workflows.yaml

• dag.yaml

• hello-world.yaml

• steps.yaml

• templates.yaml

• workflow-template-ref-with-entrypoint-arg-passing.yaml

Fields

Field Name	Field Type	Description
artifacts	Array<Artifact>	Artifacts is the list of artifacts to pass to the template or workflow
parameters	Array<Parameter>	Parameters is the list of parameters to pass to the template or workflow

WorkflowLevelArtifactGC

WorkflowLevelArtifactGC describes how to delete artifacts from completed Workflows - this spec is used on the Workflow level

Examples with this field (click to open)

• artifact-gc-workflow.yaml

Fields

Field Name	Field Type	Description
forceFinalizerRemoval	boolean	ForceFinalizerRemoval: if set to true, the finalizer will be removed in the case that Artifact GC fails
podMetadata	Metadata	PodMetadata is an optional field for specifying the Labels and Annotations that should be assigned to the Pod doing the deletion
podSpecPatch	string	PodSpecPatch holds strategic merge patch to apply against the artgc pod spec.
serviceAccountName	string	ServiceAccountName is an optional field for specifying the Service Account that should be assigned to the Pod doing the deletion
strategy	string	Strategy is the strategy to use.

ArtifactRepositoryRef

No description available

Examples with this field (click to open)

• artifact-repository-ref.yaml

Fields

Field Name	Field Type	Description
configMap	string	The name of the config map. Defaults to "artifact-repositories".
key	string	The config map key. Defaults to the value of the "workflows.argoproj.io/default-artifact-repository" annotation.

ExecutorConfig

ExecutorConfig holds configurations of an executor container.

Fields

Field Name	Field Type	Description
serviceAccountName	string	ServiceAccountName specifies the service account name of the executor container.

LifecycleHook

No description available

Examples with this field (click to open)

• exit-handler-with-artifacts.yaml

• exit-handler-with-param.yaml

• life-cycle-hooks-tmpl-level.yaml

• life-cycle-hooks-wf-level.yaml

Fields

Field Name	Field Type	Description
arguments	Arguments	Arguments hold arguments to the template
expression	string	Expression is a condition expression for when a node will be retried. If it evaluates to false, the node will not be retried and the retry strategy will be ignored
template	string	Template is the name of the template to execute by the hook
templateRef	TemplateRef	TemplateRef is the reference to the template resource to execute by the hook

Metrics

Metrics are a list of metrics emitted from a Workflow/Template

Examples with this field (click to open)

• custom-metrics.yaml

• dag-custom-metrics.yaml

Fields

Field Name	Field Type	Description
prometheus	Array<Prometheus>	Prometheus is a list of prometheus metrics to be emitted

PodGC

PodGC describes how to delete completed pods as they complete

Examples with this field (click to open)

• pod-gc-strategy-with-label-selector.yaml

• pod-gc-strategy.yaml

Fields

Field Name	Field Type	Description
deleteDelayDuration	string	DeleteDelayDuration specifies the duration before pods in the GC queue get deleted.
labelSelector	LabelSelector	LabelSelector is the label selector to check if the pods match the labels before being added to the pod GC queue.
strategy	string	Strategy is the strategy to use. One of "OnPodCompletion", "OnPodSuccess", "OnWorkflowCompletion", "OnWorkflowSuccess". If unset, does not delete Pods

Metadata

Pod metdata

Examples with this field (click to open)

• pod-metadata-wf-field.yaml

Fields

Field Name	Field Type	Description
annotations	Map< string , string >	No description available
labels	Map< string , string >	No description available

RetryStrategy

RetryStrategy provides controls on how to retry a workflow step

Examples with this field (click to open)

• clustertemplates.yaml

• dag-disable-failFast.yaml

• retry-backoff.yaml

• retry-conditional.yaml

• retry-container-to-completion.yaml

• retry-container.yaml

• retry-on-error.yaml

• retry-script.yaml

• retry-with-steps.yaml

• template-defaults.yaml

• templates.yaml

Fields

Field Name	Field Type	Description
affinity	RetryAffinity	Affinity prevents running workflow's step on the same host
backoff	Backoff	Backoff is a backoff strategy
expression	string	Expression is a condition expression for when a node will be retried. If it evaluates to false, the node will not be retried and the retry strategy will be ignored
limit	IntOrString	Limit is the maximum number of retry attempts when retrying a container. It does not include the original container; the maximum number of total attempts will be limit + 1.
retryPolicy	string	RetryPolicy is a policy of NodePhase statuses that will be retried

Synchronization

Synchronization holds synchronization lock configuration

Examples with this field (click to open)

• synchronization-mutex-tmpl-level-legacy.yaml

• synchronization-mutex-tmpl-level.yaml

• synchronization-mutex-wf-level-legacy.yaml

• synchronization-mutex-wf-level.yaml

Fields

Field Name	Field Type	Description
mutex	Mutex	Mutex holds the Mutex lock details - deprecated, use mutexes instead
mutexes	Array<Mutex>	v3.6 and after: Mutexes holds the list of Mutex lock details
semaphore	SemaphoreRef	Semaphore holds the Semaphore configuration - deprecated, use semaphores instead
semaphores	Array<SemaphoreRef>	v3.6 and after: Semaphores holds the list of Semaphores configuration

Template

Template is a reusable and composable unit of execution in a workflow

Examples with this field (click to open)

• template-defaults.yaml

Fields

Field Name	Field Type	Description
activeDeadlineSeconds	IntOrString	Optional duration in seconds relative to the StartTime that the pod may be active on a node before the system actively tries to terminate the pod; value must be positive integer This field is only applicable to container and script templates.
affinity	Affinity	Affinity sets the pod's scheduling constraints Overrides the affinity set at the workflow level (if any)
archiveLocation	ArtifactLocation	Location in which all files related to the step will be stored (logs, artifacts, etc...). Can be overridden by individual items in Outputs. If omitted, will use the default artifact repository location configured in the controller, appended with the / in the key.
automountServiceAccountToken	boolean	AutomountServiceAccountToken indicates whether a service account token should be automatically mounted in pods. ServiceAccountName of ExecutorConfig must be specified if this value is false.
container	Container	Container is the main container image to run in the pod
containerSet	ContainerSetTemplate	ContainerSet groups multiple containers within a single pod.
daemon	boolean	Daemon will allow a workflow to proceed to the next step so long as the container reaches readiness
dag	DAGTemplate	DAG template subtype which runs a DAG
data	Data	Data is a data template
executor	ExecutorConfig	Executor holds configurations of the executor container.
failFast	boolean	FailFast, if specified, will fail this template if any of its child pods has failed. This is useful for when this template is expanded with withItems, etc.
hostAliases	Array<HostAlias>	HostAliases is an optional list of hosts and IPs that will be injected into the pod spec
http	HTTP	HTTP makes a HTTP request
initContainers	Array<UserContainer>	InitContainers is a list of containers which run before the main container.
inputs	Inputs	Inputs describe what inputs parameters and artifacts are supplied to this template
memoize	Memoize	Memoize allows templates to use outputs generated from already executed templates
metadata	Metadata	Metdata sets the pods's metadata, i.e. annotations and labels
metrics	Metrics	Metrics are a list of metrics emitted from this template
name	string	Name is the name of the template
nodeSelector	Map< string , string >	NodeSelector is a selector to schedule this step of the workflow to be run on the selected node(s). Overrides the selector set at the workflow level.
outputs	Outputs	Outputs describe the parameters and artifacts that this template produces
parallelism	integer	Parallelism limits the max total parallel pods that can execute at the same time within the boundaries of this template invocation. If additional steps/dag templates are invoked, the pods created by those templates will not be counted towards this total.
plugin	Plugin	Plugin is a plugin template
podSpecPatch	string	PodSpecPatch holds strategic merge patch to apply against the pod spec. Allows parameterization of container fields which are not strings (e.g. resource limits).
priority	integer	Priority to apply to workflow pods.
priorityClassName	string	PriorityClassName to apply to workflow pods.
resource	ResourceTemplate	Resource template subtype which can run k8s resources
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.
script	ScriptTemplate	Script runs a portion of code against an interpreter
securityContext	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>	Sidecars is a list of containers which run alongside the main container Sidecars are automatically killed when the main container completes
steps	Array<Array<WorkflowStep>>	Steps define a series of sequential/parallel workflow steps
suspend	SuspendTemplate	Suspend template subtype which can suspend a workflow when reaching the step
synchronization	Synchronization	Synchronization holds synchronization lock configuration for this template
timeout	string	Timeout allows to set the total node execution timeout duration counting from the node's start time. This duration also includes time in which the node spends in Pending state. This duration may not be applied to Step or DAG templates.
tolerations	Array<Toleration>	Tolerations to apply to workflow pods.
volumes	Array<Volume>	Volumes is a list of volumes that can be mounted by containers in a template.

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)

• gc-ttl.yaml

Fields

Field Name	Field Type	Description
secondsAfterCompletion	integer	SecondsAfterCompletion is the number of seconds to live after completion
secondsAfterFailure	integer	SecondsAfterFailure is the number of seconds to live after failure
secondsAfterSuccess	integer	SecondsAfterSuccess is the number of seconds to live after success

VolumeClaimGC

VolumeClaimGC describes how to delete volumes from completed Workflows

Fields

Field Name	Field Type	Description
strategy	string	Strategy is the strategy to use. One of "OnWorkflowCompletion", "OnWorkflowSuccess". Defaults to "OnWorkflowSuccess"

WorkflowMetadata

No description available

Examples with this field (click to open)

• label-value-from-workflow.yaml

Fields

Field Name	Field Type	Description
annotations	Map< string , string >	No description available
labels	Map< string , string >	No description available
labelsFrom	LabelValueFrom	No description available

WorkflowTemplateRef

WorkflowTemplateRef is a reference to a WorkflowTemplate resource.

Examples with this field (click to open)

• workflow-template-ref-with-entrypoint-arg-passing.yaml

• workflow-template-ref.yaml

• cron-backfill.yaml

• dag-inline-cronworkflow.yaml

• event-consumer-workfloweventbinding.yaml

• workflow-of-workflows.yaml

• workflow-template-ref-with-entrypoint-arg-passing.yaml

• workflow-template-ref.yaml

Fields

Field Name	Field Type	Description
clusterScope	boolean	ClusterScope indicates the referred template is cluster scoped (i.e. a ClusterWorkflowTemplate).
name	string	Name is the resource name of the workflow template.

ArtGCStatus

ArtGCStatus maintains state related to ArtifactGC

Fields

Field Name	Field Type	Description
notSpecified	boolean	if this is true, we already checked to see if we need to do it and we don't
podsRecouped	Map< boolean , string >	have completed Pods been processed? (mapped by Pod name) used to prevent re-processing the Status of a Pod more than once
strategiesProcessed	Map< boolean , string >	have Pods been started to perform this strategy? (enables us not to re-process what we've already done)

ArtifactRepositoryRefStatus

No description available

Examples with this field (click to open)

• artifact-repository-ref.yaml

Fields

Field Name	Field Type	Description
artifactRepository	ArtifactRepository	The repository the workflow will use. This maybe empty before v3.1.
configMap	string	The name of the config map. Defaults to "artifact-repositories".
default	boolean	If this ref represents the default artifact repository, rather than a config map.
key	string	The config map key. Defaults to the value of the "workflows.argoproj.io/default-artifact-repository" annotation.
namespace	string	The namespace of the config map. Defaults to the workflow's namespace, or the controller's namespace (if found).

Condition

No description available

Fields

Field Name	Field Type	Description
message	string	Message is the condition message
status	string	Status is the status of the condition
type	string	Type is the type of condition

NodeStatus

NodeStatus contains status information about an individual node in the workflow

Fields

Field Name	Field Type	Description
boundaryID	string	BoundaryID indicates the node ID of the associated template root node in which this node belongs to
children	Array< string >	Children is a list of child node IDs
daemoned	boolean	Daemoned tracks whether or not this node was daemoned and need to be terminated
displayName	string	DisplayName is a human readable representation of the node. Unique within a template boundary
estimatedDuration	integer	EstimatedDuration in seconds.
finishedAt	Time	Time at which this node completed
hostNodeName	string	HostNodeName name of the Kubernetes node on which the Pod is running, if applicable
id	string	ID is a unique identifier of a node within the worklow It is implemented as a hash of the node name, which makes the ID deterministic
inputs	Inputs	Inputs captures input parameter values and artifact locations supplied to this template invocation
memoizationStatus	MemoizationStatus	MemoizationStatus holds information about cached nodes
message	string	A human readable message indicating details about why the node is in this condition.
name	string	Name is unique name in the node tree used to generate the node ID
nodeFlag	NodeFlag	NodeFlag tracks some history of node. e.g.) hooked, retried, etc.
outboundNodes	Array< string >	OutboundNodes tracks the node IDs which are considered "outbound" nodes to a template invocation. For every invocation of a template, there are nodes which we considered as "outbound". Essentially, these are last nodes in the execution sequence to run, before the template is considered completed. These nodes are then connected as parents to a following step. In the case of single pod steps (i.e. container, script, resource templates), this list will be nil since the pod itself is already considered the "outbound" node. In the case of DAGs, outbound nodes are the "target" tasks (tasks with no children). In the case of steps, outbound nodes are all the containers involved in the last step group. NOTE: since templates are composable, the list of outbound nodes are carried upwards when a DAG/steps template invokes another DAG/steps template. In other words, the outbound nodes of a template, will be a superset of the outbound nodes of its last children.
outputs	Outputs	Outputs captures output parameter values and artifact locations produced by this template invocation
phase	string	Phase a simple, high-level summary of where the node is in its lifecycle. Can be used as a state machine. Will be one of these values "Pending", "Running" before the node is completed, or "Succeeded", "Skipped", "Failed", "Error", or "Omitted" as a final state.
podIP	string	PodIP captures the IP of the pod for daemoned steps
progress	string	Progress to completion
resourcesDuration	Map< integer , int64 >	ResourcesDuration is indicative, but not accurate, resource duration. This is populated when the nodes completes.
startedAt	Time	Time at which this node started
synchronizationStatus	NodeSynchronizationStatus	SynchronizationStatus is the synchronization status of the node
templateName	string	TemplateName is the template name which this node corresponds to. Not applicable to virtual nodes (e.g. Retry, StepGroup)
templateRef	TemplateRef	TemplateRef is the reference to the template resource which this node corresponds to. Not applicable to virtual nodes (e.g. Retry, StepGroup)
templateScope	string	TemplateScope is the template scope in which the template of this node was retrieved.
type	string	Type indicates type of node

Outputs

Outputs hold parameters, artifacts, and results from a step

Examples with this field (click to open)

• artifact-disable-archive.yaml

• artifact-gc-workflow.yaml

• artifact-passing-subpath.yaml

• artifact-passing.yaml

• artifact-path-placeholders.yaml

• artifact-repository-ref.yaml

• artifactory-artifact.yaml

• artifacts-workflowtemplate.yaml

• ci-output-artifact.yaml

• ci-workflowtemplate.yaml

• conditional-artifacts.yaml

• conditional-parameters.yaml

• workspace-workflow.yaml

• custom-metrics.yaml

• dag-conditional-artifacts.yaml

• dag-conditional-parameters.yaml

• data-transformations.yaml

• exit-handler-with-artifacts.yaml

• exit-handler-with-param.yaml

• expression-tag-template-workflow.yaml

• fibonacci-seq-conditional-param.yaml

• fun-with-gifs.yaml

• global-outputs.yaml

• handle-large-output-results.yaml

• hdfs-artifact.yaml

• influxdb-ci.yaml

• intermediate-parameters.yaml

• k8s-wait-wf.yaml

• key-only-artifact.yaml

• map-reduce.yaml

• nested-workflow.yaml

• output-artifact-azure.yaml

• output-artifact-gcs.yaml

• output-artifact-s3.yaml

• output-parameter.yaml

• parameter-aggregation-dag.yaml

• parameter-aggregation.yaml

• pod-spec-from-previous-step.yaml

• suspend-template-outputs.yaml

• webhdfs-input-output-artifacts.yaml

• work-avoidance.yaml

Fields

Field Name	Field Type	Description
artifacts	Array<Artifact>	Artifacts holds the list of output artifacts produced by a step
exitCode	string	ExitCode holds the exit code of a script template
parameters	Array<Parameter>	Parameters holds the list of output parameters produced by a step
result	string	Result holds the result (stdout) of a script template

SynchronizationStatus

SynchronizationStatus stores the status of semaphore and mutex.

Examples with this field (click to open)

• synchronization-mutex-tmpl-level-legacy.yaml

• synchronization-mutex-tmpl-level.yaml

• synchronization-mutex-wf-level-legacy.yaml

• synchronization-mutex-wf-level.yaml

Fields

Field Name	Field Type	Description
mutex	MutexStatus	Mutex stores this workflow's mutex holder details
semaphore	SemaphoreStatus	Semaphore stores this workflow's Semaphore holder details

StopStrategy

StopStrategy defines if the CronWorkflow should stop scheduling based on an expression. v3.6 and after

Fields

Field Name	Field Type	Description
expression	string	v3.6 and after: Expression is an expression that stops scheduling workflows when true. Use the variables cronworkflow.failed or cronworkflow.succeeded to access the number of failed or successful child workflows.

Event

No description available

Examples with this field (click to open)

• event-consumer-workfloweventbinding.yaml

Fields

Field Name	Field Type	Description
selector	string	Selector (https://github.com/expr-lang/expr) that we must must match the io.argoproj.workflow.v1alpha1. E.g. payload.message == "test"

Submit

No description available

Examples with this field (click to open)

• event-consumer-workfloweventbinding.yaml

Fields

Field Name	Field Type	Description
arguments	Arguments	Arguments extracted from the event and then set as arguments to the workflow created.
metadata	ObjectMeta	Metadata optional means to customize select fields of the workflow metadata
workflowTemplateRef	WorkflowTemplateRef	WorkflowTemplateRef the workflow template to submit

Artifact

Artifact indicates an artifact to place at a specified path

Examples with this field (click to open)

• arguments-artifacts.yaml

• artifact-disable-archive.yaml

• artifact-gc-workflow.yaml

• artifact-passing-subpath.yaml

• artifact-passing.yaml

• artifact-path-placeholders.yaml

• artifact-repository-ref.yaml

• artifactory-artifact.yaml

• artifacts-workflowtemplate.yaml

• ci-output-artifact.yaml

• ci-workflowtemplate.yaml

• ci.yaml

• conditional-artifacts.yaml

• workspace-workflow.yaml

• dag-conditional-artifacts.yaml

• data-transformations.yaml

• exit-handler-with-artifacts.yaml

• fun-with-gifs.yaml

• global-outputs.yaml

• handle-large-output-results.yaml

• hdfs-artifact.yaml

• influxdb-ci.yaml

• input-artifact-azure.yaml

• input-artifact-gcs.yaml

• input-artifact-git.yaml

• input-artifact-http.yaml

• input-artifact-oss.yaml

• input-artifact-raw.yaml

• input-artifact-s3.yaml

• key-only-artifact.yaml

• map-reduce.yaml

• nested-workflow.yaml

• output-artifact-azure.yaml

• output-artifact-gcs.yaml

• output-artifact-s3.yaml

• webhdfs-input-output-artifacts.yaml

• work-avoidance.yaml

Fields

Field Name	Field Type	Description
archive	ArchiveStrategy	Archive controls how the artifact will be saved to the artifact repository.
archiveLogs	boolean	ArchiveLogs indicates if the container logs should be archived
artifactGC	ArtifactGC	ArtifactGC describes the strategy to use when to deleting an artifact from completed or deleted workflows
artifactory	ArtifactoryArtifact	Artifactory contains artifactory artifact location details
azure	AzureArtifact	Azure contains Azure Storage artifact location details
deleted	boolean	Has this been deleted?
from	string	From allows an artifact to reference an artifact from a previous step
fromExpression	string	FromExpression, if defined, is evaluated to specify the value for the artifact
gcs	GCSArtifact	GCS contains GCS artifact location details
git	GitArtifact	Git contains git artifact location details
globalName	string	GlobalName exports an output artifact to the global scope, making it available as '{{io.argoproj.workflow.v1alpha1.outputs.artifacts.XXXX}} and in workflow.status.outputs.artifacts
hdfs	HDFSArtifact	HDFS contains HDFS artifact location details
http	HTTPArtifact	HTTP contains HTTP artifact location details
mode	integer	mode bits to use on this file, must be a value between 0 and 0777 set when loading input artifacts.
name	string	name of the artifact. must be unique within a template's inputs/outputs.
optional	boolean	Make Artifacts optional, if Artifacts doesn't generate or exist
oss	OSSArtifact	OSS contains OSS artifact location details
path	string	Path is the container path to the artifact
raw	RawArtifact	Raw contains raw artifact location details
recurseMode	boolean	If mode is set, apply the permission recursively into the artifact if it is a folder
s3	S3Artifact	S3 contains S3 artifact location details
subPath	string	SubPath allows an artifact to be sourced from a subpath within the specified source

Parameter

Parameter indicate a passed string parameter to a service template with an optional default value

Examples with this field (click to open)

• arguments-parameters-from-configmap.yaml

• arguments-parameters.yaml

• artifact-path-placeholders.yaml

• buildkit-template.yaml

• ci-output-artifact.yaml

• ci-workflowtemplate.yaml

• ci.yaml

• cluster-wftmpl-dag.yaml

• clustertemplates.yaml

• mixed-cluster-namespaced-wftmpl-steps.yaml

• workflow-template-ref-with-entrypoint-arg-passing.yaml

• conditional-parameters.yaml

• conditionals.yaml

• outputs-result-workflow.yaml

• workspace-workflow.yaml

• cron-backfill.yaml

• custom-metrics.yaml

• daemon-nginx.yaml

• daemon-step.yaml

• dag-conditional-parameters.yaml

• dag-custom-metrics.yaml

• dag-daemon-task.yaml

• dag-diamond-steps.yaml

• dag-diamond.yaml

• dag-multiroot.yaml

• dag-nested.yaml

• dag-targets.yaml

• dag-task-level-timeout.yaml

• data-transformations.yaml

• exit-code-output-variable.yaml

• exit-handler-dag-level.yaml

• exit-handler-step-level.yaml

• exit-handler-with-param.yaml

• expression-destructure-json-complex.yaml

• expression-destructure-json.yaml

• expression-reusing-verbose-snippets.yaml

• expression-tag-template-workflow.yaml

• fibonacci-seq-conditional-param.yaml

• global-outputs.yaml

• global-parameters-from-configmap-referenced-as-local-variable.yaml

• global-parameters-from-configmap.yaml

• global-parameters.yaml

• handle-large-output-results.yaml

• http-hello-world.yaml

• http-success-condition.yaml

• influxdb-ci.yaml

• intermediate-parameters.yaml

• k8s-wait-wf.yaml

• label-value-from-workflow.yaml

• loops-arbitrary-sequential-steps.yaml

• loops-dag.yaml

• loops-maps.yaml

• loops-param-argument.yaml

• loops-param-result.yaml

• loops-sequence.yaml

• loops.yaml

• map-reduce.yaml

• nested-workflow.yaml

• node-selector.yaml

• output-parameter.yaml

• parallelism-nested-dag.yaml

• parallelism-nested-workflow.yaml

• parallelism-nested.yaml

• parameter-aggregation-dag.yaml

• parameter-aggregation-script.yaml

• parameter-aggregation.yaml

• pod-metadata-wf-field.yaml

• pod-metadata.yaml

• pod-spec-from-previous-step.yaml

• pod-spec-patch-wf-tmpl.yaml

• pod-spec-patch.yaml

• pod-spec-yaml-patch.yaml

• recursive-for-loop.yaml

• retry-conditional.yaml

• scripts-bash.yaml

• scripts-javascript.yaml

• scripts-python.yaml

• step-level-timeout.yaml

• steps.yaml

• suspend-template-outputs.yaml

• synchronization-mutex-tmpl-level-legacy.yaml

• synchronization-mutex-tmpl-level.yaml

• work-avoidance.yaml

• event-consumer-workfloweventbinding.yaml

• event-consumer-workflowtemplate.yaml

• workflow-of-workflows.yaml

• dag.yaml

• hello-world.yaml

• steps.yaml

• templates.yaml

• workflow-template-ref-with-entrypoint-arg-passing.yaml

Fields

Field Name	Field Type	Description
default	string	Default is the default value to use for an input parameter if a value was not supplied
description	string	Description is the parameter description
enum	Array< string >	Enum holds a list of string values to choose from, for the actual value of the parameter
globalName	string	GlobalName exports an output parameter to the global scope, making it available as '{{io.argoproj.workflow.v1alpha1.outputs.parameters.XXXX}} and in workflow.status.outputs.parameters
name	string	Name is the parameter name
value	string	Value is the literal value to use for the parameter. If specified in the context of an input parameter, the value takes precedence over any passed values
valueFrom	ValueFrom	ValueFrom is the source for the output parameter's value

TemplateRef

TemplateRef is a reference of template resource.

Examples with this field (click to open)

• cluster-wftmpl-dag.yaml

• clustertemplates.yaml

• mixed-cluster-namespaced-wftmpl-steps.yaml

• cron-backfill.yaml

• dag.yaml

• hello-world.yaml

• retry-with-steps.yaml

• steps.yaml

• templates.yaml

Fields

Field Name	Field Type	Description
clusterScope	boolean	ClusterScope indicates the referred template is cluster scoped (i.e. a ClusterWorkflowTemplate).
name	string	Name is the resource name of the template.
template	string	Template is the name of referred template in the resource.

Prometheus

Prometheus is a prometheus metric to be emitted

Examples with this field (click to open)

• custom-metrics.yaml

• dag-custom-metrics.yaml

Fields

Field Name	Field Type	Description
counter	Counter	Counter is a counter metric
gauge	Gauge	Gauge is a gauge metric
help	string	Help is a string that describes the metric
histogram	Histogram	Histogram is a histogram metric
labels	Array<MetricLabel>	Labels is a list of metric labels
name	string	Name is the name of the metric
when	string	When is a conditional statement that decides when to emit the metric

RetryAffinity

RetryAffinity prevents running steps on the same host.

Fields

Field Name	Field Type	Description
nodeAntiAffinity	RetryNodeAntiAffinity	No description available

Backoff

Backoff is a backoff strategy to use within retryStrategy

Examples with this field (click to open)

• retry-backoff.yaml

Fields

Field Name	Field Type	Description
duration	string	Duration is the amount to back off. Default unit is seconds, but could also be a duration (e.g. "2m", "1h")
factor	IntOrString	Factor is a factor to multiply the base duration after each failed retry
maxDuration	string	MaxDuration is the maximum amount of time allowed for a workflow in the backoff strategy. It is important to note that if the workflow template includes activeDeadlineSeconds, the pod's deadline is initially set with activeDeadlineSeconds. However, when the workflow fails, the pod's deadline is then overridden by maxDuration. This ensures that the workflow does not exceed the specified maximum duration when retries are involved.

Mutex

Mutex holds Mutex configuration

Examples with this field (click to open)

• synchronization-mutex-tmpl-level-legacy.yaml

• synchronization-mutex-tmpl-level.yaml

• synchronization-mutex-wf-level-legacy.yaml

• synchronization-mutex-wf-level.yaml

Fields

Field Name	Field Type	Description
name	string	name of the mutex
namespace	string	Namespace is the namespace of the mutex, default: [namespace of workflow]

SemaphoreRef

SemaphoreRef is a reference of Semaphore

Fields

Field Name	Field Type	Description
configMapKeyRef	ConfigMapKeySelector	ConfigMapKeyRef is configmap selector for Semaphore configuration
namespace	string	Namespace is the namespace of the configmap, default: [namespace of workflow]

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 location of a single workflow step, which the executor will use as a default location to store its files.

Examples with this field (click to open)

• archive-location.yaml

Fields

Field Name	Field Type	Description
archiveLogs	boolean	ArchiveLogs indicates if the container logs should be archived
artifactory	ArtifactoryArtifact	Artifactory contains artifactory artifact location details
azure	AzureArtifact	Azure contains Azure Storage artifact location details
gcs	GCSArtifact	GCS contains GCS artifact location details
git	GitArtifact	Git contains git artifact location details
hdfs	HDFSArtifact	HDFS contains HDFS artifact location details
http	HTTPArtifact	HTTP contains HTTP artifact location details
oss	OSSArtifact	OSS contains OSS artifact location details
raw	RawArtifact	Raw contains raw artifact location details
s3	S3Artifact	S3 contains S3 artifact location details

ContainerSetTemplate

No description available

Examples with this field (click to open)

• artifacts-workflowtemplate.yaml

• graph-workflow.yaml

• outputs-result-workflow.yaml

• parallel-workflow.yaml

• sequence-workflow.yaml

• workspace-workflow.yaml

Fields

Field Name	Field Type	Description
containers	Array<ContainerNode>	No description available
retryStrategy	ContainerSetRetryStrategy	RetryStrategy describes how to retry container nodes if the container set fails. Note that this works differently from the template-level retryStrategy as it is a process-level retry that does not create new Pods or containers.
volumeMounts	Array<VolumeMount>	No description available

DAGTemplate

DAGTemplate is a template subtype for directed acyclic graph templates

Examples with this field (click to open)

• buildkit-template.yaml

• ci-workflowtemplate.yaml

• cluster-wftmpl-dag.yaml

• clustertemplates.yaml

• outputs-result-workflow.yaml

• dag-coinflip.yaml

• dag-conditional-artifacts.yaml

• dag-conditional-parameters.yaml

• dag-continue-on-fail.yaml

• dag-custom-metrics.yaml

• dag-daemon-task.yaml

• dag-diamond-steps.yaml

• dag-diamond.yaml

• dag-disable-failFast.yaml

• dag-enhanced-depends.yaml

• dag-inline-clusterworkflowtemplate.yaml

• dag-inline-workflow.yaml

• dag-inline-workflowtemplate.yaml

• dag-multiroot.yaml

• dag-nested.yaml

• dag-targets.yaml

• dag-task-level-timeout.yaml

• exit-handler-dag-level.yaml

• expression-tag-template-workflow.yaml

• key-only-artifact.yaml

• loops-dag.yaml

• map-reduce.yaml

• parallelism-nested-dag.yaml

• parameter-aggregation-dag.yaml

• pod-spec-from-previous-step.yaml

• resubmit.yaml

• dag.yaml

• templates.yaml

Fields

Field Name	Field Type	Description
failFast	boolean	This flag is for DAG logic. The DAG logic has a built-in "fail fast" feature to stop scheduling new steps, as soon as it detects that one of the DAG nodes is failed. Then it waits until all DAG nodes are completed before failing the DAG itself. The FailFast flag default is true, if set to false, it will allow a DAG to run all branches of the DAG to completion (either success or failure), regardless of the failed outcomes of branches in the DAG. More info and example about this feature at https://github.com/argoproj/argo-workflows/issues/1442
target	string	Target are one or more names of targets to execute in a DAG
tasks	Array<DAGTask>	Tasks are a list of DAG tasks

Data

Data is a data template

Examples with this field (click to open)

• artifact-path-placeholders.yaml

• data-transformations.yaml

• input-artifact-raw.yaml

Fields

Field Name	Field Type	Description
source	DataSource	Source sources external data into a data template
transformation	Array<TransformationStep>	Transformation applies a set of transformations

HTTP

No description available

Examples with this field (click to open)

• arguments-artifacts.yaml

• artifactory-artifact.yaml

• artifacts-workflowtemplate.yaml

• daemon-nginx.yaml

• daemon-step.yaml

• dag-daemon-task.yaml

• http-hello-world.yaml

• http-success-condition.yaml

• influxdb-ci.yaml

• input-artifact-http.yaml

• input-artifact-oss.yaml

• life-cycle-hooks-tmpl-level.yaml

• life-cycle-hooks-wf-level.yaml

• sidecar-nginx.yaml

• sidecar.yaml

• webhdfs-input-output-artifacts.yaml

Fields

Field Name	Field Type	Description
body	string	Body is content of the HTTP Request
bodyFrom	HTTPBodySource	BodyFrom is content of the HTTP Request as Bytes
headers	Array<HTTPHeader>	Headers are an optional list of headers to send with HTTP requests
insecureSkipVerify	boolean	InsecureSkipVerify is a bool when if set to true will skip TLS verification for the HTTP client
method	string	Method is HTTP methods for HTTP Request
successCondition	string	SuccessCondition is an expression if evaluated to true is considered successful
timeoutSeconds	integer	TimeoutSeconds is request timeout for HTTP Request. Default is 30 seconds
url	string	URL of the HTTP Request

UserContainer

UserContainer is a container specified by a user.

Examples with this field (click to open)

• init-container.yaml

Fields

Field Name	Field Type	Description
args	Array< string >	Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(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 container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(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>	List of environment variables to set in the container. Cannot be updated.
envFrom	Array<EnvFromSource>	List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, 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	Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container 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	Actions that the management system should take in response to container lifecycle events. Cannot be updated.
livenessProbe	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
mirrorVolumeMounts	boolean	MirrorVolumeMounts will mount the same volumes specified in the main container to the container (including artifacts), at the same mountPaths. This enables dind daemon to partially see the same filesystem as the main container in order to use features such as docker volume binding
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>	List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated.
readinessProbe	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
resizePolicy	Array<ContainerResizePolicy>	Resources resize policy for the container.
resources	ResourceRequirements	Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
restartPolicy	string	RestartPolicy defines the restart behavior of individual containers in a pod. This field may only be set for init containers, and the only allowed value is "Always". For non-init containers or when this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. Setting the RestartPolicy as "Always" for the init container will have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy "Always" will be shut down. This lifecycle differs from normal init containers and is often referred to as a "sidecar" container. Although this init container still starts in the init container sequence, it does not wait for the container to complete before proceeding to the next init container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed.
securityContext	SecurityContext	SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
startupProbe	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. 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 this is 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 by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first 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 this flag 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 message will 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 across all 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 of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message 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>	volumeDevices is the list of block devices to be used by the container.
volumeMounts	Array<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, which might be configured in the container image. Cannot be updated.

Inputs

Inputs are the mechanism for passing parameters, artifacts, volumes from one template to another

Examples with this field (click to open)

• arguments-artifacts.yaml

• arguments-parameters-from-configmap.yaml

• arguments-parameters.yaml

• artifact-disable-archive.yaml

• artifact-passing-subpath.yaml

• artifact-passing.yaml

• artifact-path-placeholders.yaml

• artifactory-artifact.yaml

• artifacts-workflowtemplate.yaml

• buildkit-template.yaml

• ci-output-artifact.yaml

• ci-workflowtemplate.yaml

• ci.yaml

• clustertemplates.yaml

• conditionals.yaml

• outputs-result-workflow.yaml

• cron-backfill.yaml

• daemon-nginx.yaml

• daemon-step.yaml

• dag-custom-metrics.yaml

• dag-daemon-task.yaml

• dag-diamond-steps.yaml

• dag-diamond.yaml

• dag-multiroot.yaml

• dag-nested.yaml

• dag-targets.yaml

• dag-task-level-timeout.yaml

• data-transformations.yaml

• exit-code-output-variable.yaml

• exit-handler-dag-level.yaml

• exit-handler-step-level.yaml

• exit-handler-with-artifacts.yaml

• exit-handler-with-param.yaml

• expression-destructure-json-complex.yaml

• expression-destructure-json.yaml

• expression-reusing-verbose-snippets.yaml

• expression-tag-template-workflow.yaml

• fibonacci-seq-conditional-param.yaml

• global-outputs.yaml

• global-parameters-from-configmap-referenced-as-local-variable.yaml

• handle-large-output-results.yaml

• hdfs-artifact.yaml

• http-hello-world.yaml

• http-success-condition.yaml

• influxdb-ci.yaml

• input-artifact-azure.yaml

• input-artifact-gcs.yaml

• input-artifact-git.yaml

• input-artifact-http.yaml

• input-artifact-oss.yaml

• input-artifact-raw.yaml

• input-artifact-s3.yaml

• intermediate-parameters.yaml

• k8s-wait-wf.yaml

• key-only-artifact.yaml

• loops-arbitrary-sequential-steps.yaml

• loops-dag.yaml

• loops-maps.yaml

• loops-param-argument.yaml

• loops-param-result.yaml

• loops-sequence.yaml

• loops.yaml

• map-reduce.yaml

• nested-workflow.yaml

• node-selector.yaml

• output-parameter.yaml

• parallelism-nested-dag.yaml

• parallelism-nested-workflow.yaml

• parallelism-nested.yaml

• parameter-aggregation-dag.yaml

• parameter-aggregation-script.yaml

• parameter-aggregation.yaml

• pod-metadata-wf-field.yaml

• pod-metadata.yaml

• pod-spec-from-previous-step.yaml

• recursive-for-loop.yaml

• retry-conditional.yaml

• scripts-bash.yaml

• scripts-javascript.yaml

• scripts-python.yaml

• step-level-timeout.yaml

• steps.yaml

• suspend-template-outputs.yaml

• webhdfs-input-output-artifacts.yaml

• work-avoidance.yaml

• event-consumer-workflowtemplate.yaml

• workflow-of-workflows.yaml

• templates.yaml

Fields

Field Name	Field Type	Description
artifacts	Array<Artifact>	Artifact are a list of artifacts passed as inputs
parameters	Array<Parameter>	Parameters are a list of parameters passed as inputs

Memoize

Memoization enables caching for the Outputs of the template

Examples with this field (click to open)

• fibonacci-seq-conditional-param.yaml

Fields

Field Name	Field Type	Description
cache	Cache	Cache sets and configures the kind of cache
key	string	Key is the key to use as the caching key
maxAge	string	MaxAge is the maximum age (e.g. "180s", "24h") of an entry that is still considered valid. If an entry is older than the MaxAge, it will be ignored.

Plugin

Plugin is an Object with exactly one key

ResourceTemplate

ResourceTemplate is a template subtype to manipulate kubernetes resources

Examples with this field (click to open)

• cron-backfill.yaml

• k8s-owner-reference.yaml

• k8s-patch-json-pod.yaml

• k8s-patch-json-workflow.yaml

• k8s-patch-merge-pod.yaml

• k8s-wait-wf.yaml

• workflow-of-workflows.yaml

Fields

Field Name	Field Type	Description
action	string	Action is the action to perform to the resource. Must be one of: get, create, apply, delete, replace, patch
failureCondition	string	FailureCondition is a label selector expression which describes the conditions of the k8s resource in which the step was considered failed
flags	Array< string >	Flags is a set of additional options passed to kubectl before submitting a resource I.e. to disable resource validation: flags: [ "--validate=false" # disable resource validation ]
manifest	string	Manifest contains the kubernetes manifest
manifestFrom	ManifestFrom	ManifestFrom is the source for a single kubernetes manifest
mergeStrategy	string	MergeStrategy is the strategy used to merge a patch. It defaults to "strategic" Must be one of: strategic, merge, json
setOwnerReference	boolean	SetOwnerReference sets the reference to the workflow on the OwnerReference of generated resource.
successCondition	string	SuccessCondition is a label selector expression which describes the conditions of the k8s resource in which it is acceptable to proceed to the following step

ScriptTemplate

ScriptTemplate is a template subtype to enable scripting through code steps

Examples with this field (click to open)

• coinflip-recursive.yaml

• coinflip.yaml

• colored-logs.yaml

• conditional-artifacts.yaml

• conditional-parameters.yaml

• conditionals-complex.yaml

• outputs-result-workflow.yaml

• cron-backfill.yaml

• dag-coinflip.yaml

• dag-conditional-artifacts.yaml

• dag-conditional-parameters.yaml

• exit-handler-with-artifacts.yaml

• exit-handler-with-param.yaml

• expression-destructure-json-complex.yaml

• expression-destructure-json.yaml

• expression-reusing-verbose-snippets.yaml

• fibonacci-seq-conditional-param.yaml

• loops-param-result.yaml

• map-reduce.yaml

• parameter-aggregation-script.yaml

• parameter-aggregation.yaml

• pod-spec-from-previous-step.yaml

• recursive-for-loop.yaml

• retry-conditional.yaml

• retry-script.yaml

• scripts-bash.yaml

• scripts-javascript.yaml

• scripts-python.yaml

• withsequence-nested-result.yaml

• work-avoidance.yaml

Fields

Field Name	Field Type	Description
args	Array< string >	Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(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 container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(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>	List of environment variables to set in the container. Cannot be updated.
envFrom	Array<EnvFromSource>	List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, 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	Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container 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	Actions that the management system should take in response to container lifecycle events. Cannot be updated.
livenessProbe	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>	List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated.
readinessProbe	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
resizePolicy	Array<ContainerResizePolicy>	Resources resize policy for the container.
resources	ResourceRequirements	Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
restartPolicy	string	RestartPolicy defines the restart behavior of individual containers in a pod. This field may only be set for init containers, and the only allowed value is "Always". For non-init containers or when this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. Setting the RestartPolicy as "Always" for the init container will have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy "Always" will be shut down. This lifecycle differs from normal init containers and is often referred to as a "sidecar" container. Although this init container still starts in the init container sequence, it does not wait for the container to complete before proceeding to the next init container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed.
securityContext	SecurityContext	SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
source	string	Source contains the source code of the script to execute
startupProbe	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. 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 this is 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 by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first 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 this flag 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 message will 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 across all 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 of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message 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>	volumeDevices is the list of block devices to be used by the container.
volumeMounts	Array<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, which might be configured in the container image. Cannot be updated.

WorkflowStep

WorkflowStep is a reference to a template to execute in a series of step

Examples with this field (click to open)

• artifact-disable-archive.yaml

• artifact-passing-subpath.yaml

• artifact-passing.yaml

• artifactory-artifact.yaml

• ci-output-artifact.yaml

• ci.yaml

• clustertemplates.yaml

• mixed-cluster-namespaced-wftmpl-steps.yaml

• coinflip-recursive.yaml

• coinflip.yaml

• conditional-artifacts.yaml

• conditional-parameters.yaml

• conditionals-complex.yaml

• conditionals.yaml

• continue-on-fail.yaml

• cron-backfill.yaml

• custom-metrics.yaml

• daemon-nginx.yaml

• daemon-step.yaml

• dag-coinflip.yaml

• dag-diamond-steps.yaml

• data-transformations.yaml

• exit-code-output-variable.yaml

• exit-handler-step-level.yaml

• exit-handler-with-artifacts.yaml

• exit-handler-with-param.yaml

• exit-handlers.yaml

• fibonacci-seq-conditional-param.yaml

• fun-with-gifs.yaml

• global-outputs.yaml

• handle-large-output-results.yaml

• hdfs-artifact.yaml

• hello-hybrid.yaml

• http-hello-world.yaml

• http-success-condition.yaml

• influxdb-ci.yaml

• intermediate-parameters.yaml

• k8s-wait-wf.yaml

• life-cycle-hooks-tmpl-level.yaml

• life-cycle-hooks-wf-level.yaml

• loops-arbitrary-sequential-steps.yaml

• loops-maps.yaml

• loops-param-argument.yaml

• loops-param-result.yaml

• loops-sequence.yaml

• loops.yaml

• nested-workflow.yaml

• output-parameter.yaml

• parallelism-limit.yaml

• parallelism-nested-workflow.yaml

• parallelism-nested.yaml

• parallelism-template-limit.yaml

• parameter-aggregation-script.yaml

• parameter-aggregation.yaml

• pod-gc-strategy-with-label-selector.yaml

• pod-gc-strategy.yaml

• pod-metadata-wf-field.yaml

• pod-metadata.yaml

• recursive-for-loop.yaml

• resubmit.yaml

• retry-conditional.yaml

• retry-with-steps.yaml

• scripts-bash.yaml

• scripts-javascript.yaml

• scripts-python.yaml

• status-reference.yaml

• step-level-timeout.yaml

• steps-inline-workflow.yaml

• steps.yaml

• suspend-template-outputs.yaml

• suspend-template.yaml

• synchronization-mutex-tmpl-level-legacy.yaml

• synchronization-mutex-tmpl-level.yaml

• template-defaults.yaml

• template-on-exit.yaml

• timeouts-workflow.yaml

• volumes-existing.yaml

• volumes-pvc.yaml

• withsequence-nested-result.yaml

• work-avoidance.yaml

• event-consumer-workflowtemplate.yaml

• workflow-of-workflows.yaml

• hello-world.yaml

• retry-with-steps.yaml

• steps.yaml

• templates.yaml

Fields

Field Name	Field Type	Description
arguments	Arguments	Arguments hold arguments to the template
continueOn	ContinueOn	ContinueOn makes argo to proceed with the following step even if this step fails. Errors and Failed states can be specified
hooks	LifecycleHook	Hooks holds the lifecycle hook which is invoked at lifecycle of step, irrespective of the success, failure, or error status of the primary step
inline	Template	Inline is the template. Template must be empty if this is declared (and vice-versa).
name	string	Name of the step
~~onExit~~	~~string~~	~~OnExit is a template reference which is invoked at the end of the template, irrespective of the success, failure, or error of the primary template.~~ DEPRECATED: Use Hooks[exit].Template instead.
template	string	Template is the name of the template to execute as the step
templateRef	TemplateRef	TemplateRef is the reference to the template resource to execute as the step.
when	string	When is an expression in which the step should conditionally execute
withItems	Array<Item>	WithItems expands a step into multiple parallel steps from the items in the list
withParam	string	WithParam expands a step into multiple parallel steps from the value in the parameter, which is expected to be a JSON list.
withSequence	Sequence	WithSequence expands a step into a numeric sequence

SuspendTemplate

SuspendTemplate is a template subtype to suspend a workflow at a predetermined point in time

Examples with this field (click to open)

• cron-workflow-multiple-schedules.yaml

• cron-workflow.yaml

• intermediate-parameters.yaml

• suspend-template-outputs.yaml

• suspend-template.yaml

Fields

Field Name	Field Type	Description
duration	string	Duration is the seconds to wait before automatically resuming a template. Must be a string. Default unit is seconds. Could also be a Duration, e.g.: "2m", "6h"

LabelValueFrom

No description available

Examples with this field (click to open)

• label-value-from-workflow.yaml

Fields

Field Name	Field Type	Description
expression	string	No description available

ArtifactRepository

ArtifactRepository represents an artifact repository in which a controller will store its artifacts

Fields

Field Name	Field Type	Description
archiveLogs	boolean	ArchiveLogs enables log archiving
artifactory	ArtifactoryArtifactRepository	Artifactory stores artifacts to JFrog Artifactory
azure	AzureArtifactRepository	Azure stores artifact in an Azure Storage account
gcs	GCSArtifactRepository	GCS stores artifact in a GCS object store
hdfs	HDFSArtifactRepository	HDFS stores artifacts in HDFS
oss	OSSArtifactRepository	OSS stores artifact in a OSS-compliant object store
s3	S3ArtifactRepository	S3 stores artifact in a S3-compliant object store

MemoizationStatus

MemoizationStatus is the status of this memoized node

Fields

Field Name	Field Type	Description
cacheName	string	Cache is the name of the cache that was used
hit	boolean	Hit indicates whether this node was created from a cache entry
key	string	Key is the name of the key used for this node's cache

NodeFlag

No description available

Fields

Field Name	Field Type	Description
hooked	boolean	Hooked tracks whether or not this node was triggered by hook or onExit
retried	boolean	Retried tracks whether or not this node was retried by retryStrategy

NodeSynchronizationStatus

NodeSynchronizationStatus stores the status of a node

Fields

Field Name	Field Type	Description
waiting	string	Waiting is the name of the lock that this node is waiting for

MutexStatus

MutexStatus contains which objects hold mutex locks, and which objects this workflow is waiting on to release locks.

Examples with this field (click to open)

• synchronization-mutex-tmpl-level-legacy.yaml

• synchronization-mutex-tmpl-level.yaml

• synchronization-mutex-wf-level-legacy.yaml

• synchronization-mutex-wf-level.yaml

Fields

Field Name	Field Type	Description
holding	Array<MutexHolding>	Holding is a list of mutexes and their respective objects that are held by mutex lock for this io.argoproj.workflow.v1alpha1.
waiting	Array<MutexHolding>	Waiting is a list of mutexes and their respective objects this workflow is waiting for.

SemaphoreStatus

No description available

Fields

Field Name	Field Type	Description
holding	Array<SemaphoreHolding>	Holding stores the list of resource acquired synchronization lock for workflows.
waiting	Array<SemaphoreHolding>	Waiting indicates the list of current synchronization lock holders.

ArchiveStrategy

ArchiveStrategy describes how to archive files/directory when saving artifacts

Examples with this field (click to open)

• artifact-disable-archive.yaml

• artifact-passing-subpath.yaml

• artifacts-workflowtemplate.yaml

• ci-workflowtemplate.yaml

• map-reduce.yaml

• output-artifact-s3.yaml

Fields

Field Name	Field Type	Description
none	NoneStrategy	No description available
tar	TarStrategy	No description available
zip	ZipStrategy	No description available

ArtifactGC

ArtifactGC describes how to delete artifacts from completed Workflows - this is embedded into the WorkflowLevelArtifactGC, and also used for individual Artifacts to override that as needed

Examples with this field (click to open)

• artifact-gc-workflow.yaml

Fields

Field Name	Field Type	Description
podMetadata	Metadata	PodMetadata is an optional field for specifying the Labels and Annotations that should be assigned to the Pod doing the deletion
serviceAccountName	string	ServiceAccountName is an optional field for specifying the Service Account that should be assigned to the Pod doing the deletion
strategy	string	Strategy is the strategy to use.

ArtifactoryArtifact

ArtifactoryArtifact is the location of an artifactory artifact

Examples with this field (click to open)

• artifactory-artifact.yaml

Fields

Field Name	Field Type	Description
passwordSecret	SecretKeySelector	PasswordSecret is the secret selector to the repository password
url	string	URL of the artifact
usernameSecret	SecretKeySelector	UsernameSecret is the secret selector to the repository username

AzureArtifact

AzureArtifact is the location of a an Azure Storage artifact

Examples with this field (click to open)

• input-artifact-azure.yaml

• output-artifact-azure.yaml

Fields

Field Name	Field Type	Description
accountKeySecret	SecretKeySelector	AccountKeySecret is the secret selector to the Azure Blob Storage account access key
blob	string	Blob is the blob name (i.e., path) in the container where the artifact resides
container	string	Container is the container where resources will be stored
endpoint	string	Endpoint is the service url associated with an account. It is most likely "https://.blob.core.windows.net"
useSDKCreds	boolean	UseSDKCreds tells the driver to figure out credentials based on sdk defaults.

GCSArtifact

GCSArtifact is the location of a GCS artifact

Examples with this field (click to open)

• input-artifact-gcs.yaml

• output-artifact-gcs.yaml

Fields

Field Name	Field Type	Description
bucket	string	Bucket is the name of the bucket
key	string	Key is the path in the bucket where the artifact resides
serviceAccountKeySecret	SecretKeySelector	ServiceAccountKeySecret is the secret selector to the bucket's service account key

GitArtifact

GitArtifact is the location of an git artifact

Examples with this field (click to open)

• buildkit-template.yaml

• ci-output-artifact.yaml

• ci.yaml

• influxdb-ci.yaml

• input-artifact-git.yaml

Fields

Field Name	Field Type	Description
branch	string	Branch is the branch to fetch when SingleBranch is enabled
depth	integer	Depth specifies clones/fetches should be shallow and include the given number of commits from the branch tip
disableSubmodules	boolean	DisableSubmodules disables submodules during git clone
fetch	Array< string >	Fetch specifies a number of refs that should be fetched before checkout
insecureIgnoreHostKey	boolean	InsecureIgnoreHostKey disables SSH strict host key checking during git clone
insecureSkipTLS	boolean	InsecureSkipTLS disables server certificate verification resulting in insecure HTTPS connections
passwordSecret	SecretKeySelector	PasswordSecret is the secret selector to the repository password
repo	string	Repo is the git repository
revision	string	Revision is the git commit, tag, branch to checkout
singleBranch	boolean	SingleBranch enables single branch clone, using the branch parameter
sshPrivateKeySecret	SecretKeySelector	SSHPrivateKeySecret is the secret selector to the repository ssh private key
usernameSecret	SecretKeySelector	UsernameSecret is the secret selector to the repository username

HDFSArtifact

HDFSArtifact is the location of an HDFS artifact

Examples with this field (click to open)

• hdfs-artifact.yaml

Fields

Field Name	Field Type	Description
addresses	Array< string >	Addresses is accessible addresses of HDFS name nodes
dataTransferProtection	string	DataTransferProtection is the protection level for HDFS data transfer. It corresponds to the dfs.data.transfer.protection configuration in HDFS.
force	boolean	Force copies a file forcibly even if it exists
hdfsUser	string	HDFSUser is the user to access HDFS file system. It is ignored if either ccache or keytab is used.
krbCCacheSecret	SecretKeySelector	KrbCCacheSecret is the secret selector for Kerberos ccache Either ccache or keytab can be set to use Kerberos.
krbConfigConfigMap	ConfigMapKeySelector	KrbConfig is the configmap selector for Kerberos config as string It must be set if either ccache or keytab is used.
krbKeytabSecret	SecretKeySelector	KrbKeytabSecret is the secret selector for Kerberos keytab Either ccache or keytab can be set to use Kerberos.
krbRealm	string	KrbRealm is the Kerberos realm used with Kerberos keytab It must be set if keytab is used.
krbServicePrincipalName	string	KrbServicePrincipalName is the principal name of Kerberos service It must be set if either ccache or keytab is used.
krbUsername	string	KrbUsername is the Kerberos username used with Kerberos keytab It must be set if keytab is used.
path	string	Path is a file path in HDFS

HTTPArtifact

HTTPArtifact allows a file served on HTTP to be placed as an input artifact in a container

Examples with this field (click to open)

• arguments-artifacts.yaml

• artifactory-artifact.yaml

• artifacts-workflowtemplate.yaml

• daemon-nginx.yaml

• daemon-step.yaml

• dag-daemon-task.yaml

• http-hello-world.yaml

• http-success-condition.yaml

• influxdb-ci.yaml

• input-artifact-http.yaml

• input-artifact-oss.yaml

• life-cycle-hooks-tmpl-level.yaml

• life-cycle-hooks-wf-level.yaml

• sidecar-nginx.yaml

• sidecar.yaml

• webhdfs-input-output-artifacts.yaml

Fields

Field Name	Field Type	Description
auth	HTTPAuth	Auth contains information for client authentication
headers	Array<Header>	Headers are an optional list of headers to send with HTTP requests for artifacts
url	string	URL of the artifact

OSSArtifact

OSSArtifact is the location of an Alibaba Cloud OSS artifact

Examples with this field (click to open)

• input-artifact-oss.yaml

Fields

Field Name	Field Type	Description
accessKeySecret	SecretKeySelector	AccessKeySecret is the secret selector to the bucket's access key
bucket	string	Bucket is the name of the bucket
createBucketIfNotPresent	boolean	CreateBucketIfNotPresent tells the driver to attempt to create the OSS bucket for output artifacts, if it doesn't exist
endpoint	string	Endpoint is the hostname of the bucket endpoint
key	string	Key is the path in the bucket where the artifact resides
lifecycleRule	OSSLifecycleRule	LifecycleRule specifies how to manage bucket's lifecycle
secretKeySecret	SecretKeySelector	SecretKeySecret is the secret selector to the bucket's secret key
securityToken	string	SecurityToken is the user's temporary security token. For more details, check out: https://www.alibabacloud.com/help/doc-detail/100624.htm
useSDKCreds	boolean	UseSDKCreds tells the driver to figure out credentials based on sdk defaults.

RawArtifact

RawArtifact allows raw string content to be placed as an artifact in a container

Examples with this field (click to open)

• artifact-path-placeholders.yaml

• input-artifact-raw.yaml

Fields

Field Name	Field Type	Description
data	string	Data is the string contents of the artifact

S3Artifact

S3Artifact is the location of an S3 artifact

Fields

Field Name	Field Type	Description
accessKeySecret	SecretKeySelector	AccessKeySecret is the secret selector to the bucket's access key
bucket	string	Bucket is the name of the bucket
caSecret	SecretKeySelector	CASecret specifies the secret that contains the CA, used to verify the TLS connection
createBucketIfNotPresent	CreateS3BucketOptions	CreateBucketIfNotPresent tells the driver to attempt to create the S3 bucket for output artifacts, if it doesn't exist. Setting Enabled Encryption will apply either SSE-S3 to the bucket if KmsKeyId is not set or SSE-KMS if it is.
encryptionOptions	S3EncryptionOptions	No description available
endpoint	string	Endpoint is the hostname of the bucket endpoint
insecure	boolean	Insecure will connect to the service with TLS
key	string	Key is the key in the bucket where the artifact resides
region	string	Region contains the optional bucket region
roleARN	string	RoleARN is the Amazon Resource Name (ARN) of the role to assume.
secretKeySecret	SecretKeySelector	SecretKeySecret is the secret selector to the bucket's secret key
sessionTokenSecret	SecretKeySelector	SessionTokenSecret is used for ephemeral credentials like an IAM assume role or S3 access grant
useSDKCreds	boolean	UseSDKCreds tells the driver to figure out credentials based on sdk defaults.

ValueFrom

ValueFrom describes a location in which to obtain the value to a parameter

Examples with this field (click to open)

• arguments-parameters-from-configmap.yaml

• artifact-path-placeholders.yaml

• conditional-parameters.yaml

• workspace-workflow.yaml

• custom-metrics.yaml

• dag-conditional-parameters.yaml

• exit-handler-with-param.yaml

• expression-tag-template-workflow.yaml

• fibonacci-seq-conditional-param.yaml

• global-outputs.yaml

• global-parameters-from-configmap-referenced-as-local-variable.yaml

• global-parameters-from-configmap.yaml

• handle-large-output-results.yaml

• intermediate-parameters.yaml

• k8s-wait-wf.yaml

• nested-workflow.yaml

• output-parameter.yaml

• parameter-aggregation-dag.yaml

• parameter-aggregation.yaml

• pod-spec-from-previous-step.yaml

• secrets.yaml

• suspend-template-outputs.yaml

• event-consumer-workfloweventbinding.yaml

Fields

Field Name	Field Type	Description
configMapKeyRef	ConfigMapKeySelector	ConfigMapKeyRef is configmap selector for input parameter configuration
default	string	Default specifies a value to be used if retrieving the value from the specified source fails
event	string	Selector (https://github.com/expr-lang/expr) that is evaluated against the event to get the value of the parameter. E.g. payload.message
expression	string	Expression, if defined, is evaluated to specify the value for the parameter
jqFilter	string	JQFilter expression against the resource object in resource templates
jsonPath	string	JSONPath of a resource to retrieve an output parameter value from in resource templates
parameter	string	Parameter reference to a step or dag task in which to retrieve an output parameter value from (e.g. '{{steps.mystep.outputs.myparam}}')
path	string	Path in the container to retrieve an output parameter value from in container templates
supplied	SuppliedValueFrom	Supplied value to be filled in directly, either through the CLI, API, etc.

Counter

Counter is a Counter prometheus metric

Examples with this field (click to open)

• custom-metrics.yaml

• dag-custom-metrics.yaml

Fields

Field Name	Field Type	Description
value	string	Value is the value of the metric

Gauge

Gauge is a Gauge prometheus metric

Examples with this field (click to open)

• custom-metrics.yaml

• dag-custom-metrics.yaml

Fields

Field Name	Field Type	Description
operation	string	Operation defines the operation to apply with value and the metrics' current value
realtime	boolean	Realtime emits this metric in real time if applicable
value	string	Value is the value to be used in the operation with the metric's current value. If no operation is set, value is the value of the metric

Histogram

Histogram is a Histogram prometheus metric

Examples with this field (click to open)

• custom-metrics.yaml

Fields

Field Name	Field Type	Description
buckets	Array<Amount>	Buckets is a list of bucket divisors for the histogram
value	string	Value is the value of the metric

MetricLabel

MetricLabel is a single label for a prometheus metric

Examples with this field (click to open)

• arguments-parameters-from-configmap.yaml

• conditional-artifacts.yaml

• conditional-parameters.yaml

• graph-workflow.yaml

• outputs-result-workflow.yaml

• parallel-workflow.yaml

• sequence-workflow.yaml

• workspace-workflow.yaml

• custom-metrics.yaml

• dag-conditional-artifacts.yaml

• dag-conditional-parameters.yaml

• dag-custom-metrics.yaml

• dag-inline-workflow.yaml

• exit-handler-with-artifacts.yaml

• exit-handler-with-param.yaml

• expression-tag-template-workflow.yaml

• global-parameters-from-configmap-referenced-as-local-variable.yaml

• global-parameters-from-configmap.yaml

• hello-world.yaml

• http-hello-world.yaml

• k8s-owner-reference.yaml

• k8s-patch-json-pod.yaml

• k8s-patch-merge-pod.yaml

• pod-gc-strategy-with-label-selector.yaml

• pod-metadata-wf-field.yaml

• pod-metadata.yaml

• steps-inline-workflow.yaml

• title-and-description-with-markdown.yaml

Fields

Field Name	Field Type	Description
key	string	No description available
value	string	No description available

RetryNodeAntiAffinity

RetryNodeAntiAffinity is a placeholder for future expansion, only empty nodeAntiAffinity is allowed. In order to prevent running steps on the same host, it uses "kubernetes.io/hostname".

ContainerNode

No description available

Examples with this field (click to open)

• artifacts-workflowtemplate.yaml

• graph-workflow.yaml

• outputs-result-workflow.yaml

• parallel-workflow.yaml

• sequence-workflow.yaml

• workspace-workflow.yaml

• pod-spec-patch-wf-tmpl.yaml

• pod-spec-yaml-patch.yaml

Fields

Field Name	Field Type	Description
args	Array< string >	Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(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 container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(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
dependencies	Array< string >	No description available
env	Array<EnvVar>	List of environment variables to set in the container. Cannot be updated.
envFrom	Array<EnvFromSource>	List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, 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	Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container 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	Actions that the management system should take in response to container lifecycle events. Cannot be updated.
livenessProbe	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>	List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated.
readinessProbe	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
resizePolicy	Array<ContainerResizePolicy>	Resources resize policy for the container.
resources	ResourceRequirements	Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
restartPolicy	string	RestartPolicy defines the restart behavior of individual containers in a pod. This field may only be set for init containers, and the only allowed value is "Always". For non-init containers or when this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. Setting the RestartPolicy as "Always" for the init container will have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy "Always" will be shut down. This lifecycle differs from normal init containers and is often referred to as a "sidecar" container. Although this init container still starts in the init container sequence, it does not wait for the container to complete before proceeding to the next init container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed.
securityContext	SecurityContext	SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
startupProbe	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. 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 this is 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 by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first 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 this flag 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 message will 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 across all 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 of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message 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>	volumeDevices is the list of block devices to be used by the container.
volumeMounts	Array<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, which might be configured in the container image. Cannot be updated.

ContainerSetRetryStrategy

ContainerSetRetryStrategy provides controls on how to retry a container set

Examples with this field (click to open)

• clustertemplates.yaml

• dag-disable-failFast.yaml

• retry-backoff.yaml

• retry-conditional.yaml

• retry-container-to-completion.yaml

• retry-container.yaml

• retry-on-error.yaml

• retry-script.yaml

• retry-with-steps.yaml

• template-defaults.yaml

• templates.yaml

Fields

Field Name	Field Type	Description
duration	string	Duration is the time between each retry, examples values are "300ms", "1s" or "5m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
retries	IntOrString	Retries is the maximum number of retry attempts for each container. It does not include the first, original attempt; the maximum number of total attempts will be retries + 1.

DAGTask

DAGTask represents a node in the graph during DAG execution

Examples with this field (click to open)

• buildkit-template.yaml

• ci-workflowtemplate.yaml

• cluster-wftmpl-dag.yaml

• clustertemplates.yaml

• outputs-result-workflow.yaml

• dag-coinflip.yaml

• dag-conditional-artifacts.yaml

• dag-conditional-parameters.yaml

• dag-continue-on-fail.yaml

• dag-custom-metrics.yaml

• dag-daemon-task.yaml

• dag-diamond-steps.yaml

• dag-diamond.yaml

• dag-disable-failFast.yaml

• dag-enhanced-depends.yaml

• dag-inline-clusterworkflowtemplate.yaml

• dag-inline-workflow.yaml

• dag-inline-workflowtemplate.yaml

• dag-multiroot.yaml

• dag-nested.yaml

• dag-targets.yaml

• dag-task-level-timeout.yaml

• exit-handler-dag-level.yaml

• expression-tag-template-workflow.yaml

• key-only-artifact.yaml

• loops-dag.yaml

• map-reduce.yaml

• parallelism-nested-dag.yaml

• parameter-aggregation-dag.yaml

• pod-spec-from-previous-step.yaml

• resubmit.yaml

• dag.yaml

• templates.yaml

Fields

Field Name	Field Type	Description
arguments	Arguments	Arguments are the parameter and artifact arguments to the template
continueOn	ContinueOn	ContinueOn makes argo to proceed with the following step even if this step fails. Errors and Failed states can be specified
dependencies	Array< string >	Dependencies are name of other targets which this depends on
depends	string	Depends are name of other targets which this depends on
hooks	LifecycleHook	Hooks hold the lifecycle hook which is invoked at lifecycle of task, irrespective of the success, failure, or error status of the primary task
inline	Template	Inline is the template. Template must be empty if this is declared (and vice-versa).
name	string	Name is the name of the target
~~onExit~~	~~string~~	~~OnExit is a template reference which is invoked at the end of the template, irrespective of the success, failure, or error of the primary template.~~ DEPRECATED: Use Hooks[exit].Template instead.
template	string	Name of template to execute
templateRef	TemplateRef	TemplateRef is the reference to the template resource to execute.
when	string	When is an expression in which the task should conditionally execute
withItems	Array<Item>	WithItems expands a task into multiple parallel tasks from the items in the list
withParam	string	WithParam expands a task into multiple parallel tasks from the value in the parameter, which is expected to be a JSON list.
withSequence	Sequence	WithSequence expands a task into a numeric sequence

DataSource

DataSource sources external data into a data template

Examples with this field (click to open)

• coinflip-recursive.yaml

• coinflip.yaml

• colored-logs.yaml

• conditional-artifacts.yaml

• conditional-parameters.yaml

• conditionals-complex.yaml

• outputs-result-workflow.yaml

• cron-backfill.yaml

• dag-coinflip.yaml

• dag-conditional-artifacts.yaml

• dag-conditional-parameters.yaml

• data-transformations.yaml

• exit-handler-with-artifacts.yaml

• exit-handler-with-param.yaml

• expression-destructure-json-complex.yaml

• expression-destructure-json.yaml

• expression-reusing-verbose-snippets.yaml

• fibonacci-seq-conditional-param.yaml

• loops-param-result.yaml

• map-reduce.yaml

• parameter-aggregation-script.yaml

• parameter-aggregation.yaml

• pod-spec-from-previous-step.yaml

• recursive-for-loop.yaml

• retry-conditional.yaml

• retry-script.yaml

• scripts-bash.yaml

• scripts-javascript.yaml

• scripts-python.yaml

• withsequence-nested-result.yaml

• work-avoidance.yaml

Fields

Field Name	Field Type	Description
artifactPaths	ArtifactPaths	ArtifactPaths is a data transformation that collects a list of artifact paths

TransformationStep

No description available

Examples with this field (click to open)

• data-transformations.yaml

Fields

Field Name	Field Type	Description
expression	string	Expression defines an expr expression to apply

HTTPBodySource

HTTPBodySource contains the source of the HTTP body.

Fields

Field Name	Field Type	Description
bytes	byte	No description available

HTTPHeader

No description available

Examples with this field (click to open)

• webhdfs-input-output-artifacts.yaml

Fields

Field Name	Field Type	Description
name	string	No description available
value	string	No description available
valueFrom	HTTPHeaderSource	No description available

Cache

Cache is the configuration for the type of cache to be used

Examples with this field (click to open)

• fibonacci-seq-conditional-param.yaml

Fields

Field Name	Field Type	Description
configMap	ConfigMapKeySelector	ConfigMap sets a ConfigMap-based cache

ManifestFrom

No description available

Fields

Field Name	Field Type	Description
artifact	Artifact	Artifact contains the artifact to use

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)

• continue-on-fail.yaml

• exit-code-output-variable.yaml

• http-hello-world.yaml

• status-reference.yaml

• step-level-timeout.yaml

Fields

Field Name	Field Type	Description
error	boolean	No description available
failed	boolean	No description available

Item

Item expands a single workflow step into multiple parallel steps The value of Item can be a map, string, bool, or number

Examples with this field (click to open)

• ci-output-artifact.yaml

• ci.yaml

• dag-custom-metrics.yaml

• dag-diamond-steps.yaml

• loops-dag.yaml

• loops-maps.yaml

• loops.yaml

• parallelism-limit.yaml

• parallelism-template-limit.yaml

• parameter-aggregation-dag.yaml

• parameter-aggregation-script.yaml

• parameter-aggregation.yaml

• timeouts-workflow.yaml

Sequence

Sequence expands a workflow step into numeric range

Examples with this field (click to open)

• cron-backfill.yaml

• handle-large-output-results.yaml

• loops-sequence.yaml

• withsequence-nested-result.yaml

• work-avoidance.yaml

Fields

Field Name	Field Type	Description
count	IntOrString	Count is number of elements in the sequence (default: 0). Not to be used with end
end	IntOrString	Number at which to end the sequence (default: 0). Not to be used with Count
format	string	Format is a printf format string to format the value in the sequence
start	IntOrString	Number at which to start the sequence (default: 0)

ArtifactoryArtifactRepository

ArtifactoryArtifactRepository defines the controller configuration for an artifactory artifact repository

Examples with this field (click to open)

• artifactory-artifact.yaml

Fields

Field Name	Field Type	Description
keyFormat	string	KeyFormat defines the format of how to store keys and can reference workflow variables.
passwordSecret	SecretKeySelector	PasswordSecret is the secret selector to the repository password
repoURL	string	RepoURL is the url for artifactory repo.
usernameSecret	SecretKeySelector	UsernameSecret is the secret selector to the repository username

AzureArtifactRepository

AzureArtifactRepository defines the controller configuration for an Azure Blob Storage artifact repository

Examples with this field (click to open)

• input-artifact-azure.yaml

• output-artifact-azure.yaml

Fields

Field Name	Field Type	Description
accountKeySecret	SecretKeySelector	AccountKeySecret is the secret selector to the Azure Blob Storage account access key
blobNameFormat	string	BlobNameFormat is defines the format of how to store blob names. Can reference workflow variables
container	string	Container is the container where resources will be stored
endpoint	string	Endpoint is the service url associated with an account. It is most likely "https://.blob.core.windows.net"
useSDKCreds	boolean	UseSDKCreds tells the driver to figure out credentials based on sdk defaults.

GCSArtifactRepository

GCSArtifactRepository defines the controller configuration for a GCS artifact repository

Examples with this field (click to open)

• input-artifact-gcs.yaml

• output-artifact-gcs.yaml

Fields

Field Name	Field Type	Description
bucket	string	Bucket is the name of the bucket
keyFormat	string	KeyFormat defines the format of how to store keys and can reference workflow variables.
serviceAccountKeySecret	SecretKeySelector	ServiceAccountKeySecret is the secret selector to the bucket's service account key

HDFSArtifactRepository

HDFSArtifactRepository defines the controller configuration for an HDFS artifact repository

Examples with this field (click to open)

• hdfs-artifact.yaml

Fields

Field Name	Field Type	Description
addresses	Array< string >	Addresses is accessible addresses of HDFS name nodes
dataTransferProtection	string	DataTransferProtection is the protection level for HDFS data transfer. It corresponds to the dfs.data.transfer.protection configuration in HDFS.
force	boolean	Force copies a file forcibly even if it exists
hdfsUser	string	HDFSUser is the user to access HDFS file system. It is ignored if either ccache or keytab is used.
krbCCacheSecret	SecretKeySelector	KrbCCacheSecret is the secret selector for Kerberos ccache Either ccache or keytab can be set to use Kerberos.
krbConfigConfigMap	ConfigMapKeySelector	KrbConfig is the configmap selector for Kerberos config as string It must be set if either ccache or keytab is used.
krbKeytabSecret	SecretKeySelector	KrbKeytabSecret is the secret selector for Kerberos keytab Either ccache or keytab can be set to use Kerberos.
krbRealm	string	KrbRealm is the Kerberos realm used with Kerberos keytab It must be set if keytab is used.
krbServicePrincipalName	string	KrbServicePrincipalName is the principal name of Kerberos service It must be set if either ccache or keytab is used.
krbUsername	string	KrbUsername is the Kerberos username used with Kerberos keytab It must be set if keytab is used.
pathFormat	string	PathFormat is defines the format of path to store a file. Can reference workflow variables

OSSArtifactRepository

OSSArtifactRepository defines the controller configuration for an OSS artifact repository

Examples with this field (click to open)

• input-artifact-oss.yaml

Fields

Field Name	Field Type	Description
accessKeySecret	SecretKeySelector	AccessKeySecret is the secret selector to the bucket's access key
bucket	string	Bucket is the name of the bucket
createBucketIfNotPresent	boolean	CreateBucketIfNotPresent tells the driver to attempt to create the OSS bucket for output artifacts, if it doesn't exist
endpoint	string	Endpoint is the hostname of the bucket endpoint
keyFormat	string	KeyFormat defines the format of how to store keys and can reference workflow variables.
lifecycleRule	OSSLifecycleRule	LifecycleRule specifies how to manage bucket's lifecycle
secretKeySecret	SecretKeySelector	SecretKeySecret is the secret selector to the bucket's secret key
securityToken	string	SecurityToken is the user's temporary security token. For more details, check out: https://www.alibabacloud.com/help/doc-detail/100624.htm
useSDKCreds	boolean	UseSDKCreds tells the driver to figure out credentials based on sdk defaults.

S3ArtifactRepository

S3ArtifactRepository defines the controller configuration for an S3 artifact repository

Fields

Field Name	Field Type	Description
accessKeySecret	SecretKeySelector	AccessKeySecret is the secret selector to the bucket's access key
bucket	string	Bucket is the name of the bucket
caSecret	SecretKeySelector	CASecret specifies the secret that contains the CA, used to verify the TLS connection
createBucketIfNotPresent	CreateS3BucketOptions	CreateBucketIfNotPresent tells the driver to attempt to create the S3 bucket for output artifacts, if it doesn't exist. Setting Enabled Encryption will apply either SSE-S3 to the bucket if KmsKeyId is not set or SSE-KMS if it is.
encryptionOptions	S3EncryptionOptions	No description available
endpoint	string	Endpoint is the hostname of the bucket endpoint
insecure	boolean	Insecure will connect to the service with TLS
keyFormat	string	KeyFormat defines the format of how to store keys and can reference workflow variables.
~~keyPrefix~~	~~string~~	~~KeyPrefix is prefix used as part of the bucket key in which the controller will store artifacts.~~ DEPRECATED. Use KeyFormat instead
region	string	Region contains the optional bucket region
roleARN	string	RoleARN is the Amazon Resource Name (ARN) of the role to assume.
secretKeySecret	SecretKeySelector	SecretKeySecret is the secret selector to the bucket's secret key
sessionTokenSecret	SecretKeySelector	SessionTokenSecret is used for ephemeral credentials like an IAM assume role or S3 access grant
useSDKCreds	boolean	UseSDKCreds tells the driver to figure out credentials based on sdk defaults.

MutexHolding

MutexHolding describes the mutex and the object which is holding it.

Fields

Field Name	Field Type	Description
holder	string	Holder is a reference to the object which holds the Mutex. Holding Scenario: 1. Current workflow's NodeID which is holding the lock. e.g: ${NodeID} Waiting Scenario: 1. Current workflow or other workflow NodeID which is holding the lock. e.g: ${WorkflowName}/${NodeID}
mutex	string	Reference for the mutex e.g: ${namespace}/mutex/${mutexName}

SemaphoreHolding

No description available

Fields

Field Name	Field Type	Description
holders	Array< string >	Holders stores the list of current holder names in the io.argoproj.workflow.v1alpha1.
semaphore	string	Semaphore stores the semaphore name.

NoneStrategy

NoneStrategy indicates to skip tar process and upload the files or directory tree as independent files. Note that if the artifact is a directory, the artifact driver must support the ability to save/load the directory appropriately.

Examples with this field (click to open)

• artifact-disable-archive.yaml

• artifact-passing-subpath.yaml

• artifacts-workflowtemplate.yaml

• ci-workflowtemplate.yaml

• map-reduce.yaml

• output-artifact-s3.yaml

TarStrategy

TarStrategy will tar and gzip the file or directory when saving

Examples with this field (click to open)

• artifact-disable-archive.yaml

Fields

Field Name	Field Type	Description
compressionLevel	integer	CompressionLevel specifies the gzip compression level to use for the artifact. Defaults to gzip.DefaultCompression.

ZipStrategy

ZipStrategy will unzip zipped input artifacts

HTTPAuth

No description available

Examples with this field (click to open)

• webhdfs-input-output-artifacts.yaml

Fields

Field Name	Field Type	Description
basicAuth	BasicAuth	No description available
clientCert	ClientCertAuth	No description available
oauth2	OAuth2Auth	No description available

Header

Header indicate a key-value request header to be used when fetching artifacts over HTTP

Examples with this field (click to open)

• webhdfs-input-output-artifacts.yaml

Fields

Field Name	Field Type	Description
name	string	Name is the header name
value	string	Value is the literal value to use for the header

OSSLifecycleRule

OSSLifecycleRule specifies how to manage bucket's lifecycle

Fields

Field Name	Field Type	Description
markDeletionAfterDays	integer	MarkDeletionAfterDays is the number of days before we delete objects in the bucket
markInfrequentAccessAfterDays	integer	MarkInfrequentAccessAfterDays is the number of days before we convert the objects in the bucket to Infrequent Access (IA) storage type

CreateS3BucketOptions

CreateS3BucketOptions options used to determine automatic automatic bucket-creation process

Fields

Field Name	Field Type	Description
objectLocking	boolean	ObjectLocking Enable object locking

S3EncryptionOptions

S3EncryptionOptions used to determine encryption options during s3 operations

Fields

Field Name	Field Type	Description
enableEncryption	boolean	EnableEncryption tells the driver to encrypt objects if set to true. If kmsKeyId and serverSideCustomerKeySecret are not set, SSE-S3 will be used
kmsEncryptionContext	string	KmsEncryptionContext is a json blob that contains an encryption context. See https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context for more information
kmsKeyId	string	KMSKeyId tells the driver to encrypt the object using the specified KMS Key.
serverSideCustomerKeySecret	SecretKeySelector	ServerSideCustomerKeySecret tells the driver to encrypt the output artifacts using SSE-C with the specified secret.

SuppliedValueFrom

SuppliedValueFrom is a placeholder for a value to be filled in directly, either through the CLI, API, etc.

Examples with this field (click to open)

• intermediate-parameters.yaml

• suspend-template-outputs.yaml

Amount

Amount represent a numeric amount.

Examples with this field (click to open)

• custom-metrics.yaml

ArtifactPaths

ArtifactPaths expands a step from a collection of artifacts

Examples with this field (click to open)

• data-transformations.yaml

Fields

Field Name	Field Type	Description
archive	ArchiveStrategy	Archive controls how the artifact will be saved to the artifact repository.
archiveLogs	boolean	ArchiveLogs indicates if the container logs should be archived
artifactGC	ArtifactGC	ArtifactGC describes the strategy to use when to deleting an artifact from completed or deleted workflows
artifactory	ArtifactoryArtifact	Artifactory contains artifactory artifact location details
azure	AzureArtifact	Azure contains Azure Storage artifact location details
deleted	boolean	Has this been deleted?
from	string	From allows an artifact to reference an artifact from a previous step
fromExpression	string	FromExpression, if defined, is evaluated to specify the value for the artifact
gcs	GCSArtifact	GCS contains GCS artifact location details
git	GitArtifact	Git contains git artifact location details
globalName	string	GlobalName exports an output artifact to the global scope, making it available as '{{io.argoproj.workflow.v1alpha1.outputs.artifacts.XXXX}} and in workflow.status.outputs.artifacts
hdfs	HDFSArtifact	HDFS contains HDFS artifact location details
http	HTTPArtifact	HTTP contains HTTP artifact location details
mode	integer	mode bits to use on this file, must be a value between 0 and 0777 set when loading input artifacts.
name	string	name of the artifact. must be unique within a template's inputs/outputs.
optional	boolean	Make Artifacts optional, if Artifacts doesn't generate or exist
oss	OSSArtifact	OSS contains OSS artifact location details
path	string	Path is the container path to the artifact
raw	RawArtifact	Raw contains raw artifact location details
recurseMode	boolean	If mode is set, apply the permission recursively into the artifact if it is a folder
s3	S3Artifact	S3 contains S3 artifact location details
subPath	string	SubPath allows an artifact to be sourced from a subpath within the specified source

HTTPHeaderSource

No description available

Examples with this field (click to open)

• arguments-parameters-from-configmap.yaml

• artifact-path-placeholders.yaml

• conditional-parameters.yaml

• workspace-workflow.yaml

• custom-metrics.yaml

• dag-conditional-parameters.yaml

• exit-handler-with-param.yaml

• expression-tag-template-workflow.yaml

• fibonacci-seq-conditional-param.yaml

• global-outputs.yaml

• global-parameters-from-configmap-referenced-as-local-variable.yaml

• global-parameters-from-configmap.yaml

• handle-large-output-results.yaml

• intermediate-parameters.yaml

• k8s-wait-wf.yaml

• nested-workflow.yaml

• output-parameter.yaml

• parameter-aggregation-dag.yaml

• parameter-aggregation.yaml

• pod-spec-from-previous-step.yaml

• secrets.yaml

• suspend-template-outputs.yaml

• event-consumer-workfloweventbinding.yaml

Fields

Field Name	Field Type	Description
secretKeyRef	SecretKeySelector	No description available

BasicAuth

BasicAuth describes the secret selectors required for basic authentication

Fields

Field Name	Field Type	Description
passwordSecret	SecretKeySelector	PasswordSecret is the secret selector to the repository password
usernameSecret	SecretKeySelector	UsernameSecret is the secret selector to the repository username

ClientCertAuth

ClientCertAuth holds necessary information for client authentication via certificates

Examples with this field (click to open)

• webhdfs-input-output-artifacts.yaml

Fields

Field Name	Field Type	Description
clientCertSecret	SecretKeySelector	No description available
clientKeySecret	SecretKeySelector	No description available

OAuth2Auth

OAuth2Auth holds all information for client authentication via OAuth2 tokens

Fields

Field Name	Field Type	Description
clientIDSecret	SecretKeySelector	No description available
clientSecretSecret	SecretKeySelector	No description available
endpointParams	Array<OAuth2EndpointParam>	No description available
scopes	Array< string >	No description available
tokenURLSecret	SecretKeySelector	No description available

OAuth2EndpointParam

EndpointParam is for requesting optional fields that should be sent in the oauth request

Examples with this field (click to open)

• webhdfs-input-output-artifacts.yaml

Fields

Field Name	Field Type	Description
key	string	Name is the header name
value	string	Value is the literal value to use for the header

External Fields

ObjectMeta

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

Examples with this field (click to open)

• archive-location.yaml

• arguments-artifacts.yaml

• arguments-parameters-from-configmap.yaml

• arguments-parameters.yaml

• artifact-disable-archive.yaml

• artifact-gc-workflow.yaml

• artifact-passing-subpath.yaml

• artifact-passing.yaml

• artifact-path-placeholders.yaml

• artifact-repository-ref.yaml

• artifactory-artifact.yaml

• artifacts-workflowtemplate.yaml

• buildkit-template.yaml

• ci-output-artifact.yaml

• ci-workflowtemplate.yaml

• ci.yaml

• cluster-wftmpl-dag.yaml

• clustertemplates.yaml

• mixed-cluster-namespaced-wftmpl-steps.yaml

• workflow-template-ref-with-entrypoint-arg-passing.yaml

• workflow-template-ref.yaml

• coinflip-recursive.yaml

• coinflip.yaml

• colored-logs.yaml

• conditional-artifacts.yaml

• conditional-parameters.yaml

• conditionals-complex.yaml

• conditionals.yaml

• graph-workflow.yaml

• outputs-result-workflow.yaml

• parallel-workflow.yaml

• sequence-workflow.yaml

• workspace-workflow.yaml

• continue-on-fail.yaml

• cron-backfill.yaml

• cron-when.yaml

• cron-workflow-multiple-schedules.yaml

• cron-workflow.yaml

• custom-metrics.yaml

• daemon-nginx.yaml

• daemon-step.yaml

• dag-coinflip.yaml

• dag-conditional-artifacts.yaml

• dag-conditional-parameters.yaml

• dag-continue-on-fail.yaml

• dag-custom-metrics.yaml

• dag-daemon-task.yaml

• dag-diamond-steps.yaml

• dag-diamond.yaml

• dag-disable-failFast.yaml

• dag-enhanced-depends.yaml

• dag-inline-clusterworkflowtemplate.yaml

• dag-inline-cronworkflow.yaml

• dag-inline-workflow.yaml

• dag-inline-workflowtemplate.yaml

• dag-multiroot.yaml

• dag-nested.yaml

• dag-targets.yaml

• dag-task-level-timeout.yaml

• data-transformations.yaml

• default-pdb-support.yaml

• dns-config.yaml

• exit-code-output-variable.yaml

• exit-handler-dag-level.yaml

• exit-handler-slack.yaml

• exit-handler-step-level.yaml

• exit-handler-with-artifacts.yaml

• exit-handler-with-param.yaml

• exit-handlers.yaml

• expression-destructure-json-complex.yaml

• expression-destructure-json.yaml

• expression-reusing-verbose-snippets.yaml

• expression-tag-template-workflow.yaml

• fibonacci-seq-conditional-param.yaml

• forever.yaml

• fun-with-gifs.yaml

• gc-ttl.yaml

• global-outputs.yaml

• global-parameters-from-configmap-referenced-as-local-variable.yaml

• global-parameters-from-configmap.yaml

• global-parameters.yaml

• handle-large-output-results.yaml

• hdfs-artifact.yaml

• hello-hybrid.yaml

• hello-windows.yaml

• hello-world.yaml

• http-hello-world.yaml

• http-success-condition.yaml

• image-pull-secrets.yaml

• influxdb-ci.yaml

• init-container.yaml

• input-artifact-azure.yaml

• input-artifact-gcs.yaml

• input-artifact-git.yaml

• input-artifact-http.yaml

• input-artifact-oss.yaml

• input-artifact-raw.yaml

• input-artifact-s3.yaml

• intermediate-parameters.yaml

• k8s-owner-reference.yaml

• k8s-patch-json-pod.yaml

• k8s-patch-json-workflow.yaml

• k8s-patch-merge-pod.yaml

• k8s-wait-wf.yaml

• key-only-artifact.yaml

• label-value-from-workflow.yaml

• life-cycle-hooks-tmpl-level.yaml

• life-cycle-hooks-wf-level.yaml

• loops-arbitrary-sequential-steps.yaml

• loops-dag.yaml

• loops-maps.yaml

• loops-param-argument.yaml

• loops-param-result.yaml

• loops-sequence.yaml

• loops.yaml

• map-reduce.yaml

• nested-workflow.yaml

• node-selector.yaml

• output-artifact-azure.yaml

• output-artifact-gcs.yaml

• output-artifact-s3.yaml

• output-parameter.yaml

• parallelism-limit.yaml

• parallelism-nested-dag.yaml

• parallelism-nested-workflow.yaml

• parallelism-nested.yaml

• parallelism-template-limit.yaml

• parameter-aggregation-dag.yaml

• parameter-aggregation-script.yaml

• parameter-aggregation.yaml

• pod-gc-strategy-with-label-selector.yaml

• pod-gc-strategy.yaml

• pod-metadata-wf-field.yaml

• pod-metadata.yaml

• pod-spec-from-previous-step.yaml

• pod-spec-patch-wf-tmpl.yaml

• pod-spec-patch.yaml

• pod-spec-yaml-patch.yaml

• recursive-for-loop.yaml

• resubmit.yaml

• retry-backoff.yaml

• retry-conditional.yaml

• retry-container-to-completion.yaml

• retry-container.yaml

• retry-on-error.yaml

• retry-script.yaml

• retry-with-steps.yaml

• scripts-bash.yaml

• scripts-javascript.yaml

• scripts-python.yaml

• secrets.yaml

• sidecar-dind.yaml

• sidecar-nginx.yaml

• sidecar.yaml

• status-reference.yaml

• step-level-timeout.yaml

• steps-inline-workflow.yaml

• steps.yaml

• suspend-template-outputs.yaml

• suspend-template.yaml

• synchronization-mutex-tmpl-level-legacy.yaml

• synchronization-mutex-tmpl-level.yaml

• synchronization-mutex-wf-level-legacy.yaml

• synchronization-mutex-wf-level.yaml

• template-defaults.yaml

• template-on-exit.yaml

• timeouts-step.yaml

• timeouts-workflow.yaml

• title-and-description-with-markdown.yaml

• volumes-emptydir.yaml

• volumes-existing.yaml

• volumes-pvc.yaml

• webhdfs-input-output-artifacts.yaml

• withsequence-nested-result.yaml

• work-avoidance.yaml

• event-consumer-workfloweventbinding.yaml

• event-consumer-workflowtemplate.yaml

• workflow-of-workflows.yaml

• dag.yaml

• hello-world.yaml

• retry-with-steps.yaml

• steps.yaml

• templates.yaml

• workflow-archive-logs.yaml

• workflow-template-ref-with-entrypoint-arg-passing.yaml

• workflow-template-ref.yaml

Fields

Field Name	Field Type	Description
annotations	Map< string , string >	Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
creationTimestamp	Time	CreationTimestamp is a timestamp representing the server time when this object was created. 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	integer	Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
deletionTimestamp	Time	DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers 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 the future, 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 react by 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 still exist after this timestamp, until an administrator or automated process can determine the resource 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 entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.
generateName	string	GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than 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 value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
generation	integer	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 controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
managedFields	Array<ManagedFieldsEntry>	ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.
name	string	Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
namespace	string	Namespace defines the space within which each name must be unique. An empty namespace is equivalent 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 for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
ownerReferences	Array<OwnerReference>	List of objects depended by this object. If ALL objects in the list have been 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 can be used by clients to determine when objects have changed. May be used for optimistic concurrency, 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	Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
uid	string	UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

Affinity

Affinity is a group of affinity scheduling rules.

Fields

Field Name	Field Type	Description
nodeAffinity	NodeAffinity	Describes node affinity scheduling rules for the pod.
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	Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).

PodDNSConfig

PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.

Examples with this field (click to open)

• dns-config.yaml

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.
options	Array<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 Options will 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

HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.

Fields

Field Name	Field Type	Description
hostnames	Array< string >	Hostnames for the above IP address.
ip	string	IP address of the host file entry.

LocalObjectReference

LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

Examples with this field (click to open)

• image-pull-secrets.yaml

Fields

Field Name	Field Type	Description
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

PodDisruptionBudgetSpec

PodDisruptionBudgetSpec is a description of a PodDisruptionBudget.

Examples with this field (click to open)

• default-pdb-support.yaml

Fields

Field Name	Field Type	Description
maxUnavailable	IntOrString	An eviction is allowed if at most "maxUnavailable" pods selected by "selector" are unavailable after the eviction, i.e. even in absence of the evicted pod. For example, one can prevent all voluntary evictions by specifying 0. This is a mutually exclusive setting with "minAvailable".
minAvailable	IntOrString	An eviction is allowed if at least "minAvailable" pods selected by "selector" will still be available after the eviction, i.e. even in the absence of the evicted pod. So for example you can prevent all voluntary evictions by specifying "100%".
selector	LabelSelector	Label query over pods whose evictions are managed by the disruption budget. A null selector will match no pods, while an empty ({}) selector will select all pods within the namespace.
unhealthyPodEvictionPolicy	string	UnhealthyPodEvictionPolicy defines the criteria for when unhealthy pods should be considered for eviction. Current implementation considers healthy pods, as pods that have status.conditions item with type="Ready",status="True". Valid policies are IfHealthyBudget and AlwaysAllow. If no policy is specified, the default behavior will be used, which corresponds to the IfHealthyBudget policy. IfHealthyBudget policy means that running pods (status.phase="Running"), but not yet healthy can be evicted only if the guarded application is not disrupted (status.currentHealthy is at least equal to status.desiredHealthy). Healthy pods will be subject to the PDB for eviction. AlwaysAllow policy means that all running pods (status.phase="Running"), but not yet healthy are considered disrupted and can be evicted regardless of whether the criteria in a PDB is met. This means perspective running pods of a disrupted application might not get a chance to become healthy. Healthy pods will be subject to the PDB for eviction. Additional policies may be added in the future. Clients making eviction decisions should disallow eviction of unhealthy pods if they encounter an unrecognized policy in this field. This field is beta-level. The eviction API uses this field when the feature gate PDBUnhealthyPodEvictionPolicy is enabled (enabled by default).

PodSecurityContext

PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.

Examples with this field (click to open)

• sidecar-dind.yaml

Fields

Field Name	Field Type	Description
appArmorProfile	AppArmorProfile	appArmorProfile is the AppArmor options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.
fsGroup	integer	A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: 1. The owning GID will be the FSGroup 2. 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. Note that this field cannot be set when spec.os.name is windows.
fsGroupChangePolicy	string	fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. Note that this field cannot be set when spec.os.name is windows.
runAsGroup	integer	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 and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
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 it does 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 and PodSecurityContext, the value specified in SecurityContext takes precedence.
runAsUser	integer	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 and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
seLinuxOptions	SELinuxOptions	The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
seccompProfile	SeccompProfile	The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.
supplementalGroups	Array< integer >	A list of groups applied to the first process run in each container, in addition to the container's primary GID, the fsGroup (if specified), and group memberships defined in the container image for the uid of the container process. If unspecified, no additional groups are added to any container. Note that group memberships defined in the container image for the uid of the container process are still effective, even if they are not included in this list. Note that this field cannot be set when spec.os.name is windows.
sysctls	Array<Sysctl>	Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows.
windowsOptions	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. Note that this field cannot be set when spec.os.name is linux.

Toleration

The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator .

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.
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 can tolerate all taints of a particular category.
tolerationSeconds	integer	TolerationSeconds represents the period of time the toleration (which must be of 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 and negative 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

PersistentVolumeClaim is a user's request for and claim to a persistent volume

Examples with this field (click to open)

• buildkit-template.yaml

• ci-output-artifact.yaml

• ci-workflowtemplate.yaml

• ci.yaml

• fun-with-gifs.yaml

• volumes-pvc.yaml

• work-avoidance.yaml

Fields

Field Name	Field Type	Description
apiVersion	string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind	string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata	ObjectMeta	Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec	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	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

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)

• artifacts-workflowtemplate.yaml

• buildkit-template.yaml

• workspace-workflow.yaml

• init-container.yaml

• secrets.yaml

• volumes-emptydir.yaml

• volumes-existing.yaml

Fields

Field Name	Field Type	Description
awsElasticBlockStore	AWSElasticBlockStoreVolumeSource	awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
azureDisk	AzureDiskVolumeSource	azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
azureFile	AzureFileVolumeSource	azureFile represents an Azure File Service mount on the host and bind mount to the pod.
cephfs	CephFSVolumeSource	cephFS represents a Ceph FS mount on the host that shares a pod's lifetime
cinder	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	configMap represents a configMap that should populate this volume
csi	CSIVolumeSource	csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
downwardAPI	DownwardAPIVolumeSource	downwardAPI represents downward API about the pod that should populate this volume
emptyDir	EmptyDirVolumeSource	emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
ephemeral	EphemeralVolumeSource	ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. A pod can use both types of ephemeral volumes and persistent volumes at the same time.
fc	FCVolumeSource	fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
flexVolume	FlexVolumeSource	flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
flocker	FlockerVolumeSource	flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running
gcePersistentDisk	GCEPersistentDiskVolumeSource	gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
~~gitRepo~~	~~GitRepoVolumeSource~~	~~gitRepo represents a git repository at a particular revision.~~ DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.
glusterfs	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	hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
iscsi	ISCSIVolumeSource	iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md
name	string	name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
nfs	NFSVolumeSource	nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
persistentVolumeClaim	PersistentVolumeClaimVolumeSource	persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
photonPersistentDisk	PhotonPersistentDiskVolumeSource	photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
portworxVolume	PortworxVolumeSource	portworxVolume represents a portworx volume attached and mounted on kubelets host machine
projected	ProjectedVolumeSource	projected items for all in one resources secrets, configmaps, and downward API
quobyte	QuobyteVolumeSource	quobyte represents a Quobyte mount on the host that shares a pod's lifetime
rbd	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	scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
secret	SecretVolumeSource	secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
storageos	StorageOSVolumeSource	storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
vsphereVolume	VsphereVirtualDiskVolumeSource	vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

Time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

ObjectReference

ObjectReference contains enough information to let you inspect or modify the referred object.

Fields

Field Name	Field Type	Description
apiVersion	string	API version of the referent.
fieldPath	string	If referring to a piece of an object instead of an entire object, this string should 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 triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.
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

LabelSelector

A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

Examples with this field (click to open)

• pod-gc-strategy-with-label-selector.yaml

Fields

Field Name	Field Type	Description
matchExpressions	Array<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 matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

IntOrString

No description available

Examples with this field (click to open)

• clustertemplates.yaml

• dag-disable-failFast.yaml

• retry-backoff.yaml

• retry-conditional.yaml

• retry-container.yaml

• retry-on-error.yaml

• retry-script.yaml

• retry-with-steps.yaml

• template-defaults.yaml

• templates.yaml

Container

A single application container that you want to run within a pod.

Examples with this field (click to open)

• archive-location.yaml

• arguments-artifacts.yaml

• arguments-parameters-from-configmap.yaml

• arguments-parameters.yaml

• artifact-disable-archive.yaml

• artifact-gc-workflow.yaml

• artifact-passing-subpath.yaml

• artifact-passing.yaml

• artifact-path-placeholders.yaml

• artifact-repository-ref.yaml

• artifactory-artifact.yaml

• buildkit-template.yaml

• ci-output-artifact.yaml

• ci-workflowtemplate.yaml

• ci.yaml

• clustertemplates.yaml

• coinflip-recursive.yaml

• coinflip.yaml

• conditionals-complex.yaml

• conditionals.yaml

• continue-on-fail.yaml

• cron-when.yaml

• cron-workflow-multiple-schedules.yaml

• cron-workflow.yaml

• custom-metrics.yaml

• daemon-nginx.yaml

• daemon-step.yaml

• dag-coinflip.yaml

• dag-continue-on-fail.yaml

• dag-custom-metrics.yaml

• dag-daemon-task.yaml

• dag-diamond-steps.yaml

• dag-diamond.yaml

• dag-disable-failFast.yaml

• dag-enhanced-depends.yaml

• dag-inline-clusterworkflowtemplate.yaml

• dag-inline-workflow.yaml

• dag-inline-workflowtemplate.yaml

• dag-multiroot.yaml

• dag-nested.yaml

• dag-targets.yaml

• dag-task-level-timeout.yaml

• data-transformations.yaml

• default-pdb-support.yaml

• dns-config.yaml

• exit-code-output-variable.yaml

• exit-handler-dag-level.yaml

• exit-handler-slack.yaml

• exit-handler-step-level.yaml

• exit-handler-with-artifacts.yaml

• exit-handler-with-param.yaml

• exit-handlers.yaml

• expression-tag-template-workflow.yaml

• fibonacci-seq-conditional-param.yaml

• forever.yaml

• fun-with-gifs.yaml

• gc-ttl.yaml

• global-outputs.yaml

• global-parameters-from-configmap-referenced-as-local-variable.yaml

• global-parameters-from-configmap.yaml

• global-parameters.yaml

• handle-large-output-results.yaml

• hdfs-artifact.yaml

• hello-hybrid.yaml

• hello-windows.yaml

• hello-world.yaml

• image-pull-secrets.yaml

• influxdb-ci.yaml

• init-container.yaml

• input-artifact-azure.yaml

• input-artifact-gcs.yaml

• input-artifact-git.yaml

• input-artifact-http.yaml

• input-artifact-oss.yaml

• input-artifact-raw.yaml

• input-artifact-s3.yaml

• intermediate-parameters.yaml

• k8s-owner-reference.yaml

• k8s-wait-wf.yaml

• key-only-artifact.yaml

• label-value-from-workflow.yaml

• life-cycle-hooks-tmpl-level.yaml

• life-cycle-hooks-wf-level.yaml

• loops-arbitrary-sequential-steps.yaml

• loops-dag.yaml

• loops-maps.yaml

• loops-param-argument.yaml

• loops-param-result.yaml

• loops-sequence.yaml

• loops.yaml

• nested-workflow.yaml

• node-selector.yaml

• output-artifact-azure.yaml

• output-artifact-gcs.yaml

• output-artifact-s3.yaml

• output-parameter.yaml

• parallelism-limit.yaml

• parallelism-nested-dag.yaml

• parallelism-nested-workflow.yaml

• parallelism-nested.yaml

• parallelism-template-limit.yaml

• parameter-aggregation-dag.yaml

• parameter-aggregation.yaml

• pod-gc-strategy-with-label-selector.yaml

• pod-gc-strategy.yaml

• pod-metadata-wf-field.yaml

• pod-metadata.yaml

• pod-spec-patch-wf-tmpl.yaml

• pod-spec-patch.yaml

• pod-spec-yaml-patch.yaml

• resubmit.yaml

• retry-backoff.yaml

• retry-container-to-completion.yaml

• retry-container.yaml

• retry-on-error.yaml

• retry-with-steps.yaml

• scripts-bash.yaml

• scripts-javascript.yaml

• scripts-python.yaml

• secrets.yaml

• sidecar-dind.yaml

• sidecar-nginx.yaml

• sidecar.yaml

• status-reference.yaml

• step-level-timeout.yaml

• steps-inline-workflow.yaml

• steps.yaml

• suspend-template-outputs.yaml

• suspend-template.yaml

• synchronization-mutex-tmpl-level-legacy.yaml

• synchronization-mutex-tmpl-level.yaml

• synchronization-mutex-wf-level-legacy.yaml

• synchronization-mutex-wf-level.yaml

• template-defaults.yaml

• template-on-exit.yaml

• timeouts-step.yaml

• timeouts-workflow.yaml

• title-and-description-with-markdown.yaml

• volumes-emptydir.yaml

• volumes-existing.yaml

• volumes-pvc.yaml

• webhdfs-input-output-artifacts.yaml

• work-avoidance.yaml

• event-consumer-workflowtemplate.yaml

• templates.yaml

• workflow-archive-logs.yaml

Fields

Field Name	Field Type	Description
args	Array< string >	Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(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 container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(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>	List of environment variables to set in the container. Cannot be updated.
envFrom	Array<EnvFromSource>	List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, 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	Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container 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	Actions that the management system should take in response to container lifecycle events. Cannot be updated.
livenessProbe	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>	List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated.
readinessProbe	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
resizePolicy	Array<ContainerResizePolicy>	Resources resize policy for the container.
resources	ResourceRequirements	Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
restartPolicy	string	RestartPolicy defines the restart behavior of individual containers in a pod. This field may only be set for init containers, and the only allowed value is "Always". For non-init containers or when this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. Setting the RestartPolicy as "Always" for the init container will have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy "Always" will be shut down. This lifecycle differs from normal init containers and is often referred to as a "sidecar" container. Although this init container still starts in the init container sequence, it does not wait for the container to complete before proceeding to the next init container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed.
securityContext	SecurityContext	SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
startupProbe	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. 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 this is 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 by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first 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 this flag 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 message will 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 across all 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 of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message 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>	volumeDevices is the list of block devices to be used by the container.
volumeMounts	Array<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, which might be configured in the container image. Cannot be updated.

ConfigMapKeySelector

Selects a key from a ConfigMap.

Examples with this field (click to open)

• arguments-parameters-from-configmap.yaml

• global-parameters-from-configmap-referenced-as-local-variable.yaml

• global-parameters-from-configmap.yaml

Fields

Field Name	Field Type	Description
key	string	The key to select.
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional	boolean	Specify whether the ConfigMap or its key must be defined

VolumeMount

VolumeMount describes a mounting of a Volume within a container.

Examples with this field (click to open)

• artifacts-workflowtemplate.yaml

• buildkit-template.yaml

• ci-output-artifact.yaml

• ci-workflowtemplate.yaml

• ci.yaml

• workspace-workflow.yaml

• fun-with-gifs.yaml

• init-container.yaml

• secrets.yaml

• volumes-emptydir.yaml

• volumes-existing.yaml

• volumes-pvc.yaml

• work-avoidance.yaml

Fields

Field Name	Field Type	Description
mountPath	string	Path within the container at which the volume should be mounted. Must not contain ':'.
mountPropagation	string	mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified (which defaults to None).
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.
recursiveReadOnly	string	RecursiveReadOnly specifies whether read-only mounts should be handled recursively. If ReadOnly is false, this field has no meaning and must be unspecified. If ReadOnly is true, and this field is set to Disabled, the mount is not made recursively read-only. If this field is set to IfPossible, the mount is made recursively read-only, if it is supported by the container runtime. If this field is set to Enabled, the mount is made recursively read-only if it is supported by the container runtime, otherwise the pod will not be started and an error will be generated to indicate the reason. If this field is set to IfPossible or Enabled, MountPropagation must be set to None (or be unspecified, which defaults to None). If this field is not specified, it is treated as an equivalent of Disabled.
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.

EnvVar

EnvVar represents an environment variable present in a Container.

Examples with this field (click to open)

• buildkit-template.yaml

• colored-logs.yaml

• expression-destructure-json-complex.yaml

• expression-destructure-json.yaml

• expression-reusing-verbose-snippets.yaml

• secrets.yaml

• sidecar-dind.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 expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".
valueFrom	EnvVarSource	Source for the environment variable's value. Cannot be used if value is not empty.

EnvFromSource

EnvFromSource represents the source of a set of ConfigMaps

Fields

Field Name	Field Type	Description
configMapRef	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	The Secret to select from

Lifecycle

Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.

Fields

Field Name	Field Type	Description
postStart	LifecycleHandler	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	LifecycleHandler	PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

Probe

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

Fields

Field Name	Field Type	Description
exec	ExecAction	Exec specifies the action to take.
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
grpc	GRPCAction	GRPC specifies an action involving a GRPC port.
httpGet	HTTPGetAction	HTTPGet specifies the http request to perform.
initialDelaySeconds	integer	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	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
successThreshold	integer	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.
tcpSocket	TCPSocketAction	TCPSocket specifies an action involving a TCP port.
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
timeoutSeconds	integer	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

ContainerPort represents a network port in a single container.

Fields

Field Name	Field Type	Description
containerPort	integer	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.
hostPort	integer	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. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.
protocol	string	Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".

ContainerResizePolicy

ContainerResizePolicy represents resource resize policy for the container.

Fields

Field Name	Field Type	Description
resourceName	string	Name of the resource to which this resource resize policy applies. Supported values: cpu, memory.
restartPolicy	string	Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired.

ResourceRequirements

ResourceRequirements describes the compute resource requirements.

Examples with this field (click to open)

• buildkit-template.yaml

• ci-output-artifact.yaml

• ci-workflowtemplate.yaml

• ci.yaml

• dns-config.yaml

• fun-with-gifs.yaml

• influxdb-ci.yaml

• pod-spec-patch-wf-tmpl.yaml

• pod-spec-yaml-patch.yaml

• volumes-pvc.yaml

• work-avoidance.yaml

Fields

Field Name	Field Type	Description
claims	Array<ResourceClaim>	Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
limits	Quantity	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
requests	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. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

SecurityContext

SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.

Examples with this field (click to open)

• sidecar-dind.yaml

Fields

Field Name	Field Type	Description
allowPrivilegeEscalation	boolean	AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.
appArmorProfile	AppArmorProfile	appArmorProfile is the AppArmor options to use by this container. If set, this profile overrides the pod's appArmorProfile. Note that this field cannot be set when spec.os.name is windows.
capabilities	Capabilities	The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.
privileged	boolean	Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.
procMount	string	procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.
readOnlyRootFilesystem	boolean	Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.
runAsGroup	integer	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 and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
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 it does 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 and PodSecurityContext, the value specified in SecurityContext takes precedence.
runAsUser	integer	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 and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
seLinuxOptions	SELinuxOptions	The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
seccompProfile	SeccompProfile	The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.
windowsOptions	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. Note that this field cannot be set when spec.os.name is linux.

VolumeDevice

volumeDevice describes a mapping of a raw block device within a container.

Fields

Field Name	Field Type	Description
devicePath	string	devicePath is the path inside of the container that the device will be mapped to.
name	string	name must match the name of a persistentVolumeClaim in the pod

SecretKeySelector

SecretKeySelector selects a key of a Secret.

Examples with this field (click to open)

• artifactory-artifact.yaml

• input-artifact-git.yaml

Fields

Field Name	Field Type	Description
key	string	The key of the secret to select from. Must be a valid secret key.
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional	boolean	Specify whether the Secret or its key must be defined

ManagedFieldsEntry

ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.

Fields

Field Name	Field Type	Description
apiVersion	string	APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set 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 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'.
subresource	string	Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.
time	Time	Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.

OwnerReference

OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.

Fields

Field Name	Field Type	Description
apiVersion	string	API version of the referent.
blockOwnerDeletion	boolean	If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. 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: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
uid	string	UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

NodeAffinity

Node affinity is a group of node affinity scheduling rules.

Fields

Field Name	Field Type	Description
preferredDuringSchedulingIgnoredDuringExecution	Array<PreferredSchedulingTerm>	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, 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; the node(s) with the highest sum are the most preferred.
requiredDuringSchedulingIgnoredDuringExecution	NodeSelector	If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.

PodAffinity

Pod affinity is a group of inter pod affinity scheduling rules.

Fields

Field Name	Field Type	Description
preferredDuringSchedulingIgnoredDuringExecution	Array<WeightedPodAffinityTerm>	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, 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; the node(s) with the highest sum are the most preferred.
requiredDuringSchedulingIgnoredDuringExecution	Array<PodAffinityTerm>	If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.

PodAntiAffinity

Pod anti affinity is a group of inter pod anti affinity scheduling rules.

Fields

Field Name	Field Type	Description
preferredDuringSchedulingIgnoredDuringExecution	Array<WeightedPodAffinityTerm>	The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, 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; the node(s) with the highest sum are the most preferred.
requiredDuringSchedulingIgnoredDuringExecution	Array<PodAffinityTerm>	If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.

PodDNSConfigOption

PodDNSConfigOption defines DNS resolver options of a pod.

Examples with this field (click to open)

• dns-config.yaml

Fields

Field Name	Field Type	Description
name	string	Required.
value	string	No description available

AppArmorProfile

AppArmorProfile defines a pod or container's AppArmor settings.

Fields

Field Name	Field Type	Description
localhostProfile	string	localhostProfile indicates a profile loaded on the node that should be used. The profile must be preconfigured on the node to work. Must match the loaded name of the profile. Must be set if and only if type is "Localhost".
type	string	type indicates which kind of AppArmor profile will be applied. Valid options are: Localhost - a profile pre-loaded on the node. RuntimeDefault - the container runtime's default profile. Unconfined - no AppArmor enforcement.

SELinuxOptions

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.
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.

SeccompProfile

SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set.

Fields

Field Name	Field Type	Description
localhostProfile	string	localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type.
type	string	type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.

Sysctl

Sysctl defines a kernel parameter to be set

Fields

Field Name	Field Type	Description
name	string	Name of a property to set
value	string	Value of a property to set

WindowsSecurityContextOptions

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 the GMSA credential spec named by the GMSACredentialSpecName field.
gmsaCredentialSpecName	string	GMSACredentialSpecName is the name of the GMSA credential spec to use.
hostProcess	boolean	HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.
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 and PodSecurityContext, the value specified in SecurityContext takes precedence.

PersistentVolumeClaimSpec

PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes

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
dataSource	TypedLocalObjectReference	dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.
dataSourceRef	TypedObjectReference	dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
resources	VolumeResourceRequirements	resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
selector	LabelSelector	selector is a label query over volumes to consider for binding.
storageClassName	string	storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
volumeAttributesClassName	string	volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass will be applied to the claim but it's not allowed to reset this field to empty string once it is set. If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass will be set by the persistentvolume controller if it exists. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ (Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.
volumeMode	string	volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
volumeName	string	volumeName is the binding reference to the PersistentVolume backing this claim.

PersistentVolumeClaimStatus

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
allocatedResourceStatuses	Map< string , string >	allocatedResourceStatuses stores status of resource being resized for the given PVC. Key names follow standard Kubernetes label syntax. Valid values are either: * Un-prefixed keys: - storage - the capacity of the volume. * Custom resources must use implementation-defined prefixed names such as "example.com/my-custom-resource" Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered reserved and hence may not be used. ClaimResourceStatus can be in any of following states: - ControllerResizeInProgress: State set when resize controller starts resizing the volume in control-plane. - ControllerResizeFailed: State set when resize has failed in resize controller with a terminal error. - NodeResizePending: State set when resize controller has finished resizing the volume but further resizing of volume is needed on the node. - NodeResizeInProgress: State set when kubelet starts resizing the volume. - NodeResizeFailed: State set when resizing has failed in kubelet with a terminal error. Transient errors don't set NodeResizeFailed. For example: if expanding a PVC for more capacity - this field can be one of the following states: - pvc.status.allocatedResourceStatus['storage'] = "ControllerResizeInProgress" - pvc.status.allocatedResourceStatus['storage'] = "ControllerResizeFailed" - pvc.status.allocatedResourceStatus['storage'] = "NodeResizePending" - pvc.status.allocatedResourceStatus['storage'] = "NodeResizeInProgress" - pvc.status.allocatedResourceStatus['storage'] = "NodeResizeFailed" When this field is not set, it means that no resize operation is in progress for the given PVC. A controller that receives PVC update with previously unknown resourceName or ClaimResourceStatus should ignore the update for the purpose it was designed. For example - a controller that only is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid resources associated with PVC. This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.
allocatedResources	Quantity	allocatedResources tracks the resources allocated to a PVC including its capacity. Key names follow standard Kubernetes label syntax. Valid values are either: * Un-prefixed keys: - storage - the capacity of the volume. * Custom resources must use implementation-defined prefixed names such as "example.com/my-custom-resource" Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered reserved and hence may not be used. Capacity reported here may be larger than the actual capacity when a volume expansion operation is requested. For storage quota, the larger value from allocatedResources and PVC.spec.resources is used. If allocatedResources is not set, PVC.spec.resources alone is used for quota calculation. If a volume expansion capacity request is lowered, allocatedResources is only lowered if there are no expansion operations in progress and if the actual volume capacity is equal or lower than the requested capacity. A controller that receives PVC update with previously unknown resourceName should ignore the update for the purpose it was designed. For example - a controller that only is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid resources associated with PVC. This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.
capacity	Quantity	capacity represents the actual resources of the underlying volume.
conditions	Array<PersistentVolumeClaimCondition>	conditions is the current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'Resizing'.
currentVolumeAttributesClassName	string	currentVolumeAttributesClassName is the current name of the VolumeAttributesClass the PVC is using. When unset, there is no VolumeAttributeClass applied to this PersistentVolumeClaim This is an alpha field and requires enabling VolumeAttributesClass feature.
modifyVolumeStatus	ModifyVolumeStatus	ModifyVolumeStatus represents the status object of ControllerModifyVolume operation. When this is unset, there is no ModifyVolume operation being attempted. This is an alpha field and requires enabling VolumeAttributesClass feature.
phase	string	phase represents the current phase of PersistentVolumeClaim.

AWSElasticBlockStoreVolumeSource

Represents a Persistent Disk resource in AWS. An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.

Fields

Field Name	Field Type	Description
fsType	string	fsType is the 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#awselasticblockstore
partition	integer	partition is 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	readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
volumeID	string	volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

AzureDiskVolumeSource

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

Fields

Field Name	Field Type	Description
cachingMode	string	cachingMode is the Host Caching mode: None, Read Only, Read Write.
diskName	string	diskName is the Name of the data disk in the blob storage
diskURI	string	diskURI is the URI of data disk in the blob storage
fsType	string	fsType is 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	kind expected values are 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	readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

AzureFileVolumeSource

AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

Fields

Field Name	Field Type	Description
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretName	string	secretName is the name of secret that contains Azure Storage Account Name and Key
shareName	string	shareName is the azure share Name

CephFSVolumeSource

Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.

Fields

Field Name	Field Type	Description
monitors	Array< string >	monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
path	string	path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /
readOnly	boolean	readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
secretFile	string	secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
secretRef	LocalObjectReference	secretRef is 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	user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

CinderVolumeSource

Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.

Fields

Field Name	Field Type	Description
fsType	string	fsType is the 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	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
secretRef	LocalObjectReference	secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.
volumeID	string	volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

ConfigMapVolumeSource

Adapts a ConfigMap into a volume. The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling.

Examples with this field (click to open)

• fibonacci-seq-conditional-param.yaml

Fields

Field Name	Field Type	Description
defaultMode	integer	defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
items	Array<KeyToPath>	items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional	boolean	optional specify whether the ConfigMap or its keys must be defined

CSIVolumeSource

Represents a source location of a volume to mount, managed by an external CSI driver

Fields

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	fsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.
nodePublishSecretRef	LocalObjectReference	nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.
readOnly	boolean	readOnly 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 CSI driver. Consult your driver's documentation for supported values.

DownwardAPIVolumeSource

DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.

Fields

Field Name	Field Type	Description
defaultMode	integer	Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
items	Array<DownwardAPIVolumeFile>	Items is a list of downward API volume file

EmptyDirVolumeSource

Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.

Examples with this field (click to open)

• artifacts-workflowtemplate.yaml

• workspace-workflow.yaml

• init-container.yaml

• volumes-emptydir.yaml

Fields

Field Name	Field Type	Description
medium	string	medium represents 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	sizeLimit is the 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 between the 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: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

EphemeralVolumeSource

Represents an ephemeral volume that is handled by a normal storage driver.

Fields

Field Name	Field Type	Description
volumeClaimTemplate	PersistentVolumeClaimTemplate	Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. Required, must not be nil.

FCVolumeSource

Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.

Fields

Field Name	Field Type	Description
fsType	string	fsType is the 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.
lun	integer	lun is Optional: FC target lun number
readOnly	boolean	readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
targetWWNs	Array< string >	targetWWNs is Optional: FC target worldwide names (WWNs)
wwids	Array< string >	wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.

FlexVolumeSource

FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.

Fields

Field Name	Field Type	Description
driver	string	driver is the name of the driver to use for this volume.
fsType	string	fsType is the 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 >	options is Optional: this field holds extra command options if any.
readOnly	boolean	readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretRef	LocalObjectReference	secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.

FlockerVolumeSource

Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.

Fields

Field Name	Field Type	Description
datasetName	string	datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
datasetUUID	string	datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset

GCEPersistentDiskVolumeSource

Represents a Persistent Disk resource in Google Compute Engine. A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.

Fields

Field Name	Field Type	Description
fsType	string	fsType is 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#gcepersistentdisk
partition	integer	partition is 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	pdName is 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

GitRepoVolumeSource

Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.

Fields

Field Name	Field Type	Description
directory	string	directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.
repository	string	repository is the URL
revision	string	revision is the commit hash for the specified revision.

GlusterfsVolumeSource

Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.

Fields

Field Name	Field Type	Description
endpoints	string	endpoints 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

HostPathVolumeSource

Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.

Fields

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 Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

ISCSIVolumeSource

Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.

Fields

Field Name	Field Type	Description
chapAuthDiscovery	boolean	chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
chapAuthSession	boolean	chapAuthSession defines whether support iSCSI Session CHAP authentication
fsType	string	fsType is the 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#iscsi
initiatorName	string	initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection.
iqn	string	iqn is the target iSCSI Qualified Name.
iscsiInterface	string	iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
lun	integer	lun represents iSCSI Target Lun number.
portals	Array< string >	portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is 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	secretRef is the CHAP Secret for iSCSI target and initiator authentication
targetPortal	string	targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).

NFSVolumeSource

Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.

Fields

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 force the 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

PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).

Examples with this field (click to open)

• volumes-existing.yaml

Fields

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	readOnly Will force the ReadOnly setting in VolumeMounts. Default false.

PhotonPersistentDiskVolumeSource

Represents a Photon Controller persistent disk resource.

Fields

Field Name	Field Type	Description
fsType	string	fsType is the 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.
pdID	string	pdID is the ID that identifies Photon Controller persistent disk

PortworxVolumeSource

PortworxVolumeSource represents a Portworx volume resource.

Fields

Field Name	Field Type	Description
fsType	string	fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.
readOnly	boolean	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
volumeID	string	volumeID uniquely identifies a Portworx volume

ProjectedVolumeSource

Represents a projected volume source

Fields

Field Name	Field Type	Description
defaultMode	integer	defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
sources	Array<VolumeProjection>	sources is the list of volume projections

QuobyteVolumeSource

Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.

Fields

Field Name	Field Type	Description
group	string	group to map volume access to Default 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 services specified 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 Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin
user	string	user to map volume access to Defaults to serivceaccount user
volume	string	volume is a string that references an already created Quobyte volume by name.

RBDVolumeSource

Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.

Fields

Field Name	Field Type	Description
fsType	string	fsType is the 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#rbd
image	string	image is 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
monitors	Array< string >	monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
pool	string	pool is 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	secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
user	string	user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

ScaleIOVolumeSource

ScaleIOVolumeSource represents a persistent ScaleIO volume

Fields

Field Name	Field Type	Description
fsType	string	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".
gateway	string	gateway is the host address of the ScaleIO API Gateway.
protectionDomain	string	protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
readOnly	boolean	readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretRef	LocalObjectReference	secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
sslEnabled	boolean	sslEnabled Flag enable/disable SSL communication with Gateway, default false
storageMode	string	storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
storagePool	string	storagePool is the ScaleIO Storage Pool associated with the protection domain.
system	string	system is the name of the storage system as configured in ScaleIO.
volumeName	string	volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.

SecretVolumeSource

Adapts a Secret into a volume. The contents of the target Secret's Data field will be presented in a volume as 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)

• buildkit-template.yaml

• secrets.yaml

Fields

Field Name	Field Type	Description
defaultMode	integer	defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
items	Array<KeyToPath>	items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
optional	boolean	optional field specify whether the Secret or its keys must be defined
secretName	string	secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

StorageOSVolumeSource

Represents a StorageOS persistent volume resource.

Fields

Field Name	Field Type	Description
fsType	string	fsType is the 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	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretRef	LocalObjectReference	secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
volumeName	string	volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
volumeNamespace	string	volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes 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

Represents a vSphere volume resource.

Fields

Field Name	Field Type	Description
fsType	string	fsType is 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	storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
storagePolicyName	string	storagePolicyName is the storage Policy Based Management (SPBM) profile name.
volumePath	string	volumePath is the path that identifies vSphere volume vmdk

LabelSelectorRequirement

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Fields

Field Name	Field Type	Description
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 strategic merge patch.

EnvVarSource

EnvVarSource represents a source for the value of an EnvVar.

Examples with this field (click to open)

• arguments-parameters-from-configmap.yaml

• artifact-path-placeholders.yaml

• conditional-parameters.yaml

• workspace-workflow.yaml

• custom-metrics.yaml

• dag-conditional-parameters.yaml

• exit-handler-with-param.yaml

• expression-tag-template-workflow.yaml

• fibonacci-seq-conditional-param.yaml

• global-outputs.yaml

• global-parameters-from-configmap-referenced-as-local-variable.yaml

• global-parameters-from-configmap.yaml

• handle-large-output-results.yaml

• intermediate-parameters.yaml

• k8s-wait-wf.yaml

• nested-workflow.yaml

• output-parameter.yaml

• parameter-aggregation-dag.yaml

• parameter-aggregation.yaml

• pod-spec-from-previous-step.yaml

• secrets.yaml

• suspend-template-outputs.yaml

• event-consumer-workfloweventbinding.yaml

Fields

Field Name	Field Type	Description
configMapKeyRef	ConfigMapKeySelector	Selects a key of a ConfigMap.
fieldRef	ObjectFieldSelector	Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
resourceFieldRef	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	Selects a key of a secret in the pod's namespace

ConfigMapEnvSource

ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.

Fields

Field Name	Field Type	Description
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional	boolean	Specify whether the ConfigMap must be defined

SecretEnvSource

SecretEnvSource selects a Secret to populate the environment variables with. The contents of the target Secret's Data field will represent the key-value pairs as environment variables.

Fields

Field Name	Field Type	Description
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional	boolean	Specify whether the Secret must be defined

LifecycleHandler

LifecycleHandler defines a specific action that should be taken in a lifecycle hook. One and only one of the fields, except TCPSocket must be specified.

Fields

Field Name	Field Type	Description
exec	ExecAction	Exec specifies the action to take.
httpGet	HTTPGetAction	HTTPGet specifies the http request to perform.
sleep	SleepAction	Sleep represents the duration that the container should sleep before being terminated.
tcpSocket	TCPSocketAction	Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.

ExecAction

ExecAction describes a "run in container" action.

Examples with this field (click to open)

• buildkit-template.yaml

Fields

Field Name	Field Type	Description
command	Array< string >	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('

GRPCAction

No description available

Fields

Field Name	Field Type	Description
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535.
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.

HTTPGetAction

HTTPGetAction describes an action based on HTTP Get requests.

Examples with this field (click to open)

• daemon-nginx.yaml

• daemon-step.yaml

• dag-daemon-task.yaml

• influxdb-ci.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.
httpHeaders	Array<HTTPHeader>	Custom headers to set in the request. HTTP allows repeated headers.
path	string	Path to access on the HTTP server.
port	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.

TCPSocketAction

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.
port	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.

ResourceClaim

ResourceClaim references one entry in PodSpec.ResourceClaims.

Fields

Field Name	Field Type	Description
name	string	Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.

Quantity

Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors. The serialization format is: <quantity> ::= <signedNumber><suffix> (Note that <suffix> may be empty, from the "" case in <decimalSI>.) <digit> ::= 0 | 1 | ... | 9 <digits> ::= <digit> | <digit><digits> <number> ::= <digits> | <digits>.<digits> | <digits>. | .<digits> <sign> ::= "+" | "-" <signedNumber> ::= <number> | <sign><number> <suffix> ::= <binarySI> | <decimalExponent> | <decimalSI> <binarySI> ::= Ki | Mi | Gi | Ti | Pi | Ei (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) <decimalSI> ::= m | "" | k | M | G | T | P | E (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) <decimalExponent> ::= "e" <signedNumber> | "E" <signedNumber> No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: - No precision is lost - No fractional digits will be emitted - The exponent (or suffix) is as large as possible. The sign will be omitted unless the number is negative. Examples: - 1.5 will be serialized as "1500m" - 1.5Gi will be serialized as "1536Mi" Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.

Examples with this field (click to open)

• dns-config.yaml

• pod-spec-patch-wf-tmpl.yaml

• pod-spec-yaml-patch.yaml

Capabilities

Adds and removes POSIX capabilities from running containers.

Fields

Field Name	Field Type	Description
add	Array< string >	Added capabilities
drop	Array< string >	Removed capabilities

FieldsV1

FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format. Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:', where is the name of a field in a struct, or key in a map 'v:', where is the exact json formatted value of a list item 'i:', where is position of a item in a list 'k:', where is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set. The exact format is defined in sigs.k8s.io/structured-merge-diff

PreferredSchedulingTerm

An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).

Fields

Field Name	Field Type	Description
preference	NodeSelectorTerm	A node selector term, associated with the corresponding weight.
weight	integer	Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.

NodeSelector

A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.

Fields

Field Name	Field Type	Description
nodeSelectorTerms	Array<NodeSelectorTerm>	Required. A list of node selector terms. The terms are ORed.

WeightedPodAffinityTerm

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

Fields

Field Name	Field Type	Description
podAffinityTerm	PodAffinityTerm	Required. A pod affinity term, associated with the corresponding weight.
weight	integer	weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

PodAffinityTerm

Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running

Fields

Field Name	Field Type	Description
labelSelector	LabelSelector	A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.
matchLabelKeys	Array< string >	MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with labelSelector as key in (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.
mismatchLabelKeys	Array< string >	MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with labelSelector as key notin (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.
namespaceSelector	LabelSelector	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
namespaces	Array< string >	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.

TypedLocalObjectReference

TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.

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.
kind	string	Kind is the type of resource being referenced
name	string	Name is the name of resource being referenced

TypedObjectReference

No description available

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.
kind	string	Kind is the type of resource being referenced
name	string	Name is the name of resource being referenced
namespace	string	Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

VolumeResourceRequirements

VolumeResourceRequirements describes the storage resource requirements for a volume.

Examples with this field (click to open)

• buildkit-template.yaml

• ci-output-artifact.yaml

• ci-workflowtemplate.yaml

• ci.yaml

• dns-config.yaml

• fun-with-gifs.yaml

• influxdb-ci.yaml

• pod-spec-patch-wf-tmpl.yaml

• pod-spec-yaml-patch.yaml

• volumes-pvc.yaml

• work-avoidance.yaml

Fields

Field Name	Field Type	Description
limits	Quantity	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
requests	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. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

PersistentVolumeClaimCondition

PersistentVolumeClaimCondition contains details about state of pvc

Fields

Field Name	Field Type	Description
lastProbeTime	Time	lastProbeTime is the time we probed the condition.
lastTransitionTime	Time	lastTransitionTime is the time the condition transitioned from one status to another.
message	string	message is the human-readable message indicating details about last transition.
reason	string	reason is a unique, this should be a short, machine understandable string that gives the reason for condition's last transition. If it reports "Resizing" that means the underlying persistent volume is being resized.
status	string	No description available
type	string	No description available

ModifyVolumeStatus

ModifyVolumeStatus represents the status object of ControllerModifyVolume operation

Fields

Field Name	Field Type	Description
status	string	status is the status of the ControllerModifyVolume operation. It can be in any of following states: - Pending Pending indicates that the PersistentVolumeClaim cannot be modified due to unmet requirements, such as the specified VolumeAttributesClass not existing. - InProgress InProgress indicates that the volume is being modified. - Infeasible Infeasible indicates that the request has been rejected as invalid by the CSI driver. To resolve the error, a valid VolumeAttributesClass needs to be specified. Note: New statuses can be added in the future. Consumers should check for unknown statuses and fail appropriately.
targetVolumeAttributesClassName	string	targetVolumeAttributesClassName is the name of the VolumeAttributesClass the PVC currently being reconciled

KeyToPath

Maps a string key to a path within a volume.

Fields

Field Name	Field Type	Description
key	string	key is the key to project.
mode	integer	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
path	string	path is 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

DownwardAPIVolumeFile represents information to create the file containing the pod field

Fields

Field Name	Field Type	Description
fieldRef	ObjectFieldSelector	Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
mode	integer	Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, 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	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

PersistentVolumeClaimTemplate

PersistentVolumeClaimTemplate is used to produce PersistentVolumeClaim objects as part of an EphemeralVolumeSource.

Fields

Field Name	Field Type	Description
metadata	ObjectMeta	May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.
spec	PersistentVolumeClaimSpec	The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.

VolumeProjection

Projection that may be projected along with other supported volume types

Fields

Field Name	Field Type	Description
clusterTrustBundle	ClusterTrustBundleProjection	ClusterTrustBundle allows a pod to access the .spec.trustBundle field of ClusterTrustBundle objects in an auto-updating file. Alpha, gated by the ClusterTrustBundleProjection feature gate. ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector. Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time.
configMap	ConfigMapProjection	configMap information about the configMap data to project
downwardAPI	DownwardAPIProjection	downwardAPI information about the downwardAPI data to project
secret	SecretProjection	secret information about the secret data to project
serviceAccountToken	ServiceAccountTokenProjection	serviceAccountToken is information about the serviceAccountToken data to project

ObjectFieldSelector

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".
fieldPath	string	Path of the field to select in the specified API version.

ResourceFieldSelector

ResourceFieldSelector represents container resources (cpu, memory) and their output format

Fields

Field Name	Field Type	Description
containerName	string	Container name: required for volumes, optional for env vars
divisor	Quantity	Specifies the output format of the exposed resources, defaults to "1"
resource	string	Required: resource to select

SleepAction

SleepAction describes a "sleep" action.

Fields

Field Name	Field Type	Description
seconds	integer	Seconds is the number of seconds to sleep.

HTTPHeader

HTTPHeader describes a custom header to be used in HTTP probes

Fields

Field Name	Field Type	Description
name	string	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
value	string	The header field value

NodeSelectorTerm

A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.

Fields

Field Name	Field Type	Description
matchExpressions	Array<NodeSelectorRequirement>	A list of node selector requirements by node's labels.
matchFields	Array<NodeSelectorRequirement>	A list of node selector requirements by node's fields.

ClusterTrustBundleProjection

ClusterTrustBundleProjection describes how to select a set of ClusterTrustBundle objects and project their contents into the pod filesystem.

Fields

Field Name	Field Type	Description
labelSelector	LabelSelector	Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as "match nothing". If set but empty, interpreted as "match everything".
name	string	Select a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector.
optional	boolean	If true, don't block pod startup if the referenced ClusterTrustBundle(s) aren't available. If using name, then the named ClusterTrustBundle is allowed not to exist. If using signerName, then the combination of signerName and labelSelector is allowed to match zero ClusterTrustBundles.
path	string	Relative path from the volume root to write the bundle.
signerName	string	Select all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated.

ConfigMapProjection

Adapts a ConfigMap into a projected volume. The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode.

Examples with this field (click to open)

• fibonacci-seq-conditional-param.yaml

Fields

Field Name	Field Type	Description
items	Array<KeyToPath>	items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional	boolean	optional specify whether the ConfigMap or its keys must be defined

DownwardAPIProjection

Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode.

Fields

Field Name	Field Type	Description
items	Array<DownwardAPIVolumeFile>	Items is a list of DownwardAPIVolume file

SecretProjection

Adapts a secret into a projected volume. The contents of the target Secret's Data field will be presented in a projected 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 default mode.

Examples with this field (click to open)

• buildkit-template.yaml

• secrets.yaml

Fields

Field Name	Field Type	Description
items	Array<KeyToPath>	items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional	boolean	optional field specify whether the Secret or its key must be defined

ServiceAccountTokenProjection

ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise).

Fields

Field Name	Field Type	Description
audience	string	audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.
expirationSeconds	integer	expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.
path	string	path is the path relative to the mount point of the file to project the token into.

NodeSelectorRequirement

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Fields

Field Name	Field Type	Description
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 values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

---

Have a question?

Search on GitHub Discussions and Slack.