pipeline-api.md

Packages:

• resolution.tekton.dev/v1alpha1
• resolution.tekton.dev/v1beta1
• tekton.dev/v1
• tekton.dev/v1alpha1
• tekton.dev/v1beta1

resolution.tekton.dev/v1alpha1

Resource Types:

ResolutionRequest

ResolutionRequest is an object for requesting the content of a Tekton resource like a pipeline.yaml.

Field	Description
metadata Kubernetes meta/v1.ObjectMeta	(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec ResolutionRequestSpec	(Optional) Spec holds the information for the request part of the resource request. params map[string]string (Optional) Parameters are the runtime attributes passed to the resolver to help it figure out how to resolve the resource being requested. For example: repo URL, commit SHA, path to file, the kind of authentication to leverage, etc.
status ResolutionRequestStatus	(Optional) Status communicates the state of the request and, ultimately, the content of the resolved resource.

ResolutionRequestSpec

(Appears on:ResolutionRequest)

ResolutionRequestSpec are all the fields in the spec of the ResolutionRequest CRD.

Field	Description
params map[string]string	(Optional) Parameters are the runtime attributes passed to the resolver to help it figure out how to resolve the resource being requested. For example: repo URL, commit SHA, path to file, the kind of authentication to leverage, etc.

ResolutionRequestStatus

(Appears on:ResolutionRequest)

ResolutionRequestStatus are all the fields in a ResolutionRequest’s status subresource.

Field	Description
Status knative.dev/pkg/apis/duck/v1.Status	(Members of Status are embedded into this type.)
ResolutionRequestStatusFields ResolutionRequestStatusFields	(Members of ResolutionRequestStatusFields are embedded into this type.)

ResolutionRequestStatusFields

(Appears on:ResolutionRequestStatus)

ResolutionRequestStatusFields are the ResolutionRequest-specific fields for the status subresource.

Field	Description
data string	Data is a string representation of the resolved content of the requested resource in-lined into the ResolutionRequest object.
refSource RefSource	RefSource is the source reference of the remote data that records where the remote file came from including the url, digest and the entrypoint.

---

resolution.tekton.dev/v1beta1

Resource Types:

ResolutionRequest

ResolutionRequest is an object for requesting the content of a Tekton resource like a pipeline.yaml.

Field	Description
metadata Kubernetes meta/v1.ObjectMeta	(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec ResolutionRequestSpec	(Optional) Spec holds the information for the request part of the resource request. params []Param (Optional) Parameters are the runtime attributes passed to the resolver to help it figure out how to resolve the resource being requested. For example: repo URL, commit SHA, path to file, the kind of authentication to leverage, etc. url string (Optional) URL is the runtime url passed to the resolver to help it figure out how to resolver the resource being requested. This is currently at an ALPHA stability level and subject to alpha API compatibility policies.
status ResolutionRequestStatus	(Optional) Status communicates the state of the request and, ultimately, the content of the resolved resource.

ResolutionRequestSpec

(Appears on:ResolutionRequest)

ResolutionRequestSpec are all the fields in the spec of the ResolutionRequest CRD.

Field	Description
params []Param	(Optional) Parameters are the runtime attributes passed to the resolver to help it figure out how to resolve the resource being requested. For example: repo URL, commit SHA, path to file, the kind of authentication to leverage, etc.
url string	(Optional) URL is the runtime url passed to the resolver to help it figure out how to resolver the resource being requested. This is currently at an ALPHA stability level and subject to alpha API compatibility policies.

ResolutionRequestStatus

(Appears on:ResolutionRequest)

ResolutionRequestStatus are all the fields in a ResolutionRequest’s status subresource.

Field	Description
Status knative.dev/pkg/apis/duck/v1.Status	(Members of Status are embedded into this type.)
ResolutionRequestStatusFields ResolutionRequestStatusFields	(Members of ResolutionRequestStatusFields are embedded into this type.)

ResolutionRequestStatusFields

(Appears on:ResolutionRequestStatus)

ResolutionRequestStatusFields are the ResolutionRequest-specific fields for the status subresource.

Field	Description
data string	Data is a string representation of the resolved content of the requested resource in-lined into the ResolutionRequest object.
source RefSource	Deprecated: Use RefSource instead
refSource RefSource	RefSource is the source reference of the remote data that records the url, digest and the entrypoint.

---

tekton.dev/v1

Package v1 contains API Schema definitions for the pipeline v1 API group

Resource Types:

• Pipeline
• PipelineRun
• Task
• TaskRun

Pipeline

Pipeline describes a list of Tasks to execute. It expresses how outputs of tasks feed into inputs of subsequent tasks.

Field	Description
apiVersion string	tekton.dev/v1
kind string	Pipeline
metadata Kubernetes meta/v1.ObjectMeta	(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec PipelineSpec	(Optional) Spec holds the desired state of the Pipeline from the client displayName string (Optional) DisplayName is a user-facing name of the pipeline that may be used to populate a UI. description string (Optional) Description is a user-facing description of the pipeline that may be used to populate a UI. tasks []PipelineTask Tasks declares the graph of Tasks that execute when this Pipeline is run. params ParamSpecs Params declares a list of input parameters that must be supplied when this Pipeline is run. workspaces []PipelineWorkspaceDeclaration (Optional) Workspaces declares a set of named workspaces that are expected to be provided by a PipelineRun. results []PipelineResult (Optional) Results are values that this pipeline can output once run finally []PipelineTask Finally declares the list of Tasks that execute just before leaving the Pipeline i.e. either after all Tasks are finished executing successfully or after a failure which would result in ending the Pipeline

PipelineRun

PipelineRun represents a single execution of a Pipeline. PipelineRuns are how the graph of Tasks declared in a Pipeline are executed; they specify inputs to Pipelines such as parameter values and capture operational aspects of the Tasks execution such as service account and tolerations. Creating a PipelineRun creates TaskRuns for Tasks in the referenced Pipeline.

Field	Description
apiVersion string	tekton.dev/v1
kind string	PipelineRun
metadata Kubernetes meta/v1.ObjectMeta	(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec PipelineRunSpec	(Optional) pipelineRef PipelineRef (Optional) pipelineSpec PipelineSpec (Optional) Specifying PipelineSpec can be disabled by setting disable-inline-spec feature flag.. params Params Params is a list of parameter names and values. status PipelineRunSpecStatus (Optional) Used for cancelling a pipelinerun (and maybe more later on) timeouts TimeoutFields (Optional) Time after which the Pipeline times out. Currently three keys are accepted in the map pipeline, tasks and finally with Timeouts.pipeline >= Timeouts.tasks + Timeouts.finally taskRunTemplate PipelineTaskRunTemplate (Optional) TaskRunTemplate represent template of taskrun workspaces []WorkspaceBinding (Optional) Workspaces holds a set of workspace bindings that must match names with those declared in the pipeline. taskRunSpecs []PipelineTaskRunSpec (Optional) TaskRunSpecs holds a set of runtime specs
status PipelineRunStatus	(Optional)

Task

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.

Field	Description
apiVersion string	tekton.dev/v1
kind string	Task
metadata Kubernetes meta/v1.ObjectMeta	(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec TaskSpec	(Optional) Spec holds the desired state of the Task from the client params ParamSpecs (Optional) 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. displayName string (Optional) DisplayName is a user-facing name of the task that may be used to populate a UI. description string (Optional) Description is a user-facing description of the task that may be used to populate a UI. steps []Step Steps are the steps of the build; each step is run sequentially with the source mounted into /workspace. volumes []Kubernetes core/v1.Volume Volumes is a collection of volumes that are available to mount into the steps of the build. stepTemplate StepTemplate StepTemplate can be used as the basis for all step containers within the Task, so that the steps inherit settings on the base container. sidecars []Sidecar Sidecars are run alongside the Task’s step containers. They begin before the steps start and end after the steps complete. workspaces []WorkspaceDeclaration Workspaces are the volumes that this Task requires. results []TaskResult Results are values that this Task can output

TaskRun

TaskRun represents a single execution of a Task. TaskRuns are how the steps specified in a Task are executed; they specify the parameters and resources used to run the steps in a Task.

Field	Description
apiVersion string	tekton.dev/v1
kind string	TaskRun
metadata Kubernetes meta/v1.ObjectMeta	(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec TaskRunSpec	(Optional) debug TaskRunDebug (Optional) params Params (Optional) serviceAccountName string (Optional) taskRef TaskRef (Optional) no more than one of the TaskRef and TaskSpec may be specified. taskSpec TaskSpec (Optional) Specifying PipelineSpec can be disabled by setting disable-inline-spec feature flag.. status TaskRunSpecStatus (Optional) Used for cancelling a TaskRun (and maybe more later on) statusMessage TaskRunSpecStatusMessage (Optional) Status message for cancellation. retries int (Optional) Retries represents how many times this TaskRun should be retried in the event of task failure. timeout Kubernetes meta/v1.Duration (Optional) Time after which one retry attempt times out. Defaults to 1 hour. Refer Go’s ParseDuration documentation for expected format: https://golang.org/pkg/time/#ParseDuration podTemplate Template PodTemplate holds pod specific configuration workspaces []WorkspaceBinding (Optional) Workspaces is a list of WorkspaceBindings from volumes to workspaces. stepSpecs []TaskRunStepSpec (Optional) Specs to apply to Steps in this TaskRun. If a field is specified in both a Step and a StepSpec, the value from the StepSpec will be used. This field is only supported when the alpha feature gate is enabled. sidecarSpecs []TaskRunSidecarSpec (Optional) Specs to apply to Sidecars in this TaskRun. If a field is specified in both a Sidecar and a SidecarSpec, the value from the SidecarSpec will be used. This field is only supported when the alpha feature gate is enabled. computeResources Kubernetes core/v1.ResourceRequirements Compute resources to use for this TaskRun
status TaskRunStatus	(Optional)

Algorithm (string alias)

Algorithm Standard cryptographic hash algorithm

Artifact

(Appears on:Artifacts, StepState)

TaskRunStepArtifact represents an artifact produced or used by a step within a task run. It directly uses the Artifact type for its structure.

Field	Description
name string	The artifact’s identifying category name
values []ArtifactValue	A collection of values related to the artifact
buildOutput bool	Indicate if the artifact is a build output or a by-product

ArtifactValue

(Appears on:Artifact)

ArtifactValue represents a specific value or data element within an Artifact.

Field	Description
digest map[github.com/tektoncd/pipeline/pkg/apis/pipeline/v1.Algorithm]string
uri string	Algorithm-specific digests for verifying the content (e.g., SHA256)

Artifacts

(Appears on:TaskRunStatusFields)

Artifacts represents the collection of input and output artifacts associated with a task run or a similar process. Artifacts in this context are units of data or resources that the process either consumes as input or produces as output.

Field	Description
inputs []Artifact
outputs []Artifact

ChildStatusReference

(Appears on:PipelineRunStatusFields)

ChildStatusReference is used to point to the statuses of individual TaskRuns and Runs within this PipelineRun.

Field	Description
name string	Name is the name of the TaskRun or Run this is referencing.
displayName string	DisplayName is a user-facing name of the pipelineTask that may be used to populate a UI.
pipelineTaskName string	PipelineTaskName is the name of the PipelineTask this is referencing.
whenExpressions []WhenExpression	(Optional) WhenExpressions is the list of checks guarding the execution of the PipelineTask

Combination (map[string]string alias)

Combination is a map, mainly defined to hold a single combination from a Matrix with key as param.Name and value as param.Value

Combinations ([]github.com/tektoncd/pipeline/pkg/apis/pipeline/v1.Combination alias)

Combinations is a Combination list

EmbeddedTask

(Appears on:PipelineTask)

EmbeddedTask is used to define a Task inline within a Pipeline’s PipelineTasks.

Field	Description
spec k8s.io/apimachinery/pkg/runtime.RawExtension	(Optional) Spec is a specification of a custom task - []byte Raw is the underlying serialization of this object. TODO: Determine how to detect ContentType and ContentEncoding of ‘Raw’ data. - k8s.io/apimachinery/pkg/runtime.Object Object can hold a representation of this extension - useful for working with versioned structs.
metadata PipelineTaskMetadata	(Optional)
TaskSpec TaskSpec	(Members of TaskSpec are embedded into this type.) (Optional) TaskSpec is a specification of a task

IncludeParams

IncludeParams allows passing in a specific combinations of Parameters into the Matrix.

Field	Description
name string	Name the specified combination
params Params	Params takes only Parameters of type "string" The names of the params must match the names of the params in the underlying Task

Matrix

(Appears on:PipelineTask)

Matrix is used to fan out Tasks in a Pipeline

Field	Description
params Params	Params is a list of parameters used to fan out the pipelineTask Params takes only Parameters of type "array" Each array element is supplied to the PipelineTask by substituting params of type "string" in the underlying Task. The names of the params in the Matrix must match the names of the params in the underlying Task that they will be substituting.
include IncludeParamsList	(Optional) Include is a list of IncludeParams which allows passing in specific combinations of Parameters into the Matrix.

OnErrorType (string alias)

(Appears on:Step)

OnErrorType defines a list of supported exiting behavior of a container on error

Value	Description
"continue"	Continue indicates continue executing the rest of the steps irrespective of the container exit code
"stopAndFail"	StopAndFail indicates exit the taskRun if the container exits with non-zero exit code

Param

(Appears on:ResolutionRequestSpec)

Param declares an ParamValues to use for the parameter called name.

Field	Description
name string
value ParamValue

ParamSpec

ParamSpec defines arbitrary parameters needed beyond typed inputs (such as resources). Parameter values are provided by users as inputs on a TaskRun or PipelineRun.

Field	Description
name string	Name declares the name by which a parameter is referenced.
type ParamType	(Optional) Type is the user-specified type of the parameter. The possible types are currently “string”, “array” and “object”, and “string” is the default.
description string	(Optional) Description is a user-facing description of the parameter that may be used to populate a UI.
properties map[string]github.com/tektoncd/pipeline/pkg/apis/pipeline/v1.PropertySpec	(Optional) Properties is the JSON Schema properties to support key-value pairs parameter.
default ParamValue	(Optional) 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.
enum []string	(Optional) 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.

ParamSpecs ([]github.com/tektoncd/pipeline/pkg/apis/pipeline/v1.ParamSpec alias)

(Appears on:PipelineSpec, TaskSpec, StepActionSpec, StepActionSpec)

ParamSpecs is a list of ParamSpec

ParamType (string alias)

(Appears on:ParamSpec, ParamValue, PropertySpec)

ParamType indicates the type of an input parameter; Used to distinguish between a single string and an array of strings.

Value	Description
"array"
"object"
"string"

ParamValue

(Appears on:Param, ParamSpec, PipelineResult, PipelineRunResult, TaskResult, TaskRunResult)

ResultValue is a type alias of ParamValue

Field	Description
Type ParamType
StringVal string	Represents the stored type of ParamValues.
ArrayVal []string
ObjectVal map[string]string

Params ([]github.com/tektoncd/pipeline/pkg/apis/pipeline/v1.Param alias)

(Appears on:IncludeParams, Matrix, PipelineRunSpec, PipelineTask, ResolverRef, Step, TaskRunInputs, TaskRunSpec)

Params is a list of Param

PipelineRef

(Appears on:PipelineRunSpec, PipelineTask)

PipelineRef can be used to refer to a specific instance of a Pipeline.

Field	Description
name string	Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
apiVersion string	(Optional) API version of the referent
ResolverRef ResolverRef	(Optional) ResolverRef allows referencing a Pipeline in a remote location like a git repo. This field is only supported when the alpha feature gate is enabled.

PipelineResult

(Appears on:PipelineSpec)

PipelineResult used to describe the results of a pipeline

Field	Description
name string	Name the given name
type ResultsType	Type is the user-specified type of the result. The possible types are ‘string’, ‘array’, and ‘object’, with ‘string’ as the default. ‘array’ and ‘object’ types are alpha features.
description string	(Optional) Description is a human-readable description of the result
value ParamValue	Value the expression used to retrieve the value

PipelineRunReason (string alias)

PipelineRunReason represents a reason for the pipeline run “Succeeded” condition

Value	Description
"CELEvaluationFailed"	ReasonCELEvaluationFailed indicates the pipeline fails the CEL evaluation
"Cancelled"	PipelineRunReasonCancelled is the reason set when the PipelineRun cancelled by the user This reason may be found with a corev1.ConditionFalse status, if the cancellation was processed successfully This reason may be found with a corev1.ConditionUnknown status, if the cancellation is being processed or failed
"CancelledRunningFinally"	PipelineRunReasonCancelledRunningFinally indicates that pipeline has been gracefully cancelled and no new Tasks will be scheduled by the controller, but final tasks are now running
"Completed"	PipelineRunReasonCompleted is the reason set when the PipelineRun completed successfully with one or more skipped Tasks
"PipelineRunCouldntCancel"	ReasonCouldntCancel indicates that a PipelineRun was cancelled but attempting to update all of the running TaskRuns as cancelled failed.
"CouldntGetPipeline"	ReasonCouldntGetPipeline indicates that the reason for the failure status is that the associated Pipeline couldn’t be retrieved
"CouldntGetPipelineResult"	PipelineRunReasonCouldntGetPipelineResult indicates that the pipeline fails to retrieve the referenced result. This could be due to failed TaskRuns or Runs that were supposed to produce the results
"CouldntGetTask"	ReasonCouldntGetTask indicates that the reason for the failure status is that the associated Pipeline’s Tasks couldn’t all be retrieved
"PipelineRunCouldntTimeOut"	ReasonCouldntTimeOut indicates that a PipelineRun was timed out but attempting to update all of the running TaskRuns as timed out failed.
"CreateRunFailed"	ReasonCreateRunFailed indicates that the pipeline fails to create the taskrun or other run resources
"Failed"	PipelineRunReasonFailed is the reason set when the PipelineRun completed with a failure
"PipelineValidationFailed"	ReasonFailedValidation indicates that the reason for failure status is that pipelinerun failed runtime validation
"InvalidPipelineResourceBindings"	ReasonInvalidBindings indicates that the reason for the failure status is that the PipelineResources bound in the PipelineRun didn’t match those declared in the Pipeline
"PipelineInvalidGraph"	ReasonInvalidGraph indicates that the reason for the failure status is that the associated Pipeline is an invalid graph (a.k.a wrong order, cycle, …)
"InvalidMatrixParameterTypes"	ReasonInvalidMatrixParameterTypes indicates a matrix contains invalid parameter types
"InvalidParamValue"	PipelineRunReasonInvalidParamValue indicates that the PipelineRun Param input value is not allowed.
"InvalidPipelineResultReference"	PipelineRunReasonInvalidPipelineResultReference indicates a pipeline result was declared by the pipeline but not initialized in the pipelineTask
"InvalidTaskResultReference"	ReasonInvalidTaskResultReference indicates a task result was declared but was not initialized by that task
"InvalidTaskRunSpecs"	ReasonInvalidTaskRunSpec indicates that PipelineRun.Spec.TaskRunSpecs[].PipelineTaskName is defined with a not exist taskName in pipelineSpec.
"InvalidWorkspaceBindings"	ReasonInvalidWorkspaceBinding indicates that a Pipeline expects a workspace but a PipelineRun has provided an invalid binding.
"ObjectParameterMissKeys"	ReasonObjectParameterMissKeys indicates that the object param value provided from PipelineRun spec misses some keys required for the object param declared in Pipeline spec.
"ParamArrayIndexingInvalid"	ReasonParamArrayIndexingInvalid indicates that the use of param array indexing is out of bound.
"ParameterMissing"	ReasonParameterMissing indicates that the reason for the failure status is that the associated PipelineRun didn’t provide all the required parameters
"ParameterTypeMismatch"	ReasonParameterTypeMismatch indicates that the reason for the failure status is that parameter(s) declared in the PipelineRun do not have the some declared type as the parameters(s) declared in the Pipeline that they are supposed to override.
"PipelineRunPending"	PipelineRunReasonPending is the reason set when the PipelineRun is in the pending state
"RequiredWorkspaceMarkedOptional"	ReasonRequiredWorkspaceMarkedOptional indicates an optional workspace has been passed to a Task that is expecting a non-optional workspace
"ResolvingPipelineRef"	ReasonResolvingPipelineRef indicates that the PipelineRun is waiting for its pipelineRef to be asynchronously resolved.
"ResourceVerificationFailed"	ReasonResourceVerificationFailed indicates that the pipeline fails the trusted resource verification, it could be the content has changed, signature is invalid or public key is invalid
"Running"	PipelineRunReasonRunning is the reason set when the PipelineRun is running
"Started"	PipelineRunReasonStarted is the reason set when the PipelineRun has just started
"StoppedRunningFinally"	PipelineRunReasonStoppedRunningFinally indicates that pipeline has been gracefully stopped and no new Tasks will be scheduled by the controller, but final tasks are now running
"PipelineRunStopping"	PipelineRunReasonStopping indicates that no new Tasks will be scheduled by the controller, and the pipeline will stop once all running tasks complete their work
"Succeeded"	PipelineRunReasonSuccessful is the reason set when the PipelineRun completed successfully
"PipelineRunTimeout"	PipelineRunReasonTimedOut is the reason set when the PipelineRun has timed out

PipelineRunResult

(Appears on:PipelineRunStatusFields)

PipelineRunResult used to describe the results of a pipeline

Field	Description
name string	Name is the result’s name as declared by the Pipeline
value ParamValue	Value is the result returned from the execution of this PipelineRun

PipelineRunRunStatus

PipelineRunRunStatus contains the name of the PipelineTask for this Run and the Run’s Status

Field	Description
pipelineTaskName string	PipelineTaskName is the name of the PipelineTask.
status CustomRunStatus	(Optional) Status is the RunStatus for the corresponding Run
whenExpressions []WhenExpression	(Optional) WhenExpressions is the list of checks guarding the execution of the PipelineTask

PipelineRunSpec

(Appears on:PipelineRun)

PipelineRunSpec defines the desired state of PipelineRun

Field	Description
pipelineRef PipelineRef	(Optional)
pipelineSpec PipelineSpec	(Optional) Specifying PipelineSpec can be disabled by setting disable-inline-spec feature flag..
params Params	Params is a list of parameter names and values.
status PipelineRunSpecStatus	(Optional) Used for cancelling a pipelinerun (and maybe more later on)
timeouts TimeoutFields	(Optional) Time after which the Pipeline times out. Currently three keys are accepted in the map pipeline, tasks and finally with Timeouts.pipeline >= Timeouts.tasks + Timeouts.finally
taskRunTemplate PipelineTaskRunTemplate	(Optional) TaskRunTemplate represent template of taskrun
workspaces []WorkspaceBinding	(Optional) Workspaces holds a set of workspace bindings that must match names with those declared in the pipeline.
taskRunSpecs []PipelineTaskRunSpec	(Optional) TaskRunSpecs holds a set of runtime specs

PipelineRunSpecStatus (string alias)

(Appears on:PipelineRunSpec)

PipelineRunSpecStatus defines the pipelinerun spec status the user can provide

PipelineRunStatus

(Appears on:PipelineRun)

PipelineRunStatus defines the observed state of PipelineRun

Field	Description
Status knative.dev/pkg/apis/duck/v1.Status	(Members of Status are embedded into this type.)
PipelineRunStatusFields PipelineRunStatusFields	(Members of PipelineRunStatusFields are embedded into this type.) PipelineRunStatusFields inlines the status fields.

PipelineRunStatusFields

(Appears on:PipelineRunStatus)

PipelineRunStatusFields holds the fields of PipelineRunStatus’ status. This is defined separately and inlined so that other types can readily consume these fields via duck typing.

Field	Description
startTime Kubernetes meta/v1.Time	StartTime is the time the PipelineRun is actually started.
completionTime Kubernetes meta/v1.Time	CompletionTime is the time the PipelineRun completed.
results []PipelineRunResult	(Optional) Results are the list of results written out by the pipeline task’s containers
pipelineSpec PipelineSpec	PipelineRunSpec contains the exact spec used to instantiate the run
skippedTasks []SkippedTask	(Optional) list of tasks that were skipped due to when expressions evaluating to false
childReferences []ChildStatusReference	(Optional) list of TaskRun and Run names, PipelineTask names, and API versions/kinds for children of this PipelineRun.
finallyStartTime Kubernetes meta/v1.Time	(Optional) FinallyStartTime is when all non-finally tasks have been completed and only finally tasks are being executed.
provenance Provenance	(Optional) Provenance contains some key authenticated metadata about how a software artifact was built (what sources, what inputs/outputs, etc.).
spanContext map[string]string	SpanContext contains tracing span context fields

PipelineRunTaskRunStatus

PipelineRunTaskRunStatus contains the name of the PipelineTask for this TaskRun and the TaskRun’s Status

Field	Description
pipelineTaskName string	PipelineTaskName is the name of the PipelineTask.
status TaskRunStatus	(Optional) Status is the TaskRunStatus for the corresponding TaskRun
whenExpressions []WhenExpression	(Optional) WhenExpressions is the list of checks guarding the execution of the PipelineTask

PipelineSpec

(Appears on:Pipeline, PipelineRunSpec, PipelineRunStatusFields, PipelineTask)

PipelineSpec defines the desired state of Pipeline.

Field	Description
displayName string	(Optional) DisplayName is a user-facing name of the pipeline that may be used to populate a UI.
description string	(Optional) Description is a user-facing description of the pipeline that may be used to populate a UI.
tasks []PipelineTask	Tasks declares the graph of Tasks that execute when this Pipeline is run.
params ParamSpecs	Params declares a list of input parameters that must be supplied when this Pipeline is run.
workspaces []PipelineWorkspaceDeclaration	(Optional) Workspaces declares a set of named workspaces that are expected to be provided by a PipelineRun.
results []PipelineResult	(Optional) Results are values that this pipeline can output once run
finally []PipelineTask	Finally declares the list of Tasks that execute just before leaving the Pipeline i.e. either after all Tasks are finished executing successfully or after a failure which would result in ending the Pipeline

PipelineTask

(Appears on:PipelineSpec)

PipelineTask defines a task in a Pipeline, passing inputs from both Params and from the output of previous tasks.

Field	Description
name string	Name is the name of this task within the context of a Pipeline. Name is used as a coordinate with the from and runAfter fields to establish the execution order of tasks relative to one another.
displayName string	(Optional) DisplayName is the display name of this task within the context of a Pipeline. This display name may be used to populate a UI.
description string	(Optional) Description is the description of this task within the context of a Pipeline. This description may be used to populate a UI.
taskRef TaskRef	(Optional) TaskRef is a reference to a task definition.
taskSpec EmbeddedTask	(Optional) TaskSpec is a specification of a task Specifying TaskSpec can be disabled by setting disable-inline-spec feature flag..
when WhenExpressions	(Optional) When is a list of when expressions that need to be true for the task to run
retries int	(Optional) Retries represents how many times this task should be retried in case of task failure: ConditionSucceeded set to False
runAfter []string	(Optional) RunAfter is the list of PipelineTask names that should be executed before this Task executes. (Used to force a specific ordering in graph execution.)
params Params	(Optional) Parameters declares parameters passed to this task.
matrix Matrix	(Optional) Matrix declares parameters used to fan out this task.
workspaces []WorkspacePipelineTaskBinding	(Optional) Workspaces maps workspaces from the pipeline spec to the workspaces declared in the Task.
timeout Kubernetes meta/v1.Duration	(Optional) Time after which the TaskRun times out. Defaults to 1 hour. Refer Go’s ParseDuration documentation for expected format: https://golang.org/pkg/time/#ParseDuration
pipelineRef PipelineRef	(Optional) PipelineRef is a reference to a pipeline definition Note: PipelineRef is in preview mode and not yet supported
pipelineSpec PipelineSpec	(Optional) PipelineSpec is a specification of a pipeline Note: PipelineSpec is in preview mode and not yet supported Specifying PipelineSpec can be disabled by setting disable-inline-spec feature flag..
onError PipelineTaskOnErrorType	(Optional) OnError defines the exiting behavior of a PipelineRun on error can be set to [ continue | stopAndFail ]

PipelineTaskMetadata

(Appears on:EmbeddedTask, PipelineTaskRunSpec)

PipelineTaskMetadata contains the labels or annotations for an EmbeddedTask

Field	Description
labels map[string]string	(Optional)
annotations map[string]string	(Optional)

PipelineTaskOnErrorType (string alias)

(Appears on:PipelineTask)

PipelineTaskOnErrorType defines a list of supported failure handling behaviors of a PipelineTask on error

Value	Description
"continue"	PipelineTaskContinue indicates to continue executing the rest of the DAG when the PipelineTask fails
"stopAndFail"	PipelineTaskStopAndFail indicates to stop and fail the PipelineRun if the PipelineTask fails

PipelineTaskParam

PipelineTaskParam is used to provide arbitrary string parameters to a Task.

Field	Description
name string
value string

PipelineTaskRun

PipelineTaskRun reports the results of running a step in the Task. Each task has the potential to succeed or fail (based on the exit code) and produces logs.

Field	Description
name string

PipelineTaskRunSpec

(Appears on:PipelineRunSpec)

PipelineTaskRunSpec can be used to configure specific specs for a concrete Task

Field	Description
pipelineTaskName string
serviceAccountName string
podTemplate Template
stepSpecs []TaskRunStepSpec
sidecarSpecs []TaskRunSidecarSpec
metadata PipelineTaskMetadata	(Optional)
computeResources Kubernetes core/v1.ResourceRequirements	Compute resources to use for this TaskRun

PipelineTaskRunTemplate

(Appears on:PipelineRunSpec)

PipelineTaskRunTemplate is used to specify run specifications for all Task in pipelinerun.

Field	Description
podTemplate Template	(Optional)
serviceAccountName string	(Optional)

PipelineWorkspaceDeclaration

(Appears on:PipelineSpec)

WorkspacePipelineDeclaration creates a named slot in a Pipeline that a PipelineRun is expected to populate with a workspace binding.

Deprecated: use PipelineWorkspaceDeclaration type instead

Field	Description
name string	Name is the name of a workspace to be provided by a PipelineRun.
description string	(Optional) Description is a human readable string describing how the workspace will be used in the Pipeline. It can be useful to include a bit of detail about which tasks are intended to have access to the data on the workspace.
optional bool	Optional marks a Workspace as not being required in PipelineRuns. By default this field is false and so declared workspaces are required.

PropertySpec

(Appears on:ParamSpec, StepResult, TaskResult)

PropertySpec defines the struct for object keys

Field	Description
type ParamType

Provenance

(Appears on:PipelineRunStatusFields, StepState, TaskRunStatusFields)

Provenance contains metadata about resources used in the TaskRun/PipelineRun such as the source from where a remote build definition was fetched. This field aims to carry minimum amoumt of metadata in *Run status so that Tekton Chains can capture them in the provenance.

Field	Description
refSource RefSource	RefSource identifies the source where a remote task/pipeline came from.
featureFlags github.com/tektoncd/pipeline/pkg/apis/config.FeatureFlags	FeatureFlags identifies the feature flags that were used during the task/pipeline run

Ref

(Appears on:Step)

Ref can be used to refer to a specific instance of a StepAction.

Field	Description
name string	Name of the referenced step
ResolverRef ResolverRef	(Optional) ResolverRef allows referencing a StepAction in a remote location like a git repo.

RefSource

(Appears on:Provenance, ResolutionRequestStatusFields, ResolutionRequestStatusFields)

RefSource contains the information that can uniquely identify where a remote built definition came from i.e. Git repositories, Tekton Bundles in OCI registry and hub.

Field	Description
uri string	URI indicates the identity of the source of the build definition. Example: “https://github.com/tektoncd/catalog”
digest map[string]string	Digest is a collection of cryptographic digests for the contents of the artifact specified by URI. Example: {“sha1”: “f99d13e554ffcb696dee719fa85b695cb5b0f428”}
entryPoint string	EntryPoint identifies the entry point into the build. This is often a path to a build definition file and/or a target label within that file. Example: “task/git-clone/0.8/git-clone.yaml”

ResolverName (string alias)

(Appears on:ResolverRef)

ResolverName is the name of a resolver from which a resource can be requested.

ResolverRef

(Appears on:PipelineRef, Ref, TaskRef)

ResolverRef can be used to refer to a Pipeline or Task in a remote location like a git repo. This feature is in beta and these fields are only available when the beta feature gate is enabled.

Field	Description
resolver ResolverName	(Optional) Resolver is the name of the resolver that should perform resolution of the referenced Tekton resource, such as “git”.
params Params	(Optional) 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.

ResultRef

ResultRef is a type that represents a reference to a task run result

Field	Description
pipelineTask string
result string
resultsIndex int
property string

ResultsType (string alias)

(Appears on:PipelineResult, StepResult, TaskResult, TaskRunResult)

ResultsType indicates the type of a result; Used to distinguish between a single string and an array of strings. Note that there is ResultType used to find out whether a RunResult is from a task result or not, which is different from this ResultsType.

Value	Description
"array"
"object"
"string"

Sidecar

(Appears on:TaskSpec)

Sidecar has nearly the same data structure as Step but does not have the ability to timeout.

Field	Description
name string	Name of the Sidecar specified as a DNS_LABEL. Each Sidecar in a Task must have a unique name (DNS_LABEL). Cannot be updated.
image string	(Optional) Image reference name. More info: https://kubernetes.io/docs/concepts/containers/images
command []string	(Optional) 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
args []string	(Optional) 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
workingDir string	(Optional) 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.
ports []Kubernetes core/v1.ContainerPort	(Optional) 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.
envFrom []Kubernetes core/v1.EnvFromSource	(Optional) 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.
env []Kubernetes core/v1.EnvVar	(Optional) List of environment variables to set in the Sidecar. Cannot be updated.
computeResources Kubernetes core/v1.ResourceRequirements	(Optional) ComputeResources required by this Sidecar. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
volumeMounts []Kubernetes core/v1.VolumeMount	(Optional) Volumes to mount into the Sidecar’s filesystem. Cannot be updated.
volumeDevices []Kubernetes core/v1.VolumeDevice	(Optional) volumeDevices is the list of block devices to be used by the Sidecar.
livenessProbe Kubernetes core/v1.Probe	(Optional) 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
readinessProbe Kubernetes core/v1.Probe	(Optional) 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
startupProbe Kubernetes core/v1.Probe	(Optional) 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
lifecycle Kubernetes core/v1.Lifecycle	(Optional) Actions that the management system should take in response to Sidecar lifecycle events. Cannot be updated.
terminationMessagePath string	(Optional) 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.
terminationMessagePolicy Kubernetes core/v1.TerminationMessagePolicy	(Optional) 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.
imagePullPolicy Kubernetes core/v1.PullPolicy	(Optional) 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
securityContext Kubernetes core/v1.SecurityContext	(Optional) 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/
stdin bool	(Optional) 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.
stdinOnce bool	(Optional) 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
tty bool	(Optional) Whether this Sidecar should allocate a TTY for itself, also requires ‘stdin’ to be true. Default is false.
script string	(Optional) Script is the contents of an executable file to execute. If Script is not empty, the Step cannot have an Command or Args.
workspaces []WorkspaceUsage	(Optional) 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.
restartPolicy Kubernetes core/v1.ContainerRestartPolicy	(Optional) 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.

SidecarState

(Appears on:TaskRunStatusFields)

SidecarState reports the results of running a sidecar in a Task.

Field	Description
ContainerState Kubernetes core/v1.ContainerState	(Members of ContainerState are embedded into this type.)
name string
container string
imageID string

SkippedTask

(Appears on:PipelineRunStatusFields)

SkippedTask is used to describe the Tasks that were skipped due to their When Expressions evaluating to False. This is a struct because we are looking into including more details about the When Expressions that caused this Task to be skipped.

Field	Description
name string	Name is the Pipeline Task name
reason SkippingReason	Reason is the cause of the PipelineTask being skipped.
whenExpressions []WhenExpression	(Optional) WhenExpressions is the list of checks guarding the execution of the PipelineTask

SkippingReason (string alias)

(Appears on:SkippedTask)

SkippingReason explains why a PipelineTask was skipped.

Value	Description
"Matrix Parameters have an empty array"	EmptyArrayInMatrixParams means the task was skipped because Matrix parameters contain empty array.
"PipelineRun Finally timeout has been reached"	FinallyTimedOutSkip means the task was skipped because the PipelineRun has passed its Timeouts.Finally.
"PipelineRun was gracefully cancelled"	GracefullyCancelledSkip means the task was skipped because the pipeline run has been gracefully cancelled
"PipelineRun was gracefully stopped"	GracefullyStoppedSkip means the task was skipped because the pipeline run has been gracefully stopped
"Results were missing"	MissingResultsSkip means the task was skipped because it’s missing necessary results
"None"	None means the task was not skipped
"Parent Tasks were skipped"	ParentTasksSkip means the task was skipped because its parent was skipped
"PipelineRun timeout has been reached"	PipelineTimedOutSkip means the task was skipped because the PipelineRun has passed its overall timeout.
"PipelineRun was stopping"	StoppingSkip means the task was skipped because the pipeline run is stopping
"PipelineRun Tasks timeout has been reached"	TasksTimedOutSkip means the task was skipped because the PipelineRun has passed its Timeouts.Tasks.
"When Expressions evaluated to false"	WhenExpressionsSkip means the task was skipped due to at least one of its when expressions evaluating to false

Step

(Appears on:TaskSpec)

Step runs a subcomponent of a Task

Field	Description
name string	Name of the Step specified as a DNS_LABEL. Each Step in a Task must have a unique name.
image string	(Optional) Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images
command []string	(Optional) 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
args []string	(Optional) 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
workingDir string	(Optional) 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.
envFrom []Kubernetes core/v1.EnvFromSource	(Optional) 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.
env []Kubernetes core/v1.EnvVar	(Optional) List of environment variables to set in the Step. Cannot be updated.
computeResources Kubernetes core/v1.ResourceRequirements	(Optional) ComputeResources required by this Step. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
volumeMounts []Kubernetes core/v1.VolumeMount	(Optional) Volumes to mount into the Step’s filesystem. Cannot be updated.
volumeDevices []Kubernetes core/v1.VolumeDevice	(Optional) volumeDevices is the list of block devices to be used by the Step.
imagePullPolicy Kubernetes core/v1.PullPolicy	(Optional) 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
securityContext Kubernetes core/v1.SecurityContext	(Optional) 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/
script string	(Optional) 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.
timeout Kubernetes meta/v1.Duration	(Optional) 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
workspaces []WorkspaceUsage	(Optional) 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.
onError OnErrorType	OnError defines the exiting behavior of a container on error can be set to [ continue | stopAndFail ]
stdoutConfig StepOutputConfig	(Optional) Stores configuration for the stdout stream of the step.
stderrConfig StepOutputConfig	(Optional) Stores configuration for the stderr stream of the step.
ref Ref	(Optional) Contains the reference to an existing StepAction.
params Params	(Optional) Params declares parameters passed to this step action.
results []StepResult	(Optional) Results declares StepResults produced by the Step. This is field is at an ALPHA stability level and gated by “enable-step-actions” feature flag. 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.
when WhenExpressions	(Optional) When is a list of when expressions that need to be true for the task to run

StepOutputConfig

(Appears on:Step)

StepOutputConfig stores configuration for a step output stream.

Field	Description
path string	(Optional) Path to duplicate stdout stream to on container’s local filesystem.

StepResult

(Appears on:Step, StepActionSpec, Step, StepActionSpec)

StepResult used to describe the Results of a Step.

This is field is at an BETA stability level and gated by “enable-step-actions” feature flag.

Field	Description
name string	Name the given name
type ResultsType	(Optional) The possible types are ‘string’, ‘array’, and ‘object’, with ‘string’ as the default.
properties map[string]github.com/tektoncd/pipeline/pkg/apis/pipeline/v1.PropertySpec	(Optional) Properties is the JSON Schema properties to support key-value pairs results.
description string	(Optional) Description is a human-readable description of the result

StepState

(Appears on:TaskRunStatusFields)

StepState reports the results of running a step in a Task.

Field	Description
ContainerState Kubernetes core/v1.ContainerState	(Members of ContainerState are embedded into this type.)
name string
container string
imageID string
results []TaskRunResult
provenance Provenance
terminationReason string
inputs []Artifact
outputs []Artifact

StepTemplate

(Appears on:TaskSpec)

StepTemplate is a template for a Step

Field	Description
image string	(Optional) Image reference name. More info: https://kubernetes.io/docs/concepts/containers/images
command []string	(Optional) 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
args []string	(Optional) 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
workingDir string	(Optional) 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.
envFrom []Kubernetes core/v1.EnvFromSource	(Optional) 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.
env []Kubernetes core/v1.EnvVar	(Optional) List of environment variables to set in the Step. Cannot be updated.
computeResources Kubernetes core/v1.ResourceRequirements	(Optional) ComputeResources required by this Step. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
volumeMounts []Kubernetes core/v1.VolumeMount	(Optional) Volumes to mount into the Step’s filesystem. Cannot be updated.
volumeDevices []Kubernetes core/v1.VolumeDevice	(Optional) volumeDevices is the list of block devices to be used by the Step.
imagePullPolicy Kubernetes core/v1.PullPolicy	(Optional) 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
securityContext Kubernetes core/v1.SecurityContext	(Optional) 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/

TaskBreakpoints

(Appears on:TaskRunDebug)

TaskBreakpoints defines the breakpoint config for a particular Task

Field	Description
onFailure string	(Optional) if enabled, pause TaskRun on failure of a step failed step will not exit
beforeSteps []string	(Optional)

TaskKind (string alias)

(Appears on:TaskRef)

TaskKind defines the type of Task used by the pipeline.

Value	Description
"ClusterTask"	ClusterTaskRefKind is the task type for a reference to a task with cluster scope. ClusterTasks are not supported in v1, but v1 types may reference ClusterTasks.
"Task"	NamespacedTaskKind indicates that the task type has a namespaced scope.

TaskRef

(Appears on:PipelineTask, TaskRunSpec)

TaskRef can be used to refer to a specific instance of a task.

Field	Description
name string	Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
kind TaskKind	TaskKind indicates the Kind of the Task: 1. Namespaced Task when Kind is set to “Task”. If Kind is “”, it defaults to “Task”. 2. Custom Task when Kind is non-empty and APIVersion is non-empty
apiVersion string	(Optional) API version of the referent Note: A Task with non-empty APIVersion and Kind is considered a Custom Task
ResolverRef ResolverRef	(Optional) ResolverRef allows referencing a Task in a remote location like a git repo. This field is only supported when the alpha feature gate is enabled.

TaskResult

(Appears on:TaskSpec)

TaskResult used to describe the results of a task

Field	Description
name string	Name the given name
type ResultsType	(Optional) Type is the user-specified type of the result. The possible type is currently “string” and will support “array” in following work.
properties map[string]github.com/tektoncd/pipeline/pkg/apis/pipeline/v1.PropertySpec	(Optional) Properties is the JSON Schema properties to support key-value pairs results.
description string	(Optional) Description is a human-readable description of the result
value ParamValue	(Optional) Value the expression used to retrieve the value of the result from an underlying Step.

TaskRunDebug

(Appears on:TaskRunSpec)

TaskRunDebug defines the breakpoint config for a particular TaskRun

Field	Description
breakpoints TaskBreakpoints	(Optional)

TaskRunInputs

TaskRunInputs holds the input values that this task was invoked with.

Field	Description
params Params	(Optional)

TaskRunReason (string alias)

TaskRunReason is an enum used to store all TaskRun reason for the Succeeded condition that are controlled by the TaskRun itself. Failure reasons that emerge from underlying resources are not included here

Value	Description
"TaskRunCancelled"	TaskRunReasonCancelled is the reason set when the TaskRun is cancelled by the user
"Failed"	TaskRunReasonFailed is the reason set when the TaskRun completed with a failure
"TaskRunResolutionFailed"	TaskRunReasonFailedResolution indicated that the reason for failure status is that references within the TaskRun could not be resolved
"TaskRunValidationFailed"	TaskRunReasonFailedValidation indicated that the reason for failure status is that taskrun failed runtime validation
"FailureIgnored"	TaskRunReasonFailureIgnored is the reason set when the Taskrun has failed due to pod execution error and the failure is ignored for the owning PipelineRun. TaskRuns failed due to reconciler/validation error should not use this reason.
"TaskRunImagePullFailed"	TaskRunReasonImagePullFailed is the reason set when the step of a task fails due to image not being pulled
"InvalidParamValue"	TaskRunReasonInvalidParamValue indicates that the TaskRun Param input value is not allowed.
"ResourceVerificationFailed"	TaskRunReasonResourceVerificationFailed indicates that the task fails the trusted resource verification, it could be the content has changed, signature is invalid or public key is invalid
"TaskRunResultLargerThanAllowedLimit"	TaskRunReasonResultLargerThanAllowedLimit is the reason set when one of the results exceeds its maximum allowed limit of 1 KB
"Running"	TaskRunReasonRunning is the reason set when the TaskRun is running
"Started"	TaskRunReasonStarted is the reason set when the TaskRun has just started
"TaskRunStopSidecarFailed"	TaskRunReasonStopSidecarFailed indicates that the sidecar is not properly stopped.
"Succeeded"	TaskRunReasonSuccessful is the reason set when the TaskRun completed successfully
"TaskValidationFailed"	TaskRunReasonTaskFailedValidation indicated that the reason for failure status is that task failed runtime validation
"TaskRunTimeout"	TaskRunReasonTimedOut is the reason set when one TaskRun execution has timed out
"ToBeRetried"	TaskRunReasonToBeRetried is the reason set when the last TaskRun execution failed, and will be retried

TaskRunResult

(Appears on:StepState, TaskRunStatusFields)

TaskRunStepResult is a type alias of TaskRunResult

Field	Description
name string	Name the given name
type ResultsType	(Optional) Type is the user-specified type of the result. The possible type is currently “string” and will support “array” in following work.
value ParamValue	Value the given value of the result

TaskRunSidecarSpec

(Appears on:PipelineTaskRunSpec, TaskRunSpec)

TaskRunSidecarSpec is used to override the values of a Sidecar in the corresponding Task.

Field	Description
name string	The name of the Sidecar to override.
computeResources Kubernetes core/v1.ResourceRequirements	The resource requirements to apply to the Sidecar.

TaskRunSpec

(Appears on:TaskRun)

TaskRunSpec defines the desired state of TaskRun

Field	Description
debug TaskRunDebug	(Optional)
params Params	(Optional)
serviceAccountName string	(Optional)
taskRef TaskRef	(Optional) no more than one of the TaskRef and TaskSpec may be specified.
taskSpec TaskSpec	(Optional) Specifying PipelineSpec can be disabled by setting disable-inline-spec feature flag..
status TaskRunSpecStatus	(Optional) Used for cancelling a TaskRun (and maybe more later on)
statusMessage TaskRunSpecStatusMessage	(Optional) Status message for cancellation.
retries int	(Optional) Retries represents how many times this TaskRun should be retried in the event of task failure.
timeout Kubernetes meta/v1.Duration	(Optional) Time after which one retry attempt times out. Defaults to 1 hour. Refer Go’s ParseDuration documentation for expected format: https://golang.org/pkg/time/#ParseDuration
podTemplate Template	PodTemplate holds pod specific configuration
workspaces []WorkspaceBinding	(Optional) Workspaces is a list of WorkspaceBindings from volumes to workspaces.
stepSpecs []TaskRunStepSpec	(Optional) Specs to apply to Steps in this TaskRun. If a field is specified in both a Step and a StepSpec, the value from the StepSpec will be used. This field is only supported when the alpha feature gate is enabled.
sidecarSpecs []TaskRunSidecarSpec	(Optional) Specs to apply to Sidecars in this TaskRun. If a field is specified in both a Sidecar and a SidecarSpec, the value from the SidecarSpec will be used. This field is only supported when the alpha feature gate is enabled.
computeResources Kubernetes core/v1.ResourceRequirements	Compute resources to use for this TaskRun

TaskRunSpecStatus (string alias)

(Appears on:TaskRunSpec)

TaskRunSpecStatus defines the TaskRun spec status the user can provide

TaskRunSpecStatusMessage (string alias)

(Appears on:TaskRunSpec)

TaskRunSpecStatusMessage defines human readable status messages for the TaskRun.

Value	Description
"TaskRun cancelled as the PipelineRun it belongs to has been cancelled."	TaskRunCancelledByPipelineMsg indicates that the PipelineRun of which this TaskRun was a part of has been cancelled.
"TaskRun cancelled as the PipelineRun it belongs to has timed out."	TaskRunCancelledByPipelineTimeoutMsg indicates that the TaskRun was cancelled because the PipelineRun running it timed out.

TaskRunStatus

(Appears on:TaskRun, PipelineRunTaskRunStatus, TaskRunStatusFields)

TaskRunStatus defines the observed state of TaskRun

Field	Description
Status knative.dev/pkg/apis/duck/v1.Status	(Members of Status are embedded into this type.)
TaskRunStatusFields TaskRunStatusFields	(Members of TaskRunStatusFields are embedded into this type.) TaskRunStatusFields inlines the status fields.

TaskRunStatusFields

(Appears on:TaskRunStatus)

TaskRunStatusFields holds the fields of TaskRun’s status. This is defined separately and inlined so that other types can readily consume these fields via duck typing.

Field	Description
podName string	PodName is the name of the pod responsible for executing this task’s steps.
startTime Kubernetes meta/v1.Time	StartTime is the time the build is actually started.
completionTime Kubernetes meta/v1.Time	CompletionTime is the time the build completed.
steps []StepState	(Optional) Steps describes the state of each build step container.
retriesStatus []TaskRunStatus	(Optional) RetriesStatus contains the history of TaskRunStatus in case of a retry in order to keep record of failures. All TaskRunStatus stored in RetriesStatus will have no date within the RetriesStatus as is redundant.
results []TaskRunResult	(Optional) Results are the list of results written out by the task’s containers
artifacts Artifacts	(Optional) Artifacts are the list of artifacts written out by the task’s containers
sidecars []SidecarState	The list has one entry per sidecar in the manifest. Each entry is represents the imageid of the corresponding sidecar.
taskSpec TaskSpec	TaskSpec contains the Spec from the dereferenced Task definition used to instantiate this TaskRun.
provenance Provenance	(Optional) Provenance contains some key authenticated metadata about how a software artifact was built (what sources, what inputs/outputs, etc.).
spanContext map[string]string	SpanContext contains tracing span context fields

TaskRunStepSpec

(Appears on:PipelineTaskRunSpec, TaskRunSpec)

TaskRunStepSpec is used to override the values of a Step in the corresponding Task.

Field	Description
name string	The name of the Step to override.
computeResources Kubernetes core/v1.ResourceRequirements	The resource requirements to apply to the Step.

TaskSpec

(Appears on:Task, EmbeddedTask, TaskRunSpec, TaskRunStatusFields)

TaskSpec defines the desired state of Task.

Field	Description
params ParamSpecs	(Optional) 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.
displayName string	(Optional) DisplayName is a user-facing name of the task that may be used to populate a UI.
description string	(Optional) Description is a user-facing description of the task that may be used to populate a UI.
steps []Step	Steps are the steps of the build; each step is run sequentially with the source mounted into /workspace.
volumes []Kubernetes core/v1.Volume	Volumes is a collection of volumes that are available to mount into the steps of the build.
stepTemplate StepTemplate	StepTemplate can be used as the basis for all step containers within the Task, so that the steps inherit settings on the base container.
sidecars []Sidecar	Sidecars are run alongside the Task’s step containers. They begin before the steps start and end after the steps complete.
workspaces []WorkspaceDeclaration	Workspaces are the volumes that this Task requires.
results []TaskResult	Results are values that this Task can output

TimeoutFields

(Appears on:PipelineRunSpec)

TimeoutFields allows granular specification of pipeline, task, and finally timeouts

Field	Description
pipeline Kubernetes meta/v1.Duration	Pipeline sets the maximum allowed duration for execution of the entire pipeline. The sum of individual timeouts for tasks and finally must not exceed this value.
tasks Kubernetes meta/v1.Duration	Tasks sets the maximum allowed duration of this pipeline’s tasks
finally Kubernetes meta/v1.Duration	Finally sets the maximum allowed duration of this pipeline’s finally

WhenExpression

(Appears on:ChildStatusReference, PipelineRunRunStatus, PipelineRunTaskRunStatus, SkippedTask)

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

Field	Description
input string	Input is the string for guard checking which can be a static input or an output from a parent Task
operator k8s.io/apimachinery/pkg/selection.Operator	Operator that represents an Input’s relationship to the values
values []string	Values is an array of strings, which is compared against the input, for guard checking It must be non-empty
cel string	(Optional) 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

WhenExpressions ([]github.com/tektoncd/pipeline/pkg/apis/pipeline/v1.WhenExpression alias)

(Appears on:PipelineTask, Step)

WhenExpressions are used to specify whether a Task should be executed or skipped All of them need to evaluate to True for a guarded Task to be executed.

WorkspaceBinding

(Appears on:PipelineRunSpec, TaskRunSpec)

WorkspaceBinding maps a Task’s declared workspace to a Volume.

Field	Description
name string	Name is the name of the workspace populated by the volume.
subPath string	(Optional) SubPath is optionally a directory on the volume which should be used for this binding (i.e. the volume will be mounted at this sub directory).
volumeClaimTemplate Kubernetes core/v1.PersistentVolumeClaim	(Optional) VolumeClaimTemplate is a template for a claim that will be created in the same namespace. The PipelineRun controller is responsible for creating a unique claim for each instance of PipelineRun.
persistentVolumeClaim Kubernetes core/v1.PersistentVolumeClaimVolumeSource	(Optional) PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. Either this OR EmptyDir can be used.
emptyDir Kubernetes core/v1.EmptyDirVolumeSource	(Optional) EmptyDir represents a temporary directory that shares a Task’s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir Either this OR PersistentVolumeClaim can be used.
configMap Kubernetes core/v1.ConfigMapVolumeSource	(Optional) ConfigMap represents a configMap that should populate this workspace.
secret Kubernetes core/v1.SecretVolumeSource	(Optional) Secret represents a secret that should populate this workspace.
projected Kubernetes core/v1.ProjectedVolumeSource	(Optional) Projected represents a projected volume that should populate this workspace.
csi Kubernetes core/v1.CSIVolumeSource	(Optional) CSI (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers.

WorkspaceDeclaration

(Appears on:TaskSpec)

WorkspaceDeclaration is a declaration of a volume that a Task requires.

Field	Description
name string	Name is the name by which you can bind the volume at runtime.
description string	(Optional) Description is an optional human readable description of this volume.
mountPath string	(Optional) MountPath overrides the directory that the volume will be made available at.
readOnly bool	ReadOnly dictates whether a mounted volume is writable. By default this field is false and so mounted volumes are writable.
optional bool	Optional marks a Workspace as not being required in TaskRuns. By default this field is false and so declared workspaces are required.

WorkspacePipelineTaskBinding

(Appears on:PipelineTask)

WorkspacePipelineTaskBinding describes how a workspace passed into the pipeline should be mapped to a task’s declared workspace.

Field	Description
name string	Name is the name of the workspace as declared by the task
workspace string	(Optional) Workspace is the name of the workspace declared by the pipeline
subPath string	(Optional) SubPath is optionally a directory on the volume which should be used for this binding (i.e. the volume will be mounted at this sub directory).

WorkspaceUsage

(Appears on:Sidecar, Step)

WorkspaceUsage is used by a Step or Sidecar to declare that it wants isolated access to a Workspace defined in a Task.

Field	Description
name string	Name is the name of the workspace this Step or Sidecar wants access to.
mountPath string	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.

---

tekton.dev/v1alpha1

Package v1alpha1 contains API Schema definitions for the pipeline v1alpha1 API group

Resource Types:

• Run
• StepAction
• VerificationPolicy
• PipelineResource

Run

Run represents a single execution of a Custom Task.

Field	Description
apiVersion string	tekton.dev/v1alpha1
kind string	Run
metadata Kubernetes meta/v1.ObjectMeta	(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec RunSpec	(Optional) ref TaskRef (Optional) spec EmbeddedRunSpec (Optional) Spec is a specification of a custom task params Params (Optional) status RunSpecStatus (Optional) Used for cancelling a run (and maybe more later on) statusMessage RunSpecStatusMessage (Optional) Status message for cancellation. retries int (Optional) Used for propagating retries count to custom tasks serviceAccountName string (Optional) podTemplate Template (Optional) PodTemplate holds pod specific configuration timeout Kubernetes meta/v1.Duration (Optional) Time after which the custom-task times out. Refer Go’s ParseDuration documentation for expected format: https://golang.org/pkg/time/#ParseDuration workspaces []WorkspaceBinding (Optional) Workspaces is a list of WorkspaceBindings from volumes to workspaces.
status RunStatus	(Optional)

StepAction

StepAction represents the actionable components of Step. The Step can only reference it from the cluster or using remote resolution.

Field	Description
apiVersion string	tekton.dev/v1alpha1
kind string	StepAction
metadata Kubernetes meta/v1.ObjectMeta	(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec StepActionSpec	(Optional) Spec holds the desired state of the Step from the client description string (Optional) Description is a user-facing description of the stepaction that may be used to populate a UI. image string (Optional) Image reference name to run for this StepAction. More info: https://kubernetes.io/docs/concepts/containers/images command []string (Optional) 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 args []string (Optional) 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 env []Kubernetes core/v1.EnvVar (Optional) List of environment variables to set in the container. Cannot be updated. script string (Optional) 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. workingDir string (Optional) 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. params ParamSpecs (Optional) Params is a list of input parameters required to run the stepAction. Params must be supplied as inputs in Steps unless they declare a defaultvalue. results []StepResult (Optional) Results are values that this StepAction can output securityContext Kubernetes core/v1.SecurityContext (Optional) 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/ The value set in StepAction will take precedence over the value from Task. volumeMounts []Kubernetes core/v1.VolumeMount (Optional) Volumes to mount into the Step’s filesystem. Cannot be updated.

VerificationPolicy

VerificationPolicy defines the rules to verify Tekton resources. VerificationPolicy can config the mapping from resources to a list of public keys, so when verifying the resources we can use the corresponding public keys.

Field	Description
apiVersion string	tekton.dev/v1alpha1
kind string	VerificationPolicy
metadata Kubernetes meta/v1.ObjectMeta	(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec VerificationPolicySpec	Spec holds the desired state of the VerificationPolicy. resources []ResourcePattern Resources defines the patterns of resources sources that should be subject to this policy. For example, we may want to apply this Policy from a certain GitHub repo. Then the ResourcesPattern should be valid regex. E.g. If using gitresolver, and we want to config keys from a certain git repo. ResourcesPattern can be https://github.com/tektoncd/catalog.git, we will use regex to filter out those resources. authorities []Authority Authorities defines the rules for validating signatures. mode ModeType (Optional) Mode controls whether a failing policy will fail the taskrun/pipelinerun, or only log the warnings enforce - fail the taskrun/pipelinerun if verification fails (default) warn - don’t fail the taskrun/pipelinerun if verification fails but log warnings

PipelineResource

PipelineResource describes a resource that is an input to or output from a Task.

Deprecated: Unused, preserved only for backwards compatibility

Field	Description
apiVersion string	tekton.dev/v1alpha1
kind string	PipelineResource
metadata Kubernetes meta/v1.ObjectMeta	(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec PipelineResourceSpec	Spec holds the desired state of the PipelineResource from the client description string (Optional) Description is a user-facing description of the resource that may be used to populate a UI. type string params []ResourceParam secrets []SecretParam (Optional) Secrets to fetch to populate some of resource fields
status PipelineResourceStatus	(Optional) Status is used to communicate the observed state of the PipelineResource from the controller, but was unused as there is no controller for PipelineResource.

Authority

(Appears on:VerificationPolicySpec)

The Authority block defines the keys for validating signatures.

Field	Description
name string	Name is the name for this authority.
key KeyRef	Key contains the public key to validate the resource.

EmbeddedRunSpec

(Appears on:RunSpec)

EmbeddedRunSpec allows custom task definitions to be embedded

Field	Description
metadata PipelineTaskMetadata	(Optional)
spec k8s.io/apimachinery/pkg/runtime.RawExtension	(Optional) Spec is a specification of a custom task - []byte Raw is the underlying serialization of this object. TODO: Determine how to detect ContentType and ContentEncoding of ‘Raw’ data. - k8s.io/apimachinery/pkg/runtime.Object Object can hold a representation of this extension - useful for working with versioned structs.

HashAlgorithm (string alias)

(Appears on:KeyRef)

HashAlgorithm defines the hash algorithm used for the public key

KeyRef

(Appears on:Authority)

KeyRef defines the reference to a public key

Field	Description
secretRef Kubernetes core/v1.SecretReference	(Optional) SecretRef sets a reference to a secret with the key.
data string	(Optional) Data contains the inline public key.
kms string	(Optional) KMS contains the KMS url of the public key Supported formats differ based on the KMS system used. One example of a KMS url could be: gcpkms://projects/[PROJECT]/locations/[LOCATION]>/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[KEY_VERSION] For more examples please refer https://docs.sigstore.dev/cosign/kms_support. Note that the KMS is not supported yet.
hashAlgorithm HashAlgorithm	(Optional) HashAlgorithm always defaults to sha256 if the algorithm hasn’t been explicitly set

ModeType (string alias)

(Appears on:VerificationPolicySpec)

ModeType indicates the type of a mode for VerificationPolicy

ResourcePattern

(Appears on:VerificationPolicySpec)

ResourcePattern defines the pattern of the resource source

Field	Description
pattern string	Pattern defines a resource pattern. Regex is created to filter resources based on Pattern Example patterns: GitHub resource: https://github.com/tektoncd/catalog.git, https://github.com/tektoncd/* Bundle resource: gcr.io/tekton-releases/catalog/upstream/git-clone, gcr.io/tekton-releases/catalog/upstream/* Hub resource: https://artifacthub.io/*,

RunReason (string alias)

RunReason is an enum used to store all Run reason for the Succeeded condition that are controlled by the Run itself.

RunSpec

(Appears on:Run)

RunSpec defines the desired state of Run

Field	Description
ref TaskRef	(Optional)
spec EmbeddedRunSpec	(Optional) Spec is a specification of a custom task
params Params	(Optional)
status RunSpecStatus	(Optional) Used for cancelling a run (and maybe more later on)
statusMessage RunSpecStatusMessage	(Optional) Status message for cancellation.
retries int	(Optional) Used for propagating retries count to custom tasks
serviceAccountName string	(Optional)
podTemplate Template	(Optional) PodTemplate holds pod specific configuration
timeout Kubernetes meta/v1.Duration	(Optional) Time after which the custom-task times out. Refer Go’s ParseDuration documentation for expected format: https://golang.org/pkg/time/#ParseDuration
workspaces []WorkspaceBinding	(Optional) Workspaces is a list of WorkspaceBindings from volumes to workspaces.

RunSpecStatus (string alias)

(Appears on:RunSpec)

RunSpecStatus defines the taskrun spec status the user can provide

RunSpecStatusMessage (string alias)

(Appears on:RunSpec)

RunSpecStatusMessage defines human readable status messages for the TaskRun.

StepActionObject

StepActionObject is implemented by StepAction

StepActionSpec

(Appears on:StepAction)

StepActionSpec contains the actionable components of a step.

Field	Description
description string	(Optional) Description is a user-facing description of the stepaction that may be used to populate a UI.
image string	(Optional) Image reference name to run for this StepAction. More info: https://kubernetes.io/docs/concepts/containers/images
command []string	(Optional) 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
args []string	(Optional) 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
env []Kubernetes core/v1.EnvVar	(Optional) List of environment variables to set in the container. Cannot be updated.
script string	(Optional) 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.
workingDir string	(Optional) 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.
params ParamSpecs	(Optional) Params is a list of input parameters required to run the stepAction. Params must be supplied as inputs in Steps unless they declare a defaultvalue.
results []StepResult	(Optional) Results are values that this StepAction can output
securityContext Kubernetes core/v1.SecurityContext	(Optional) 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/ The value set in StepAction will take precedence over the value from Task.
volumeMounts []Kubernetes core/v1.VolumeMount	(Optional) Volumes to mount into the Step’s filesystem. Cannot be updated.

VerificationPolicySpec

(Appears on:VerificationPolicy)

VerificationPolicySpec defines the patterns and authorities.

Field	Description
resources []ResourcePattern	Resources defines the patterns of resources sources that should be subject to this policy. For example, we may want to apply this Policy from a certain GitHub repo. Then the ResourcesPattern should be valid regex. E.g. If using gitresolver, and we want to config keys from a certain git repo. ResourcesPattern can be https://github.com/tektoncd/catalog.git, we will use regex to filter out those resources.
authorities []Authority	Authorities defines the rules for validating signatures.
mode ModeType	(Optional) Mode controls whether a failing policy will fail the taskrun/pipelinerun, or only log the warnings enforce - fail the taskrun/pipelinerun if verification fails (default) warn - don’t fail the taskrun/pipelinerun if verification fails but log warnings

PipelineResourceSpec

(Appears on:PipelineResource, PipelineResourceBinding)

PipelineResourceSpec defines an individual resources used in the pipeline.

Deprecated: Unused, preserved only for backwards compatibility

Field	Description
description string	(Optional) Description is a user-facing description of the resource that may be used to populate a UI.
type string
params []ResourceParam
secrets []SecretParam	(Optional) Secrets to fetch to populate some of resource fields

PipelineResourceStatus

(Appears on:PipelineResource)

PipelineResourceStatus does not contain anything because PipelineResources on their own do not have a status

Deprecated: Unused, preserved only for backwards compatibility

ResourceDeclaration

(Appears on:TaskResource)

ResourceDeclaration defines an input or output PipelineResource declared as a requirement by another type such as a Task or Condition. The Name field will be used to refer to these PipelineResources within the type’s definition, and when provided as an Input, the Name will be the path to the volume mounted containing this PipelineResource as an input (e.g. an input Resource named workspace will be mounted at /workspace).

Deprecated: Unused, preserved only for backwards compatibility

Field	Description
name string	Name declares the name by which a resource is referenced in the definition. Resources may be referenced by name in the definition of a Task’s steps.
type string	Type is the type of this resource;
description string	(Optional) Description is a user-facing description of the declared resource that may be used to populate a UI.
targetPath string	(Optional) TargetPath is the path in workspace directory where the resource will be copied.
optional bool	Optional declares the resource as optional. By default optional is set to false which makes a resource required. optional: true - the resource is considered optional optional: false - the resource is considered required (equivalent of not specifying it)

ResourceParam

(Appears on:PipelineResourceSpec)

ResourceParam declares a string value to use for the parameter called Name, and is used in the specific context of PipelineResources.

Deprecated: Unused, preserved only for backwards compatibility

Field	Description
name string
value string

SecretParam

(Appears on:PipelineResourceSpec)

SecretParam indicates which secret can be used to populate a field of the resource

Deprecated: Unused, preserved only for backwards compatibility

Field	Description
fieldName string
secretKey string
secretName string

RunResult

(Appears on:RunStatusFields)

RunResult used to describe the results of a task

Field	Description
name string	Name the given name
value string	Value the given value of the result

RunStatus

(Appears on:Run, RunStatusFields)

RunStatus defines the observed state of Run

Field	Description
Status knative.dev/pkg/apis/duck/v1.Status	(Members of Status are embedded into this type.)
RunStatusFields RunStatusFields	(Members of RunStatusFields are embedded into this type.) RunStatusFields inlines the status fields.

RunStatusFields

(Appears on:RunStatus)

RunStatusFields holds the fields of Run’s status. This is defined separately and inlined so that other types can readily consume these fields via duck typing.

Field	Description
startTime Kubernetes meta/v1.Time	(Optional) StartTime is the time the build is actually started.
completionTime Kubernetes meta/v1.Time	(Optional) CompletionTime is the time the build completed.
results []RunResult	(Optional) Results reports any output result values to be consumed by later tasks in a pipeline.
retriesStatus []RunStatus	(Optional) RetriesStatus contains the history of RunStatus, in case of a retry.
extraFields k8s.io/apimachinery/pkg/runtime.RawExtension	ExtraFields holds arbitrary fields provided by the custom task controller.

---

tekton.dev/v1beta1

Package v1beta1 contains API Schema definitions for the pipeline v1beta1 API group

Resource Types:

• ClusterTask
• CustomRun
• Pipeline
• PipelineRun
• StepAction
• Task
• TaskRun

ClusterTask

ClusterTask is a Task with a cluster scope. ClusterTasks are used to represent Tasks that should be publicly addressable from any namespace in the cluster.

Deprecated: Please use the cluster resolver instead.

Field	Description
apiVersion string	tekton.dev/v1beta1
kind string	ClusterTask
metadata Kubernetes meta/v1.ObjectMeta	(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec TaskSpec	(Optional) Spec holds the desired state of the Task from the client resources TaskResources (Optional) Resources is a list input and output resource to run the task Resources are represented in TaskRuns as bindings to instances of PipelineResources. Deprecated: Unused, preserved only for backwards compatibility params ParamSpecs (Optional) 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. displayName string (Optional) DisplayName is a user-facing name of the task that may be used to populate a UI. description string (Optional) Description is a user-facing description of the task that may be used to populate a UI. steps []Step Steps are the steps of the build; each step is run sequentially with the source mounted into /workspace. volumes []Kubernetes core/v1.Volume Volumes is a collection of volumes that are available to mount into the steps of the build. stepTemplate StepTemplate StepTemplate can be used as the basis for all step containers within the Task, so that the steps inherit settings on the base container. sidecars []Sidecar Sidecars are run alongside the Task’s step containers. They begin before the steps start and end after the steps complete. workspaces []WorkspaceDeclaration Workspaces are the volumes that this Task requires. results []TaskResult Results are values that this Task can output

CustomRun

CustomRun represents a single execution of a Custom Task.

Field	Description
apiVersion string	tekton.dev/v1beta1
kind string	CustomRun
metadata Kubernetes meta/v1.ObjectMeta	(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec CustomRunSpec	(Optional) customRef TaskRef (Optional) customSpec EmbeddedCustomRunSpec (Optional) Spec is a specification of a custom task params Params (Optional) status CustomRunSpecStatus (Optional) Used for cancelling a customrun (and maybe more later on) statusMessage CustomRunSpecStatusMessage (Optional) Status message for cancellation. retries int (Optional) Used for propagating retries count to custom tasks serviceAccountName string (Optional) timeout Kubernetes meta/v1.Duration (Optional) Time after which the custom-task times out. Refer Go’s ParseDuration documentation for expected format: https://golang.org/pkg/time/#ParseDuration workspaces []WorkspaceBinding (Optional) Workspaces is a list of WorkspaceBindings from volumes to workspaces.
status CustomRunStatus	(Optional)

Pipeline

Pipeline describes a list of Tasks to execute. It expresses how outputs of tasks feed into inputs of subsequent tasks.

Deprecated: Please use v1.Pipeline instead.

Field	Description
apiVersion string	tekton.dev/v1beta1
kind string	Pipeline
metadata Kubernetes meta/v1.ObjectMeta	(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec PipelineSpec	(Optional) Spec holds the desired state of the Pipeline from the client displayName string (Optional) DisplayName is a user-facing name of the pipeline that may be used to populate a UI. description string (Optional) Description is a user-facing description of the pipeline that may be used to populate a UI. resources []PipelineDeclaredResource Deprecated: Unused, preserved only for backwards compatibility tasks []PipelineTask Tasks declares the graph of Tasks that execute when this Pipeline is run. params ParamSpecs Params declares a list of input parameters that must be supplied when this Pipeline is run. workspaces []PipelineWorkspaceDeclaration (Optional) Workspaces declares a set of named workspaces that are expected to be provided by a PipelineRun. results []PipelineResult (Optional) Results are values that this pipeline can output once run finally []PipelineTask Finally declares the list of Tasks that execute just before leaving the Pipeline i.e. either after all Tasks are finished executing successfully or after a failure which would result in ending the Pipeline

PipelineRun

PipelineRun represents a single execution of a Pipeline. PipelineRuns are how the graph of Tasks declared in a Pipeline are executed; they specify inputs to Pipelines such as parameter values and capture operational aspects of the Tasks execution such as service account and tolerations. Creating a PipelineRun creates TaskRuns for Tasks in the referenced Pipeline.

Deprecated: Please use v1.PipelineRun instead.

Field	Description
apiVersion string	tekton.dev/v1beta1
kind string	PipelineRun
metadata Kubernetes meta/v1.ObjectMeta	(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec PipelineRunSpec	(Optional) pipelineRef PipelineRef (Optional) pipelineSpec PipelineSpec (Optional) Specifying PipelineSpec can be disabled by setting disable-inline-spec feature flag.. resources []PipelineResourceBinding Resources is a list of bindings specifying which actual instances of PipelineResources to use for the resources the Pipeline has declared it needs. Deprecated: Unused, preserved only for backwards compatibility params Params Params is a list of parameter names and values. serviceAccountName string (Optional) status PipelineRunSpecStatus (Optional) Used for cancelling a pipelinerun (and maybe more later on) timeouts TimeoutFields (Optional) Time after which the Pipeline times out. Currently three keys are accepted in the map pipeline, tasks and finally with Timeouts.pipeline >= Timeouts.tasks + Timeouts.finally timeout Kubernetes meta/v1.Duration (Optional) Timeout is the Time after which the Pipeline times out. Defaults to never. Refer to Go’s ParseDuration documentation for expected format: https://golang.org/pkg/time/#ParseDuration Deprecated: use pipelineRunSpec.Timeouts.Pipeline instead podTemplate Template PodTemplate holds pod specific configuration workspaces []WorkspaceBinding (Optional) Workspaces holds a set of workspace bindings that must match names with those declared in the pipeline. taskRunSpecs []PipelineTaskRunSpec (Optional) TaskRunSpecs holds a set of runtime specs
status PipelineRunStatus	(Optional)

StepAction

StepAction represents the actionable components of Step. The Step can only reference it from the cluster or using remote resolution.

Field	Description
apiVersion string	tekton.dev/v1beta1
kind string	StepAction
metadata Kubernetes meta/v1.ObjectMeta	(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec StepActionSpec	(Optional) Spec holds the desired state of the Step from the client description string (Optional) Description is a user-facing description of the stepaction that may be used to populate a UI. image string (Optional) Image reference name to run for this StepAction. More info: https://kubernetes.io/docs/concepts/containers/images command []string (Optional) 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 args []string (Optional) 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 env []Kubernetes core/v1.EnvVar (Optional) List of environment variables to set in the container. Cannot be updated. script string (Optional) 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. workingDir string (Optional) 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. params ParamSpecs (Optional) Params is a list of input parameters required to run the stepAction. Params must be supplied as inputs in Steps unless they declare a defaultvalue. results []StepResult (Optional) Results are values that this StepAction can output securityContext Kubernetes core/v1.SecurityContext (Optional) 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/ The value set in StepAction will take precedence over the value from Task. volumeMounts []Kubernetes core/v1.VolumeMount (Optional) Volumes to mount into the Step’s filesystem. Cannot be updated.

Task

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.

Deprecated: Please use v1.Task instead.

Field	Description
apiVersion string	tekton.dev/v1beta1
kind string	Task
metadata Kubernetes meta/v1.ObjectMeta	(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec TaskSpec	(Optional) Spec holds the desired state of the Task from the client resources TaskResources (Optional) Resources is a list input and output resource to run the task Resources are represented in TaskRuns as bindings to instances of PipelineResources. Deprecated: Unused, preserved only for backwards compatibility params ParamSpecs (Optional) 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. displayName string (Optional) DisplayName is a user-facing name of the task that may be used to populate a UI. description string (Optional) Description is a user-facing description of the task that may be used to populate a UI. steps []Step Steps are the steps of the build; each step is run sequentially with the source mounted into /workspace. volumes []Kubernetes core/v1.Volume Volumes is a collection of volumes that are available to mount into the steps of the build. stepTemplate StepTemplate StepTemplate can be used as the basis for all step containers within the Task, so that the steps inherit settings on the base container. sidecars []Sidecar Sidecars are run alongside the Task’s step containers. They begin before the steps start and end after the steps complete. workspaces []WorkspaceDeclaration Workspaces are the volumes that this Task requires. results []TaskResult Results are values that this Task can output

TaskRun

TaskRun represents a single execution of a Task. TaskRuns are how the steps specified in a Task are executed; they specify the parameters and resources used to run the steps in a Task.

Deprecated: Please use v1.TaskRun instead.

Field	Description
apiVersion string	tekton.dev/v1beta1
kind string	TaskRun
metadata Kubernetes meta/v1.ObjectMeta	(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec TaskRunSpec	(Optional) debug TaskRunDebug (Optional) params Params (Optional) resources TaskRunResources (Optional) Deprecated: Unused, preserved only for backwards compatibility serviceAccountName string (Optional) taskRef TaskRef (Optional) no more than one of the TaskRef and TaskSpec may be specified. taskSpec TaskSpec (Optional) Specifying PipelineSpec can be disabled by setting disable-inline-spec feature flag.. status TaskRunSpecStatus (Optional) Used for cancelling a TaskRun (and maybe more later on) statusMessage TaskRunSpecStatusMessage (Optional) Status message for cancellation. retries int (Optional) Retries represents how many times this TaskRun should be retried in the event of Task failure. timeout Kubernetes meta/v1.Duration (Optional) Time after which one retry attempt times out. Defaults to 1 hour. Refer Go’s ParseDuration documentation for expected format: https://golang.org/pkg/time/#ParseDuration podTemplate Template PodTemplate holds pod specific configuration workspaces []WorkspaceBinding (Optional) Workspaces is a list of WorkspaceBindings from volumes to workspaces. stepOverrides []TaskRunStepOverride (Optional) Overrides to apply to Steps in this TaskRun. If a field is specified in both a Step and a StepOverride, the value from the StepOverride will be used. This field is only supported when the alpha feature gate is enabled. sidecarOverrides []TaskRunSidecarOverride (Optional) Overrides to apply to Sidecars in this TaskRun. If a field is specified in both a Sidecar and a SidecarOverride, the value from the SidecarOverride will be used. This field is only supported when the alpha feature gate is enabled. computeResources Kubernetes core/v1.ResourceRequirements Compute resources to use for this TaskRun
status TaskRunStatus	(Optional)

Algorithm (string alias)

Algorithm Standard cryptographic hash algorithm

Artifact

(Appears on:Artifacts, StepState)

TaskRunStepArtifact represents an artifact produced or used by a step within a task run. It directly uses the Artifact type for its structure.

Field	Description
name string	The artifact’s identifying category name
values []ArtifactValue	A collection of values related to the artifact
buildOutput bool	Indicate if the artifact is a build output or a by-product

ArtifactValue

(Appears on:Artifact)

ArtifactValue represents a specific value or data element within an Artifact.

Field	Description
digest map[github.com/tektoncd/pipeline/pkg/apis/pipeline/v1beta1.Algorithm]string
uri string	Algorithm-specific digests for verifying the content (e.g., SHA256)

Artifacts

Artifacts represents the collection of input and output artifacts associated with a task run or a similar process. Artifacts in this context are units of data or resources that the process either consumes as input or produces as output.

Field	Description
inputs []Artifact
outputs []Artifact

ChildStatusReference

(Appears on:PipelineRunStatusFields)

ChildStatusReference is used to point to the statuses of individual TaskRuns and Runs within this PipelineRun.

Field	Description
name string	Name is the name of the TaskRun or Run this is referencing.
displayName string	DisplayName is a user-facing name of the pipelineTask that may be used to populate a UI.
pipelineTaskName string	PipelineTaskName is the name of the PipelineTask this is referencing.
whenExpressions []WhenExpression	(Optional) WhenExpressions is the list of checks guarding the execution of the PipelineTask

CloudEventCondition (string alias)

(Appears on:CloudEventDeliveryState)

CloudEventCondition is a string that represents the condition of the event.

CloudEventDelivery

(Appears on:TaskRunStatusFields)

CloudEventDelivery is the target of a cloud event along with the state of delivery.

Field	Description
target string	Target points to an addressable
status CloudEventDeliveryState

CloudEventDeliveryState

(Appears on:CloudEventDelivery)

CloudEventDeliveryState reports the state of a cloud event to be sent.

Field	Description
condition CloudEventCondition	Current status
sentAt Kubernetes meta/v1.Time	(Optional) SentAt is the time at which the last attempt to send the event was made
message string	Error is the text of error (if any)
retryCount int32	RetryCount is the number of attempts of sending the cloud event

Combination (map[string]string alias)

Combination is a map, mainly defined to hold a single combination from a Matrix with key as param.Name and value as param.Value

Combinations ([]github.com/tektoncd/pipeline/pkg/apis/pipeline/v1beta1.Combination alias)

Combinations is a Combination list

ConfigSource

(Appears on:Provenance)

ConfigSource contains the information that can uniquely identify where a remote built definition came from i.e. Git repositories, Tekton Bundles in OCI registry and hub.

Field	Description
uri string	URI indicates the identity of the source of the build definition. Example: “https://github.com/tektoncd/catalog”
digest map[string]string	Digest is a collection of cryptographic digests for the contents of the artifact specified by URI. Example: {“sha1”: “f99d13e554ffcb696dee719fa85b695cb5b0f428”}
entryPoint string	EntryPoint identifies the entry point into the build. This is often a path to a build definition file and/or a target label within that file. Example: “task/git-clone/0.8/git-clone.yaml”

CustomRunReason (string alias)

CustomRunReason is an enum used to store all Run reason for the Succeeded condition that are controlled by the CustomRun itself.

CustomRunSpec

(Appears on:CustomRun)

CustomRunSpec defines the desired state of CustomRun

Field	Description
customRef TaskRef	(Optional)
customSpec EmbeddedCustomRunSpec	(Optional) Spec is a specification of a custom task
params Params	(Optional)
status CustomRunSpecStatus	(Optional) Used for cancelling a customrun (and maybe more later on)
statusMessage CustomRunSpecStatusMessage	(Optional) Status message for cancellation.
retries int	(Optional) Used for propagating retries count to custom tasks
serviceAccountName string	(Optional)
timeout Kubernetes meta/v1.Duration	(Optional) Time after which the custom-task times out. Refer Go’s ParseDuration documentation for expected format: https://golang.org/pkg/time/#ParseDuration
workspaces []WorkspaceBinding	(Optional) Workspaces is a list of WorkspaceBindings from volumes to workspaces.

CustomRunSpecStatus (string alias)

(Appears on:CustomRunSpec)

CustomRunSpecStatus defines the taskrun spec status the user can provide

CustomRunSpecStatusMessage (string alias)

(Appears on:CustomRunSpec)

CustomRunSpecStatusMessage defines human readable status messages for the TaskRun.

EmbeddedCustomRunSpec

(Appears on:CustomRunSpec)

EmbeddedCustomRunSpec allows custom task definitions to be embedded

Field	Description
metadata PipelineTaskMetadata	(Optional)
spec k8s.io/apimachinery/pkg/runtime.RawExtension	(Optional) Spec is a specification of a custom task - []byte Raw is the underlying serialization of this object. TODO: Determine how to detect ContentType and ContentEncoding of ‘Raw’ data. - k8s.io/apimachinery/pkg/runtime.Object Object can hold a representation of this extension - useful for working with versioned structs.

EmbeddedTask

(Appears on:PipelineTask)

EmbeddedTask is used to define a Task inline within a Pipeline’s PipelineTasks.

Field	Description
spec k8s.io/apimachinery/pkg/runtime.RawExtension	(Optional) Spec is a specification of a custom task - []byte Raw is the underlying serialization of this object. TODO: Determine how to detect ContentType and ContentEncoding of ‘Raw’ data. - k8s.io/apimachinery/pkg/runtime.Object Object can hold a representation of this extension - useful for working with versioned structs.
metadata PipelineTaskMetadata	(Optional)
TaskSpec TaskSpec	(Members of TaskSpec are embedded into this type.) (Optional) TaskSpec is a specification of a task

IncludeParams

IncludeParams allows passing in a specific combinations of Parameters into the Matrix.

Field	Description
name string	Name the specified combination
params Params	Params takes only Parameters of type "string" The names of the params must match the names of the params in the underlying Task

InternalTaskModifier

InternalTaskModifier implements TaskModifier for resources that are built-in to Tekton Pipelines.

Deprecated: Unused, preserved only for backwards compatibility

Field	Description
stepsToPrepend []Step
stepsToAppend []Step
volumes []Kubernetes core/v1.Volume

Matrix

(Appears on:PipelineTask)

Matrix is used to fan out Tasks in a Pipeline

Field	Description
params Params	Params is a list of parameters used to fan out the pipelineTask Params takes only Parameters of type "array" Each array element is supplied to the PipelineTask by substituting params of type "string" in the underlying Task. The names of the params in the Matrix must match the names of the params in the underlying Task that they will be substituting.
include IncludeParamsList	(Optional) Include is a list of IncludeParams which allows passing in specific combinations of Parameters into the Matrix.

OnErrorType (string alias)

(Appears on:Step)

OnErrorType defines a list of supported exiting behavior of a container on error

Param

(Appears on:TaskRunInputs)

Param declares an ParamValues to use for the parameter called name.

Field	Description
name string
value ParamValue

ParamSpec

ParamSpec defines arbitrary parameters needed beyond typed inputs (such as resources). Parameter values are provided by users as inputs on a TaskRun or PipelineRun.

Field	Description
name string	Name declares the name by which a parameter is referenced.
type ParamType	(Optional) Type is the user-specified type of the parameter. The possible types are currently “string”, “array” and “object”, and “string” is the default.
description string	(Optional) Description is a user-facing description of the parameter that may be used to populate a UI.
properties map[string]github.com/tektoncd/pipeline/pkg/apis/pipeline/v1beta1.PropertySpec	(Optional) Properties is the JSON Schema properties to support key-value pairs parameter.
default ParamValue	(Optional) 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.
enum []string	(Optional) 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.

ParamSpecs ([]github.com/tektoncd/pipeline/pkg/apis/pipeline/v1beta1.ParamSpec alias)

(Appears on:PipelineSpec, TaskSpec)

ParamSpecs is a list of ParamSpec

ParamType (string alias)

(Appears on:ParamSpec, ParamValue, PropertySpec)

ParamType indicates the type of an input parameter; Used to distinguish between a single string and an array of strings.

ParamValue

(Appears on:Param, ParamSpec, PipelineResult, PipelineRunResult, TaskResult, TaskRunResult)

ResultValue is a type alias of ParamValue

Field	Description
Type ParamType
StringVal string	Represents the stored type of ParamValues.
ArrayVal []string
ObjectVal map[string]string

Params ([]github.com/tektoncd/pipeline/pkg/apis/pipeline/v1beta1.Param alias)

(Appears on:RunSpec, CustomRunSpec, IncludeParams, Matrix, PipelineRunSpec, PipelineTask, ResolverRef, Step, TaskRunSpec)

Params is a list of Param

PipelineDeclaredResource

(Appears on:PipelineSpec)

PipelineDeclaredResource is used by a Pipeline to declare the types of the PipelineResources that it will required to run and names which can be used to refer to these PipelineResources in PipelineTaskResourceBindings.

Deprecated: Unused, preserved only for backwards compatibility

Field	Description
name string	Name is the name that will be used by the Pipeline to refer to this resource. It does not directly correspond to the name of any PipelineResources Task inputs or outputs, and it does not correspond to the actual names of the PipelineResources that will be bound in the PipelineRun.
type string	Type is the type of the PipelineResource.
optional bool	Optional declares the resource as optional. optional: true - the resource is considered optional optional: false - the resource is considered required (default/equivalent of not specifying it)

PipelineObject

PipelineObject is implemented by Pipeline

PipelineRef

(Appears on:PipelineRunSpec, PipelineTask)

PipelineRef can be used to refer to a specific instance of a Pipeline.

Field	Description
name string	Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
apiVersion string	(Optional) API version of the referent
bundle string	(Optional) Bundle url reference to a Tekton Bundle. Deprecated: Please use ResolverRef with the bundles resolver instead. The field is staying there for go client backward compatibility, but is not used/allowed anymore.
ResolverRef ResolverRef	(Optional) ResolverRef allows referencing a Pipeline in a remote location like a git repo. This field is only supported when the alpha feature gate is enabled.

PipelineResourceBinding

(Appears on:PipelineRunSpec, TaskResourceBinding)

PipelineResourceBinding connects a reference to an instance of a PipelineResource with a PipelineResource dependency that the Pipeline has declared

Deprecated: Unused, preserved only for backwards compatibility

Field	Description
name string	Name is the name of the PipelineResource in the Pipeline’s declaration
resourceRef PipelineResourceRef	(Optional) ResourceRef is a reference to the instance of the actual PipelineResource that should be used
resourceSpec PipelineResourceSpec	(Optional) ResourceSpec is specification of a resource that should be created and consumed by the task

PipelineResourceInterface

PipelineResourceInterface interface to be implemented by different PipelineResource types

Deprecated: Unused, preserved only for backwards compatibility

PipelineResourceRef

(Appears on:PipelineResourceBinding)

PipelineResourceRef can be used to refer to a specific instance of a Resource

Deprecated: Unused, preserved only for backwards compatibility

Field	Description
name string	Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
apiVersion string	(Optional) API version of the referent

PipelineResult

(Appears on:PipelineSpec)

PipelineResult used to describe the results of a pipeline

Field	Description
name string	Name the given name
type ResultsType	Type is the user-specified type of the result. The possible types are ‘string’, ‘array’, and ‘object’, with ‘string’ as the default. ‘array’ and ‘object’ types are alpha features.
description string	(Optional) Description is a human-readable description of the result
value ParamValue	Value the expression used to retrieve the value

PipelineRunReason (string alias)

PipelineRunReason represents a reason for the pipeline run “Succeeded” condition

PipelineRunResult

(Appears on:PipelineRunStatusFields)

PipelineRunResult used to describe the results of a pipeline

Field	Description
name string	Name is the result’s name as declared by the Pipeline
value ParamValue	Value is the result returned from the execution of this PipelineRun

PipelineRunRunStatus

(Appears on:PipelineRunStatusFields)

PipelineRunRunStatus contains the name of the PipelineTask for this CustomRun or Run and the CustomRun or Run’s Status

Field	Description
pipelineTaskName string	PipelineTaskName is the name of the PipelineTask.
status CustomRunStatus	(Optional) Status is the CustomRunStatus for the corresponding CustomRun or Run
whenExpressions []WhenExpression	(Optional) WhenExpressions is the list of checks guarding the execution of the PipelineTask

PipelineRunSpec

(Appears on:PipelineRun)

PipelineRunSpec defines the desired state of PipelineRun

Field	Description
pipelineRef PipelineRef	(Optional)
pipelineSpec PipelineSpec	(Optional) Specifying PipelineSpec can be disabled by setting disable-inline-spec feature flag..
resources []PipelineResourceBinding	Resources is a list of bindings specifying which actual instances of PipelineResources to use for the resources the Pipeline has declared it needs. Deprecated: Unused, preserved only for backwards compatibility
params Params	Params is a list of parameter names and values.
serviceAccountName string	(Optional)
status PipelineRunSpecStatus	(Optional) Used for cancelling a pipelinerun (and maybe more later on)
timeouts TimeoutFields	(Optional) Time after which the Pipeline times out. Currently three keys are accepted in the map pipeline, tasks and finally with Timeouts.pipeline >= Timeouts.tasks + Timeouts.finally
timeout Kubernetes meta/v1.Duration	(Optional) Timeout is the Time after which the Pipeline times out. Defaults to never. Refer to Go’s ParseDuration documentation for expected format: https://golang.org/pkg/time/#ParseDuration Deprecated: use pipelineRunSpec.Timeouts.Pipeline instead
podTemplate Template	PodTemplate holds pod specific configuration
workspaces []WorkspaceBinding	(Optional) Workspaces holds a set of workspace bindings that must match names with those declared in the pipeline.
taskRunSpecs []PipelineTaskRunSpec	(Optional) TaskRunSpecs holds a set of runtime specs

PipelineRunSpecStatus (string alias)

(Appears on:PipelineRunSpec)

PipelineRunSpecStatus defines the pipelinerun spec status the user can provide

PipelineRunStatus

(Appears on:PipelineRun)

PipelineRunStatus defines the observed state of PipelineRun

Field	Description
Status knative.dev/pkg/apis/duck/v1.Status	(Members of Status are embedded into this type.)
PipelineRunStatusFields PipelineRunStatusFields	(Members of PipelineRunStatusFields are embedded into this type.) PipelineRunStatusFields inlines the status fields.

PipelineRunStatusFields

(Appears on:PipelineRunStatus)

PipelineRunStatusFields holds the fields of PipelineRunStatus’ status. This is defined separately and inlined so that other types can readily consume these fields via duck typing.

Field	Description
startTime Kubernetes meta/v1.Time	StartTime is the time the PipelineRun is actually started.
completionTime Kubernetes meta/v1.Time	CompletionTime is the time the PipelineRun completed.
taskRuns map[string]*github.com/tektoncd/pipeline/pkg/apis/pipeline/v1beta1.PipelineRunTaskRunStatus	(Optional) TaskRuns is a map of PipelineRunTaskRunStatus with the taskRun name as the key. Deprecated: use ChildReferences instead. As of v0.45.0, this field is no longer populated and is only included for backwards compatibility with older server versions.
runs map[string]*github.com/tektoncd/pipeline/pkg/apis/pipeline/v1beta1.PipelineRunRunStatus	(Optional) Runs is a map of PipelineRunRunStatus with the run name as the key Deprecated: use ChildReferences instead. As of v0.45.0, this field is no longer populated and is only included for backwards compatibility with older server versions.
pipelineResults []PipelineRunResult	(Optional) PipelineResults are the list of results written out by the pipeline task’s containers
pipelineSpec PipelineSpec	PipelineRunSpec contains the exact spec used to instantiate the run
skippedTasks []SkippedTask	(Optional) list of tasks that were skipped due to when expressions evaluating to false
childReferences []ChildStatusReference	(Optional) list of TaskRun and Run names, PipelineTask names, and API versions/kinds for children of this PipelineRun.
finallyStartTime Kubernetes meta/v1.Time	(Optional) FinallyStartTime is when all non-finally tasks have been completed and only finally tasks are being executed.
provenance Provenance	(Optional) Provenance contains some key authenticated metadata about how a software artifact was built (what sources, what inputs/outputs, etc.).
spanContext map[string]string	SpanContext contains tracing span context fields

PipelineRunTaskRunStatus

(Appears on:PipelineRunStatusFields)

PipelineRunTaskRunStatus contains the name of the PipelineTask for this TaskRun and the TaskRun’s Status

Field	Description
pipelineTaskName string	PipelineTaskName is the name of the PipelineTask.
status TaskRunStatus	(Optional) Status is the TaskRunStatus for the corresponding TaskRun
whenExpressions []WhenExpression	(Optional) WhenExpressions is the list of checks guarding the execution of the PipelineTask

PipelineSpec

(Appears on:Pipeline, PipelineRunSpec, PipelineRunStatusFields, PipelineTask)

PipelineSpec defines the desired state of Pipeline.

Field	Description
displayName string	(Optional) DisplayName is a user-facing name of the pipeline that may be used to populate a UI.
description string	(Optional) Description is a user-facing description of the pipeline that may be used to populate a UI.
resources []PipelineDeclaredResource	Deprecated: Unused, preserved only for backwards compatibility
tasks []PipelineTask	Tasks declares the graph of Tasks that execute when this Pipeline is run.
params ParamSpecs	Params declares a list of input parameters that must be supplied when this Pipeline is run.
workspaces []PipelineWorkspaceDeclaration	(Optional) Workspaces declares a set of named workspaces that are expected to be provided by a PipelineRun.
results []PipelineResult	(Optional) Results are values that this pipeline can output once run
finally []PipelineTask	Finally declares the list of Tasks that execute just before leaving the Pipeline i.e. either after all Tasks are finished executing successfully or after a failure which would result in ending the Pipeline

PipelineTask

(Appears on:PipelineSpec)

PipelineTask defines a task in a Pipeline, passing inputs from both Params and from the output of previous tasks.

Field	Description
name string	Name is the name of this task within the context of a Pipeline. Name is used as a coordinate with the from and runAfter fields to establish the execution order of tasks relative to one another.
displayName string	(Optional) DisplayName is the display name of this task within the context of a Pipeline. This display name may be used to populate a UI.
description string	(Optional) Description is the description of this task within the context of a Pipeline. This description may be used to populate a UI.
taskRef TaskRef	(Optional) TaskRef is a reference to a task definition.
taskSpec EmbeddedTask	(Optional) TaskSpec is a specification of a task Specifying TaskSpec can be disabled by setting disable-inline-spec feature flag..
when WhenExpressions	(Optional) WhenExpressions is a list of when expressions that need to be true for the task to run
retries int	(Optional) Retries represents how many times this task should be retried in case of task failure: ConditionSucceeded set to False
runAfter []string	(Optional) RunAfter is the list of PipelineTask names that should be executed before this Task executes. (Used to force a specific ordering in graph execution.)
resources PipelineTaskResources	(Optional) Deprecated: Unused, preserved only for backwards compatibility
params Params	(Optional) Parameters declares parameters passed to this task.
matrix Matrix	(Optional) Matrix declares parameters used to fan out this task.
workspaces []WorkspacePipelineTaskBinding	(Optional) Workspaces maps workspaces from the pipeline spec to the workspaces declared in the Task.
timeout Kubernetes meta/v1.Duration	(Optional) Time after which the TaskRun times out. Defaults to 1 hour. Refer Go’s ParseDuration documentation for expected format: https://golang.org/pkg/time/#ParseDuration
pipelineRef PipelineRef	(Optional) PipelineRef is a reference to a pipeline definition Note: PipelineRef is in preview mode and not yet supported
pipelineSpec PipelineSpec	(Optional) PipelineSpec is a specification of a pipeline Note: PipelineSpec is in preview mode and not yet supported Specifying TaskSpec can be disabled by setting disable-inline-spec feature flag..
onError PipelineTaskOnErrorType	(Optional) OnError defines the exiting behavior of a PipelineRun on error can be set to [ continue | stopAndFail ]

PipelineTaskInputResource

(Appears on:PipelineTaskResources)

PipelineTaskInputResource maps the name of a declared PipelineResource input dependency in a Task to the resource in the Pipeline’s DeclaredPipelineResources that should be used. This input may come from a previous task.

Deprecated: Unused, preserved only for backwards compatibility

Field	Description
name string	Name is the name of the PipelineResource as declared by the Task.
resource string	Resource is the name of the DeclaredPipelineResource to use.
from []string	(Optional) From is the list of PipelineTask names that the resource has to come from. (Implies an ordering in the execution graph.)

PipelineTaskMetadata

(Appears on:EmbeddedRunSpec, EmbeddedCustomRunSpec, EmbeddedTask, PipelineTaskRunSpec)

PipelineTaskMetadata contains the labels or annotations for an EmbeddedTask

Field	Description
labels map[string]string	(Optional)
annotations map[string]string	(Optional)

PipelineTaskOnErrorType (string alias)

(Appears on:PipelineTask)

PipelineTaskOnErrorType defines a list of supported failure handling behaviors of a PipelineTask on error

PipelineTaskOutputResource

(Appears on:PipelineTaskResources)

PipelineTaskOutputResource maps the name of a declared PipelineResource output dependency in a Task to the resource in the Pipeline’s DeclaredPipelineResources that should be used.

Deprecated: Unused, preserved only for backwards compatibility

Field	Description
name string	Name is the name of the PipelineResource as declared by the Task.
resource string	Resource is the name of the DeclaredPipelineResource to use.

PipelineTaskParam

PipelineTaskParam is used to provide arbitrary string parameters to a Task.

Field	Description
name string
value string

PipelineTaskResources

(Appears on:PipelineTask)

PipelineTaskResources allows a Pipeline to declare how its DeclaredPipelineResources should be provided to a Task as its inputs and outputs.

Deprecated: Unused, preserved only for backwards compatibility

Field	Description
inputs []PipelineTaskInputResource	Inputs holds the mapping from the PipelineResources declared in DeclaredPipelineResources to the input PipelineResources required by the Task.
outputs []PipelineTaskOutputResource	Outputs holds the mapping from the PipelineResources declared in DeclaredPipelineResources to the input PipelineResources required by the Task.

PipelineTaskRun

PipelineTaskRun reports the results of running a step in the Task. Each task has the potential to succeed or fail (based on the exit code) and produces logs.

Field	Description
name string

PipelineTaskRunSpec

(Appears on:PipelineRunSpec)

PipelineTaskRunSpec can be used to configure specific specs for a concrete Task

Field	Description
pipelineTaskName string
taskServiceAccountName string
taskPodTemplate Template
stepOverrides []TaskRunStepOverride
sidecarOverrides []TaskRunSidecarOverride
metadata PipelineTaskMetadata	(Optional)
computeResources Kubernetes core/v1.ResourceRequirements	Compute resources to use for this TaskRun

PipelineWorkspaceDeclaration

(Appears on:PipelineSpec)

WorkspacePipelineDeclaration creates a named slot in a Pipeline that a PipelineRun is expected to populate with a workspace binding.

Deprecated: use PipelineWorkspaceDeclaration type instead

Field	Description
name string	Name is the name of a workspace to be provided by a PipelineRun.
description string	(Optional) Description is a human readable string describing how the workspace will be used in the Pipeline. It can be useful to include a bit of detail about which tasks are intended to have access to the data on the workspace.
optional bool	Optional marks a Workspace as not being required in PipelineRuns. By default this field is false and so declared workspaces are required.

PropertySpec

(Appears on:ParamSpec, TaskResult)

PropertySpec defines the struct for object keys

Field	Description
type ParamType

Provenance

(Appears on:PipelineRunStatusFields, StepState, TaskRunStatusFields)

Provenance contains metadata about resources used in the TaskRun/PipelineRun such as the source from where a remote build definition was fetched. This field aims to carry minimum amoumt of metadata in *Run status so that Tekton Chains can capture them in the provenance.

Field	Description
configSource ConfigSource	Deprecated: Use RefSource instead
refSource RefSource	RefSource identifies the source where a remote task/pipeline came from.
featureFlags github.com/tektoncd/pipeline/pkg/apis/config.FeatureFlags	FeatureFlags identifies the feature flags that were used during the task/pipeline run

Ref

(Appears on:Step)

Ref can be used to refer to a specific instance of a StepAction.

Field	Description
name string	Name of the referenced step
ResolverRef ResolverRef	(Optional) ResolverRef allows referencing a StepAction in a remote location like a git repo.

RefSource

(Appears on:Provenance)

RefSource contains the information that can uniquely identify where a remote built definition came from i.e. Git repositories, Tekton Bundles in OCI registry and hub.

Field	Description
uri string	URI indicates the identity of the source of the build definition. Example: “https://github.com/tektoncd/catalog”
digest map[string]string	Digest is a collection of cryptographic digests for the contents of the artifact specified by URI. Example: {“sha1”: “f99d13e554ffcb696dee719fa85b695cb5b0f428”}
entryPoint string	EntryPoint identifies the entry point into the build. This is often a path to a build definition file and/or a target label within that file. Example: “task/git-clone/0.8/git-clone.yaml”

ResolverName (string alias)

(Appears on:ResolverRef)

ResolverName is the name of a resolver from which a resource can be requested.

ResolverRef

(Appears on:PipelineRef, Ref, TaskRef)

ResolverRef can be used to refer to a Pipeline or Task in a remote location like a git repo.

Field	Description
resolver ResolverName	(Optional) Resolver is the name of the resolver that should perform resolution of the referenced Tekton resource, such as “git”.
params Params	(Optional) 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.

ResultRef

ResultRef is a type that represents a reference to a task run result

Field	Description
pipelineTask string
result string
resultsIndex int
property string

ResultsType (string alias)

(Appears on:PipelineResult, TaskResult, TaskRunResult)

ResultsType indicates the type of a result; Used to distinguish between a single string and an array of strings. Note that there is ResultType used to find out whether a RunResult is from a task result or not, which is different from this ResultsType.

RunObject

RunObject is implemented by CustomRun and Run

Sidecar

(Appears on:TaskSpec)

Sidecar has nearly the same data structure as Step but does not have the ability to timeout.

Field	Description
name string	Name of the Sidecar specified as a DNS_LABEL. Each Sidecar in a Task must have a unique name (DNS_LABEL). Cannot be updated.
image string	(Optional) Image name to be used by the Sidecar. More info: https://kubernetes.io/docs/concepts/containers/images
command []string	(Optional) 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
args []string	(Optional) 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
workingDir string	(Optional) 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.
ports []Kubernetes core/v1.ContainerPort	(Optional) 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.
envFrom []Kubernetes core/v1.EnvFromSource	(Optional) 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 Sidecar 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.
env []Kubernetes core/v1.EnvVar	(Optional) List of environment variables to set in the Sidecar. Cannot be updated.
resources Kubernetes core/v1.ResourceRequirements	(Optional) Compute Resources required by this Sidecar. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
volumeMounts []Kubernetes core/v1.VolumeMount	(Optional) Volumes to mount into the Sidecar’s filesystem. Cannot be updated.
volumeDevices []Kubernetes core/v1.VolumeDevice	(Optional) volumeDevices is the list of block devices to be used by the Sidecar.
livenessProbe Kubernetes core/v1.Probe	(Optional) 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
readinessProbe Kubernetes core/v1.Probe	(Optional) 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
startupProbe Kubernetes core/v1.Probe	(Optional) 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
lifecycle Kubernetes core/v1.Lifecycle	(Optional) Actions that the management system should take in response to Sidecar lifecycle events. Cannot be updated.
terminationMessagePath string	(Optional) 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.
terminationMessagePolicy Kubernetes core/v1.TerminationMessagePolicy	(Optional) 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.
imagePullPolicy Kubernetes core/v1.PullPolicy	(Optional) 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
securityContext Kubernetes core/v1.SecurityContext	(Optional) 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/
stdin bool	(Optional) 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.
stdinOnce bool	(Optional) 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
tty bool	(Optional) Whether this Sidecar should allocate a TTY for itself, also requires ‘stdin’ to be true. Default is false.
script string	(Optional) Script is the contents of an executable file to execute. If Script is not empty, the Step cannot have an Command or Args.
workspaces []WorkspaceUsage	(Optional) 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.
restartPolicy Kubernetes core/v1.ContainerRestartPolicy	(Optional) 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.

SidecarState

(Appears on:TaskRunStatusFields)

SidecarState reports the results of running a sidecar in a Task.

Field	Description
ContainerState Kubernetes core/v1.ContainerState	(Members of ContainerState are embedded into this type.)
name string
container string
imageID string

SkippedTask

(Appears on:PipelineRunStatusFields)

SkippedTask is used to describe the Tasks that were skipped due to their When Expressions evaluating to False. This is a struct because we are looking into including more details about the When Expressions that caused this Task to be skipped.

Field	Description
name string	Name is the Pipeline Task name
reason SkippingReason	Reason is the cause of the PipelineTask being skipped.
whenExpressions []WhenExpression	(Optional) WhenExpressions is the list of checks guarding the execution of the PipelineTask

SkippingReason (string alias)

(Appears on:SkippedTask)

SkippingReason explains why a PipelineTask was skipped.

Step

(Appears on:InternalTaskModifier, TaskSpec)

Step runs a subcomponent of a Task

Field	Description
name string	Name of the Step specified as a DNS_LABEL. Each Step in a Task must have a unique name.
image string	(Optional) Image reference name to run for this Step. More info: https://kubernetes.io/docs/concepts/containers/images
command []string	(Optional) 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
args []string	(Optional) 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
workingDir string	(Optional) 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.
ports []Kubernetes core/v1.ContainerPort	(Optional) List of ports to expose from the Step’s container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default “0.0.0.0” address inside a container will be accessible from the network. Cannot be updated. Deprecated: This field will be removed in a future release.
envFrom []Kubernetes core/v1.EnvFromSource	(Optional) List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.
env []Kubernetes core/v1.EnvVar	(Optional) List of environment variables to set in the container. Cannot be updated.
resources Kubernetes core/v1.ResourceRequirements	(Optional) Compute Resources required by this Step. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
volumeMounts []Kubernetes core/v1.VolumeMount	(Optional) Volumes to mount into the Step’s filesystem. Cannot be updated.
volumeDevices []Kubernetes core/v1.VolumeDevice	(Optional) volumeDevices is the list of block devices to be used by the Step.
livenessProbe Kubernetes core/v1.Probe	(Optional) Periodic probe of container liveness. Step will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Deprecated: This field will be removed in a future release.
readinessProbe Kubernetes core/v1.Probe	(Optional) Periodic probe of container service readiness. Step 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 Deprecated: This field will be removed in a future release.
startupProbe Kubernetes core/v1.Probe	(Optional) DeprecatedStartupProbe indicates that the Pod this Step runs 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 Deprecated: This field will be removed in a future release.
lifecycle Kubernetes core/v1.Lifecycle	(Optional) Actions that the management system should take in response to container lifecycle events. Cannot be updated. Deprecated: This field will be removed in a future release.
terminationMessagePath string	(Optional) Deprecated: This field will be removed in a future release and can’t be meaningfully used.
terminationMessagePolicy Kubernetes core/v1.TerminationMessagePolicy	(Optional) Deprecated: This field will be removed in a future release and can’t be meaningfully used.
imagePullPolicy Kubernetes core/v1.PullPolicy	(Optional) 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
securityContext Kubernetes core/v1.SecurityContext	(Optional) 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/
stdin bool	(Optional) Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. Deprecated: This field will be removed in a future release.
stdinOnce bool	(Optional) Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false Deprecated: This field will be removed in a future release.
tty bool	(Optional) Whether this container should allocate a DeprecatedTTY for itself, also requires ‘stdin’ to be true. Default is false. Deprecated: This field will be removed in a future release.
script string	(Optional) 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.
timeout Kubernetes meta/v1.Duration	(Optional) 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
workspaces []WorkspaceUsage	(Optional) 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.
onError OnErrorType	OnError defines the exiting behavior of a container on error can be set to [ continue | stopAndFail ]
stdoutConfig StepOutputConfig	(Optional) Stores configuration for the stdout stream of the step.
stderrConfig StepOutputConfig	(Optional) Stores configuration for the stderr stream of the step.
ref Ref	(Optional) Contains the reference to an existing StepAction.
params Params	(Optional) Params declares parameters passed to this step action.
results []StepResult	(Optional) Results declares StepResults produced by the Step. This is field is at an ALPHA stability level and gated by “enable-step-actions” feature flag. 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 [v1beta1.Step.Ref]. The Results declared by the StepActions will be stored here instead.
when WhenExpressions

StepActionObject

StepActionObject is implemented by StepAction

StepActionSpec

(Appears on:StepAction)

StepActionSpec contains the actionable components of a step.

Field	Description
description string	(Optional) Description is a user-facing description of the stepaction that may be used to populate a UI.
image string	(Optional) Image reference name to run for this StepAction. More info: https://kubernetes.io/docs/concepts/containers/images
command []string	(Optional) 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
args []string	(Optional) 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
env []Kubernetes core/v1.EnvVar	(Optional) List of environment variables to set in the container. Cannot be updated.
script string	(Optional) 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.
workingDir string	(Optional) 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.
params ParamSpecs	(Optional) Params is a list of input parameters required to run the stepAction. Params must be supplied as inputs in Steps unless they declare a defaultvalue.
results []StepResult	(Optional) Results are values that this StepAction can output
securityContext Kubernetes core/v1.SecurityContext	(Optional) 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/ The value set in StepAction will take precedence over the value from Task.
volumeMounts []Kubernetes core/v1.VolumeMount	(Optional) Volumes to mount into the Step’s filesystem. Cannot be updated.

StepOutputConfig

(Appears on:Step)

StepOutputConfig stores configuration for a step output stream.

Field	Description
path string	(Optional) Path to duplicate stdout stream to on container’s local filesystem.

StepState

(Appears on:TaskRunStatusFields)

StepState reports the results of running a step in a Task.

Field	Description
ContainerState Kubernetes core/v1.ContainerState	(Members of ContainerState are embedded into this type.)
name string
container string
imageID string
results []TaskRunResult
provenance Provenance
inputs []Artifact
outputs []Artifact

StepTemplate

(Appears on:TaskSpec)

StepTemplate is a template for a Step

Field	Description
name string	Default name for each Step specified as a DNS_LABEL. Each Step in a Task must have a unique name. Cannot be updated. Deprecated: This field will be removed in a future release.
image string	(Optional) Default image name to use for each Step. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.
command []string	(Optional) Entrypoint array. Not executed within a shell. The docker 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
args []string	(Optional) 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
workingDir string	(Optional) 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.
ports []Kubernetes core/v1.ContainerPort	(Optional) List of ports to expose from the Step’s container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default “0.0.0.0” address inside a container will be accessible from the network. Cannot be updated. Deprecated: This field will be removed in a future release.
envFrom []Kubernetes core/v1.EnvFromSource	(Optional) 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 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.
env []Kubernetes core/v1.EnvVar	(Optional) List of environment variables to set in the container. Cannot be updated.
resources Kubernetes core/v1.ResourceRequirements	(Optional) Compute Resources required by this Step. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
volumeMounts []Kubernetes core/v1.VolumeMount	(Optional) Volumes to mount into the Step’s filesystem. Cannot be updated.
volumeDevices []Kubernetes core/v1.VolumeDevice	(Optional) volumeDevices is the list of block devices to be used by the Step.
livenessProbe Kubernetes core/v1.Probe	(Optional) Periodic probe of container 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 Deprecated: This field will be removed in a future release.
readinessProbe Kubernetes core/v1.Probe	(Optional) Periodic probe of container 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 Deprecated: This field will be removed in a future release.
startupProbe Kubernetes core/v1.Probe	(Optional) DeprecatedStartupProbe indicates that the Pod 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 Deprecated: This field will be removed in a future release.
lifecycle Kubernetes core/v1.Lifecycle	(Optional) Actions that the management system should take in response to container lifecycle events. Cannot be updated. Deprecated: This field will be removed in a future release.
terminationMessagePath string	(Optional) Deprecated: This field will be removed in a future release and cannot be meaningfully used.
terminationMessagePolicy Kubernetes core/v1.TerminationMessagePolicy	(Optional) Deprecated: This field will be removed in a future release and cannot be meaningfully used.
imagePullPolicy Kubernetes core/v1.PullPolicy	(Optional) 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
securityContext Kubernetes core/v1.SecurityContext	(Optional) 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/
stdin bool	(Optional) Whether this Step should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the Step will always result in EOF. Default is false. Deprecated: This field will be removed in a future release.
stdinOnce bool	(Optional) Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false Deprecated: This field will be removed in a future release.
tty bool	(Optional) Whether this Step should allocate a DeprecatedTTY for itself, also requires ‘stdin’ to be true. Default is false. Deprecated: This field will be removed in a future release.

TaskBreakpoints

(Appears on:TaskRunDebug)

TaskBreakpoints defines the breakpoint config for a particular Task

Field	Description
onFailure string	(Optional) if enabled, pause TaskRun on failure of a step failed step will not exit
beforeSteps []string	(Optional)

TaskKind (string alias)

(Appears on:TaskRef)

TaskKind defines the type of Task used by the pipeline.

TaskModifier

TaskModifier is an interface to be implemented by different PipelineResources

Deprecated: Unused, preserved only for backwards compatibility

TaskObject

TaskObject is implemented by Task and ClusterTask

TaskRef

(Appears on:RunSpec, CustomRunSpec, PipelineTask, TaskRunSpec)

TaskRef can be used to refer to a specific instance of a task.

Field	Description
name string	Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
kind TaskKind	TaskKind indicates the Kind of the Task: 1. Namespaced Task when Kind is set to “Task”. If Kind is “”, it defaults to “Task”. 2. Cluster-Scoped Task when Kind is set to “ClusterTask” 3. Custom Task when Kind is non-empty and APIVersion is non-empty
apiVersion string	(Optional) API version of the referent Note: A Task with non-empty APIVersion and Kind is considered a Custom Task
bundle string	(Optional) Bundle url reference to a Tekton Bundle. Deprecated: Please use ResolverRef with the bundles resolver instead. The field is staying there for go client backward compatibility, but is not used/allowed anymore.
ResolverRef ResolverRef	(Optional) ResolverRef allows referencing a Task in a remote location like a git repo. This field is only supported when the alpha feature gate is enabled.

TaskResource

(Appears on:TaskResources)

TaskResource defines an input or output Resource declared as a requirement by a Task. The Name field will be used to refer to these Resources within the Task definition, and when provided as an Input, the Name will be the path to the volume mounted containing this Resource as an input (e.g. an input Resource named workspace will be mounted at /workspace).

Deprecated: Unused, preserved only for backwards compatibility

Field	Description
ResourceDeclaration ResourceDeclaration	(Members of ResourceDeclaration are embedded into this type.)

TaskResourceBinding

(Appears on:TaskRunInputs, TaskRunOutputs, TaskRunResources)

TaskResourceBinding points to the PipelineResource that will be used for the Task input or output called Name.

Deprecated: Unused, preserved only for backwards compatibility

Field	Description
PipelineResourceBinding PipelineResourceBinding	(Members of PipelineResourceBinding are embedded into this type.)
paths []string	(Optional) Paths will probably be removed in #1284, and then PipelineResourceBinding can be used instead. The optional Path field corresponds to a path on disk at which the Resource can be found (used when providing the resource via mounted volume, overriding the default logic to fetch the Resource).

TaskResources

(Appears on:TaskSpec)

TaskResources allows a Pipeline to declare how its DeclaredPipelineResources should be provided to a Task as its inputs and outputs.

Deprecated: Unused, preserved only for backwards compatibility

Field	Description
inputs []TaskResource	Inputs holds the mapping from the PipelineResources declared in DeclaredPipelineResources to the input PipelineResources required by the Task.
outputs []TaskResource	Outputs holds the mapping from the PipelineResources declared in DeclaredPipelineResources to the input PipelineResources required by the Task.

TaskResult

(Appears on:TaskSpec)

TaskResult used to describe the results of a task

Field	Description
name string	Name the given name
type ResultsType	(Optional) Type is the user-specified type of the result. The possible type is currently “string” and will support “array” in following work.
properties map[string]github.com/tektoncd/pipeline/pkg/apis/pipeline/v1beta1.PropertySpec	(Optional) Properties is the JSON Schema properties to support key-value pairs results.
description string	(Optional) Description is a human-readable description of the result
value ParamValue	(Optional) Value the expression used to retrieve the value of the result from an underlying Step.

TaskRunConditionType (string alias)

TaskRunConditionType is an enum used to store TaskRun custom conditions such as one used in spire results verification

TaskRunDebug

(Appears on:TaskRunSpec)

TaskRunDebug defines the breakpoint config for a particular TaskRun

Field	Description
breakpoints TaskBreakpoints	(Optional)

TaskRunInputs

TaskRunInputs holds the input values that this task was invoked with.

Deprecated: Unused, preserved only for backwards compatibility

Field	Description
resources []TaskResourceBinding	(Optional)
params []Param	(Optional)

TaskRunOutputs

TaskRunOutputs holds the output values that this task was invoked with.

Deprecated: Unused, preserved only for backwards compatibility

Field	Description
resources []TaskResourceBinding	(Optional)

TaskRunReason (string alias)

TaskRunReason is an enum used to store all TaskRun reason for the Succeeded condition that are controlled by the TaskRun itself. Failure reasons that emerge from underlying resources are not included here

TaskRunResources

(Appears on:TaskRunSpec)

TaskRunResources allows a TaskRun to declare inputs and outputs TaskResourceBinding

Deprecated: Unused, preserved only for backwards compatibility

Field	Description
inputs []TaskResourceBinding	Inputs holds the inputs resources this task was invoked with
outputs []TaskResourceBinding	Outputs holds the inputs resources this task was invoked with

TaskRunResult

(Appears on:StepState, TaskRunStatusFields)

TaskRunStepResult is a type alias of TaskRunResult

Field	Description
name string	Name the given name
type ResultsType	(Optional) Type is the user-specified type of the result. The possible type is currently “string” and will support “array” in following work.
value ParamValue	Value the given value of the result

TaskRunSidecarOverride

(Appears on:PipelineTaskRunSpec, TaskRunSpec)

TaskRunSidecarOverride is used to override the values of a Sidecar in the corresponding Task.

Field	Description
name string	The name of the Sidecar to override.
resources Kubernetes core/v1.ResourceRequirements	The resource requirements to apply to the Sidecar.

TaskRunSpec

(Appears on:TaskRun)

TaskRunSpec defines the desired state of TaskRun

Field	Description
debug TaskRunDebug	(Optional)
params Params	(Optional)
resources TaskRunResources	(Optional) Deprecated: Unused, preserved only for backwards compatibility
serviceAccountName string	(Optional)
taskRef TaskRef	(Optional) no more than one of the TaskRef and TaskSpec may be specified.
taskSpec TaskSpec	(Optional) Specifying PipelineSpec can be disabled by setting disable-inline-spec feature flag..
status TaskRunSpecStatus	(Optional) Used for cancelling a TaskRun (and maybe more later on)
statusMessage TaskRunSpecStatusMessage	(Optional) Status message for cancellation.
retries int	(Optional) Retries represents how many times this TaskRun should be retried in the event of Task failure.
timeout Kubernetes meta/v1.Duration	(Optional) Time after which one retry attempt times out. Defaults to 1 hour. Refer Go’s ParseDuration documentation for expected format: https://golang.org/pkg/time/#ParseDuration
podTemplate Template	PodTemplate holds pod specific configuration
workspaces []WorkspaceBinding	(Optional) Workspaces is a list of WorkspaceBindings from volumes to workspaces.
stepOverrides []TaskRunStepOverride	(Optional) Overrides to apply to Steps in this TaskRun. If a field is specified in both a Step and a StepOverride, the value from the StepOverride will be used. This field is only supported when the alpha feature gate is enabled.
sidecarOverrides []TaskRunSidecarOverride	(Optional) Overrides to apply to Sidecars in this TaskRun. If a field is specified in both a Sidecar and a SidecarOverride, the value from the SidecarOverride will be used. This field is only supported when the alpha feature gate is enabled.
computeResources Kubernetes core/v1.ResourceRequirements	Compute resources to use for this TaskRun

TaskRunSpecStatus (string alias)

(Appears on:TaskRunSpec)

TaskRunSpecStatus defines the TaskRun spec status the user can provide

TaskRunSpecStatusMessage (string alias)

(Appears on:TaskRunSpec)

TaskRunSpecStatusMessage defines human readable status messages for the TaskRun.

TaskRunStatus

(Appears on:TaskRun, PipelineRunTaskRunStatus, TaskRunStatusFields)

TaskRunStatus defines the observed state of TaskRun

Field	Description
Status knative.dev/pkg/apis/duck/v1.Status	(Members of Status are embedded into this type.)
TaskRunStatusFields TaskRunStatusFields	(Members of TaskRunStatusFields are embedded into this type.) TaskRunStatusFields inlines the status fields.

TaskRunStatusFields

(Appears on:TaskRunStatus)

TaskRunStatusFields holds the fields of TaskRun’s status. This is defined separately and inlined so that other types can readily consume these fields via duck typing.

Field	Description
podName string	PodName is the name of the pod responsible for executing this task’s steps.
startTime Kubernetes meta/v1.Time	StartTime is the time the build is actually started.
completionTime Kubernetes meta/v1.Time	CompletionTime is the time the build completed.
steps []StepState	(Optional) Steps describes the state of each build step container.
cloudEvents []CloudEventDelivery	(Optional) CloudEvents describe the state of each cloud event requested via a CloudEventResource. Deprecated: Removed in v0.44.0.
retriesStatus []TaskRunStatus	(Optional) RetriesStatus contains the history of TaskRunStatus in case of a retry in order to keep record of failures. All TaskRunStatus stored in RetriesStatus will have no date within the RetriesStatus as is redundant.
resourcesResult []github.com/tektoncd/pipeline/pkg/result.RunResult	(Optional) Results from Resources built during the TaskRun. This is tomb-stoned along with the removal of pipelineResources Deprecated: this field is not populated and is preserved only for backwards compatibility
taskResults []TaskRunResult	(Optional) TaskRunResults are the list of results written out by the task’s containers
sidecars []SidecarState	The list has one entry per sidecar in the manifest. Each entry is represents the imageid of the corresponding sidecar.
taskSpec TaskSpec	TaskSpec contains the Spec from the dereferenced Task definition used to instantiate this TaskRun.
provenance Provenance	(Optional) Provenance contains some key authenticated metadata about how a software artifact was built (what sources, what inputs/outputs, etc.).
spanContext map[string]string	SpanContext contains tracing span context fields

TaskRunStepOverride

(Appears on:PipelineTaskRunSpec, TaskRunSpec)

TaskRunStepOverride is used to override the values of a Step in the corresponding Task.

Field	Description
name string	The name of the Step to override.
resources Kubernetes core/v1.ResourceRequirements	The resource requirements to apply to the Step.

TaskSpec

(Appears on:ClusterTask, Task, EmbeddedTask, TaskRunSpec, TaskRunStatusFields)

TaskSpec defines the desired state of Task.

Field	Description
resources TaskResources	(Optional) Resources is a list input and output resource to run the task Resources are represented in TaskRuns as bindings to instances of PipelineResources. Deprecated: Unused, preserved only for backwards compatibility
params ParamSpecs	(Optional) 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.
displayName string	(Optional) DisplayName is a user-facing name of the task that may be used to populate a UI.
description string	(Optional) Description is a user-facing description of the task that may be used to populate a UI.
steps []Step	Steps are the steps of the build; each step is run sequentially with the source mounted into /workspace.
volumes []Kubernetes core/v1.Volume	Volumes is a collection of volumes that are available to mount into the steps of the build.
stepTemplate StepTemplate	StepTemplate can be used as the basis for all step containers within the Task, so that the steps inherit settings on the base container.
sidecars []Sidecar	Sidecars are run alongside the Task’s step containers. They begin before the steps start and end after the steps complete.
workspaces []WorkspaceDeclaration	Workspaces are the volumes that this Task requires.
results []TaskResult	Results are values that this Task can output

TimeoutFields

(Appears on:PipelineRunSpec)

TimeoutFields allows granular specification of pipeline, task, and finally timeouts

Field	Description
pipeline Kubernetes meta/v1.Duration	Pipeline sets the maximum allowed duration for execution of the entire pipeline. The sum of individual timeouts for tasks and finally must not exceed this value.
tasks Kubernetes meta/v1.Duration	Tasks sets the maximum allowed duration of this pipeline’s tasks
finally Kubernetes meta/v1.Duration	Finally sets the maximum allowed duration of this pipeline’s finally

WhenExpression

(Appears on:ChildStatusReference, PipelineRunRunStatus, PipelineRunTaskRunStatus, SkippedTask)

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

Field	Description
input string	Input is the string for guard checking which can be a static input or an output from a parent Task
operator k8s.io/apimachinery/pkg/selection.Operator	Operator that represents an Input’s relationship to the values
values []string	Values is an array of strings, which is compared against the input, for guard checking It must be non-empty
cel string	(Optional) 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

WhenExpressions ([]github.com/tektoncd/pipeline/pkg/apis/pipeline/v1beta1.WhenExpression alias)

(Appears on:PipelineTask, Step)

WhenExpressions are used to specify whether a Task should be executed or skipped All of them need to evaluate to True for a guarded Task to be executed.

WorkspaceBinding

(Appears on:RunSpec, CustomRunSpec, PipelineRunSpec, TaskRunSpec)

WorkspaceBinding maps a Task’s declared workspace to a Volume.

Field	Description
name string	Name is the name of the workspace populated by the volume.
subPath string	(Optional) SubPath is optionally a directory on the volume which should be used for this binding (i.e. the volume will be mounted at this sub directory).
volumeClaimTemplate Kubernetes core/v1.PersistentVolumeClaim	(Optional) VolumeClaimTemplate is a template for a claim that will be created in the same namespace. The PipelineRun controller is responsible for creating a unique claim for each instance of PipelineRun.
persistentVolumeClaim Kubernetes core/v1.PersistentVolumeClaimVolumeSource	(Optional) PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. Either this OR EmptyDir can be used.
emptyDir Kubernetes core/v1.EmptyDirVolumeSource	(Optional) EmptyDir represents a temporary directory that shares a Task’s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir Either this OR PersistentVolumeClaim can be used.
configMap Kubernetes core/v1.ConfigMapVolumeSource	(Optional) ConfigMap represents a configMap that should populate this workspace.
secret Kubernetes core/v1.SecretVolumeSource	(Optional) Secret represents a secret that should populate this workspace.
projected Kubernetes core/v1.ProjectedVolumeSource	(Optional) Projected represents a projected volume that should populate this workspace.
csi Kubernetes core/v1.CSIVolumeSource	(Optional) CSI (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers.

WorkspaceDeclaration

(Appears on:TaskSpec)

WorkspaceDeclaration is a declaration of a volume that a Task requires.

Field	Description
name string	Name is the name by which you can bind the volume at runtime.
description string	(Optional) Description is an optional human readable description of this volume.
mountPath string	(Optional) MountPath overrides the directory that the volume will be made available at.
readOnly bool	ReadOnly dictates whether a mounted volume is writable. By default this field is false and so mounted volumes are writable.
optional bool	Optional marks a Workspace as not being required in TaskRuns. By default this field is false and so declared workspaces are required.

WorkspacePipelineTaskBinding

(Appears on:PipelineTask)

WorkspacePipelineTaskBinding describes how a workspace passed into the pipeline should be mapped to a task’s declared workspace.

Field	Description
name string	Name is the name of the workspace as declared by the task
workspace string	(Optional) Workspace is the name of the workspace declared by the pipeline
subPath string	(Optional) SubPath is optionally a directory on the volume which should be used for this binding (i.e. the volume will be mounted at this sub directory).

WorkspaceUsage

(Appears on:Sidecar, Step)

WorkspaceUsage is used by a Step or Sidecar to declare that it wants isolated access to a Workspace defined in a Task.

Field	Description
name string	Name is the name of the workspace this Step or Sidecar wants access to.
mountPath string	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.

CustomRunResult

(Appears on:CustomRunStatusFields)

CustomRunResult used to describe the results of a task

Field	Description
name string	Name the given name
value string	Value the given value of the result

CustomRunStatus

(Appears on:CustomRun, PipelineRunRunStatus, PipelineRunRunStatus, CustomRunStatusFields)

CustomRunStatus defines the observed state of CustomRun

Field	Description
Status knative.dev/pkg/apis/duck/v1.Status	(Members of Status are embedded into this type.)
CustomRunStatusFields CustomRunStatusFields	(Members of CustomRunStatusFields are embedded into this type.) CustomRunStatusFields inlines the status fields.

CustomRunStatusFields

(Appears on:CustomRunStatus)

CustomRunStatusFields holds the fields of CustomRun’s status. This is defined separately and inlined so that other types can readily consume these fields via duck typing.

Field	Description
startTime Kubernetes meta/v1.Time	(Optional) StartTime is the time the build is actually started.
completionTime Kubernetes meta/v1.Time	(Optional) CompletionTime is the time the build completed.
results []CustomRunResult	(Optional) Results reports any output result values to be consumed by later tasks in a pipeline.
retriesStatus []CustomRunStatus	(Optional) RetriesStatus contains the history of CustomRunStatus, in case of a retry.
extraFields k8s.io/apimachinery/pkg/runtime.RawExtension	ExtraFields holds arbitrary fields provided by the custom task controller.

---

Generated with gen-crd-api-reference-docs .