v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the pipelineloop v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:defaulter-gen=TypeMeta +groupName=custom.tekton.dev

Index

• Variables
• func Kind(kind string) schema.GroupKind
• func Resource(resource string) schema.GroupResource
• type PipelineLoop
  • func (in *PipelineLoop) DeepCopy() *PipelineLoop
  • func (in *PipelineLoop) DeepCopyInto(out *PipelineLoop)
  • func (in *PipelineLoop) DeepCopyObject() runtime.Object
  • func (tl *PipelineLoop) SetDefaults(ctx context.Context)
  • func (tl *PipelineLoop) Validate(ctx context.Context) *apis.FieldError
• type PipelineLoopList
  • func (in *PipelineLoopList) DeepCopy() *PipelineLoopList
  • func (in *PipelineLoopList) DeepCopyInto(out *PipelineLoopList)
  • func (in *PipelineLoopList) DeepCopyObject() runtime.Object
• type PipelineLoopPipelineRunStatus
  • func (in *PipelineLoopPipelineRunStatus) DeepCopy() *PipelineLoopPipelineRunStatus
  • func (in *PipelineLoopPipelineRunStatus) DeepCopyInto(out *PipelineLoopPipelineRunStatus)
• type PipelineLoopRunReason
  • func (t PipelineLoopRunReason) String() string
• type PipelineLoopRunStatus
  • func (in *PipelineLoopRunStatus) DeepCopy() *PipelineLoopRunStatus
  • func (in *PipelineLoopRunStatus) DeepCopyInto(out *PipelineLoopRunStatus)
• type PipelineLoopSpec
  • func (in *PipelineLoopSpec) DeepCopy() *PipelineLoopSpec
  • func (in *PipelineLoopSpec) DeepCopyInto(out *PipelineLoopSpec)
  • func (tls *PipelineLoopSpec) SetDefaults(ctx context.Context)
  • func (tls *PipelineLoopSpec) Validate(ctx context.Context) *apis.FieldError

Variables

var (

	// AddToScheme adds Build types to the scheme.
	AddToScheme = schemeBuilder.AddToScheme
)

var SchemeGroupVersion = schema.GroupVersion{Group: pipelineloop.GroupName, Version: "v1alpha1"}

SchemeGroupVersion is group version used to register these objects

Functions

func Kind

func Kind(kind string) schema.GroupKind

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

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type PipelineLoop

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

	// Spec holds the desired state of the PipelineLoop from the client
	// +optional
	Spec PipelineLoopSpec `json:"spec"`
}

PipelineLoop iteratively executes a Task over elements in an array. +k8s:openapi-gen=true

func (*PipelineLoop) DeepCopy

func (in *PipelineLoop) DeepCopy() *PipelineLoop

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

func (*PipelineLoop) DeepCopyInto

func (in *PipelineLoop) DeepCopyInto(out *PipelineLoop)

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

func (*PipelineLoop) DeepCopyObject

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

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

func (*PipelineLoop) SetDefaults

func (tl *PipelineLoop) SetDefaults(ctx context.Context)

SetDefaults set any defaults for the PipelineLoop

func (*PipelineLoop) Validate

func (tl *PipelineLoop) Validate(ctx context.Context) *apis.FieldError

Validate PipelineLoop

type PipelineLoopList

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

PipelineLoopList contains a list of PipelineLoops

func (*PipelineLoopList) DeepCopy

func (in *PipelineLoopList) DeepCopy() *PipelineLoopList

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

func (*PipelineLoopList) DeepCopyInto

func (in *PipelineLoopList) DeepCopyInto(out *PipelineLoopList)

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

func (*PipelineLoopList) DeepCopyObject

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

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

type PipelineLoopPipelineRunStatus

type PipelineLoopPipelineRunStatus struct {
	// iteration number
	Iteration int `json:"iteration,omitempty"`
	// the current iteration item
	IterationItem interface{} `json:"iterationItem,omitempty"`
	// Status is the TaskRunStatus for the corresponding TaskRun
	// +optional
	Status *tektonv1.PipelineRunStatus `json:"status,omitempty"`
}

PipelineLoopPipelineRunStatus contains the iteration number for a PipelineRun, current running pipeline number, and the PipelineRun's Status

func (*PipelineLoopPipelineRunStatus) DeepCopy

func (in *PipelineLoopPipelineRunStatus) DeepCopy() *PipelineLoopPipelineRunStatus

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

func (*PipelineLoopPipelineRunStatus) DeepCopyInto

func (in *PipelineLoopPipelineRunStatus) DeepCopyInto(out *PipelineLoopPipelineRunStatus)

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

type PipelineLoopRunReason

type PipelineLoopRunReason string

PipelineLoopRunReason represents a reason for the Run "Succeeded" condition

const (
	// PipelineLoopRunReasonStarted is the reason set when the Run has just started
	PipelineLoopRunReasonStarted PipelineLoopRunReason = "Started"

	// PipelineLoopRunReasonCacheHit indicates that the Run result was fetched from cache instead of performing an actual run.
	PipelineLoopRunReasonCacheHit PipelineLoopRunReason = "CacheHit"

	// PipelineLoopRunReasonRunning indicates that the Run is in progress
	PipelineLoopRunReasonRunning PipelineLoopRunReason = "Running"

	// PipelineLoopRunReasonFailed indicates that one of the TaskRuns created from the Run failed
	PipelineLoopRunReasonFailed PipelineLoopRunReason = "Failed"

	// PipelineLoopRunReasonRecursionLimitExceeded indicates that one of the TaskRuns created from the Run has exceeded stack limit
	PipelineLoopRunReasonStackLimitExceeded PipelineLoopRunReason = "NestedCallStackLimitExceeded"

	// PipelineLoopRunReasonSucceeded indicates that all of the TaskRuns created from the Run completed successfully
	PipelineLoopRunReasonSucceeded PipelineLoopRunReason = "Succeeded"

	// PipelineLoopRunReasonCancelled indicates that a Run was cancelled.
	PipelineLoopRunReasonCancelled PipelineLoopRunReason = "PipelineLoopRunCancelled"

	// PipelineLoopRunReasonCouldntCancel indicates that a Run was cancelled but attempting to update
	// the running TaskRun as cancelled failed.
	PipelineLoopRunReasonCouldntCancel PipelineLoopRunReason = "PipelineLoopRunCouldntCancel"

	// PipelineLoopRunReasonCouldntGetPipelineLoop indicates that the associated PipelineLoop couldn't be retrieved
	PipelineLoopRunReasonCouldntGetPipelineLoop PipelineLoopRunReason = "CouldntGetPipelineLoop"

	// PipelineLoopRunReasonFailedValidation indicates that the PipelineLoop failed runtime validation
	PipelineLoopRunReasonFailedValidation PipelineLoopRunReason = "PipelineLoopValidationFailed"

	// PipelineLoopRunReasonInternalError indicates that the PipelineLoop failed due to an internal error in the reconciler
	PipelineLoopRunReasonInternalError PipelineLoopRunReason = "PipelineLoopInternalError"
)

func (PipelineLoopRunReason) String

func (t PipelineLoopRunReason) String() string

type PipelineLoopRunStatus

type PipelineLoopRunStatus struct {
	// PipelineLoopSpec contains the exact spec used to instantiate the Run
	PipelineLoopSpec *PipelineLoopSpec `json:"pipelineLoopSpec,omitempty"`
	// current running pipelinerun number
	// +optional
	CurrentRunning int `json:"currentRunning,omitempty"`
	// map of PipelineLoopPipelineRunStatus with the PipelineRun name as the key
	// +optional
	PipelineRuns map[string]*PipelineLoopPipelineRunStatus `json:"pipelineRuns,omitempty"`
}

PipelineLoopRunStatus contains the status stored in the ExtraFields of a Run that references a PipelineLoop.

func (*PipelineLoopRunStatus) DeepCopy

func (in *PipelineLoopRunStatus) DeepCopy() *PipelineLoopRunStatus

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

func (*PipelineLoopRunStatus) DeepCopyInto

func (in *PipelineLoopRunStatus) DeepCopyInto(out *PipelineLoopRunStatus)

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

type PipelineLoopSpec

type PipelineLoopSpec struct {
	// TaskRef is a reference to a task definition.
	// +optional
	// TaskRef     *tektonv1.TaskRef     `json:"taskRef,omitempty"`
	PipelineRef *tektonv1.PipelineRef `json:"pipelineRef,omitempty"`

	// TaskSpec is a specification of a task
	// +optional
	PipelineSpec *tektonv1.PipelineSpec `json:"pipelineSpec,omitempty"`

	// IterateParam is the name of the task parameter that is iterated upon.
	IterateParam string `json:"iterateParam"`

	// The separator for IterateParam if the IterateParam is a strings with separator char, this field is optional.
	// +optional
	IterateParamSeparator string `json:"iterateParamStringSeparator,omitempty"`

	// +optional
	IterationNumberParam string `json:"iterationNumberParam,omitempty"`

	IterateNumeric string `json:"iterateNumeric"`

	// Time after which the TaskRun times out.
	// +optional
	Timeout *metav1.Duration `json:"timeout,omitempty"`

	// Parallelism represents how many pipelines can be triggered simultaneously by the loop.
	// +optional
	Parallelism int `json:"parallelism,omitempty"`

	// Retries represents how many times a task should be retried in case of task failure.
	// +optional
	Retries int `json:"retries,omitempty"`

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

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

	// Workspace to a volume mapping to be consumed by a PipelineRun.
	// +optional
	Workspaces []tektonv1.WorkspaceBinding `json:"workspaces,omitempty"`

	// TaskRunSpecs holds a set of runtime specs
	// +optional
	TaskRunSpecs []tektonv1.PipelineTaskRunSpec `json:"taskRunSpecs,omitempty"`
}

PipelineLoopSpec defines the desired state of the PipelineLoop

func (*PipelineLoopSpec) DeepCopy

func (in *PipelineLoopSpec) DeepCopy() *PipelineLoopSpec

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

func (*PipelineLoopSpec) DeepCopyInto

func (in *PipelineLoopSpec) DeepCopyInto(out *PipelineLoopSpec)

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

func (*PipelineLoopSpec) SetDefaults

func (tls *PipelineLoopSpec) SetDefaults(ctx context.Context)

SetDefaults set any defaults for the PipelineLoop spec

func (*PipelineLoopSpec) Validate

func (tls *PipelineLoopSpec) Validate(ctx context.Context) *apis.FieldError

Validate PipelineLoopSpec