v1alpha1

package
Version: v0.28.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 13, 2021 License: Apache-2.0 Imports: 27 Imported by: 348

Documentation

Overview

nolint: revive

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: revive

nolint: revive

nolint: revive

nolint: revive

Index

Constants

View Source
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
	// Conversion Error message for a field not available in v1alpha1
	ConversionErrorFieldNotAvailableMsg = "the specified field/section is not available in v1alpha1"
)
View Source
const (
	// RunReasonCancelled must be used in the Condition Reason to indicate that a Run was cancelled.
	RunReasonCancelled = "RunCancelled"
	// RunReasonTimedOut must be used in the Condition Reason to indicate that a Run was timed out.
	RunReasonTimedOut = "RunTimedOut"
	// RunReasonWorkspaceNotSupported can be used in the Condition Reason to indicate that the
	// Run contains a workspace which is not supported by this custom task.
	RunReasonWorkspaceNotSupported = "RunWorkspaceNotSupported"
	// RunReasonPodTemplateNotSupported can be used in the Condition Reason to indicate that the
	// Run contains a pod template which is not supported by this custom task.
	RunReasonPodTemplateNotSupported = "RunPodTemplateNotSupported"
)
View Source
const (
	// TaskRunSpecStatusCancelled indicates that the user wants to cancel the task,
	// if not already cancelled or terminated
	TaskRunSpecStatusCancelled = v1beta1.TaskRunSpecStatusCancelled

	// TaskRunReasonCancelled indicates that the TaskRun has been cancelled
	// because it was requested so by the user
	TaskRunReasonCancelled = v1beta1.TaskRunSpecStatusCancelled
)
View Source
const FinallyFieldName = "finally"
View Source
const ManagedByLabelKey = "app.kubernetes.io/managed-by"
View Source
const (
	// PipelineRunSpecStatusCancelled indicates that the user wants to cancel the task,
	// if not already cancelled or terminated
	PipelineRunSpecStatusCancelled = v1beta1.PipelineRunSpecStatusCancelledDeprecated
)

Variables

View Source
var (

	// AddToScheme adds Build types to the scheme.
	AddToScheme = schemeBuilder.AddToScheme
)
View Source
var AllParamTypes = v1beta1.AllParamTypes

AllParamTypes can be used for ParamType validation.

View Source
var AllResourceTypes = resource.AllResourceTypes

AllResourceTypes can be used for validation to check if a provided Resource type is one of the known types.

View Source
var (
	AllowedOutputResources = resource.AllowedOutputResources
)
View Source
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 ApplyContainerReplacements(step *corev1.Container, stringReplacements map[string]string, arrayReplacements map[string][]string)

func ApplyStepReplacements added in v0.6.0

func ApplyStepReplacements(step *Step, stringReplacements map[string]string, arrayReplacements map[string][]string)

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 Kind

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns back a Group qualified GroupKind

func OutputResourcePath added in v0.7.0

func OutputResourcePath(r ResourceDeclaration) string

OutputResourcePath returns the path to the output resource 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) ConvertFrom added in v0.12.0

func (sink *ClusterTask) ConvertFrom(ctx context.Context, obj apis.Convertible) error

ConvertFrom implements api.Convertible

func (*ClusterTask) ConvertTo added in v0.12.0

func (source *ClusterTask) ConvertTo(ctx context.Context, obj apis.Convertible) error

ConvertTo implements api.Convertible

func (*ClusterTask) Copy

func (t *ClusterTask) Copy() TaskObject

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

func (in *Condition) DeepCopy() *Condition

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Condition.

func (*Condition) DeepCopyInto added in v0.6.0

func (in *Condition) DeepCopyInto(out *Condition)

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

func (in *Condition) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*Condition) SetDefaults added in v0.6.0

func (c *Condition) SetDefaults(ctx context.Context)

func (Condition) Validate added in v0.6.0

func (c Condition) Validate(ctx context.Context) *apis.FieldError

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"`

	// Description is a user-facing description of the condition that may be
	// used to populate a UI.
	// +optional
	Description string `json:"description,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 EmbeddedRunSpec added in v0.25.0

type EmbeddedRunSpec struct {
	runtime.TypeMeta `json:",inline"`

	// +optional
	Metadata v1beta1.PipelineTaskMetadata `json:"metadata,omitempty"`

	// Spec is a specification of a custom task
	// +optional
	Spec runtime.RawExtension `json:"spec,omitempty"`
}

EmbeddedRunSpec allows custom task definitions to be embedded

func (*EmbeddedRunSpec) DeepCopy added in v0.25.0

func (in *EmbeddedRunSpec) DeepCopy() *EmbeddedRunSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EmbeddedRunSpec.

func (*EmbeddedRunSpec) DeepCopyInto added in v0.25.0

func (in *EmbeddedRunSpec) DeepCopyInto(out *EmbeddedRunSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

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

func (in *Inputs) DeepCopy() *Inputs

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Inputs.

func (*Inputs) DeepCopyInto

func (in *Inputs) DeepCopyInto(out *Inputs)

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

func (inputs *Inputs) SetDefaults(ctx context.Context)

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

func (in *Outputs) DeepCopy() *Outputs

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Outputs.

func (*Outputs) DeepCopyInto

func (in *Outputs) DeepCopyInto(out *Outputs)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Param

type Param = v1beta1.Param

Param declares an ArrayOrString to use for the parameter called name.

type ParamSpec added in v0.5.0

type ParamSpec = v1beta1.ParamSpec

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

type ParamType = v1beta1.ParamType

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) ConvertFrom added in v0.12.0

func (sink *Pipeline) ConvertFrom(ctx context.Context, obj apis.Convertible) error

ConvertFrom implements api.Convertible

func (*Pipeline) ConvertTo added in v0.12.0

func (source *Pipeline) ConvertTo(ctx context.Context, obj apis.Convertible) error

ConvertTo implements api.Convertible

func (*Pipeline) Copy added in v0.8.0

func (p *Pipeline) Copy() PipelineObject

func (*Pipeline) DeepCopy

func (in *Pipeline) DeepCopy() *Pipeline

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Pipeline.

func (*Pipeline) DeepCopyInto

func (in *Pipeline) DeepCopyInto(out *Pipeline)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Pipeline) DeepCopyObject

func (in *Pipeline) DeepCopyObject() runtime.Object

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

func (p *Pipeline) SetDefaults(ctx context.Context)

func (*Pipeline) Validate

func (p *Pipeline) Validate(ctx context.Context) *apis.FieldError

Validate checks that the Pipeline structure is valid but does not validate that any references resources exist, that is done at run time.

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 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 PipelineObject added in v0.19.0

type PipelineObject interface {
	PipelineMetadata() metav1.ObjectMeta
	PipelineSpec() PipelineSpec
	Copy() PipelineObject
}

PipelineObject is implemented by Pipeline and ClusterPipeline

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 Git 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 PipelineResourceType = resource.PipelineResourceTypeGCS

PipelineResourceTypeGCS is the subtype for the GCSResources, which is backed by a GCS blob/directory.

type PipelineResult added in v0.12.0

type PipelineResult = v1beta1.PipelineResult

PipelineResult used to describe the results of a pipeline

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) ConvertFrom added in v0.12.0

func (sink *PipelineRun) ConvertFrom(ctx context.Context, obj apis.Convertible) error

ConvertFrom implements api.Convertible

func (*PipelineRun) ConvertTo added in v0.12.0

func (source *PipelineRun) ConvertTo(ctx context.Context, obj apis.Convertible) error

ConvertTo 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) GetGroupVersionKind added in v0.27.0

func (*PipelineRun) GetGroupVersionKind() schema.GroupVersionKind

GetGroupVersionKind implements kmeta.OwnerRefable.

func (*PipelineRun) GetName added in v0.11.0

func (pr *PipelineRun) GetName() string

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) GetTaskRunSpecs added in v0.13.0

func (pr *PipelineRun) GetTaskRunSpecs(pipelineTaskName string) (string, *PodTemplate)

GetTaskRunSpecs returns the task specific spec for a given PipelineTask if configured, otherwise it returns the PipelineRun's default.

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) HasVolumeClaimTemplate added in v0.12.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) 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"`
	// TaskRunSpecs holds a set of task specific specs
	// +optional
	TaskRunSpecs []PipelineTaskRunSpec `json:"taskRunSpecs,omitempty"`
}

PipelineRunSpec defines the desired state of PipelineRun

func (*PipelineRunSpec) ConvertFrom added in v0.12.0

func (sink *PipelineRunSpec) ConvertFrom(ctx context.Context, source *v1beta1.PipelineRunSpec) error

func (*PipelineRunSpec) ConvertTo added in v0.12.0

func (source *PipelineRunSpec) ConvertTo(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 {
	// Description is a user-facing description of the pipeline that may be
	// used to populate a UI.
	// +optional
	Description string `json:"description,omitempty"`
	// 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 []PipelineWorkspaceDeclaration `json:"workspaces,omitempty"`
	// Results are values that this pipeline can output once run
	// +optional
	Results []PipelineResult `json:"results,omitempty"`
}

PipelineSpec defines the desired state of Pipeline.

func (*PipelineSpec) ConvertFrom added in v0.12.0

func (sink *PipelineSpec) ConvertFrom(ctx context.Context, source v1beta1.PipelineSpec) error

func (*PipelineSpec) ConvertTo added in v0.12.0

func (source *PipelineSpec) ConvertTo(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) ConvertFrom added in v0.12.0

func (sink *PipelineTask) ConvertFrom(ctx context.Context, source v1beta1.PipelineTask) error

func (*PipelineTask) ConvertTo added in v0.12.0

func (source *PipelineTask) ConvertTo(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) Deps added in v0.19.0

func (l PipelineTaskList) Deps() map[string][]string

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 PipelineTaskRunSpec added in v0.13.0

type PipelineTaskRunSpec struct {
	PipelineTaskName       string       `json:"pipelineTaskName,omitempty"`
	TaskServiceAccountName string       `json:"taskServiceAccountName,omitempty"`
	TaskPodTemplate        *PodTemplate `json:"taskPodTemplate,omitempty"`
}

PipelineTaskRunSpec holds task specific specs

func (*PipelineTaskRunSpec) DeepCopy added in v0.13.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.13.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 PipelineWorkspaceDeclaration added in v0.13.0

type PipelineWorkspaceDeclaration = v1beta1.PipelineWorkspaceDeclaration

PipelineWorkspaceDeclaration creates a named slot in a Pipeline that a PipelineRun is expected to populate with a workspace binding.

type PodTemplate added in v0.6.0

type PodTemplate = pod.Template

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 = v1beta1.TaskRunResultType
	// PipelineResourceResultType default pipeline result value
	PipelineResourceResultType ResultType = v1beta1.PipelineResourceResultType
	// UnknownResultType default unknown result type value
	UnknownResultType ResultType = v1beta1.UnknownResultType
)

type Run added in v0.15.0

type Run struct {
	metav1.TypeMeta `json:",inline"`
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// +optional
	Spec RunSpec `json:"spec,omitempty"`
	// +optional
	Status RunStatus `json:"status,omitempty"`
}

Run represents a single execution of a Custom Task.

+k8s:openapi-gen=true

func (*Run) DeepCopy added in v0.15.0

func (in *Run) DeepCopy() *Run

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Run.

func (*Run) DeepCopyInto added in v0.15.0

func (in *Run) DeepCopyInto(out *Run)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Run) DeepCopyObject added in v0.15.0

func (in *Run) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*Run) GetConditionSet added in v0.15.0

func (r *Run) GetConditionSet() apis.ConditionSet

GetConditionSet retrieves the condition set for this resource. Implements the KRShaped interface.

func (*Run) GetGroupVersionKind added in v0.27.0

func (*Run) GetGroupVersionKind() schema.GroupVersionKind

GetGroupVersionKind implements kmeta.OwnerRefable.

func (*Run) GetRunKey added in v0.15.0

func (r *Run) GetRunKey() string

GetRunKey return the run's key for timeout handler map

func (*Run) GetStatus added in v0.15.0

func (r *Run) GetStatus() *duckv1.Status

GetStatus retrieves the status of the Parallel. Implements the KRShaped interface.

func (*Run) GetTimeout added in v0.27.0

func (r *Run) GetTimeout() time.Duration

func (*Run) HasPipelineRunOwnerReference added in v0.15.0

func (r *Run) HasPipelineRunOwnerReference() bool

HasPipelineRunOwnerReference returns true of Run has owner reference of type PipelineRun

func (*Run) HasStarted added in v0.15.0

func (r *Run) HasStarted() bool

HasStarted function check whether taskrun has valid start time set in its status

func (*Run) HasTimedOut added in v0.27.0

func (r *Run) HasTimedOut() bool

HasTimedOut returns true if the Run's running time is beyond the allowed timeout

func (*Run) IsCancelled added in v0.17.0

func (r *Run) IsCancelled() bool

IsCancelled returns true if the Run's spec status is set to Cancelled state

func (*Run) IsDone added in v0.15.0

func (r *Run) IsDone() bool

IsDone returns true if the Run's status indicates that it is done.

func (*Run) IsSuccessful added in v0.15.0

func (r *Run) IsSuccessful() bool

IsSuccessful returns true if the Run's status indicates that it is done.

func (*Run) SetDefaults added in v0.15.0

func (r *Run) SetDefaults(ctx context.Context)

func (*Run) Validate added in v0.15.0

func (r *Run) Validate(ctx context.Context) *apis.FieldError

Validate taskrun

type RunList added in v0.15.0

type RunList struct {
	metav1.TypeMeta `json:",inline"`
	// +optional
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Run `json:"items"`
}

RunList contains a list of Run

func (*RunList) DeepCopy added in v0.15.0

func (in *RunList) DeepCopy() *RunList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RunList.

func (*RunList) DeepCopyInto added in v0.15.0

func (in *RunList) DeepCopyInto(out *RunList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*RunList) DeepCopyObject added in v0.15.0

func (in *RunList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type RunResult added in v0.19.0

type RunResult = runv1alpha1.RunResult

RunResult used to describe the results of a task

type RunSpec added in v0.15.0

type RunSpec struct {
	// +optional
	Ref *TaskRef `json:"ref,omitempty"`

	// Spec is a specification of a custom task
	// +optional
	Spec *EmbeddedRunSpec `json:"spec,omitempty"`

	// +optional
	Params []v1beta1.Param `json:"params,omitempty"`

	// Used for cancelling a run (and maybe more later on)
	// +optional
	Status RunSpecStatus `json:"status,omitempty"`

	// +optional
	ServiceAccountName string `json:"serviceAccountName"`

	// PodTemplate holds pod specific configuration
	// +optional
	PodTemplate *PodTemplate `json:"podTemplate,omitempty"`

	// Time after which the custom-task times out.
	// Refer Go's ParseDuration documentation for expected format: https://golang.org/pkg/time/#ParseDuration
	// +optional
	Timeout *metav1.Duration `json:"timeout,omitempty"`

	// Workspaces is a list of WorkspaceBindings from volumes to workspaces.
	// +optional
	Workspaces []v1beta1.WorkspaceBinding `json:"workspaces,omitempty"`
}

RunSpec defines the desired state of Run

func (*RunSpec) DeepCopy added in v0.15.0

func (in *RunSpec) DeepCopy() *RunSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RunSpec.

func (*RunSpec) DeepCopyInto added in v0.15.0

func (in *RunSpec) DeepCopyInto(out *RunSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (RunSpec) GetParam added in v0.15.0

func (rs RunSpec) GetParam(name string) *v1beta1.Param

TODO(jasonhall): Move this to a Params type so other code can use it?

func (*RunSpec) SetDefaults added in v0.15.0

func (rs *RunSpec) SetDefaults(ctx context.Context)

func (*RunSpec) Validate added in v0.15.0

func (rs *RunSpec) Validate(ctx context.Context) *apis.FieldError

Validate Run spec

type RunSpecStatus added in v0.17.0

type RunSpecStatus string

RunSpecStatus defines the taskrun spec status the user can provide

const (
	// RunSpecStatusCancelled indicates that the user wants to cancel the run,
	// if not already cancelled or terminated
	RunSpecStatusCancelled RunSpecStatus = "RunCancelled"
)

type RunStatus added in v0.15.0

type RunStatus = runv1alpha1.RunStatus

RunStatus defines the observed state of Run.

type RunStatusFields added in v0.15.0

type RunStatusFields = runv1alpha1.RunStatusFields

RunStatusFields holds the fields of Run's status. This is defined separately and inlined so that other types can readily consume these fields via duck typing.

type SecretParam

type SecretParam = resource.SecretParam

SecretParam indicates which secret can be used to populate a field of the resource

type Sidecar added in v0.11.0

type Sidecar = v1beta1.Sidecar

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

type Step = v1beta1.Step

Step embeds the Container type, which allows it to include fields not provided by Container.

type StepState

type StepState = v1beta1.StepState

StepState reports the results of running a step in the Task.

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) ConvertFrom added in v0.12.0

func (sink *Task) ConvertFrom(ctx context.Context, obj apis.Convertible) error

ConvertFrom implements api.Convertible

func (*Task) ConvertTo added in v0.12.0

func (source *Task) ConvertTo(ctx context.Context, obj apis.Convertible) error

ConvertTo implements api.Convertible

func (*Task) Copy

func (t *Task) Copy() TaskObject

func (*Task) DeepCopy

func (in *Task) DeepCopy() *Task

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Task.

func (*Task) DeepCopyInto

func (in *Task) DeepCopyInto(out *Task)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Task) DeepCopyObject

func (in *Task) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*Task) SetDefaults

func (t *Task) SetDefaults(ctx context.Context)

func (*Task) TaskMetadata

func (t *Task) TaskMetadata() metav1.ObjectMeta

func (*Task) TaskSpec

func (t *Task) TaskSpec() TaskSpec

func (*Task) Validate

func (t *Task) Validate(ctx context.Context) *apis.FieldError

type TaskKind

type TaskKind = v1beta1.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

func (in *TaskList) DeepCopy() *TaskList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TaskList.

func (*TaskList) DeepCopyInto

func (in *TaskList) DeepCopyInto(out *TaskList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*TaskList) DeepCopyObject

func (in *TaskList) DeepCopyObject() runtime.Object

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 TaskObject added in v0.19.0

type TaskObject interface {
	TaskMetadata() metav1.ObjectMeta
	TaskSpec() TaskSpec
	Copy() TaskObject
}

TaskObject is implemented by Task and ClusterTask

type TaskRef

type TaskRef = v1beta1.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) ConvertFrom added in v0.12.0

func (sink *TaskRun) ConvertFrom(ctx context.Context, obj apis.Convertible) error

ConvertFrom implements api.Convertible

func (*TaskRun) ConvertTo added in v0.12.0

func (source *TaskRun) ConvertTo(ctx context.Context, obj apis.Convertible) error

ConvertTo implements api.Convertible

func (*TaskRun) DeepCopy

func (in *TaskRun) DeepCopy() *TaskRun

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TaskRun.

func (*TaskRun) DeepCopyInto

func (in *TaskRun) DeepCopyInto(out *TaskRun)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*TaskRun) DeepCopyObject

func (in *TaskRun) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*TaskRun) GetGroupVersionKind added in v0.27.0

func (*TaskRun) GetGroupVersionKind() schema.GroupVersionKind

GetGroupVersionKind implements kmeta.OwnerRefable.

func (*TaskRun) GetPipelineRunPVCName

func (tr *TaskRun) GetPipelineRunPVCName() string

GetPipelineRunPVCName for taskrun gets pipelinerun

func (*TaskRun) GetRunKey added in v0.2.0

func (tr *TaskRun) GetRunKey() string

GetRunKey return the taskrun key for timeout handler map

func (*TaskRun) GetTimeout added in v0.12.0

func (tr *TaskRun) GetTimeout() time.Duration

func (*TaskRun) HasPipelineRunOwnerReference

func (tr *TaskRun) HasPipelineRunOwnerReference() bool

HasPipelineRunOwnerReference returns true of TaskRun has owner reference of type PipelineRun

func (*TaskRun) HasStarted added in v0.3.0

func (tr *TaskRun) HasStarted() bool

HasStarted function check whether taskrun has valid start time set in its status

func (*TaskRun) HasTimedOut added in v0.12.0

func (tr *TaskRun) HasTimedOut() bool

HasTimedOut returns true if the TaskRun runtime is beyond the allowed timeout

func (*TaskRun) HasVolumeClaimTemplate added in v0.12.0

func (tr *TaskRun) HasVolumeClaimTemplate() bool

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

func (tr *TaskRun) IsCancelled() bool

IsCancelled returns true if the TaskRun's spec status is set to Cancelled state

func (*TaskRun) IsDone added in v0.2.0

func (tr *TaskRun) IsDone() bool

IsDone returns true if the TaskRun's status indicates that it is done.

func (*TaskRun) IsPartOfPipeline added in v0.8.0

func (tr *TaskRun) IsPartOfPipeline() (bool, string, string)

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

func (tr *TaskRun) IsSuccessful() bool

IsSuccessful returns true if the TaskRun's status indicates that it is done.

func (*TaskRun) SetDefaults

func (tr *TaskRun) SetDefaults(ctx context.Context)

func (*TaskRun) Validate

func (tr *TaskRun) Validate(ctx context.Context) *apis.FieldError

Validate taskrun

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) ConvertFrom added in v0.12.0

func (sink *TaskRunSpec) ConvertFrom(ctx context.Context, source *v1beta1.TaskRunSpec) error

func (*TaskRunSpec) ConvertTo added in v0.12.0

func (source *TaskRunSpec) ConvertTo(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) ConvertFrom added in v0.12.0

func (sink *TaskSpec) ConvertFrom(ctx context.Context, source *v1beta1.TaskSpec) error

func (*TaskSpec) ConvertTo added in v0.12.0

func (source *TaskSpec) ConvertTo(ctx context.Context, sink *v1beta1.TaskSpec) error

func (*TaskSpec) DeepCopy

func (in *TaskSpec) DeepCopy() *TaskSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TaskSpec.

func (*TaskSpec) DeepCopyInto

func (in *TaskSpec) DeepCopyInto(out *TaskSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*TaskSpec) SetDefaults

func (ts *TaskSpec) SetDefaults(ctx context.Context)

SetDefaults set any defaults for the task spec

func (*TaskSpec) Validate

func (ts *TaskSpec) Validate(ctx context.Context) *apis.FieldError

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL