v1alpha1

Documentation

Overview

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

Index

• Constants
• Variables
• func Kind(kind string) schema.GroupKind
• func Resource(resource string) schema.GroupResource
• type ParamBinding
  • func (in *ParamBinding) DeepCopy() *ParamBinding
  • func (in *ParamBinding) DeepCopyInto(out *ParamBinding)
• type Step
  • func (in *Step) DeepCopy() *Step
  • func (in *Step) DeepCopyInto(out *Step)
  • func (s Step) Validate(ctx context.Context) (errs *apis.FieldError)
• type TaskGroup
  • func (in *TaskGroup) DeepCopy() *TaskGroup
  • func (in *TaskGroup) DeepCopyInto(out *TaskGroup)
  • func (in *TaskGroup) DeepCopyObject() runtime.Object
  • func (tl *TaskGroup) SetDefaults(ctx context.Context)
  • func (tg *TaskGroup) Validate(ctx context.Context) *apis.FieldError
• type TaskGroupList
  • func (in *TaskGroupList) DeepCopy() *TaskGroupList
  • func (in *TaskGroupList) DeepCopyInto(out *TaskGroupList)
  • func (in *TaskGroupList) DeepCopyObject() runtime.Object
• type TaskGroupRunReason
  • func (t TaskGroupRunReason) String() string
• type TaskGroupRunStatus
  • func (in *TaskGroupRunStatus) DeepCopy() *TaskGroupRunStatus
  • func (in *TaskGroupRunStatus) DeepCopyInto(out *TaskGroupRunStatus)
• type TaskGroupSpec
  • func (in *TaskGroupSpec) DeepCopy() *TaskGroupSpec
  • func (in *TaskGroupSpec) DeepCopyInto(out *TaskGroupSpec)
  • func (tls *TaskGroupSpec) SetDefaults(ctx context.Context)
  • func (tgs *TaskGroupSpec) Validate(ctx context.Context) (errs *apis.FieldError)
• type Uses
  • func (in *Uses) DeepCopy() *Uses
  • func (in *Uses) DeepCopyInto(out *Uses)
  • func (u *Uses) Validate(ctx context.Context) (errs *apis.FieldError)
• type WorkspaceBinding
  • func (in *WorkspaceBinding) DeepCopy() *WorkspaceBinding
  • func (in *WorkspaceBinding) DeepCopyInto(out *WorkspaceBinding)

Constants

const ManagedByLabelKey = "app.kubernetes.io/managed-by"

Variables

var (

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

var SchemeGroupVersion = schema.GroupVersion{Group: taskgroup.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 ParamBinding

type ParamBinding struct {
	Name  string `json:"name"`
	Param string `json:"param"`
}

func (*ParamBinding) DeepCopy

func (in *ParamBinding) DeepCopy() *ParamBinding

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

func (*ParamBinding) DeepCopyInto

func (in *ParamBinding) DeepCopyInto(out *ParamBinding)

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

type Step

type Step struct {
	v1beta1.Step `json:",inline"`

	// +optional
	Uses *Uses `json:"uses"`
}

func (*Step) DeepCopy

func (in *Step) DeepCopy() *Step

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

func (*Step) DeepCopyInto

func (in *Step) DeepCopyInto(out *Step)

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

func (Step) Validate

func (s Step) Validate(ctx context.Context) (errs *apis.FieldError)

type TaskGroup

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

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

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

func (*TaskGroup) DeepCopy

func (in *TaskGroup) DeepCopy() *TaskGroup

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

func (*TaskGroup) DeepCopyInto

func (in *TaskGroup) DeepCopyInto(out *TaskGroup)

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

func (*TaskGroup) DeepCopyObject

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

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

func (*TaskGroup) SetDefaults

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

SetDefaults set any defaults for the TaskGroup

func (*TaskGroup) Validate

func (tg *TaskGroup) Validate(ctx context.Context) *apis.FieldError

Validate TaskGroup

type TaskGroupList

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

TaskGroupList contains a list of TaskGroups

func (*TaskGroupList) DeepCopy

func (in *TaskGroupList) DeepCopy() *TaskGroupList

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

func (*TaskGroupList) DeepCopyInto

func (in *TaskGroupList) DeepCopyInto(out *TaskGroupList)

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

func (*TaskGroupList) DeepCopyObject

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

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

type TaskGroupRunReason

type TaskGroupRunReason string

TaskGroupRunReason represents a reason for the Run "Succeeded" condition

const (
	// TaskGroupRunReasonStarted is the reason set when the Run has just started
	TaskGroupRunReasonStarted TaskGroupRunReason = "Started"

	// TaskGroupRunReasonRunning indicates that the Run is in progress
	TaskGroupRunReasonRunning TaskGroupRunReason = "Running"

	// TaskGroupRunReasonFailed indicates that one of the TaskRuns created from the Run failed
	TaskGroupRunReasonFailed TaskGroupRunReason = "Failed"

	// TaskGroupRunReasonSucceeded indicates that all of the TaskRuns created from the Run completed successfully
	TaskGroupRunReasonSucceeded TaskGroupRunReason = "Succeeded"

	// TaskGroupRunReasonCouldntCancel indicates that a Run was cancelled but attempting to update
	// the running TaskRun as cancelled failed.
	TaskGroupRunReasonCouldntCancel TaskGroupRunReason = "TaskGroupRunCouldntCancel"

	// TaskGroupRunReasonCouldntGetTaskGroup indicates that the associated TaskGroup couldn't be retrieved
	TaskGroupRunReasonCouldntGetTaskGroup TaskGroupRunReason = "CouldntGetTaskGroup"

	// TaskGroupRunReasonFailedValidation indicates that the TaskGroup failed runtime validation
	TaskGroupRunReasonFailedValidation TaskGroupRunReason = "TaskGroupValidationFailed"

	// TaskGroupRunReasonInternalError indicates that the TaskGroup failed due to an internal error in the reconciler
	TaskGroupRunReasonInternalError TaskGroupRunReason = "TaskGroupInternalError"
)

func (TaskGroupRunReason) String

func (t TaskGroupRunReason) String() string

type TaskGroupRunStatus

type TaskGroupRunStatus struct {
	// TaskGroupSpec contains the exact spec used to instantiate the Run
	// FIXME(openshift-pipelines) can probably remove
	TaskGroupSpec *TaskGroupSpec `json:"taskLoopSpec,omitempty"`
	// +optional
	TaskRun *v1beta1.TaskRunStatus `json:"status,omitempty"`
}

TaskGroupRunStatus contains the status stored in the ExtraFields of a Run that references a TaskGroup.

func (*TaskGroupRunStatus) DeepCopy

func (in *TaskGroupRunStatus) DeepCopy() *TaskGroupRunStatus

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

func (*TaskGroupRunStatus) DeepCopyInto

func (in *TaskGroupRunStatus) DeepCopyInto(out *TaskGroupRunStatus)

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

type TaskGroupSpec

type TaskGroupSpec struct {
	// Params is a list of input parameters required to run the task. Params
	// must be supplied as inputs in TaskRuns unless they declare a default
	// value.
	// +optional
	Params []v1beta1.ParamSpec `json:"params,omitempty"`

	// Description is a user-facing description of the task that may be
	// used to populate a UI.
	// +optional
	Description string `json:"description,omitempty"`

	// Steps are the steps of the build; each step is run sequentially with the
	// source mounted into /workspace.
	Steps []Step `json:"steps,omitempty"`

	// Volumes is a collection of volumes that are available to mount into the
	// steps of the build.
	Volumes []corev1.Volume `json:"volumes,omitempty"`

	// StepTemplate can be used as the basis for all step containers within the
	// Task, so that the steps inherit settings on the base container.
	StepTemplate *corev1.Container `json:"stepTemplate,omitempty"`

	// Sidecars are run alongside the Task's step containers. They begin before
	// the steps start and end after the steps complete.
	Sidecars []v1beta1.Sidecar `json:"sidecars,omitempty"`

	// Workspaces are the volumes that this Task requires.
	Workspaces []v1beta1.WorkspaceDeclaration `json:"workspaces,omitempty"`

	// Results are values that this Task can output
	Results []v1beta1.TaskResult `json:"results,omitempty"`
}

TaskGroupSpec defines the desired state of the TaskGroup

func (*TaskGroupSpec) DeepCopy

func (in *TaskGroupSpec) DeepCopy() *TaskGroupSpec

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

func (*TaskGroupSpec) DeepCopyInto

func (in *TaskGroupSpec) DeepCopyInto(out *TaskGroupSpec)

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

func (*TaskGroupSpec) SetDefaults

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

SetDefaults set any defaults for the TaskGroup spec

func (*TaskGroupSpec) Validate

func (tgs *TaskGroupSpec) Validate(ctx context.Context) (errs *apis.FieldError)

Validate TaskGroupSpec

type Uses

type Uses struct {
	TaskRef v1beta1.TaskRef `json:"taskRef"`

	ParamBindings     []ParamBinding     `json:"parambindings"`
	WorkspaceBindings []WorkspaceBinding `json:"workspacebindings"`
}

func (*Uses) DeepCopy

func (in *Uses) DeepCopy() *Uses

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

func (*Uses) DeepCopyInto

func (in *Uses) DeepCopyInto(out *Uses)

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

func (*Uses) Validate

func (u *Uses) Validate(ctx context.Context) (errs *apis.FieldError)

type WorkspaceBinding

type WorkspaceBinding struct {
	Name      string `json:"name"`
	Workspace string `json:"workspace"`
}

func (*WorkspaceBinding) DeepCopy

func (in *WorkspaceBinding) DeepCopy() *WorkspaceBinding

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

func (*WorkspaceBinding) DeepCopyInto

func (in *WorkspaceBinding) DeepCopyInto(out *WorkspaceBinding)

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