v1alpha1

package
v0.4.2 Latest Latest
Warning

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

Go to latest
Published: Dec 21, 2023 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

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
	// ConversionErrorFieldNotAvailableMsg 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 (
	// 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 SchemeGroupVersion = schema.GroupVersion{Group: pipeline.GroupName, Version: "v1alpha1"}

SchemeGroupVersion is group version used to register these objects

Functions

func ApplyTaskModifier

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

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

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

Types

type ArrayOrString

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 CloudEventCondition

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

type CloudEventDelivery = v1beta1.CloudEventDelivery

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

type CloudEventDeliveryState

type CloudEventDeliveryState = v1beta1.CloudEventDeliveryState

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

type ClusterTask

type ClusterTask struct {
	metav1.TypeMeta `json:",inline"`

	metav1.ObjectMeta `json:"metadata,omitempty"`

	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) Copy

func (t *ClusterTask) Copy() TaskObject

Copy returns a DeepCopy of the ClusterTask.

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) TaskMetadata

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

TaskMetadata returns the ObjectMeta for the ClusterTask.

func (*ClusterTask) TaskSpec

func (t *ClusterTask) TaskSpec() TaskSpec

TaskSpec returns the ClusterTask's Spec.

type ClusterTaskList

type ClusterTaskList struct {
	metav1.TypeMeta `json:",inline"`

	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 EmbeddedRunSpec

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

	Metadata v1beta1.PipelineTaskMetadata `json:"metadata,omitempty"`

	Spec runtime.RawExtension `json:"spec,omitempty"`
}

EmbeddedRunSpec allows custom task definitions to be embedded

func (*EmbeddedRunSpec) DeepCopy

func (in *EmbeddedRunSpec) DeepCopy() *EmbeddedRunSpec

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

func (*EmbeddedRunSpec) DeepCopyInto

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 []TaskResource `json:"resources,omitempty"`

	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.

type InternalTaskModifier

type InternalTaskModifier = v1beta1.InternalTaskModifier

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

type Outputs

type Outputs struct {
	Results []TestResult `json:"results,omitempty"`

	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

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

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

	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec PipelineSpec `json:"spec"`

	Status *PipelineStatus `json:"status,omitempty"`
}

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.

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

	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

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

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

type PipelineResult = v1beta1.PipelineResult

PipelineResult used to describe the results of a pipeline

type PipelineRun

type PipelineRun struct {
	metav1.TypeMeta `json:",inline"`

	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec PipelineRunSpec `json:"spec,omitempty"`

	Status PipelineRunStatus `json:"status,omitempty"`
}

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) GetName

func (pr *PipelineRun) GetName() string

GetName returns the PipelineRun's name

type PipelineRunList

type PipelineRunList struct {
	metav1.TypeMeta `json:",inline"`

	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 {
	PipelineRef *PipelineRef `json:"pipelineRef,omitempty"`

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

	ServiceAccountName string `json:"serviceAccountName,omitempty"`

	Status PipelineRunSpecStatus `json:"status,omitempty"`

	Timeout *metav1.Duration `json:"timeout,omitempty"`
	// PodTemplate holds pod specific configuration
	PodTemplate *PodTemplate `json:"podTemplate,omitempty"`

	Workspaces []WorkspaceBinding `json:"workspaces,omitempty"`

	TaskRunSpecs []PipelineTaskRunSpec `json:"taskRunSpecs,omitempty"`
}

PipelineRunSpec defines the desired state of PipelineRun

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.

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

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

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 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 []PipelineWorkspaceDeclaration `json:"workspaces,omitempty"`

	Results []PipelineResult `json:"results,omitempty"`
}

PipelineSpec defines the desired state of Pipeline.

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.

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 *TaskRef `json:"taskRef,omitempty"`

	TaskSpec *TaskSpec `json:"taskSpec,omitempty"`

	Retries int `json:"retries,omitempty"`

	RunAfter []string `json:"runAfter,omitempty"`

	Resources *PipelineTaskResources `json:"resources,omitempty"`

	Params []Param `json:"params,omitempty"`

	Workspaces []WorkspacePipelineTaskBinding `json:"workspaces,omitempty"`

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

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

type PipelineTaskList []PipelineTask

PipelineTaskList is a list of PipelineTasks

func (PipelineTaskList) DeepCopy

func (in PipelineTaskList) DeepCopy() PipelineTaskList

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

func (PipelineTaskList) DeepCopyInto

func (in PipelineTaskList) DeepCopyInto(out *PipelineTaskList)

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

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

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

func (in *PipelineTaskRunSpec) DeepCopy() *PipelineTaskRunSpec

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

func (*PipelineTaskRunSpec) DeepCopyInto

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

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

type PodTemplate = pod.Template

PodTemplate holds pod specific configuration

type ResourceDeclaration

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

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

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

type Run struct {
	metav1.TypeMeta `json:",inline"`

	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec RunSpec `json:"spec,omitempty"`

	Status RunStatus `json:"status,omitempty"`
}

func (*Run) DeepCopy

func (in *Run) DeepCopy() *Run

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

func (*Run) DeepCopyInto

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

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

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

type RunList

type RunList struct {
	metav1.TypeMeta `json:",inline"`

	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Run `json:"items"`
}

RunList contains a list of Run

func (*RunList) DeepCopy

func (in *RunList) DeepCopy() *RunList

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

func (*RunList) DeepCopyInto

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

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

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

type RunResult

type RunResult = runv1alpha1.RunResult

RunResult used to describe the results of a task

type RunSpec

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

	Spec *EmbeddedRunSpec `json:"spec,omitempty"`

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

	Status RunSpecStatus `json:"status,omitempty"`

	Retries int `json:"retries,omitempty"`

	ServiceAccountName string `json:"serviceAccountName"`

	PodTemplate *PodTemplate `json:"podTemplate,omitempty"`

	Timeout *metav1.Duration `json:"timeout,omitempty"`

	Workspaces []v1beta1.WorkspaceBinding `json:"workspaces,omitempty"`
}

RunSpec defines the desired state of Run

func (*RunSpec) DeepCopy

func (in *RunSpec) DeepCopy() *RunSpec

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

func (*RunSpec) DeepCopyInto

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

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

type RunSpecStatus

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

type RunStatus = runv1alpha1.RunStatus

RunStatus defines the observed state of Run.

type RunStatusFields

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

type Sidecar = v1beta1.Sidecar

Sidecar has nearly the same data structure as Step, consisting of a Container and an optional Script, but does not have the ability to timeout.

type SidecarState

type SidecarState = v1beta1.SidecarState

SidecarState reports the results of sidecar in the Task.

type Step

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 StepTemplate

type StepTemplate = v1beta1.StepTemplate

StepTemplate is a template for a Step

type Task

type Task struct {
	metav1.TypeMeta `json:",inline"`

	metav1.ObjectMeta `json:"metadata"`

	Spec TaskSpec `json:"spec"`
}

func (*Task) Copy

func (t *Task) Copy() TaskObject

Copy returns a deep copy of the task

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) TaskMetadata

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

TaskMetadata returns the task's ObjectMeta

func (*Task) TaskSpec

func (t *Task) TaskSpec() TaskSpec

TaskSpec returns the task's spec

type TaskKind

type TaskKind = v1beta1.TaskKind

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

	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

type TaskModifier = v1beta1.TaskModifier

TaskModifier is an interface to be implemented by different PipelineResources

type TaskObject

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

type TaskResult = v1beta1.TaskResult

TaskResult used to describe the results of a task

type TaskRun

type TaskRun struct {
	metav1.TypeMeta `json:",inline"`

	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec TaskRunSpec `json:"spec,omitempty"`

	Status TaskRunStatus `json:"status,omitempty"`
}

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.

type TaskRunInputs

type TaskRunInputs struct {
	Resources []TaskResourceBinding `json:"resources,omitempty"`

	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.

type TaskRunList

type TaskRunList struct {
	metav1.TypeMeta `json:",inline"`

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

type TaskRunResult

type TaskRunResult = v1beta1.TaskRunResult

TaskRunResult used to describe the results of a task

type TaskRunSpec

type TaskRunSpec struct {
	ServiceAccountName string `json:"serviceAccountName"`

	TaskRef *TaskRef `json:"taskRef,omitempty"`

	TaskSpec *TaskSpec `json:"taskSpec,omitempty"`

	Status TaskRunSpecStatus `json:"status,omitempty"`

	Timeout *metav1.Duration `json:"timeout,omitempty"`

	PodTemplate *PodTemplate `json:"podTemplate,omitempty"`

	Workspaces []WorkspaceBinding `json:"workspaces,omitempty"`

	Params []Param `json:"params,omitempty"`

	Resources *v1beta1.TaskRunResources `json:"resources,omitempty"`

	Inputs *TaskRunInputs `json:"inputs,omitempty"`

	Outputs *TaskRunOutputs `json:"outputs,omitempty"`
}

TaskRunSpec defines the desired state of TaskRun

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.

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

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 *Inputs `json:"inputs,omitempty"`

	Outputs *Outputs `json:"outputs,omitempty"`
}

TaskSpec defines the desired state of Task.

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.

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

type WorkspaceBinding = v1beta1.WorkspaceBinding

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

type WorkspaceDeclaration

type WorkspaceDeclaration = v1beta1.WorkspaceDeclaration

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

type WorkspacePipelineTaskBinding

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
y or Y : Canonical URL