Task [tekton.dev/v1]

Description
Task represents a collection of sequential steps that are run as part of a Pipeline using a set of inputs and producing a set of outputs. Tasks execute when TaskRuns are created that provide the input parameters and resources and output resources the Task requires.
Type
object

Specification

PropertyTypeDescription
apiVersionstring

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kindstring

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadataObjectMeta

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

specobject

Spec holds the desired state of the Task from the client

.spec

Description
Spec holds the desired state of the Task from the client
Type
object
PropertyTypeDescription
descriptionstring

Description is a user-facing description of the task that may be used to populate a UI.

displayNamestring

DisplayName is a user-facing name of the task that may be used to populate a UI.

paramsarray

Params is a list of input parameters required to run the task. Params must be supplied as inputs in TaskRuns unless they declare a default value.

resultsarray

Results are values that this Task can output

sidecarsarray

Sidecars are run alongside the Task's step containers. They begin before the steps start and end after the steps complete.

stepTemplateobject

StepTemplate can be used as the basis for all step containers within the Task, so that the steps inherit settings on the base container.

stepsarray

Steps are the steps of the build; each step is run sequentially with the source mounted into /workspace.

volumes

Volumes is a collection of volumes that are available to mount into the steps of the build. See Pod.spec.volumes (API version: v1)

workspacesarray

Workspaces are the volumes that this Task requires.

.spec.params

Description
Params is a list of input parameters required to run the task. Params must be supplied as inputs in TaskRuns unless they declare a default value.
Type
array

.spec.params[]

Description
ParamSpec defines arbitrary parameters needed beyond typed inputs (such as resources). Parameter values are provided by users as inputs on a TaskRun or PipelineRun.
Type
object
Required
name
PropertyTypeDescription
default

Default is the value a parameter takes if no input value is supplied. If default is set, a Task may be executed without a supplied value for the parameter.

descriptionstring

Description is a user-facing description of the parameter that may be used to populate a UI.

enumarray

Enum declares a set of allowed param input values for tasks/pipelines that can be validated. If Enum is not set, no input validation is performed for the param.

namestring

Name declares the name by which a parameter is referenced.

propertiesobject

Properties is the JSON Schema properties to support key-value pairs parameter.

typestring

Type is the user-specified type of the parameter. The possible types are currently "string", "array" and "object", and "string" is the default.

.spec.params[].enum

Description
Enum declares a set of allowed param input values for tasks/pipelines that can be validated. If Enum is not set, no input validation is performed for the param.
Type
array

.spec.params[].enum[]

Type
string

.spec.params[].properties

Description
Properties is the JSON Schema properties to support key-value pairs parameter.
Type
object

.spec.results

Description
Results are values that this Task can output
Type
array

.spec.results[]

Description
TaskResult used to describe the results of a task
Type
object
Required
name
PropertyTypeDescription
descriptionstring

Description is a human-readable description of the result

namestring

Name the given name

propertiesobject

Properties is the JSON Schema properties to support key-value pairs results.

typestring

Type is the user-specified type of the result. The possible type is currently "string" and will support "array" in following work.

value

Value the expression used to retrieve the value of the result from an underlying Step.

.spec.results[].properties

Description
Properties is the JSON Schema properties to support key-value pairs results.
Type
object

.spec.sidecars

Description
Sidecars are run alongside the Task's step containers. They begin before the steps start and end after the steps complete.
Type
array

.spec.sidecars[]

Description
Sidecar has nearly the same data structure as Step but does not have the ability to timeout.
Type
object
Required
name
PropertyTypeDescription
argsarray

Arguments to the entrypoint. The image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the Sidecar'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

commandarray

Entrypoint array. Not executed within a shell. The image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the Sidecar'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

computeResourcesobject

ComputeResources required by this Sidecar. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

envarray

List of environment variables to set in the Sidecar. Cannot be updated.

envFromarray

List of sources to populate environment variables in the Sidecar. 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.

imagestring

Image reference name. More info: https://kubernetes.io/docs/concepts/containers/images

imagePullPolicystring

Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images

lifecycleobject

Actions that the management system should take in response to Sidecar lifecycle events. Cannot be updated.

livenessProbeobject

Periodic probe of Sidecar liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

namestring

Name of the Sidecar specified as a DNS_LABEL. Each Sidecar in a Task must have a unique name (DNS_LABEL). Cannot be updated.

portsarray

List of ports to expose from the Sidecar. 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.

readinessProbeobject

Periodic probe of Sidecar service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

restartPolicystring

RestartPolicy refers to kubernetes RestartPolicy. It can only be set for an initContainer and must have it's policy set to "Always". It is currently left optional to help support Kubernetes versions prior to 1.29 when this feature was introduced.

scriptstring

Script is the contents of an executable file to execute.

If Script is not empty, the Step cannot have an Command or Args.

securityContextobject

SecurityContext defines the security options the Sidecar should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

startupProbeobject

StartupProbe indicates that the Pod the Sidecar is running in has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

stdinboolean

Whether this Sidecar should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the Sidecar will always result in EOF. Default is false.

stdinOnceboolean

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 Sidecar 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 Sidecar is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false

terminationMessagePathstring

Optional: Path at which the file to which the Sidecar's termination message will be written is mounted into the Sidecar'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.

terminationMessagePolicystring

Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the Sidecar status message on both success and failure. FallbackToLogsOnError will use the last chunk of Sidecar log output if the termination message file is empty and the Sidecar exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.

ttyboolean

Whether this Sidecar should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.

volumeDevicesarray

volumeDevices is the list of block devices to be used by the Sidecar.

volumeMountsarray

Volumes to mount into the Sidecar's filesystem. Cannot be updated.

workingDirstring

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

workspacesarray

This is an alpha field. You must set the "enable-api-fields" feature flag to "alpha" for this field to be supported.

Workspaces is a list of workspaces from the Task that this Sidecar wants exclusive access to. Adding a workspace to this list means that any other Step or Sidecar that does not also request this Workspace will not have access to it.

.spec.sidecars[].args

Description
Arguments to the entrypoint. The image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the Sidecar'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
Type
array

.spec.sidecars[].args[]

Type
string

.spec.sidecars[].command

Description
Entrypoint array. Not executed within a shell. The image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the Sidecar'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
Type
array

.spec.sidecars[].command[]

Type
string

.spec.sidecars[].computeResources

Description
ComputeResources required by this Sidecar. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
Type
object
PropertyTypeDescription
claimsarray

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

limitsobject

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

requestsobject

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

.spec.sidecars[].computeResources.claims

Description
Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
Type
array

.spec.sidecars[].computeResources.claims[]

Description
ResourceClaim references one entry in PodSpec.ResourceClaims.
Type
object
Required
name
PropertyTypeDescription
namestring

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

requeststring

Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.

.spec.sidecars[].computeResources.limits

Description
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
Type
object

.spec.sidecars[].computeResources.requests

Description
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
Type
object

.spec.sidecars[].env

Description
List of environment variables to set in the Sidecar. Cannot be updated.
Type
array

.spec.sidecars[].env[]

Description
EnvVar represents an environment variable present in a Container.
Type
object
Required
name
PropertyTypeDescription
namestring

Name of the environment variable. Must be a C_IDENTIFIER.

valuestring

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

valueFromobject

Source for the environment variable's value. Cannot be used if value is not empty.

.spec.sidecars[].env[].valueFrom

Description
Source for the environment variable's value. Cannot be used if value is not empty.
Type
object
PropertyTypeDescription
configMapKeyRefobject

Selects a key of a ConfigMap.

fieldRefobject

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.

resourceFieldRefobject

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.

secretKeyRefobject

Selects a key of a secret in the pod's namespace

.spec.sidecars[].env[].valueFrom.configMapKeyRef

Description
Selects a key of a ConfigMap.
Type
object
Required
key
PropertyTypeDescription
keystring

The key to select.

namestring

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

optionalboolean

Specify whether the ConfigMap or its key must be defined

.spec.sidecars[].env[].valueFrom.fieldRef

Description
Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
Type
object
Required
fieldPath
PropertyTypeDescription
apiVersionstring

Version of the schema the FieldPath is written in terms of, defaults to "v1".

fieldPathstring

Path of the field to select in the specified API version.

.spec.sidecars[].env[].valueFrom.resourceFieldRef

Description
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
Type
object
Required
resource
PropertyTypeDescription
containerNamestring

Container name: required for volumes, optional for env vars

divisor

Specifies the output format of the exposed resources, defaults to "1"

resourcestring

Required: resource to select

.spec.sidecars[].env[].valueFrom.secretKeyRef

Description
Selects a key of a secret in the pod's namespace
Type
object
Required
key
PropertyTypeDescription
keystring

The key of the secret to select from. Must be a valid secret key.

namestring

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

optionalboolean

Specify whether the Secret or its key must be defined

.spec.sidecars[].envFrom

Description
List of sources to populate environment variables in the Sidecar. 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.
Type
array

.spec.sidecars[].envFrom[]

Description
EnvFromSource represents the source of a set of ConfigMaps
Type
object
PropertyTypeDescription
configMapRefobject

The ConfigMap to select from

prefixstring

An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.

secretRefobject

The Secret to select from

.spec.sidecars[].envFrom[].configMapRef

Description
The ConfigMap to select from
Type
object
PropertyTypeDescription
namestring

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

optionalboolean

Specify whether the ConfigMap must be defined

.spec.sidecars[].envFrom[].secretRef

Description
The Secret to select from
Type
object
PropertyTypeDescription
namestring

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

optionalboolean

Specify whether the Secret must be defined

.spec.sidecars[].lifecycle

Description
Actions that the management system should take in response to Sidecar lifecycle events. Cannot be updated.
Type
object
PropertyTypeDescription
postStartobject

PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

preStopobject

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

.spec.sidecars[].lifecycle.postStart

Description
PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
Type
object
PropertyTypeDescription
execobject

Exec specifies a command to execute in the container.

httpGetobject

HTTPGet specifies an HTTP GET request to perform.

sleepobject

Sleep represents a duration that the container should sleep.

tcpSocketobject

Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for backward compatibility. There is no validation of this field and lifecycle hooks will fail at runtime when it is specified.

.spec.sidecars[].lifecycle.postStart.exec

Description
Exec specifies a command to execute in the container.
Type
object
PropertyTypeDescription
commandarray

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.

.spec.sidecars[].lifecycle.postStart.exec.command

Description
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.
Type
array

.spec.sidecars[].lifecycle.postStart.exec.command[]

Type
string

.spec.sidecars[].lifecycle.postStart.httpGet

Description
HTTPGet specifies an HTTP GET request to perform.
Type
object
Required
port
PropertyTypeDescription
hoststring

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

httpHeadersarray

Custom headers to set in the request. HTTP allows repeated headers.

pathstring

Path to access on the HTTP server.

port

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

schemestring

Scheme to use for connecting to the host. Defaults to HTTP.

.spec.sidecars[].lifecycle.postStart.httpGet.httpHeaders

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array

.spec.sidecars[].lifecycle.postStart.httpGet.httpHeaders[]

Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
namevalue
PropertyTypeDescription
namestring

The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

valuestring

The header field value

.spec.sidecars[].lifecycle.postStart.sleep

Description
Sleep represents a duration that the container should sleep.
Type
object
Required
seconds
PropertyTypeDescription
secondsinteger

Seconds is the number of seconds to sleep.

.spec.sidecars[].lifecycle.postStart.tcpSocket

Description
Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for backward compatibility. There is no validation of this field and lifecycle hooks will fail at runtime when it is specified.
Type
object
Required
port
PropertyTypeDescription
hoststring

Optional: Host name to connect to, defaults to the pod IP.

port

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

.spec.sidecars[].lifecycle.preStop

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

Exec specifies a command to execute in the container.

httpGetobject

HTTPGet specifies an HTTP GET request to perform.

sleepobject

Sleep represents a duration that the container should sleep.

tcpSocketobject

Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for backward compatibility. There is no validation of this field and lifecycle hooks will fail at runtime when it is specified.

.spec.sidecars[].lifecycle.preStop.exec

Description
Exec specifies a command to execute in the container.
Type
object
PropertyTypeDescription
commandarray

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.

.spec.sidecars[].lifecycle.preStop.exec.command

Description
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.
Type
array

.spec.sidecars[].lifecycle.preStop.exec.command[]

Type
string

.spec.sidecars[].lifecycle.preStop.httpGet

Description
HTTPGet specifies an HTTP GET request to perform.
Type
object
Required
port
PropertyTypeDescription
hoststring

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

httpHeadersarray

Custom headers to set in the request. HTTP allows repeated headers.

pathstring

Path to access on the HTTP server.

port

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

schemestring

Scheme to use for connecting to the host. Defaults to HTTP.

.spec.sidecars[].lifecycle.preStop.httpGet.httpHeaders

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array

.spec.sidecars[].lifecycle.preStop.httpGet.httpHeaders[]

Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
namevalue
PropertyTypeDescription
namestring

The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

valuestring

The header field value

.spec.sidecars[].lifecycle.preStop.sleep

Description
Sleep represents a duration that the container should sleep.
Type
object
Required
seconds
PropertyTypeDescription
secondsinteger

Seconds is the number of seconds to sleep.

.spec.sidecars[].lifecycle.preStop.tcpSocket

Description
Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for backward compatibility. There is no validation of this field and lifecycle hooks will fail at runtime when it is specified.
Type
object
Required
port
PropertyTypeDescription
hoststring

Optional: Host name to connect to, defaults to the pod IP.

port

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

.spec.sidecars[].livenessProbe

Description
Periodic probe of Sidecar liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Type
object
PropertyTypeDescription
execobject

Exec specifies a command to execute in the container.

failureThresholdinteger

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

grpcobject

GRPC specifies a GRPC HealthCheckRequest.

httpGetobject

HTTPGet specifies an HTTP GET request to perform.

initialDelaySecondsinteger

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

periodSecondsinteger

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

successThresholdinteger

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.

tcpSocketobject

TCPSocket specifies a connection to a TCP port.

terminationGracePeriodSecondsinteger

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.

timeoutSecondsinteger

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

.spec.sidecars[].livenessProbe.exec

Description
Exec specifies a command to execute in the container.
Type
object
PropertyTypeDescription
commandarray

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.

.spec.sidecars[].livenessProbe.exec.command

Description
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.
Type
array

.spec.sidecars[].livenessProbe.exec.command[]

Type
string

.spec.sidecars[].livenessProbe.grpc

Description
GRPC specifies a GRPC HealthCheckRequest.
Type
object
Required
port
PropertyTypeDescription
portinteger

Port number of the gRPC service. Number must be in the range 1 to 65535.

servicestring

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.

.spec.sidecars[].livenessProbe.httpGet

Description
HTTPGet specifies an HTTP GET request to perform.
Type
object
Required
port
PropertyTypeDescription
hoststring

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

httpHeadersarray

Custom headers to set in the request. HTTP allows repeated headers.

pathstring

Path to access on the HTTP server.

port

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

schemestring

Scheme to use for connecting to the host. Defaults to HTTP.

.spec.sidecars[].livenessProbe.httpGet.httpHeaders

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array

.spec.sidecars[].livenessProbe.httpGet.httpHeaders[]

Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
namevalue
PropertyTypeDescription
namestring

The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

valuestring

The header field value

.spec.sidecars[].livenessProbe.tcpSocket

Description
TCPSocket specifies a connection to a TCP port.
Type
object
Required
port
PropertyTypeDescription
hoststring

Optional: Host name to connect to, defaults to the pod IP.

port

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

.spec.sidecars[].ports

Description
List of ports to expose from the Sidecar. 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.
Type
array

.spec.sidecars[].ports[]

Description
ContainerPort represents a network port in a single container.
Type
object
Required
containerPort
PropertyTypeDescription
containerPortinteger

Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.

hostIPstring

What host IP to bind the external port to.

hostPortinteger

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.

namestring

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.

protocolstring

Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".

.spec.sidecars[].readinessProbe

Description
Periodic probe of Sidecar service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Type
object
PropertyTypeDescription
execobject

Exec specifies a command to execute in the container.

failureThresholdinteger

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

grpcobject

GRPC specifies a GRPC HealthCheckRequest.

httpGetobject

HTTPGet specifies an HTTP GET request to perform.

initialDelaySecondsinteger

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

periodSecondsinteger

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

successThresholdinteger

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.

tcpSocketobject

TCPSocket specifies a connection to a TCP port.

terminationGracePeriodSecondsinteger

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.

timeoutSecondsinteger

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

.spec.sidecars[].readinessProbe.exec

Description
Exec specifies a command to execute in the container.
Type
object
PropertyTypeDescription
commandarray

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.

.spec.sidecars[].readinessProbe.exec.command

Description
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.
Type
array

.spec.sidecars[].readinessProbe.exec.command[]

Type
string

.spec.sidecars[].readinessProbe.grpc

Description
GRPC specifies a GRPC HealthCheckRequest.
Type
object
Required
port
PropertyTypeDescription
portinteger

Port number of the gRPC service. Number must be in the range 1 to 65535.

servicestring

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.

.spec.sidecars[].readinessProbe.httpGet

Description
HTTPGet specifies an HTTP GET request to perform.
Type
object
Required
port
PropertyTypeDescription
hoststring

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

httpHeadersarray

Custom headers to set in the request. HTTP allows repeated headers.

pathstring

Path to access on the HTTP server.

port

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

schemestring

Scheme to use for connecting to the host. Defaults to HTTP.

.spec.sidecars[].readinessProbe.httpGet.httpHeaders

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array

.spec.sidecars[].readinessProbe.httpGet.httpHeaders[]

Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
namevalue
PropertyTypeDescription
namestring

The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

valuestring

The header field value

.spec.sidecars[].readinessProbe.tcpSocket

Description
TCPSocket specifies a connection to a TCP port.
Type
object
Required
port
PropertyTypeDescription
hoststring

Optional: Host name to connect to, defaults to the pod IP.

port

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

.spec.sidecars[].securityContext

Description
SecurityContext defines the security options the Sidecar should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
Type
object
PropertyTypeDescription
allowPrivilegeEscalationboolean

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

appArmorProfile is the AppArmor options to use by this container. If set, this profile overrides the pod's appArmorProfile. Note that this field cannot be set when spec.os.name is windows.

capabilitiesobject

The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.

privilegedboolean

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.

procMountstring

procMount denotes the type of proc mount to use for the containers. The default value is Default which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.

readOnlyRootFilesystemboolean

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.

runAsGroupinteger

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.

runAsNonRootboolean

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.

runAsUserinteger

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.

seLinuxOptionsobject

The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.

seccompProfileobject

The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.

windowsOptionsobject

The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.

.spec.sidecars[].securityContext.appArmorProfile

Description
appArmorProfile is the AppArmor options to use by this container. If set, this profile overrides the pod's appArmorProfile. Note that this field cannot be set when spec.os.name is windows.
Type
object
Required
type
PropertyTypeDescription
localhostProfilestring

localhostProfile indicates a profile loaded on the node that should be used. The profile must be preconfigured on the node to work. Must match the loaded name of the profile. Must be set if and only if type is "Localhost".

typestring

type indicates which kind of AppArmor profile will be applied. Valid options are: Localhost - a profile pre-loaded on the node. RuntimeDefault - the container runtime's default profile. Unconfined - no AppArmor enforcement.

.spec.sidecars[].securityContext.capabilities

Description
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.
Type
object
PropertyTypeDescription
addarray

Added capabilities

droparray

Removed capabilities

.spec.sidecars[].securityContext.capabilities.add

Description
Added capabilities
Type
array

.spec.sidecars[].securityContext.capabilities.add[]

Description
Capability represent POSIX capabilities type
Type
string

.spec.sidecars[].securityContext.capabilities.drop

Description
Removed capabilities
Type
array

.spec.sidecars[].securityContext.capabilities.drop[]

Description
Capability represent POSIX capabilities type
Type
string

.spec.sidecars[].securityContext.seLinuxOptions

Description
The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
Type
object
PropertyTypeDescription
levelstring

Level is SELinux level label that applies to the container.

rolestring

Role is a SELinux role label that applies to the container.

typestring

Type is a SELinux type label that applies to the container.

userstring

User is a SELinux user label that applies to the container.

.spec.sidecars[].securityContext.seccompProfile

Description
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.
Type
object
Required
type
PropertyTypeDescription
localhostProfilestring

localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type.

typestring

type indicates which kind of seccomp profile will be applied. Valid options are:

Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.

.spec.sidecars[].securityContext.windowsOptions

Description
The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
Type
object
PropertyTypeDescription
gmsaCredentialSpecstring

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.

gmsaCredentialSpecNamestring

GMSACredentialSpecName is the name of the GMSA credential spec to use.

hostProcessboolean

HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.

runAsUserNamestring

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.

.spec.sidecars[].startupProbe

Description
StartupProbe indicates that the Pod the Sidecar is running in has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Type
object
PropertyTypeDescription
execobject

Exec specifies a command to execute in the container.

failureThresholdinteger

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

grpcobject

GRPC specifies a GRPC HealthCheckRequest.

httpGetobject

HTTPGet specifies an HTTP GET request to perform.

initialDelaySecondsinteger

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

periodSecondsinteger

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

successThresholdinteger

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.

tcpSocketobject

TCPSocket specifies a connection to a TCP port.

terminationGracePeriodSecondsinteger

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.

timeoutSecondsinteger

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

.spec.sidecars[].startupProbe.exec

Description
Exec specifies a command to execute in the container.
Type
object
PropertyTypeDescription
commandarray

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.

.spec.sidecars[].startupProbe.exec.command

Description
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.
Type
array

.spec.sidecars[].startupProbe.exec.command[]

Type
string

.spec.sidecars[].startupProbe.grpc

Description
GRPC specifies a GRPC HealthCheckRequest.
Type
object
Required
port
PropertyTypeDescription
portinteger

Port number of the gRPC service. Number must be in the range 1 to 65535.

servicestring

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.

.spec.sidecars[].startupProbe.httpGet

Description
HTTPGet specifies an HTTP GET request to perform.
Type
object
Required
port
PropertyTypeDescription
hoststring

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

httpHeadersarray

Custom headers to set in the request. HTTP allows repeated headers.

pathstring

Path to access on the HTTP server.

port

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

schemestring

Scheme to use for connecting to the host. Defaults to HTTP.

.spec.sidecars[].startupProbe.httpGet.httpHeaders

Description
Custom headers to set in the request. HTTP allows repeated headers.
Type
array

.spec.sidecars[].startupProbe.httpGet.httpHeaders[]

Description
HTTPHeader describes a custom header to be used in HTTP probes
Type
object
Required
namevalue
PropertyTypeDescription
namestring

The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

valuestring

The header field value

.spec.sidecars[].startupProbe.tcpSocket

Description
TCPSocket specifies a connection to a TCP port.
Type
object
Required
port
PropertyTypeDescription
hoststring

Optional: Host name to connect to, defaults to the pod IP.

port

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

.spec.sidecars[].volumeDevices

Description
volumeDevices is the list of block devices to be used by the Sidecar.
Type
array

.spec.sidecars[].volumeDevices[]

Description
volumeDevice describes a mapping of a raw block device within a container.
Type
object
Required
devicePathname
PropertyTypeDescription
devicePathstring

devicePath is the path inside of the container that the device will be mapped to.

namestring

name must match the name of a persistentVolumeClaim in the pod

.spec.sidecars[].volumeMounts

Description
Volumes to mount into the Sidecar's filesystem. Cannot be updated.
Type
array

.spec.sidecars[].volumeMounts[]

Description
VolumeMount describes a mounting of a Volume within a container.
Type
object
Required
mountPathname
PropertyTypeDescription
mountPathstring

Path within the container at which the volume should be mounted. Must not contain ':'.

mountPropagationstring

mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified (which defaults to None).

namestring

This must match the Name of a Volume.

readOnlyboolean

Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

recursiveReadOnlystring

RecursiveReadOnly specifies whether read-only mounts should be handled recursively.

If ReadOnly is false, this field has no meaning and must be unspecified.

If ReadOnly is true, and this field is set to Disabled, the mount is not made recursively read-only. If this field is set to IfPossible, the mount is made recursively read-only, if it is supported by the container runtime. If this field is set to Enabled, the mount is made recursively read-only if it is supported by the container runtime, otherwise the pod will not be started and an error will be generated to indicate the reason.

If this field is set to IfPossible or Enabled, MountPropagation must be set to None (or be unspecified, which defaults to None).

If this field is not specified, it is treated as an equivalent of Disabled.

subPathstring

Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

subPathExprstring

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.

.spec.sidecars[].workspaces

Description
This is an alpha field. You must set the "enable-api-fields" feature flag to "alpha" for this field to be supported. Workspaces is a list of workspaces from the Task that this Sidecar wants exclusive access to. Adding a workspace to this list means that any other Step or Sidecar that does not also request this Workspace will not have access to it.
Type
array

.spec.sidecars[].workspaces[]

Description
WorkspaceUsage is used by a Step or Sidecar to declare that it wants isolated access to a Workspace defined in a Task.
Type
object
Required
mountPathname
PropertyTypeDescription
mountPathstring

MountPath is the path that the workspace should be mounted to inside the Step or Sidecar, overriding any MountPath specified in the Task's WorkspaceDeclaration.

namestring

Name is the name of the workspace this Step or Sidecar wants access to.

.spec.stepTemplate

Description
StepTemplate can be used as the basis for all step containers within the Task, so that the steps inherit settings on the base container.
Type
object
PropertyTypeDescription
argsarray

Arguments to the entrypoint. The image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the Step'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

commandarray

Entrypoint array. Not executed within a shell. The image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the Step'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

computeResourcesobject

ComputeResources required by this Step. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

envarray

List of environment variables to set in the Step. Cannot be updated.

envFromarray

List of sources to populate environment variables in the Step. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the Step 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.

imagestring

Image reference name. More info: https://kubernetes.io/docs/concepts/containers/images

imagePullPolicystring

Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images

securityContextobject

SecurityContext defines the security options the Step should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

volumeDevicesarray

volumeDevices is the list of block devices to be used by the Step.

volumeMountsarray

Volumes to mount into the Step's filesystem. Cannot be updated.

workingDirstring

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

.spec.stepTemplate.args

Description
Arguments to the entrypoint. The image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the Step'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
Type
array

.spec.stepTemplate.args[]

Type
string

.spec.stepTemplate.command

Description
Entrypoint array. Not executed within a shell. The image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the Step'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
Type
array

.spec.stepTemplate.command[]

Type
string

.spec.stepTemplate.computeResources

Description
ComputeResources required by this Step. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
Type
object
PropertyTypeDescription
claimsarray

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

limitsobject

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

requestsobject

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

.spec.stepTemplate.computeResources.claims

Description
Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
Type
array

.spec.stepTemplate.computeResources.claims[]

Description
ResourceClaim references one entry in PodSpec.ResourceClaims.
Type
object
Required
name
PropertyTypeDescription
namestring

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

requeststring

Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.

.spec.stepTemplate.computeResources.limits

Description
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
Type
object

.spec.stepTemplate.computeResources.requests

Description
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
Type
object

.spec.stepTemplate.env

Description
List of environment variables to set in the Step. Cannot be updated.
Type
array

.spec.stepTemplate.env[]

Description
EnvVar represents an environment variable present in a Container.
Type
object
Required
name
PropertyTypeDescription
namestring

Name of the environment variable. Must be a C_IDENTIFIER.

valuestring

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

valueFromobject

Source for the environment variable's value. Cannot be used if value is not empty.

.spec.stepTemplate.env[].valueFrom

Description
Source for the environment variable's value. Cannot be used if value is not empty.
Type
object
PropertyTypeDescription
configMapKeyRefobject

Selects a key of a ConfigMap.

fieldRefobject

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.

resourceFieldRefobject

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.

secretKeyRefobject

Selects a key of a secret in the pod's namespace

.spec.stepTemplate.env[].valueFrom.configMapKeyRef

Description
Selects a key of a ConfigMap.
Type
object
Required
key
PropertyTypeDescription
keystring

The key to select.

namestring

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

optionalboolean

Specify whether the ConfigMap or its key must be defined

.spec.stepTemplate.env[].valueFrom.fieldRef

Description
Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
Type
object
Required
fieldPath
PropertyTypeDescription
apiVersionstring

Version of the schema the FieldPath is written in terms of, defaults to "v1".

fieldPathstring

Path of the field to select in the specified API version.

.spec.stepTemplate.env[].valueFrom.resourceFieldRef

Description
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
Type
object
Required
resource
PropertyTypeDescription
containerNamestring

Container name: required for volumes, optional for env vars

divisor

Specifies the output format of the exposed resources, defaults to "1"

resourcestring

Required: resource to select

.spec.stepTemplate.env[].valueFrom.secretKeyRef

Description
Selects a key of a secret in the pod's namespace
Type
object
Required
key
PropertyTypeDescription
keystring

The key of the secret to select from. Must be a valid secret key.

namestring

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

optionalboolean

Specify whether the Secret or its key must be defined

.spec.stepTemplate.envFrom

Description
List of sources to populate environment variables in the Step. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the Step 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.
Type
array

.spec.stepTemplate.envFrom[]

Description
EnvFromSource represents the source of a set of ConfigMaps
Type
object
PropertyTypeDescription
configMapRefobject

The ConfigMap to select from

prefixstring

An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.

secretRefobject

The Secret to select from

.spec.stepTemplate.envFrom[].configMapRef

Description
The ConfigMap to select from
Type
object
PropertyTypeDescription
namestring

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

optionalboolean

Specify whether the ConfigMap must be defined

.spec.stepTemplate.envFrom[].secretRef

Description
The Secret to select from
Type
object
PropertyTypeDescription
namestring

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

optionalboolean

Specify whether the Secret must be defined

.spec.stepTemplate.securityContext

Description
SecurityContext defines the security options the Step should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
Type
object
PropertyTypeDescription
allowPrivilegeEscalationboolean

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

appArmorProfile is the AppArmor options to use by this container. If set, this profile overrides the pod's appArmorProfile. Note that this field cannot be set when spec.os.name is windows.

capabilitiesobject

The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.

privilegedboolean

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.

procMountstring

procMount denotes the type of proc mount to use for the containers. The default value is Default which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.

readOnlyRootFilesystemboolean

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.

runAsGroupinteger

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.

runAsNonRootboolean

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.

runAsUserinteger

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.

seLinuxOptionsobject

The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.

seccompProfileobject

The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.

windowsOptionsobject

The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.

.spec.stepTemplate.securityContext.appArmorProfile

Description
appArmorProfile is the AppArmor options to use by this container. If set, this profile overrides the pod's appArmorProfile. Note that this field cannot be set when spec.os.name is windows.
Type
object
Required
type
PropertyTypeDescription
localhostProfilestring

localhostProfile indicates a profile loaded on the node that should be used. The profile must be preconfigured on the node to work. Must match the loaded name of the profile. Must be set if and only if type is "Localhost".

typestring

type indicates which kind of AppArmor profile will be applied. Valid options are: Localhost - a profile pre-loaded on the node. RuntimeDefault - the container runtime's default profile. Unconfined - no AppArmor enforcement.

.spec.stepTemplate.securityContext.capabilities

Description
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.
Type
object
PropertyTypeDescription
addarray

Added capabilities

droparray

Removed capabilities

.spec.stepTemplate.securityContext.capabilities.add

Description
Added capabilities
Type
array

.spec.stepTemplate.securityContext.capabilities.add[]

Description
Capability represent POSIX capabilities type
Type
string

.spec.stepTemplate.securityContext.capabilities.drop

Description
Removed capabilities
Type
array

.spec.stepTemplate.securityContext.capabilities.drop[]

Description
Capability represent POSIX capabilities type
Type
string

.spec.stepTemplate.securityContext.seLinuxOptions

Description
The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
Type
object
PropertyTypeDescription
levelstring

Level is SELinux level label that applies to the container.

rolestring

Role is a SELinux role label that applies to the container.

typestring

Type is a SELinux type label that applies to the container.

userstring

User is a SELinux user label that applies to the container.

.spec.stepTemplate.securityContext.seccompProfile

Description
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.
Type
object
Required
type
PropertyTypeDescription
localhostProfilestring

localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type.

typestring

type indicates which kind of seccomp profile will be applied. Valid options are:

Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.

.spec.stepTemplate.securityContext.windowsOptions

Description
The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
Type
object
PropertyTypeDescription
gmsaCredentialSpecstring

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.

gmsaCredentialSpecNamestring

GMSACredentialSpecName is the name of the GMSA credential spec to use.

hostProcessboolean

HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.

runAsUserNamestring

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.

.spec.stepTemplate.volumeDevices

Description
volumeDevices is the list of block devices to be used by the Step.
Type
array

.spec.stepTemplate.volumeDevices[]

Description
volumeDevice describes a mapping of a raw block device within a container.
Type
object
Required
devicePathname
PropertyTypeDescription
devicePathstring

devicePath is the path inside of the container that the device will be mapped to.

namestring

name must match the name of a persistentVolumeClaim in the pod

.spec.stepTemplate.volumeMounts

Description
Volumes to mount into the Step's filesystem. Cannot be updated.
Type
array

.spec.stepTemplate.volumeMounts[]

Description
VolumeMount describes a mounting of a Volume within a container.
Type
object
Required
mountPathname
PropertyTypeDescription
mountPathstring

Path within the container at which the volume should be mounted. Must not contain ':'.

mountPropagationstring

mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified (which defaults to None).

namestring

This must match the Name of a Volume.

readOnlyboolean

Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

recursiveReadOnlystring

RecursiveReadOnly specifies whether read-only mounts should be handled recursively.

If ReadOnly is false, this field has no meaning and must be unspecified.

If ReadOnly is true, and this field is set to Disabled, the mount is not made recursively read-only. If this field is set to IfPossible, the mount is made recursively read-only, if it is supported by the container runtime. If this field is set to Enabled, the mount is made recursively read-only if it is supported by the container runtime, otherwise the pod will not be started and an error will be generated to indicate the reason.

If this field is set to IfPossible or Enabled, MountPropagation must be set to None (or be unspecified, which defaults to None).

If this field is not specified, it is treated as an equivalent of Disabled.

subPathstring

Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

subPathExprstring

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.

.spec.steps

Description
Steps are the steps of the build; each step is run sequentially with the source mounted into /workspace.
Type
array

.spec.steps[]

Description
Step runs a subcomponent of a Task
Type
object
Required
name
PropertyTypeDescription
argsarray

Arguments to the entrypoint. The 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

commandarray

Entrypoint array. Not executed within a shell. The 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

computeResourcesobject

ComputeResources required by this Step. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

envarray

List of environment variables to set in the Step. Cannot be updated.

envFromarray

List of sources to populate environment variables in the Step. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the Step 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.

imagestring

OCI image name. More info: https://kubernetes.io/docs/concepts/containers/images

imagePullPolicystring

Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images

namestring

Name of the Step specified as a DNS_LABEL. Each Step in a Task must have a unique name.

onErrorstring

OnError defines the exiting behavior of a container on error can be set to [ continue | stopAndFail ]

paramsarray

Params declares parameters passed to this step action.

refobject

Contains the reference to an existing StepAction.

resultsarray

Results declares StepResults produced by the Step.

It can be used in an inlined Step when used to store Results to $(step.results.resultName.path). It cannot be used when referencing StepActions using [v1.Step.Ref]. The Results declared by the StepActions will be stored here instead.

scriptstring

Script is the contents of an executable file to execute.

If Script is not empty, the Step cannot have an Command and the Args will be passed to the Script.

securityContextobject

SecurityContext defines the security options the Step should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

stderrConfigobject

Stores configuration for the stderr stream of the step.

stdoutConfigobject

Stores configuration for the stdout stream of the step.

timeoutstring

Timeout is the time after which the step times out. Defaults to never. Refer to Go's ParseDuration documentation for expected format: https://golang.org/pkg/time/#ParseDuration

volumeDevicesarray

volumeDevices is the list of block devices to be used by the Step.

volumeMountsarray

Volumes to mount into the Step's filesystem. Cannot be updated.

whenarray

When is a list of when expressions that need to be true for the task to run

workingDirstring

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

workspacesarray

This is an alpha field. You must set the "enable-api-fields" feature flag to "alpha" for this field to be supported.

Workspaces is a list of workspaces from the Task that this Step wants exclusive access to. Adding a workspace to this list means that any other Step or Sidecar that does not also request this Workspace will not have access to it.

.spec.steps[].args

Description
Arguments to the entrypoint. The 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
Type
array

.spec.steps[].args[]

Type
string

.spec.steps[].command

Description
Entrypoint array. Not executed within a shell. The 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
Type
array

.spec.steps[].command[]

Type
string

.spec.steps[].computeResources

Description
ComputeResources required by this Step. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
Type
object
PropertyTypeDescription
claimsarray

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

limitsobject

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

requestsobject

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

.spec.steps[].computeResources.claims

Description
Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
Type
array

.spec.steps[].computeResources.claims[]

Description
ResourceClaim references one entry in PodSpec.ResourceClaims.
Type
object
Required
name
PropertyTypeDescription
namestring

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

requeststring

Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.

.spec.steps[].computeResources.limits

Description
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
Type
object

.spec.steps[].computeResources.requests

Description
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
Type
object

.spec.steps[].env

Description
List of environment variables to set in the Step. Cannot be updated.
Type
array

.spec.steps[].env[]

Description
EnvVar represents an environment variable present in a Container.
Type
object
Required
name
PropertyTypeDescription
namestring

Name of the environment variable. Must be a C_IDENTIFIER.

valuestring

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

valueFromobject

Source for the environment variable's value. Cannot be used if value is not empty.

.spec.steps[].env[].valueFrom

Description
Source for the environment variable's value. Cannot be used if value is not empty.
Type
object
PropertyTypeDescription
configMapKeyRefobject

Selects a key of a ConfigMap.

fieldRefobject

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.

resourceFieldRefobject

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.

secretKeyRefobject

Selects a key of a secret in the pod's namespace

.spec.steps[].env[].valueFrom.configMapKeyRef

Description
Selects a key of a ConfigMap.
Type
object
Required
key
PropertyTypeDescription
keystring

The key to select.

namestring

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

optionalboolean

Specify whether the ConfigMap or its key must be defined

.spec.steps[].env[].valueFrom.fieldRef

Description
Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
Type
object
Required
fieldPath
PropertyTypeDescription
apiVersionstring

Version of the schema the FieldPath is written in terms of, defaults to "v1".

fieldPathstring

Path of the field to select in the specified API version.

.spec.steps[].env[].valueFrom.resourceFieldRef

Description
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
Type
object
Required
resource
PropertyTypeDescription
containerNamestring

Container name: required for volumes, optional for env vars

divisor

Specifies the output format of the exposed resources, defaults to "1"

resourcestring

Required: resource to select

.spec.steps[].env[].valueFrom.secretKeyRef

Description
Selects a key of a secret in the pod's namespace
Type
object
Required
key
PropertyTypeDescription
keystring

The key of the secret to select from. Must be a valid secret key.

namestring

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

optionalboolean

Specify whether the Secret or its key must be defined

.spec.steps[].envFrom

Description
List of sources to populate environment variables in the Step. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the Step 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.
Type
array

.spec.steps[].envFrom[]

Description
EnvFromSource represents the source of a set of ConfigMaps
Type
object
PropertyTypeDescription
configMapRefobject

The ConfigMap to select from

prefixstring

An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.

secretRefobject

The Secret to select from

.spec.steps[].envFrom[].configMapRef

Description
The ConfigMap to select from
Type
object
PropertyTypeDescription
namestring

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

optionalboolean

Specify whether the ConfigMap must be defined

.spec.steps[].envFrom[].secretRef

Description
The Secret to select from
Type
object
PropertyTypeDescription
namestring

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

optionalboolean

Specify whether the Secret must be defined

.spec.steps[].params

Description
Params declares parameters passed to this step action.
Type
array

.spec.steps[].params[]

Description
Param declares an ParamValues to use for the parameter called name.
Type
object
Required
namevalue
PropertyTypeDescription
namestring
value

.spec.steps[].ref

Description
Contains the reference to an existing StepAction.
Type
object
PropertyTypeDescription
namestring

Name of the referenced step

paramsarray

Params contains the parameters used to identify the referenced Tekton resource. Example entries might include "repo" or "path" but the set of params ultimately depends on the chosen resolver.

resolverstring

Resolver is the name of the resolver that should perform resolution of the referenced Tekton resource, such as "git".

.spec.steps[].ref.params

Description
Params contains the parameters used to identify the referenced Tekton resource. Example entries might include "repo" or "path" but the set of params ultimately depends on the chosen resolver.
Type
array

.spec.steps[].ref.params[]

Description
Param declares an ParamValues to use for the parameter called name.
Type
object
Required
namevalue
PropertyTypeDescription
namestring
value

.spec.steps[].results

Description
Results declares StepResults produced by the Step. It can be used in an inlined Step when used to store Results to $(step.results.resultName.path). It cannot be used when referencing StepActions using [v1.Step.Ref]. The Results declared by the StepActions will be stored here instead.
Type
array

.spec.steps[].results[]

Description
StepResult used to describe the Results of a Step.
Type
object
Required
name
PropertyTypeDescription
descriptionstring

Description is a human-readable description of the result

namestring

Name the given name

propertiesobject

Properties is the JSON Schema properties to support key-value pairs results.

typestring

The possible types are 'string', 'array', and 'object', with 'string' as the default.

.spec.steps[].results[].properties

Description
Properties is the JSON Schema properties to support key-value pairs results.
Type
object

.spec.steps[].securityContext

Description
SecurityContext defines the security options the Step should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
Type
object
PropertyTypeDescription
allowPrivilegeEscalationboolean

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

appArmorProfile is the AppArmor options to use by this container. If set, this profile overrides the pod's appArmorProfile. Note that this field cannot be set when spec.os.name is windows.

capabilitiesobject

The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.

privilegedboolean

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.

procMountstring

procMount denotes the type of proc mount to use for the containers. The default value is Default which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.

readOnlyRootFilesystemboolean

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.

runAsGroupinteger

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.

runAsNonRootboolean

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.

runAsUserinteger

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.

seLinuxOptionsobject

The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.

seccompProfileobject

The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.

windowsOptionsobject

The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.

.spec.steps[].securityContext.appArmorProfile

Description
appArmorProfile is the AppArmor options to use by this container. If set, this profile overrides the pod's appArmorProfile. Note that this field cannot be set when spec.os.name is windows.
Type
object
Required
type
PropertyTypeDescription
localhostProfilestring

localhostProfile indicates a profile loaded on the node that should be used. The profile must be preconfigured on the node to work. Must match the loaded name of the profile. Must be set if and only if type is "Localhost".

typestring

type indicates which kind of AppArmor profile will be applied. Valid options are: Localhost - a profile pre-loaded on the node. RuntimeDefault - the container runtime's default profile. Unconfined - no AppArmor enforcement.

.spec.steps[].securityContext.capabilities

Description
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.
Type
object
PropertyTypeDescription
addarray

Added capabilities

droparray

Removed capabilities

.spec.steps[].securityContext.capabilities.add

Description
Added capabilities
Type
array

.spec.steps[].securityContext.capabilities.add[]

Description
Capability represent POSIX capabilities type
Type
string

.spec.steps[].securityContext.capabilities.drop

Description
Removed capabilities
Type
array

.spec.steps[].securityContext.capabilities.drop[]

Description
Capability represent POSIX capabilities type
Type
string

.spec.steps[].securityContext.seLinuxOptions

Description
The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
Type
object
PropertyTypeDescription
levelstring

Level is SELinux level label that applies to the container.

rolestring

Role is a SELinux role label that applies to the container.

typestring

Type is a SELinux type label that applies to the container.

userstring

User is a SELinux user label that applies to the container.

.spec.steps[].securityContext.seccompProfile

Description
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.
Type
object
Required
type
PropertyTypeDescription
localhostProfilestring

localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type.

typestring

type indicates which kind of seccomp profile will be applied. Valid options are:

Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.

.spec.steps[].securityContext.windowsOptions

Description
The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
Type
object
PropertyTypeDescription
gmsaCredentialSpecstring

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.

gmsaCredentialSpecNamestring

GMSACredentialSpecName is the name of the GMSA credential spec to use.

hostProcessboolean

HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.

runAsUserNamestring

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.

.spec.steps[].stderrConfig

Description
Stores configuration for the stderr stream of the step.
Type
object
PropertyTypeDescription
pathstring

Path to duplicate stdout stream to on container's local filesystem.

.spec.steps[].stdoutConfig

Description
Stores configuration for the stdout stream of the step.
Type
object
PropertyTypeDescription
pathstring

Path to duplicate stdout stream to on container's local filesystem.

.spec.steps[].volumeDevices

Description
volumeDevices is the list of block devices to be used by the Step.
Type
array

.spec.steps[].volumeDevices[]

Description
volumeDevice describes a mapping of a raw block device within a container.
Type
object
Required
devicePathname
PropertyTypeDescription
devicePathstring

devicePath is the path inside of the container that the device will be mapped to.

namestring

name must match the name of a persistentVolumeClaim in the pod

.spec.steps[].volumeMounts

Description
Volumes to mount into the Step's filesystem. Cannot be updated.
Type
array

.spec.steps[].volumeMounts[]

Description
VolumeMount describes a mounting of a Volume within a container.
Type
object
Required
mountPathname
PropertyTypeDescription
mountPathstring

Path within the container at which the volume should be mounted. Must not contain ':'.

mountPropagationstring

mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified (which defaults to None).

namestring

This must match the Name of a Volume.

readOnlyboolean

Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

recursiveReadOnlystring

RecursiveReadOnly specifies whether read-only mounts should be handled recursively.

If ReadOnly is false, this field has no meaning and must be unspecified.

If ReadOnly is true, and this field is set to Disabled, the mount is not made recursively read-only. If this field is set to IfPossible, the mount is made recursively read-only, if it is supported by the container runtime. If this field is set to Enabled, the mount is made recursively read-only if it is supported by the container runtime, otherwise the pod will not be started and an error will be generated to indicate the reason.

If this field is set to IfPossible or Enabled, MountPropagation must be set to None (or be unspecified, which defaults to None).

If this field is not specified, it is treated as an equivalent of Disabled.

subPathstring

Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

subPathExprstring

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.

.spec.steps[].when

Description
When is a list of when expressions that need to be true for the task to run
Type
array

.spec.steps[].when[]

Description
WhenExpression allows a PipelineTask to declare expressions to be evaluated before the Task is run to determine whether the Task should be executed or skipped
Type
object
PropertyTypeDescription
celstring

CEL is a string of Common Language Expression, which can be used to conditionally execute the task based on the result of the expression evaluation More info about CEL syntax: https://github.com/google/cel-spec/blob/master/doc/langdef.md

inputstring

Input is the string for guard checking which can be a static input or an output from a parent Task

operatorstring

Operator that represents an Input's relationship to the values

valuesarray

Values is an array of strings, which is compared against the input, for guard checking It must be non-empty

.spec.steps[].when[].values

Description
Values is an array of strings, which is compared against the input, for guard checking It must be non-empty
Type
array

.spec.steps[].when[].values[]

Type
string

.spec.steps[].workspaces

Description
This is an alpha field. You must set the "enable-api-fields" feature flag to "alpha" for this field to be supported. Workspaces is a list of workspaces from the Task that this Step wants exclusive access to. Adding a workspace to this list means that any other Step or Sidecar that does not also request this Workspace will not have access to it.
Type
array

.spec.steps[].workspaces[]

Description
WorkspaceUsage is used by a Step or Sidecar to declare that it wants isolated access to a Workspace defined in a Task.
Type
object
Required
mountPathname
PropertyTypeDescription
mountPathstring

MountPath is the path that the workspace should be mounted to inside the Step or Sidecar, overriding any MountPath specified in the Task's WorkspaceDeclaration.

namestring

Name is the name of the workspace this Step or Sidecar wants access to.

.spec.workspaces

Description
Workspaces are the volumes that this Task requires.
Type
array

.spec.workspaces[]

Description
WorkspaceDeclaration is a declaration of a volume that a Task requires.
Type
object
Required
name
PropertyTypeDescription
descriptionstring

Description is an optional human readable description of this volume.

mountPathstring

MountPath overrides the directory that the volume will be made available at.

namestring

Name is the name by which you can bind the volume at runtime.

optionalboolean

Optional marks a Workspace as not being required in TaskRuns. By default this field is false and so declared workspaces are required.

readOnlyboolean

ReadOnly dictates whether a mounted volume is writable. By default this field is false and so mounted volumes are writable.

API Endpoints

The following API endpoints are available:

  • /apis/tekton.dev/v1/namespaces/{namespace}/tasks
    • DELETE: delete collection of Task
    • GET: list objects of kind Task
    • POST: create a new Task
  • /apis/tekton.dev/v1/namespaces/{namespace}/tasks/{name}
    • DELETE: delete the specified Task
    • GET: read the specified Task
    • PATCH: partially update the specified Task
    • PUT: replace the specified Task

/apis/tekton.dev/v1/namespaces/{namespace}/tasks

HTTP method
DELETE
Description
delete collection of Task
HTTP responses
HTTP codeResponse body
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
list objects of kind Task
HTTP responses
HTTP codeResponse body
200 - OKTaskList schema
401 - UnauthorizedEmpty
HTTP method
POST
Description
create a new Task
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Body parameters
ParameterTypeDescription
bodyTask schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKTask schema
201 - CreatedTask schema
202 - AcceptedTask schema
401 - UnauthorizedEmpty

/apis/tekton.dev/v1/namespaces/{namespace}/tasks/{name}

HTTP method
DELETE
Description
delete the specified Task
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
HTTP responses
HTTP codeResponse body
200 - OKStatus schema
202 - AcceptedStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
read the specified Task
HTTP responses
HTTP codeResponse body
200 - OKTask schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update the specified Task
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
HTTP responses
HTTP codeResponse body
200 - OKTask schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace the specified Task
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Body parameters
ParameterTypeDescription
bodyTask schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKTask schema
201 - CreatedTask schema
401 - UnauthorizedEmpty