Pipeline [tekton.dev/v1]
tekton.dev group
Pipeline describes a list of Tasks to execute. It expresses how outputs of tasks feed into inputs of subsequent tasks.
v1 versionspec object
Spec holds the desired state of the Pipeline from the client
description string
Description is a user-facing description of the pipeline that may be used to populate a UI.
displayName string
DisplayName is a user-facing name of the pipeline that may be used to populate a UI.
finally []object
PipelineTask defines a task in a Pipeline, passing inputs from both Params and from the output of previous tasks.
description string
Description is the description of this task within the context of a Pipeline. This description may be used to populate a UI.
displayName string
DisplayName is the display name of this task within the context of a Pipeline. This display name may be used to populate a UI.
matrix object
Matrix declares parameters used to fan out this task.
include []object
IncludeParams allows passing in a specific combinations of Parameters into the Matrix.
name string
Name the specified combination
params []object
Param declares an ParamValues to use for the parameter called name.
name string required
value required
params []object
Param declares an ParamValues to use for the parameter called name.
name string required
value required
name string
Name is the name of this task within the context of a Pipeline. Name is
used as a coordinate with the from and runAfter fields to establish
the execution order of tasks relative to one another.
onError string
OnError defines the exiting behavior of a PipelineRun on error can be set to [ continue | stopAndFail ]
params []object
Param declares an ParamValues to use for the parameter called name.
name string required
value required
pipelineRef object
PipelineRef is a reference to a pipeline definition Note: PipelineRef is in preview mode and not yet supported
apiVersion string
API version of the referent
name string
Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
params []object
Param declares an ParamValues to use for the parameter called name.
name string required
value required
resolver string
Resolver is the name of the resolver that should perform resolution of the referenced Tekton resource, such as "git".
pipelineSpec
PipelineSpec is a specification of a pipeline
Note: PipelineSpec is in preview mode and not yet supported
Specifying PipelineSpec can be disabled by setting
disable-inline-spec feature flag.
See Pipeline.spec (API version: tekton.dev/v1)
retries integer
Retries represents how many times this task should be retried in case of task failure: ConditionSucceeded set to False
runAfter []string
RunAfter is the list of PipelineTask names that should be executed before this Task executes. (Used to force a specific ordering in graph execution.)
taskRef object
TaskRef is a reference to a task definition.
apiVersion string
API version of the referent Note: A Task with non-empty APIVersion and Kind is considered a Custom Task
kind string
TaskKind indicates the Kind of the Task:
- Namespaced Task when Kind is set to "Task". If Kind is "", it defaults to "Task".
- Custom Task when Kind is non-empty and APIVersion is non-empty
name string
Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
params []object
Param declares an ParamValues to use for the parameter called name.
name string required
value required
resolver string
Resolver is the name of the resolver that should perform resolution of the referenced Tekton resource, such as "git".
taskSpec
TaskSpec is a specification of a task
Specifying TaskSpec can be disabled by setting
disable-inline-spec feature flag.
See Task.spec (API version: tekton.dev/v1)
timeout string
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
when []object
WhenExpression allows a PipelineTask to declare expressions to be evaluated before the Task is run to determine whether the Task should be executed or skipped
cel string
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
input string
Input is the string for guard checking which can be a static input or an output from a parent Task
operator string
Operator that represents an Input's relationship to the values
values []string
Values is an array of strings, which is compared against the input, for guard checking It must be non-empty
workspaces []object
WorkspacePipelineTaskBinding describes how a workspace passed into the pipeline should be mapped to a task's declared workspace.
name string required
Name is the name of the workspace as declared by the task
subPath string
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).
workspace string
Workspace is the name of the workspace declared by the pipeline
params []object
ParamSpec defines arbitrary parameters needed beyond typed inputs (such as resources). Parameter values are provided by users as inputs on a TaskRun or PipelineRun.
default
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.
description string
Description is a user-facing description of the parameter that may be used to populate a UI.
enum []string
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.
name string required
Name declares the name by which a parameter is referenced.
properties object
Properties is the JSON Schema properties to support key-value pairs parameter.
type string
Type is the user-specified type of the parameter. The possible types are currently "string", "array" and "object", and "string" is the default.
results []object
PipelineResult used to describe the results of a pipeline
description string
Description is a human-readable description of the result
name string required
Name the given name
type string
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.
value required
Value the expression used to retrieve the value
tasks []object
PipelineTask defines a task in a Pipeline, passing inputs from both Params and from the output of previous tasks.
description string
Description is the description of this task within the context of a Pipeline. This description may be used to populate a UI.
displayName string
DisplayName is the display name of this task within the context of a Pipeline. This display name may be used to populate a UI.
matrix object
Matrix declares parameters used to fan out this task.
include []object
IncludeParams allows passing in a specific combinations of Parameters into the Matrix.
name string
Name the specified combination
params []object
Param declares an ParamValues to use for the parameter called name.
name string required
value required
params []object
Param declares an ParamValues to use for the parameter called name.
name string required
value required
name string
Name is the name of this task within the context of a Pipeline. Name is
used as a coordinate with the from and runAfter fields to establish
the execution order of tasks relative to one another.
onError string
OnError defines the exiting behavior of a PipelineRun on error can be set to [ continue | stopAndFail ]
params []object
Param declares an ParamValues to use for the parameter called name.
name string required
value required
pipelineRef object
PipelineRef is a reference to a pipeline definition Note: PipelineRef is in preview mode and not yet supported
apiVersion string
API version of the referent
name string
Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
params []object
Param declares an ParamValues to use for the parameter called name.
name string required
value required
resolver string
Resolver is the name of the resolver that should perform resolution of the referenced Tekton resource, such as "git".
pipelineSpec
PipelineSpec is a specification of a pipeline
Note: PipelineSpec is in preview mode and not yet supported
Specifying PipelineSpec can be disabled by setting
disable-inline-spec feature flag.
See Pipeline.spec (API version: tekton.dev/v1)
retries integer
Retries represents how many times this task should be retried in case of task failure: ConditionSucceeded set to False
runAfter []string
RunAfter is the list of PipelineTask names that should be executed before this Task executes. (Used to force a specific ordering in graph execution.)
taskRef object
TaskRef is a reference to a task definition.
apiVersion string
API version of the referent Note: A Task with non-empty APIVersion and Kind is considered a Custom Task
kind string
TaskKind indicates the Kind of the Task:
- Namespaced Task when Kind is set to "Task". If Kind is "", it defaults to "Task".
- Custom Task when Kind is non-empty and APIVersion is non-empty
name string
Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
params []object
Param declares an ParamValues to use for the parameter called name.
name string required
value required
resolver string
Resolver is the name of the resolver that should perform resolution of the referenced Tekton resource, such as "git".
taskSpec
TaskSpec is a specification of a task
Specifying TaskSpec can be disabled by setting
disable-inline-spec feature flag.
See Task.spec (API version: tekton.dev/v1)
timeout string
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
when []object
WhenExpression allows a PipelineTask to declare expressions to be evaluated before the Task is run to determine whether the Task should be executed or skipped
cel string
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
input string
Input is the string for guard checking which can be a static input or an output from a parent Task
operator string
Operator that represents an Input's relationship to the values
values []string
Values is an array of strings, which is compared against the input, for guard checking It must be non-empty
workspaces []object
WorkspacePipelineTaskBinding describes how a workspace passed into the pipeline should be mapped to a task's declared workspace.
name string required
Name is the name of the workspace as declared by the task
subPath string
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).
workspace string
Workspace is the name of the workspace declared by the pipeline
workspaces []object
PipelineWorkspaceDeclaration creates a named slot in a Pipeline that a PipelineRun is expected to populate with a workspace binding.
description string
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.
name string required
Name is the name of a workspace to be provided by a PipelineRun.
optional boolean
Optional marks a Workspace as not being required in PipelineRuns. By default this field is false and so declared workspaces are required.
Pipeline describes a list of Tasks to execute. It expresses how outputs of tasks feed into inputs of subsequent tasks.
Deprecated: Please use v1.Pipeline instead.
v1beta1 versionspec object
Spec holds the desired state of the Pipeline from the client
description string
Description is a user-facing description of the pipeline that may be used to populate a UI.
displayName string
DisplayName is a user-facing name of the pipeline that may be used to populate a UI.
finally []object
PipelineTask defines a task in a Pipeline, passing inputs from both Params and from the output of previous tasks.
description string
Description is the description of this task within the context of a Pipeline. This description may be used to populate a UI.
displayName string
DisplayName is the display name of this task within the context of a Pipeline. This display name may be used to populate a UI.
matrix object
Matrix declares parameters used to fan out this task.
include []object
IncludeParams allows passing in a specific combinations of Parameters into the Matrix.
name string
Name the specified combination
params []object
Param declares an ParamValues to use for the parameter called name.
name string required
value required
params []object
Param declares an ParamValues to use for the parameter called name.
name string required
value required
name string
Name is the name of this task within the context of a Pipeline. Name is
used as a coordinate with the from and runAfter fields to establish
the execution order of tasks relative to one another.
onError string
OnError defines the exiting behavior of a PipelineRun on error can be set to [ continue | stopAndFail ]
params []object
Param declares an ParamValues to use for the parameter called name.
name string required
value required
pipelineRef object
PipelineRef is a reference to a pipeline definition Note: PipelineRef is in preview mode and not yet supported
apiVersion string
API version of the referent
bundle string
Bundle url reference to a Tekton Bundle.
Deprecated: Please use ResolverRef with the bundles resolver instead. The field is staying there for go client backward compatibility, but is not used/allowed anymore.
name string
Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
params []object
Param declares an ParamValues to use for the parameter called name.
name string required
value required
resolver string
Resolver is the name of the resolver that should perform resolution of the referenced Tekton resource, such as "git".
pipelineSpec
PipelineSpec is a specification of a pipeline
Note: PipelineSpec is in preview mode and not yet supported
Specifying PipelineSpec can be disabled by setting
disable-inline-spec feature flag.
See Pipeline.spec (API version: tekton.dev/v1beta1)
resources object
Deprecated: Unused, preserved only for backwards compatibility
inputs []object
PipelineTaskInputResource maps the name of a declared PipelineResource input dependency in a Task to the resource in the Pipeline's DeclaredPipelineResources that should be used. This input may come from a previous task.
Deprecated: Unused, preserved only for backwards compatibility
from []string
From is the list of PipelineTask names that the resource has to come from. (Implies an ordering in the execution graph.)
name string required
Name is the name of the PipelineResource as declared by the Task.
resource string required
Resource is the name of the DeclaredPipelineResource to use.
outputs []object
PipelineTaskOutputResource maps the name of a declared PipelineResource output dependency in a Task to the resource in the Pipeline's DeclaredPipelineResources that should be used.
Deprecated: Unused, preserved only for backwards compatibility
name string required
Name is the name of the PipelineResource as declared by the Task.
resource string required
Resource is the name of the DeclaredPipelineResource to use.
retries integer
Retries represents how many times this task should be retried in case of task failure: ConditionSucceeded set to False
runAfter []string
RunAfter is the list of PipelineTask names that should be executed before this Task executes. (Used to force a specific ordering in graph execution.)
taskRef object
TaskRef is a reference to a task definition.
apiVersion string
API version of the referent Note: A Task with non-empty APIVersion and Kind is considered a Custom Task
bundle string
Bundle url reference to a Tekton Bundle.
Deprecated: Please use ResolverRef with the bundles resolver instead. The field is staying there for go client backward compatibility, but is not used/allowed anymore.
kind string
TaskKind indicates the Kind of the Task:
- Namespaced Task when Kind is set to "Task". If Kind is "", it defaults to "Task".
- Custom Task when Kind is non-empty and APIVersion is non-empty
name string
Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
params []object
Param declares an ParamValues to use for the parameter called name.
name string required
value required
resolver string
Resolver is the name of the resolver that should perform resolution of the referenced Tekton resource, such as "git".
taskSpec
TaskSpec is a specification of a task
Specifying TaskSpec can be disabled by setting
disable-inline-spec feature flag.
See Task.spec (API version: tekton.dev/v1beta1)
timeout string
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
when []object
WhenExpression allows a PipelineTask to declare expressions to be evaluated before the Task is run to determine whether the Task should be executed or skipped
cel string
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
input string
Input is the string for guard checking which can be a static input or an output from a parent Task
operator string
Operator that represents an Input's relationship to the values
values []string
Values is an array of strings, which is compared against the input, for guard checking It must be non-empty
workspaces []object
WorkspacePipelineTaskBinding describes how a workspace passed into the pipeline should be mapped to a task's declared workspace.
name string required
Name is the name of the workspace as declared by the task
subPath string
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).
workspace string
Workspace is the name of the workspace declared by the pipeline
params []object
ParamSpec defines arbitrary parameters needed beyond typed inputs (such as resources). Parameter values are provided by users as inputs on a TaskRun or PipelineRun.
default
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.
description string
Description is a user-facing description of the parameter that may be used to populate a UI.
enum []string
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.
name string required
Name declares the name by which a parameter is referenced.
properties object
Properties is the JSON Schema properties to support key-value pairs parameter.
type string
Type is the user-specified type of the parameter. The possible types are currently "string", "array" and "object", and "string" is the default.
resources []object
PipelineDeclaredResource is used by a Pipeline to declare the types of the PipelineResources that it will required to run and names which can be used to refer to these PipelineResources in PipelineTaskResourceBindings.
Deprecated: Unused, preserved only for backwards compatibility
name string required
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.
optional boolean
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)
type string required
Type is the type of the PipelineResource.
results []object
PipelineResult used to describe the results of a pipeline
description string
Description is a human-readable description of the result
name string required
Name the given name
type string
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.
value required
Value the expression used to retrieve the value
tasks []object
PipelineTask defines a task in a Pipeline, passing inputs from both Params and from the output of previous tasks.
description string
Description is the description of this task within the context of a Pipeline. This description may be used to populate a UI.
displayName string
DisplayName is the display name of this task within the context of a Pipeline. This display name may be used to populate a UI.
matrix object
Matrix declares parameters used to fan out this task.
include []object
IncludeParams allows passing in a specific combinations of Parameters into the Matrix.
name string
Name the specified combination
params []object
Param declares an ParamValues to use for the parameter called name.
name string required
value required
params []object
Param declares an ParamValues to use for the parameter called name.
name string required
value required
name string
Name is the name of this task within the context of a Pipeline. Name is
used as a coordinate with the from and runAfter fields to establish
the execution order of tasks relative to one another.
onError string
OnError defines the exiting behavior of a PipelineRun on error can be set to [ continue | stopAndFail ]
params []object
Param declares an ParamValues to use for the parameter called name.
name string required
value required
pipelineRef object
PipelineRef is a reference to a pipeline definition Note: PipelineRef is in preview mode and not yet supported
apiVersion string
API version of the referent
bundle string
Bundle url reference to a Tekton Bundle.
Deprecated: Please use ResolverRef with the bundles resolver instead. The field is staying there for go client backward compatibility, but is not used/allowed anymore.
name string
Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
params []object
Param declares an ParamValues to use for the parameter called name.
name string required
value required
resolver string
Resolver is the name of the resolver that should perform resolution of the referenced Tekton resource, such as "git".
pipelineSpec
PipelineSpec is a specification of a pipeline
Note: PipelineSpec is in preview mode and not yet supported
Specifying PipelineSpec can be disabled by setting
disable-inline-spec feature flag.
See Pipeline.spec (API version: tekton.dev/v1beta1)
resources object
Deprecated: Unused, preserved only for backwards compatibility
inputs []object
PipelineTaskInputResource maps the name of a declared PipelineResource input dependency in a Task to the resource in the Pipeline's DeclaredPipelineResources that should be used. This input may come from a previous task.
Deprecated: Unused, preserved only for backwards compatibility
from []string
From is the list of PipelineTask names that the resource has to come from. (Implies an ordering in the execution graph.)
name string required
Name is the name of the PipelineResource as declared by the Task.
resource string required
Resource is the name of the DeclaredPipelineResource to use.
outputs []object
PipelineTaskOutputResource maps the name of a declared PipelineResource output dependency in a Task to the resource in the Pipeline's DeclaredPipelineResources that should be used.
Deprecated: Unused, preserved only for backwards compatibility
name string required
Name is the name of the PipelineResource as declared by the Task.
resource string required
Resource is the name of the DeclaredPipelineResource to use.
retries integer
Retries represents how many times this task should be retried in case of task failure: ConditionSucceeded set to False
runAfter []string
RunAfter is the list of PipelineTask names that should be executed before this Task executes. (Used to force a specific ordering in graph execution.)
taskRef object
TaskRef is a reference to a task definition.
apiVersion string
API version of the referent Note: A Task with non-empty APIVersion and Kind is considered a Custom Task
bundle string
Bundle url reference to a Tekton Bundle.
Deprecated: Please use ResolverRef with the bundles resolver instead. The field is staying there for go client backward compatibility, but is not used/allowed anymore.
kind string
TaskKind indicates the Kind of the Task:
- Namespaced Task when Kind is set to "Task". If Kind is "", it defaults to "Task".
- Custom Task when Kind is non-empty and APIVersion is non-empty
name string
Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
params []object
Param declares an ParamValues to use for the parameter called name.
name string required
value required
resolver string
Resolver is the name of the resolver that should perform resolution of the referenced Tekton resource, such as "git".
taskSpec
TaskSpec is a specification of a task
Specifying TaskSpec can be disabled by setting
disable-inline-spec feature flag.
See Task.spec (API version: tekton.dev/v1beta1)
timeout string
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
when []object
WhenExpression allows a PipelineTask to declare expressions to be evaluated before the Task is run to determine whether the Task should be executed or skipped
cel string
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
input string
Input is the string for guard checking which can be a static input or an output from a parent Task
operator string
Operator that represents an Input's relationship to the values
values []string
Values is an array of strings, which is compared against the input, for guard checking It must be non-empty
workspaces []object
WorkspacePipelineTaskBinding describes how a workspace passed into the pipeline should be mapped to a task's declared workspace.
name string required
Name is the name of the workspace as declared by the task
subPath string
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).
workspace string
Workspace is the name of the workspace declared by the pipeline
workspaces []object
PipelineWorkspaceDeclaration creates a named slot in a Pipeline that a PipelineRun is expected to populate with a workspace binding.
description string
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.
name string required
Name is the name of a workspace to be provided by a PipelineRun.
optional boolean
Optional marks a Workspace as not being required in PipelineRuns. By default this field is false and so declared workspaces are required.