tekton.dev/v1/Pipeline - manifests.fyi

string

.apiVersion

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

string

.kind

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

object

.metadata

object

.spec

Spec holds the desired state of the Pipeline from the client

string

.spec .description

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

string

.spec .displayName

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

array

.spec .finally

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

string

.spec .finally[] .description

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

string

.spec .finally[] .displayName

DisplayName is the display name of this task within the context of a Pipeline. This display name may be used to populate a UI.

object

.spec .finally[] .matrix

Matrix declares parameters used to fan out this task.

array

.spec .finally[] .matrix .include

Include is a list of IncludeParams which allows passing in specific combinations of Parameters into the Matrix.

string

.spec .finally[] .matrix .include[] .name

Name the specified combination

array

.spec .finally[] .matrix .include[] .params

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

string required

.spec .finally[] .matrix .include[] .params[] .name

undefined required

.spec .finally[] .matrix .include[] .params[] .value

array

.spec .finally[] .matrix .params

Params is a list of parameters used to fan out the pipelineTask Params takes only Parameters of type "array" Each array element is supplied to the PipelineTask by substituting params of type "string" in the underlying Task. The names of the params in the Matrix must match the names of the params in the underlying Task that they will be substituting.

string required

.spec .finally[] .matrix .params[] .name

undefined required

.spec .finally[] .matrix .params[] .value

string

.spec .finally[] .name

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.

string

.spec .finally[] .onError

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

array

.spec .finally[] .params

Parameters declares parameters passed to this task.

string required

.spec .finally[] .params[] .name

undefined required

.spec .finally[] .params[] .value

object

.spec .finally[] .pipelineRef

PipelineRef is a reference to a pipeline definition Note: PipelineRef is in preview mode and not yet supported

string

.spec .finally[] .pipelineRef .apiVersion

API version of the referent

string

.spec .finally[] .pipelineRef .name

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

array

.spec .finally[] .pipelineRef .params

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.

string required

.spec .finally[] .pipelineRef .params[] .name

undefined required

.spec .finally[] .pipelineRef .params[] .value

string

.spec .finally[] .pipelineRef .resolver

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

undefined

.spec .finally[] .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)

integer

.spec .finally[] .retries

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

array

.spec .finally[] .runAfter

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

object

.spec .finally[] .taskRef

TaskRef is a reference to a task definition.

string

.spec .finally[] .taskRef .apiVersion

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

string

.spec .finally[] .taskRef .kind

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

string

.spec .finally[] .taskRef .name

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

array

.spec .finally[] .taskRef .params

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.

string required

.spec .finally[] .taskRef .params[] .name

undefined required

.spec .finally[] .taskRef .params[] .value

string

.spec .finally[] .taskRef .resolver

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

undefined

.spec .finally[] .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)

string

.spec .finally[] .timeout

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

array

.spec .finally[] .when

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

string

.spec .finally[] .when[] .cel

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

string

.spec .finally[] .when[] .input

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

string

.spec .finally[] .when[] .operator

Operator that represents an Input’s relationship to the values

array

.spec .finally[] .when[] .values

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

array

.spec .finally[] .workspaces

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

string required

.spec .finally[] .workspaces[] .name

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

string

.spec .finally[] .workspaces[] .subPath

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

string

.spec .finally[] .workspaces[] .workspace

Workspace is the name of the workspace declared by the pipeline

array

.spec .params

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

undefined

.spec .params[] .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.

string

.spec .params[] .description

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

array

.spec .params[] .enum

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.

string required

.spec .params[] .name

Name declares the name by which a parameter is referenced.

object

.spec .params[] .properties

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

string

.spec .params[] .type

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

array

.spec .results

Results are values that this pipeline can output once run

string

.spec .results[] .description

Description is a human-readable description of the result

string required

.spec .results[] .name

Name the given name

string

.spec .results[] .type

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.

undefined required

.spec .results[] .value

Value the expression used to retrieve the value

array

.spec .tasks

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

string

.spec .tasks[] .description

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

string

.spec .tasks[] .displayName

DisplayName is the display name of this task within the context of a Pipeline. This display name may be used to populate a UI.

object

.spec .tasks[] .matrix

Matrix declares parameters used to fan out this task.

array

.spec .tasks[] .matrix .include

Include is a list of IncludeParams which allows passing in specific combinations of Parameters into the Matrix.

string

.spec .tasks[] .matrix .include[] .name

Name the specified combination

array

.spec .tasks[] .matrix .include[] .params

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

string required

.spec .tasks[] .matrix .include[] .params[] .name

undefined required

.spec .tasks[] .matrix .include[] .params[] .value

array

.spec .tasks[] .matrix .params

Params is a list of parameters used to fan out the pipelineTask Params takes only Parameters of type "array" Each array element is supplied to the PipelineTask by substituting params of type "string" in the underlying Task. The names of the params in the Matrix must match the names of the params in the underlying Task that they will be substituting.

string required

.spec .tasks[] .matrix .params[] .name

undefined required

.spec .tasks[] .matrix .params[] .value

string

.spec .tasks[] .name

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.

string

.spec .tasks[] .onError

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

array

.spec .tasks[] .params

Parameters declares parameters passed to this task.

string required

.spec .tasks[] .params[] .name

undefined required

.spec .tasks[] .params[] .value

object

.spec .tasks[] .pipelineRef

PipelineRef is a reference to a pipeline definition Note: PipelineRef is in preview mode and not yet supported

string

.spec .tasks[] .pipelineRef .apiVersion

API version of the referent

string

.spec .tasks[] .pipelineRef .name

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

array

.spec .tasks[] .pipelineRef .params

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.

string required

.spec .tasks[] .pipelineRef .params[] .name

undefined required

.spec .tasks[] .pipelineRef .params[] .value

string

.spec .tasks[] .pipelineRef .resolver

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

undefined

.spec .tasks[] .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)

integer

.spec .tasks[] .retries

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

array

.spec .tasks[] .runAfter

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

object

.spec .tasks[] .taskRef

TaskRef is a reference to a task definition.

string

.spec .tasks[] .taskRef .apiVersion

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

string

.spec .tasks[] .taskRef .kind

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

string

tekton.dev / v1 / Pipeline