package
0.69.0
Repository: https://github.com/tektoncd/pipeline.git
Documentation: pkg.go.dev

# Functions

CancelPod cancels the pod.
DidTaskRunFail check the status of pod to decide if related taskrun is failed.
GetContainerName prefixes the input name with "step-".
IsContainerSidecar returns true if the container name indicates that it represents a sidecar.
IsContainerStep returns true if the container name indicates that it represents a step.
isNativeSidecarSupport returns true if k8s api has native sidecar support based on the k8s version (1.29+).
IsPodArchived indicates if a pod is archived in the retriesStatus.
IsPodExceedingNodeResources returns true if the Pod's status indicates there are insufficient resources to schedule the Pod.
IsSidecarStatusRunning determines if any SidecarStatus on a TaskRun is still running.
MakeTaskRunStatus returns a TaskRunStatus based on the Pod's status.
NewEntrypointCache returns a new entrypoint cache implementation that uses K8s credentials to pull image metadata from a container image registry.
SidecarsReady returns true if all of the Pod's sidecars are Ready or Terminated.
StepName returns the step name after adding "step-" prefix to the actual step name or returns "step-unnamed-<step-index>" if not specified.
StopSidecars updates sidecar containers in the Pod to a nop image, which exits successfully immediately.
TrimSidecarPrefix returns the container name, stripped of its sidecar prefix.
TrimStepPrefix returns the container name, stripped of its step prefix.
UpdateReady updates the Pod's annotations to signal the first step to start by projecting the ready annotation via the Downward API.

# Constants

ExecutionModeAnnotation is an experimental optional annotation to set the execution mode on a TaskRun.
ExecutionModeHermetic indicates hermetic execution mode.
OsSelectorLabel is the label Kubernetes uses for OS-specific workloads (https://kubernetes.io/docs/reference/labels-annotations-taints/#kubernetes-io-os).
ReasonCreateContainerConfigError indicates that the TaskRun failed to create a pod due to config error of container.
ReasonExceededNodeResources indicates that the TaskRun's pod has failed to start due to resource constraints on the node.
ReasonExceededResourceQuota indicates that the TaskRun failed to create a pod due to a ResourceQuota in the namespace.
ReasonPodAdmissionFailed indicates that the TaskRun's pod failed to pass admission validation.
ReasonPodCreationFailed indicates that the reason for the current condition is that the creation of the pod backing the TaskRun failed.
ReasonPending indicates that the pod is in corev1.Pending, and the reason is not ReasonExceededNodeResources or isPodHitConfigError.
ReasonPullImageFailed indicates that the TaskRun's pod failed to pull image.
RunDir is the directory that contains runtime variable data for TaskRuns.
K8s version to determine if to use native k8s sidecar or Tekton sidecar.
SpiffeCsiDriver is the CSI storage plugin needed for injection of SPIFFE workload api.
TektonHermeticEnvVar is the env var we set in containers to indicate they should be run hermetically.
TerminationReasonCancelled indicates a step was cancelled.
TerminationReasonContinued indicates a step errored but was ignored since onError was set to continue.
TerminationReasonSkipped indicates a step execution was skipped due to previous step failed.
TerminationReasonTimeoutExceeded indicates a step execution timed out.

# Variables

DownwardMountCancelFile is cancellation file mount to step, entrypoint will check this file to cancel the step.
LinuxSecurityContext allow init containers to run in namespaces with "restricted" pod security admission See https://kubernetes.io/docs/concepts/security/pod-security-standards/#restricted.
MaxActiveDeadlineSeconds is a maximum permitted value to be used for a task with no timeout.
ReasonFailedResolution indicated that the reason for failure status is that references within the TaskRun could not be resolved.
ReasonFailedValidation indicated that the reason for failure status is that taskrun failed runtime validation.
ReasonResourceVerificationFailed indicates that the task fails the trusted resource verification, it could be the content has changed, signature is invalid or public key is invalid.
ReasonTaskFailedValidation indicated that the reason for failure status is that task failed runtime validation.
These are effectively const, but Go doesn't have such an annotation.
WindowsSecurityContext adds securityContext that is supported by Windows OS.

# Structs

Builder exposes options to configure Pod construction from TaskSpecs/Runs.
SecurityContextConfig is configuration for setting security context for init containers and affinity assistant container.

# Interfaces

EntrypointCache looks up an image's entrypoint (command) in a container image registry, possibly using the given service account's credentials.

# Type aliases

Transformer is a function that will transform a Pod.