controllerutil

package
v1.2.0-alpha.2 Latest Latest
Warning

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

 Go to latest Published: Jun 12, 2026 License: AGPL-3.0 Imports: 59 Imported by: 3

Documentation

Index

Constants

View Source 
const FeatureGateEnableRuntimeMetrics = "ENABLED_RUNTIME_METRICS"
View Source 
const (
	// PodContainerFailedTimeout the timeout for container of pod failures, the component phase will be set to Failed after this time.
	PodContainerFailedTimeout = 10 * time.Second
)

Variables

View Source 
var ErrFailedToAddFinalizer = errors.New("failed to add finalizer")
View Source 
var SupportResizeSubResource = supportResizeSubResourceImpl

SupportResizeSubResource is for the ease of tests

Functions

func BackgroundDeleteObject 

func BackgroundDeleteObject(cli client.Client, ctx context.Context, obj client.Object, opts ...client.DeleteOption) error

BackgroundDeleteObject deletes the object in the background, usually used in the Reconcile method

func BuildImagePullSecrets added in v0.9.1 

func BuildImagePullSecrets() []corev1.LocalObjectReference

func BuildPodHostDNS 

func BuildPodHostDNS(pod *corev1.Pod) string

BuildPodHostDNS builds the host dns of pod. ref: https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/

func CheckResourceExists 

func CheckResourceExists(
	ctx context.Context,
	cli client.Reader,
	key client.ObjectKey,
	obj client.Object) (bool, error)

CheckResourceExists checks whether resource exist or not.

func CheckedRequeueWithError 

func CheckedRequeueWithError(err error, logger logr.Logger, msg string, keysAndValues ...interface{}) (reconcile.Result, error)

CheckedRequeueWithError passes the error through to the controller manager, it ignores unknown errors.

func ComposePVCName 

func ComposePVCName(template corev1.PersistentVolumeClaim, itsName, podName string) string

func ComputeHash 

func ComputeHash(object interface{}) (string, error)

func CreateVolumeIfNotExist added in v1.0.0 

func CreateVolumeIfNotExist(volumes []corev1.Volume, volumeName string, createFn createVolumeFn) []corev1.Volume

func DeleteOwnedResources added in v0.8.3 

func DeleteOwnedResources[T generics.Object, PT generics.PObject[T], L generics.ObjList[T], PL generics.PObjList[T, L]](ctx context.Context,
	cli client.Client,
	owner client.Object,
	resourceMatchLabels client.MatchingLabels,
	_ func(T, PT, L, PL)) error

DeleteOwnedResources deletes the matched resources which are owned by the owner.

func EnabledRuntimeMetrics added in v0.9.0 

func EnabledRuntimeMetrics() bool

func EqualContainerImageInSpec 

func EqualContainerImageInSpec(oldImage, newImage string) bool

EqualContainerImageInSpec returns true if two PodSpec image references point to the same image after ignoring registry rewrites. Tags and digests remain strict.

func GetContainerByConfigSpec 

func GetContainerByConfigSpec(podSpec *corev1.PodSpec, configs []appsv1alpha1.ComponentConfigSpec) *corev1.Container

GetContainerByConfigSpec searches for container using the configmap of config from the pod 

e.g.:
ClusterDefinition.configTemplateRef:
	 - Name: "mysql-8.0"
	   VolumeName: "mysql_config"

PodTemplate.containers[*].volumeMounts:
	 - mountPath: /data/config
	   name: mysql_config
	 - mountPath: /data
	   name: data
	 - mountPath: /log
	   name: log

func GetContainerByName 

func GetContainerByName(containers []corev1.Container, name string) (int, *corev1.Container)

func GetContainersByConfigmap 

func GetContainersByConfigmap(containers []corev1.Container, volumeName string, cmName string, filters ...containerNameFilter) []string

func GetCoreNum 

func GetCoreNum(container corev1.Container) int64

GetCoreNum gets content of Resources.Limits.cpu

func GetKubeRestConfig added in v1.0.0 

func GetKubeRestConfig(userAgent string) *rest.Config

func GetKubeVersion added in v0.9.5 

func GetKubeVersion() (string, error)

GetKubeVersion get the version of Kubernetes and return the gitVersion

func GetMemorySize 

func GetMemorySize(container corev1.Container) int64

GetMemorySize gets content of Resources.Limits.memory

func GetPodCondition 

func GetPodCondition(status *corev1.PodStatus, conditionType corev1.PodConditionType) *corev1.PodCondition

func GetPodContainer added in v0.9.0 

func GetPodContainer(pod *corev1.Pod, containerName string) *corev1.Container

GetPodContainer gets the pod container by name. if containerName is empty, return the first container.

func GetPodContainerWithVolumeMount 

func GetPodContainerWithVolumeMount(podSpec *corev1.PodSpec, volumeName string) []*corev1.Container

GetPodContainerWithVolumeMount searches for containers mounting the volume

func GetPodListByInstanceSet added in v0.9.0 

func GetPodListByInstanceSet(ctx context.Context, cli client.Client, its *workloads.InstanceSet) ([]corev1.Pod, error)

GetPodListByInstanceSet gets ITS pod list.

func GetPodRevision 

func GetPodRevision(pod *corev1.Pod) string

GetPodRevision gets the revision of Pod by inspecting the StatefulSetRevisionLabel. If pod has no revision empty string is returned.

func GetPortByName added in v1.0.0 

func GetPortByName(pod corev1.Pod, cname, pname string) (int32, error)

func GetRequestMemorySize 

func GetRequestMemorySize(container corev1.Container) int64

GetRequestMemorySize gets content of Resources.Limits.memory

func GetStorageSizeFromPersistentVolume 

func GetStorageSizeFromPersistentVolume(pvc corev1.PersistentVolumeClaimTemplate) int64

GetStorageSizeFromPersistentVolume gets content of Resources.Requests.storage

func GetUncachedObjects 

func GetUncachedObjects() []client.Object

GetUncachedObjects returns a list of K8s objects, for these object types, and their list types, client.Reader will read directly from the API server instead of the cache, which may not be up-to-date. see sigs.k8s.io/controller-runtime/pkg/client/split.go to understand how client works with this UncachedObjects filter.

func GetVolumeMountByVolume 

func GetVolumeMountByVolume(container *corev1.Container, volumeName string) *corev1.VolumeMount

func GetVolumeMountName 

func GetVolumeMountName(volumes []corev1.Volume, resourceName string) *corev1.Volume

GetVolumeMountName finds the volume with mount name

func HandleCRDeletion 

func HandleCRDeletion(reqCtx RequestCtx,
	r client.Writer,
	cr client.Object,
	finalizer string,
	deletionHandler func() (*ctrl.Result, error)) (*ctrl.Result, error)

HandleCRDeletion handles CR deletion, adds finalizer if found a non-deleting object and removes finalizer during deletion process. It patches only finalizer metadata so chart-owned spec fields keep their field ownership. Passes optional 'deletionHandler' func for external dependency deletion. Returns Result pointer if required to return out of outer 'Reconcile' reconciliation loop.

func IgnoreIsAlreadyExists 

func IgnoreIsAlreadyExists(err error) error

IgnoreIsAlreadyExists returns errors if 'err' is not type of AlreadyExists

func InitDefaultHostPortManager 

func InitDefaultHostPortManager(cli client.Client) error

func InjectZeroResourceLimitIfEmpty 

func InjectZeroResourceLimitIfEmpty(c *corev1.Container, name corev1.ResourceName)

func InjectZeroResourcesLimitsForDataProtection 

func InjectZeroResourcesLimitsForDataProtection(c *corev1.Container)

func InjectZeroResourcesLimitsForOps 

func InjectZeroResourcesLimitsForOps(c *corev1.Container)

func InjectZeroResourcesLimitsIfEmpty 

func InjectZeroResourcesLimitsIfEmpty(c *corev1.Container)

func IsAPIVersionSupported added in v1.0.0 

func IsAPIVersionSupported(apiVersion string) bool

func IsDelayedRequeueError 

func IsDelayedRequeueError(err error) bool

func IsInstanceAvailable 

func IsInstanceAvailable(inst *workloads.Instance) bool

IsInstanceAvailable returns true if an instance is ready for at least minReadySeconds

func IsInstanceFailure 

func IsInstanceFailure(inst *workloads.Instance) bool

func IsInstanceReady 

func IsInstanceReady(inst *workloads.Instance) bool

IsInstanceReady returns true if an instance is ready

func IsInstanceReadyWithRole 

func IsInstanceReadyWithRole(inst *workloads.Instance) bool

IsInstanceReadyWithRole checks if an instance is ready with the role observed.

func IsInstanceTerminating 

func IsInstanceTerminating(inst *workloads.Instance) bool

IsInstanceTerminating returns true if instance's DeletionTimestamp has been set

func IsMatchConfigVersion 

func IsMatchConfigVersion(obj client.Object, labelKey string, version string) bool

func IsNotFound 

func IsNotFound(err error) bool

IsNotFound returns true if the specified error is the error type of ErrorTypeNotFound.

func IsPodAvailable added in v1.0.0 

func IsPodAvailable(pod *corev1.Pod, minReadySeconds int32) bool

IsPodAvailable returns true if pod is ready for at least minReadySeconds

func IsPodFailedAndTimedOut added in v0.8.2 

func IsPodFailedAndTimedOut(pod *corev1.Pod) (bool, bool, string)

IsPodFailedAndTimedOut checks if the pod is failed and timed out.

func IsPodReady added in v1.0.0 

func IsPodReady(pod *corev1.Pod) bool

IsPodReady returns true if pod is ready Currently, if pod is being deleted and have a grace period, k8s still considers it ready, which is not what we expect. See https://github.com/kubernetes/kubernetes/issues/129552

func IsRequeueError 

func IsRequeueError(err error) bool

IsRequeueError checks if the error is the RequeueError.

func IsTargetError 

func IsTargetError(err error, errorType ErrorType) bool

IsTargetError checks if the error is the target error.

func LoadRegistryConfig added in v1.0.0 

func LoadRegistryConfig() error

func MatchContainerImageInStatus 

func MatchContainerImageInStatus(specImage, statusImage, statusImageID string) bool

MatchContainerImageInStatus returns true if the status image matches the image requested in PodSpec. For digest-pinned images, the status imageID digest is the stable runtime contract; status image may be reported as a tag or local ID.

func MergeList added in v0.9.0 

func MergeList[E any](src, dst *[]E, f func(E) func(E) bool)

MergeList merge src to dst, dst is modified in place. f returns a function that can be passed to slices.IndexFunc(). Items in src will overwrite items in dst, if possible.

func MergeMetadataMapInplace added in v0.8.2 

func MergeMetadataMapInplace(originalMap map[string]string, targetMap *map[string]string)

MergeMetadataMapInplace merges two map[string]string, the targetMap will be updated.

func MergeMetadataMaps added in v0.8.2 

func MergeMetadataMaps(originalMap map[string]string, targetMaps ...map[string]string) map[string]string

func NewControllerManagedBy added in v0.9.2 

func NewControllerManagedBy(mgr manager.Manager) *builder.Builder

func NewDelayedRequeueError 

func NewDelayedRequeueError(after time.Duration, reason string) error

NewDelayedRequeueError creates a delayed requeue error which only returns in the last step of the DAG.

func NewEncryptor 

func NewEncryptor(encryptionKey string) *encryptor

func NewRequeueError 

func NewRequeueError(after time.Duration, reason string) error

func ObjectAPIVersionSupported added in v0.9.3 

func ObjectAPIVersionSupported(obj client.Object) bool

func PodFQDN added in v1.0.0 

func PodFQDN(namespace, compName, podName string) string

func PodIsReadyWithLabel 

func PodIsReadyWithLabel(pod corev1.Pod) bool

PodIsReadyWithLabel checks if pod is ready for ConsensusSet/ReplicationSet component, it will be available when the pod is ready and labeled with role.

func Reconciled 

func Reconciled() (reconcile.Result, error)

Reconciled returns an empty result with nil error to signal a successful reconcile to the controller manager

func RecordCreatedEvent 

func RecordCreatedEvent(r record.EventRecorder, cr client.Object)

RecordCreatedEvent records an event when a CR created successfully

func ReplaceImageRegistry added in v1.0.0 

func ReplaceImageRegistry(image string) string

func Requeue 

func Requeue(logger logr.Logger, msg string, keysAndValues ...interface{}) (reconcile.Result, error)

func RequeueAfter 

func RequeueAfter(duration time.Duration, logger logr.Logger, msg string, keysAndValues ...interface{}) (reconcile.Result, error)

func RequeueWithError 

func RequeueWithError(err error, logger logr.Logger, msg string, keysAndValues ...interface{}) (reconcile.Result, error)

RequeueWithError requeues when an error occurs

func RequeueWithErrorAndRecordEvent 

func RequeueWithErrorAndRecordEvent(obj client.Object, recorder record.EventRecorder, err error, logger logr.Logger) (reconcile.Result, error)

RequeueWithErrorAndRecordEvent requeues when an error occurs. if it is an unknown error, triggers an event

func ResolveContainerDefaultFields added in v0.8.0 

func ResolveContainerDefaultFields(container corev1.Container, pcontainer *corev1.Container)

ResolveContainerDefaultFields set default value for some known fields of proto Container @pcontainer.

func ResolvePodSpecDefaultFields added in v0.8.0 

func ResolvePodSpecDefaultFields(obj corev1.PodSpec, pobj *corev1.PodSpec)

ResolvePodSpecDefaultFields set default value for some known fields of proto PodSpec @pobj.

func ResultToP 

func ResultToP(res reconcile.Result, err error) (*reconcile.Result, error)

ResultToP converts a Result object to a pointer.

func ServiceFQDN added in v1.0.0 

func ServiceFQDN(namespace, serviceName string) string

func SetControllerReference 

func SetControllerReference(owner, object metav1.Object) error

func SetOwnerReference 

func SetOwnerReference(owner, object metav1.Object) error

func SetOwnership 

func SetOwnership(owner, obj client.Object, scheme *runtime.Scheme, finalizer string, useOwnerReference ...bool) error

SetOwnership provides helper function controllerutil.SetControllerReference/controllerutil.SetOwnerReference and controllerutil.AddFinalizer if not exists.

func ToCoreV1PVCTs added in v1.0.0 

func ToCoreV1PVCTs(vcts []appsv1.PersistentVolumeClaimTemplate) []corev1.PersistentVolumeClaimTemplate

func TruncateConditionMessage 

func TruncateConditionMessage(msg string) string

TruncateConditionMessage returns msg unchanged when it fits in the Condition message budget, otherwise it returns a UTF-8 safe prefix followed by the truncation marker. The result is guaranteed to be valid UTF-8 and no longer than maxConditionMessageBytes bytes.

func TruncateConditionReason 

func TruncateConditionReason(reason string) string

TruncateConditionReason returns reason unchanged when it fits in the Condition reason budget, otherwise a UTF-8 safe prefix cut to fit. No marker is appended — reason is a short identifier consumed by automation, not a human-readable message.

func ValidateReferenceCR 

func ValidateReferenceCR(reqCtx RequestCtx, cli client.Client, obj client.Object,
	labelKey string, recordEvent func(), objLists ...client.ObjectList) (*ctrl.Result, error)

ValidateReferenceCR validates existing referencing CRs, if exists, requeue reconcile after 30 seconds

Types

type ByPodName 

type ByPodName []corev1.Pod

ByPodName sorts a list of jobs by pod name

func (ByPodName) Len 

func (c ByPodName) Len() int

Len returns the length of byPodName for sort.Sort

func (ByPodName) Less 

func (c ByPodName) Less(i, j int) bool

Less defines compare method for sort.Sort

func (ByPodName) Swap 

func (c ByPodName) Swap(i, j int)

Swap swaps the items for sort.Sort

type DelayedRequeueError 

type DelayedRequeueError interface {
	RequeueError
	Delayed()
}

type Error 

type Error struct {
	Type    ErrorType
	Message string
}

func NewError 

func NewError(errorType ErrorType, message string) *Error

func NewErrorf 

func NewErrorf(errorType ErrorType, format string, a ...any) *Error

func NewFatalError 

func NewFatalError(message string) *Error

NewFatalError returns a new Error with ErrorTypeFatal

func NewNotFound 

func NewNotFound(format string, a ...any) *Error

NewNotFound returns a new Error with ErrorTypeNotFound.

func UnwrapControllerError 

func UnwrapControllerError(err error) *Error

UnwrapControllerError unwraps the Controller error from target error.

func (*Error) Error 

func (v *Error) Error() string

Error implements the error interface.

type ErrorType 

type ErrorType string

ErrorType is explicit error type. 

const (
	// ErrorWaitCacheRefresh waits for synchronization of the corresponding object cache in client-go from ApiServer.
	ErrorWaitCacheRefresh ErrorType = "WaitCacheRefresh"
	ErrorIgnoreCancel     ErrorType = "IgnoreCancel"

	// ErrorTypeNotFound not found any resource.
	ErrorTypeNotFound ErrorType = "NotFound"

	ErrorTypeRequeue ErrorType = "Requeue" // requeue for reconcile.

	ErrorTypeFatal ErrorType = "Fatal" // fatal error

	// ErrorType for cluster controller
	ErrorTypeBackupFailed  ErrorType = "BackupFailed"
	ErrorTypeRestoreFailed ErrorType = "RestoreFailed"
	ErrorTypeNeedWaiting   ErrorType = "NeedWaiting" // waiting for next reconcile

	// ErrorTypeExpectedInProcess is used to indicate that the operation is expected to be in process.
	ErrorTypeExpectedInProcess ErrorType = "ExpectedInProcess"
)

type PortManager added in v0.8.0 

type PortManager interface {
	GetPort(key string) (int32, error)
	UsePort(key string, port int32) error
	AllocatePort(key string) (int32, error)
	ReleaseByPrefix(prefix string) error
	PortKey(clusterName, compName, containerName, portName string) string
}

func GetPortManager added in v0.8.0 

func GetPortManager(network *appsv1.ComponentNetwork) PortManager

type RequestCtx 

type RequestCtx struct {
	Ctx      context.Context
	Req      ctrl.Request
	Log      logr.Logger
	Recorder record.EventRecorder
}

RequestCtx wrapper for reconcile procedure context parameters

func (*RequestCtx) Event 

func (r *RequestCtx) Event(object runtime.Object, eventtype, reason, message string)

Event is wrapper for Recorder.Event, if Recorder is nil, then it's no-op.

func (*RequestCtx) Eventf 

func (r *RequestCtx) Eventf(object runtime.Object, eventtype, reason, messageFmt string, args ...interface{})

Eventf is wrapper for Recorder.Eventf, if Recorder is nil, then it's no-op.

func (*RequestCtx) UpdateCtxValue 

func (r *RequestCtx) UpdateCtxValue(key, val any) context.Context

UpdateCtxValue updates Context value, returns parent Context.

func (*RequestCtx) WithValue 

func (r *RequestCtx) WithValue(key, val any) context.Context

WithValue returns a copy of parent in which the value associated with key is val.

type RequeueError 

type RequeueError interface {
	RequeueAfter() time.Duration
	Reason() string
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.