pipeline

Documentation

Index

• Constants
• Variables
• type Images
  • func (i Images) Validate() error
• type Options

Constants

const (
	// PipelineRunControllerName holds the name of the PipelineRun controller
	PipelineRunControllerName = "PipelineRun"

	// PipelineControllerName holds the name of the Pipeline controller
	PipelineControllerName = "Pipeline"

	// TaskRunControllerName holds the name of the TaskRun controller
	TaskRunControllerName = "TaskRun"

	// TaskControllerName holds the name of the Task controller
	TaskControllerName = "Task"

	// ClusterTaskControllerName holds the name of the Task controller
	ClusterTaskControllerName = "ClusterTask"

	// RunControllerName holds the name of the Custom Task controller
	RunControllerName = "Run"

	// CustomRunControllerName holds the name of the CustomRun controller
	CustomRunControllerName = "CustomRun"
)

const (
	// WorkspaceDir is the root directory used for PipelineResources and (by default) Workspaces
	WorkspaceDir = "/workspace"
	// DefaultResultPath is the path for a task result to create the result file
	DefaultResultPath = "/tekton/results"
	// HomeDir is the HOME directory of PipelineResources
	HomeDir = "/tekton/home"
	// CredsDir is the directory where credentials are placed to meet the legacy credentials
	// helpers image (aka "creds-init") contract
	CredsDir = "/tekton/creds" // #nosec
	// StepsDir is the directory used for a step to store any metadata related to the step
	StepsDir = "/tekton/steps"
)

const (
	// GroupName is the Kubernetes resource group name for Pipeline types.
	GroupName = "tekton.dev"

	// ClusterTaskLabelKey is used as the label identifier for a ClusterTask
	ClusterTaskLabelKey = GroupName + "/clusterTask"

	// TaskLabelKey is used as the label identifier for a Task
	TaskLabelKey = GroupName + "/task"

	// TaskRunLabelKey is used as the label identifier for a TaskRun
	TaskRunLabelKey = GroupName + "/taskRun"

	// PipelineLabelKey is used as the label identifier for a Pipeline
	PipelineLabelKey = GroupName + "/pipeline"

	// PipelineRunLabelKey is used as the label identifier for a PipelineRun
	PipelineRunLabelKey = GroupName + "/pipelineRun"

	// PipelineTaskLabelKey is used as the label identifier for a PipelineTask
	PipelineTaskLabelKey = GroupName + "/pipelineTask"

	// RunKey is used as the label identifier for a Run
	RunKey = GroupName + "/run"

	// CustomRunKey is used as the label identifier for a CustomRun
	CustomRunKey = GroupName + "/customRun"

	// MemberOfLabelKey is used as the label identifier for a PipelineTask
	// Set to Tasks/Finally depending on the position of the PipelineTask
	MemberOfLabelKey = GroupName + "/memberOf"
)

const (
	// ReservedResultsSidecarName is the name of the results sidecar that outputs the results to stdout
	// when the results-from feature-flag is set to "sidecar-logs".
	ReservedResultsSidecarName = "tekton-log-results"

	// ReservedResultsSidecarContainerName is the name of the results sidecar container that is injected
	// by the reconciler.
	ReservedResultsSidecarContainerName = "sidecar-tekton-log-results"
)

const (
	// TektonReservedAnnotationExpr is the expression we use to filter out reserved key in annotation
	TektonReservedAnnotationExpr = "(results.tekton.dev|chains.tekton.dev)/.*"
)

Variables

var (
	// TaskResource represents a Tekton Task
	TaskResource = schema.GroupResource{
		Group:    GroupName,
		Resource: "tasks",
	}
	// ClusterTaskResource represents a Tekton ClusterTask
	ClusterTaskResource = schema.GroupResource{
		Group:    GroupName,
		Resource: "clustertasks",
	}
	// TaskRunResource represents a Tekton TaskRun
	TaskRunResource = schema.GroupResource{
		Group:    GroupName,
		Resource: "taskruns",
	}
	// RunResource represents a Tekton Run
	RunResource = schema.GroupResource{
		Group:    GroupName,
		Resource: "runs",
	}
	// PipelineResource represents a Tekton Pipeline
	PipelineResource = schema.GroupResource{
		Group:    GroupName,
		Resource: "pipelines",
	}
	// PipelineRunResource represents a Tekton PipelineRun
	PipelineRunResource = schema.GroupResource{
		Group:    GroupName,
		Resource: "pipelineruns",
	}

	// CustomRunResource represents a Tekton CustomRun
	CustomRunResource = schema.GroupResource{
		Group:    GroupName,
		Resource: "customruns",
	}
)

Types

type Images

type Images struct {
	// EntrypointImage is container image containing our entrypoint binary.
	EntrypointImage string
	// SidecarLogResultsImage is container image containing the binary that fetches results from the steps and logs it to stdout.
	SidecarLogResultsImage string
	// NopImage is the container image used to kill sidecars.
	NopImage string
	// ShellImage is the container image containing bash shell.
	ShellImage string
	// ShellImageWin is the container image containing powershell.
	ShellImageWin string
	// WorkingDirInitImage is the container image containing our working dir init binary.
	WorkingDirInitImage string
}

Images holds the images reference for a number of container images used across tektoncd pipelines.

func (Images) Validate

func (i Images) Validate() error

Validate returns an error if any image is not set.

type Options

type Options struct {
	Images Images
}

Options holds options passed to the Tekton Pipeline controllers typically via command-line flags.