Pipeline
tekton.dev / v1
apiVersion: tekton.dev/v1
kind: Pipeline
metadata:
name: example
apiVersion
string
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind
string
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata
object
spec 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
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
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
Include is a list of IncludeParams which allows passing in specific combinations of Parameters into the Matrix.
name
string
Name the specified combination
params []object
Params takes only `Parameters` of type `"string"`
The names of the `params` must match the names of the `params` in the underlying `Task`
name
string required
value
object required
params []object
Params is a list of parameters used to fan out the pipelineTask
Params takes only `Parameters` of type `"array"`
Each array element is supplied to the `PipelineTask` by substituting `params` of type `"string"` in the underlying `Task`.
The names of the `params` in the `Matrix` must match the names of the `params` in the underlying `Task` that they will be substituting.
name
string required
value
object 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
Parameters declares parameters passed to this task.
name
string required
value
object 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
Params contains the parameters used to identify the
referenced Tekton resource. Example entries might include
"repo" or "path" but the set of params ultimately depends on
the chosen resolver.
name
string required
value
object required
resolver
string
Resolver is the name of the resolver that should perform
resolution of the referenced Tekton resource, such as "git".
pipelineSpec
object
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:
1. Namespaced Task when Kind is set to "Task". If Kind is "", it defaults to "Task".
2. Custom Task when Kind is non-empty and APIVersion is non-empty
name
string
Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
params []object
Params contains the parameters used to identify the
referenced Tekton resource. Example entries might include
"repo" or "path" but the set of params ultimately depends on
the chosen resolver.
name
string required
value
object required
resolver
string
Resolver is the name of the resolver that should perform
resolution of the referenced Tekton resource, such as "git".
taskSpec
object
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
Duration 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
When is a list of when expressions that need to be true for the task to run
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
Workspaces maps workspaces from the pipeline spec to the workspaces
declared in the Task.
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
Params declares a list of input parameters that must be supplied when
this Pipeline is run.
default
object
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
Results are values that this pipeline can output once run
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
object required
Value the expression used to retrieve the value
tasks []object
Tasks declares the graph of Tasks that execute when this Pipeline is run.
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
Include is a list of IncludeParams which allows passing in specific combinations of Parameters into the Matrix.
name
string
Name the specified combination
params []object
Params takes only `Parameters` of type `"string"`
The names of the `params` must match the names of the `params` in the underlying `Task`
name
string required
value
object required
params []object
Params is a list of parameters used to fan out the pipelineTask
Params takes only `Parameters` of type `"array"`
Each array element is supplied to the `PipelineTask` by substituting `params` of type `"string"` in the underlying `Task`.
The names of the `params` in the `Matrix` must match the names of the `params` in the underlying `Task` that they will be substituting.
name
string required
value
object 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
Parameters declares parameters passed to this task.
name
string required
value
object 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
Params contains the parameters used to identify the
referenced Tekton resource. Example entries might include
"repo" or "path" but the set of params ultimately depends on
the chosen resolver.
name
string required
value
object required
resolver
string
Resolver is the name of the resolver that should perform
resolution of the referenced Tekton resource, such as "git".
pipelineSpec
object
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:
1. Namespaced Task when Kind is set to "Task". If Kind is "", it defaults to "Task".
2. Custom Task when Kind is non-empty and APIVersion is non-empty
name
string
Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
params []object
Params contains the parameters used to identify the
referenced Tekton resource. Example entries might include
"repo" or "path" but the set of params ultimately depends on
the chosen resolver.
name
string required
value
object required
resolver
string
Resolver is the name of the resolver that should perform
resolution of the referenced Tekton resource, such as "git".
taskSpec
object
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
Duration 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
When is a list of when expressions that need to be true for the task to run
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
Workspaces maps workspaces from the pipeline spec to the workspaces
declared in the Task.
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
Workspaces declares a set of named workspaces that are expected to be
provided by a PipelineRun.
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.
No matches. Try .spec.description for an exact path