diff --git a/docs/pipeline-api.md b/docs/pipeline-api.md index e160a627d99..83b23c6f55f 100644 --- a/docs/pipeline-api.md +++ b/docs/pipeline-api.md @@ -1,3 +1,11 @@ + +
Packages:
metadata
metadata
metadata
metadata
metadata
metadata
metadata
metadata
metadata
startTime
completionTime
metadata
volumes
stepTemplate
metadata
metadata
metadata
volumes
stepTemplate
metadata
Workspaces is a list of WorkspaceBindings from volumes to workspaces.
stepOverrides
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.
+sidecarOverrides
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.
++(Appears on:PipelineRunStatusFields) +
+ChildStatusReference is used to point to the statuses of individual TaskRuns and Runs within this PipelineRun.
+Field | +Description | +
---|---|
+name + +string + + |
+
+ Name is the name of the TaskRun or Run this is referencing. + |
+
+pipelineTaskName + +string + + |
+
+ PipelineTaskName is the name of the PipelineTask this is referencing. + |
+
+conditionChecks + + +[]PipelineRunChildConditionCheckStatus + + + |
+
+(Optional)
+ ConditionChecks is the the list of condition checks, including their names and statuses, for the PipelineTask. +Deprecated: This field will be removed when conditions are removed. + |
+
+whenExpressions + + +[]WhenExpression + + + |
+
+(Optional)
+ WhenExpressions is the list of checks guarding the execution of the PipelineTask + |
+
string
alias)@@ -4408,7 +4519,7 @@ CloudEventCondition
sentAt
metadata
Workspaces is a list of WorkspaceBindings from volumes to workspaces.
stepOverrides
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.
+sidecarOverrides
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.
+startTime
completionTime
check
Volumes
Bundle url reference to a Tekton Bundle.
ResolverRef
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.
++(Appears on:ChildStatusReference) +
+PipelineRunChildConditionCheckStatus is used to record the status of condition checks within StatusChildReferences.
+Field | +Description | +
---|---|
+PipelineRunConditionCheckStatus + + +PipelineRunConditionCheckStatus + + + |
+
+
+(Members of |
+
+conditionCheckName + +string + + |
++ | +
-(Appears on:PipelineRunTaskRunStatus) +(Appears on:PipelineRunChildConditionCheckStatus, PipelineRunTaskRunStatus)
PipelineRunConditionCheckStatus returns the condition check status
@@ -5880,7 +6084,7 @@ consume these fields via duck typing.startTime
completionTime
map of PipelineRunTaskRunStatus with the taskRun name as the key
+Deprecated - use ChildReferences instead. +map of PipelineRunTaskRunStatus with the taskRun name as the key
map of PipelineRunRunStatus with the run name as the key
+Deprecated - use ChildReferences instead. +map of PipelineRunRunStatus with the run name as the key
list of tasks that were skipped due to when expressions evaluating to false
childReferences
list of TaskRun and Run names, PipelineTask names, and API versions/kinds for children of this PipelineRun.
+matrix
Matrix declares parameters used to fan out this task.
+workspaces
stepOverrides
sidecarOverrides
string
alias)+(Appears on:ResolverRef) +
+ResolverName is the name of a resolver from which a resource can be +requested.
++(Appears on:ResolverRef) +
+ResolverParam is a single parameter passed to a resolver.
+Field | +Description | +
---|---|
+Name + +string + + |
+
+ Name is the name of the parameter that will be passed to the +resolver. + |
+
+Value + +string + + |
+
+ Value is the string value of the parameter that will be +passed to the resolver. + |
+
+(Appears on:PipelineRef, TaskRef) +
+ResolverRef can be used to refer to a Pipeline or Task in a remote +location like a git repo. This feature is in alpha and these fields +are only available when the alpha feature gate is enabled.
+Field | +Description | +
---|---|
+resolver + + +ResolverName + + + |
+
+(Optional)
+ Resolver is the name of the resolver that should perform +resolution of the referenced Tekton resource, such as “git”. + |
+
+resource + + +[]ResolverParam + + + |
+
+(Optional)
+ 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. + |
+
Container
ContainerState
Container
ContainerState
Bundle url reference to a Tekton Bundle.
ResolverRef
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.
++(Appears on:PipelineTaskRunSpec, TaskRunSpec) +
+TaskRunSidecarOverride is used to override the values of a Sidecar in the corresponding Task.
+Field | +Description | +
---|---|
+Name + +string + + |
+
+ The name of the Sidecar to override. + |
+
+Resources + + +Kubernetes core/v1.ResourceRequirements + + + |
+
+ The resource requirements to apply to the Sidecar. + |
+
@@ -7772,6 +8191,40 @@ Template
Workspaces is a list of WorkspaceBindings from volumes to workspaces.
+stepOverrides
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.
+sidecarOverrides
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.
+startTime
completionTime
+(Appears on:PipelineTaskRunSpec, TaskRunSpec) +
+TaskRunStepOverride is used to override the values of a Step in the corresponding Task.
+Field | +Description | +
---|---|
+Name + +string + + |
+
+ The name of the Step to override. + |
+
+Resources + + +Kubernetes core/v1.ResourceRequirements + + + |
+
+ The resource requirements to apply to the Step. + |
+
@@ -8069,7 +8564,7 @@ source mounted into /workspace.
volumes
stepTemplate
-(Appears on:PipelineRunRunStatus, PipelineRunTaskRunStatus, SkippedTask) +(Appears on:ChildStatusReference, PipelineRunRunStatus, PipelineRunTaskRunStatus, SkippedTask)
WhenExpression allows a PipelineTask to declare expressions to be evaluated before the Task is run @@ -8298,7 +8793,7 @@ for this binding (i.e. the volume will be mounted at this sub directory).
volumeClaimTemplate
persistentVolumeClaim
emptyDir
configMap
secret