Documentation
¶
Overview ¶
Copyright 2022 The Tekton Authors
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Package v1 contains API Schema definitions for the pipeline v1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/tektoncd/pipeline/pkg/apis/pipeline +k8s:defaulter-gen=TypeMeta +groupName=tekton.dev
Index ¶
- Constants
- Variables
- func ArrayReference(a string) string
- func ExtractStepResultName(value string) (string, string, error)
- func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenAPIDefinition
- func Kind(kind string) schema.GroupKind
- func LooksLikeContainsResultRefs(expressions []string) bool
- func ParseResultName(resultName string) (string, string)
- func Resource(resource string) schema.GroupResource
- func ResultsArrayReference(a string) string
- func ValidateNameFormat(stringAndArrayParams sets.String, objectParams []ParamSpec) (errs *apis.FieldError)
- func ValidateObjectParamsHaveProperties(ctx context.Context, params ParamSpecs) *apis.FieldError
- func ValidateParameterTypes(ctx context.Context, params []ParamSpec) (errs *apis.FieldError)
- func ValidateParameterVariables(ctx context.Context, steps []Step, params ParamSpecs) *apis.FieldError
- func ValidateParameters(ctx context.Context, params Params) (errs *apis.FieldError)
- func ValidatePipelineParameterVariables(ctx context.Context, tasks []PipelineTask, params ParamSpecs) (errs *apis.FieldError)
- func ValidatePipelineTasks(ctx context.Context, tasks []PipelineTask, finalTasks []PipelineTask) *apis.FieldError
- func ValidateStepResults(ctx context.Context, results []StepResult) (errs *apis.FieldError)
- func ValidateStepResultsVariables(ctx context.Context, results []StepResult, script string) (errs *apis.FieldError)
- func ValidateUsageOfDeclaredParameters(ctx context.Context, steps []Step, params ParamSpecs) *apis.FieldError
- func ValidateVolumes(volumes []corev1.Volume) (errs *apis.FieldError)
- func ValidateWorkspaceBindings(ctx context.Context, wb []WorkspaceBinding) (errs *apis.FieldError)
- type Algorithm
- type Artifact
- type ArtifactValue
- type Artifacts
- type ChildStatusReference
- type Combination
- type Combinations
- type EmbeddedTask
- type IncludeParams
- type IncludeParamsList
- type Matrix
- type OnErrorType
- type Param
- type ParamSpec
- type ParamSpecs
- func (in ParamSpecs) DeepCopy() ParamSpecs
- func (in ParamSpecs) DeepCopyInto(out *ParamSpecs)
- func (ps ParamSpecs) ExtractDefaultParamArrayLengths() map[string]int
- func (ps ParamSpecs) GetNames() []string
- func (ps ParamSpecs) SortByType() (ParamSpecs, ParamSpecs, ParamSpecs)
- func (ps ParamSpecs) ValidateNoDuplicateNames() *apis.FieldError
- type ParamType
- type ParamValue
- func (paramValues *ParamValue) ApplyReplacements(stringReplacements map[string]string, arrayReplacements map[string][]string, ...)
- func (in *ParamValue) DeepCopy() *ParamValue
- func (in *ParamValue) DeepCopyInto(out *ParamValue)
- func (paramValues ParamValue) MarshalJSON() ([]byte, error)
- func (paramValues *ParamValue) UnmarshalJSON(value []byte) error
- type Params
- func (in Params) DeepCopy() Params
- func (in Params) DeepCopyInto(out *Params)
- func (ps Params) ExtractNames() sets.String
- func (ps Params) ExtractParamArrayLengths() map[string]int
- func (ps Params) ReplaceVariables(stringReplacements map[string]string, arrayReplacements map[string][]string, ...) Params
- type Pipeline
- func (p *Pipeline) Checksum() ([]byte, error)
- func (p *Pipeline) ConvertFrom(ctx context.Context, source apis.Convertible) error
- func (p *Pipeline) ConvertTo(ctx context.Context, sink apis.Convertible) error
- func (in *Pipeline) DeepCopy() *Pipeline
- func (in *Pipeline) DeepCopyInto(out *Pipeline)
- func (in *Pipeline) DeepCopyObject() runtime.Object
- func (*Pipeline) GetGroupVersionKind() schema.GroupVersionKind
- func (p *Pipeline) PipelineMetadata() metav1.ObjectMeta
- func (p *Pipeline) PipelineSpec() PipelineSpec
- func (p *Pipeline) SetDefaults(ctx context.Context)
- func (p *Pipeline) SupportedVerbs() []admissionregistrationv1.OperationType
- func (p *Pipeline) Validate(ctx context.Context) *apis.FieldError
- type PipelineList
- type PipelineRef
- type PipelineResult
- type PipelineRun
- func (pr *PipelineRun) ConvertFrom(ctx context.Context, source apis.Convertible) error
- func (pr *PipelineRun) ConvertTo(ctx context.Context, sink apis.Convertible) error
- func (in *PipelineRun) DeepCopy() *PipelineRun
- func (in *PipelineRun) DeepCopyInto(out *PipelineRun)
- func (in *PipelineRun) DeepCopyObject() runtime.Object
- func (pr *PipelineRun) FinallyTimeout() *metav1.Duration
- func (*PipelineRun) GetGroupVersionKind() schema.GroupVersionKind
- func (pr *PipelineRun) GetName() string
- func (pr *PipelineRun) GetNamespacedName() types.NamespacedName
- func (pr *PipelineRun) GetStatusCondition() apis.ConditionAccessor
- func (pr *PipelineRun) GetTaskRunSpec(pipelineTaskName string) PipelineTaskRunSpec
- func (pr *PipelineRun) HasFinallyTimedOut(ctx context.Context, c clock.PassiveClock) bool
- func (pr *PipelineRun) HasStarted() bool
- func (pr *PipelineRun) HasTimedOut(ctx context.Context, c clock.PassiveClock) bool
- func (pr *PipelineRun) HasTimedOutForALongTime(ctx context.Context, c clock.PassiveClock) bool
- func (pr *PipelineRun) HasVolumeClaimTemplate() bool
- func (pr *PipelineRun) HaveTasksTimedOut(ctx context.Context, c clock.PassiveClock) bool
- func (pr *PipelineRun) IsCancelled() bool
- func (pr *PipelineRun) IsDone() bool
- func (pr *PipelineRun) IsGracefullyCancelled() bool
- func (pr *PipelineRun) IsGracefullyStopped() bool
- func (pr *PipelineRun) IsPending() bool
- func (pr *PipelineRun) IsTimeoutConditionSet() bool
- func (pr *PipelineRun) PipelineTimeout(ctx context.Context) time.Duration
- func (pr *PipelineRun) SetDefaults(ctx context.Context)
- func (pr *PipelineRun) SetTimeoutCondition(ctx context.Context)
- func (pr *PipelineRun) SupportedVerbs() []admissionregistrationv1.OperationType
- func (pr *PipelineRun) TasksTimeout() *metav1.Duration
- func (pr *PipelineRun) Validate(ctx context.Context) *apis.FieldError
- type PipelineRunList
- type PipelineRunReason
- type PipelineRunResult
- type PipelineRunRunStatus
- type PipelineRunSpec
- type PipelineRunSpecStatus
- type PipelineRunStatus
- func (in *PipelineRunStatus) DeepCopy() *PipelineRunStatus
- func (in *PipelineRunStatus) DeepCopyInto(out *PipelineRunStatus)
- func (pr *PipelineRunStatus) GetCondition(t apis.ConditionType) *apis.Condition
- func (pr *PipelineRunStatus) InitializeConditions(c clock.PassiveClock)
- func (pr *PipelineRunStatus) MarkFailed(reason, messageFormat string, messageA ...interface{})
- func (pr *PipelineRunStatus) MarkRunning(reason, messageFormat string, messageA ...interface{})
- func (pr *PipelineRunStatus) MarkSucceeded(reason, messageFormat string, messageA ...interface{})
- func (pr *PipelineRunStatus) SetCondition(newCond *apis.Condition)
- type PipelineRunStatusFields
- type PipelineRunTaskRunStatus
- type PipelineSpec
- func (in *PipelineSpec) DeepCopy() *PipelineSpec
- func (in *PipelineSpec) DeepCopyInto(out *PipelineSpec)
- func (ps *PipelineSpec) GetIndexingReferencesToArrayParams() sets.String
- func (ps *PipelineSpec) SetDefaults(ctx context.Context)
- func (ps *PipelineSpec) Validate(ctx context.Context) (errs *apis.FieldError)
- func (ps *PipelineSpec) ValidateBetaFields(ctx context.Context) *apis.FieldError
- type PipelineTask
- func (in *PipelineTask) DeepCopy() *PipelineTask
- func (in *PipelineTask) DeepCopyInto(out *PipelineTask)
- func (pt PipelineTask) Deps() []string
- func (pt *PipelineTask) GetVarSubstitutionExpressions() []string
- func (pt PipelineTask) HashKey() string
- func (pt *PipelineTask) IsMatrixed() bool
- func (pt *PipelineTask) SetDefaults(ctx context.Context)
- func (pt *PipelineTask) TaskSpecMetadata() PipelineTaskMetadata
- func (pt PipelineTask) Validate(ctx context.Context) (errs *apis.FieldError)
- func (pt PipelineTask) ValidateName() *apis.FieldError
- type PipelineTaskList
- func (in PipelineTaskList) DeepCopy() PipelineTaskList
- func (in PipelineTaskList) DeepCopyInto(out *PipelineTaskList)
- func (l PipelineTaskList) Deps() map[string][]string
- func (l PipelineTaskList) Items() []dag.Task
- func (l PipelineTaskList) Names() sets.String
- func (l PipelineTaskList) Validate(ctx context.Context, taskNames sets.String, path string) (errs *apis.FieldError)
- type PipelineTaskMetadata
- type PipelineTaskOnErrorType
- type PipelineTaskParam
- type PipelineTaskRun
- type PipelineTaskRunSpec
- type PipelineTaskRunTemplate
- type PipelineWorkspaceDeclaration
- type PropertySpec
- type Provenance
- type Ref
- type RefSource
- type ResolverName
- type ResolverRef
- type ResultRef
- type ResultValue
- type ResultsType
- type Sidecar
- type SidecarState
- type SkippedTask
- type SkippingReason
- type Step
- type StepOutputConfig
- type StepResult
- type StepState
- type StepTemplate
- type Task
- func (t *Task) Checksum() ([]byte, error)
- func (t *Task) ConvertFrom(ctx context.Context, source apis.Convertible) error
- func (t *Task) ConvertTo(ctx context.Context, sink apis.Convertible) error
- func (in *Task) DeepCopy() *Task
- func (in *Task) DeepCopyInto(out *Task)
- func (in *Task) DeepCopyObject() runtime.Object
- func (*Task) GetGroupVersionKind() schema.GroupVersionKind
- func (t *Task) SetDefaults(ctx context.Context)
- func (t *Task) SupportedVerbs() []admissionregistrationv1.OperationType
- func (t *Task) Validate(ctx context.Context) *apis.FieldError
- type TaskBreakpoints
- type TaskKind
- type TaskList
- type TaskRef
- type TaskResult
- type TaskRun
- func (tr *TaskRun) ConvertFrom(ctx context.Context, source apis.Convertible) error
- func (tr *TaskRun) ConvertTo(ctx context.Context, sink apis.Convertible) error
- func (in *TaskRun) DeepCopy() *TaskRun
- func (in *TaskRun) DeepCopyInto(out *TaskRun)
- func (in *TaskRun) DeepCopyObject() runtime.Object
- func (*TaskRun) GetGroupVersionKind() schema.GroupVersionKind
- func (tr *TaskRun) GetNamespacedName() types.NamespacedName
- func (tr *TaskRun) GetPipelineRunPVCName() string
- func (tr *TaskRun) GetStatusCondition() apis.ConditionAccessor
- func (tr *TaskRun) GetTimeout(ctx context.Context) time.Duration
- func (tr *TaskRun) HasPipelineRunOwnerReference() bool
- func (tr *TaskRun) HasStarted() bool
- func (tr *TaskRun) HasTimedOut(ctx context.Context, c clock.PassiveClock) bool
- func (tr *TaskRun) HasVolumeClaimTemplate() bool
- func (tr *TaskRun) IsCancelled() bool
- func (tr *TaskRun) IsDone() bool
- func (tr *TaskRun) IsFailure() bool
- func (tr *TaskRun) IsRetriable() bool
- func (tr *TaskRun) IsSuccessful() bool
- func (tr *TaskRun) SetDefaults(ctx context.Context)
- func (tr *TaskRun) SupportedVerbs() []admissionregistrationv1.OperationType
- func (tr *TaskRun) Validate(ctx context.Context) *apis.FieldError
- type TaskRunDebug
- type TaskRunInputs
- type TaskRunList
- type TaskRunReason
- type TaskRunResult
- type TaskRunSidecarSpec
- type TaskRunSpec
- type TaskRunSpecStatus
- type TaskRunSpecStatusMessage
- type TaskRunStatus
- func (in *TaskRunStatus) DeepCopy() *TaskRunStatus
- func (in *TaskRunStatus) DeepCopyInto(out *TaskRunStatus)
- func (trs *TaskRunStatus) GetCondition(t apis.ConditionType) *apis.Condition
- func (trs *TaskRunStatus) GetRunningReason() string
- func (trs *TaskRunStatus) GetStartedReason() string
- func (trs *TaskRunStatus) InitializeConditions()
- func (trs *TaskRunStatus) MarkResourceFailed(reason TaskRunReason, err error)
- func (trs *TaskRunStatus) MarkResourceOngoing(reason TaskRunReason, message string)
- func (trs *TaskRunStatus) SetCondition(newCond *apis.Condition)
- type TaskRunStatusFields
- type TaskRunStepArtifact
- type TaskRunStepResult
- type TaskRunStepSpec
- type TaskSpec
- type TimeoutFields
- type WhenExpression
- type WhenExpressions
- func (wes WhenExpressions) AllowsExecution(evaluatedCEL map[string]bool) bool
- func (in WhenExpressions) DeepCopy() WhenExpressions
- func (in WhenExpressions) DeepCopyInto(out *WhenExpressions)
- func (wes WhenExpressions) ReplaceVariables(replacements map[string]string, arrayReplacements map[string][]string) WhenExpressions
- type WorkspaceBinding
- type WorkspaceDeclaration
- type WorkspacePipelineDeclarationdeprecated
- type WorkspacePipelineTaskBinding
- type WorkspaceUsage
Constants ¶
const ( // PipelineTasksAggregateStatus is a param representing aggregate status of all dag pipelineTasks PipelineTasksAggregateStatus = "tasks.status" // PipelineTasks is a value representing a task is a member of "tasks" section of the pipeline PipelineTasks = "tasks" // PipelineFinallyTasks is a value representing a task is a member of "finally" section of the pipeline PipelineFinallyTasks = "finally" // PipelineTaskStopAndFail indicates to stop and fail the PipelineRun if the PipelineTask fails PipelineTaskStopAndFail PipelineTaskOnErrorType = "stopAndFail" // PipelineTaskContinue indicates to continue executing the rest of the DAG when the PipelineTask fails PipelineTaskContinue PipelineTaskOnErrorType = "continue" )
const ( // PipelineRunSpecStatusCancelled indicates that the user wants to cancel the task, // if not already cancelled or terminated PipelineRunSpecStatusCancelled = "Cancelled" // PipelineRunSpecStatusCancelledRunFinally indicates that the user wants to cancel the pipeline run, // if not already cancelled or terminated, but ensure finally is run normally PipelineRunSpecStatusCancelledRunFinally = "CancelledRunFinally" // PipelineRunSpecStatusStoppedRunFinally indicates that the user wants to stop the pipeline run, // wait for already running tasks to be completed and run finally // if not already cancelled or terminated PipelineRunSpecStatusStoppedRunFinally = "StoppedRunFinally" // PipelineRunSpecStatusPending indicates that the user wants to postpone starting a PipelineRun // until some condition is met PipelineRunSpecStatusPending = "PipelineRunPending" )
const ( // ResultTaskPart Constant used to define the "tasks" part of a pipeline result reference // retained because of backwards compatibility ResultTaskPart = resultref.ResultTaskPart // ResultFinallyPart Constant used to define the "finally" part of a pipeline result reference // retained because of backwards compatibility ResultFinallyPart = resultref.ResultFinallyPart // ResultResultPart Constant used to define the "results" part of a pipeline result reference // retained because of backwards compatibility ResultResultPart = resultref.ResultResultPart // ResultNameFormat Constant used to define the regex Result.Name should follow ResultNameFormat = `^([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]$` )
const (
// EnabledOnFailureBreakpoint is the value for TaskRunDebug.Breakpoints.OnFailure that means the breakpoint onFailure is enabled
EnabledOnFailureBreakpoint = "enabled"
)
const ManagedByLabelKey = "app.kubernetes.io/managed-by"
ManagedByLabelKey is the label key used to mark what is managing this resource
const ParamsPrefix = "params"
ParamsPrefix is the prefix used in $(...) expressions referring to parameters
const PipelineTaskOnErrorAnnotation = "pipeline.tekton.dev/pipeline-task-on-error"
PipelineTaskOnErrorAnnotation is used to pass the failure strategy to TaskRun pods from PipelineTask OnError field
const ( // TaskRunSpecStatusCancelled indicates that the user wants to cancel the task, // if not already cancelled or terminated TaskRunSpecStatusCancelled = "TaskRunCancelled" )
Variables ¶
var (
// AddToScheme adds Build types to the scheme.
AddToScheme = schemeBuilder.AddToScheme
)
var AllParamTypes = []ParamType{ParamTypeString, ParamTypeArray, ParamTypeObject}
AllParamTypes can be used for ParamType validation.
var AllResultsTypes = []ResultsType{ResultsTypeString, ResultsTypeArray, ResultsTypeObject}
AllResultsTypes can be used for ResultsTypes validation.
var SchemeGroupVersion = schema.GroupVersion{Group: pipeline.GroupName, Version: "v1"}
SchemeGroupVersion is group version used to register these objects
var VariableSubstitutionRegex = regexp.MustCompile(variableSubstitutionFormat)
VariableSubstitutionRegex is a regex to find all result matching substitutions
Functions ¶
func ArrayReference ¶
ArrayReference returns the name of the parameter from array parameter reference returns arrayParam from $(params.arrayParam[*])
func ExtractStepResultName ¶ added in v0.54.0
ExtractStepResultName extracts the step name and result name from a string matching formtat $(steps.<stepName>.results.<resultName>). If a match is not found, an error is retured.
func GetOpenAPIDefinitions ¶
func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenAPIDefinition
func LooksLikeContainsResultRefs ¶ added in v0.39.0
LooksLikeContainsResultRefs attempts to check if param or a pipeline result looks like it contains any result references. This is useful if we want to make sure the param looks like a ResultReference before performing strict validation
func ParseResultName ¶ added in v0.39.0
ParseResultName parse the input string to extract resultName and result index. Array indexing: Input: anArrayResult[1] Output: anArrayResult, "1" Array star reference: Input: anArrayResult[*] Output: anArrayResult, "*" retained for backwards compatibility
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns a Group qualified GroupResource
func ResultsArrayReference ¶
ResultsArrayReference returns the reference of the result. e.g. results.resultname from $(results.resultname[*])
func ValidateNameFormat ¶ added in v0.54.0
func ValidateNameFormat(stringAndArrayParams sets.String, objectParams []ParamSpec) (errs *apis.FieldError)
ValidateNameFormat validates that the name format of all param types follows the rules
func ValidateObjectParamsHaveProperties ¶ added in v0.54.0
func ValidateObjectParamsHaveProperties(ctx context.Context, params ParamSpecs) *apis.FieldError
ValidateObjectParamsHaveProperties returns an error if any declared object params are missing properties
func ValidateParameterTypes ¶
func ValidateParameterTypes(ctx context.Context, params []ParamSpec) (errs *apis.FieldError)
ValidateParameterTypes validates all the types within a slice of ParamSpecs
func ValidateParameterVariables ¶
func ValidateParameterVariables(ctx context.Context, steps []Step, params ParamSpecs) *apis.FieldError
ValidateParameterVariables validates all variables within a slice of ParamSpecs against a slice of Steps
func ValidateParameters ¶ added in v0.40.0
func ValidateParameters(ctx context.Context, params Params) (errs *apis.FieldError)
ValidateParameters makes sure the params for the Task are valid.
func ValidatePipelineParameterVariables ¶ added in v0.40.0
func ValidatePipelineParameterVariables(ctx context.Context, tasks []PipelineTask, params ParamSpecs) (errs *apis.FieldError)
ValidatePipelineParameterVariables validates parameters with those specified by each pipeline task, (1) it validates the type of parameter is either string or array (2) parameter default value matches with the type of that param (3) no duplication, feature flag and allowed param type when using param enum
func ValidatePipelineTasks ¶ added in v0.39.0
func ValidatePipelineTasks(ctx context.Context, tasks []PipelineTask, finalTasks []PipelineTask) *apis.FieldError
ValidatePipelineTasks ensures that pipeline tasks has unique label, pipeline tasks has specified one of taskRef or taskSpec, and in case of a pipeline task with taskRef, it has a reference to a valid task (task name)
func ValidateStepResults ¶ added in v0.54.0
func ValidateStepResults(ctx context.Context, results []StepResult) (errs *apis.FieldError)
ValidateStepResults validates that all of the declared StepResults are valid.
func ValidateStepResultsVariables ¶ added in v0.54.0
func ValidateStepResultsVariables(ctx context.Context, results []StepResult, script string) (errs *apis.FieldError)
ValidateStepResultsVariables validates if the StepResults referenced in step script are defined in step's results.
func ValidateUsageOfDeclaredParameters ¶ added in v0.48.0
func ValidateUsageOfDeclaredParameters(ctx context.Context, steps []Step, params ParamSpecs) *apis.FieldError
ValidateUsageOfDeclaredParameters validates that all parameters referenced in the Task are declared by the Task.
func ValidateVolumes ¶
func ValidateVolumes(volumes []corev1.Volume) (errs *apis.FieldError)
ValidateVolumes validates a slice of volumes to make sure there are no dupilcate names
func ValidateWorkspaceBindings ¶ added in v0.40.0
func ValidateWorkspaceBindings(ctx context.Context, wb []WorkspaceBinding) (errs *apis.FieldError)
ValidateWorkspaceBindings makes sure the volumes provided for the Task's declared workspaces make sense.
Types ¶
type Algorithm ¶ added in v0.58.0
type Algorithm string
Algorithm Standard cryptographic hash algorithm
type Artifact ¶ added in v0.58.0
type Artifact struct { Name string `json:"name,omitempty"` // The artifact's identifying category name Values []ArtifactValue `json:"values,omitempty"` // A collection of values related to the artifact }
Artifact represents an artifact within a system, potentially containing multiple values associated with it.
func (*Artifact) DeepCopy ¶ added in v0.58.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Artifact.
func (*Artifact) DeepCopyInto ¶ added in v0.58.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ArtifactValue ¶ added in v0.58.0
type ArtifactValue struct { Digest map[Algorithm]string `json:"digest,omitempty"` // Algorithm-specific digests for verifying the content (e.g., SHA256) Uri string `json:"uri,omitempty"` // Location where the artifact value can be retrieved }
ArtifactValue represents a specific value or data element within an Artifact.
func (*ArtifactValue) DeepCopy ¶ added in v0.58.0
func (in *ArtifactValue) DeepCopy() *ArtifactValue
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ArtifactValue.
func (*ArtifactValue) DeepCopyInto ¶ added in v0.58.0
func (in *ArtifactValue) DeepCopyInto(out *ArtifactValue)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Artifacts ¶ added in v0.59.0
type Artifacts struct { Inputs []Artifact `json:"inputs,omitempty"` Outputs []Artifact `json:"outputs,omitempty"` }
Artifacts represents the collection of input and output artifacts associated with a task run or a similar process. Artifacts in this context are units of data or resources that the process either consumes as input or produces as output.
func (*Artifacts) DeepCopy ¶ added in v0.59.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Artifacts.
func (*Artifacts) DeepCopyInto ¶ added in v0.59.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ChildStatusReference ¶ added in v0.40.0
type ChildStatusReference struct { runtime.TypeMeta `json:",inline"` // Name is the name of the TaskRun or Run this is referencing. Name string `json:"name,omitempty"` // DisplayName is a user-facing name of the pipelineTask that may be // used to populate a UI. DisplayName string `json:"displayName,omitempty"` // PipelineTaskName is the name of the PipelineTask this is referencing. PipelineTaskName string `json:"pipelineTaskName,omitempty"` // WhenExpressions is the list of checks guarding the execution of the PipelineTask // +optional // +listType=atomic WhenExpressions []WhenExpression `json:"whenExpressions,omitempty"` }
ChildStatusReference is used to point to the statuses of individual TaskRuns and Runs within this PipelineRun.
func (*ChildStatusReference) DeepCopy ¶ added in v0.40.0
func (in *ChildStatusReference) DeepCopy() *ChildStatusReference
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ChildStatusReference.
func (*ChildStatusReference) DeepCopyInto ¶ added in v0.40.0
func (in *ChildStatusReference) DeepCopyInto(out *ChildStatusReference)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Combination ¶ added in v0.46.0
Combination is a map, mainly defined to hold a single combination from a Matrix with key as param.Name and value as param.Value
func (Combination) DeepCopy ¶ added in v0.46.0
func (in Combination) DeepCopy() Combination
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Combination.
func (Combination) DeepCopyInto ¶ added in v0.46.0
func (in Combination) DeepCopyInto(out *Combination)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Combinations ¶ added in v0.46.0
type Combinations []Combination
Combinations is a Combination list
func (Combinations) DeepCopy ¶ added in v0.46.0
func (in Combinations) DeepCopy() Combinations
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Combinations.
func (Combinations) DeepCopyInto ¶ added in v0.46.0
func (in Combinations) DeepCopyInto(out *Combinations)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type EmbeddedTask ¶ added in v0.39.0
type EmbeddedTask struct { // +optional runtime.TypeMeta `json:",inline,omitempty"` // Spec is a specification of a custom task // +optional Spec runtime.RawExtension `json:"spec,omitempty"` // +optional Metadata PipelineTaskMetadata `json:"metadata,omitempty"` // TaskSpec is a specification of a task // +optional TaskSpec `json:",inline,omitempty"` }
EmbeddedTask is used to define a Task inline within a Pipeline's PipelineTasks.
func (*EmbeddedTask) DeepCopy ¶ added in v0.39.0
func (in *EmbeddedTask) DeepCopy() *EmbeddedTask
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EmbeddedTask.
func (*EmbeddedTask) DeepCopyInto ¶ added in v0.39.0
func (in *EmbeddedTask) DeepCopyInto(out *EmbeddedTask)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*EmbeddedTask) IsCustomTask ¶ added in v0.47.0
func (et *EmbeddedTask) IsCustomTask() bool
IsCustomTask checks whether an embedded TaskSpec is a Custom Task
type IncludeParams ¶ added in v0.47.0
type IncludeParams struct { // Name the specified combination Name string `json:"name,omitempty"` // Params takes only `Parameters` of type `"string"` // The names of the `params` must match the names of the `params` in the underlying `Task` // +listType=atomic Params Params `json:"params,omitempty"` }
IncludeParams allows passing in a specific combinations of Parameters into the Matrix.
func (*IncludeParams) DeepCopy ¶ added in v0.47.0
func (in *IncludeParams) DeepCopy() *IncludeParams
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IncludeParams.
func (*IncludeParams) DeepCopyInto ¶ added in v0.47.0
func (in *IncludeParams) DeepCopyInto(out *IncludeParams)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type IncludeParamsList ¶ added in v0.47.0
type IncludeParamsList []IncludeParams
IncludeParamsList is a list of IncludeParams which allows passing in specific combinations of Parameters into the Matrix.
func (IncludeParamsList) DeepCopy ¶ added in v0.47.0
func (in IncludeParamsList) DeepCopy() IncludeParamsList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IncludeParamsList.
func (IncludeParamsList) DeepCopyInto ¶ added in v0.47.0
func (in IncludeParamsList) DeepCopyInto(out *IncludeParamsList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Matrix ¶ added in v0.40.0
type Matrix struct { // 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. // +listType=atomic Params Params `json:"params,omitempty"` // Include is a list of IncludeParams which allows passing in specific combinations of Parameters into the Matrix. // +optional // +listType=atomic Include IncludeParamsList `json:"include,omitempty"` }
Matrix is used to fan out Tasks in a Pipeline
func (*Matrix) CountCombinations ¶ added in v0.46.0
CountCombinations returns the count of Combinations of Parameters generated from the Matrix in PipelineTask.
func (*Matrix) DeepCopy ¶ added in v0.40.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Matrix.
func (*Matrix) DeepCopyInto ¶ added in v0.40.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Matrix) FanOut ¶ added in v0.46.0
FanOut returns an list of params that represent combinations
func (*Matrix) GetAllParams ¶ added in v0.47.0
GetAllParams returns a list of all Matrix Parameters
func (*Matrix) HasInclude ¶ added in v0.47.0
HasInclude returns true if the Matrix has Include Parameters
type OnErrorType ¶ added in v0.39.0
type OnErrorType string
OnErrorType defines a list of supported exiting behavior of a container on error
const ( // StopAndFail indicates exit the taskRun if the container exits with non-zero exit code StopAndFail OnErrorType = "stopAndFail" // Continue indicates continue executing the rest of the steps irrespective of the container exit code Continue OnErrorType = "continue" )
type Param ¶
type Param struct { Name string `json:"name"` Value ParamValue `json:"value"` }
Param declares an ParamValues to use for the parameter called name.
func (*Param) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Param.
func (*Param) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (Param) GetVarSubstitutionExpressions ¶ added in v0.52.0
GetVarSubstitutionExpressions extracts all the value between "$(" and ")"" for a Parameter
func (Param) ParseTaskandResultName ¶ added in v0.53.0
ParseTaskandResultName parses "task name", "result name" from a Matrix Context Variable Valid Example 1: - Input: tasks.myTask.matrix.length - Output: "myTask", "" Valid Example 2: - Input: tasks.myTask.matrix.ResultName.length - Output: "myTask", "ResultName"
type ParamSpec ¶
type ParamSpec struct { // Name declares the name by which a parameter is referenced. Name string `json:"name"` // Type is the user-specified type of the parameter. The possible types // are currently "string", "array" and "object", and "string" is the default. // +optional Type ParamType `json:"type,omitempty"` // Description is a user-facing description of the parameter that may be // used to populate a UI. // +optional Description string `json:"description,omitempty"` // Properties is the JSON Schema properties to support key-value pairs parameter. // +optional Properties map[string]PropertySpec `json:"properties,omitempty"` // 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. // +optional Default *ParamValue `json:"default,omitempty"` // 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. // +optional Enum []string `json:"enum,omitempty"` }
ParamSpec defines arbitrary parameters needed beyond typed inputs (such as resources). Parameter values are provided by users as inputs on a TaskRun or PipelineRun.
func (*ParamSpec) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ParamSpec.
func (*ParamSpec) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ParamSpec) SetDefaults ¶
SetDefaults set the default type
func (ParamSpec) ValidateObjectType ¶
func (p ParamSpec) ValidateObjectType(ctx context.Context) *apis.FieldError
ValidateObjectType checks that object type parameter does not miss the definition of `properties` section and the type of a PropertySpec is allowed. (Currently, only string is allowed)
func (ParamSpec) ValidateType ¶
func (p ParamSpec) ValidateType(ctx context.Context) *apis.FieldError
ValidateType checks that the type of a ParamSpec is allowed and its default value matches that type
type ParamSpecs ¶ added in v0.46.0
type ParamSpecs []ParamSpec
ParamSpecs is a list of ParamSpec
func (ParamSpecs) DeepCopy ¶ added in v0.46.0
func (in ParamSpecs) DeepCopy() ParamSpecs
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ParamSpecs.
func (ParamSpecs) DeepCopyInto ¶ added in v0.46.0
func (in ParamSpecs) DeepCopyInto(out *ParamSpecs)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ParamSpecs) ExtractDefaultParamArrayLengths ¶ added in v0.49.0
func (ps ParamSpecs) ExtractDefaultParamArrayLengths() map[string]int
ExtractDefaultParamArrayLengths extract and return the lengths of all array params Example of returned value: {"a-array-params": 2,"b-array-params": 2 }
func (ParamSpecs) GetNames ¶ added in v0.54.0
func (ps ParamSpecs) GetNames() []string
GetNames returns all the names of the declared parameters
func (ParamSpecs) SortByType ¶ added in v0.54.0
func (ps ParamSpecs) SortByType() (ParamSpecs, ParamSpecs, ParamSpecs)
SortByType splits the input params into string params, array params, and object params, in that order
func (ParamSpecs) ValidateNoDuplicateNames ¶ added in v0.54.0
func (ps ParamSpecs) ValidateNoDuplicateNames() *apis.FieldError
ValidateNoDuplicateNames returns an error if any of the params have the same name
type ParamType ¶
type ParamType string
ParamType indicates the type of an input parameter; Used to distinguish between a single string and an array of strings.
type ParamValue ¶ added in v0.39.0
type ParamValue struct { Type ParamType // Represents the stored type of ParamValues. StringVal string // +listType=atomic ArrayVal []string ObjectVal map[string]string }
ParamValue is a type that can hold a single string, string array, or string map. Used in JSON unmarshalling so that a single JSON field can accept either an individual string or an array of strings.
func NewObject ¶
func NewObject(pairs map[string]string) *ParamValue
NewObject creates an ParamValues of type ParamTypeObject using the provided key-value pairs
func NewStructuredValues ¶ added in v0.39.0
func NewStructuredValues(value string, values ...string) *ParamValue
NewStructuredValues creates an ParamValues of type ParamTypeString or ParamTypeArray, based on how many inputs are given (>1 input will create an array, not string).
func (*ParamValue) ApplyReplacements ¶ added in v0.39.0
func (paramValues *ParamValue) ApplyReplacements(stringReplacements map[string]string, arrayReplacements map[string][]string, objectReplacements map[string]map[string]string)
ApplyReplacements applyes replacements for ParamValues type
func (*ParamValue) DeepCopy ¶ added in v0.39.0
func (in *ParamValue) DeepCopy() *ParamValue
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ParamValue.
func (*ParamValue) DeepCopyInto ¶ added in v0.39.0
func (in *ParamValue) DeepCopyInto(out *ParamValue)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ParamValue) MarshalJSON ¶ added in v0.39.0
func (paramValues ParamValue) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface.
func (*ParamValue) UnmarshalJSON ¶ added in v0.39.0
func (paramValues *ParamValue) UnmarshalJSON(value []byte) error
UnmarshalJSON implements the json.Unmarshaller interface.
type Params ¶ added in v0.46.0
type Params []Param
Params is a list of Param
func (Params) DeepCopy ¶ added in v0.46.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Params.
func (Params) DeepCopyInto ¶ added in v0.46.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (Params) ExtractNames ¶ added in v0.47.0
ExtractNames returns a set of unique names
func (Params) ExtractParamArrayLengths ¶ added in v0.49.0
ExtractParamArrayLengths extract and return the lengths of all array params Example of returned value: {"a-array-params": 2,"b-array-params": 2 }
func (Params) ReplaceVariables ¶ added in v0.48.0
func (ps Params) ReplaceVariables(stringReplacements map[string]string, arrayReplacements map[string][]string, objectReplacements map[string]map[string]string) Params
ReplaceVariables applies string, array and object replacements to variables in Params
type Pipeline ¶ added in v0.39.0
type Pipeline struct { metav1.TypeMeta `json:",inline"` // +optional metav1.ObjectMeta `json:"metadata,omitempty"` // Spec holds the desired state of the Pipeline from the client // +optional Spec PipelineSpec `json:"spec"` }
Pipeline describes a list of Tasks to execute. It expresses how outputs of tasks feed into inputs of subsequent tasks. +k8s:openapi-gen=true
func (*Pipeline) Checksum ¶ added in v0.51.0
Checksum computes the sha256 checksum of the pipeline object. Prior to computing the checksum, it performs some preprocessing on the metadata of the object where it removes system provided annotations. Only the name, namespace, generateName, user-provided labels and annotations and the pipelineSpec are included for the checksum computation.
func (*Pipeline) ConvertFrom ¶ added in v0.39.0
ConvertFrom implements apis.Convertible
func (*Pipeline) DeepCopy ¶ added in v0.39.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Pipeline.
func (*Pipeline) DeepCopyInto ¶ added in v0.39.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Pipeline) DeepCopyObject ¶ added in v0.39.0
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Pipeline) GetGroupVersionKind ¶ added in v0.39.0
func (*Pipeline) GetGroupVersionKind() schema.GroupVersionKind
GetGroupVersionKind implements kmeta.OwnerRefable.
func (*Pipeline) PipelineMetadata ¶ added in v0.39.0
func (p *Pipeline) PipelineMetadata() metav1.ObjectMeta
PipelineMetadata returns the Pipeline's ObjectMeta, implementing PipelineObject
func (*Pipeline) PipelineSpec ¶ added in v0.39.0
func (p *Pipeline) PipelineSpec() PipelineSpec
PipelineSpec returns the Pipeline's Spec, implementing PipelineObject
func (*Pipeline) SetDefaults ¶ added in v0.39.0
SetDefaults sets default values on the Pipeline's Spec
func (*Pipeline) SupportedVerbs ¶ added in v0.41.0
func (p *Pipeline) SupportedVerbs() []admissionregistrationv1.OperationType
SupportedVerbs returns the operations that validation should be called for
type PipelineList ¶ added in v0.39.0
type PipelineList struct { metav1.TypeMeta `json:",inline"` // +optional metav1.ListMeta `json:"metadata,omitempty"` Items []Pipeline `json:"items"` }
PipelineList contains a list of Pipeline
func (*PipelineList) DeepCopy ¶ added in v0.39.0
func (in *PipelineList) DeepCopy() *PipelineList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PipelineList.
func (*PipelineList) DeepCopyInto ¶ added in v0.39.0
func (in *PipelineList) DeepCopyInto(out *PipelineList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PipelineList) DeepCopyObject ¶ added in v0.39.0
func (in *PipelineList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type PipelineRef ¶ added in v0.40.0
type PipelineRef struct { // Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names Name string `json:"name,omitempty"` // API version of the referent // +optional APIVersion string `json:"apiVersion,omitempty"` // 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. // +optional ResolverRef `json:",omitempty"` }
PipelineRef can be used to refer to a specific instance of a Pipeline.
func (*PipelineRef) DeepCopy ¶ added in v0.40.0
func (in *PipelineRef) DeepCopy() *PipelineRef
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PipelineRef.
func (*PipelineRef) DeepCopyInto ¶ added in v0.40.0
func (in *PipelineRef) DeepCopyInto(out *PipelineRef)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PipelineRef) Validate ¶ added in v0.40.0
func (ref *PipelineRef) Validate(ctx context.Context) (errs *apis.FieldError)
Validate ensures that a supplied PipelineRef field is populated correctly. No errors are returned for a nil PipelineRef.
type PipelineResult ¶ added in v0.39.0
type PipelineResult struct { // Name the given name Name string `json:"name"` // 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. Type ResultsType `json:"type,omitempty"` // Description is a human-readable description of the result // +optional Description string `json:"description"` // Value the expression used to retrieve the value Value ResultValue `json:"value"` }
PipelineResult used to describe the results of a pipeline
func (*PipelineResult) DeepCopy ¶ added in v0.39.0
func (in *PipelineResult) DeepCopy() *PipelineResult
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PipelineResult.
func (*PipelineResult) DeepCopyInto ¶ added in v0.39.0
func (in *PipelineResult) DeepCopyInto(out *PipelineResult)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (PipelineResult) GetVarSubstitutionExpressions ¶ added in v0.52.0
func (result PipelineResult) GetVarSubstitutionExpressions() ([]string, bool)
GetVarSubstitutionExpressions extracts all the value between "$(" and ")"" for a PipelineResult
type PipelineRun ¶ added in v0.40.0
type PipelineRun struct { metav1.TypeMeta `json:",inline"` // +optional metav1.ObjectMeta `json:"metadata,omitempty"` // +optional Spec PipelineRunSpec `json:"spec,omitempty"` // +optional Status PipelineRunStatus `json:"status,omitempty"` }
PipelineRun represents a single execution of a Pipeline. PipelineRuns are how the graph of Tasks declared in a Pipeline are executed; they specify inputs to Pipelines such as parameter values and capture operational aspects of the Tasks execution such as service account and tolerations. Creating a PipelineRun creates TaskRuns for Tasks in the referenced Pipeline.
+k8s:openapi-gen=true
func (*PipelineRun) ConvertFrom ¶ added in v0.40.0
func (pr *PipelineRun) ConvertFrom(ctx context.Context, source apis.Convertible) error
ConvertFrom implements apis.Convertible
func (*PipelineRun) ConvertTo ¶ added in v0.40.0
func (pr *PipelineRun) ConvertTo(ctx context.Context, sink apis.Convertible) error
ConvertTo implements apis.Convertible
func (*PipelineRun) DeepCopy ¶ added in v0.40.0
func (in *PipelineRun) DeepCopy() *PipelineRun
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PipelineRun.
func (*PipelineRun) DeepCopyInto ¶ added in v0.40.0
func (in *PipelineRun) DeepCopyInto(out *PipelineRun)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PipelineRun) DeepCopyObject ¶ added in v0.40.0
func (in *PipelineRun) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*PipelineRun) FinallyTimeout ¶ added in v0.40.0
func (pr *PipelineRun) FinallyTimeout() *metav1.Duration
FinallyTimeout returns the finally timeout for the PipelineRun, if set, or the finally timeout computed from the Pipeline and Tasks timeouts, if those are set.
func (*PipelineRun) GetGroupVersionKind ¶ added in v0.40.0
func (*PipelineRun) GetGroupVersionKind() schema.GroupVersionKind
GetGroupVersionKind implements kmeta.OwnerRefable.
func (*PipelineRun) GetName ¶ added in v0.40.0
func (pr *PipelineRun) GetName() string
GetName Returns the name of the PipelineRun
func (*PipelineRun) GetNamespacedName ¶ added in v0.40.0
func (pr *PipelineRun) GetNamespacedName() types.NamespacedName
GetNamespacedName returns a k8s namespaced name that identifies this PipelineRun
func (*PipelineRun) GetStatusCondition ¶ added in v0.40.0
func (pr *PipelineRun) GetStatusCondition() apis.ConditionAccessor
GetStatusCondition returns the task run status as a ConditionAccessor
func (*PipelineRun) GetTaskRunSpec ¶ added in v0.40.0
func (pr *PipelineRun) GetTaskRunSpec(pipelineTaskName string) PipelineTaskRunSpec
GetTaskRunSpec returns the task specific spec for a given PipelineTask if configured, otherwise it returns the PipelineRun's default.
func (*PipelineRun) HasFinallyTimedOut ¶ added in v0.40.0
func (pr *PipelineRun) HasFinallyTimedOut(ctx context.Context, c clock.PassiveClock) bool
HasFinallyTimedOut returns true if a pipelinerun has exceeded its spec.Timeouts.Finally, based on status.FinallyStartTime
func (*PipelineRun) HasStarted ¶ added in v0.40.0
func (pr *PipelineRun) HasStarted() bool
HasStarted function check whether pipelinerun has valid start time set in its status
func (*PipelineRun) HasTimedOut ¶ added in v0.40.0
func (pr *PipelineRun) HasTimedOut(ctx context.Context, c clock.PassiveClock) bool
HasTimedOut returns true if a pipelinerun has exceeded its spec.Timeout based on its status.Timeout
func (*PipelineRun) HasTimedOutForALongTime ¶ added in v0.49.0
func (pr *PipelineRun) HasTimedOutForALongTime(ctx context.Context, c clock.PassiveClock) bool
HasTimedOutForALongTime returns true if a pipelinerun has exceeed its spec.Timeout based its status.StartTime by a large margin
func (*PipelineRun) HasVolumeClaimTemplate ¶ added in v0.40.0
func (pr *PipelineRun) HasVolumeClaimTemplate() bool
HasVolumeClaimTemplate returns true if PipelineRun contains volumeClaimTemplates that is used for creating PersistentVolumeClaims with an OwnerReference for each run
func (*PipelineRun) HaveTasksTimedOut ¶ added in v0.40.0
func (pr *PipelineRun) HaveTasksTimedOut(ctx context.Context, c clock.PassiveClock) bool
HaveTasksTimedOut returns true if a pipelinerun has exceeded its spec.Timeouts.Tasks
func (*PipelineRun) IsCancelled ¶ added in v0.40.0
func (pr *PipelineRun) IsCancelled() bool
IsCancelled returns true if the PipelineRun's spec status is set to Cancelled state
func (*PipelineRun) IsDone ¶ added in v0.40.0
func (pr *PipelineRun) IsDone() bool
IsDone returns true if the PipelineRun's status indicates that it is done.
func (*PipelineRun) IsGracefullyCancelled ¶ added in v0.40.0
func (pr *PipelineRun) IsGracefullyCancelled() bool
IsGracefullyCancelled returns true if the PipelineRun's spec status is set to CancelledRunFinally state
func (*PipelineRun) IsGracefullyStopped ¶ added in v0.40.0
func (pr *PipelineRun) IsGracefullyStopped() bool
IsGracefullyStopped returns true if the PipelineRun's spec status is set to StoppedRunFinally state
func (*PipelineRun) IsPending ¶ added in v0.40.0
func (pr *PipelineRun) IsPending() bool
IsPending returns true if the PipelineRun's spec status is set to Pending state
func (*PipelineRun) IsTimeoutConditionSet ¶ added in v0.49.0
func (pr *PipelineRun) IsTimeoutConditionSet() bool
IsTimeoutConditionSet returns true when the pipelinerun has the pipelinerun timed out reason
func (*PipelineRun) PipelineTimeout ¶ added in v0.40.0
func (pr *PipelineRun) PipelineTimeout(ctx context.Context) time.Duration
PipelineTimeout returns the applicable timeout for the PipelineRun
func (*PipelineRun) SetDefaults ¶ added in v0.40.0
func (pr *PipelineRun) SetDefaults(ctx context.Context)
SetDefaults implements apis.Defaultable
func (*PipelineRun) SetTimeoutCondition ¶ added in v0.49.0
func (pr *PipelineRun) SetTimeoutCondition(ctx context.Context)
SetTimeoutCondition sets the status of the PipelineRun to timed out.
func (*PipelineRun) SupportedVerbs ¶ added in v0.41.0
func (pr *PipelineRun) SupportedVerbs() []admissionregistrationv1.OperationType
SupportedVerbs returns the operations that validation should be called for
func (*PipelineRun) TasksTimeout ¶ added in v0.40.0
func (pr *PipelineRun) TasksTimeout() *metav1.Duration
TasksTimeout returns the tasks timeout for the PipelineRun, if set, or the tasks timeout computed from the Pipeline and Finally timeouts, if those are set.
func (*PipelineRun) Validate ¶ added in v0.40.0
func (pr *PipelineRun) Validate(ctx context.Context) *apis.FieldError
Validate pipelinerun
type PipelineRunList ¶ added in v0.40.0
type PipelineRunList struct { metav1.TypeMeta `json:",inline"` // +optional metav1.ListMeta `json:"metadata,omitempty"` Items []PipelineRun `json:"items,omitempty"` }
PipelineRunList contains a list of PipelineRun
func (*PipelineRunList) DeepCopy ¶ added in v0.40.0
func (in *PipelineRunList) DeepCopy() *PipelineRunList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PipelineRunList.
func (*PipelineRunList) DeepCopyInto ¶ added in v0.40.0
func (in *PipelineRunList) DeepCopyInto(out *PipelineRunList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PipelineRunList) DeepCopyObject ¶ added in v0.40.0
func (in *PipelineRunList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type PipelineRunReason ¶ added in v0.40.0
type PipelineRunReason string
PipelineRunReason represents a reason for the pipeline run "Succeeded" condition
const ( // PipelineRunReasonStarted is the reason set when the PipelineRun has just started PipelineRunReasonStarted PipelineRunReason = "Started" // PipelineRunReasonRunning is the reason set when the PipelineRun is running PipelineRunReasonRunning PipelineRunReason = "Running" // PipelineRunReasonSuccessful is the reason set when the PipelineRun completed successfully PipelineRunReasonSuccessful PipelineRunReason = "Succeeded" // PipelineRunReasonCompleted is the reason set when the PipelineRun completed successfully with one or more skipped Tasks PipelineRunReasonCompleted PipelineRunReason = "Completed" // PipelineRunReasonFailed is the reason set when the PipelineRun completed with a failure PipelineRunReasonFailed PipelineRunReason = "Failed" // PipelineRunReasonCancelled is the reason set when the PipelineRun cancelled by the user // This reason may be found with a corev1.ConditionFalse status, if the cancellation was processed successfully // This reason may be found with a corev1.ConditionUnknown status, if the cancellation is being processed or failed PipelineRunReasonCancelled PipelineRunReason = "Cancelled" // PipelineRunReasonPending is the reason set when the PipelineRun is in the pending state PipelineRunReasonPending PipelineRunReason = "PipelineRunPending" // PipelineRunReasonTimedOut is the reason set when the PipelineRun has timed out PipelineRunReasonTimedOut PipelineRunReason = "PipelineRunTimeout" // PipelineRunReasonStopping indicates that no new Tasks will be scheduled by the controller, and the // pipeline will stop once all running tasks complete their work PipelineRunReasonStopping PipelineRunReason = "PipelineRunStopping" // PipelineRunReasonCancelledRunningFinally indicates that pipeline has been gracefully cancelled // and no new Tasks will be scheduled by the controller, but final tasks are now running PipelineRunReasonCancelledRunningFinally PipelineRunReason = "CancelledRunningFinally" // PipelineRunReasonStoppedRunningFinally indicates that pipeline has been gracefully stopped // and no new Tasks will be scheduled by the controller, but final tasks are now running PipelineRunReasonStoppedRunningFinally PipelineRunReason = "StoppedRunningFinally" // ReasonCouldntGetPipeline indicates that the reason for the failure status is that the // associated Pipeline couldn't be retrieved PipelineRunReasonCouldntGetPipeline PipelineRunReason = "CouldntGetPipeline" // ReasonInvalidBindings indicates that the reason for the failure status is that the // PipelineResources bound in the PipelineRun didn't match those declared in the Pipeline PipelineRunReasonInvalidBindings PipelineRunReason = "InvalidPipelineResourceBindings" // ReasonInvalidWorkspaceBinding indicates that a Pipeline expects a workspace but a // PipelineRun has provided an invalid binding. PipelineRunReasonInvalidWorkspaceBinding PipelineRunReason = "InvalidWorkspaceBindings" // ReasonInvalidTaskRunSpec indicates that PipelineRun.Spec.TaskRunSpecs[].PipelineTaskName is defined with // a not exist taskName in pipelineSpec. PipelineRunReasonInvalidTaskRunSpec PipelineRunReason = "InvalidTaskRunSpecs" // ReasonParameterTypeMismatch indicates that the reason for the failure status is that // parameter(s) declared in the PipelineRun do not have the some declared type as the // parameters(s) declared in the Pipeline that they are supposed to override. PipelineRunReasonParameterTypeMismatch PipelineRunReason = "ParameterTypeMismatch" // ReasonObjectParameterMissKeys indicates that the object param value provided from PipelineRun spec // misses some keys required for the object param declared in Pipeline spec. PipelineRunReasonObjectParameterMissKeys PipelineRunReason = "ObjectParameterMissKeys" // ReasonParamArrayIndexingInvalid indicates that the use of param array indexing is out of bound. PipelineRunReasonParamArrayIndexingInvalid PipelineRunReason = "ParamArrayIndexingInvalid" // ReasonCouldntGetTask indicates that the reason for the failure status is that the // associated Pipeline's Tasks couldn't all be retrieved PipelineRunReasonCouldntGetTask PipelineRunReason = "CouldntGetTask" // ReasonParameterMissing indicates that the reason for the failure status is that the // associated PipelineRun didn't provide all the required parameters PipelineRunReasonParameterMissing PipelineRunReason = "ParameterMissing" // ReasonFailedValidation indicates that the reason for failure status is // that pipelinerun failed runtime validation PipelineRunReasonFailedValidation PipelineRunReason = "PipelineValidationFailed" // PipelineRunReasonCouldntGetPipelineResult indicates that the pipeline fails to retrieve the // referenced result. This could be due to failed TaskRuns or Runs that were supposed to produce // the results PipelineRunReasonCouldntGetPipelineResult PipelineRunReason = "CouldntGetPipelineResult" // ReasonInvalidGraph indicates that the reason for the failure status is that the // associated Pipeline is an invalid graph (a.k.a wrong order, cycle, …) PipelineRunReasonInvalidGraph PipelineRunReason = "PipelineInvalidGraph" // ReasonCouldntCancel indicates that a PipelineRun was cancelled but attempting to update // all of the running TaskRuns as cancelled failed. PipelineRunReasonCouldntCancel PipelineRunReason = "PipelineRunCouldntCancel" // ReasonCouldntTimeOut indicates that a PipelineRun was timed out but attempting to update // all of the running TaskRuns as timed out failed. PipelineRunReasonCouldntTimeOut PipelineRunReason = "PipelineRunCouldntTimeOut" // ReasonInvalidMatrixParameterTypes indicates a matrix contains invalid parameter types PipelineRunReasonInvalidMatrixParameterTypes PipelineRunReason = "InvalidMatrixParameterTypes" // ReasonInvalidTaskResultReference indicates a task result was declared // but was not initialized by that task PipelineRunReasonInvalidTaskResultReference PipelineRunReason = "InvalidTaskResultReference" // PipelineRunReasonInvalidPipelineResultReference indicates a pipeline result was declared // by the pipeline but not initialized in the pipelineTask PipelineRunReasonInvalidPipelineResultReference PipelineRunReason = "InvalidPipelineResultReference" // ReasonRequiredWorkspaceMarkedOptional indicates an optional workspace // has been passed to a Task that is expecting a non-optional workspace PipelineRunReasonRequiredWorkspaceMarkedOptional PipelineRunReason = "RequiredWorkspaceMarkedOptional" // ReasonResolvingPipelineRef indicates that the PipelineRun is waiting for // its pipelineRef to be asynchronously resolved. PipelineRunReasonResolvingPipelineRef PipelineRunReason = "ResolvingPipelineRef" // ReasonResourceVerificationFailed indicates that the pipeline fails the trusted resource verification, // it could be the content has changed, signature is invalid or public key is invalid PipelineRunReasonResourceVerificationFailed PipelineRunReason = "ResourceVerificationFailed" // ReasonCreateRunFailed indicates that the pipeline fails to create the taskrun or other run resources PipelineRunReasonCreateRunFailed PipelineRunReason = "CreateRunFailed" // ReasonCELEvaluationFailed indicates the pipeline fails the CEL evaluation PipelineRunReasonCELEvaluationFailed PipelineRunReason = "CELEvaluationFailed" // PipelineRunReasonInvalidParamValue indicates that the PipelineRun Param input value is not allowed. PipelineRunReasonInvalidParamValue PipelineRunReason = "InvalidParamValue" )
func (PipelineRunReason) String ¶ added in v0.40.0
func (t PipelineRunReason) String() string
type PipelineRunResult ¶ added in v0.40.0
type PipelineRunResult struct { // Name is the result's name as declared by the Pipeline Name string `json:"name"` // Value is the result returned from the execution of this PipelineRun Value ResultValue `json:"value"` }
PipelineRunResult used to describe the results of a pipeline
func (*PipelineRunResult) DeepCopy ¶ added in v0.40.0
func (in *PipelineRunResult) DeepCopy() *PipelineRunResult
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PipelineRunResult.
func (*PipelineRunResult) DeepCopyInto ¶ added in v0.40.0
func (in *PipelineRunResult) DeepCopyInto(out *PipelineRunResult)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PipelineRunRunStatus ¶ added in v0.40.0
type PipelineRunRunStatus struct { // PipelineTaskName is the name of the PipelineTask. PipelineTaskName string `json:"pipelineTaskName,omitempty"` // Status is the RunStatus for the corresponding Run // +optional Status *runv1beta1.CustomRunStatus `json:"status,omitempty"` // WhenExpressions is the list of checks guarding the execution of the PipelineTask // +optional // +listType=atomic WhenExpressions []WhenExpression `json:"whenExpressions,omitempty"` }
PipelineRunRunStatus contains the name of the PipelineTask for this Run and the Run's Status
func (*PipelineRunRunStatus) DeepCopy ¶ added in v0.40.0
func (in *PipelineRunRunStatus) DeepCopy() *PipelineRunRunStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PipelineRunRunStatus.
func (*PipelineRunRunStatus) DeepCopyInto ¶ added in v0.40.0
func (in *PipelineRunRunStatus) DeepCopyInto(out *PipelineRunRunStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PipelineRunSpec ¶ added in v0.40.0
type PipelineRunSpec struct { // +optional PipelineRef *PipelineRef `json:"pipelineRef,omitempty"` // Specifying PipelineSpec can be disabled by setting // `disable-inline-spec` feature flag.. // +optional PipelineSpec *PipelineSpec `json:"pipelineSpec,omitempty"` // Params is a list of parameter names and values. // +listType=atomic Params Params `json:"params,omitempty"` // Used for cancelling a pipelinerun (and maybe more later on) // +optional Status PipelineRunSpecStatus `json:"status,omitempty"` // Time after which the Pipeline times out. // Currently three keys are accepted in the map // pipeline, tasks and finally // with Timeouts.pipeline >= Timeouts.tasks + Timeouts.finally // +optional Timeouts *TimeoutFields `json:"timeouts,omitempty"` // TaskRunTemplate represent template of taskrun // +optional TaskRunTemplate PipelineTaskRunTemplate `json:"taskRunTemplate,omitempty"` // Workspaces holds a set of workspace bindings that must match names // with those declared in the pipeline. // +optional // +listType=atomic Workspaces []WorkspaceBinding `json:"workspaces,omitempty"` // TaskRunSpecs holds a set of runtime specs // +optional // +listType=atomic TaskRunSpecs []PipelineTaskRunSpec `json:"taskRunSpecs,omitempty"` }
PipelineRunSpec defines the desired state of PipelineRun
func (*PipelineRunSpec) DeepCopy ¶ added in v0.40.0
func (in *PipelineRunSpec) DeepCopy() *PipelineRunSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PipelineRunSpec.
func (*PipelineRunSpec) DeepCopyInto ¶ added in v0.40.0
func (in *PipelineRunSpec) DeepCopyInto(out *PipelineRunSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PipelineRunSpec) SetDefaults ¶ added in v0.40.0
func (prs *PipelineRunSpec) SetDefaults(ctx context.Context)
SetDefaults implements apis.Defaultable
func (*PipelineRunSpec) Validate ¶ added in v0.40.0
func (ps *PipelineRunSpec) Validate(ctx context.Context) (errs *apis.FieldError)
Validate pipelinerun spec
type PipelineRunSpecStatus ¶ added in v0.40.0
type PipelineRunSpecStatus string
PipelineRunSpecStatus defines the pipelinerun spec status the user can provide
type PipelineRunStatus ¶ added in v0.40.0
type PipelineRunStatus struct { duckv1.Status `json:",inline"` // PipelineRunStatusFields inlines the status fields. PipelineRunStatusFields `json:",inline"` }
PipelineRunStatus defines the observed state of PipelineRun
func (*PipelineRunStatus) DeepCopy ¶ added in v0.40.0
func (in *PipelineRunStatus) DeepCopy() *PipelineRunStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PipelineRunStatus.
func (*PipelineRunStatus) DeepCopyInto ¶ added in v0.40.0
func (in *PipelineRunStatus) DeepCopyInto(out *PipelineRunStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PipelineRunStatus) GetCondition ¶ added in v0.40.0
func (pr *PipelineRunStatus) GetCondition(t apis.ConditionType) *apis.Condition
GetCondition returns the Condition matching the given type.
func (*PipelineRunStatus) InitializeConditions ¶ added in v0.40.0
func (pr *PipelineRunStatus) InitializeConditions(c clock.PassiveClock)
InitializeConditions will set all conditions in pipelineRunCondSet to unknown for the PipelineRun and set the started time to the current time
func (*PipelineRunStatus) MarkFailed ¶ added in v0.40.0
func (pr *PipelineRunStatus) MarkFailed(reason, messageFormat string, messageA ...interface{})
MarkFailed changes the Succeeded condition to False with the provided reason and message.
func (*PipelineRunStatus) MarkRunning ¶ added in v0.40.0
func (pr *PipelineRunStatus) MarkRunning(reason, messageFormat string, messageA ...interface{})
MarkRunning changes the Succeeded condition to Unknown with the provided reason and message.
func (*PipelineRunStatus) MarkSucceeded ¶ added in v0.40.0
func (pr *PipelineRunStatus) MarkSucceeded(reason, messageFormat string, messageA ...interface{})
MarkSucceeded changes the Succeeded condition to True with the provided reason and message.
func (*PipelineRunStatus) SetCondition ¶ added in v0.40.0
func (pr *PipelineRunStatus) SetCondition(newCond *apis.Condition)
SetCondition sets the condition, unsetting previous conditions with the same type as necessary.
type PipelineRunStatusFields ¶ added in v0.40.0
type PipelineRunStatusFields struct { // StartTime is the time the PipelineRun is actually started. StartTime *metav1.Time `json:"startTime,omitempty"` // CompletionTime is the time the PipelineRun completed. CompletionTime *metav1.Time `json:"completionTime,omitempty"` // Results are the list of results written out by the pipeline task's containers // +optional // +listType=atomic Results []PipelineRunResult `json:"results,omitempty"` // PipelineRunSpec contains the exact spec used to instantiate the run PipelineSpec *PipelineSpec `json:"pipelineSpec,omitempty"` // list of tasks that were skipped due to when expressions evaluating to false // +optional // +listType=atomic SkippedTasks []SkippedTask `json:"skippedTasks,omitempty"` // list of TaskRun and Run names, PipelineTask names, and API versions/kinds for children of this PipelineRun. // +optional // +listType=atomic ChildReferences []ChildStatusReference `json:"childReferences,omitempty"` // FinallyStartTime is when all non-finally tasks have been completed and only finally tasks are being executed. // +optional FinallyStartTime *metav1.Time `json:"finallyStartTime,omitempty"` // Provenance contains some key authenticated metadata about how a software artifact was built (what sources, what inputs/outputs, etc.). // +optional Provenance *Provenance `json:"provenance,omitempty"` // SpanContext contains tracing span context fields SpanContext map[string]string `json:"spanContext,omitempty"` }
PipelineRunStatusFields holds the fields of PipelineRunStatus' status. This is defined separately and inlined so that other types can readily consume these fields via duck typing.
func (*PipelineRunStatusFields) DeepCopy ¶ added in v0.40.0
func (in *PipelineRunStatusFields) DeepCopy() *PipelineRunStatusFields
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PipelineRunStatusFields.
func (*PipelineRunStatusFields) DeepCopyInto ¶ added in v0.40.0
func (in *PipelineRunStatusFields) DeepCopyInto(out *PipelineRunStatusFields)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PipelineRunTaskRunStatus ¶ added in v0.40.0
type PipelineRunTaskRunStatus struct { // PipelineTaskName is the name of the PipelineTask. PipelineTaskName string `json:"pipelineTaskName,omitempty"` // Status is the TaskRunStatus for the corresponding TaskRun // +optional Status *TaskRunStatus `json:"status,omitempty"` // WhenExpressions is the list of checks guarding the execution of the PipelineTask // +optional // +listType=atomic WhenExpressions []WhenExpression `json:"whenExpressions,omitempty"` }
PipelineRunTaskRunStatus contains the name of the PipelineTask for this TaskRun and the TaskRun's Status
func (*PipelineRunTaskRunStatus) DeepCopy ¶ added in v0.40.0
func (in *PipelineRunTaskRunStatus) DeepCopy() *PipelineRunTaskRunStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PipelineRunTaskRunStatus.
func (*PipelineRunTaskRunStatus) DeepCopyInto ¶ added in v0.40.0
func (in *PipelineRunTaskRunStatus) DeepCopyInto(out *PipelineRunTaskRunStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PipelineSpec ¶ added in v0.39.0
type PipelineSpec struct { // DisplayName is a user-facing name of the pipeline that may be // used to populate a UI. // +optional DisplayName string `json:"displayName,omitempty"` // Description is a user-facing description of the pipeline that may be // used to populate a UI. // +optional Description string `json:"description,omitempty"` // Tasks declares the graph of Tasks that execute when this Pipeline is run. // +listType=atomic Tasks []PipelineTask `json:"tasks,omitempty"` // Params declares a list of input parameters that must be supplied when // this Pipeline is run. // +listType=atomic Params ParamSpecs `json:"params,omitempty"` // Workspaces declares a set of named workspaces that are expected to be // provided by a PipelineRun. // +optional // +listType=atomic Workspaces []PipelineWorkspaceDeclaration `json:"workspaces,omitempty"` // Results are values that this pipeline can output once run // +optional // +listType=atomic Results []PipelineResult `json:"results,omitempty"` // 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 // +listType=atomic Finally []PipelineTask `json:"finally,omitempty"` }
PipelineSpec defines the desired state of Pipeline.
func (*PipelineSpec) DeepCopy ¶ added in v0.39.0
func (in *PipelineSpec) DeepCopy() *PipelineSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PipelineSpec.
func (*PipelineSpec) DeepCopyInto ¶ added in v0.39.0
func (in *PipelineSpec) DeepCopyInto(out *PipelineSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PipelineSpec) GetIndexingReferencesToArrayParams ¶ added in v0.48.0
func (ps *PipelineSpec) GetIndexingReferencesToArrayParams() sets.String
GetIndexingReferencesToArrayParams returns all strings referencing indices of PipelineRun array parameters from parameters, workspaces, and when expressions defined in the Pipeline's Tasks and Finally Tasks. For example, if a Task in the Pipeline has a parameter with a value "$(params.array-param-name[1])", this would be one of the strings returned.
func (*PipelineSpec) SetDefaults ¶ added in v0.39.0
func (ps *PipelineSpec) SetDefaults(ctx context.Context)
SetDefaults sets default values for the PipelineSpec's Params, Tasks, and Finally
func (*PipelineSpec) Validate ¶ added in v0.39.0
func (ps *PipelineSpec) Validate(ctx context.Context) (errs *apis.FieldError)
Validate checks that taskNames in the Pipeline are valid and that the graph of Tasks expressed in the Pipeline makes sense.
func (*PipelineSpec) ValidateBetaFields ¶ added in v0.49.0
func (ps *PipelineSpec) ValidateBetaFields(ctx context.Context) *apis.FieldError
ValidateBetaFields returns an error if the Pipeline spec uses beta features but does not have "enable-api-fields" set to "alpha" or "beta".
type PipelineTask ¶ added in v0.39.0
type PipelineTask struct { // 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. Name string `json:"name,omitempty"` // DisplayName is the display name of this task within the context of a Pipeline. // This display name may be used to populate a UI. // +optional DisplayName string `json:"displayName,omitempty"` // Description is the description of this task within the context of a Pipeline. // This description may be used to populate a UI. // +optional Description string `json:"description,omitempty"` // TaskRef is a reference to a task definition. // +optional TaskRef *TaskRef `json:"taskRef,omitempty"` // TaskSpec is a specification of a task // Specifying TaskSpec can be disabled by setting // `disable-inline-spec` feature flag.. // +optional TaskSpec *EmbeddedTask `json:"taskSpec,omitempty"` // When is a list of when expressions that need to be true for the task to run // +optional When WhenExpressions `json:"when,omitempty"` // Retries represents how many times this task should be retried in case of task failure: ConditionSucceeded set to False // +optional Retries int `json:"retries,omitempty"` // RunAfter is the list of PipelineTask names that should be executed before // this Task executes. (Used to force a specific ordering in graph execution.) // +optional // +listType=atomic RunAfter []string `json:"runAfter,omitempty"` // Parameters declares parameters passed to this task. // +optional // +listType=atomic Params Params `json:"params,omitempty"` // Matrix declares parameters used to fan out this task. // +optional Matrix *Matrix `json:"matrix,omitempty"` // Workspaces maps workspaces from the pipeline spec to the workspaces // declared in the Task. // +optional // +listType=atomic Workspaces []WorkspacePipelineTaskBinding `json:"workspaces,omitempty"` // 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 // +optional Timeout *metav1.Duration `json:"timeout,omitempty"` // PipelineRef is a reference to a pipeline definition // Note: PipelineRef is in preview mode and not yet supported // +optional PipelineRef *PipelineRef `json:"pipelineRef,omitempty"` // 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.. // +optional PipelineSpec *PipelineSpec `json:"pipelineSpec,omitempty"` // OnError defines the exiting behavior of a PipelineRun on error // can be set to [ continue | stopAndFail ] // +optional OnError PipelineTaskOnErrorType `json:"onError,omitempty"` }
PipelineTask defines a task in a Pipeline, passing inputs from both Params and from the output of previous tasks.
func (*PipelineTask) DeepCopy ¶ added in v0.39.0
func (in *PipelineTask) DeepCopy() *PipelineTask
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PipelineTask.
func (*PipelineTask) DeepCopyInto ¶ added in v0.39.0
func (in *PipelineTask) DeepCopyInto(out *PipelineTask)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (PipelineTask) Deps ¶ added in v0.39.0
func (pt PipelineTask) Deps() []string
Deps returns all other PipelineTask dependencies of this PipelineTask, based on resource usage or ordering
func (*PipelineTask) GetVarSubstitutionExpressions ¶ added in v0.53.0
func (pt *PipelineTask) GetVarSubstitutionExpressions() []string
GetVarSubstitutionExpressions extract all values between the parameters "$(" and ")" of steps and sidecars
func (PipelineTask) HashKey ¶ added in v0.39.0
func (pt PipelineTask) HashKey() string
HashKey is the name of the PipelineTask, and is used as the key for this PipelineTask in the DAG
func (*PipelineTask) IsMatrixed ¶ added in v0.40.0
func (pt *PipelineTask) IsMatrixed() bool
IsMatrixed return whether pipeline task is matrixed
func (*PipelineTask) SetDefaults ¶ added in v0.47.0
func (pt *PipelineTask) SetDefaults(ctx context.Context)
SetDefaults sets default values for a PipelineTask
func (*PipelineTask) TaskSpecMetadata ¶ added in v0.39.0
func (pt *PipelineTask) TaskSpecMetadata() PipelineTaskMetadata
TaskSpecMetadata returns the metadata of the PipelineTask's EmbeddedTask spec.
func (PipelineTask) Validate ¶ added in v0.39.0
func (pt PipelineTask) Validate(ctx context.Context) (errs *apis.FieldError)
Validate classifies whether a task is a custom task or a regular task(dag/final) calls the validation routine based on the type of the task
func (PipelineTask) ValidateName ¶ added in v0.39.0
func (pt PipelineTask) ValidateName() *apis.FieldError
ValidateName checks whether the PipelineTask's name is a valid DNS label
type PipelineTaskList ¶ added in v0.39.0
type PipelineTaskList []PipelineTask
PipelineTaskList is a list of PipelineTasks
func (PipelineTaskList) DeepCopy ¶ added in v0.39.0
func (in PipelineTaskList) DeepCopy() PipelineTaskList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PipelineTaskList.
func (PipelineTaskList) DeepCopyInto ¶ added in v0.39.0
func (in PipelineTaskList) DeepCopyInto(out *PipelineTaskList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (PipelineTaskList) Deps ¶ added in v0.39.0
func (l PipelineTaskList) Deps() map[string][]string
Deps returns a map with key as name of a pipelineTask and value as a list of its dependencies
func (PipelineTaskList) Items ¶ added in v0.39.0
func (l PipelineTaskList) Items() []dag.Task
Items returns a slice of all tasks in the PipelineTaskList, converted to dag.Tasks
func (PipelineTaskList) Names ¶ added in v0.39.0
func (l PipelineTaskList) Names() sets.String
Names returns a set of pipeline task names from the given list of pipeline tasks
func (PipelineTaskList) Validate ¶ added in v0.39.0
func (l PipelineTaskList) Validate(ctx context.Context, taskNames sets.String, path string) (errs *apis.FieldError)
Validate a list of pipeline tasks including custom task
type PipelineTaskMetadata ¶ added in v0.39.0
type PipelineTaskMetadata struct { // +optional Labels map[string]string `json:"labels,omitempty"` // +optional Annotations map[string]string `json:"annotations,omitempty"` }
PipelineTaskMetadata contains the labels or annotations for an EmbeddedTask
func (*PipelineTaskMetadata) DeepCopy ¶ added in v0.39.0
func (in *PipelineTaskMetadata) DeepCopy() *PipelineTaskMetadata
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PipelineTaskMetadata.
func (*PipelineTaskMetadata) DeepCopyInto ¶ added in v0.39.0
func (in *PipelineTaskMetadata) DeepCopyInto(out *PipelineTaskMetadata)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PipelineTaskOnErrorType ¶ added in v0.53.0
type PipelineTaskOnErrorType string
PipelineTaskOnErrorType defines a list of supported failure handling behaviors of a PipelineTask on error
type PipelineTaskParam ¶ added in v0.39.0
PipelineTaskParam is used to provide arbitrary string parameters to a Task.
func (*PipelineTaskParam) DeepCopy ¶ added in v0.39.0
func (in *PipelineTaskParam) DeepCopy() *PipelineTaskParam
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PipelineTaskParam.
func (*PipelineTaskParam) DeepCopyInto ¶ added in v0.39.0
func (in *PipelineTaskParam) DeepCopyInto(out *PipelineTaskParam)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PipelineTaskRun ¶ added in v0.40.0
type PipelineTaskRun struct {
Name string `json:"name,omitempty"`
}
PipelineTaskRun reports the results of running a step in the Task. Each task has the potential to succeed or fail (based on the exit code) and produces logs.
func (*PipelineTaskRun) DeepCopy ¶ added in v0.40.0
func (in *PipelineTaskRun) DeepCopy() *PipelineTaskRun
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PipelineTaskRun.
func (*PipelineTaskRun) DeepCopyInto ¶ added in v0.40.0
func (in *PipelineTaskRun) DeepCopyInto(out *PipelineTaskRun)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PipelineTaskRunSpec ¶ added in v0.40.0
type PipelineTaskRunSpec struct { PipelineTaskName string `json:"pipelineTaskName,omitempty"` ServiceAccountName string `json:"serviceAccountName,omitempty"` PodTemplate *pod.PodTemplate `json:"podTemplate,omitempty"` // +listType=atomic StepSpecs []TaskRunStepSpec `json:"stepSpecs,omitempty"` // +listType=atomic SidecarSpecs []TaskRunSidecarSpec `json:"sidecarSpecs,omitempty"` // +optional Metadata *PipelineTaskMetadata `json:"metadata,omitempty"` // Compute resources to use for this TaskRun ComputeResources *corev1.ResourceRequirements `json:"computeResources,omitempty"` }
PipelineTaskRunSpec can be used to configure specific specs for a concrete Task
func (*PipelineTaskRunSpec) DeepCopy ¶ added in v0.40.0
func (in *PipelineTaskRunSpec) DeepCopy() *PipelineTaskRunSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PipelineTaskRunSpec.
func (*PipelineTaskRunSpec) DeepCopyInto ¶ added in v0.40.0
func (in *PipelineTaskRunSpec) DeepCopyInto(out *PipelineTaskRunSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PipelineTaskRunTemplate ¶ added in v0.40.0
type PipelineTaskRunTemplate struct { // +optional PodTemplate *pod.PodTemplate `json:"podTemplate,omitempty"` // +optional ServiceAccountName string `json:"serviceAccountName,omitempty"` }
PipelineTaskRunTemplate is used to specify run specifications for all Task in pipelinerun.
func (*PipelineTaskRunTemplate) DeepCopy ¶ added in v0.40.0
func (in *PipelineTaskRunTemplate) DeepCopy() *PipelineTaskRunTemplate
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PipelineTaskRunTemplate.
func (*PipelineTaskRunTemplate) DeepCopyInto ¶ added in v0.40.0
func (in *PipelineTaskRunTemplate) DeepCopyInto(out *PipelineTaskRunTemplate)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PipelineWorkspaceDeclaration ¶
type PipelineWorkspaceDeclaration struct { // Name is the name of a workspace to be provided by a PipelineRun. Name string `json:"name"` // 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. // +optional Description string `json:"description,omitempty"` // Optional marks a Workspace as not being required in PipelineRuns. By default // this field is false and so declared workspaces are required. Optional bool `json:"optional,omitempty"` }
PipelineWorkspaceDeclaration creates a named slot in a Pipeline that a PipelineRun is expected to populate with a workspace binding.
func (*PipelineWorkspaceDeclaration) DeepCopy ¶
func (in *PipelineWorkspaceDeclaration) DeepCopy() *PipelineWorkspaceDeclaration
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PipelineWorkspaceDeclaration.
func (*PipelineWorkspaceDeclaration) DeepCopyInto ¶
func (in *PipelineWorkspaceDeclaration) DeepCopyInto(out *PipelineWorkspaceDeclaration)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PropertySpec ¶
type PropertySpec struct {
Type ParamType `json:"type,omitempty"`
}
PropertySpec defines the struct for object keys
func (*PropertySpec) DeepCopy ¶
func (in *PropertySpec) DeepCopy() *PropertySpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PropertySpec.
func (*PropertySpec) DeepCopyInto ¶
func (in *PropertySpec) DeepCopyInto(out *PropertySpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Provenance ¶ added in v0.41.0
type Provenance struct { // RefSource identifies the source where a remote task/pipeline came from. RefSource *RefSource `json:"refSource,omitempty"` // FeatureFlags identifies the feature flags that were used during the task/pipeline run FeatureFlags *config.FeatureFlags `json:"featureFlags,omitempty"` }
Provenance contains metadata about resources used in the TaskRun/PipelineRun such as the source from where a remote build definition was fetched. This field aims to carry minimum amoumt of metadata in *Run status so that Tekton Chains can capture them in the provenance.
func (*Provenance) DeepCopy ¶ added in v0.41.0
func (in *Provenance) DeepCopy() *Provenance
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Provenance.
func (*Provenance) DeepCopyInto ¶ added in v0.41.0
func (in *Provenance) DeepCopyInto(out *Provenance)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Ref ¶ added in v0.54.0
type Ref struct { // Name of the referenced step Name string `json:"name,omitempty"` // ResolverRef allows referencing a StepAction in a remote location // like a git repo. // +optional ResolverRef `json:",omitempty"` }
Ref can be used to refer to a specific instance of a StepAction.
func (*Ref) DeepCopy ¶ added in v0.54.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Ref.
func (*Ref) DeepCopyInto ¶ added in v0.54.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RefSource ¶ added in v0.47.0
type RefSource struct { // URI indicates the identity of the source of the build definition. // Example: "https://github.com/tektoncd/catalog" URI string `json:"uri,omitempty"` // Digest is a collection of cryptographic digests for the contents of the artifact specified by URI. // Example: {"sha1": "f99d13e554ffcb696dee719fa85b695cb5b0f428"} Digest map[string]string `json:"digest,omitempty"` // EntryPoint identifies the entry point into the build. This is often a path to a // build definition file and/or a target label within that file. // Example: "task/git-clone/0.8/git-clone.yaml" EntryPoint string `json:"entryPoint,omitempty"` }
RefSource contains the information that can uniquely identify where a remote built definition came from i.e. Git repositories, Tekton Bundles in OCI registry and hub.
func (*RefSource) DeepCopy ¶ added in v0.47.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RefSource.
func (*RefSource) DeepCopyInto ¶ added in v0.47.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ResolverName ¶
type ResolverName string
ResolverName is the name of a resolver from which a resource can be requested.
type ResolverRef ¶
type ResolverRef struct { // Resolver is the name of the resolver that should perform // resolution of the referenced Tekton resource, such as "git". // +optional Resolver ResolverName `json:"resolver,omitempty"` // 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. // +optional // +listType=atomic Params Params `json:"params,omitempty"` }
ResolverRef can be used to refer to a Pipeline or Task in a remote location like a git repo. This feature is in beta and these fields are only available when the beta feature gate is enabled.
func (*ResolverRef) DeepCopy ¶
func (in *ResolverRef) DeepCopy() *ResolverRef
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResolverRef.
func (*ResolverRef) DeepCopyInto ¶
func (in *ResolverRef) DeepCopyInto(out *ResolverRef)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ResultRef ¶ added in v0.39.0
type ResultRef struct { PipelineTask string `json:"pipelineTask"` Result string `json:"result"` ResultsIndex *int `json:"resultsIndex"` Property string `json:"property"` }
ResultRef is a type that represents a reference to a task run result
func NewResultRefs ¶ added in v0.39.0
NewResultRefs extracts all ResultReferences from a param or a pipeline result. If the ResultReference can be extracted, they are returned. Expressions which are not results are ignored.
func PipelineTaskResultRefs ¶ added in v0.39.0
func PipelineTaskResultRefs(pt *PipelineTask) []*ResultRef
PipelineTaskResultRefs walks all the places a result reference can be used in a PipelineTask and returns a list of any references that are found.
func (*ResultRef) DeepCopy ¶ added in v0.39.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResultRef.
func (*ResultRef) DeepCopyInto ¶ added in v0.39.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ResultValue ¶ added in v0.39.0
type ResultValue = ParamValue
ResultValue is a type alias of ParamValue
type ResultsType ¶
type ResultsType string
ResultsType indicates the type of a result; Used to distinguish between a single string and an array of strings. Note that there is ResultType used to find out whether a RunResult is from a task result or not, which is different from this ResultsType.
const ( ResultsTypeString ResultsType = "string" ResultsTypeArray ResultsType = "array" ResultsTypeObject ResultsType = "object" )
Valid ResultsType:
type Sidecar ¶
type Sidecar struct { // Name of the Sidecar specified as a DNS_LABEL. // Each Sidecar in a Task must have a unique name (DNS_LABEL). // Cannot be updated. Name string `json:"name" protobuf:"bytes,1,opt,name=name"` // Image reference name. // More info: https://kubernetes.io/docs/concepts/containers/images // +optional Image string `json:"image,omitempty" protobuf:"bytes,2,opt,name=image"` // Entrypoint array. Not executed within a shell. // The image's ENTRYPOINT is used if this is not provided. // Variable references $(VAR_NAME) are expanded using the Sidecar's environment. If a variable // cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced // to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will // produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless // of whether the variable exists or not. Cannot be updated. // More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell // +optional // +listType=atomic Command []string `json:"command,omitempty" protobuf:"bytes,3,rep,name=command"` // Arguments to the entrypoint. // The image's CMD is used if this is not provided. // Variable references $(VAR_NAME) are expanded using the Sidecar's environment. If a variable // cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced // to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will // produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless // of whether the variable exists or not. Cannot be updated. // More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell // +optional // +listType=atomic Args []string `json:"args,omitempty" protobuf:"bytes,4,rep,name=args"` // Sidecar's working directory. // If not specified, the container runtime's default will be used, which // might be configured in the container image. // Cannot be updated. // +optional WorkingDir string `json:"workingDir,omitempty" protobuf:"bytes,5,opt,name=workingDir"` // List of ports to expose from the Sidecar. Exposing a port here gives // the system additional information about the network connections a // container uses, but is primarily informational. Not specifying a port here // DOES NOT prevent that port from being exposed. Any port which is // listening on the default "0.0.0.0" address inside a container will be // accessible from the network. // Cannot be updated. // +optional // +patchMergeKey=containerPort // +patchStrategy=merge // +listType=map // +listMapKey=containerPort // +listMapKey=protocol Ports []corev1.ContainerPort `json:"ports,omitempty" patchMergeKey:"containerPort" patchStrategy:"merge" protobuf:"bytes,6,rep,name=ports"` // List of sources to populate environment variables in the Sidecar. // The keys defined within a source must be a C_IDENTIFIER. All invalid keys // will be reported as an event when the container is starting. When a key exists in multiple // sources, the value associated with the last source will take precedence. // Values defined by an Env with a duplicate key will take precedence. // Cannot be updated. // +optional // +listType=atomic EnvFrom []corev1.EnvFromSource `json:"envFrom,omitempty" protobuf:"bytes,19,rep,name=envFrom"` // List of environment variables to set in the Sidecar. // Cannot be updated. // +optional // +patchMergeKey=name // +patchStrategy=merge // +listType=atomic Env []corev1.EnvVar `json:"env,omitempty" patchMergeKey:"name" patchStrategy:"merge" protobuf:"bytes,7,rep,name=env"` // ComputeResources required by this Sidecar. // Cannot be updated. // More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ // +optional ComputeResources corev1.ResourceRequirements `json:"computeResources,omitempty" protobuf:"bytes,8,opt,name=computeResources"` // Volumes to mount into the Sidecar's filesystem. // Cannot be updated. // +optional // +patchMergeKey=mountPath // +patchStrategy=merge // +listType=atomic VolumeMounts []corev1.VolumeMount `json:"volumeMounts,omitempty" patchMergeKey:"mountPath" patchStrategy:"merge" protobuf:"bytes,9,rep,name=volumeMounts"` // volumeDevices is the list of block devices to be used by the Sidecar. // +patchMergeKey=devicePath // +patchStrategy=merge // +optional // +listType=atomic VolumeDevices []corev1.VolumeDevice `json:"volumeDevices,omitempty" patchMergeKey:"devicePath" patchStrategy:"merge" protobuf:"bytes,21,rep,name=volumeDevices"` // Periodic probe of Sidecar liveness. // Container will be restarted if the probe fails. // Cannot be updated. // More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes // +optional LivenessProbe *corev1.Probe `json:"livenessProbe,omitempty" protobuf:"bytes,10,opt,name=livenessProbe"` // Periodic probe of Sidecar service readiness. // Container will be removed from service endpoints if the probe fails. // Cannot be updated. // More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes // +optional ReadinessProbe *corev1.Probe `json:"readinessProbe,omitempty" protobuf:"bytes,11,opt,name=readinessProbe"` // StartupProbe indicates that the Pod the Sidecar is running in has successfully initialized. // If specified, no other probes are executed until this completes successfully. // If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. // This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, // when it might take a long time to load data or warm a cache, than during steady-state operation. // This cannot be updated. // More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes // +optional StartupProbe *corev1.Probe `json:"startupProbe,omitempty" protobuf:"bytes,22,opt,name=startupProbe"` // Actions that the management system should take in response to Sidecar lifecycle events. // Cannot be updated. // +optional Lifecycle *corev1.Lifecycle `json:"lifecycle,omitempty" protobuf:"bytes,12,opt,name=lifecycle"` // Optional: Path at which the file to which the Sidecar's termination message // will be written is mounted into the Sidecar's filesystem. // Message written is intended to be brief final status, such as an assertion failure message. // Will be truncated by the node if greater than 4096 bytes. The total message length across // all containers will be limited to 12kb. // Defaults to /dev/termination-log. // Cannot be updated. // +optional TerminationMessagePath string `json:"terminationMessagePath,omitempty" protobuf:"bytes,13,opt,name=terminationMessagePath"` // Indicate how the termination message should be populated. File will use the contents of // terminationMessagePath to populate the Sidecar status message on both success and failure. // FallbackToLogsOnError will use the last chunk of Sidecar log output if the termination // message file is empty and the Sidecar exited with an error. // The log output is limited to 2048 bytes or 80 lines, whichever is smaller. // Defaults to File. // Cannot be updated. // +optional TerminationMessagePolicy corev1.TerminationMessagePolicy `` /* 129-byte string literal not displayed */ // Image pull policy. // One of Always, Never, IfNotPresent. // Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. // Cannot be updated. // More info: https://kubernetes.io/docs/concepts/containers/images#updating-images // +optional ImagePullPolicy corev1.PullPolicy `json:"imagePullPolicy,omitempty" protobuf:"bytes,14,opt,name=imagePullPolicy,casttype=PullPolicy"` // SecurityContext defines the security options the Sidecar should be run with. // If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. // More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ // +optional SecurityContext *corev1.SecurityContext `json:"securityContext,omitempty" protobuf:"bytes,15,opt,name=securityContext"` // Whether this Sidecar should allocate a buffer for stdin in the container runtime. If this // is not set, reads from stdin in the Sidecar will always result in EOF. // Default is false. // +optional Stdin bool `json:"stdin,omitempty" protobuf:"varint,16,opt,name=stdin"` // Whether the container runtime should close the stdin channel after it has been opened by // a single attach. When stdin is true the stdin stream will remain open across multiple attach // sessions. If stdinOnce is set to true, stdin is opened on Sidecar start, is empty until the // first client attaches to stdin, and then remains open and accepts data until the client disconnects, // at which time stdin is closed and remains closed until the Sidecar is restarted. If this // flag is false, a container processes that reads from stdin will never receive an EOF. // Default is false // +optional StdinOnce bool `json:"stdinOnce,omitempty" protobuf:"varint,17,opt,name=stdinOnce"` // Whether this Sidecar should allocate a TTY for itself, also requires 'stdin' to be true. // Default is false. // +optional TTY bool `json:"tty,omitempty" protobuf:"varint,18,opt,name=tty"` // Script is the contents of an executable file to execute. // // If Script is not empty, the Step cannot have an Command or Args. // +optional Script string `json:"script,omitempty"` // This is an alpha field. You must set the "enable-api-fields" feature flag to "alpha" // for this field to be supported. // // Workspaces is a list of workspaces from the Task that this Sidecar wants // exclusive access to. Adding a workspace to this list means that any // other Step or Sidecar that does not also request this Workspace will // not have access to it. // +optional // +listType=atomic Workspaces []WorkspaceUsage `json:"workspaces,omitempty"` }
Sidecar has nearly the same data structure as Step but does not have the ability to timeout.
func MergeSidecarsWithSpecs ¶ added in v0.47.0
func MergeSidecarsWithSpecs(sidecars []Sidecar, overrides []TaskRunSidecarSpec) ([]Sidecar, error)
MergeSidecarsWithSpecs takes a possibly nil list of overrides and a list of sidecars, merging each of the sidecars with the overrides' resource requirements, if it's not nil, and returning the resulting list.
func (*Sidecar) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Sidecar.
func (*Sidecar) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Sidecar) GetVarSubstitutionExpressions ¶ added in v0.53.0
GetVarSubstitutionExpressions walks all the places a substitution reference can be used
func (*Sidecar) SetContainerFields ¶
SetContainerFields sets the fields of the Sidecar to the values of the corresponding fields in the Container
func (*Sidecar) ToK8sContainer ¶
ToK8sContainer converts the Sidecar to a Kubernetes Container struct
type SidecarState ¶ added in v0.40.0
type SidecarState struct { corev1.ContainerState `json:",inline"` Name string `json:"name,omitempty"` Container string `json:"container,omitempty"` ImageID string `json:"imageID,omitempty"` }
SidecarState reports the results of running a sidecar in a Task.
func (*SidecarState) DeepCopy ¶ added in v0.40.0
func (in *SidecarState) DeepCopy() *SidecarState
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SidecarState.
func (*SidecarState) DeepCopyInto ¶ added in v0.40.0
func (in *SidecarState) DeepCopyInto(out *SidecarState)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SkippedTask ¶ added in v0.40.0
type SkippedTask struct { // Name is the Pipeline Task name Name string `json:"name"` // Reason is the cause of the PipelineTask being skipped. Reason SkippingReason `json:"reason"` // WhenExpressions is the list of checks guarding the execution of the PipelineTask // +optional // +listType=atomic WhenExpressions []WhenExpression `json:"whenExpressions,omitempty"` }
SkippedTask is used to describe the Tasks that were skipped due to their When Expressions evaluating to False. This is a struct because we are looking into including more details about the When Expressions that caused this Task to be skipped.
func (*SkippedTask) DeepCopy ¶ added in v0.40.0
func (in *SkippedTask) DeepCopy() *SkippedTask
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SkippedTask.
func (*SkippedTask) DeepCopyInto ¶ added in v0.40.0
func (in *SkippedTask) DeepCopyInto(out *SkippedTask)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SkippingReason ¶ added in v0.40.0
type SkippingReason string
SkippingReason explains why a PipelineTask was skipped.
const ( // WhenExpressionsSkip means the task was skipped due to at least one of its when expressions evaluating to false WhenExpressionsSkip SkippingReason = "When Expressions evaluated to false" // ParentTasksSkip means the task was skipped because its parent was skipped ParentTasksSkip SkippingReason = "Parent Tasks were skipped" // StoppingSkip means the task was skipped because the pipeline run is stopping StoppingSkip SkippingReason = "PipelineRun was stopping" // GracefullyCancelledSkip means the task was skipped because the pipeline run has been gracefully cancelled GracefullyCancelledSkip SkippingReason = "PipelineRun was gracefully cancelled" // GracefullyStoppedSkip means the task was skipped because the pipeline run has been gracefully stopped GracefullyStoppedSkip SkippingReason = "PipelineRun was gracefully stopped" // MissingResultsSkip means the task was skipped because it's missing necessary results MissingResultsSkip SkippingReason = "Results were missing" // PipelineTimedOutSkip means the task was skipped because the PipelineRun has passed its overall timeout. PipelineTimedOutSkip SkippingReason = "PipelineRun timeout has been reached" // TasksTimedOutSkip means the task was skipped because the PipelineRun has passed its Timeouts.Tasks. TasksTimedOutSkip SkippingReason = "PipelineRun Tasks timeout has been reached" // FinallyTimedOutSkip means the task was skipped because the PipelineRun has passed its Timeouts.Finally. FinallyTimedOutSkip SkippingReason = "PipelineRun Finally timeout has been reached" // EmptyArrayInMatrixParams means the task was skipped because Matrix parameters contain empty array. EmptyArrayInMatrixParams SkippingReason = "Matrix Parameters have an empty array" // None means the task was not skipped None SkippingReason = "None" )
type Step ¶
type Step struct { // Name of the Step specified as a DNS_LABEL. // Each Step in a Task must have a unique name. Name string `json:"name" protobuf:"bytes,1,opt,name=name"` // Docker image name. // More info: https://kubernetes.io/docs/concepts/containers/images // +optional Image string `json:"image,omitempty" protobuf:"bytes,2,opt,name=image"` // Entrypoint array. Not executed within a shell. // The image's ENTRYPOINT is used if this is not provided. // Variable references $(VAR_NAME) are expanded using the container's environment. If a variable // cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced // to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will // produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless // of whether the variable exists or not. Cannot be updated. // More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell // +optional // +listType=atomic Command []string `json:"command,omitempty" protobuf:"bytes,3,rep,name=command"` // Arguments to the entrypoint. // The image's CMD is used if this is not provided. // Variable references $(VAR_NAME) are expanded using the container's environment. If a variable // cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced // to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will // produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless // of whether the variable exists or not. Cannot be updated. // More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell // +optional // +listType=atomic Args []string `json:"args,omitempty" protobuf:"bytes,4,rep,name=args"` // Step's working directory. // If not specified, the container runtime's default will be used, which // might be configured in the container image. // Cannot be updated. // +optional WorkingDir string `json:"workingDir,omitempty" protobuf:"bytes,5,opt,name=workingDir"` // List of sources to populate environment variables in the Step. // The keys defined within a source must be a C_IDENTIFIER. All invalid keys // will be reported as an event when the Step is starting. When a key exists in multiple // sources, the value associated with the last source will take precedence. // Values defined by an Env with a duplicate key will take precedence. // Cannot be updated. // +optional // +listType=atomic EnvFrom []corev1.EnvFromSource `json:"envFrom,omitempty" protobuf:"bytes,19,rep,name=envFrom"` // List of environment variables to set in the Step. // Cannot be updated. // +optional // +patchMergeKey=name // +patchStrategy=merge // +listType=atomic Env []corev1.EnvVar `json:"env,omitempty" patchMergeKey:"name" patchStrategy:"merge" protobuf:"bytes,7,rep,name=env"` // ComputeResources required by this Step. // Cannot be updated. // More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ // +optional ComputeResources corev1.ResourceRequirements `json:"computeResources,omitempty" protobuf:"bytes,8,opt,name=computeResources"` // Volumes to mount into the Step's filesystem. // Cannot be updated. // +optional // +patchMergeKey=mountPath // +patchStrategy=merge // +listType=atomic VolumeMounts []corev1.VolumeMount `json:"volumeMounts,omitempty" patchMergeKey:"mountPath" patchStrategy:"merge" protobuf:"bytes,9,rep,name=volumeMounts"` // volumeDevices is the list of block devices to be used by the Step. // +patchMergeKey=devicePath // +patchStrategy=merge // +optional // +listType=atomic VolumeDevices []corev1.VolumeDevice `json:"volumeDevices,omitempty" patchMergeKey:"devicePath" patchStrategy:"merge" protobuf:"bytes,21,rep,name=volumeDevices"` // Image pull policy. // One of Always, Never, IfNotPresent. // Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. // Cannot be updated. // More info: https://kubernetes.io/docs/concepts/containers/images#updating-images // +optional ImagePullPolicy corev1.PullPolicy `json:"imagePullPolicy,omitempty" protobuf:"bytes,14,opt,name=imagePullPolicy,casttype=PullPolicy"` // SecurityContext defines the security options the Step should be run with. // If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. // More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ // +optional SecurityContext *corev1.SecurityContext `json:"securityContext,omitempty" protobuf:"bytes,15,opt,name=securityContext"` // Script is the contents of an executable file to execute. // // If Script is not empty, the Step cannot have an Command and the Args will be passed to the Script. // +optional Script string `json:"script,omitempty"` // Timeout is the time after which the step times out. Defaults to never. // Refer to Go's ParseDuration documentation for expected format: https://golang.org/pkg/time/#ParseDuration // +optional Timeout *metav1.Duration `json:"timeout,omitempty"` // This is an alpha field. You must set the "enable-api-fields" feature flag to "alpha" // for this field to be supported. // // Workspaces is a list of workspaces from the Task that this Step wants // exclusive access to. Adding a workspace to this list means that any // other Step or Sidecar that does not also request this Workspace will // not have access to it. // +optional // +listType=atomic Workspaces []WorkspaceUsage `json:"workspaces,omitempty"` // OnError defines the exiting behavior of a container on error // can be set to [ continue | stopAndFail ] OnError OnErrorType `json:"onError,omitempty"` // Stores configuration for the stdout stream of the step. // +optional StdoutConfig *StepOutputConfig `json:"stdoutConfig,omitempty"` // Stores configuration for the stderr stream of the step. // +optional StderrConfig *StepOutputConfig `json:"stderrConfig,omitempty"` // Contains the reference to an existing StepAction. //+optional Ref *Ref `json:"ref,omitempty"` // Params declares parameters passed to this step action. // +optional // +listType=atomic Params Params `json:"params,omitempty"` // Results declares StepResults produced by the Step. // // This is field is at an ALPHA stability level and gated by "enable-step-actions" feature flag. // // It can be used in an inlined Step when used to store Results to $(step.results.resultName.path). // It cannot be used when referencing StepActions using [v1.Step.Ref]. // The Results declared by the StepActions will be stored here instead. // +optional // +listType=atomic Results []StepResult `json:"results,omitempty"` }
Step runs a subcomponent of a Task
func MergeStepsWithSpecs ¶ added in v0.47.0
func MergeStepsWithSpecs(steps []Step, overrides []TaskRunStepSpec) ([]Step, error)
MergeStepsWithSpecs takes a possibly nil list of overrides and a list of steps, merging each of the steps with the overrides' resource requirements, if it's not nil, and returning the resulting list.
func MergeStepsWithStepTemplate ¶
func MergeStepsWithStepTemplate(template *StepTemplate, steps []Step) ([]Step, error)
MergeStepsWithStepTemplate takes a possibly nil container template and a list of steps, merging each of the steps with the container template, if it's not nil, and returning the resulting list.
func (*Step) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Step.
func (*Step) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Step) GetVarSubstitutionExpressions ¶ added in v0.53.0
GetVarSubstitutionExpressions walks all the places a substitution reference can be used
func (*Step) SetContainerFields ¶
SetContainerFields sets the fields of the Step to the values of the corresponding fields in the Container
func (*Step) ToK8sContainer ¶
ToK8sContainer converts the Step to a Kubernetes Container struct
type StepOutputConfig ¶
type StepOutputConfig struct { // Path to duplicate stdout stream to on container's local filesystem. // +optional Path string `json:"path,omitempty"` }
StepOutputConfig stores configuration for a step output stream.
func (*StepOutputConfig) DeepCopy ¶
func (in *StepOutputConfig) DeepCopy() *StepOutputConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StepOutputConfig.
func (*StepOutputConfig) DeepCopyInto ¶
func (in *StepOutputConfig) DeepCopyInto(out *StepOutputConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type StepResult ¶ added in v0.54.0
type StepResult struct { // Name the given name Name string `json:"name"` // The possible types are 'string', 'array', and 'object', with 'string' as the default. // +optional Type ResultsType `json:"type,omitempty"` // Properties is the JSON Schema properties to support key-value pairs results. // +optional Properties map[string]PropertySpec `json:"properties,omitempty"` // Description is a human-readable description of the result // +optional Description string `json:"description,omitempty"` }
StepResult used to describe the Results of a Step.
This is field is at an ALPHA stability level and gated by "enable-step-actions" feature flag.
func (*StepResult) DeepCopy ¶ added in v0.54.0
func (in *StepResult) DeepCopy() *StepResult
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StepResult.
func (*StepResult) DeepCopyInto ¶ added in v0.54.0
func (in *StepResult) DeepCopyInto(out *StepResult)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*StepResult) SetDefaults ¶ added in v0.54.0
func (sr *StepResult) SetDefaults(context.Context)
SetDefaults set the default type for StepResult
func (StepResult) Validate ¶ added in v0.54.0
func (sr StepResult) Validate(ctx context.Context) (errs *apis.FieldError)
Validate implements apis.Validatable
type StepState ¶ added in v0.40.0
type StepState struct { corev1.ContainerState `json:",inline"` Name string `json:"name,omitempty"` Container string `json:"container,omitempty"` ImageID string `json:"imageID,omitempty"` Results []TaskRunStepResult `json:"results,omitempty"` TerminationReason string `json:"terminationReason,omitempty"` Inputs []TaskRunStepArtifact `json:"inputs,omitempty"` Outputs []TaskRunStepArtifact `json:"outputs,omitempty"` }
StepState reports the results of running a step in a Task.
func (*StepState) DeepCopy ¶ added in v0.40.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StepState.
func (*StepState) DeepCopyInto ¶ added in v0.40.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type StepTemplate ¶
type StepTemplate struct { // Image reference name. // More info: https://kubernetes.io/docs/concepts/containers/images // +optional Image string `json:"image,omitempty" protobuf:"bytes,2,opt,name=image"` // Entrypoint array. Not executed within a shell. // The image's ENTRYPOINT is used if this is not provided. // Variable references $(VAR_NAME) are expanded using the Step's environment. If a variable // cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced // to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will // produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless // of whether the variable exists or not. Cannot be updated. // More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell // +optional // +listType=atomic Command []string `json:"command,omitempty" protobuf:"bytes,3,rep,name=command"` // Arguments to the entrypoint. // The image's CMD is used if this is not provided. // Variable references $(VAR_NAME) are expanded using the Step's environment. If a variable // cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced // to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will // produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless // of whether the variable exists or not. Cannot be updated. // More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell // +optional // +listType=atomic Args []string `json:"args,omitempty" protobuf:"bytes,4,rep,name=args"` // Step's working directory. // If not specified, the container runtime's default will be used, which // might be configured in the container image. // Cannot be updated. // +optional WorkingDir string `json:"workingDir,omitempty" protobuf:"bytes,5,opt,name=workingDir"` // List of sources to populate environment variables in the Step. // The keys defined within a source must be a C_IDENTIFIER. All invalid keys // will be reported as an event when the Step is starting. When a key exists in multiple // sources, the value associated with the last source will take precedence. // Values defined by an Env with a duplicate key will take precedence. // Cannot be updated. // +optional // +listType=atomic EnvFrom []corev1.EnvFromSource `json:"envFrom,omitempty" protobuf:"bytes,19,rep,name=envFrom"` // List of environment variables to set in the Step. // Cannot be updated. // +optional // +patchMergeKey=name // +patchStrategy=merge // +listType=atomic Env []corev1.EnvVar `json:"env,omitempty" patchMergeKey:"name" patchStrategy:"merge" protobuf:"bytes,7,rep,name=env"` // ComputeResources required by this Step. // Cannot be updated. // More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ // +optional ComputeResources corev1.ResourceRequirements `json:"computeResources,omitempty" protobuf:"bytes,8,opt,name=computeResources"` // Volumes to mount into the Step's filesystem. // Cannot be updated. // +optional // +patchMergeKey=mountPath // +patchStrategy=merge // +listType=atomic VolumeMounts []corev1.VolumeMount `json:"volumeMounts,omitempty" patchMergeKey:"mountPath" patchStrategy:"merge" protobuf:"bytes,9,rep,name=volumeMounts"` // volumeDevices is the list of block devices to be used by the Step. // +patchMergeKey=devicePath // +patchStrategy=merge // +optional // +listType=atomic VolumeDevices []corev1.VolumeDevice `json:"volumeDevices,omitempty" patchMergeKey:"devicePath" patchStrategy:"merge" protobuf:"bytes,21,rep,name=volumeDevices"` // Image pull policy. // One of Always, Never, IfNotPresent. // Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. // Cannot be updated. // More info: https://kubernetes.io/docs/concepts/containers/images#updating-images // +optional ImagePullPolicy corev1.PullPolicy `json:"imagePullPolicy,omitempty" protobuf:"bytes,14,opt,name=imagePullPolicy,casttype=PullPolicy"` // SecurityContext defines the security options the Step should be run with. // If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. // More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ // +optional SecurityContext *corev1.SecurityContext `json:"securityContext,omitempty" protobuf:"bytes,15,opt,name=securityContext"` }
StepTemplate is a template for a Step
func (*StepTemplate) DeepCopy ¶
func (in *StepTemplate) DeepCopy() *StepTemplate
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StepTemplate.
func (*StepTemplate) DeepCopyInto ¶
func (in *StepTemplate) DeepCopyInto(out *StepTemplate)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*StepTemplate) SetContainerFields ¶
func (s *StepTemplate) SetContainerFields(c corev1.Container)
SetContainerFields sets the fields of the Step to the values of the corresponding fields in the Container
func (*StepTemplate) ToK8sContainer ¶
func (s *StepTemplate) ToK8sContainer() *corev1.Container
ToK8sContainer converts the StepTemplate to a Kubernetes Container struct
type Task ¶
type Task struct { metav1.TypeMeta `json:",inline"` // +optional metav1.ObjectMeta `json:"metadata"` // Spec holds the desired state of the Task from the client // +optional Spec TaskSpec `json:"spec"` }
Task represents a collection of sequential steps that are run as part of a Pipeline using a set of inputs and producing a set of outputs. Tasks execute when TaskRuns are created that provide the input parameters and resources and output resources the Task requires.
+k8s:openapi-gen=true
func (*Task) Checksum ¶ added in v0.51.0
Checksum computes the sha256 checksum of the task object. Prior to computing the checksum, it performs some preprocessing on the metadata of the object where it removes system provided annotations. Only the name, namespace, generateName, user-provided labels and annotations and the taskSpec are included for the checksum computation.
func (*Task) ConvertFrom ¶ added in v0.39.0
ConvertFrom implements apis.Convertible
func (*Task) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Task.
func (*Task) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Task) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Task) GetGroupVersionKind ¶
func (*Task) GetGroupVersionKind() schema.GroupVersionKind
GetGroupVersionKind implements kmeta.OwnerRefable.
func (*Task) SetDefaults ¶
SetDefaults implements apis.Defaultable
func (*Task) SupportedVerbs ¶ added in v0.41.0
func (t *Task) SupportedVerbs() []admissionregistrationv1.OperationType
SupportedVerbs returns the operations that validation should be called for
type TaskBreakpoints ¶ added in v0.53.0
type TaskBreakpoints struct { // if enabled, pause TaskRun on failure of a step // failed step will not exit // +optional OnFailure string `json:"onFailure,omitempty"` }
TaskBreakpoints defines the breakpoint config for a particular Task
func (*TaskBreakpoints) DeepCopy ¶ added in v0.53.0
func (in *TaskBreakpoints) DeepCopy() *TaskBreakpoints
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TaskBreakpoints.
func (*TaskBreakpoints) DeepCopyInto ¶ added in v0.53.0
func (in *TaskBreakpoints) DeepCopyInto(out *TaskBreakpoints)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TaskKind ¶ added in v0.39.0
type TaskKind string
TaskKind defines the type of Task used by the pipeline.
const ( // NamespacedTaskKind indicates that the task type has a namespaced scope. NamespacedTaskKind TaskKind = "Task" // ClusterTaskRefKind is the task type for a reference to a task with cluster scope. // ClusterTasks are not supported in v1, but v1 types may reference ClusterTasks. ClusterTaskRefKind TaskKind = "ClusterTask" )
type TaskList ¶
type TaskList struct { metav1.TypeMeta `json:",inline"` // +optional metav1.ListMeta `json:"metadata,omitempty"` Items []Task `json:"items"` }
TaskList contains a list of Task +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
func (*TaskList) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TaskList.
func (*TaskList) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*TaskList) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type TaskRef ¶ added in v0.39.0
type TaskRef struct { // Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names Name string `json:"name,omitempty"` // 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 Kind TaskKind `json:"kind,omitempty"` // API version of the referent // Note: A Task with non-empty APIVersion and Kind is considered a Custom Task // +optional APIVersion string `json:"apiVersion,omitempty"` // 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. // +optional ResolverRef `json:",omitempty"` }
TaskRef can be used to refer to a specific instance of a task.
func (*TaskRef) DeepCopy ¶ added in v0.39.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TaskRef.
func (*TaskRef) DeepCopyInto ¶ added in v0.39.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*TaskRef) IsCustomTask ¶ added in v0.47.0
IsCustomTask checks whether the reference is to a Custom Task
type TaskResult ¶
type TaskResult struct { // Name the given name Name string `json:"name"` // Type is the user-specified type of the result. The possible type // is currently "string" and will support "array" in following work. // +optional Type ResultsType `json:"type,omitempty"` // Properties is the JSON Schema properties to support key-value pairs results. // +optional Properties map[string]PropertySpec `json:"properties,omitempty"` // Description is a human-readable description of the result // +optional Description string `json:"description,omitempty"` // Value the expression used to retrieve the value of the result from an underlying Step. // +optional Value *ResultValue `json:"value,omitempty"` }
TaskResult used to describe the results of a task
func (*TaskResult) DeepCopy ¶
func (in *TaskResult) DeepCopy() *TaskResult
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TaskResult.
func (*TaskResult) DeepCopyInto ¶
func (in *TaskResult) DeepCopyInto(out *TaskResult)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*TaskResult) SetDefaults ¶
func (tr *TaskResult) SetDefaults(context.Context)
SetDefaults set the default type for TaskResult
func (TaskResult) Validate ¶
func (tr TaskResult) Validate(ctx context.Context) (errs *apis.FieldError)
Validate implements apis.Validatable
type TaskRun ¶ added in v0.40.0
type TaskRun struct { metav1.TypeMeta `json:",inline"` // +optional metav1.ObjectMeta `json:"metadata,omitempty"` // +optional Spec TaskRunSpec `json:"spec,omitempty"` // +optional Status TaskRunStatus `json:"status,omitempty"` }
TaskRun represents a single execution of a Task. TaskRuns are how the steps specified in a Task are executed; they specify the parameters and resources used to run the steps in a Task.
+k8s:openapi-gen=true
func (*TaskRun) ConvertFrom ¶ added in v0.40.0
ConvertFrom implements apis.Convertible
func (*TaskRun) DeepCopy ¶ added in v0.40.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TaskRun.
func (*TaskRun) DeepCopyInto ¶ added in v0.40.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*TaskRun) DeepCopyObject ¶ added in v0.40.0
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*TaskRun) GetGroupVersionKind ¶ added in v0.40.0
func (*TaskRun) GetGroupVersionKind() schema.GroupVersionKind
GetGroupVersionKind implements kmeta.OwnerRefable.
func (*TaskRun) GetNamespacedName ¶ added in v0.40.0
func (tr *TaskRun) GetNamespacedName() types.NamespacedName
GetNamespacedName returns a k8s namespaced name that identifies this TaskRun
func (*TaskRun) GetPipelineRunPVCName ¶ added in v0.40.0
GetPipelineRunPVCName for TaskRun gets pipelinerun
func (*TaskRun) GetStatusCondition ¶ added in v0.40.0
func (tr *TaskRun) GetStatusCondition() apis.ConditionAccessor
GetStatusCondition returns the task run status as a ConditionAccessor
func (*TaskRun) GetTimeout ¶ added in v0.40.0
GetTimeout returns the timeout for the TaskRun, or the default if not specified
func (*TaskRun) HasPipelineRunOwnerReference ¶ added in v0.40.0
HasPipelineRunOwnerReference returns true of TaskRun has owner reference of type PipelineRun
func (*TaskRun) HasStarted ¶ added in v0.40.0
HasStarted function check whether TaskRun has valid start time set in its status
func (*TaskRun) HasTimedOut ¶ added in v0.40.0
HasTimedOut returns true if the TaskRun runtime is beyond the allowed timeout
func (*TaskRun) HasVolumeClaimTemplate ¶ added in v0.40.0
HasVolumeClaimTemplate returns true if TaskRun contains volumeClaimTemplates that is used for creating PersistentVolumeClaims with an OwnerReference for each run
func (*TaskRun) IsCancelled ¶ added in v0.40.0
IsCancelled returns true if the TaskRun's spec status is set to Cancelled state
func (*TaskRun) IsDone ¶ added in v0.40.0
IsDone returns true if the TaskRun's status indicates that it is done.
func (*TaskRun) IsFailure ¶ added in v0.50.0
IsFailure returns true if the TaskRun's status indicates that it has failed.
func (*TaskRun) IsRetriable ¶ added in v0.43.0
IsRetriable returns true if the TaskRun's Retries is not exhausted.
func (*TaskRun) IsSuccessful ¶ added in v0.40.0
IsSuccessful returns true if the TaskRun's status indicates that it has succeeded.
func (*TaskRun) SetDefaults ¶ added in v0.40.0
SetDefaults implements apis.Defaultable
func (*TaskRun) SupportedVerbs ¶ added in v0.41.0
func (tr *TaskRun) SupportedVerbs() []admissionregistrationv1.OperationType
SupportedVerbs returns the operations that validation should be called for
type TaskRunDebug ¶ added in v0.40.0
type TaskRunDebug struct { // +optional Breakpoints *TaskBreakpoints `json:"breakpoints,omitempty"` }
TaskRunDebug defines the breakpoint config for a particular TaskRun
func (*TaskRunDebug) DeepCopy ¶ added in v0.40.0
func (in *TaskRunDebug) DeepCopy() *TaskRunDebug
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TaskRunDebug.
func (*TaskRunDebug) DeepCopyInto ¶ added in v0.40.0
func (in *TaskRunDebug) DeepCopyInto(out *TaskRunDebug)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*TaskRunDebug) NeedsDebug ¶ added in v0.53.0
func (trd *TaskRunDebug) NeedsDebug() bool
NeedsDebug return true if defined onfailure or have any before, after steps
func (*TaskRunDebug) NeedsDebugOnFailure ¶ added in v0.53.0
func (trd *TaskRunDebug) NeedsDebugOnFailure() bool
NeedsDebugOnFailure return true if the TaskRun is configured to debug on failure
func (*TaskRunDebug) StepNeedsDebug ¶ added in v0.53.0
func (trd *TaskRunDebug) StepNeedsDebug(stepName string) bool
StepNeedsDebug return true if the step is configured to debug
type TaskRunInputs ¶ added in v0.40.0
type TaskRunInputs struct { // +optional // +listType=atomic Params Params `json:"params,omitempty"` }
TaskRunInputs holds the input values that this task was invoked with.
func (*TaskRunInputs) DeepCopy ¶ added in v0.40.0
func (in *TaskRunInputs) DeepCopy() *TaskRunInputs
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TaskRunInputs.
func (*TaskRunInputs) DeepCopyInto ¶ added in v0.40.0
func (in *TaskRunInputs) DeepCopyInto(out *TaskRunInputs)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TaskRunList ¶ added in v0.40.0
type TaskRunList struct { metav1.TypeMeta `json:",inline"` // +optional metav1.ListMeta `json:"metadata,omitempty"` Items []TaskRun `json:"items"` }
TaskRunList contains a list of TaskRun
func (*TaskRunList) DeepCopy ¶ added in v0.40.0
func (in *TaskRunList) DeepCopy() *TaskRunList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TaskRunList.
func (*TaskRunList) DeepCopyInto ¶ added in v0.40.0
func (in *TaskRunList) DeepCopyInto(out *TaskRunList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*TaskRunList) DeepCopyObject ¶ added in v0.40.0
func (in *TaskRunList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type TaskRunReason ¶ added in v0.40.0
type TaskRunReason string
TaskRunReason is an enum used to store all TaskRun reason for the Succeeded condition that are controlled by the TaskRun itself. Failure reasons that emerge from underlying resources are not included here
const ( // TaskRunReasonStarted is the reason set when the TaskRun has just started TaskRunReasonStarted TaskRunReason = "Started" // TaskRunReasonRunning is the reason set when the TaskRun is running TaskRunReasonRunning TaskRunReason = "Running" // TaskRunReasonSuccessful is the reason set when the TaskRun completed successfully TaskRunReasonSuccessful TaskRunReason = "Succeeded" // TaskRunReasonFailed is the reason set when the TaskRun completed with a failure TaskRunReasonFailed TaskRunReason = "Failed" // TaskRunReasonToBeRetried is the reason set when the last TaskRun execution failed, and will be retried TaskRunReasonToBeRetried TaskRunReason = "ToBeRetried" // TaskRunReasonCancelled is the reason set when the TaskRun is cancelled by the user TaskRunReasonCancelled TaskRunReason = "TaskRunCancelled" // TaskRunReasonTimedOut is the reason set when one TaskRun execution has timed out TaskRunReasonTimedOut TaskRunReason = "TaskRunTimeout" // TaskRunReasonResolvingTaskRef indicates that the TaskRun is waiting for // its taskRef to be asynchronously resolved. TaskRunReasonResolvingTaskRef = "ResolvingTaskRef" // TaskRunReasonResolvingStepActionRef indicates that the TaskRun is waiting for // its StepAction's Ref to be asynchronously resolved. TaskRunReasonResolvingStepActionRef = "ResolvingStepActionRef" // TaskRunReasonImagePullFailed is the reason set when the step of a task fails due to image not being pulled TaskRunReasonImagePullFailed TaskRunReason = "TaskRunImagePullFailed" // TaskRunReasonResultLargerThanAllowedLimit is the reason set when one of the results exceeds its maximum allowed limit of 1 KB TaskRunReasonResultLargerThanAllowedLimit TaskRunReason = "TaskRunResultLargerThanAllowedLimit" // TaskRunReasonStopSidecarFailed indicates that the sidecar is not properly stopped. TaskRunReasonStopSidecarFailed TaskRunReason = "TaskRunStopSidecarFailed" // TaskRunReasonInvalidParamValue indicates that the TaskRun Param input value is not allowed. TaskRunReasonInvalidParamValue TaskRunReason = "InvalidParamValue" // TaskRunReasonFailedResolution indicated that the reason for failure status is // that references within the TaskRun could not be resolved TaskRunReasonFailedResolution TaskRunReason = "TaskRunResolutionFailed" // TaskRunReasonFailedValidation indicated that the reason for failure status is // that taskrun failed runtime validation TaskRunReasonFailedValidation TaskRunReason = "TaskRunValidationFailed" // TaskRunReasonTaskFailedValidation indicated that the reason for failure status is // that task failed runtime validation TaskRunReasonTaskFailedValidation TaskRunReason = "TaskValidationFailed" // TaskRunReasonResourceVerificationFailed indicates that the task fails the trusted resource verification, // it could be the content has changed, signature is invalid or public key is invalid TaskRunReasonResourceVerificationFailed TaskRunReason = "ResourceVerificationFailed" // TaskRunReasonFailureIgnored is the reason set when the Taskrun has failed due to pod execution error and the failure is ignored for the owning PipelineRun. // TaskRuns failed due to reconciler/validation error should not use this reason. TaskRunReasonFailureIgnored TaskRunReason = "FailureIgnored" )
func (TaskRunReason) String ¶ added in v0.40.0
func (t TaskRunReason) String() string
type TaskRunResult ¶
type TaskRunResult struct { // Name the given name Name string `json:"name"` // Type is the user-specified type of the result. The possible type // is currently "string" and will support "array" in following work. // +optional Type ResultsType `json:"type,omitempty"` // Value the given value of the result Value ResultValue `json:"value"` }
TaskRunResult used to describe the results of a task
func (*TaskRunResult) DeepCopy ¶
func (in *TaskRunResult) DeepCopy() *TaskRunResult
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TaskRunResult.
func (*TaskRunResult) DeepCopyInto ¶
func (in *TaskRunResult) DeepCopyInto(out *TaskRunResult)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TaskRunSidecarSpec ¶ added in v0.41.0
type TaskRunSidecarSpec struct { // The name of the Sidecar to override. Name string `json:"name"` // The resource requirements to apply to the Sidecar. ComputeResources corev1.ResourceRequirements `json:"computeResources"` }
TaskRunSidecarSpec is used to override the values of a Sidecar in the corresponding Task.
func (*TaskRunSidecarSpec) DeepCopy ¶ added in v0.41.0
func (in *TaskRunSidecarSpec) DeepCopy() *TaskRunSidecarSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TaskRunSidecarSpec.
func (*TaskRunSidecarSpec) DeepCopyInto ¶ added in v0.41.0
func (in *TaskRunSidecarSpec) DeepCopyInto(out *TaskRunSidecarSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TaskRunSpec ¶ added in v0.40.0
type TaskRunSpec struct { // +optional Debug *TaskRunDebug `json:"debug,omitempty"` // +optional // +listType=atomic Params Params `json:"params,omitempty"` // +optional ServiceAccountName string `json:"serviceAccountName"` // no more than one of the TaskRef and TaskSpec may be specified. // +optional TaskRef *TaskRef `json:"taskRef,omitempty"` // Specifying PipelineSpec can be disabled by setting // `disable-inline-spec` feature flag.. // +optional TaskSpec *TaskSpec `json:"taskSpec,omitempty"` // Used for cancelling a TaskRun (and maybe more later on) // +optional Status TaskRunSpecStatus `json:"status,omitempty"` // Status message for cancellation. // +optional StatusMessage TaskRunSpecStatusMessage `json:"statusMessage,omitempty"` // Retries represents how many times this TaskRun should be retried in the event of task failure. // +optional Retries int `json:"retries,omitempty"` // Time after which one retry attempt times out. Defaults to 1 hour. // Refer Go's ParseDuration documentation for expected format: https://golang.org/pkg/time/#ParseDuration // +optional Timeout *metav1.Duration `json:"timeout,omitempty"` // PodTemplate holds pod specific configuration PodTemplate *pod.PodTemplate `json:"podTemplate,omitempty"` // Workspaces is a list of WorkspaceBindings from volumes to workspaces. // +optional // +listType=atomic Workspaces []WorkspaceBinding `json:"workspaces,omitempty"` // Specs to apply to Steps in this TaskRun. // If a field is specified in both a Step and a StepSpec, // the value from the StepSpec will be used. // This field is only supported when the alpha feature gate is enabled. // +optional // +listType=atomic StepSpecs []TaskRunStepSpec `json:"stepSpecs,omitempty"` // Specs to apply to Sidecars in this TaskRun. // If a field is specified in both a Sidecar and a SidecarSpec, // the value from the SidecarSpec will be used. // This field is only supported when the alpha feature gate is enabled. // +optional // +listType=atomic SidecarSpecs []TaskRunSidecarSpec `json:"sidecarSpecs,omitempty"` // Compute resources to use for this TaskRun ComputeResources *corev1.ResourceRequirements `json:"computeResources,omitempty"` }
TaskRunSpec defines the desired state of TaskRun
func (*TaskRunSpec) DeepCopy ¶ added in v0.40.0
func (in *TaskRunSpec) DeepCopy() *TaskRunSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TaskRunSpec.
func (*TaskRunSpec) DeepCopyInto ¶ added in v0.40.0
func (in *TaskRunSpec) DeepCopyInto(out *TaskRunSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*TaskRunSpec) SetDefaults ¶ added in v0.40.0
func (trs *TaskRunSpec) SetDefaults(ctx context.Context)
SetDefaults implements apis.Defaultable
func (*TaskRunSpec) Validate ¶ added in v0.40.0
func (ts *TaskRunSpec) Validate(ctx context.Context) (errs *apis.FieldError)
Validate taskrun spec
type TaskRunSpecStatus ¶ added in v0.40.0
type TaskRunSpecStatus string
TaskRunSpecStatus defines the TaskRun spec status the user can provide
type TaskRunSpecStatusMessage ¶ added in v0.40.0
type TaskRunSpecStatusMessage string
TaskRunSpecStatusMessage defines human readable status messages for the TaskRun.
const ( // TaskRunCancelledByPipelineMsg indicates that the PipelineRun of which this // TaskRun was a part of has been cancelled. TaskRunCancelledByPipelineMsg TaskRunSpecStatusMessage = "TaskRun cancelled as the PipelineRun it belongs to has been cancelled." // TaskRunCancelledByPipelineTimeoutMsg indicates that the TaskRun was cancelled because the PipelineRun running it timed out. TaskRunCancelledByPipelineTimeoutMsg TaskRunSpecStatusMessage = "TaskRun cancelled as the PipelineRun it belongs to has timed out." )
type TaskRunStatus ¶ added in v0.40.0
type TaskRunStatus struct { duckv1.Status `json:",inline"` // TaskRunStatusFields inlines the status fields. TaskRunStatusFields `json:",inline"` }
TaskRunStatus defines the observed state of TaskRun
func (*TaskRunStatus) DeepCopy ¶ added in v0.40.0
func (in *TaskRunStatus) DeepCopy() *TaskRunStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TaskRunStatus.
func (*TaskRunStatus) DeepCopyInto ¶ added in v0.40.0
func (in *TaskRunStatus) DeepCopyInto(out *TaskRunStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*TaskRunStatus) GetCondition ¶ added in v0.40.0
func (trs *TaskRunStatus) GetCondition(t apis.ConditionType) *apis.Condition
GetCondition returns the Condition matching the given type.
func (*TaskRunStatus) GetRunningReason ¶ added in v0.40.0
func (trs *TaskRunStatus) GetRunningReason() string
GetRunningReason returns the reason set to the "Succeeded" condition when the TaskRun starts running. This is used indicate that the resource could be validated is starting to perform its job.
func (*TaskRunStatus) GetStartedReason ¶ added in v0.40.0
func (trs *TaskRunStatus) GetStartedReason() string
GetStartedReason returns the reason set to the "Succeeded" condition when InitializeConditions is invoked
func (*TaskRunStatus) InitializeConditions ¶ added in v0.40.0
func (trs *TaskRunStatus) InitializeConditions()
InitializeConditions will set all conditions in taskRunCondSet to unknown for the TaskRun and set the started time to the current time
func (*TaskRunStatus) MarkResourceFailed ¶ added in v0.40.0
func (trs *TaskRunStatus) MarkResourceFailed(reason TaskRunReason, err error)
MarkResourceFailed sets the ConditionSucceeded condition to ConditionFalse based on an error that occurred and a reason
func (*TaskRunStatus) MarkResourceOngoing ¶ added in v0.40.0
func (trs *TaskRunStatus) MarkResourceOngoing(reason TaskRunReason, message string)
MarkResourceOngoing sets the ConditionSucceeded condition to ConditionUnknown with the reason and message.
func (*TaskRunStatus) SetCondition ¶ added in v0.40.0
func (trs *TaskRunStatus) SetCondition(newCond *apis.Condition)
SetCondition sets the condition, unsetting previous conditions with the same type as necessary.
type TaskRunStatusFields ¶ added in v0.40.0
type TaskRunStatusFields struct { // PodName is the name of the pod responsible for executing this task's steps. PodName string `json:"podName"` // StartTime is the time the build is actually started. StartTime *metav1.Time `json:"startTime,omitempty"` // CompletionTime is the time the build completed. CompletionTime *metav1.Time `json:"completionTime,omitempty"` // Steps describes the state of each build step container. // +optional // +listType=atomic Steps []StepState `json:"steps,omitempty"` // RetriesStatus contains the history of TaskRunStatus in case of a retry in order to keep record of failures. // All TaskRunStatus stored in RetriesStatus will have no date within the RetriesStatus as is redundant. // +optional // +listType=atomic RetriesStatus []TaskRunStatus `json:"retriesStatus,omitempty"` // Results are the list of results written out by the task's containers // +optional // +listType=atomic Results []TaskRunResult `json:"results,omitempty"` // The list has one entry per sidecar in the manifest. Each entry is // represents the imageid of the corresponding sidecar. // +listType=atomic Sidecars []SidecarState `json:"sidecars,omitempty"` // TaskSpec contains the Spec from the dereferenced Task definition used to instantiate this TaskRun. TaskSpec *TaskSpec `json:"taskSpec,omitempty"` // Provenance contains some key authenticated metadata about how a software artifact was built (what sources, what inputs/outputs, etc.). // +optional Provenance *Provenance `json:"provenance,omitempty"` // SpanContext contains tracing span context fields SpanContext map[string]string `json:"spanContext,omitempty"` }
TaskRunStatusFields holds the fields of TaskRun's status. This is defined separately and inlined so that other types can readily consume these fields via duck typing.
func (*TaskRunStatusFields) DeepCopy ¶ added in v0.40.0
func (in *TaskRunStatusFields) DeepCopy() *TaskRunStatusFields
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TaskRunStatusFields.
func (*TaskRunStatusFields) DeepCopyInto ¶ added in v0.40.0
func (in *TaskRunStatusFields) DeepCopyInto(out *TaskRunStatusFields)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TaskRunStepArtifact ¶ added in v0.58.0
type TaskRunStepArtifact = Artifact
TaskRunStepArtifact represents an artifact produced or used by a step within a task run. It directly uses the Artifact type for its structure.
type TaskRunStepResult ¶ added in v0.54.0
type TaskRunStepResult = TaskRunResult
TaskRunStepResult is a type alias of TaskRunResult
type TaskRunStepSpec ¶ added in v0.41.0
type TaskRunStepSpec struct { // The name of the Step to override. Name string `json:"name"` // The resource requirements to apply to the Step. ComputeResources corev1.ResourceRequirements `json:"computeResources"` }
TaskRunStepSpec is used to override the values of a Step in the corresponding Task.
func (*TaskRunStepSpec) DeepCopy ¶ added in v0.41.0
func (in *TaskRunStepSpec) DeepCopy() *TaskRunStepSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TaskRunStepSpec.
func (*TaskRunStepSpec) DeepCopyInto ¶ added in v0.41.0
func (in *TaskRunStepSpec) DeepCopyInto(out *TaskRunStepSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TaskSpec ¶
type TaskSpec struct { // Params is a list of input parameters required to run the task. Params // must be supplied as inputs in TaskRuns unless they declare a default // value. // +optional // +listType=atomic Params ParamSpecs `json:"params,omitempty"` // DisplayName is a user-facing name of the task that may be // used to populate a UI. // +optional DisplayName string `json:"displayName,omitempty"` // Description is a user-facing description of the task that may be // used to populate a UI. // +optional Description string `json:"description,omitempty"` // Steps are the steps of the build; each step is run sequentially with the // source mounted into /workspace. // +listType=atomic Steps []Step `json:"steps,omitempty"` // Volumes is a collection of volumes that are available to mount into the // steps of the build. // +listType=atomic Volumes []corev1.Volume `json:"volumes,omitempty"` // StepTemplate can be used as the basis for all step containers within the // Task, so that the steps inherit settings on the base container. StepTemplate *StepTemplate `json:"stepTemplate,omitempty"` // Sidecars are run alongside the Task's step containers. They begin before // the steps start and end after the steps complete. // +listType=atomic Sidecars []Sidecar `json:"sidecars,omitempty"` // Workspaces are the volumes that this Task requires. // +listType=atomic Workspaces []WorkspaceDeclaration `json:"workspaces,omitempty"` // Results are values that this Task can output // +listType=atomic Results []TaskResult `json:"results,omitempty"` }
TaskSpec defines the desired state of Task.
func (*TaskSpec) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TaskSpec.
func (*TaskSpec) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*TaskSpec) GetIndexingReferencesToArrayParams ¶ added in v0.48.0
GetIndexingReferencesToArrayParams returns all strings referencing indices of TaskRun array parameters from parameters, workspaces, and when expressions defined in the Task. For example, if a Task has a parameter with a value "$(params.array-param-name[1])", this would be one of the strings returned.
func (*TaskSpec) SetDefaults ¶
SetDefaults set any defaults for the task spec
type TimeoutFields ¶ added in v0.40.0
type TimeoutFields struct { // Pipeline sets the maximum allowed duration for execution of the entire pipeline. The sum of individual timeouts for tasks and finally must not exceed this value. Pipeline *metav1.Duration `json:"pipeline,omitempty"` // Tasks sets the maximum allowed duration of this pipeline's tasks Tasks *metav1.Duration `json:"tasks,omitempty"` // Finally sets the maximum allowed duration of this pipeline's finally Finally *metav1.Duration `json:"finally,omitempty"` }
TimeoutFields allows granular specification of pipeline, task, and finally timeouts
func (*TimeoutFields) DeepCopy ¶ added in v0.40.0
func (in *TimeoutFields) DeepCopy() *TimeoutFields
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TimeoutFields.
func (*TimeoutFields) DeepCopyInto ¶ added in v0.40.0
func (in *TimeoutFields) DeepCopyInto(out *TimeoutFields)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type WhenExpression ¶ added in v0.39.0
type WhenExpression struct { // Input is the string for guard checking which can be a static input or an output from a parent Task Input string `json:"input,omitempty"` // Operator that represents an Input's relationship to the values Operator selection.Operator `json:"operator,omitempty"` // Values is an array of strings, which is compared against the input, for guard checking // It must be non-empty // +listType=atomic Values []string `json:"values,omitempty"` // 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 // +optional CEL string `json:"cel,omitempty"` }
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
func (*WhenExpression) DeepCopy ¶ added in v0.39.0
func (in *WhenExpression) DeepCopy() *WhenExpression
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WhenExpression.
func (*WhenExpression) DeepCopyInto ¶ added in v0.39.0
func (in *WhenExpression) DeepCopyInto(out *WhenExpression)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*WhenExpression) GetVarSubstitutionExpressions ¶ added in v0.39.0
func (we *WhenExpression) GetVarSubstitutionExpressions() ([]string, bool)
GetVarSubstitutionExpressions extracts all the values between "$(" and ")" in a When Expression
type WhenExpressions ¶ added in v0.39.0
type WhenExpressions []WhenExpression
WhenExpressions are used to specify whether a Task should be executed or skipped All of them need to evaluate to True for a guarded Task to be executed.
func (WhenExpressions) AllowsExecution ¶ added in v0.39.0
func (wes WhenExpressions) AllowsExecution(evaluatedCEL map[string]bool) bool
AllowsExecution evaluates an Input's relationship to an array of Values, based on the Operator, to determine whether all the When Expressions are True. If they are all True, the guarded Task is executed, otherwise it is skipped. If CEL expression exists, AllowsExecution will get the evaluated results from evaluatedCEL and determine if the Task should be skipped.
func (WhenExpressions) DeepCopy ¶ added in v0.39.0
func (in WhenExpressions) DeepCopy() WhenExpressions
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WhenExpressions.
func (WhenExpressions) DeepCopyInto ¶ added in v0.39.0
func (in WhenExpressions) DeepCopyInto(out *WhenExpressions)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (WhenExpressions) ReplaceVariables ¶ added in v0.48.0
func (wes WhenExpressions) ReplaceVariables(replacements map[string]string, arrayReplacements map[string][]string) WhenExpressions
ReplaceVariables interpolates variables, such as Parameters and Results, in the Input and Values.
type WorkspaceBinding ¶
type WorkspaceBinding struct { // Name is the name of the workspace populated by the volume. Name string `json:"name"` // 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). // +optional SubPath string `json:"subPath,omitempty"` // VolumeClaimTemplate is a template for a claim that will be created in the same namespace. // The PipelineRun controller is responsible for creating a unique claim for each instance of PipelineRun. // +optional VolumeClaimTemplate *corev1.PersistentVolumeClaim `json:"volumeClaimTemplate,omitempty"` // PersistentVolumeClaimVolumeSource represents a reference to a // PersistentVolumeClaim in the same namespace. Either this OR EmptyDir can be used. // +optional PersistentVolumeClaim *corev1.PersistentVolumeClaimVolumeSource `json:"persistentVolumeClaim,omitempty"` // EmptyDir represents a temporary directory that shares a Task's lifetime. // More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir // Either this OR PersistentVolumeClaim can be used. // +optional EmptyDir *corev1.EmptyDirVolumeSource `json:"emptyDir,omitempty"` // ConfigMap represents a configMap that should populate this workspace. // +optional ConfigMap *corev1.ConfigMapVolumeSource `json:"configMap,omitempty"` // Secret represents a secret that should populate this workspace. // +optional Secret *corev1.SecretVolumeSource `json:"secret,omitempty"` // Projected represents a projected volume that should populate this workspace. // +optional Projected *corev1.ProjectedVolumeSource `json:"projected,omitempty"` // CSI (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers. // +optional CSI *corev1.CSIVolumeSource `json:"csi,omitempty"` }
WorkspaceBinding maps a Task's declared workspace to a Volume.
func (*WorkspaceBinding) DeepCopy ¶
func (in *WorkspaceBinding) DeepCopy() *WorkspaceBinding
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WorkspaceBinding.
func (*WorkspaceBinding) DeepCopyInto ¶
func (in *WorkspaceBinding) DeepCopyInto(out *WorkspaceBinding)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*WorkspaceBinding) Validate ¶
func (b *WorkspaceBinding) Validate(ctx context.Context) (errs *apis.FieldError)
Validate looks at the Volume provided in wb and makes sure that it is valid. This means that only one VolumeSource can be specified, and also that the supported VolumeSource is itself valid.
type WorkspaceDeclaration ¶
type WorkspaceDeclaration struct { // Name is the name by which you can bind the volume at runtime. Name string `json:"name"` // Description is an optional human readable description of this volume. // +optional Description string `json:"description,omitempty"` // MountPath overrides the directory that the volume will be made available at. // +optional MountPath string `json:"mountPath,omitempty"` // ReadOnly dictates whether a mounted volume is writable. By default this // field is false and so mounted volumes are writable. ReadOnly bool `json:"readOnly,omitempty"` // Optional marks a Workspace as not being required in TaskRuns. By default // this field is false and so declared workspaces are required. Optional bool `json:"optional,omitempty"` }
WorkspaceDeclaration is a declaration of a volume that a Task requires.
func (*WorkspaceDeclaration) DeepCopy ¶
func (in *WorkspaceDeclaration) DeepCopy() *WorkspaceDeclaration
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WorkspaceDeclaration.
func (*WorkspaceDeclaration) DeepCopyInto ¶
func (in *WorkspaceDeclaration) DeepCopyInto(out *WorkspaceDeclaration)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*WorkspaceDeclaration) GetMountPath ¶
func (w *WorkspaceDeclaration) GetMountPath() string
GetMountPath returns the mountPath for w which is the MountPath if provided or the default if not.
type WorkspacePipelineDeclaration
deprecated
type WorkspacePipelineDeclaration = PipelineWorkspaceDeclaration
WorkspacePipelineDeclaration creates a named slot in a Pipeline that a PipelineRun is expected to populate with a workspace binding.
Deprecated: use PipelineWorkspaceDeclaration type instead
type WorkspacePipelineTaskBinding ¶
type WorkspacePipelineTaskBinding struct { // Name is the name of the workspace as declared by the task Name string `json:"name"` // Workspace is the name of the workspace declared by the pipeline // +optional Workspace string `json:"workspace,omitempty"` // 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). // +optional SubPath string `json:"subPath,omitempty"` }
WorkspacePipelineTaskBinding describes how a workspace passed into the pipeline should be mapped to a task's declared workspace.
func (*WorkspacePipelineTaskBinding) DeepCopy ¶
func (in *WorkspacePipelineTaskBinding) DeepCopy() *WorkspacePipelineTaskBinding
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WorkspacePipelineTaskBinding.
func (*WorkspacePipelineTaskBinding) DeepCopyInto ¶
func (in *WorkspacePipelineTaskBinding) DeepCopyInto(out *WorkspacePipelineTaskBinding)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type WorkspaceUsage ¶
type WorkspaceUsage struct { // Name is the name of the workspace this Step or Sidecar wants access to. Name string `json:"name"` // MountPath is the path that the workspace should be mounted to inside the Step or Sidecar, // overriding any MountPath specified in the Task's WorkspaceDeclaration. MountPath string `json:"mountPath"` }
WorkspaceUsage is used by a Step or Sidecar to declare that it wants isolated access to a Workspace defined in a Task.
func (*WorkspaceUsage) DeepCopy ¶
func (in *WorkspaceUsage) DeepCopy() *WorkspaceUsage
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WorkspaceUsage.
func (*WorkspaceUsage) DeepCopyInto ¶
func (in *WorkspaceUsage) DeepCopyInto(out *WorkspaceUsage)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
Source Files
¶
- artifact_types.go
- container_types.go
- container_validation.go
- doc.go
- matrix_types.go
- merge.go
- openapi_generated.go
- param_types.go
- pipeline_conversion.go
- pipeline_defaults.go
- pipeline_types.go
- pipeline_validation.go
- pipelineref_types.go
- pipelineref_validation.go
- pipelinerun_conversion.go
- pipelinerun_defaults.go
- pipelinerun_types.go
- pipelinerun_validation.go
- provenance.go
- register.go
- resolver_types.go
- result_defaults.go
- result_types.go
- result_validation.go
- resultref.go
- task_conversion.go
- task_defaults.go
- task_types.go
- task_validation.go
- taskref_types.go
- taskref_validation.go
- taskrun_conversion.go
- taskrun_defaults.go
- taskrun_types.go
- taskrun_validation.go
- when_types.go
- when_validation.go
- workspace_types.go
- workspace_validation.go
- zz_generated.deepcopy.go