pipeline: github.com/tektoncd/pipeline/pkg/apis/pipeline/v1alpha1 Index | Files

package v1alpha1

import "github.com/tektoncd/pipeline/pkg/apis/pipeline/v1alpha1"

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

Package 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 run_defaults.go run_types.go run_validation.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

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
    // Conversion Error message for a field not available in v1alpha1
    ConversionErrorFieldNotAvailableMsg = "the specified field/section is not available in v1alpha1"
)
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
)
const FinallyFieldName = "finally"
const (
    // PipelineRunSpecStatusCancelled indicates that the user wants to cancel the task,
    // if not already cancelled or terminated
    PipelineRunSpecStatusCancelled = v1beta1.PipelineRunSpecStatusCancelled
)

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

func ApplyContainerReplacements Uses

func ApplyContainerReplacements(step *corev1.Container, stringReplacements map[string]string, arrayReplacements map[string][]string)

func ApplyStepReplacements Uses

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

func ApplyTaskModifier Uses

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 Uses

func InputResourcePath(r ResourceDeclaration) string

InputResourcePath returns the path where the given input resource will get mounted in a Pod

func Kind Uses

func Kind(kind string) schema.GroupKind

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

func OutputResourcePath Uses

func OutputResourcePath(r ResourceDeclaration) string

OutputResourcePath returns the path to the output resouce in a Pod

func Resource Uses

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

func ValidateVolumes Uses

func ValidateVolumes(volumes []corev1.Volume) *apis.FieldError

type ArrayOrString Uses

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 Uses

type CannotConvertError = v1beta1.CannotConvertError

CannotConvertError is returned when a field cannot be converted.

type CloudEventCondition Uses

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 Uses

type CloudEventDelivery = v1beta1.CloudEventDelivery

CloudEventDelivery is the target of a cloud event along with the state of delivery.

type CloudEventDeliveryState Uses

type CloudEventDeliveryState = v1beta1.CloudEventDeliveryState

CloudEventDeliveryState reports the state of a cloud event to be sent.

type ClusterTask Uses

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 Uses

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

ConvertFrom implements api.Convertible

func (*ClusterTask) ConvertTo Uses

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

ConvertTo implements api.Convertible

func (*ClusterTask) Copy Uses

func (t *ClusterTask) Copy() TaskInterface

func (*ClusterTask) DeepCopy Uses

func (in *ClusterTask) DeepCopy() *ClusterTask

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

func (*ClusterTask) DeepCopyInto Uses

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 Uses

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

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

func (*ClusterTask) SetDefaults Uses

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

func (*ClusterTask) TaskMetadata Uses

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

func (*ClusterTask) TaskSpec Uses

func (t *ClusterTask) TaskSpec() TaskSpec

func (*ClusterTask) Validate Uses

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

type ClusterTaskList Uses

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 Uses

func (in *ClusterTaskList) DeepCopy() *ClusterTaskList

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

func (*ClusterTaskList) DeepCopyInto Uses

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 Uses

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

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

type Condition Uses

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 Uses

func (in *Condition) DeepCopy() *Condition

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

func (*Condition) DeepCopyInto Uses

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 Uses

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

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

func (*Condition) SetDefaults Uses

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

func (Condition) Validate Uses

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

type ConditionCheck Uses

type ConditionCheck TaskRun

ConditionCheck represents a single evaluation of a Condition step.

func NewConditionCheck Uses

func NewConditionCheck(tr *TaskRun) *ConditionCheck

func (*ConditionCheck) DeepCopy Uses

func (in *ConditionCheck) DeepCopy() *ConditionCheck

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

func (*ConditionCheck) DeepCopyInto Uses

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 Uses

func (cc *ConditionCheck) IsDone() bool

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

func (*ConditionCheck) IsSuccessful Uses

func (cc *ConditionCheck) IsSuccessful() bool

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

type ConditionCheckStatus Uses

type ConditionCheckStatus = v1beta1.ConditionCheckStatus

ConditionCheckStatus defines the observed state of ConditionCheck

type ConditionCheckStatusFields Uses

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 Uses

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 Uses

func (in *ConditionList) DeepCopy() *ConditionList

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

func (*ConditionList) DeepCopyInto Uses

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 Uses

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

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

type ConditionSpec Uses

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 Uses

func (in *ConditionSpec) DeepCopy() *ConditionSpec

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

func (*ConditionSpec) DeepCopyInto Uses

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 Uses

func (cs *ConditionSpec) SetDefaults(ctx context.Context)

func (*ConditionSpec) Validate Uses

func (cs *ConditionSpec) Validate(ctx context.Context) *apis.FieldError

type Inputs Uses

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 Uses

func (in *Inputs) DeepCopy() *Inputs

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

func (*Inputs) DeepCopyInto Uses

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 Uses

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

type InternalTaskModifier Uses

type InternalTaskModifier = v1beta1.InternalTaskModifier

InternalTaskModifier implements TaskModifier for resources that are built-in to Tekton Pipelines.

type Outputs Uses

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 Uses

func (in *Outputs) DeepCopy() *Outputs

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

func (*Outputs) DeepCopyInto Uses

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 Uses

type Param = v1beta1.Param

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

type ParamSpec Uses

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 Uses

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 Uses

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 Uses

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

ConvertFrom implements api.Convertible

func (*Pipeline) ConvertTo Uses

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

ConvertTo implements api.Convertible

func (*Pipeline) Copy Uses

func (p *Pipeline) Copy() PipelineInterface

func (*Pipeline) DeepCopy Uses

func (in *Pipeline) DeepCopy() *Pipeline

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

func (*Pipeline) DeepCopyInto Uses

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 Uses

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

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

func (*Pipeline) PipelineMetadata Uses

func (p *Pipeline) PipelineMetadata() metav1.ObjectMeta

func (*Pipeline) PipelineSpec Uses

func (p *Pipeline) PipelineSpec() PipelineSpec

func (*Pipeline) SetDefaults Uses

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

func (*Pipeline) Validate Uses

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 Uses

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 Uses

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

PipelineInterface is implemented by Pipeline and ClusterPipeline

type PipelineList Uses

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 Uses

func (in *PipelineList) DeepCopy() *PipelineList

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

func (*PipelineList) DeepCopyInto Uses

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 Uses

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

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

type PipelineRef Uses

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 Uses

type PipelineResource = resource.PipelineResource

PipelineResource describes a resource that is an input to or output from a Task.

type PipelineResourceBinding Uses

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 Uses

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 Uses

type PipelineResourceList = resource.PipelineResourceList

PipelineResourceList contains a list of PipelineResources

type PipelineResourceRef Uses

type PipelineResourceRef = v1beta1.PipelineResourceRef

PipelineResourceRef can be used to refer to a specific instance of a Resource

type PipelineResourceResult Uses

type PipelineResourceResult = v1beta1.PipelineResourceResult

PipelineResourceResult used to export the image name and digest as json

type PipelineResourceSpec Uses

type PipelineResourceSpec = resource.PipelineResourceSpec

PipelineResourceSpec defines an individual resources used in the pipeline.

type PipelineResourceType Uses

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 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 PipelineResult Uses

type PipelineResult = v1beta1.PipelineResult

PipelineResult used to describe the results of a pipeline

type PipelineRun Uses

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 Uses

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

ConvertFrom implements api.Convertible

func (*PipelineRun) ConvertTo Uses

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

ConvertTo implements api.Convertible

func (*PipelineRun) DeepCopy Uses

func (in *PipelineRun) DeepCopy() *PipelineRun

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

func (*PipelineRun) DeepCopyInto Uses

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 Uses

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

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

func (*PipelineRun) GetName Uses

func (pr *PipelineRun) GetName() string

func (*PipelineRun) GetOwnerReference Uses

func (pr *PipelineRun) GetOwnerReference() metav1.OwnerReference

GetOwnerReference gets the pipeline run as owner reference for any related objects

func (*PipelineRun) GetRunKey Uses

func (pr *PipelineRun) GetRunKey() string

GetRunKey return the pipelinerun key for timeout handler map

func (*PipelineRun) GetServiceAccountName Uses

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 Uses

func (pr *PipelineRun) GetTaskRunRef() corev1.ObjectReference

GetTaskRunRef for pipelinerun

func (*PipelineRun) GetTaskRunSpecs Uses

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 Uses

func (pr *PipelineRun) HasStarted() bool

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

func (*PipelineRun) HasVolumeClaimTemplate Uses

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 Uses

func (pr *PipelineRun) IsCancelled() bool

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

func (*PipelineRun) IsDone Uses

func (pr *PipelineRun) IsDone() bool

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

func (*PipelineRun) IsTimedOut Uses

func (pr *PipelineRun) IsTimedOut() bool

IsTimedOut returns true if a pipelinerun has exceeded its spec.Timeout based on its status.Timeout

func (*PipelineRun) SetDefaults Uses

func (pr *PipelineRun) SetDefaults(ctx context.Context)

func (*PipelineRun) Validate Uses

func (pr *PipelineRun) Validate(ctx context.Context) *apis.FieldError

Validate pipelinerun

type PipelineRunConditionCheckStatus Uses

type PipelineRunConditionCheckStatus = v1beta1.PipelineRunConditionCheckStatus

type PipelineRunList Uses

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 Uses

func (in *PipelineRunList) DeepCopy() *PipelineRunList

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

func (*PipelineRunList) DeepCopyInto Uses

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 Uses

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

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

type PipelineRunSpec Uses

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 Uses

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

func (*PipelineRunSpec) ConvertTo Uses

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

func (*PipelineRunSpec) DeepCopy Uses

func (in *PipelineRunSpec) DeepCopy() *PipelineRunSpec

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

func (*PipelineRunSpec) DeepCopyInto Uses

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 Uses

func (prs *PipelineRunSpec) SetDefaults(ctx context.Context)

func (*PipelineRunSpec) Validate Uses

func (ps *PipelineRunSpec) Validate(ctx context.Context) *apis.FieldError

Validate pipelinerun spec

type PipelineRunSpecServiceAccountName Uses

type PipelineRunSpecServiceAccountName = v1beta1.PipelineRunSpecServiceAccountName

PipelineRunSpecServiceAccountName can be used to configure specific ServiceAccountName for a concrete Task

type PipelineRunSpecStatus Uses

type PipelineRunSpecStatus = v1beta1.PipelineRunSpecStatus

PipelineRunSpecStatus defines the pipelinerun spec status the user can provide

type PipelineRunStatus Uses

type PipelineRunStatus = v1beta1.PipelineRunStatus

PipelineRunStatus defines the observed state of PipelineRun

type PipelineRunStatusFields Uses

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 Uses

type PipelineRunTaskRunStatus = v1beta1.PipelineRunTaskRunStatus

PipelineRunTaskRunStatus contains the name of the PipelineTask for this TaskRun and the TaskRun's Status

type PipelineSpec Uses

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 Uses

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

func (*PipelineSpec) ConvertTo Uses

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

func (*PipelineSpec) DeepCopy Uses

func (in *PipelineSpec) DeepCopy() *PipelineSpec

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

func (*PipelineSpec) DeepCopyInto Uses

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 Uses

func (ps *PipelineSpec) SetDefaults(ctx context.Context)

func (*PipelineSpec) Validate Uses

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 Uses

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 Uses

func (in *PipelineStatus) DeepCopy() *PipelineStatus

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

func (*PipelineStatus) DeepCopyInto Uses

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 Uses

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 Uses

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

func (*PipelineTask) ConvertTo Uses

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

func (*PipelineTask) DeepCopy Uses

func (in *PipelineTask) DeepCopy() *PipelineTask

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

func (*PipelineTask) DeepCopyInto Uses

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 Uses

func (pt PipelineTask) Deps() []string

func (PipelineTask) HashKey Uses

func (pt PipelineTask) HashKey() string

type PipelineTaskCondition Uses

type PipelineTaskCondition = v1beta1.PipelineTaskCondition

PipelineTaskCondition allows a PipelineTask to declare a Condition to be evaluated before the Task is run.

type PipelineTaskInputResource Uses

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 Uses

type PipelineTaskList []PipelineTask

func (PipelineTaskList) DeepCopy Uses

func (in PipelineTaskList) DeepCopy() PipelineTaskList

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

func (PipelineTaskList) DeepCopyInto Uses

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 Uses

func (l PipelineTaskList) Items() []dag.Task

type PipelineTaskOutputResource Uses

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 Uses

type PipelineTaskParam = v1beta1.PipelineTaskParam

PipelineTaskParam is used to provide arbitrary string parameters to a Task.

type PipelineTaskResources Uses

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 Uses

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 Uses

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 Uses

func (in *PipelineTaskRunSpec) DeepCopy() *PipelineTaskRunSpec

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

func (*PipelineTaskRunSpec) DeepCopyInto Uses

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 Uses

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 Uses

type PodTemplate = pod.Template

type ResourceDeclaration Uses

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 Uses

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 Uses

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 Uses

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 Uses

func (in *Run) DeepCopy() *Run

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

func (*Run) DeepCopyInto Uses

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 Uses

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

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

func (*Run) GetConditionSet Uses

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

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

func (*Run) GetOwnerReference Uses

func (r *Run) GetOwnerReference() metav1.OwnerReference

GetOwnerReference gets the task run as owner reference for any related objects

func (*Run) GetRunKey Uses

func (r *Run) GetRunKey() string

GetRunKey return the taskrun key for timeout handler map

func (*Run) GetStatus Uses

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

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

func (*Run) HasPipelineRunOwnerReference Uses

func (r *Run) HasPipelineRunOwnerReference() bool

HasPipelineRunOwnerReference returns true of Run has owner reference of type PipelineRun

func (*Run) HasStarted Uses

func (r *Run) HasStarted() bool

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

func (*Run) IsDone Uses

func (r *Run) IsDone() bool

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

func (*Run) IsSuccessful Uses

func (r *Run) IsSuccessful() bool

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

func (*Run) SetDefaults Uses

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

func (*Run) Validate Uses

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

Validate taskrun

type RunList Uses

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 Uses

func (in *RunList) DeepCopy() *RunList

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

func (*RunList) DeepCopyInto Uses

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 Uses

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

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

type RunSpec Uses

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

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

RunSpec defines the desired state of Run

func (*RunSpec) DeepCopy Uses

func (in *RunSpec) DeepCopy() *RunSpec

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

func (*RunSpec) DeepCopyInto Uses

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 Uses

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 Uses

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

func (*RunSpec) Validate Uses

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

Validate Run spec

type RunStatus Uses

type RunStatus struct {
    duckv1.Status `json:",inline"`

    // RunStatusFields inlines the status fields.
    RunStatusFields `json:",inline"`
}

func (*RunStatus) DeepCopy Uses

func (in *RunStatus) DeepCopy() *RunStatus

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

func (*RunStatus) DeepCopyInto Uses

func (in *RunStatus) DeepCopyInto(out *RunStatus)

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

func (*RunStatus) GetCondition Uses

func (r *RunStatus) GetCondition(t apis.ConditionType) *apis.Condition

GetCondition returns the Condition matching the given type.

func (*RunStatus) InitializeConditions Uses

func (r *RunStatus) InitializeConditions()

InitializeConditions will set all conditions in runCondSet to unknown for the PipelineRun and set the started time to the current time

func (*RunStatus) SetCondition Uses

func (r *RunStatus) SetCondition(newCond *apis.Condition)

SetCondition sets the condition, unsetting previous conditions with the same type as necessary.

type RunStatusFields Uses

type RunStatusFields struct {
    // StartTime is the time the build is actually started.
    // +optional
    StartTime *metav1.Time `json:"startTime,omitempty"`

    // CompletionTime is the time the build completed.
    // +optional
    CompletionTime *metav1.Time `json:"completionTime,omitempty"`

    // Results reports any output result values to be consumed by later
    // tasks in a pipeline.
    // +optional
    Results []v1beta1.TaskRunResult `json:"results,omitempty"`
}

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.

func (*RunStatusFields) DeepCopy Uses

func (in *RunStatusFields) DeepCopy() *RunStatusFields

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

func (*RunStatusFields) DeepCopyInto Uses

func (in *RunStatusFields) DeepCopyInto(out *RunStatusFields)

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

type SecretParam Uses

type SecretParam = resource.SecretParam

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

type Sidecar Uses

type Sidecar = v1beta1.Sidecar

type SidecarState Uses

type SidecarState = v1beta1.SidecarState

SidecarState reports the results of sidecar in the Task.

type Step Uses

type Step = v1beta1.Step

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

func MergeStepsWithStepTemplate Uses

func MergeStepsWithStepTemplate(template *v1.Container, steps []Step) ([]Step, error)

MergeStepsWithStepTemplate takes a possibly nil container template and a list of steps, merging each of the steps with the container template, if it's not nil, and returning the resulting list. Deprecated

type StepState Uses

type StepState = v1beta1.StepState

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

type Task Uses

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 Uses

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

ConvertFrom implements api.Convertible

func (*Task) ConvertTo Uses

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

ConvertTo implements api.Convertible

func (*Task) Copy Uses

func (t *Task) Copy() TaskInterface

func (*Task) DeepCopy Uses

func (in *Task) DeepCopy() *Task

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

func (*Task) DeepCopyInto Uses

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 Uses

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

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

func (*Task) SetDefaults Uses

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

func (*Task) TaskMetadata Uses

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

func (*Task) TaskSpec Uses

func (t *Task) TaskSpec() TaskSpec

func (*Task) Validate Uses

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

type TaskInterface Uses

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

TaskInterface is implemented by Task and ClusterTask

type TaskKind Uses

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 Uses

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 Uses

func (in *TaskList) DeepCopy() *TaskList

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

func (*TaskList) DeepCopyInto Uses

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 Uses

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

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

type TaskModifier Uses

type TaskModifier = v1beta1.TaskModifier

TaskModifier is an interface to be implemented by different PipelineResources

type TaskRef Uses

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 Uses

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 Uses

type TaskResourceBinding = v1beta1.TaskResourceBinding

TaskResourceBinding points to the PipelineResource that will be used for the Task input or output called Name.

type TaskResult Uses

type TaskResult = v1beta1.TaskResult

TaskResult used to describe the results of a task

type TaskRun Uses

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 Uses

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

ConvertFrom implements api.Convertible

func (*TaskRun) ConvertTo Uses

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

ConvertTo implements api.Convertible

func (*TaskRun) DeepCopy Uses

func (in *TaskRun) DeepCopy() *TaskRun

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

func (*TaskRun) DeepCopyInto Uses

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 Uses

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

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

func (*TaskRun) GetBuildPodRef Uses

func (tr *TaskRun) GetBuildPodRef() corev1.ObjectReference

GetBuildPodRef for task

func (*TaskRun) GetOwnerReference Uses

func (tr *TaskRun) GetOwnerReference() metav1.OwnerReference

GetOwnerReference gets the task run as owner reference for any related objects

func (*TaskRun) GetPipelineRunPVCName Uses

func (tr *TaskRun) GetPipelineRunPVCName() string

GetPipelineRunPVCName for taskrun gets pipelinerun

func (*TaskRun) GetRunKey Uses

func (tr *TaskRun) GetRunKey() string

GetRunKey return the taskrun key for timeout handler map

func (*TaskRun) GetTimeout Uses

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

func (*TaskRun) HasPipelineRunOwnerReference Uses

func (tr *TaskRun) HasPipelineRunOwnerReference() bool

HasPipelineRunOwnerReference returns true of TaskRun has owner reference of type PipelineRun

func (*TaskRun) HasStarted Uses

func (tr *TaskRun) HasStarted() bool

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

func (*TaskRun) HasTimedOut Uses

func (tr *TaskRun) HasTimedOut() bool

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

func (*TaskRun) HasVolumeClaimTemplate Uses

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 Uses

func (tr *TaskRun) IsCancelled() bool

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

func (*TaskRun) IsDone Uses

func (tr *TaskRun) IsDone() bool

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

func (*TaskRun) IsPartOfPipeline Uses

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 Uses

func (tr *TaskRun) IsSuccessful() bool

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

func (*TaskRun) SetDefaults Uses

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

func (*TaskRun) Validate Uses

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

Validate taskrun

type TaskRunInputs Uses

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 Uses

func (in *TaskRunInputs) DeepCopy() *TaskRunInputs

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

func (*TaskRunInputs) DeepCopyInto Uses

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 Uses

func (i TaskRunInputs) Validate(ctx context.Context, path string) *apis.FieldError

type TaskRunList Uses

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 Uses

func (in *TaskRunList) DeepCopy() *TaskRunList

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

func (*TaskRunList) DeepCopyInto Uses

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 Uses

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

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

type TaskRunOutputs Uses

type TaskRunOutputs struct {
    // +optional
    Resources []TaskResourceBinding `json:"resources,omitempty"`
}

TaskRunOutputs holds the output values that this task was invoked with.

func (*TaskRunOutputs) DeepCopy Uses

func (in *TaskRunOutputs) DeepCopy() *TaskRunOutputs

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

func (*TaskRunOutputs) DeepCopyInto Uses

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 Uses

func (o TaskRunOutputs) Validate(ctx context.Context, path string) *apis.FieldError

type TaskRunResult Uses

type TaskRunResult = v1beta1.TaskRunResult

TaskRunResult used to describe the results of a task

type TaskRunSpec Uses

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 Uses

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

func (*TaskRunSpec) ConvertTo Uses

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

func (*TaskRunSpec) DeepCopy Uses

func (in *TaskRunSpec) DeepCopy() *TaskRunSpec

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

func (*TaskRunSpec) DeepCopyInto Uses

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 Uses

func (trs *TaskRunSpec) SetDefaults(ctx context.Context)

func (*TaskRunSpec) Validate Uses

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

Validate taskrun spec

type TaskRunSpecStatus Uses

type TaskRunSpecStatus = v1beta1.TaskRunSpecStatus

TaskRunSpecStatus defines the taskrun spec status the user can provide

type TaskRunStatus Uses

type TaskRunStatus = v1beta1.TaskRunStatus

TaskRunStatus defines the observed state of TaskRun

type TaskRunStatusFields Uses

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 Uses

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 Uses

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

func (*TaskSpec) ConvertTo Uses

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

func (*TaskSpec) DeepCopy Uses

func (in *TaskSpec) DeepCopy() *TaskSpec

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

func (*TaskSpec) DeepCopyInto Uses

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 Uses

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

SetDefaults set any defaults for the task spec

func (*TaskSpec) Validate Uses

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

type TestResult Uses

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 Uses

func (in *TestResult) DeepCopy() *TestResult

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

func (*TestResult) DeepCopyInto Uses

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 Uses

type WorkspaceBinding = v1beta1.WorkspaceBinding

WorkspaceBinding maps a Task's declared workspace to a Volume.

type WorkspaceDeclaration Uses

type WorkspaceDeclaration = v1beta1.WorkspaceDeclaration

WorkspaceDeclaration is a declaration of a volume that a Task requires.

type WorkspacePipelineTaskBinding Uses

type WorkspacePipelineTaskBinding = v1beta1.WorkspacePipelineTaskBinding

WorkspacePipelineTaskBinding describes how a workspace passed into the pipeline should be mapped to a task's declared workspace.

Package v1alpha1 imports 27 packages (graph) and is imported by 131 packages. Updated 2020-07-08. Refresh now. Tools for package owners.