Pipeline API

Spec holds the information for the request part of the resource request.

Status communicates the state of the request and, ultimately, the content of the resolved resource.

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.

(Members of Status are embedded into this type.)

(Members of ResolutionRequestStatusFields are embedded into this type.)

Data is a string representation of the resolved content of the requested resource in-lined into the ResolutionRequest object.

RefSource is the source reference of the remote data that records where the remote file came from including the url, digest and the entrypoint.

Spec holds the information for the request part of the resource request.

Status communicates the state of the request and, ultimately, the content of the resolved resource.

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.

(Members of Status are embedded into this type.)

(Members of ResolutionRequestStatusFields are embedded into this type.)

Data is a string representation of the resolved content of the requested resource in-lined into the ResolutionRequest object.

Deprecated: Use RefSource instead

RefSource is the source reference of the remote data that records the url, digest and the entrypoint.

Spec holds the desired state of the Pipeline from the client

Spec holds the desired state of the Task from the client

Name is the name of the TaskRun or Run this is referencing.

PipelineTaskName is the name of the PipelineTask this is referencing.

WhenExpressions is the list of checks guarding the execution of the PipelineTask

Spec is a specification of a custom task

(Members of TaskSpec are embedded into this type.)

TaskSpec is a specification of a task

Name the specified combination

Params takes only Parameters of type "string" The names of the params must match the names of the params in the underlying Task

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 is a list of IncludeParams which allows passing in specific combinations of Parameters into the Matrix.

"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

Name declares the name by which a parameter is referenced.

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

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

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

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

"array"

"object"

"string"

Represents the stored type of ParamValues.

Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names

API version of the referent

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.

Name the given name

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 is a human-readable description of the result

Value the expression used to retrieve the value

"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

Name is the result’s name as declared by the Pipeline

Value is the result returned from the execution of this PipelineRun

PipelineTaskName is the name of the PipelineTask.

Status is the RunStatus for the corresponding Run

WhenExpressions is the list of checks guarding the execution of the PipelineTask

Params is a list of parameter names and values.

Used for cancelling a pipelinerun (and maybe more later on)

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 represent template of taskrun

Workspaces holds a set of workspace bindings that must match names with those declared in the pipeline.

TaskRunSpecs holds a set of runtime specs

(Members of Status are embedded into this type.)

(Members of PipelineRunStatusFields are embedded into this type.)

PipelineRunStatusFields inlines the status fields.

StartTime is the time the PipelineRun is actually started.

CompletionTime is the time the PipelineRun completed.

Results are the list of results written out by the pipeline task’s containers

PipelineRunSpec contains the exact spec used to instantiate the run

list of tasks that were skipped due to when expressions evaluating to false

list of TaskRun and Run names, PipelineTask names, and API versions/kinds for children of this PipelineRun.

FinallyStartTime is when all non-finally tasks have been completed and only finally tasks are being executed.

Provenance contains some key authenticated metadata about how a software artifact was built (what sources, what inputs/outputs, etc.).

SpanContext contains tracing span context fields

PipelineTaskName is the name of the PipelineTask.

Status is the TaskRunStatus for the corresponding TaskRun

WhenExpressions is the list of checks guarding the execution of the PipelineTask

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

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

Tasks declares the graph of Tasks that execute when this Pipeline is run.

Params declares a list of input parameters that must be supplied when this Pipeline is run.

Workspaces declares a set of named workspaces that are expected to be provided by a PipelineRun.

Results are values that this pipeline can output once run

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

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 is the display name of this task within the context of a Pipeline. This display name may be used to populate a UI.

Description is the description of this task within the context of a Pipeline. This description may be used to populate a UI.

TaskRef is a reference to a task definition.

TaskSpec is a specification of a task

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

Retries represents how many times this task should be retried in case of task failure: ConditionSucceeded set to False

RunAfter is the list of PipelineTask names that should be executed before this Task executes. (Used to force a specific ordering in graph execution.)

Parameters declares parameters passed to this task.

Matrix declares parameters used to fan out this task.

Workspaces maps workspaces from the pipeline spec to the workspaces declared in the Task.

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 is a reference to a pipeline definition Note: PipelineRef is in preview mode and not yet supported

PipelineSpec is a specification of a pipeline Note: PipelineSpec is in preview mode and not yet supported

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

"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

Compute resources to use for this TaskRun

Name is the name of a workspace to be provided by a PipelineRun.

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 marks a Workspace as not being required in PipelineRuns. By default this field is false and so declared workspaces are required.

RefSource identifies the source where a remote task/pipeline came from.

FeatureFlags identifies the feature flags that were used during the task/pipeline run

Name of the referenced step

ResolverRef allows referencing a StepAction in a remote location like a git repo.

URI indicates the identity of the source of the build definition. Example: “https://github.com/tektoncd/catalog”

Digest is a collection of cryptographic digests for the contents of the artifact specified by URI. Example: {“sha1”: “f99d13e554ffcb696dee719fa85b695cb5b0f428”}

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”

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

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.

"array"

"object"

"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 reference name. More info: https://kubernetes.io/docs/concepts/containers/images

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

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

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.

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.

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.

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

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

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

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

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

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

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

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.

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.

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 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/

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.

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

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

Script is the contents of an executable file to execute.

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

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.

(Members of ContainerState are embedded into this type.)

Name is the Pipeline Task name

Reason is the cause of the PipelineTask being skipped.

WhenExpressions is the list of checks guarding the execution of the PipelineTask

"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

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

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

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

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

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.

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.

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

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

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

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

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

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 defines the exiting behavior of a container on error can be set to [ continue | stopAndFail ]

Stores configuration for the stdout stream of the step.

Stores configuration for the stderr stream of the step.

Contains the reference to an existing StepAction.

Params declares parameters passed to this step action.

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.

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

Name the given name

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

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

Description is a human-readable description of the result

(Members of ContainerState are embedded into this type.)

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

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

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

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.

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.

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

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

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

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

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 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/

if enabled, pause TaskRun on failure of a step failed step will not exit

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

Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names

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

API version of the referent Note: A Task with non-empty APIVersion and Kind is considered a Custom Task

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.

Name the given name

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

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

Description is a human-readable description of the result

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

"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

Name the given name

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

Value the given value of the result

The name of the Sidecar to override.

The resource requirements to apply to the Sidecar.

no more than one of the TaskRef and TaskSpec may be specified.

Used for cancelling a TaskRun (and maybe more later on)

Status message for cancellation.

Retries represents how many times this TaskRun should be retried in the event of task failure.

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 holds pod specific configuration

Workspaces is a list of WorkspaceBindings from volumes to workspaces.

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.

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.

Compute resources to use for this TaskRun

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

(Members of Status are embedded into this type.)

(Members of TaskRunStatusFields are embedded into this type.)

TaskRunStatusFields inlines the status fields.

PodName is the name of the pod responsible for executing this task’s steps.

StartTime is the time the build is actually started.

CompletionTime is the time the build completed.

Steps describes the state of each build step container.

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 are the list of results written out by the task’s containers

The list has one entry per sidecar in the manifest. Each entry is represents the imageid of the corresponding sidecar.

TaskSpec contains the Spec from the dereferenced Task definition used to instantiate this TaskRun.

Provenance contains some key authenticated metadata about how a software artifact was built (what sources, what inputs/outputs, etc.).

SpanContext contains tracing span context fields

The name of the Step to override.

The resource requirements to apply to the Step.

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 is a user-facing name of the task that may be used to populate a UI.

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

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

Volumes is a collection of volumes that are available to mount into the steps of the build.

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 are run alongside the Task’s step containers. They begin before the steps start and end after the steps complete.

Workspaces are the volumes that this Task requires.

Results are values that this Task can output

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 sets the maximum allowed duration of this pipeline’s tasks

Finally sets the maximum allowed duration of this pipeline’s finally

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

Operator that represents an Input’s relationship to the values

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

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

Name is the name of the workspace populated by the volume.

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

PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. Either this OR EmptyDir can be used.

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 represents a configMap that should populate this workspace.

Secret represents a secret that should populate this workspace.

Projected represents a projected volume that should populate this workspace.

CSI (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers.

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

Description is an optional human readable description of this volume.

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

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

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

Name is the name of the workspace as declared by the task

Workspace is the name of the workspace declared by the pipeline

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

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

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.

Spec holds the desired state of the Step from the client

Spec holds the desired state of the VerificationPolicy.

Spec holds the desired state of the PipelineResource from the client

Status is used to communicate the observed state of the PipelineResource from the controller, but was unused as there is no controller for PipelineResource.

Name is the name for this authority.

Key contains the public key to validate the resource.

Spec is a specification of a custom task

SecretRef sets a reference to a secret with the key.

Data contains the inline public key.

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 always defaults to sha256 if the algorithm hasn’t been explicitly set

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/*,

Spec is a specification of a custom task

Used for cancelling a run (and maybe more later on)

Status message for cancellation.

Used for propagating retries count to custom tasks

PodTemplate holds pod specific configuration

Time after which the custom-task times out. Refer Go’s ParseDuration documentation for expected format: https://golang.org/pkg/time/#ParseDuration

Workspaces is a list of WorkspaceBindings from volumes to workspaces.

Image reference name to run for this StepAction. More info: https://kubernetes.io/docs/concepts/containers/images

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

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

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

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.

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 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 are values that this StepAction can output

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.

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

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 defines the rules for validating signatures.

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

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

Secrets to fetch to populate some of resource fields

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 is the type of this resource;

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

TargetPath is the path in workspace directory where the resource will be copied.

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)

Name the given name

Value the given value of the result

(Members of Status are embedded into this type.)

(Members of RunStatusFields are embedded into this type.)

RunStatusFields inlines the status fields.

StartTime is the time the build is actually started.

CompletionTime is the time the build completed.

Results reports any output result values to be consumed by later tasks in a pipeline.

RetriesStatus contains the history of RunStatus, in case of a retry.

ExtraFields holds arbitrary fields provided by the custom task controller.

Spec holds the desired state of the Task from the client

Spec holds the desired state of the Pipeline from the client

Spec holds the desired state of the Task from the client

Name is the name of the TaskRun or Run this is referencing.

PipelineTaskName is the name of the PipelineTask this is referencing.

WhenExpressions is the list of checks guarding the execution of the PipelineTask

Target points to an addressable

Current status

SentAt is the time at which the last attempt to send the event was made

Error is the text of error (if any)

RetryCount is the number of attempts of sending the cloud event

URI indicates the identity of the source of the build definition. Example: “https://github.com/tektoncd/catalog”

Digest is a collection of cryptographic digests for the contents of the artifact specified by URI. Example: {“sha1”: “f99d13e554ffcb696dee719fa85b695cb5b0f428”}

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”

Spec is a specification of a custom task

Used for cancelling a customrun (and maybe more later on)

Status message for cancellation.

Used for propagating retries count to custom tasks

Time after which the custom-task times out. Refer Go’s ParseDuration documentation for expected format: https://golang.org/pkg/time/#ParseDuration

Workspaces is a list of WorkspaceBindings from volumes to workspaces.

Spec is a specification of a custom task

Spec is a specification of a custom task

(Members of TaskSpec are embedded into this type.)

TaskSpec is a specification of a task

Name the specified combination

Params takes only Parameters of type "string" The names of the params must match the names of the params in the underlying Task

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 is a list of IncludeParams which allows passing in specific combinations of Parameters into the Matrix.

Name declares the name by which a parameter is referenced.

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

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

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

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

Represents the stored type of ParamValues.

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 is the type of the PipelineResource.

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)

Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names

API version of the referent

Bundle url reference to a Tekton Bundle.

Deprecated: Please use ResolverRef with the bundles resolver instead.

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.

Name is the name of the PipelineResource in the Pipeline’s declaration

ResourceRef is a reference to the instance of the actual PipelineResource that should be used

ResourceSpec is specification of a resource that should be created and consumed by the task

Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names

API version of the referent

Name the given name

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 is a human-readable description of the result

Value the expression used to retrieve the value

Name is the result’s name as declared by the Pipeline

Value is the result returned from the execution of this PipelineRun

PipelineTaskName is the name of the PipelineTask.

Status is the CustomRunStatus for the corresponding CustomRun or Run

WhenExpressions is the list of checks guarding the execution of the PipelineTask

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 is a list of parameter names and values.

Used for cancelling a pipelinerun (and maybe more later on)

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 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 holds pod specific configuration

Workspaces holds a set of workspace bindings that must match names with those declared in the pipeline.

TaskRunSpecs holds a set of runtime specs

(Members of Status are embedded into this type.)

(Members of PipelineRunStatusFields are embedded into this type.)

PipelineRunStatusFields inlines the status fields.

StartTime is the time the PipelineRun is actually started.

CompletionTime is the time the PipelineRun completed.

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 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 are the list of results written out by the pipeline task’s containers

PipelineRunSpec contains the exact spec used to instantiate the run

list of tasks that were skipped due to when expressions evaluating to false

list of TaskRun and Run names, PipelineTask names, and API versions/kinds for children of this PipelineRun.

FinallyStartTime is when all non-finally tasks have been completed and only finally tasks are being executed.

Provenance contains some key authenticated metadata about how a software artifact was built (what sources, what inputs/outputs, etc.).

SpanContext contains tracing span context fields

PipelineTaskName is the name of the PipelineTask.

Status is the TaskRunStatus for the corresponding TaskRun

WhenExpressions is the list of checks guarding the execution of the PipelineTask

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

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

Deprecated: Unused, preserved only for backwards compatibility

Tasks declares the graph of Tasks that execute when this Pipeline is run.

Params declares a list of input parameters that must be supplied when this Pipeline is run.

Workspaces declares a set of named workspaces that are expected to be provided by a PipelineRun.

Results are values that this pipeline can output once run

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

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 is the display name of this task within the context of a Pipeline. This display name may be used to populate a UI.

Description is the description of this task within the context of a Pipeline. This description may be used to populate a UI.

TaskRef is a reference to a task definition.

TaskSpec is a specification of a task

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

Retries represents how many times this task should be retried in case of task failure: ConditionSucceeded set to False

RunAfter is the list of PipelineTask names that should be executed before this Task executes. (Used to force a specific ordering in graph execution.)

Deprecated: Unused, preserved only for backwards compatibility

Parameters declares parameters passed to this task.

Matrix declares parameters used to fan out this task.

Workspaces maps workspaces from the pipeline spec to the workspaces declared in the Task.

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 is a reference to a pipeline definition Note: PipelineRef is in preview mode and not yet supported

PipelineSpec is a specification of a pipeline Note: PipelineSpec is in preview mode and not yet supported

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

Name is the name of the PipelineResource as declared by the Task.

Resource is the name of the DeclaredPipelineResource to use.

From is the list of PipelineTask names that the resource has to come from. (Implies an ordering in the execution graph.)

Name is the name of the PipelineResource as declared by the Task.

Resource is the name of the DeclaredPipelineResource to use.

Inputs holds the mapping from the PipelineResources declared in DeclaredPipelineResources to the input PipelineResources required by the Task.

Outputs holds the mapping from the PipelineResources declared in DeclaredPipelineResources to the input PipelineResources required by the Task.

Compute resources to use for this TaskRun

Name is the name of a workspace to be provided by a PipelineRun.

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 marks a Workspace as not being required in PipelineRuns. By default this field is false and so declared workspaces are required.

Deprecated: Use RefSource instead

RefSource identifies the source where a remote task/pipeline came from.

FeatureFlags identifies the feature flags that were used during the task/pipeline run

Name of the referenced step

ResolverRef allows referencing a StepAction in a remote location like a git repo.

URI indicates the identity of the source of the build definition. Example: “https://github.com/tektoncd/catalog”

Digest is a collection of cryptographic digests for the contents of the artifact specified by URI. Example: {“sha1”: “f99d13e554ffcb696dee719fa85b695cb5b0f428”}

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”

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