Pipeline

API reference for the Pipeline v1 resource

A Pipeline is a collection of Tasks arranged in a specific order of execution. Pipelines express how outputs of tasks feed into inputs of subsequent tasks.

Resource Definition

apiVersion · string · required

tekton.dev/v1

kind · string · required

Pipeline

metadata · ObjectMeta · required

Standard Kubernetes metadata.

spec · PipelineSpec · required

Defines the desired state of the Pipeline.

PipelineSpec

description · string

A user-facing description of the pipeline.

displayName · string

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

params · []ParamSpec

Parameters that must be supplied when running the Pipeline.

See Parameter Types for details.

tasks · []PipelineTask · required

The graph of Tasks that execute when this Pipeline runs.

Show PipelineTask fields

name · string · required

Name of this task within the Pipeline. Used with runAfter to establish execution order.

displayName · string

User-facing name of this task.

description · string

Description of this task.

taskRef · TaskRef

Reference to a Task definition. Mutually exclusive with taskSpec.

taskSpec · TaskSpec

Inline Task specification. Mutually exclusive with taskRef.

runAfter · []string

List of PipelineTask names that should execute before this Task.

params · []Param

Parameters passed to this task.

when · []WhenExpression

Conditions that must be true for the task to run.

See When Expressions for details.

workspaces · []WorkspacePipelineTaskBinding

Maps workspaces from the pipeline to the task.

Show WorkspacePipelineTaskBinding fields

name · string · required

Name of the workspace as declared by the task.

workspace · string

Name of the workspace declared by the pipeline.

subPath · string

Optional subdirectory on the volume.

timeout · Duration

Timeout for this task.

retries · integer

Number of retries on task failure.

onError · string

Behavior on task error:

• stopAndFail - Stop pipeline execution (default)
• continue - Continue executing remaining tasks

finally · []PipelineTask

Tasks that execute after all pipeline tasks finish, regardless of success or failure.

workspaces · []PipelineWorkspaceDeclaration

Workspaces expected to be provided by a PipelineRun.

Show PipelineWorkspaceDeclaration fields

name · string · required

Name of the workspace.

description · string

Description of how the workspace is used.

optional · boolean · default: false

Whether the workspace is optional.

results · []PipelineResult

Values that this pipeline can output.

Show PipelineResult fields

name · string · required

Name of the result.

type · ResultsType

Type of the result: string, array, or object

description · string

Human-readable description.

value · ResultValue · required

Expression to retrieve the value (e.g., $(tasks.taskName.results.resultName))

Example

apiVersion: tekton.dev/v1
kind: Pipeline
metadata:
  name: example-pipeline
spec:
  description: "An example pipeline"
  params:
    - name: repo-url
      type: string
  workspaces:
    - name: shared-data
  tasks:
    - name: fetch-source
      taskRef:
        name: git-clone
      params:
        - name: url
          value: $(params.repo-url)
      workspaces:
        - name: output
          workspace: shared-data
    - name: build
      taskRef:
        name: build-task
      runAfter:
        - fetch-source
      workspaces:
        - name: source
          workspace: shared-data
  finally:
    - name: cleanup
      taskRef:
        name: cleanup-task