Task

API reference for the Task v1 resource

A Task is a collection of Steps that execute sequentially. Tasks run as a pod on your Kubernetes cluster with each step running in its own container.

Resource Definition

apiVersion · string · required

tekton.dev/v1

kind · string · required

Task

metadata · ObjectMeta · required

Standard Kubernetes metadata including name, namespace, labels, and annotations.

spec · TaskSpec · required

Defines the desired state of the Task.

TaskSpec

description · string

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

displayName · string

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

params · []ParamSpec

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

See Parameter Types for details.

steps · []Step · required

The steps of the task; each step runs sequentially with the source mounted into /workspace.

Show Step fields

name · string · required

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

image · string

Container image name to run for this Step.

command · []string

Entrypoint array. Not executed within a shell. The image’s ENTRYPOINT is used if not provided.

args · []string

Arguments to the entrypoint. The image’s CMD is used if not provided.

script · string

Script is the contents of an executable file to execute. If Script is not empty, the Step cannot have a Command and the Args will be passed to the Script.

workingDir · string

Step’s working directory. If not specified, the container runtime’s default will be used.

env · []EnvVar

List of environment variables to set in the Step.

computeResources · ResourceRequirements

Compute resources required by this Step.

volumeMounts · []VolumeMount

Volumes to mount into the Step’s filesystem.

securityContext · SecurityContext

Security options the Step should run with.

timeout · Duration

Time after which the step times out. Defaults to never.

onError · string

Exiting behavior on error. Values: stopAndFail (default), continue

results · []StepResult

Results declared by this Step.

volumes · []Volume

A collection of volumes available to mount into the steps of the task.

stepTemplate · StepTemplate

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

sidecars · []Sidecar

Containers that run alongside the Task’s step containers. They begin before the steps start and end after the steps complete.

Show Sidecar fields

name · string · required

Name of the Sidecar specified as a DNS_LABEL.

image · string

Container image name.

command · []string

Entrypoint array.

args · []string

Arguments to the entrypoint.

script · string

Script to execute. If Script is not empty, the Sidecar cannot have a Command or Args.

env · []EnvVar

List of environment variables.

securityContext · SecurityContext

Security options the Sidecar should run with.

workspaces · []WorkspaceDeclaration

The volumes that this Task requires.

See Workspace Types for details.

results · []TaskResult

Values that this Task can output.

See Result Types for details.

Example

apiVersion: tekton.dev/v1
kind: Task
metadata:
  name: example-task
spec:
  description: "An example task that echoes a message"
  params:
    - name: message
      type: string
      description: The message to echo
      default: "Hello World"
  steps:
    - name: echo
      image: ubuntu
      script: |
        #!/usr/bin/env bash
        echo "$(params.message)"
  results:
    - name: message-length
      description: The length of the message