Documentation
¶
Overview ¶
nolint: golint
Package v1alpha1 contains API Schema definitions for the pipeline v1alpha1 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
nolint: golint
nolint: golint
nolint: golint
nolint: golint
Index ¶
- Constants
- Variables
- func ApplyContainerReplacements(step *corev1.Container, stringReplacements map[string]string, ...)
- func ApplyStepReplacements(step *Step, stringReplacements map[string]string, ...)
- func ApplyTaskModifier(ts *TaskSpec, tm TaskModifier) error
- func InputResourcePath(r ResourceDeclaration) string
- func Kind(kind string) schema.GroupKind
- func OutputResourcePath(r ResourceDeclaration) string
- func Resource(resource string) schema.GroupResource
- func ValidateVolumes(volumes []corev1.Volume) *apis.FieldError
- type ArrayOrString
- type CannotConvertError
- type CloudEventCondition
- type CloudEventDelivery
- type CloudEventDeliveryState
- type ClusterTask
- func (sink *ClusterTask) ConvertDown(ctx context.Context, obj apis.Convertible) error
- func (source *ClusterTask) ConvertUp(ctx context.Context, obj apis.Convertible) error
- func (t *ClusterTask) Copy() TaskInterface
- func (in *ClusterTask) DeepCopy() *ClusterTask
- func (in *ClusterTask) DeepCopyInto(out *ClusterTask)
- func (in *ClusterTask) DeepCopyObject() runtime.Object
- func (t *ClusterTask) SetDefaults(ctx context.Context)
- func (t *ClusterTask) TaskMetadata() metav1.ObjectMeta
- func (t *ClusterTask) TaskSpec() TaskSpec
- func (t *ClusterTask) Validate(ctx context.Context) *apis.FieldError
- type ClusterTaskList
- type Condition
- type ConditionCheck
- type ConditionCheckStatus
- type ConditionCheckStatusFields
- type ConditionList
- type ConditionSpec
- type Inputs
- type InternalTaskModifier
- type Outputs
- type Param
- type ParamSpec
- type ParamType
- type Pipeline
- func (sink *Pipeline) ConvertDown(ctx context.Context, obj apis.Convertible) error
- func (source *Pipeline) ConvertUp(ctx context.Context, obj apis.Convertible) error
- func (p *Pipeline) Copy() PipelineInterface
- func (in *Pipeline) DeepCopy() *Pipeline
- func (in *Pipeline) DeepCopyInto(out *Pipeline)
- func (in *Pipeline) DeepCopyObject() runtime.Object
- func (p *Pipeline) PipelineMetadata() metav1.ObjectMeta
- func (p *Pipeline) PipelineSpec() PipelineSpec
- func (p *Pipeline) SetDefaults(ctx context.Context)
- func (p *Pipeline) Validate(ctx context.Context) *apis.FieldError
- type PipelineDeclaredResource
- type PipelineInterface
- type PipelineList
- type PipelineRef
- type PipelineResource
- type PipelineResourceBinding
- type PipelineResourceInterface
- type PipelineResourceList
- type PipelineResourceRef
- type PipelineResourceResult
- type PipelineResourceSpec
- type PipelineResourceType
- type PipelineRun
- func (sink *PipelineRun) ConvertDown(ctx context.Context, obj apis.Convertible) error
- func (source *PipelineRun) ConvertUp(ctx context.Context, obj apis.Convertible) error
- func (in *PipelineRun) DeepCopy() *PipelineRun
- func (in *PipelineRun) DeepCopyInto(out *PipelineRun)
- func (in *PipelineRun) DeepCopyObject() runtime.Object
- func (pr *PipelineRun) GetOwnerReference() []metav1.OwnerReference
- func (pr *PipelineRun) GetRunKey() string
- func (pr *PipelineRun) GetServiceAccountName(pipelineTaskName string) string
- func (pr *PipelineRun) GetTaskRunRef() corev1.ObjectReference
- func (pr *PipelineRun) HasStarted() bool
- func (pr *PipelineRun) IsCancelled() bool
- func (pr *PipelineRun) IsDone() bool
- func (pr *PipelineRun) IsTimedOut() bool
- func (pr *PipelineRun) SetDefaults(ctx context.Context)
- func (pr *PipelineRun) Validate(ctx context.Context) *apis.FieldError
- type PipelineRunConditionCheckStatus
- type PipelineRunList
- type PipelineRunSpec
- func (sink *PipelineRunSpec) ConvertDown(ctx context.Context, source *v1beta1.PipelineRunSpec) error
- func (source *PipelineRunSpec) ConvertUp(ctx context.Context, sink *v1beta1.PipelineRunSpec) error
- func (in *PipelineRunSpec) DeepCopy() *PipelineRunSpec
- func (in *PipelineRunSpec) DeepCopyInto(out *PipelineRunSpec)
- func (prs *PipelineRunSpec) SetDefaults(ctx context.Context)
- func (ps *PipelineRunSpec) Validate(ctx context.Context) *apis.FieldError
- type PipelineRunSpecServiceAccountName
- type PipelineRunSpecStatus
- type PipelineRunStatus
- type PipelineRunStatusFields
- type PipelineRunTaskRunStatus
- type PipelineSpec
- func (sink *PipelineSpec) ConvertDown(ctx context.Context, source v1beta1.PipelineSpec) error
- func (source *PipelineSpec) ConvertUp(ctx context.Context, sink *v1beta1.PipelineSpec) error
- func (in *PipelineSpec) DeepCopy() *PipelineSpec
- func (in *PipelineSpec) DeepCopyInto(out *PipelineSpec)
- func (ps *PipelineSpec) SetDefaults(ctx context.Context)
- func (ps *PipelineSpec) Validate(ctx context.Context) *apis.FieldError
- type PipelineStatus
- type PipelineTask
- func (sink *PipelineTask) ConvertDown(ctx context.Context, source v1beta1.PipelineTask) error
- func (source *PipelineTask) ConvertUp(ctx context.Context, sink *v1beta1.PipelineTask) error
- func (in *PipelineTask) DeepCopy() *PipelineTask
- func (in *PipelineTask) DeepCopyInto(out *PipelineTask)
- func (pt PipelineTask) Deps() []string
- func (pt PipelineTask) HashKey() string
- type PipelineTaskCondition
- type PipelineTaskInputResource
- type PipelineTaskList
- type PipelineTaskOutputResource
- type PipelineTaskParam
- type PipelineTaskResources
- type PipelineTaskRun
- type PodTemplate
- type ResourceDeclaration
- type ResourceParam
- type ResultType
- type SecretParam
- type Sidecar
- type SidecarState
- type Step
- type StepState
- type Task
- func (sink *Task) ConvertDown(ctx context.Context, obj apis.Convertible) error
- func (source *Task) ConvertUp(ctx context.Context, obj apis.Convertible) error
- func (t *Task) Copy() TaskInterface
- func (in *Task) DeepCopy() *Task
- func (in *Task) DeepCopyInto(out *Task)
- func (in *Task) DeepCopyObject() runtime.Object
- func (t *Task) SetDefaults(ctx context.Context)
- func (t *Task) TaskMetadata() metav1.ObjectMeta
- func (t *Task) TaskSpec() TaskSpec
- func (t *Task) Validate(ctx context.Context) *apis.FieldError
- type TaskInterface
- type TaskKind
- type TaskList
- type TaskModifier
- type TaskRef
- type TaskResource
- type TaskResourceBinding
- type TaskResult
- type TaskRun
- func (sink *TaskRun) ConvertDown(ctx context.Context, obj apis.Convertible) error
- func (source *TaskRun) ConvertUp(ctx context.Context, obj apis.Convertible) error
- func (in *TaskRun) DeepCopy() *TaskRun
- func (in *TaskRun) DeepCopyInto(out *TaskRun)
- func (in *TaskRun) DeepCopyObject() runtime.Object
- func (tr *TaskRun) GetBuildPodRef() corev1.ObjectReference
- func (tr *TaskRun) GetPipelineRunPVCName() string
- func (tr *TaskRun) GetRunKey() string
- func (tr *TaskRun) HasPipelineRunOwnerReference() bool
- func (tr *TaskRun) HasStarted() bool
- func (tr *TaskRun) IsCancelled() bool
- func (tr *TaskRun) IsDone() bool
- func (tr *TaskRun) IsPartOfPipeline() (bool, string, string)
- func (tr *TaskRun) IsSuccessful() bool
- func (tr *TaskRun) SetDefaults(ctx context.Context)
- func (tr *TaskRun) Validate(ctx context.Context) *apis.FieldError
- type TaskRunInputs
- type TaskRunList
- type TaskRunOutputs
- type TaskRunResult
- type TaskRunSpec
- func (sink *TaskRunSpec) ConvertDown(ctx context.Context, source *v1beta1.TaskRunSpec) error
- func (source *TaskRunSpec) ConvertUp(ctx context.Context, sink *v1beta1.TaskRunSpec) error
- func (in *TaskRunSpec) DeepCopy() *TaskRunSpec
- func (in *TaskRunSpec) DeepCopyInto(out *TaskRunSpec)
- func (trs *TaskRunSpec) SetDefaults(ctx context.Context)
- func (ts *TaskRunSpec) Validate(ctx context.Context) *apis.FieldError
- type TaskRunSpecStatus
- type TaskRunStatus
- type TaskRunStatusFields
- type TaskSpec
- func (sink *TaskSpec) ConvertDown(ctx context.Context, source *v1beta1.TaskSpec) error
- func (source *TaskSpec) ConvertUp(ctx context.Context, sink *v1beta1.TaskSpec) error
- func (in *TaskSpec) DeepCopy() *TaskSpec
- func (in *TaskSpec) DeepCopyInto(out *TaskSpec)
- func (ts *TaskSpec) SetDefaults(ctx context.Context)
- func (ts *TaskSpec) Validate(ctx context.Context) *apis.FieldError
- type TestResult
- type WorkspaceBinding
- type WorkspaceDeclaration
- type WorkspacePipelineDeclaration
- type WorkspacePipelineTaskBinding
Constants ¶
const ( // ConditionTypeConvertible is a Warning condition that is set on // resources when they cannot be converted to warn of a forthcoming // breakage. ConditionTypeConvertible apis.ConditionType = v1beta1.ConditionTypeConvertible )
const ( // PipelineRunSpecStatusCancelled indicates that the user wants to cancel the task, // if not already cancelled or terminated PipelineRunSpecStatusCancelled = v1beta1.PipelineRunSpecStatusCancelled )
const ( // TaskRunSpecStatusCancelled indicates that the user wants to cancel the task, // if not already cancelled or terminated TaskRunSpecStatusCancelled = v1beta1.TaskRunSpecStatusCancelled )
Variables ¶
var (
// AddToScheme adds Build types to the scheme.
AddToScheme = schemeBuilder.AddToScheme
)
var AllParamTypes = v1beta1.AllParamTypes
AllParamTypes can be used for ParamType validation.
var AllResourceTypes = resource.AllResourceTypes
AllResourceTypes can be used for validation to check if a provided Resource type is one of the known types.
var (
AllowedOutputResources = resource.AllowedOutputResources
)
var ConvertErrorf = v1beta1.ConvertErrorf
ConvertErrorf creates a CannotConvertError from the field name and format string.
var SchemeGroupVersion = schema.GroupVersion{Group: pipeline.GroupName, Version: "v1alpha1"}
SchemeGroupVersion is group version used to register these objects
Functions ¶
func ApplyContainerReplacements ¶ added in v0.10.0
func ApplyStepReplacements ¶ added in v0.6.0
func ApplyTaskModifier ¶ added in v0.8.0
func ApplyTaskModifier(ts *TaskSpec, tm TaskModifier) error
ApplyTaskModifier applies a modifier to the task by appending and prepending steps and volumes. If steps with the same name exist in ts an error will be returned. If identical Volumes have been added, they will not be added again. If Volumes with the same name but different contents have been added, an error will be returned. FIXME(vdemeester) de-duplicate this
func InputResourcePath ¶ added in v0.7.0
func InputResourcePath(r ResourceDeclaration) string
InputResourcePath returns the path where the given input resource will get mounted in a Pod
func OutputResourcePath ¶ added in v0.7.0
func OutputResourcePath(r ResourceDeclaration) string
OutputResourcePath returns the path to the output resouce in a Pod
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns a Group qualified GroupResource
func ValidateVolumes ¶ added in v0.2.0
func ValidateVolumes(volumes []corev1.Volume) *apis.FieldError
Types ¶
type ArrayOrString ¶ added in v0.6.0
type ArrayOrString = v1beta1.ArrayOrString
ArrayOrString is a type that can hold a single string or string array. Used in JSON unmarshalling so that a single JSON field can accept either an individual string or an array of strings.
type CannotConvertError ¶ added in v0.11.0
type CannotConvertError = v1beta1.CannotConvertError
CannotConvertError is returned when a field cannot be converted.
type CloudEventCondition ¶ added in v0.6.0
type CloudEventCondition = v1beta1.CloudEventCondition
CloudEventCondition is a string that represents the condition of the event.
const ( // CloudEventConditionUnknown means that the condition for the event to be // triggered was not met yet, or we don't know the state yet. CloudEventConditionUnknown CloudEventCondition = v1beta1.CloudEventConditionUnknown // CloudEventConditionSent means that the event was sent successfully CloudEventConditionSent CloudEventCondition = v1beta1.CloudEventConditionSent // CloudEventConditionFailed means that there was one or more attempts to // send the event, and none was successful so far. CloudEventConditionFailed CloudEventCondition = v1beta1.CloudEventConditionFailed )
type CloudEventDelivery ¶ added in v0.6.0
type CloudEventDelivery = v1beta1.CloudEventDelivery
CloudEventDelivery is the target of a cloud event along with the state of delivery.
type CloudEventDeliveryState ¶ added in v0.6.0
type CloudEventDeliveryState = v1beta1.CloudEventDeliveryState
CloudEventDeliveryState reports the state of a cloud event to be sent.
type ClusterTask ¶
type ClusterTask struct { metav1.TypeMeta `json:",inline"` // +optional metav1.ObjectMeta `json:"metadata,omitempty"` // Spec holds the desired state of the Task from the client // +optional Spec TaskSpec `json:"spec,omitempty"` }
ClusterTask is a Task with a cluster scope. ClusterTasks are used to represent Tasks that should be publicly addressable from any namespace in the cluster.
func (*ClusterTask) ConvertDown ¶ added in v0.11.0
func (sink *ClusterTask) ConvertDown(ctx context.Context, obj apis.Convertible) error
ConvertDown implements api.Convertible
func (*ClusterTask) ConvertUp ¶ added in v0.11.0
func (source *ClusterTask) ConvertUp(ctx context.Context, obj apis.Convertible) error
ConvertUp implements api.Convertible
func (*ClusterTask) Copy ¶
func (t *ClusterTask) Copy() TaskInterface
func (*ClusterTask) DeepCopy ¶
func (in *ClusterTask) DeepCopy() *ClusterTask
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterTask.
func (*ClusterTask) DeepCopyInto ¶
func (in *ClusterTask) DeepCopyInto(out *ClusterTask)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ClusterTask) DeepCopyObject ¶
func (in *ClusterTask) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*ClusterTask) SetDefaults ¶
func (t *ClusterTask) SetDefaults(ctx context.Context)
func (*ClusterTask) TaskMetadata ¶
func (t *ClusterTask) TaskMetadata() metav1.ObjectMeta
func (*ClusterTask) TaskSpec ¶
func (t *ClusterTask) TaskSpec() TaskSpec
func (*ClusterTask) Validate ¶
func (t *ClusterTask) Validate(ctx context.Context) *apis.FieldError
type ClusterTaskList ¶
type ClusterTaskList struct { metav1.TypeMeta `json:",inline"` // +optional metav1.ListMeta `json:"metadata,omitempty"` Items []ClusterTask `json:"items"` }
ClusterTaskList contains a list of ClusterTask
func (*ClusterTaskList) DeepCopy ¶
func (in *ClusterTaskList) DeepCopy() *ClusterTaskList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterTaskList.
func (*ClusterTaskList) DeepCopyInto ¶
func (in *ClusterTaskList) DeepCopyInto(out *ClusterTaskList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ClusterTaskList) DeepCopyObject ¶
func (in *ClusterTaskList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type Condition ¶ added in v0.6.0
type Condition struct { metav1.TypeMeta `json:",inline"` // +optional metav1.ObjectMeta `json:"metadata"` // Spec holds the desired state of the Condition from the client // +optional Spec ConditionSpec `json:"spec"` }
Condition declares a step that is used to gate the execution of a Task in a Pipeline. A condition execution (ConditionCheck) evaluates to either true or false +k8s:openapi-gen=true
func (*Condition) DeepCopy ¶ added in v0.6.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Condition.
func (*Condition) DeepCopyInto ¶ added in v0.6.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Condition) DeepCopyObject ¶ added in v0.6.0
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Condition) SetDefaults ¶ added in v0.6.0
type ConditionCheck ¶ added in v0.6.0
type ConditionCheck TaskRun
ConditionCheck represents a single evaluation of a Condition step.
func NewConditionCheck ¶ added in v0.6.0
func NewConditionCheck(tr *TaskRun) *ConditionCheck
func (*ConditionCheck) DeepCopy ¶ added in v0.6.0
func (in *ConditionCheck) DeepCopy() *ConditionCheck
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConditionCheck.
func (*ConditionCheck) DeepCopyInto ¶ added in v0.6.0
func (in *ConditionCheck) DeepCopyInto(out *ConditionCheck)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ConditionCheck) IsDone ¶ added in v0.6.0
func (cc *ConditionCheck) IsDone() bool
IsDone returns true if the ConditionCheck's status indicates that it is done.
func (*ConditionCheck) IsSuccessful ¶ added in v0.6.0
func (cc *ConditionCheck) IsSuccessful() bool
IsSuccessful returns true if the ConditionCheck's status indicates that it is done.
type ConditionCheckStatus ¶ added in v0.6.0
type ConditionCheckStatus = v1beta1.ConditionCheckStatus
ConditionCheckStatus defines the observed state of ConditionCheck
type ConditionCheckStatusFields ¶ added in v0.10.0
type ConditionCheckStatusFields = v1beta1.ConditionCheckStatusFields
ConditionCheckStatusFields holds the fields of ConfigurationCheck's status. This is defined separately and inlined so that other types can readily consume these fields via duck typing.
type ConditionList ¶ added in v0.6.0
type ConditionList struct { metav1.TypeMeta `json:",inline"` // +optional metav1.ListMeta `json:"metadata,omitempty"` Items []Condition `json:"items"` }
ConditionList contains a list of Conditions
func (*ConditionList) DeepCopy ¶ added in v0.6.0
func (in *ConditionList) DeepCopy() *ConditionList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConditionList.
func (*ConditionList) DeepCopyInto ¶ added in v0.6.0
func (in *ConditionList) DeepCopyInto(out *ConditionList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ConditionList) DeepCopyObject ¶ added in v0.6.0
func (in *ConditionList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ConditionSpec ¶ added in v0.6.0
type ConditionSpec struct { // Check declares container whose exit code determines where a condition is true or false Check Step `json:"check,omitempty"` // Params is an optional set of parameters which must be supplied by the user when a Condition // is evaluated // +optional Params []ParamSpec `json:"params,omitempty"` // Resources is a list of the ConditionResources required to run the condition. // +optional Resources []ResourceDeclaration `json:"resources,omitempty"` }
ConditionSpec defines the desired state of the Condition
func (*ConditionSpec) DeepCopy ¶ added in v0.6.0
func (in *ConditionSpec) DeepCopy() *ConditionSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConditionSpec.
func (*ConditionSpec) DeepCopyInto ¶ added in v0.6.0
func (in *ConditionSpec) DeepCopyInto(out *ConditionSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ConditionSpec) SetDefaults ¶ added in v0.6.0
func (cs *ConditionSpec) SetDefaults(ctx context.Context)
func (*ConditionSpec) Validate ¶ added in v0.6.0
func (cs *ConditionSpec) Validate(ctx context.Context) *apis.FieldError
type Inputs ¶
type Inputs struct { // Resources is a list of the input resources required to run the task. // Resources are represented in TaskRuns as bindings to instances of // PipelineResources. // +optional Resources []TaskResource `json:"resources,omitempty"` // 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 Params []ParamSpec `json:"params,omitempty"` }
Inputs are the requirements that a task needs to run a Build.
func (*Inputs) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Inputs.
func (*Inputs) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Inputs) SetDefaults ¶ added in v0.6.0
type InternalTaskModifier ¶ added in v0.8.0
type InternalTaskModifier = v1beta1.InternalTaskModifier
InternalTaskModifier implements TaskModifier for resources that are built-in to Tekton Pipelines.
type Outputs ¶
type Outputs struct { // +optional Results []TestResult `json:"results,omitempty"` // +optional Resources []TaskResource `json:"resources,omitempty"` }
Outputs allow a task to declare what data the Build/Task will be producing, i.e. results such as logs and artifacts such as images.
func (*Outputs) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Outputs.
func (*Outputs) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ParamSpec ¶ added in v0.5.0
ParamSpec defines arbitrary parameters needed beyond typed inputs (such as resources). Parameter values are provided by users as inputs on a TaskRun or PipelineRun.
type ParamType ¶ added in v0.6.0
ParamType indicates the type of an input parameter; Used to distinguish between a single string and an array of strings.
const ( ParamTypeString ParamType = v1beta1.ParamTypeString ParamTypeArray ParamType = v1beta1.ParamTypeArray )
Valid ParamTypes:
type Pipeline ¶
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"` // Status is deprecated. // It usually is used to communicate the observed state of the Pipeline from // the controller, but was unused as there is no controller for Pipeline. // +optional Status *PipelineStatus `json:"status,omitempty"` }
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) ConvertDown ¶ added in v0.11.0
ConvertDown implements api.Convertible
func (*Pipeline) Copy ¶ added in v0.8.0
func (p *Pipeline) Copy() PipelineInterface
func (*Pipeline) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Pipeline.
func (*Pipeline) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Pipeline) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Pipeline) PipelineMetadata ¶ added in v0.8.0
func (p *Pipeline) PipelineMetadata() metav1.ObjectMeta
func (*Pipeline) PipelineSpec ¶ added in v0.8.0
func (p *Pipeline) PipelineSpec() PipelineSpec
func (*Pipeline) SetDefaults ¶
type PipelineDeclaredResource ¶
type PipelineDeclaredResource = v1beta1.PipelineDeclaredResource
PipelineDeclaredResource is used by a Pipeline to declare the types of the PipelineResources that it will required to run and names which can be used to refer to these PipelineResources in PipelineTaskResourceBindings.
type PipelineInterface ¶ added in v0.8.0
type PipelineInterface interface { PipelineMetadata() metav1.ObjectMeta PipelineSpec() PipelineSpec Copy() PipelineInterface }
PipelineInterface is implemented by Pipeline and ClusterPipeline
type PipelineList ¶
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 ¶
func (in *PipelineList) DeepCopy() *PipelineList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PipelineList.
func (*PipelineList) DeepCopyInto ¶
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 ¶
func (in *PipelineList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type PipelineRef ¶
type PipelineRef = v1beta1.PipelineRef
PipelineRef can be used to refer to a specific instance of a Pipeline. Copied from CrossVersionObjectReference: https://github.com/kubernetes/kubernetes/blob/169df7434155cbbc22f1532cba8e0a9588e29ad8/pkg/apis/autoscaling/types.go#L64
type PipelineResource ¶
type PipelineResource = resource.PipelineResource
PipelineResource describes a resource that is an input to or output from a Task.
type PipelineResourceBinding ¶
type PipelineResourceBinding = v1beta1.PipelineResourceBinding
PipelineResourceBinding connects a reference to an instance of a PipelineResource with a PipelineResource dependency that the Pipeline has declared
type PipelineResourceInterface ¶
type PipelineResourceInterface interface { // GetName returns the name of this PipelineResource instance. GetName() string // GetType returns the type of this PipelineResource (often a super type, e.g. in the case of storage). GetType() PipelineResourceType // Replacements returns all the attributes that this PipelineResource has that // can be used for variable replacement. Replacements() map[string]string // GetOutputTaskModifier returns the TaskModifier instance that should be used on a Task // in order to add this kind of resource when it is being used as an output. GetOutputTaskModifier(ts *TaskSpec, path string) (TaskModifier, error) // GetInputTaskModifier returns the TaskModifier instance that should be used on a Task // in order to add this kind of resource when it is being used as an input. GetInputTaskModifier(ts *TaskSpec, path string) (TaskModifier, error) }
PipelineResourceInterface interface to be implemented by different PipelineResource types
type PipelineResourceList ¶
type PipelineResourceList = resource.PipelineResourceList
PipelineResourceList contains a list of PipelineResources
type PipelineResourceRef ¶
type PipelineResourceRef = v1beta1.PipelineResourceRef
PipelineResourceRef can be used to refer to a specific instance of a Resource
type PipelineResourceResult ¶ added in v0.4.0
type PipelineResourceResult = v1beta1.PipelineResourceResult
PipelineResourceResult used to export the image name and digest as json
type PipelineResourceSpec ¶
type PipelineResourceSpec = resource.PipelineResourceSpec
PipelineResourceSpec defines an individual resources used in the pipeline.
type PipelineResourceType ¶
type PipelineResourceType = resource.PipelineResourceType
PipelineResourceType represents the type of endpoint the pipelineResource is, so that the controller will know this pipelineResource should be fetched and optionally what additional metatdata should be provided for it.
const ( // PipelineResourceTypeGit indicates that this source is a GitHub repo. PipelineResourceTypeGit PipelineResourceType = resource.PipelineResourceTypeGit // PipelineResourceTypeStorage indicates that this source is a storage blob resource. PipelineResourceTypeStorage PipelineResourceType = resource.PipelineResourceTypeStorage // PipelineResourceTypeImage indicates that this source is a docker Image. PipelineResourceTypeImage PipelineResourceType = resource.PipelineResourceTypeImage // PipelineResourceTypeCluster indicates that this source is a k8s cluster Image. PipelineResourceTypeCluster PipelineResourceType = resource.PipelineResourceTypeCluster // PipelineResourceTypePullRequest indicates that this source is a SCM Pull Request. PipelineResourceTypePullRequest PipelineResourceType = resource.PipelineResourceTypePullRequest // PipelineResourceTypeCloudEvent indicates that this source is a cloud event URI PipelineResourceTypeCloudEvent PipelineResourceType = resource.PipelineResourceTypeCloudEvent )
const ( // PipelineResourceTypeGCS is the subtype for the GCSResources, which is backed by a GCS blob/directory. PipelineResourceTypeGCS PipelineResourceType = resource.PipelineResourceTypeGCS // PipelineResourceTypeBuildGCS is the subtype for the BuildGCSResources, which is simialr to the GCSResource but // with additional functionality that was added to be compatible with knative build. PipelineResourceTypeBuildGCS PipelineResourceType = resource.PipelineResourceTypeBuildGCS )
type PipelineRun ¶
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) ConvertDown ¶ added in v0.11.0
func (sink *PipelineRun) ConvertDown(ctx context.Context, obj apis.Convertible) error
ConvertDown implements api.Convertible
func (*PipelineRun) ConvertUp ¶ added in v0.11.0
func (source *PipelineRun) ConvertUp(ctx context.Context, obj apis.Convertible) error
ConvertUp implements api.Convertible
func (*PipelineRun) DeepCopy ¶
func (in *PipelineRun) DeepCopy() *PipelineRun
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PipelineRun.
func (*PipelineRun) DeepCopyInto ¶
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 ¶
func (in *PipelineRun) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*PipelineRun) GetOwnerReference ¶
func (pr *PipelineRun) GetOwnerReference() []metav1.OwnerReference
GetOwnerReference gets the pipeline run as owner reference for any related objects
func (*PipelineRun) GetRunKey ¶ added in v0.2.0
func (pr *PipelineRun) GetRunKey() string
GetRunKey return the pipelinerun key for timeout handler map
func (*PipelineRun) GetServiceAccountName ¶ added in v0.8.0
func (pr *PipelineRun) GetServiceAccountName(pipelineTaskName string) string
GetServiceAccountName returns the service account name for a given PipelineTask if configured, otherwise it returns the PipelineRun's serviceAccountName.
func (*PipelineRun) GetTaskRunRef ¶
func (pr *PipelineRun) GetTaskRunRef() corev1.ObjectReference
GetTaskRunRef for pipelinerun
func (*PipelineRun) HasStarted ¶ added in v0.2.0
func (pr *PipelineRun) HasStarted() bool
HasStarted function check whether pipelinerun has valid start time set in its status
func (*PipelineRun) IsCancelled ¶ added in v0.2.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.2.0
func (pr *PipelineRun) IsDone() bool
IsDone returns true if the PipelineRun's status indicates that it is done.
func (*PipelineRun) IsTimedOut ¶ added in v0.6.0
func (pr *PipelineRun) IsTimedOut() bool
IsTimedOut returns true if a pipelinerun has exceeded its spec.Timeout based on its status.Timeout
func (*PipelineRun) SetDefaults ¶
func (pr *PipelineRun) SetDefaults(ctx context.Context)
func (*PipelineRun) Validate ¶
func (pr *PipelineRun) Validate(ctx context.Context) *apis.FieldError
Validate pipelinerun
type PipelineRunConditionCheckStatus ¶ added in v0.6.0
type PipelineRunConditionCheckStatus = v1beta1.PipelineRunConditionCheckStatus
type PipelineRunList ¶
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 ¶
func (in *PipelineRunList) DeepCopy() *PipelineRunList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PipelineRunList.
func (*PipelineRunList) DeepCopyInto ¶
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 ¶
func (in *PipelineRunList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type PipelineRunSpec ¶
type PipelineRunSpec struct { // +optional PipelineRef *PipelineRef `json:"pipelineRef,omitempty"` // +optional PipelineSpec *PipelineSpec `json:"pipelineSpec,omitempty"` // Resources is a list of bindings specifying which actual instances of // PipelineResources to use for the resources the Pipeline has declared // it needs. Resources []PipelineResourceBinding `json:"resources,omitempty"` // Params is a list of parameter names and values. Params []Param `json:"params,omitempty"` // +optional ServiceAccountName string `json:"serviceAccountName,omitempty"` // +optional ServiceAccountNames []PipelineRunSpecServiceAccountName `json:"serviceAccountNames,omitempty"` // Used for cancelling a pipelinerun (and maybe more later on) // +optional Status PipelineRunSpecStatus `json:"status,omitempty"` // Time after which the Pipeline 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"` // PodTemplate holds pod specific configuration PodTemplate *PodTemplate `json:"podTemplate,omitempty"` // Workspaces holds a set of workspace bindings that must match names // with those declared in the pipeline. // +optional Workspaces []WorkspaceBinding `json:"workspaces,omitempty"` }
PipelineRunSpec defines the desired state of PipelineRun
func (*PipelineRunSpec) ConvertDown ¶ added in v0.11.0
func (sink *PipelineRunSpec) ConvertDown(ctx context.Context, source *v1beta1.PipelineRunSpec) error
func (*PipelineRunSpec) ConvertUp ¶ added in v0.11.0
func (source *PipelineRunSpec) ConvertUp(ctx context.Context, sink *v1beta1.PipelineRunSpec) error
func (*PipelineRunSpec) DeepCopy ¶
func (in *PipelineRunSpec) DeepCopy() *PipelineRunSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PipelineRunSpec.
func (*PipelineRunSpec) DeepCopyInto ¶
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.5.0
func (prs *PipelineRunSpec) SetDefaults(ctx context.Context)
func (*PipelineRunSpec) Validate ¶
func (ps *PipelineRunSpec) Validate(ctx context.Context) *apis.FieldError
Validate pipelinerun spec
type PipelineRunSpecServiceAccountName ¶ added in v0.8.0
type PipelineRunSpecServiceAccountName = v1beta1.PipelineRunSpecServiceAccountName
PipelineRunSpecServiceAccountName can be used to configure specific ServiceAccountName for a concrete Task
type PipelineRunSpecStatus ¶
type PipelineRunSpecStatus = v1beta1.PipelineRunSpecStatus
PipelineRunSpecStatus defines the pipelinerun spec status the user can provide
type PipelineRunStatus ¶
type PipelineRunStatus = v1beta1.PipelineRunStatus
PipelineRunStatus defines the observed state of PipelineRun
type PipelineRunStatusFields ¶ added in v0.10.0
type PipelineRunStatusFields = v1beta1.PipelineRunStatusFields
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.
type PipelineRunTaskRunStatus ¶ added in v0.2.0
type PipelineRunTaskRunStatus = v1beta1.PipelineRunTaskRunStatus
PipelineRunTaskRunStatus contains the name of the PipelineTask for this TaskRun and the TaskRun's Status
type PipelineSpec ¶
type PipelineSpec struct { // Resources declares the names and types of the resources given to the // Pipeline's tasks as inputs and outputs. Resources []PipelineDeclaredResource `json:"resources,omitempty"` // Tasks declares the graph of Tasks that execute when this Pipeline is run. Tasks []PipelineTask `json:"tasks,omitempty"` // Params declares a list of input parameters that must be supplied when // this Pipeline is run. Params []ParamSpec `json:"params,omitempty"` // Workspaces declares a set of named workspaces that are expected to be // provided by a PipelineRun. // +optional Workspaces []WorkspacePipelineDeclaration `json:"workspaces,omitempty"` }
PipelineSpec defines the desired state of Pipeline.
func (*PipelineSpec) ConvertDown ¶ added in v0.11.0
func (sink *PipelineSpec) ConvertDown(ctx context.Context, source v1beta1.PipelineSpec) error
func (*PipelineSpec) ConvertUp ¶ added in v0.11.0
func (source *PipelineSpec) ConvertUp(ctx context.Context, sink *v1beta1.PipelineSpec) error
func (*PipelineSpec) DeepCopy ¶
func (in *PipelineSpec) DeepCopy() *PipelineSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PipelineSpec.
func (*PipelineSpec) DeepCopyInto ¶
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) SetDefaults ¶
func (ps *PipelineSpec) SetDefaults(ctx context.Context)
func (*PipelineSpec) Validate ¶
func (ps *PipelineSpec) Validate(ctx context.Context) *apis.FieldError
Validate checks that taskNames in the Pipeline are valid and that the graph of Tasks expressed in the Pipeline makes sense.
type PipelineStatus ¶
type PipelineStatus struct { }
PipelineStatus does not contain anything because Pipelines on their own do not have a status, they just hold data which is later used by a PipelineRun. Deprecated
func (*PipelineStatus) DeepCopy ¶
func (in *PipelineStatus) DeepCopy() *PipelineStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PipelineStatus.
func (*PipelineStatus) DeepCopyInto ¶
func (in *PipelineStatus) DeepCopyInto(out *PipelineStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PipelineTask ¶
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"` // TaskRef is a reference to a task definition. // +optional TaskRef *TaskRef `json:"taskRef,omitempty"` // TaskSpec is specification of a task // +optional TaskSpec *TaskSpec `json:"taskSpec,omitempty"` // Conditions is a list of conditions that need to be true for the task to run // +optional Conditions []PipelineTaskCondition `json:"conditions,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 RunAfter []string `json:"runAfter,omitempty"` // Resources declares the resources given to this task as inputs and // outputs. // +optional Resources *PipelineTaskResources `json:"resources,omitempty"` // Parameters declares parameters passed to this task. // +optional Params []Param `json:"params,omitempty"` // Workspaces maps workspaces from the pipeline spec to the workspaces // declared in the Task. // +optional Workspaces []WorkspacePipelineTaskBinding `json:"workspaces,omitempty"` // Time after which the TaskRun times out. Defaults to 1 hour. // Specified TaskRun timeout should be less than 24h. // Refer Go's ParseDuration documentation for expected format: https://golang.org/pkg/time/#ParseDuration // +optional Timeout *metav1.Duration `json:"timeout,omitempty"` }
PipelineTask defines a task in a Pipeline, passing inputs from both Params and from the output of previous tasks.
func (*PipelineTask) ConvertDown ¶ added in v0.11.0
func (sink *PipelineTask) ConvertDown(ctx context.Context, source v1beta1.PipelineTask) error
func (*PipelineTask) ConvertUp ¶ added in v0.11.0
func (source *PipelineTask) ConvertUp(ctx context.Context, sink *v1beta1.PipelineTask) error
func (*PipelineTask) DeepCopy ¶
func (in *PipelineTask) DeepCopy() *PipelineTask
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PipelineTask.
func (*PipelineTask) DeepCopyInto ¶
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.9.0
func (pt PipelineTask) Deps() []string
func (PipelineTask) HashKey ¶ added in v0.9.0
func (pt PipelineTask) HashKey() string
type PipelineTaskCondition ¶ added in v0.6.0
type PipelineTaskCondition = v1beta1.PipelineTaskCondition
PipelineTaskCondition allows a PipelineTask to declare a Condition to be evaluated before the Task is run.
type PipelineTaskInputResource ¶
type PipelineTaskInputResource = v1beta1.PipelineTaskInputResource
PipelineTaskInputResource maps the name of a declared PipelineResource input dependency in a Task to the resource in the Pipeline's DeclaredPipelineResources that should be used. This input may come from a previous task.
type PipelineTaskList ¶ added in v0.9.0
type PipelineTaskList []PipelineTask
func (PipelineTaskList) DeepCopy ¶ added in v0.9.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.9.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) Items ¶ added in v0.9.0
func (l PipelineTaskList) Items() []dag.Task
type PipelineTaskOutputResource ¶
type PipelineTaskOutputResource = v1beta1.PipelineTaskOutputResource
PipelineTaskOutputResource maps the name of a declared PipelineResource output dependency in a Task to the resource in the Pipeline's DeclaredPipelineResources that should be used.
type PipelineTaskParam ¶
type PipelineTaskParam = v1beta1.PipelineTaskParam
PipelineTaskParam is used to provide arbitrary string parameters to a Task.
type PipelineTaskResources ¶
type PipelineTaskResources = v1beta1.PipelineTaskResources
PipelineTaskResources allows a Pipeline to declare how its DeclaredPipelineResources should be provided to a Task as its inputs and outputs.
type PipelineTaskRun ¶
type PipelineTaskRun = v1beta1.PipelineTaskRun
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.
type PodTemplate ¶ added in v0.6.0
type ResourceDeclaration ¶ added in v0.7.0
type ResourceDeclaration = resource.ResourceDeclaration
ResourceDeclaration defines an input or output PipelineResource declared as a requirement by another type such as a Task or Condition. The Name field will be used to refer to these PipelineResources within the type's definition, and when provided as an Input, the Name will be the path to the volume mounted containing this PipelineResource as an input (e.g. an input Resource named `workspace` will be mounted at `/workspace`).
type ResourceParam ¶ added in v0.6.0
type ResourceParam = resource.ResourceParam
ResourceParam declares a string value to use for the parameter called Name, and is used in the specific context of PipelineResources.
type ResultType ¶ added in v0.10.0
type ResultType = v1beta1.ResultType
ResultType used to find out whether a PipelineResourceResult is from a task result or not
const ( // TaskRunResultType default task run result value TaskRunResultType ResultType = "TaskRunResult" // PipelineResourceResultType default pipeline result value PipelineResourceResultType ResultType = "PipelineResourceResult" // UnknownResultType default unknown result type value UnknownResultType ResultType = "" )
type SecretParam ¶
type SecretParam = resource.SecretParam
SecretParam indicates which secret can be used to populate a field of the resource
type SidecarState ¶ added in v0.9.0
type SidecarState = v1beta1.SidecarState
SidecarState reports the results of sidecar in the Task.
type Step ¶ added in v0.6.0
Step embeds the Container type, which allows it to include fields not provided by Container.
func MergeStepsWithStepTemplate ¶ added in v0.6.0
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. Deprecated
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) ConvertDown ¶ added in v0.11.0
ConvertDown implements api.Convertible
func (*Task) Copy ¶
func (t *Task) Copy() TaskInterface
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) SetDefaults ¶
func (*Task) TaskMetadata ¶
func (t *Task) TaskMetadata() metav1.ObjectMeta
type TaskInterface ¶
type TaskInterface interface { TaskMetadata() metav1.ObjectMeta TaskSpec() TaskSpec Copy() TaskInterface }
TaskInterface is implemented by Task and ClusterTask
type TaskKind ¶
Check that Pipeline may be validated and defaulted. TaskKind defines the type of Task used by the pipeline.
const ( // NamespacedTaskKind indicates that the task type has a namepace scope. NamespacedTaskKind TaskKind = v1beta1.NamespacedTaskKind // ClusterTaskKind indicates that task type has a cluster scope. ClusterTaskKind TaskKind = v1beta1.ClusterTaskKind )
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
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 TaskModifier ¶ added in v0.8.0
type TaskModifier = v1beta1.TaskModifier
TaskModifier is an interface to be implemented by different PipelineResources
type TaskRef ¶
TaskRef can be used to refer to a specific instance of a task. Copied from CrossVersionObjectReference: https://github.com/kubernetes/kubernetes/blob/169df7434155cbbc22f1532cba8e0a9588e29ad8/pkg/apis/autoscaling/types.go#L64
type TaskResource ¶
type TaskResource = v1beta1.TaskResource
TaskResource defines an input or output Resource declared as a requirement by a Task. The Name field will be used to refer to these Resources within the Task definition, and when provided as an Input, the Name will be the path to the volume mounted containing this Resource as an input (e.g. an input Resource named `workspace` will be mounted at `/workspace`).
type TaskResourceBinding ¶
type TaskResourceBinding = v1beta1.TaskResourceBinding
TaskResourceBinding points to the PipelineResource that will be used for the Task input or output called Name.
type TaskResult ¶ added in v0.10.0
type TaskResult = v1beta1.TaskResult
TaskResult used to describe the results of a task
type TaskRun ¶
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) ConvertDown ¶ added in v0.11.0
ConvertDown implements api.Convertible
func (*TaskRun) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TaskRun.
func (*TaskRun) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*TaskRun) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*TaskRun) GetBuildPodRef ¶
func (tr *TaskRun) GetBuildPodRef() corev1.ObjectReference
GetBuildPodRef for task
func (*TaskRun) GetPipelineRunPVCName ¶
GetPipelineRunPVCName for taskrun gets pipelinerun
func (*TaskRun) GetRunKey ¶ added in v0.2.0
GetRunKey return the taskrun key for timeout handler map
func (*TaskRun) HasPipelineRunOwnerReference ¶
HasPipelineRunOwnerReference returns true of TaskRun has owner reference of type PipelineRun
func (*TaskRun) HasStarted ¶ added in v0.3.0
HasStarted function check whether taskrun has valid start time set in its status
func (*TaskRun) IsCancelled ¶ added in v0.2.0
IsCancelled returns true if the TaskRun's spec status is set to Cancelled state
func (*TaskRun) IsDone ¶ added in v0.2.0
IsDone returns true if the TaskRun's status indicates that it is done.
func (*TaskRun) IsPartOfPipeline ¶ added in v0.8.0
IsPartOfPipeline return true if TaskRun is a part of a Pipeline. It also return the name of Pipeline and PipelineRun
func (*TaskRun) IsSuccessful ¶ added in v0.4.0
IsSuccessful returns true if the TaskRun's status indicates that it is done.
func (*TaskRun) SetDefaults ¶
type TaskRunInputs ¶
type TaskRunInputs struct { // +optional Resources []TaskResourceBinding `json:"resources,omitempty"` // +optional Params []Param `json:"params,omitempty"` }
TaskRunInputs holds the input values that this task was invoked with.
func (*TaskRunInputs) DeepCopy ¶
func (in *TaskRunInputs) DeepCopy() *TaskRunInputs
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TaskRunInputs.
func (*TaskRunInputs) DeepCopyInto ¶
func (in *TaskRunInputs) DeepCopyInto(out *TaskRunInputs)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (TaskRunInputs) Validate ¶
func (i TaskRunInputs) Validate(ctx context.Context, path string) *apis.FieldError
type TaskRunList ¶
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 ¶
func (in *TaskRunList) DeepCopy() *TaskRunList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TaskRunList.
func (*TaskRunList) DeepCopyInto ¶
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 ¶
func (in *TaskRunList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type TaskRunOutputs ¶
type TaskRunOutputs struct { // +optional Resources []TaskResourceBinding `json:"resources,omitempty"` }
TaskRunOutputs holds the output values that this task was invoked with.
func (*TaskRunOutputs) DeepCopy ¶
func (in *TaskRunOutputs) DeepCopy() *TaskRunOutputs
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TaskRunOutputs.
func (*TaskRunOutputs) DeepCopyInto ¶
func (in *TaskRunOutputs) DeepCopyInto(out *TaskRunOutputs)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (TaskRunOutputs) Validate ¶
func (o TaskRunOutputs) Validate(ctx context.Context, path string) *apis.FieldError
type TaskRunResult ¶ added in v0.11.0
type TaskRunResult = v1beta1.TaskRunResult
TaskRunResult used to describe the results of a task
type TaskRunSpec ¶
type TaskRunSpec struct { // +optional ServiceAccountName string `json:"serviceAccountName"` // no more than one of the TaskRef and TaskSpec may be specified. // +optional TaskRef *TaskRef `json:"taskRef,omitempty"` // +optional TaskSpec *TaskSpec `json:"taskSpec,omitempty"` // Used for cancelling a taskrun (and maybe more later on) // +optional Status TaskRunSpecStatus `json:"status,omitempty"` // Time after which the build times out. Defaults to 10 minutes. // Specified build timeout should be less than 24h. // 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 // +optional PodTemplate *PodTemplate `json:"podTemplate,omitempty"` // Workspaces is a list of WorkspaceBindings from volumes to workspaces. // +optional Workspaces []WorkspaceBinding `json:"workspaces,omitempty"` // From v1beta1 // +optional Params []Param `json:"params,omitempty"` // +optional Resources *v1beta1.TaskRunResources `json:"resources,omitempty"` // Deprecated // +optional Inputs TaskRunInputs `json:"inputs,omitempty"` // +optional Outputs TaskRunOutputs `json:"outputs,omitempty"` }
TaskRunSpec defines the desired state of TaskRun
func (*TaskRunSpec) ConvertDown ¶ added in v0.11.0
func (sink *TaskRunSpec) ConvertDown(ctx context.Context, source *v1beta1.TaskRunSpec) error
func (*TaskRunSpec) ConvertUp ¶ added in v0.11.0
func (source *TaskRunSpec) ConvertUp(ctx context.Context, sink *v1beta1.TaskRunSpec) error
func (*TaskRunSpec) DeepCopy ¶
func (in *TaskRunSpec) DeepCopy() *TaskRunSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TaskRunSpec.
func (*TaskRunSpec) DeepCopyInto ¶
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 ¶
func (trs *TaskRunSpec) SetDefaults(ctx context.Context)
func (*TaskRunSpec) Validate ¶
func (ts *TaskRunSpec) Validate(ctx context.Context) *apis.FieldError
Validate taskrun spec
type TaskRunSpecStatus ¶
type TaskRunSpecStatus = v1beta1.TaskRunSpecStatus
TaskRunSpecStatus defines the taskrun spec status the user can provide
type TaskRunStatus ¶
type TaskRunStatus = v1beta1.TaskRunStatus
TaskRunStatus defines the observed state of TaskRun
type TaskRunStatusFields ¶ added in v0.10.0
type TaskRunStatusFields = v1beta1.TaskRunStatusFields
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.
type TaskSpec ¶
type TaskSpec struct { v1beta1.TaskSpec `json:",inline"` // Inputs is an optional set of parameters and resources which must be // supplied by the user when a Task is executed by a TaskRun. // +optional Inputs *Inputs `json:"inputs,omitempty"` // Outputs is an optional set of resources and results produced when this // Task is run. // +optional Outputs *Outputs `json:"outputs,omitempty"` }
TaskSpec defines the desired state of Task.
func (*TaskSpec) ConvertDown ¶ added in v0.11.0
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) SetDefaults ¶
SetDefaults set any defaults for the task spec
type TestResult ¶
type TestResult struct { // Name declares the name by which a result is referenced in the Task's // definition. Results may be referenced by name in the definition of a // Task's steps. Name string `json:"name"` // TODO: maybe this is an enum with types like "go test", "junit", etc. Format string `json:"format"` Path string `json:"path"` }
TestResult allows a task to specify the location where test logs can be found and what format they will be in.
func (*TestResult) DeepCopy ¶
func (in *TestResult) DeepCopy() *TestResult
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TestResult.
func (*TestResult) DeepCopyInto ¶
func (in *TestResult) DeepCopyInto(out *TestResult)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type WorkspaceBinding ¶ added in v0.10.0
type WorkspaceBinding = v1beta1.WorkspaceBinding
WorkspaceBinding maps a Task's declared workspace to a Volume.
type WorkspaceDeclaration ¶ added in v0.10.0
type WorkspaceDeclaration = v1beta1.WorkspaceDeclaration
WorkspaceDeclaration is a declaration of a volume that a Task requires.
type WorkspacePipelineDeclaration ¶ added in v0.10.0
type WorkspacePipelineDeclaration = v1beta1.WorkspacePipelineDeclaration
WorkspacePipelineDeclaration creates a named slot in a Pipeline that a PipelineRun is expected to populate with a workspace binding.
type WorkspacePipelineTaskBinding ¶ added in v0.10.0
type WorkspacePipelineTaskBinding = v1beta1.WorkspacePipelineTaskBinding
WorkspacePipelineTaskBinding describes how a workspace passed into the pipeline should be mapped to a task's declared workspace.
Source Files
¶
- cluster_task_conversion.go
- cluster_task_defaults.go
- cluster_task_types.go
- cluster_task_validation.go
- condition_defaults.go
- condition_types.go
- condition_validation.go
- container_replacements.go
- conversion_error.go
- doc.go
- merge.go
- param_types.go
- pipeline_conversion.go
- pipeline_defaults.go
- pipeline_interface.go
- pipeline_resource_types.go
- pipeline_types.go
- pipeline_validation.go
- pipelinerun_conversion.go
- pipelinerun_defaults.go
- pipelinerun_types.go
- pipelinerun_validation.go
- pod.go
- register.go
- resource_paths.go
- resource_types.go
- step_replacements.go
- storage_resource.go
- task_conversion.go
- task_defaults.go
- task_interface.go
- task_types.go
- task_validation.go
- taskrun_conversion.go
- taskrun_defaults.go
- taskrun_types.go
- taskrun_validation.go
- workspace_types.go
- workspace_validation.go
- zz_generated.deepcopy.go