PipelineRun

A PipelineRun represents a single execution of a Pipeline. PipelineRuns instantiate Pipelines and create TaskRuns for each task in the pipeline.

Resource Definition

apiVersion

string

required

tekton.dev/v1

kind

string

required

PipelineRun

metadata

ObjectMeta

required

Standard Kubernetes metadata.

spec

PipelineRunSpec

required

Defines the desired state of the PipelineRun.

status

PipelineRunStatus

Defines the observed state of the PipelineRun.

PipelineRunSpec

pipelineRef

PipelineRef

Reference to the Pipeline to execute. Mutually exclusive with pipelineSpec.

Show PipelineRef fields

name

string

Name of the Pipeline in the same namespace.

resolver

string

Name of the resolver for remote resolution.

params

[]Param

Parameters for remote resolution.

pipelineSpec

PipelineSpec

Inline Pipeline specification. Mutually exclusive with pipelineRef.Can be disabled with the disable-inline-spec feature flag.

params

[]Param

Parameters to pass to the Pipeline.See Parameter Types for details.

workspaces

[]WorkspaceBinding

Workspace bindings for the Pipeline.See Workspace Types for details.

timeouts

TimeoutFields

Timeout configuration for the PipelineRun.

Show TimeoutFields

pipeline

Duration

Maximum duration for the entire pipeline. Defaults to 1 hour.

tasks

Duration

Maximum duration for all tasks (excluding finally tasks).

finally

Duration

Maximum duration for finally tasks.

Constraint: pipeline ≥ tasks + finally

status

string

Control the execution state of the PipelineRun.Values:

Cancelled - Cancel immediately
CancelledRunFinally - Cancel but run finally tasks
StoppedRunFinally - Stop gracefully and run finally tasks
PipelineRunPending - Hold execution until set to empty string

taskRunTemplate

PipelineTaskRunTemplate

Template configuration applied to all TaskRuns created by this PipelineRun.

Show PipelineTaskRunTemplate fields

serviceAccountName

string

ServiceAccount for all TaskRuns.

podTemplate

PodTemplate

Pod template for all TaskRuns.

taskRunSpecs

[]PipelineTaskRunSpec

Specifications for individual tasks in the pipeline.

Show PipelineTaskRunSpec fields

pipelineTaskName

string

required

Name of the pipeline task to configure.

serviceAccountName

string

ServiceAccount override for this task.

podTemplate

PodTemplate

Pod template override for this task.

computeResources

ResourceRequirements

Compute resource override.

PipelineRunStatus

conditions

[]Condition

Conditions describing the current state.

Show Condition fields

type

string

Primary type: Succeeded

status

string

True, False, or Unknown

reason

string

Reason codes include:

Succeeded - Pipeline completed successfully
Failed - Pipeline failed
Running - Pipeline is executing
Cancelled - Pipeline was cancelled
PipelineRunTimeout - Pipeline timed out

message

string

Human-readable message.

startTime

Time

When the PipelineRun started.

completionTime

Time

When the PipelineRun completed.

finallyStartTime

Time

When finally tasks began executing.

pipelineSpec

PipelineSpec

The resolved Pipeline specification that was executed.

childReferences

[]ChildStatusReference

References to TaskRuns and Runs created by this PipelineRun.

Show ChildStatusReference fields

name

string

Name of the TaskRun or Run.

pipelineTaskName

string

Name of the PipelineTask this references.

displayName

string

User-facing display name.

whenExpressions

[]WhenExpression

When expressions that guarded this task.

results

[]PipelineRunResult

Results produced by the Pipeline.

Show PipelineRunResult fields

name

string

Name of the result as declared by the Pipeline.

value

ResultValue

The actual value produced.

skippedTasks

[]SkippedTask

Tasks that were skipped.

Show SkippedTask fields

name

string

Name of the skipped task.

reason

SkippingReason

Why the task was skipped:

When Expressions evaluated to false
Parent Tasks were skipped
PipelineRun was stopping
Results were missing

Example

apiVersion: tekton.dev/v1
kind: PipelineRun
metadata:
  name: example-pipelinerun
spec:
  pipelineRef:
    name: example-pipeline
  params:
    - name: repo-url
      value: https://github.com/example/repo
  workspaces:
    - name: shared-data
      volumeClaimTemplate:
        spec:
          accessModes:
            - ReadWriteOnce
          resources:
            requests:
              storage: 1Gi
  timeouts:
    pipeline: 1h
    tasks: 50m
    finally: 10m

Overview

v1 Resources

Beta Resources

Common Types

Resource Definition

PipelineRunSpec

PipelineRunStatus

Example

Build docs developers (and LLMs) love

Overview

v1 Resources

Beta Resources

Common Types

​Resource Definition

​PipelineRunSpec

​PipelineRunStatus

​Example

Build docs developers (and LLMs) love

Resource Definition

PipelineRunSpec

PipelineRunStatus

Example