Skip to content

The API for an executor plugin.

Informations

Version

0.0.1

Content negotiation

URI Schemes

  • http

Consumes

  • application/json

Produces

  • application/json

All endpoints

operations

Method URI Name Summary
POST /api/v1/template.execute execute template

Paths

execute template (executeTemplate)

POST /api/v1/template.execute

Parameters

Name Source Type Go type Separator Required Default Description
Body body ExecuteTemplateArgs models.ExecuteTemplateArgs

All responses

Code Status Description Has headers Schema
200 OK schema

Responses

200

Status: OK

Schema

ExecuteTemplateReply

Models

AWSElasticBlockStoreVolumeSource

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.

Properties

Name Type Go type Required Default Description Example
fsType string 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
TODO: how do we prevent errors in the filesystem from compromising the machine
+optional
partition int32 (formatted integer) int32 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).
+optional
readOnly boolean bool readOnly value true will force the readOnly setting in VolumeMounts.
More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+optional
volumeID string 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

Affinity

Properties

Name Type Go type Required Default Description Example
nodeAffinity NodeAffinity NodeAffinity
podAffinity PodAffinity PodAffinity
podAntiAffinity PodAntiAffinity PodAntiAffinity

Amount

+kubebuilder:validation:Type=number

interface{}

AnyString

It will unmarshall int64, int32, float64, float32, boolean, a plain string and represents it as string. It will marshall back to string - marshalling is not symmetric.

Name Type Go type Default Description Example
AnyString string string It will unmarshall int64, int32, float64, float32, boolean, a plain string and represents it as string.
It will marshall back to string - marshalling is not symmetric.

ArchiveStrategy

ArchiveStrategy describes how to archive files/directory when saving artifacts

Properties

Name Type Go type Required Default Description Example
none NoneStrategy NoneStrategy
tar TarStrategy TarStrategy
zip ZipStrategy ZipStrategy

Arguments

Arguments to a template

Properties

Name Type Go type Required Default Description Example
artifacts Artifacts Artifacts
parameters []Parameter []*Parameter Parameters is the list of parameters to pass to the template or workflow
+patchStrategy=merge
+patchMergeKey=name

Artifact

Artifact indicates an artifact to place at a specified path

Properties

Name Type Go type Required Default Description Example
archive ArchiveStrategy ArchiveStrategy
archiveLogs boolean bool ArchiveLogs indicates if the container logs should be archived
artifactGC ArtifactGC ArtifactGC
artifactory ArtifactoryArtifact ArtifactoryArtifact
azure AzureArtifact AzureArtifact
deleted boolean bool Has this been deleted?
from string string From allows an artifact to reference an artifact from a previous step
fromExpression string string FromExpression, if defined, is evaluated to specify the value for the artifact
gcs GCSArtifact GCSArtifact
git GitArtifact GitArtifact
globalName string string GlobalName exports an output artifact to the global scope, making it available as
'{{workflow.outputs.artifacts.XXXX}} and in workflow.status.outputs.artifacts
hdfs HDFSArtifact HDFSArtifact
http HTTPArtifact HTTPArtifact
mode int32 (formatted integer) int32 mode bits to use on this file, must be a value between 0 and 0777
set when loading input artifacts.
name string string name of the artifact. must be unique within a template's inputs/outputs.
optional boolean bool Make Artifacts optional, if Artifacts doesn't generate or exist
oss OSSArtifact OSSArtifact
path string string Path is the container path to the artifact
raw RawArtifact RawArtifact
recurseMode boolean bool If mode is set, apply the permission recursively into the artifact if it is a folder
s3 S3Artifact S3Artifact
subPath string string SubPath allows an artifact to be sourced from a subpath within the specified source

ArtifactGC

ArtifactGC describes how to delete artifacts from completed Workflows

Properties

Name Type Go type Required Default Description Example
podMetadata Metadata Metadata
serviceAccountName string string ServiceAccountName is an optional field for specifying the Service Account that should be assigned to the Pod doing the deletion
strategy ArtifactGCStrategy ArtifactGCStrategy

ArtifactGCStrategy

Name Type Go type Default Description Example
ArtifactGCStrategy string string

ArtifactLocation

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.

Properties

Name Type Go type Required Default Description Example
archiveLogs boolean bool ArchiveLogs indicates if the container logs should be archived
artifactory ArtifactoryArtifact ArtifactoryArtifact
azure AzureArtifact AzureArtifact
gcs GCSArtifact GCSArtifact
git GitArtifact GitArtifact
hdfs HDFSArtifact HDFSArtifact
http HTTPArtifact HTTPArtifact
oss OSSArtifact OSSArtifact
raw RawArtifact RawArtifact
s3 S3Artifact S3Artifact

ArtifactPaths

ArtifactPaths expands a step from a collection of artifacts

Properties

Name Type Go type Required Default Description Example
archive ArchiveStrategy ArchiveStrategy
archiveLogs boolean bool ArchiveLogs indicates if the container logs should be archived
artifactGC ArtifactGC ArtifactGC
artifactory ArtifactoryArtifact ArtifactoryArtifact
azure AzureArtifact AzureArtifact
deleted boolean bool Has this been deleted?
from string string From allows an artifact to reference an artifact from a previous step
fromExpression string string FromExpression, if defined, is evaluated to specify the value for the artifact
gcs GCSArtifact GCSArtifact
git GitArtifact GitArtifact
globalName string string GlobalName exports an output artifact to the global scope, making it available as
'{{workflow.outputs.artifacts.XXXX}} and in workflow.status.outputs.artifacts
hdfs HDFSArtifact HDFSArtifact
http HTTPArtifact HTTPArtifact
mode int32 (formatted integer) int32 mode bits to use on this file, must be a value between 0 and 0777
set when loading input artifacts.
name string string name of the artifact. must be unique within a template's inputs/outputs.
optional boolean bool Make Artifacts optional, if Artifacts doesn't generate or exist
oss OSSArtifact OSSArtifact
path string string Path is the container path to the artifact
raw RawArtifact RawArtifact
recurseMode boolean bool If mode is set, apply the permission recursively into the artifact if it is a folder
s3 S3Artifact S3Artifact
subPath string string SubPath allows an artifact to be sourced from a subpath within the specified source

ArtifactoryArtifact

ArtifactoryArtifact is the location of an artifactory artifact

Properties

Name Type Go type Required Default Description Example
passwordSecret SecretKeySelector SecretKeySelector
url string string URL of the artifact
usernameSecret SecretKeySelector SecretKeySelector

Artifacts

[]Artifact

AzureArtifact

AzureArtifact is the location of a an Azure Storage artifact

Properties

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

AzureDataDiskCachingMode

+enum

Name Type Go type Default Description Example
AzureDataDiskCachingMode string string +enum

AzureDataDiskKind

+enum

Name Type Go type Default Description Example
AzureDataDiskKind string string +enum

AzureDiskVolumeSource

Properties

Name Type Go type Required Default Description Example
cachingMode AzureDataDiskCachingMode AzureDataDiskCachingMode
diskName string string diskName is the Name of the data disk in the blob storage
diskURI string string diskURI is the URI of data disk in the blob storage
fsType string 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.
+optional
kind AzureDataDiskKind AzureDataDiskKind
readOnly boolean bool readOnly Defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
+optional

AzureFileVolumeSource

Properties

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

Backoff

Backoff is a backoff strategy to use within retryStrategy

Properties

Name Type Go type Required Default Description Example
duration string string Duration is the amount to back off. Default unit is seconds, but could also be a duration (e.g. "2m", "1h")
factor IntOrString IntOrString
maxDuration string string MaxDuration is the maximum amount of time allowed for the backoff strategy

BasicAuth

BasicAuth describes the secret selectors required for basic authentication

Properties

Name Type Go type Required Default Description Example
passwordSecret SecretKeySelector SecretKeySelector
usernameSecret SecretKeySelector SecretKeySelector

CSIVolumeSource

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

Properties

Name Type Go type Required Default Description Example
driver string 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 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.
+optional
nodePublishSecretRef LocalObjectReference LocalObjectReference
readOnly boolean bool readOnly specifies a read-only configuration for the volume.
Defaults to false (read/write).
+optional
volumeAttributes map of string map[string]string volumeAttributes stores driver-specific properties that are passed to the CSI
driver. Consult your driver's documentation for supported values.
+optional

Cache

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

Properties

Name Type Go type Required Default Description Example
configMap ConfigMapKeySelector ConfigMapKeySelector

Capabilities

Properties

Name Type Go type Required Default Description Example
add []Capability []Capability Added capabilities
+optional
drop []Capability []Capability Removed capabilities
+optional

Capability

Capability represent POSIX capabilities type

Name Type Go type Default Description Example
Capability string string Capability represent POSIX capabilities type

CephFSVolumeSource

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

Properties

Name Type Go type Required Default Description Example
monitors []string []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 string path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /
+optional
readOnly boolean bool 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
+optional
secretFile string 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
+optional
secretRef LocalObjectReference LocalObjectReference
user string 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
+optional

CinderVolumeSource

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.

Properties

Name Type Go type Required Default Description Example
fsType string 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
+optional
readOnly boolean bool 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
+optional
secretRef LocalObjectReference LocalObjectReference
volumeID string string volumeID used to identify the volume in cinder.
More info: https://examples.k8s.io/mysql-cinder-pd/README.md

ClientCertAuth

ClientCertAuth holds necessary information for client authentication via certificates

Properties

Name Type Go type Required Default Description Example
clientCertSecret SecretKeySelector SecretKeySelector
clientKeySecret SecretKeySelector SecretKeySelector

ConfigMapEnvSource

The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.

Properties

Name Type Go type Required Default Description Example
name string string Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
+optional
optional boolean bool Specify whether the ConfigMap must be defined
+optional

ConfigMapKeySelector

+structType=atomic

Properties

Name Type Go type Required Default Description Example
key string string The key to select.
name string string Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
+optional
optional boolean bool Specify whether the ConfigMap or its key must be defined
+optional

ConfigMapProjection

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.

Properties

Name Type Go type Required Default Description Example
items []KeyToPath []*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 '..'.
+optional
name string string Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
+optional
optional boolean bool optional specify whether the ConfigMap or its keys must be defined
+optional

ConfigMapVolumeSource

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.

Properties

Name Type Go type Required Default Description Example
defaultMode int32 (formatted integer) int32 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.
+optional
items []KeyToPath []*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 '..'.
+optional
name string string Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
+optional
optional boolean bool optional specify whether the ConfigMap or its keys must be defined
+optional

Container

Properties

Name Type Go type Required Default Description Example
args []string []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
+optional
command []string []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
+optional
env []EnvVar []*EnvVar List of environment variables to set in the container.
Cannot be updated.
+optional
+patchMergeKey=name
+patchStrategy=merge
envFrom []EnvFromSource []*EnvFromSource List of sources to populate environment variables in the container.
The keys defined within a source must be a C_IDENTIFIER. All invalid 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.
+optional
image string 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.
+optional
imagePullPolicy PullPolicy PullPolicy
lifecycle Lifecycle Lifecycle
livenessProbe Probe Probe
name string 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 []ContainerPort []*ContainerPort List of ports to expose from the container. Exposing a port here gives
the system additional information about the network connections a
container uses, but is primarily informational. 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.
Cannot be updated.
+optional
+patchMergeKey=containerPort
+patchStrategy=merge
+listType=map
+listMapKey=containerPort
+listMapKey=protocol
readinessProbe Probe Probe
resources ResourceRequirements ResourceRequirements
securityContext SecurityContext SecurityContext
startupProbe Probe Probe
stdin boolean bool 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.
+optional
stdinOnce boolean bool 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
+optional
terminationMessagePath string 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.
+optional
terminationMessagePolicy TerminationMessagePolicy TerminationMessagePolicy
tty boolean bool Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
Default is false.
+optional
volumeDevices []VolumeDevice []*VolumeDevice volumeDevices is the list of block devices to be used by the container.
+patchMergeKey=devicePath
+patchStrategy=merge
+optional
volumeMounts []VolumeMount []*VolumeMount Pod volumes to mount into the container's filesystem.
Cannot be updated.
+optional
+patchMergeKey=mountPath
+patchStrategy=merge
workingDir string 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.
+optional

ContainerNode

Properties

Name Type Go type Required Default Description Example
args []string []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
+optional
command []string []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
+optional
dependencies []string []string
env []EnvVar []*EnvVar List of environment variables to set in the container.
Cannot be updated.
+optional
+patchMergeKey=name
+patchStrategy=merge
envFrom []EnvFromSource []*EnvFromSource List of sources to populate environment variables in the container.
The keys defined within a source must be a C_IDENTIFIER. All invalid 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.
+optional
image string 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.
+optional
imagePullPolicy PullPolicy PullPolicy
lifecycle Lifecycle Lifecycle
livenessProbe Probe Probe
name string 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 []ContainerPort []*ContainerPort List of ports to expose from the container. Exposing a port here gives
the system additional information about the network connections a
container uses, but is primarily informational. 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.
Cannot be updated.
+optional
+patchMergeKey=containerPort
+patchStrategy=merge
+listType=map
+listMapKey=containerPort
+listMapKey=protocol
readinessProbe Probe Probe
resources ResourceRequirements ResourceRequirements
securityContext SecurityContext SecurityContext
startupProbe Probe Probe
stdin boolean bool 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.
+optional
stdinOnce boolean bool 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
+optional
terminationMessagePath string 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.
+optional
terminationMessagePolicy TerminationMessagePolicy TerminationMessagePolicy
tty boolean bool Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
Default is false.
+optional
volumeDevices []VolumeDevice []*VolumeDevice volumeDevices is the list of block devices to be used by the container.
+patchMergeKey=devicePath
+patchStrategy=merge
+optional
volumeMounts []VolumeMount []*VolumeMount Pod volumes to mount into the container's filesystem.
Cannot be updated.
+optional
+patchMergeKey=mountPath
+patchStrategy=merge
workingDir string 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.
+optional

ContainerPort

Properties

Name Type Go type Required Default Description Example
containerPort int32 (formatted integer) int32 Number of port to expose on the pod's IP address.
This must be a valid port number, 0 < x < 65536.
hostIP string string What host IP to bind the external port to.
+optional
hostPort int32 (formatted integer) int32 Number of port to expose on the host.
If specified, this must be a valid port number, 0 < x < 65536.
If HostNetwork is specified, this must match ContainerPort.
Most containers do not need this.
+optional
name string 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.
+optional
protocol Protocol Protocol

ContainerSetRetryStrategy

Properties

Name Type Go type Required Default Description Example
duration string 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 IntOrString

ContainerSetTemplate

Properties

Name Type Go type Required Default Description Example
containers []ContainerNode []*ContainerNode
retryStrategy ContainerSetRetryStrategy ContainerSetRetryStrategy
volumeMounts []VolumeMount []*VolumeMount

ContinueOn

It can be specified if the workflow should continue when the pod errors, fails or both.

Properties

Name Type Go type Required Default Description Example
error boolean bool +optional
failed boolean bool +optional

Counter

Counter is a Counter prometheus metric

Properties

Name Type Go type Required Default Description Example
value string string Value is the value of the metric

CreateS3BucketOptions

CreateS3BucketOptions options used to determine automatic automatic bucket-creation process

Properties

Name Type Go type Required Default Description Example
objectLocking boolean bool ObjectLocking Enable object locking

DAGTask

DAGTask represents a node in the graph during DAG execution

Properties

Name Type Go type Required Default Description Example
arguments Arguments Arguments
continueOn ContinueOn ContinueOn
dependencies []string []string Dependencies are name of other targets which this depends on
depends string string Depends are name of other targets which this depends on
hooks LifecycleHooks LifecycleHooks
inline Template Template
name string string Name is the name of the target
onExit string 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 string Name of template to execute
templateRef TemplateRef TemplateRef
when string string When is an expression in which the task should conditionally execute
withItems []Item []Item WithItems expands a task into multiple parallel tasks from the items in the list
withParam string 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 Sequence

DAGTemplate

DAGTemplate is a template subtype for directed acyclic graph templates

Properties

Name Type Go type Required Default Description Example
failFast boolean bool 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 string Target are one or more names of targets to execute in a DAG
tasks []DAGTask []*DAGTask Tasks are a list of DAG tasks
+patchStrategy=merge
+patchMergeKey=name

Data

Data is a data template

Properties

Name Type Go type Required Default Description Example
source DataSource DataSource
transformation Transformation Transformation

DataSource

DataSource sources external data into a data template

Properties

Name Type Go type Required Default Description Example
artifactPaths ArtifactPaths ArtifactPaths

DownwardAPIProjection

Note that this is identical to a downwardAPI volume source without the default mode.

Properties

Name Type Go type Required Default Description Example
items []DownwardAPIVolumeFile []*DownwardAPIVolumeFile Items is a list of DownwardAPIVolume file
+optional

DownwardAPIVolumeFile

DownwardAPIVolumeFile represents information to create the file containing the pod field

Properties

Name Type Go type Required Default Description Example
fieldRef ObjectFieldSelector ObjectFieldSelector
mode int32 (formatted integer) int32 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.
+optional
path string string Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'
resourceFieldRef ResourceFieldSelector ResourceFieldSelector

DownwardAPIVolumeSource

Downward API volumes support ownership management and SELinux relabeling.

Properties

Name Type Go type Required Default Description Example
defaultMode int32 (formatted integer) int32 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.
+optional
items []DownwardAPIVolumeFile []*DownwardAPIVolumeFile Items is a list of downward API volume file
+optional

Duration

Duration is a wrapper around time.Duration which supports correct marshaling to YAML and JSON. In particular, it marshals into strings, which can be used as map keys in json.

interface{}

EmptyDirVolumeSource

Empty directory volumes support ownership management and SELinux relabeling.

Properties

Name Type Go type Required Default Description Example
medium StorageMedium StorageMedium
sizeLimit Quantity Quantity

EnvFromSource

EnvFromSource represents the source of a set of ConfigMaps

Properties

Name Type Go type Required Default Description Example
configMapRef ConfigMapEnvSource ConfigMapEnvSource
prefix string string An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
+optional
secretRef SecretEnvSource SecretEnvSource

EnvVar

Properties

Name Type Go type Required Default Description Example
name string string Name of the environment variable. Must be a C_IDENTIFIER.
value string 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 "".
+optional
valueFrom EnvVarSource EnvVarSource

EnvVarSource

Properties

Name Type Go type Required Default Description Example
configMapKeyRef ConfigMapKeySelector ConfigMapKeySelector
fieldRef ObjectFieldSelector ObjectFieldSelector
resourceFieldRef ResourceFieldSelector ResourceFieldSelector
secretKeyRef SecretKeySelector SecretKeySelector

EphemeralVolumeSource

Properties

Name Type Go type Required Default Description Example
volumeClaimTemplate PersistentVolumeClaimTemplate PersistentVolumeClaimTemplate

ExecAction

Properties

Name Type Go type Required Default Description Example
command []string []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 (' ', etc) won't work. To use
a shell, you need to explicitly call out to that shell.
Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+optional

ExecuteTemplateArgs

Properties

Name Type Go type Required Default Description Example
template Template Template
workflow Workflow Workflow

ExecuteTemplateReply

Properties

Name Type Go type Required Default Description Example
node NodeResult NodeResult
requeue Duration Duration

ExecutorConfig

Properties

Name Type Go type Required Default Description Example
serviceAccountName string string ServiceAccountName specifies the service account name of the executor container.

FCVolumeSource

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

Properties

Name Type Go type Required Default Description Example
fsType string 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.
TODO: how do we prevent errors in the filesystem from compromising the machine
+optional
lun int32 (formatted integer) int32 lun is Optional: FC target lun number
+optional
readOnly boolean bool readOnly is Optional: Defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
+optional
targetWWNs []string []string targetWWNs is Optional: FC target worldwide names (WWNs)
+optional
wwids []string []string wwids Optional: FC volume world wide identifiers (wwids)
Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
+optional

FieldsV1

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 +protobuf.options.(gogoproto.goproto_stringer)=false

interface{}

FlexVolumeSource

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

Properties

Name Type Go type Required Default Description Example
driver string string driver is the name of the driver to use for this volume.
fsType string 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.
+optional
options map of string map[string]string options is Optional: this field holds extra command options if any.
+optional
readOnly boolean bool readOnly is Optional: defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
+optional
secretRef LocalObjectReference LocalObjectReference

FlockerVolumeSource

One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.

Properties

Name Type Go type Required Default Description Example
datasetName string string datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker
should be considered as deprecated
+optional
datasetUUID string string datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset
+optional

GCEPersistentDiskVolumeSource

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.

Properties

Name Type Go type Required Default Description Example
fsType string 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
TODO: how do we prevent errors in the filesystem from compromising the machine
+optional
partition int32 (formatted integer) int32 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
+optional
pdName string 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 bool readOnly here will force the ReadOnly setting in VolumeMounts.
Defaults to false.
More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+optional

GCSArtifact

GCSArtifact is the location of a GCS artifact

Properties

Name Type Go type Required Default Description Example
bucket string string Bucket is the name of the bucket
key string string Key is the path in the bucket where the artifact resides
serviceAccountKeySecret SecretKeySelector SecretKeySelector

GRPCAction

Properties

Name Type Go type Required Default Description Example
port int32 (formatted integer) int32 Port number of the gRPC service. Number must be in the range 1 to 65535.
service string 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. +optional +default="" | |

Gauge

Gauge is a Gauge prometheus metric

Properties

Name Type Go type Required Default Description Example
realtime boolean bool Realtime emits this metric in real time if applicable
value string string Value is the value of the metric

GitArtifact

GitArtifact is the location of an git artifact

Properties

Name Type Go type Required Default Description Example
branch string string Branch is the branch to fetch when SingleBranch is enabled
depth uint64 (formatted integer) uint64 Depth specifies clones/fetches should be shallow and include the given
number of commits from the branch tip
disableSubmodules boolean bool DisableSubmodules disables submodules during git clone
fetch []string []string Fetch specifies a number of refs that should be fetched before checkout
insecureIgnoreHostKey boolean bool InsecureIgnoreHostKey disables SSH strict host key checking during git clone
passwordSecret SecretKeySelector SecretKeySelector
repo string string Repo is the git repository
revision string string Revision is the git commit, tag, branch to checkout
singleBranch boolean bool SingleBranch enables single branch clone, using the branch parameter
sshPrivateKeySecret SecretKeySelector SecretKeySelector
usernameSecret SecretKeySelector SecretKeySelector

GitRepoVolumeSource

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.

Properties

Name Type Go type Required Default Description Example
directory string 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.
+optional
repository string string repository is the URL
revision string string revision is the commit hash for the specified revision.
+optional

GlusterfsVolumeSource

Glusterfs volumes do not support ownership management or SELinux relabeling.

Properties

Name Type Go type Required Default Description Example
endpoints string 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 string path is the Glusterfs volume path.
More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
readOnly boolean bool readOnly here will force the Glusterfs volume to be mounted with read-only permissions.
Defaults to false.
More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
+optional

HDFSArtifact

HDFSArtifact is the location of an HDFS artifact

Properties

Name Type Go type Required Default Description Example
addresses []string []string Addresses is accessible addresses of HDFS name nodes
force boolean bool Force copies a file forcibly even if it exists
hdfsUser string string HDFSUser is the user to access HDFS file system.
It is ignored if either ccache or keytab is used.
krbCCacheSecret SecretKeySelector SecretKeySelector
krbConfigConfigMap ConfigMapKeySelector ConfigMapKeySelector
krbKeytabSecret SecretKeySelector SecretKeySelector
krbRealm string string KrbRealm is the Kerberos realm used with Kerberos keytab
It must be set if keytab is used.
krbServicePrincipalName string string KrbServicePrincipalName is the principal name of Kerberos service
It must be set if either ccache or keytab is used.
krbUsername string string KrbUsername is the Kerberos username used with Kerberos keytab
It must be set if keytab is used.
path string string Path is a file path in HDFS

HTTP

Properties

Name Type Go type Required Default Description Example
body string string Body is content of the HTTP Request
bodyFrom HTTPBodySource HTTPBodySource
headers HTTPHeaders HTTPHeaders
insecureSkipVerify boolean bool InsecureSkipVerify is a bool when if set to true will skip TLS verification for the HTTP client
method string string Method is HTTP methods for HTTP Request
successCondition string string SuccessCondition is an expression if evaluated to true is considered successful
timeoutSeconds int64 (formatted integer) int64 TimeoutSeconds is request timeout for HTTP Request. Default is 30 seconds
url string string URL of the HTTP Request

HTTPArtifact

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

Properties

Name Type Go type Required Default Description Example
auth HTTPAuth HTTPAuth
headers []Header []*Header Headers are an optional list of headers to send with HTTP requests for artifacts
url string string URL of the artifact

HTTPAuth

Properties

Name Type Go type Required Default Description Example
basicAuth BasicAuth BasicAuth
clientCert ClientCertAuth ClientCertAuth
oauth2 OAuth2Auth OAuth2Auth

HTTPBodySource

Properties

Name Type Go type Required Default Description Example
bytes []uint8 (formatted integer) []uint8

HTTPGetAction

Properties

Name Type Go type Required Default Description Example
host string string Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead.
+optional
httpHeaders []HTTPHeader []*HTTPHeader Custom headers to set in the request. HTTP allows repeated headers.
+optional
path string string Path to access on the HTTP server.
+optional
port IntOrString IntOrString
scheme URIScheme URIScheme

HTTPHeader

Properties

Name Type Go type Required Default Description Example
name string string
value string string
valueFrom HTTPHeaderSource HTTPHeaderSource

HTTPHeaderSource

Properties

Name Type Go type Required Default Description Example
secretKeyRef SecretKeySelector SecretKeySelector

HTTPHeaders

[]HTTPHeader

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

Properties

Name Type Go type Required Default Description Example
name string string Name is the header name
value string string Value is the literal value to use for the header

Histogram

Histogram is a Histogram prometheus metric

Properties

Name Type Go type Required Default Description Example
buckets []Amount []Amount Buckets is a list of bucket divisors for the histogram
value string string Value is the value of the metric

HostAlias

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

Properties

Name Type Go type Required Default Description Example
hostnames []string []string Hostnames for the above IP address.
ip string string IP address of the host file entry.

HostPathType

+enum

Name Type Go type Default Description Example
HostPathType string string +enum

HostPathVolumeSource

Host path volumes do not support ownership management or SELinux relabeling.

Properties

Name Type Go type Required Default Description Example
path string 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 HostPathType HostPathType

ISCSIVolumeSource

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

Properties

Name Type Go type Required Default Description Example
chapAuthDiscovery boolean bool chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
+optional
chapAuthSession boolean bool chapAuthSession defines whether support iSCSI Session CHAP authentication
+optional
fsType string 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
TODO: how do we prevent errors in the filesystem from compromising the machine
+optional
initiatorName string string initiatorName is the custom iSCSI Initiator Name.
If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface
: will be created for the connection.
+optional
iqn string string iqn is the target iSCSI Qualified Name.
iscsiInterface string string iscsiInterface is the interface Name that uses an iSCSI transport.
Defaults to 'default' (tcp).
+optional
lun int32 (formatted integer) int32 lun represents iSCSI Target Lun number.
portals []string []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).
+optional
readOnly boolean bool readOnly here will force the ReadOnly setting in VolumeMounts.
Defaults to false.
+optional
secretRef LocalObjectReference LocalObjectReference
targetPortal string 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).

Inputs

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

Properties

Name Type Go type Required Default Description Example
artifacts Artifacts Artifacts
parameters []Parameter []*Parameter Parameters are a list of parameters passed as inputs
+patchStrategy=merge
+patchMergeKey=name

IntOrString

+protobuf=true +protobuf.options.(gogoproto.goproto_stringer)=false +k8s:openapi-gen=true

Properties

Name Type Go type Required Default Description Example
IntVal int32 (formatted integer) int32
StrVal string string
Type Type Type

Item

+protobuf.options.(gogoproto.goproto_stringer)=false +kubebuilder:validation:Type=object

interface{}

KeyToPath

Properties

Name Type Go type Required Default Description Example
key string string key is the key to project.
mode int32 (formatted integer) int32 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.
+optional
path string 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 '..'.

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. +structType=atomic

Properties

Name Type Go type Required Default Description Example
matchExpressions []LabelSelectorRequirement []*LabelSelectorRequirement matchExpressions is a list of label selector requirements. The requirements are ANDed.
+optional
matchLabels map of string 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.
+optional

LabelSelectorOperator

Name Type Go type Default Description Example
LabelSelectorOperator string string

LabelSelectorRequirement

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

Properties

Name Type Go type Required Default Description Example
key string string key is the label key that the selector applies to.
+patchMergeKey=key
+patchStrategy=merge
operator LabelSelectorOperator LabelSelectorOperator
values []string []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.
+optional

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.

Properties

Name Type Go type Required Default Description Example
postStart LifecycleHandler LifecycleHandler
preStop LifecycleHandler LifecycleHandler

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.

Properties

Name Type Go type Required Default Description Example
exec ExecAction ExecAction
httpGet HTTPGetAction HTTPGetAction
tcpSocket TCPSocketAction TCPSocketAction

LifecycleHook

Properties

Name Type Go type Required Default Description Example
arguments Arguments Arguments
expression string 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 string Template is the name of the template to execute by the hook
templateRef TemplateRef TemplateRef

LifecycleHooks

LifecycleHooks

LocalObjectReference

LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. +structType=atomic

Properties

Name Type Go type Required Default Description Example
name string string Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
+optional

ManagedFieldsEntry

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

Properties

Name Type Go type Required Default Description Example
apiVersion string 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 string FieldsType is the discriminator for the different fields format and version.
There is currently only one possible value: "FieldsV1"
fieldsV1 FieldsV1 FieldsV1
manager string string Manager is an identifier of the workflow managing these fields.
operation ManagedFieldsOperationType ManagedFieldsOperationType
subresource string 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

ManagedFieldsOperationType

Name Type Go type Default Description Example
ManagedFieldsOperationType string string

ManifestFrom

Properties

Name Type Go type Required Default Description Example
artifact Artifact Artifact

Memoize

Memoization enables caching for the Outputs of the template

Properties

Name Type Go type Required Default Description Example
cache Cache Cache
key string string Key is the key to use as the caching key
maxAge string 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.

Metadata

Pod metdata

Properties

Name Type Go type Required Default Description Example
annotations map of string map[string]string
labels map of string map[string]string

MetricLabel

MetricLabel is a single label for a prometheus metric

Properties

Name Type Go type Required Default Description Example
key string string
value string string

Metrics

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

Properties

Name Type Go type Required Default Description Example
prometheus []Prometheus []*Prometheus Prometheus is a list of prometheus metrics to be emitted

MountPropagationMode

+enum

Name Type Go type Default Description Example
MountPropagationMode string string +enum

Mutex

Mutex holds Mutex configuration

Properties

Name Type Go type Required Default Description Example
name string string name of the mutex

NFSVolumeSource

NFS volumes do not support ownership management or SELinux relabeling.

Properties

Name Type Go type Required Default Description Example
path string string path that is exported by the NFS server.
More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
readOnly boolean bool 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
+optional
server string string server is the hostname or IP address of the NFS server.
More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

NodeAffinity

Properties

Name Type Go type Required Default Description Example
preferredDuringSchedulingIgnoredDuringExecution []PreferredSchedulingTerm []*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.
+optional
requiredDuringSchedulingIgnoredDuringExecution NodeSelector NodeSelector

NodePhase

Name Type Go type Default Description Example
NodePhase string string

NodeResult

Properties

Name Type Go type Required Default Description Example
message string string
outputs Outputs Outputs
phase NodePhase NodePhase
progress Progress Progress

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. +structType=atomic

Properties

Name Type Go type Required Default Description Example
nodeSelectorTerms []NodeSelectorTerm []*NodeSelectorTerm Required. A list of node selector terms. The terms are ORed.

NodeSelectorOperator

A node selector operator is the set of operators that can be used in a node selector requirement. +enum

Name Type Go type Default Description Example
NodeSelectorOperator string string A node selector operator is the set of operators that can be used in
a node selector requirement.
+enum

NodeSelectorRequirement

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

Properties

Name Type Go type Required Default Description Example
key string string The label key that the selector applies to.
operator NodeSelectorOperator NodeSelectorOperator
values []string []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.
+optional

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. +structType=atomic

Properties

Name Type Go type Required Default Description Example
matchExpressions []NodeSelectorRequirement []*NodeSelectorRequirement A list of node selector requirements by node's labels.
+optional
matchFields []NodeSelectorRequirement []*NodeSelectorRequirement A list of node selector requirements by node's fields.
+optional

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.

interface{}

OAuth2Auth

OAuth2Auth holds all information for client authentication via OAuth2 tokens

Properties

Name Type Go type Required Default Description Example
clientIDSecret SecretKeySelector SecretKeySelector
clientSecretSecret SecretKeySelector SecretKeySelector
endpointParams []OAuth2EndpointParam []*OAuth2EndpointParam
scopes []string []string
tokenURLSecret SecretKeySelector SecretKeySelector

OAuth2EndpointParam

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

Properties

Name Type Go type Required Default Description Example
key string string Name is the header name
value string string Value is the literal value to use for the header

OSSArtifact

OSSArtifact is the location of an Alibaba Cloud OSS artifact

Properties

Name Type Go type Required Default Description Example
accessKeySecret SecretKeySelector SecretKeySelector
bucket string string Bucket is the name of the bucket
createBucketIfNotPresent boolean bool CreateBucketIfNotPresent tells the driver to attempt to create the OSS bucket for output artifacts, if it doesn't exist
endpoint string string Endpoint is the hostname of the bucket endpoint
key string string Key is the path in the bucket where the artifact resides
lifecycleRule OSSLifecycleRule OSSLifecycleRule
secretKeySecret SecretKeySelector SecretKeySelector
securityToken string string SecurityToken is the user's temporary security token. For more details, check out: https://www.alibabacloud.com/help/doc-detail/100624.htm

OSSLifecycleRule

OSSLifecycleRule specifies how to manage bucket's lifecycle

Properties

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

ObjectFieldSelector

+structType=atomic

Properties

Name Type Go type Required Default Description Example
apiVersion string string Version of the schema the FieldPath is written in terms of, defaults to "v1".
+optional
fieldPath string string Path of the field to select in the specified API version.

ObjectMeta

Properties

Name Type Go type Required Default Description Example
name string string

Outputs

Outputs hold parameters, artifacts, and results from a step

Properties

Name Type Go type Required Default Description Example
artifacts Artifacts Artifacts
exitCode string string ExitCode holds the exit code of a script template
parameters []Parameter []*Parameter Parameters holds the list of output parameters produced by a step
+patchStrategy=merge
+patchMergeKey=name
result string string Result holds the result (stdout) of a script template

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. +structType=atomic

Properties

Name Type Go type Required Default Description Example
apiVersion string string API version of the referent.
blockOwnerDeletion boolean bool 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.
+optional
controller boolean bool If true, this reference points to the managing controller.
+optional
kind string string Kind of the referent.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
name string string Name of the referent.
More info: http://kubernetes.io/docs/user-guide/identifiers#names
uid UID UID

ParallelSteps

+kubebuilder:validation:Type=array

interface{}

Parameter

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

Properties

Name Type Go type Required Default Description Example
default AnyString AnyString
description AnyString AnyString
enum []AnyString []AnyString Enum holds a list of string values to choose from, for the actual value of the parameter
globalName string string GlobalName exports an output parameter to the global scope, making it available as
'{{workflow.outputs.parameters.XXXX}} and in workflow.status.outputs.parameters
name string string Name is the parameter name
value AnyString AnyString
valueFrom ValueFrom ValueFrom

PersistentVolumeAccessMode

+enum

Name Type Go type Default Description Example
PersistentVolumeAccessMode string string +enum

PersistentVolumeClaimSpec

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

Properties

Name Type Go type Required Default Description Example
accessModes []PersistentVolumeAccessMode []PersistentVolumeAccessMode accessModes contains the desired access modes the volume should have.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
+optional
dataSource TypedLocalObjectReference TypedLocalObjectReference
dataSourceRef TypedLocalObjectReference TypedLocalObjectReference
resources ResourceRequirements ResourceRequirements
selector LabelSelector LabelSelector
storageClassName string string storageClassName is the name of the StorageClass required by the claim.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
+optional
volumeMode PersistentVolumeMode PersistentVolumeMode
volumeName string string volumeName is the binding reference to the PersistentVolume backing this claim.
+optional

PersistentVolumeClaimTemplate

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

Properties

Name Type Go type Required Default Description Example
annotations map of string 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: http://kubernetes.io/docs/user-guide/annotations
+optional
clusterName string string Deprecated: ClusterName is a legacy field that was always cleared by
the system and never used; it will be removed completely in 1.25.

The name in the go struct is changed to help clients detect accidental use.

+optional | | | creationTimestamp | Time| Time | | | | | | deletionGracePeriodSeconds | int64 (formatted integer)| int64 | | | 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. +optional | | | deletionTimestamp | Time| Time | | | | | | finalizers | []string| []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. +optional +patchStrategy=merge | | | generateName | string| 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 +optional | | | generation | int64 (formatted integer)| int64 | | | A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional | | | labels | map of string| 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: http://kubernetes.io/docs/user-guide/labels +optional | | | managedFields | []ManagedFieldsEntry| []*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.

+optional | | | name | string| 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: http://kubernetes.io/docs/user-guide/identifiers#names +optional | | | namespace | string| 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: http://kubernetes.io/docs/user-guide/namespaces +optional | | | ownerReferences | []OwnerReference| []*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. +optional +patchMergeKey=uid +patchStrategy=merge | | | resourceVersion | string| 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 +optional | | | selfLink | string| string | | | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. +optional | | | spec | PersistentVolumeClaimSpec| PersistentVolumeClaimSpec | | | | | | uid | UID| UID | | | | |

PersistentVolumeClaimVolumeSource

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

Properties

Name Type Go type Required Default Description Example
claimName string 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 bool readOnly Will force the ReadOnly setting in VolumeMounts.
Default false.
+optional

PersistentVolumeMode

+enum

Name Type Go type Default Description Example
PersistentVolumeMode string string +enum

PhotonPersistentDiskVolumeSource

Properties

Name Type Go type Required Default Description Example
fsType string 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 string pdID is the ID that identifies Photon Controller persistent disk

Plugin

Plugin is an Object with exactly one key

interface{}

PodAffinity

Properties

Name Type Go type Required Default Description Example
preferredDuringSchedulingIgnoredDuringExecution []WeightedPodAffinityTerm []*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.
+optional
requiredDuringSchedulingIgnoredDuringExecution []PodAffinityTerm []*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.
+optional

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

Properties

Name Type Go type Required Default Description Example
labelSelector LabelSelector LabelSelector
namespaceSelector LabelSelector LabelSelector
namespaces []string []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".
+optional
topologyKey string 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.

PodAntiAffinity

Properties

Name Type Go type Required Default Description Example
preferredDuringSchedulingIgnoredDuringExecution []WeightedPodAffinityTerm []*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.
+optional
requiredDuringSchedulingIgnoredDuringExecution []PodAffinityTerm []*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.
+optional

PodFSGroupChangePolicy

PodFSGroupChangePolicy holds policies that will be used for applying fsGroup to a volume when volume is mounted. +enum

Name Type Go type Default Description Example
PodFSGroupChangePolicy string string PodFSGroupChangePolicy holds policies that will be used for applying fsGroup to a volume
when volume is mounted.
+enum

PodSecurityContext

Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.

Properties

Name Type Go type Required Default Description Example
fsGroup int64 (formatted integer) int64 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. +optional | | | fsGroupChangePolicy | PodFSGroupChangePolicy| PodFSGroupChangePolicy | | | | | | runAsGroup | int64 (formatted integer)| int64 | | | The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext 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. +optional | | | runAsNonRoot | boolean| bool | | | 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. +optional | | | runAsUser | int64 (formatted integer)| int64 | | | The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext 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. +optional | | | seLinuxOptions | SELinuxOptions| SELinuxOptions | | | | | | seccompProfile | SeccompProfile| SeccompProfile | | | | | | supplementalGroups | []int64 (formatted integer)| []int64 | | | A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container. Note that this field cannot be set when spec.os.name is windows. +optional | | | sysctls | []Sysctl| []*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. +optional | | | windowsOptions | WindowsSecurityContextOptions| WindowsSecurityContextOptions | | | | |

PortworxVolumeSource

Properties

Name Type Go type Required Default Description Example
fsType string 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 bool readOnly defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
+optional
volumeID string string volumeID uniquely identifies a Portworx volume

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

Properties

Name Type Go type Required Default Description Example
preference NodeSelectorTerm NodeSelectorTerm
weight int32 (formatted integer) int32 Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.

Probe

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

Properties

Name Type Go type Required Default Description Example
exec ExecAction ExecAction
failureThreshold int32 (formatted integer) int32 Minimum consecutive failures for the probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.
+optional
grpc GRPCAction GRPCAction
httpGet HTTPGetAction HTTPGetAction
initialDelaySeconds int32 (formatted integer) int32 Number of seconds after the container has started before liveness probes are initiated.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+optional
periodSeconds int32 (formatted integer) int32 How often (in seconds) to perform the probe.
Default to 10 seconds. Minimum value is 1.
+optional
successThreshold int32 (formatted integer) int32 Minimum consecutive successes for the probe to be considered successful after having failed.
Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+optional
tcpSocket TCPSocketAction TCPSocketAction
terminationGracePeriodSeconds int64 (formatted integer) int64 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.
+optional
timeoutSeconds int32 (formatted integer) int32 Number of seconds after which the probe times out.
Defaults to 1 second. Minimum value is 1.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+optional

ProcMountType

+enum

Name Type Go type Default Description Example
ProcMountType string string +enum

Progress

Name Type Go type Default Description Example
Progress string string

ProjectedVolumeSource

Represents a projected volume source

Properties

Name Type Go type Required Default Description Example
defaultMode int32 (formatted integer) int32 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.
+optional
sources []VolumeProjection []*VolumeProjection sources is the list of volume projections
+optional

Prometheus

Prometheus is a prometheus metric to be emitted

Properties

Name Type Go type Required Default Description Example
counter Counter Counter
gauge Gauge Gauge
help string string Help is a string that describes the metric
histogram Histogram Histogram
labels []MetricLabel []*MetricLabel Labels is a list of metric labels
name string string Name is the name of the metric
when string string When is a conditional statement that decides when to emit the metric

Protocol

+enum

Name Type Go type Default Description Example
Protocol string string +enum

PullPolicy

PullPolicy describes a policy for if/when to pull a container image +enum

Name Type Go type Default Description Example
PullPolicy string string PullPolicy describes a policy for if/when to pull a container image
+enum

Quantity

The serialization format is:

::= (Note that may be empty, from the "" case in .) ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) ::= m | "" | k | M | G | T | P | E (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) ::= "e" | "E"

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: a. No precision is lost b. No fractional digits will be emitted c. 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.

+protobuf=true +protobuf.embed=string +protobuf.options.marshal=false +protobuf.options.(gogoproto.goproto_stringer)=false +k8s:deepcopy-gen=true +k8s:openapi-gen=true

interface{}

QuobyteVolumeSource

Quobyte volumes do not support ownership management or SELinux relabeling.

Properties

Name Type Go type Required Default Description Example
group string string group to map volume access to
Default is no group
+optional
readOnly boolean bool readOnly here will force the Quobyte volume to be mounted with read-only permissions.
Defaults to false.
+optional
registry string 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 string tenant owning the given Quobyte volume in the Backend
Used with dynamically provisioned Quobyte volumes, value is set by the plugin
+optional
user string string user to map volume access to
Defaults to serivceaccount user
+optional
volume string string volume is a string that references an already created Quobyte volume by name.

RBDVolumeSource

RBD volumes support ownership management and SELinux relabeling.

Properties

Name Type Go type Required Default Description Example
fsType string 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
TODO: how do we prevent errors in the filesystem from compromising the machine
+optional
image string string image is the rados image name.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
keyring string string keyring is the path to key ring for RBDUser.
Default is /etc/ceph/keyring.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+optional
monitors []string []string monitors is a collection of Ceph monitors.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
pool string string pool is the rados pool name.
Default is rbd.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+optional
readOnly boolean bool readOnly here will force the ReadOnly setting in VolumeMounts.
Defaults to false.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+optional
secretRef LocalObjectReference LocalObjectReference
user string string user is the rados user name.
Default is admin.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+optional

RawArtifact

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

Properties

Name Type Go type Required Default Description Example
data string string Data is the string contents of the artifact

ResourceFieldSelector

ResourceFieldSelector represents container resources (cpu, memory) and their output format +structType=atomic

Properties

Name Type Go type Required Default Description Example
containerName string string Container name: required for volumes, optional for env vars
+optional
divisor Quantity Quantity
resource string string Required: resource to select

ResourceList

ResourceList

ResourceRequirements

Properties

Name Type Go type Required Default Description Example
limits ResourceList ResourceList
requests ResourceList ResourceList

ResourceTemplate

ResourceTemplate is a template subtype to manipulate kubernetes resources

Properties

Name Type Go type Required Default Description Example
action string string Action is the action to perform to the resource.
Must be one of: get, create, apply, delete, replace, patch
failureCondition string string FailureCondition is a label selector expression which describes the conditions
of the k8s resource in which the step was considered failed
flags []string []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 string Manifest contains the kubernetes manifest
manifestFrom ManifestFrom ManifestFrom
mergeStrategy string string MergeStrategy is the strategy used to merge a patch. It defaults to "strategic"
Must be one of: strategic, merge, json
setOwnerReference boolean bool SetOwnerReference sets the reference to the workflow on the OwnerReference of generated resource.
successCondition string 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

RetryAffinity

Properties

Name Type Go type Required Default Description Example
nodeAntiAffinity RetryNodeAntiAffinity RetryNodeAntiAffinity

RetryNodeAntiAffinity

In order to prevent running steps on the same host, it uses "kubernetes.io/hostname".

interface{}

RetryPolicy

Name Type Go type Default Description Example
RetryPolicy string string

RetryStrategy

RetryStrategy provides controls on how to retry a workflow step

Properties

Name Type Go type Required Default Description Example
affinity RetryAffinity RetryAffinity
backoff Backoff Backoff
expression string 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 IntOrString
retryPolicy RetryPolicy RetryPolicy

S3Artifact

S3Artifact is the location of an S3 artifact

Properties

Name Type Go type Required Default Description Example
accessKeySecret SecretKeySelector SecretKeySelector
bucket string string Bucket is the name of the bucket
createBucketIfNotPresent CreateS3BucketOptions CreateS3BucketOptions
encryptionOptions S3EncryptionOptions S3EncryptionOptions
endpoint string string Endpoint is the hostname of the bucket endpoint
insecure boolean bool Insecure will connect to the service with TLS
key string string Key is the key in the bucket where the artifact resides
region string string Region contains the optional bucket region
roleARN string string RoleARN is the Amazon Resource Name (ARN) of the role to assume.
secretKeySecret SecretKeySelector SecretKeySelector
useSDKCreds boolean bool UseSDKCreds tells the driver to figure out credentials based on sdk defaults.

S3EncryptionOptions

S3EncryptionOptions used to determine encryption options during s3 operations

Properties

Name Type Go type Required Default Description Example
enableEncryption boolean bool 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 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 string KMSKeyId tells the driver to encrypt the object using the specified KMS Key.
serverSideCustomerKeySecret SecretKeySelector SecretKeySelector

SELinuxOptions

SELinuxOptions are the labels to be applied to the container

Properties

Name Type Go type Required Default Description Example
level string string Level is SELinux level label that applies to the container.
+optional
role string string Role is a SELinux role label that applies to the container.
+optional
type string string Type is a SELinux type label that applies to the container.
+optional
user string string User is a SELinux user label that applies to the container.
+optional

ScaleIOVolumeSource

ScaleIOVolumeSource represents a persistent ScaleIO volume

Properties

Name Type Go type Required Default Description Example
fsType string 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".
+optional
gateway string string gateway is the host address of the ScaleIO API Gateway.
protectionDomain string string protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
+optional
readOnly boolean bool readOnly Defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
+optional
secretRef LocalObjectReference LocalObjectReference
sslEnabled boolean bool sslEnabled Flag enable/disable SSL communication with Gateway, default false
+optional
storageMode string string storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.
Default is ThinProvisioned.
+optional
storagePool string string storagePool is the ScaleIO Storage Pool associated with the protection domain.
+optional
system string string system is the name of the storage system as configured in ScaleIO.
volumeName string string volumeName is the name of a volume already created in the ScaleIO system
that is associated with this volume source.

ScriptTemplate

ScriptTemplate is a template subtype to enable scripting through code steps

Properties

Name Type Go type Required Default Description Example
args []string []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
+optional
command []string []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
+optional
env []EnvVar []*EnvVar List of environment variables to set in the container.
Cannot be updated.
+optional
+patchMergeKey=name
+patchStrategy=merge
envFrom []EnvFromSource []*EnvFromSource List of sources to populate environment variables in the container.
The keys defined within a source must be a C_IDENTIFIER. All invalid 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.
+optional
image string 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.
+optional
imagePullPolicy PullPolicy PullPolicy
lifecycle Lifecycle Lifecycle
livenessProbe Probe Probe
name string 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 []ContainerPort []*ContainerPort List of ports to expose from the container. Exposing a port here gives
the system additional information about the network connections a
container uses, but is primarily informational. 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.
Cannot be updated.
+optional
+patchMergeKey=containerPort
+patchStrategy=merge
+listType=map
+listMapKey=containerPort
+listMapKey=protocol
readinessProbe Probe Probe
resources ResourceRequirements ResourceRequirements
securityContext SecurityContext SecurityContext
source string string Source contains the source code of the script to execute
startupProbe Probe Probe
stdin boolean bool 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.
+optional
stdinOnce boolean bool 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
+optional
terminationMessagePath string 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.
+optional
terminationMessagePolicy TerminationMessagePolicy TerminationMessagePolicy
tty boolean bool Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
Default is false.
+optional
volumeDevices []VolumeDevice []*VolumeDevice volumeDevices is the list of block devices to be used by the container.
+patchMergeKey=devicePath
+patchStrategy=merge
+optional
volumeMounts []VolumeMount []*VolumeMount Pod volumes to mount into the container's filesystem.
Cannot be updated.
+optional
+patchMergeKey=mountPath
+patchStrategy=merge
workingDir string 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.
+optional

SeccompProfile

Only one profile source may be set. +union

Properties

Name Type Go type Required Default Description Example
localhostProfile string 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 only be set if type is "Localhost".
+optional
type SeccompProfileType SeccompProfileType

SeccompProfileType

+enum

Name Type Go type Default Description Example
SeccompProfileType string string +enum

SecretEnvSource

The contents of the target Secret's Data field will represent the key-value pairs as environment variables.

Properties

Name Type Go type Required Default Description Example
name string string Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
+optional
optional boolean bool Specify whether the Secret must be defined
+optional

SecretKeySelector

+structType=atomic

Properties

Name Type Go type Required Default Description Example
key string string The key of the secret to select from. Must be a valid secret key.
name string string Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
+optional
optional boolean bool Specify whether the Secret or its key must be defined
+optional

SecretProjection

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.

Properties

Name Type Go type Required Default Description Example
items []KeyToPath []*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
name string string Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
+optional
optional boolean bool optional field specify whether the Secret or its key must be defined
+optional

SecretVolumeSource

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.

Properties

Name Type Go type Required Default Description Example
defaultMode int32 (formatted integer) int32 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.
+optional
items []KeyToPath []*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
optional boolean bool optional field specify whether the Secret or its keys must be defined
+optional
secretName string 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
+optional

SecurityContext

Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.

Properties

Name Type Go type Required Default Description Example
allowPrivilegeEscalation boolean bool 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.
+optional
capabilities Capabilities Capabilities
privileged boolean bool 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.
+optional
procMount ProcMountType ProcMountType
readOnlyRootFilesystem boolean bool 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.
+optional
runAsGroup int64 (formatted integer) int64 The GID to run the entrypoint of the container process.
Uses runtime default if unset.
May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is windows.
+optional
runAsNonRoot boolean bool 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.
+optional
runAsUser int64 (formatted integer) int64 The UID to run the entrypoint of the container process.
Defaults to user specified in image metadata if unspecified.
May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is windows.
+optional
seLinuxOptions SELinuxOptions SELinuxOptions
seccompProfile SeccompProfile SeccompProfile
windowsOptions WindowsSecurityContextOptions WindowsSecurityContextOptions

SemaphoreRef

SemaphoreRef is a reference of Semaphore

Properties

Name Type Go type Required Default Description Example
configMapKeyRef ConfigMapKeySelector ConfigMapKeySelector

Sequence

Sequence expands a workflow step into numeric range

Properties

Name Type Go type Required Default Description Example
count IntOrString IntOrString
end IntOrString IntOrString
format string string Format is a printf format string to format the value in the sequence
start IntOrString IntOrString

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

Properties

Name Type Go type Required Default Description Example
audience string 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.
+optional
expirationSeconds int64 (formatted integer) int64 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.
+optional
path string string path is the path relative to the mount point of the file to project the
token into.

StorageMedium

Name Type Go type Default Description Example
StorageMedium string string

StorageOSVolumeSource

Properties

Name Type Go type Required Default Description Example
fsType string 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.
+optional
readOnly boolean bool readOnly defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
+optional
secretRef LocalObjectReference LocalObjectReference
volumeName string string volumeName is the human-readable name of the StorageOS volume. Volume
names are only unique within a namespace.
volumeNamespace string 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.
+optional

SuppliedValueFrom

interface{}

SuspendTemplate

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

Properties

Name Type Go type Required Default Description Example
duration string string Duration is the seconds to wait before automatically resuming a template

Synchronization

Synchronization holds synchronization lock configuration

Properties

Name Type Go type Required Default Description Example
mutex Mutex Mutex
semaphore SemaphoreRef SemaphoreRef

Sysctl

Sysctl defines a kernel parameter to be set

Properties

Name Type Go type Required Default Description Example
name string string Name of a property to set
value string string Value of a property to set

TCPSocketAction

TCPSocketAction describes an action based on opening a socket

Properties

Name Type Go type Required Default Description Example
host string string Optional: Host name to connect to, defaults to the pod IP.
+optional
port IntOrString IntOrString

TaintEffect

+enum

Name Type Go type Default Description Example
TaintEffect string string +enum

TarStrategy

TarStrategy will tar and gzip the file or directory when saving

Properties

Name Type Go type Required Default Description Example
compressionLevel int32 (formatted integer) int32 CompressionLevel specifies the gzip compression level to use for the artifact.
Defaults to gzip.DefaultCompression.

Template

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

Properties

Name Type Go type Required Default Description Example
activeDeadlineSeconds IntOrString IntOrString
affinity Affinity Affinity
archiveLocation ArtifactLocation ArtifactLocation
automountServiceAccountToken boolean bool 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
containerSet ContainerSetTemplate ContainerSetTemplate
daemon boolean bool Deamon will allow a workflow to proceed to the next step so long as the container reaches readiness
dag DAGTemplate DAGTemplate
data Data Data
executor ExecutorConfig ExecutorConfig
failFast boolean bool 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 []HostAlias []*HostAlias HostAliases is an optional list of hosts and IPs that will be injected into the pod spec
+patchStrategy=merge
+patchMergeKey=ip
http HTTP HTTP
initContainers []UserContainer []*UserContainer InitContainers is a list of containers which run before the main container.
+patchStrategy=merge
+patchMergeKey=name
inputs Inputs Inputs
memoize Memoize Memoize
metadata Metadata Metadata
metrics Metrics Metrics
name string string Name is the name of the template
nodeSelector map of string 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
parallelism int64 (formatted integer) int64 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
podSpecPatch string 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 int32 (formatted integer) int32 Priority to apply to workflow pods.
priorityClassName string string PriorityClassName to apply to workflow pods.
resource ResourceTemplate ResourceTemplate
retryStrategy RetryStrategy RetryStrategy
schedulerName string string If specified, the pod will be dispatched by specified scheduler.
Or it will be dispatched by workflow scope scheduler if specified.
If neither specified, the pod will be dispatched by default scheduler.
+optional
script ScriptTemplate ScriptTemplate
securityContext PodSecurityContext PodSecurityContext
serviceAccountName string string ServiceAccountName to apply to workflow pods
sidecars []UserContainer []*UserContainer Sidecars is a list of containers which run alongside the main container
Sidecars are automatically killed when the main container completes
+patchStrategy=merge
+patchMergeKey=name
steps []ParallelSteps []ParallelSteps Steps define a series of sequential/parallel workflow steps
suspend SuspendTemplate SuspendTemplate
synchronization Synchronization Synchronization
timeout string 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 []Toleration []*Toleration Tolerations to apply to workflow pods.
+patchStrategy=merge
+patchMergeKey=key
volumes []Volume []*Volume Volumes is a list of volumes that can be mounted by containers in a template.
+patchStrategy=merge
+patchMergeKey=name

TemplateRef

Properties

Name Type Go type Required Default Description Example
clusterScope boolean bool ClusterScope indicates the referred template is cluster scoped (i.e. a ClusterWorkflowTemplate).
name string string Name is the resource name of the template.
template string string Template is the name of referred template in the resource.

TerminationMessagePolicy

+enum

Name Type Go type Default Description Example
TerminationMessagePolicy string string +enum

Time

+protobuf.options.marshal=false +protobuf.as=Timestamp +protobuf.options.(gogoproto.goproto_stringer)=false

interface{}

Toleration

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

Properties

Name Type Go type Required Default Description Example
effect TaintEffect TaintEffect
key string string Key is the taint key that the toleration applies to. Empty means match all taint keys.
If the key is empty, operator must be Exists; this combination means to match all values and all keys.
+optional
operator TolerationOperator TolerationOperator
tolerationSeconds int64 (formatted integer) int64 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.
+optional
value string string Value is the taint value the toleration matches to.
If the operator is Exists, the value should be empty, otherwise just a regular string.
+optional

TolerationOperator

+enum

Name Type Go type Default Description Example
TolerationOperator string string +enum

Transformation

[]TransformationStep

TransformationStep

Properties

Name Type Go type Required Default Description Example
expression string string Expression defines an expr expression to apply

Type

Name Type Go type Default Description Example
Type int64 (formatted integer) int64

TypedLocalObjectReference

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

Properties

Name Type Go type Required Default Description Example
apiGroup string string APIGroup is the group for the resource being referenced.
If APIGroup is not specified, the specified Kind must be in the core API group.
For any other third-party types, APIGroup is required.
+optional
kind string string Kind is the type of resource being referenced
name string string Name is the name of resource being referenced

UID

UID is a type that holds unique ID values, including UUIDs. Because we don't ONLY use UUIDs, this is an alias to string. Being a type captures intent and helps make sure that UIDs and names do not get conflated.

Name Type Go type Default Description Example
UID string string UID is a type that holds unique ID values, including UUIDs. Because we
don't ONLY use UUIDs, this is an alias to string. Being a type captures
intent and helps make sure that UIDs and names do not get conflated.

URIScheme

URIScheme identifies the scheme used for connection to a host for Get actions +enum

Name Type Go type Default Description Example
URIScheme string string URIScheme identifies the scheme used for connection to a host for Get actions
+enum

UserContainer

Properties

Name Type Go type Required Default Description Example
args []string []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
+optional
command []string []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
+optional
env []EnvVar []*EnvVar List of environment variables to set in the container.
Cannot be updated.
+optional
+patchMergeKey=name
+patchStrategy=merge
envFrom []EnvFromSource []*EnvFromSource List of sources to populate environment variables in the container.
The keys defined within a source must be a C_IDENTIFIER. All invalid 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.
+optional
image string 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.
+optional
imagePullPolicy PullPolicy PullPolicy
lifecycle Lifecycle Lifecycle
livenessProbe Probe Probe
mirrorVolumeMounts boolean bool 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 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 []ContainerPort []*ContainerPort List of ports to expose from the container. Exposing a port here gives
the system additional information about the network connections a
container uses, but is primarily informational. 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.
Cannot be updated.
+optional
+patchMergeKey=containerPort
+patchStrategy=merge
+listType=map
+listMapKey=containerPort
+listMapKey=protocol
readinessProbe Probe Probe
resources ResourceRequirements ResourceRequirements
securityContext SecurityContext SecurityContext
startupProbe Probe Probe
stdin boolean bool 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.
+optional
stdinOnce boolean bool 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
+optional
terminationMessagePath string 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.
+optional
terminationMessagePolicy TerminationMessagePolicy TerminationMessagePolicy
tty boolean bool Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
Default is false.
+optional
volumeDevices []VolumeDevice []*VolumeDevice volumeDevices is the list of block devices to be used by the container.
+patchMergeKey=devicePath
+patchStrategy=merge
+optional
volumeMounts []VolumeMount []*VolumeMount Pod volumes to mount into the container's filesystem.
Cannot be updated.
+optional
+patchMergeKey=mountPath
+patchStrategy=merge
workingDir string 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.
+optional

ValueFrom

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

Properties

Name Type Go type Required Default Description Example
configMapKeyRef ConfigMapKeySelector ConfigMapKeySelector
default AnyString AnyString
event string string Selector (https://github.com/antonmedv/expr) that is evaluated against the event to get the value of the parameter. E.g. payload.message
expression string string Expression, if defined, is evaluated to specify the value for the parameter
jqFilter string string JQFilter expression against the resource object in resource templates
jsonPath string string JSONPath of a resource to retrieve an output parameter value from in resource templates
parameter string 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 string Path in the container to retrieve an output parameter value from in container templates
supplied SuppliedValueFrom SuppliedValueFrom

Volume

Properties

Name Type Go type Required Default Description Example
awsElasticBlockStore AWSElasticBlockStoreVolumeSource AWSElasticBlockStoreVolumeSource
azureDisk AzureDiskVolumeSource AzureDiskVolumeSource
azureFile AzureFileVolumeSource AzureFileVolumeSource
cephfs CephFSVolumeSource CephFSVolumeSource
cinder CinderVolumeSource CinderVolumeSource
configMap ConfigMapVolumeSource ConfigMapVolumeSource
csi CSIVolumeSource CSIVolumeSource
downwardAPI DownwardAPIVolumeSource DownwardAPIVolumeSource
emptyDir EmptyDirVolumeSource EmptyDirVolumeSource
ephemeral EphemeralVolumeSource EphemeralVolumeSource
fc FCVolumeSource FCVolumeSource
flexVolume FlexVolumeSource FlexVolumeSource
flocker FlockerVolumeSource FlockerVolumeSource
gcePersistentDisk GCEPersistentDiskVolumeSource GCEPersistentDiskVolumeSource
gitRepo GitRepoVolumeSource GitRepoVolumeSource
glusterfs GlusterfsVolumeSource GlusterfsVolumeSource
hostPath HostPathVolumeSource HostPathVolumeSource
iscsi ISCSIVolumeSource ISCSIVolumeSource
name string 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 NFSVolumeSource
persistentVolumeClaim PersistentVolumeClaimVolumeSource PersistentVolumeClaimVolumeSource
photonPersistentDisk PhotonPersistentDiskVolumeSource PhotonPersistentDiskVolumeSource
portworxVolume PortworxVolumeSource PortworxVolumeSource
projected ProjectedVolumeSource ProjectedVolumeSource
quobyte QuobyteVolumeSource QuobyteVolumeSource
rbd RBDVolumeSource RBDVolumeSource
scaleIO ScaleIOVolumeSource ScaleIOVolumeSource
secret SecretVolumeSource SecretVolumeSource
storageos StorageOSVolumeSource StorageOSVolumeSource
vsphereVolume VsphereVirtualDiskVolumeSource VsphereVirtualDiskVolumeSource

VolumeDevice

Properties

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

VolumeMount

Properties

Name Type Go type Required Default Description Example
mountPath string string Path within the container at which the volume should be mounted. Must
not contain ':'.
mountPropagation MountPropagationMode MountPropagationMode
name string string This must match the Name of a Volume.
readOnly boolean bool Mounted read-only if true, read-write otherwise (false or unspecified).
Defaults to false.
+optional
subPath string string Path within the volume from which the container's volume should be mounted.
Defaults to "" (volume's root).
+optional
subPathExpr string 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.
+optional

VolumeProjection

Projection that may be projected along with other supported volume types

Properties

Name Type Go type Required Default Description Example
configMap ConfigMapProjection ConfigMapProjection
downwardAPI DownwardAPIProjection DownwardAPIProjection
secret SecretProjection SecretProjection
serviceAccountToken ServiceAccountTokenProjection ServiceAccountTokenProjection

VsphereVirtualDiskVolumeSource

Properties

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

WeightedPodAffinityTerm

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

Properties

Name Type Go type Required Default Description Example
podAffinityTerm PodAffinityTerm PodAffinityTerm
weight int32 (formatted integer) int32 weight associated with matching the corresponding podAffinityTerm,
in the range 1-100.

WindowsSecurityContextOptions

Properties

Name Type Go type Required Default Description Example
gmsaCredentialSpec string 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.
+optional
gmsaCredentialSpecName string string GMSACredentialSpecName is the name of the GMSA credential spec to use.
+optional
hostProcess boolean bool HostProcess determines if a container should be run as a 'Host Process' container.
This field is alpha-level and will only be honored by components that enable the
WindowsHostProcessContainers feature flag. Setting this field without the feature
flag will result in errors when validating the Pod. 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.
+optional
runAsUserName string 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.
+optional

Workflow

Properties

Name Type Go type Required Default Description Example
metadata ObjectMeta ObjectMeta

ZipStrategy

ZipStrategy will unzip zipped input artifacts

interface{}

Comments

Back to top