Pipeline API

Spec holds the desired state of the Pipeline from the client

Spec holds the desired state of the Task from the client

Spec is a specification of a custom task

(Members of TaskSpec are embedded into this type.)

TaskSpec is a specification of a task

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.

"array"

"object"

"string"

Represents the stored type of ParamValues.

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

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.

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. Specified TaskRun timeout should be less than 24h. Refer Go’s ParseDuration documentation for expected format: https://golang.org/pkg/time/#ParseDuration

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.

Name is the name of the parameter that will be passed to the resolver.

Value is the string value of the parameter that will be passed to the resolver.

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

Resource 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 container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.

Docker image name. 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.

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

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

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.

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

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

Pod volumes to mount into the container’s filesystem. Cannot be updated.

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

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

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

StartupProbe 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

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

Optional: Path at which the file to which the container’s termination message will be written is mounted into the container’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 container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container 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 container 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 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.

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

Whether this container 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.

Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.

Docker image name. 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.

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

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

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

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

Pod volumes to mount into the container’s filesystem. Cannot be updated.

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

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 container 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 ] stopAndFail indicates exit the taskRun if the container exits with non-zero exit code continue indicates continue executing the rest of the steps irrespective of the container exit code

Stores configuration for the stdout stream of the step.

Stores configuration for the stderr stream of the step.

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

Docker image name. 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.

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

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

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

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

Pod volumes to mount into the container’s filesystem. Cannot be updated.

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

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

"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, namespaced or cluster scoped.

API version of the referent

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

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

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.

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

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

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.

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 PipelineResource from the client

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

Spec is a specification of a custom task

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.

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

"Failed"

CloudEventConditionFailed means that there was one or more attempts to send the event, and none was successful so far.

"Sent"

CloudEventConditionSent means that the event was sent successfully

"Unknown"

CloudEventConditionUnknown means that the condition for the event to be triggered was not met yet, or we don’t know the state yet.

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

Spec is a specification of a custom task

(Members of TaskSpec are embedded into this type.)

TaskSpec is a specification of a task

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.

"array"

"object"

"string"

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.

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

"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

"Failed"

PipelineRunReasonFailed is the reason set when the PipelineRun completed with a failure

"PipelineRunPending"

PipelineRunReasonPending is the reason set when the PipelineRun is in the pending state

"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

Resources is a list of bindings specifying which actual instances of PipelineResources to use for the resources the Pipeline has declared it needs.

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 Deprecated: use pipelineRunSpec.Timeouts.Pipeline instead 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

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.

Deprecated - use ChildReferences instead. map of PipelineRunTaskRunStatus with the taskRun name as the key

Deprecated - use ChildReferences instead. map of PipelineRunRunStatus with the run name as the key

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.

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

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

Resources declares the names and types of the resources given to the Pipeline’s tasks as inputs and outputs.

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.

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

Resources declares the resources given to this task as inputs and outputs.

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. Specified TaskRun timeout should be less than 24h. Refer Go’s ParseDuration documentation for expected format: https://golang.org/pkg/time/#ParseDuration

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.

Name is the name of the parameter that will be passed to the resolver.

Value is the string value of the parameter that will be passed to the resolver.

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

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

1

TaskRunResultType default task run result value

"array"

"object"

"string"

Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.

Docker image name. 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.

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

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

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.

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

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

Pod volumes to mount into the container’s filesystem. Cannot be updated.

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

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

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

StartupProbe 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

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

Optional: Path at which the file to which the container’s termination message will be written is mounted into the container’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 container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container 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 container 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 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.

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

Whether this container 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

"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 was stopping"

StoppingSkip means the task was skipped because the pipeline run is stopping

"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 container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.

Docker image name. 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.

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

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

Deprecated. This field will be removed in a future release. List of ports to expose from the 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.

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.

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

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

Pod volumes to mount into the container’s filesystem. Cannot be updated.

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

Deprecated. This field will be removed in a future release. 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. 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. 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. 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. Optional: Path at which the file to which the container’s termination message will be written is mounted into the container’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.

Deprecated. This field will be removed in a future release. Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container 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 container 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/

Deprecated. This field will be removed in a future release. 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. 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. Whether this container should allocate a DeprecatedTTY 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 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 ] stopAndFail indicates exit the taskRun if the container exits with non-zero exit code continue indicates continue executing the rest of the steps irrespective of the container exit code

Stores configuration for the stdout stream of the step.

Stores configuration for the stderr stream of the step.

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

(Members of ContainerState are embedded into this type.)

Deprecated. This field will be removed in a future release. DeprecatedName of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.

Docker image name. 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.

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

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

Deprecated. This field will be removed in a future release. List of ports to expose from the 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.

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.

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

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

Pod volumes to mount into the container’s filesystem. Cannot be updated.

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

Deprecated. This field will be removed in a future release. 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. 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. 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. 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. Optional: Path at which the file to which the container’s termination message will be written is mounted into the container’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.

Deprecated. This field will be removed in a future release. Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container 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 container 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/

Deprecated. This field will be removed in a future release. 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. 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. Whether this container should allocate a DeprecatedTTY for itself, also requires ‘stdin’ to be true. Default is false.

"ClusterTask"

ClusterTaskKind indicates that task type has a cluster scope.

"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, namespaced or cluster scoped.

API version of the referent

Bundle url reference to a Tekton Bundle.

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.

(Members of ResourceDeclaration are embedded into this type.)

(Members of PipelineResourceBinding are embedded into this type.)

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

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.

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

"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

"TaskRunImagePullFailed"

TaskRunReasonImagePullFailed is the reason set when the step of a task fails due to image not being pulled

"Running"

TaskRunReasonRunning is the reason set when the TaskRun is running

"Started"

TaskRunReasonStarted is the reason set when the TaskRun has just started

"Succeeded"

TaskRunReasonSuccessful is the reason set when the TaskRun completed successfully

"TaskRunTimeout"

TaskRunReasonTimedOut is the reason set when the Taskrun has timed out

Inputs holds the inputs resources this task was invoked with

Outputs holds the inputs resources this task was invoked with

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.

Time after which the build times out. Defaults to 1 hour. Specified build timeout should be less than 24h. 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.

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.

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.

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.

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

CloudEvents describe the state of each cloud event requested via a CloudEventResource.

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 from Resources built during the taskRun. currently includes the digest of build container images

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

The name of the Step to override.

The resource requirements to apply to the Step.

Resources is a list input and output resource to run the task Resources are represented in TaskRuns as bindings to instances of PipelineResources.

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.

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

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.