@@ -7770,6 +8202,23 @@ TaskSpec
+resources
+
+
+TaskResources
+
+
+ |
+
+(Optional)
+ Resources is a list input and output resource to run the task
+Resources are represented in TaskRuns as bindings to instances of
+PipelineResources.
+Deprecated: Unused, preserved only for backwards compatibility
+ |
+
+
+
params
@@ -7986,6 +8435,20 @@ Params
|
+resources
+
+
+TaskRunResources
+
+
+ |
+
+(Optional)
+ Deprecated: Unused, preserved only for backwards compatibility
+ |
+
+
+
serviceAccountName
string
@@ -8769,6 +9232,58 @@ The names of the params must match the names of the params
|
+InternalTaskModifier
+
+
+
InternalTaskModifier implements TaskModifier for resources that are built-in to Tekton Pipelines.
+
Deprecated: Unused, preserved only for backwards compatibility
+
Matrix
@@ -8828,7 +9343,7 @@ IncludeParamsList
Param
-(Appears on:ResolutionRequestSpec)
+(Appears on:TaskRunInputs, ResolutionRequestSpec)
Param declares an ParamValues to use for the parameter called name.
@@ -8968,13 +9483,146 @@ parameter.
ParamType indicates the type of an input parameter;
Used to distinguish between a single string and an array of strings.
-ParamValue
+ParamValue
+
+
+(Appears on:Param, ParamSpec, PipelineResult, PipelineRunResult, TaskRunResult)
+
+
+
ResultValue is a type alias of ParamValue
+
+
+
+| Field |
+Description |
+
+
+
+
+
+type
+
+
+ParamType
+
+
+ |
+
+ |
+
+
+
+stringVal
+
+string
+
+ |
+
+ Represents the stored type of ParamValues.
+ |
+
+
+
+arrayVal
+
+[]string
+
+ |
+
+ |
+
+
+
+objectVal
+
+map[string]string
+
+ |
+
+ |
+
+
+
+Params
+([]github.com/tektoncd/pipeline/pkg/apis/pipeline/v1beta1.Param alias)
+
+(Appears on:RunSpec, CustomRunSpec, IncludeParams, Matrix, PipelineRunSpec, PipelineTask, ResolverRef, TaskRunSpec)
+
+
+
Params is a list of Param
+
PipelineDeclaredResource
+
+
+(Appears on:PipelineSpec)
+
+
+
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
+
+
+
+| Field |
+Description |
+
+
+
+
+
+name
+
+string
+
+ |
+
+ 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
+
+string
+
+ |
+
+ Type is the type of the PipelineResource.
+ |
+
+
+
+optional
+
+bool
+
+ |
+
+ 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)
+ |
+
+
+
+PipelineObject
+
+
+
PipelineObject is implemented by Pipeline
+
PipelineRef
-(Appears on:Param, ParamSpec, PipelineResult, PipelineRunResult, TaskRunResult)
+(Appears on:PipelineRunSpec)
-
ResultValue is a type alias of ParamValue
+
PipelineRef can be used to refer to a specific instance of a Pipeline.
@@ -8986,69 +9634,67 @@ Used to distinguish between a single string and an array of strings.
-type
+name
-
-ParamType
-
+string
|
+ Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
|
-stringVal
+apiVersion
string
|
- Represents the stored type of ParamValues.
+(Optional)
+API version of the referent
|
-arrayVal
+bundle
-[]string
+string
|
+(Optional)
+ Bundle url reference to a Tekton Bundle.
+Deprecated: Please use ResolverRef with the bundles resolver instead.
|
-objectVal
+ResolverRef
-map[string]string
+
+ResolverRef
+
|
+(Optional)
+ 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.
|
-Params
-([]github.com/tektoncd/pipeline/pkg/apis/pipeline/v1beta1.Param alias)
-
-(Appears on:RunSpec, CustomRunSpec, IncludeParams, Matrix, PipelineRunSpec, PipelineTask, ResolverRef, TaskRunSpec)
-
-
-
Params is a list of Param
-
PipelineObject
-
-
-
PipelineObject is implemented by Pipeline
-
PipelineRef
+PipelineResourceBinding
-(Appears on:PipelineRunSpec)
+(Appears on:PipelineRunSpec, TaskResourceBinding)
-
PipelineRef can be used to refer to a specific instance of a Pipeline.
+
PipelineResourceBinding connects a reference to an instance of a PipelineResource
+with a PipelineResource dependency that the Pipeline has declared
+
Deprecated: Unused, preserved only for backwards compatibility
@@ -9066,48 +9712,85 @@ string
|
- Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
+Name is the name of the PipelineResource in the Pipeline’s declaration
|
-apiVersion
+resourceRef
-string
+
+PipelineResourceRef
+
|
(Optional)
- API version of the referent
+ResourceRef is a reference to the instance of the actual PipelineResource
+that should be used
|
-bundle
+resourceSpec
-string
+
+PipelineResourceSpec
+
|
(Optional)
- Bundle url reference to a Tekton Bundle.
-Deprecated: Please use ResolverRef with the bundles resolver instead.
+ResourceSpec is specification of a resource that should be created and
+consumed by the task
+ |
+
+
+
+PipelineResourceInterface
+
+
+
PipelineResourceInterface interface to be implemented by different PipelineResource types
+
Deprecated: Unused, preserved only for backwards compatibility
+
PipelineResourceRef
+
+
+(Appears on:PipelineResourceBinding)
+
+
+
PipelineResourceRef can be used to refer to a specific instance of a Resource
+
Deprecated: Unused, preserved only for backwards compatibility
+
+
+
+| Field |
+Description |
+
+
+
+
+
+name
+
+string
+
+ |
+
+ Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
|
-ResolverRef
+apiVersion
-
-ResolverRef
-
+string
|
(Optional)
- 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.
+API version of the referent
|
@@ -9395,6 +10078,22 @@ PipelineSpec
+resources
+
+
+[]PipelineResourceBinding
+
+
+ |
+
+ Resources is a list of bindings specifying which actual instances of
+PipelineResources to use for the resources the Pipeline has declared
+it needs.
+Deprecated: Unused, preserved only for backwards compatibility
+ |
+
+
+
params
@@ -9841,6 +10540,19 @@ used to populate a UI.
|
+resources
+
+
+[]PipelineDeclaredResource
+
+
+ |
+
+ Deprecated: Unused, preserved only for backwards compatibility
+ |
+
+
+
tasks
@@ -10037,6 +10749,20 @@ this Task executes. (Used to force a specific ordering in graph execution.)
|
+resources
+
+
+PipelineTaskResources
+
+
+ |
+
+(Optional)
+ Deprecated: Unused, preserved only for backwards compatibility
+ |
+
+
+
params
@@ -10080,29 +10806,165 @@ declared in the Task.
|
-timeout
+timeout
+
+
+Kubernetes meta/v1.Duration
+
+
+ |
+
+(Optional)
+ 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
+ |
+
+
+
+
+
+(Appears on:PipelineTaskResources)
+
+
+
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
+
+
+
+| Field |
+Description |
+
+
+
+
+
+name
+
+string
+
+ |
+
+ Name is the name of the PipelineResource as declared by the Task.
+ |
+
+
+
+resource
+
+string
+
+ |
+
+ Resource is the name of the DeclaredPipelineResource to use.
+ |
+
+
+
+from
+
+[]string
+
+ |
+
+(Optional)
+ From is the list of PipelineTask names that the resource has to come from.
+(Implies an ordering in the execution graph.)
+ |
+
+
+
+
+
+(Appears on:EmbeddedRunSpec, EmbeddedCustomRunSpec, EmbeddedTask, PipelineTaskRunSpec)
+
+
+
PipelineTaskMetadata contains the labels or annotations for an EmbeddedTask
+
+
+
+| Field |
+Description |
+
+
+
+
+
+labels
+
+map[string]string
+
+ |
+
+(Optional)
+ |
+
+
+
+annotations
+
+map[string]string
+
+ |
+
+(Optional)
+ |
+
+
+
+PipelineTaskOutputResource
+
+
+(Appears on:PipelineTaskResources)
+
+
+
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
+
+
+
+| Field |
+Description |
+
+
+
+
+
+name
+
+string
+
+ |
+
+ Name is the name of the PipelineResource as declared by the Task.
+ |
+
+
+
+resource
-
-Kubernetes meta/v1.Duration
-
+string
|
-(Optional)
- 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
+Resource is the name of the DeclaredPipelineResource to use.
|
-
-(Appears on:EmbeddedRunSpec, EmbeddedCustomRunSpec, EmbeddedTask, PipelineTaskRunSpec)
-
-
PipelineTaskMetadata contains the labels or annotations for an EmbeddedTask
+
PipelineTaskParam is used to provide arbitrary string parameters to a Task.
@@ -10114,32 +10976,35 @@ Refer Go’s ParseDuration documentation for expected format: PipelineTaskParam
+PipelineTaskResources
+
+(Appears on:PipelineTask)
+
-
PipelineTaskParam is used to provide arbitrary string parameters to a Task.
+
PipelineTaskResources allows a Pipeline to declare how its DeclaredPipelineResources
+should be provided to a Task as its inputs and outputs.
+
Deprecated: Unused, preserved only for backwards compatibility
@@ -10151,22 +11016,30 @@ map[string]string
-name
+inputs
-string
+
+[]PipelineTaskInputResource
+
|
+ Inputs holds the mapping from the PipelineResources declared in
+DeclaredPipelineResources to the input PipelineResources required by the Task.
|
-value
+outputs
-string
+
+[]PipelineTaskOutputResource
+
|
+ Outputs holds the mapping from the PipelineResources declared in
+DeclaredPipelineResources to the input PipelineResources required by the Task.
|
@@ -11121,7 +11994,7 @@ SkippingReason
Step
-(Appears on:TaskSpec)
+(Appears on:InternalTaskModifier, TaskSpec)
Step runs a subcomponent of a Task
@@ -12066,6 +12939,12 @@ Default is false.
TaskKind defines the type of Task used by the pipeline.
+
TaskModifier
+
+
+
TaskModifier is an interface to be implemented by different PipelineResources
+
Deprecated: Unused, preserved only for backwards compatibility
+
TaskObject
@@ -12158,6 +13037,141 @@ feature gate is enabled.
+TaskResource
+
+
+(Appears on:TaskResources)
+
+
+
TaskResource defines an input or output Resource declared as a requirement
+by a Task. The Name field will be used to refer to these Resources within
+the Task definition, and when provided as an Input, the Name will be the
+path to the volume mounted containing this Resource as an input (e.g.
+an input Resource named workspace will be mounted at /workspace).
+
Deprecated: Unused, preserved only for backwards compatibility
+
+
+
+| Field |
+Description |
+
+
+
+
+
+ResourceDeclaration
+
+
+ResourceDeclaration
+
+
+ |
+
+
+(Members of ResourceDeclaration are embedded into this type.)
+
+ |
+
+
+
+TaskResourceBinding
+
+
+(Appears on:TaskRunInputs, TaskRunOutputs, TaskRunResources)
+
+
+
TaskResourceBinding points to the PipelineResource that
+will be used for the Task input or output called Name.
+
Deprecated: Unused, preserved only for backwards compatibility
+
+
+
+| Field |
+Description |
+
+
+
+
+
+PipelineResourceBinding
+
+
+PipelineResourceBinding
+
+
+ |
+
+
+(Members of PipelineResourceBinding are embedded into this type.)
+
+ |
+
+
+
+paths
+
+[]string
+
+ |
+
+(Optional)
+ 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).
+ |
+
+
+
+TaskResources
+
+
+(Appears on:TaskSpec)
+
+
+
TaskResources allows a Pipeline to declare how its DeclaredPipelineResources
+should be provided to a Task as its inputs and outputs.
+
Deprecated: Unused, preserved only for backwards compatibility
+
+
+
+| Field |
+Description |
+
+
+
+
+
+inputs
+
+
+[]TaskResource
+
+
+ |
+
+ Inputs holds the mapping from the PipelineResources declared in
+DeclaredPipelineResources to the input PipelineResources required by the Task.
+ |
+
+
+
+outputs
+
+
+[]TaskResource
+
+
+ |
+
+ Outputs holds the mapping from the PipelineResources declared in
+DeclaredPipelineResources to the input PipelineResources required by the Task.
+ |
+
+
+
TaskResult
@@ -12263,6 +13277,77 @@ conditions such as one used in spire results verification
+
+
+
TaskRunInputs holds the input values that this task was invoked with.
+
Deprecated: Unused, preserved only for backwards compatibility
+
TaskRunOutputs
+
+
+
TaskRunOutputs holds the output values that this task was invoked with.
+
Deprecated: Unused, preserved only for backwards compatibility
+
TaskRunReason
(string alias)
@@ -12270,6 +13355,51 @@ conditions such as one used in spire results verification
the Succeeded condition that are controlled by the TaskRun itself. Failure
reasons that emerge from underlying resources are not included here
+TaskRunResources
+
+
+(Appears on:TaskRunSpec)
+
+
+
TaskRunResources allows a TaskRun to declare inputs and outputs TaskResourceBinding
+
Deprecated: Unused, preserved only for backwards compatibility
+
+
+
+| Field |
+Description |
+
+
+
+
+
+inputs
+
+
+[]TaskResourceBinding
+
+
+ |
+
+ Inputs holds the inputs resources this task was invoked with
+ |
+
+
+
+outputs
+
+
+[]TaskResourceBinding
+
+
+ |
+
+ Outputs holds the inputs resources this task was invoked with
+ |
+
+
+
TaskRunResult
@@ -12413,6 +13543,20 @@ Params