controllerutils

Documentation

Index

• Variables
• func AddFinalizers(ctx context.Context, writer client.Writer, obj client.Object, ...) error
• func AddTasks(annotations map[string]string, tasksToAdd ...string)
• func BackupBucketFilterFunc(seedName string) func(obj interface{}) bool
• func BackupEntryFilterFunc(seedName string) func(obj interface{}) bool
• func BackupEntryIsBeingMigratedToSeed(ctx context.Context, c client.Reader, ...) bool
• func BackupEntryMigrationFilterFunc(ctx context.Context, c client.Reader, seedName string) func(obj interface{}) bool
• func BastionFilterFunc(seedName string) func(obj interface{}) bool
• func ControllerInstallationFilterFunc(seedName string) func(obj interface{}) bool
• func CreateOrGetAndMergePatch(ctx context.Context, c client.Client, obj client.Object, ...) (controllerutil.OperationResult, error)
• func CreateOrGetAndStrategicMergePatch(ctx context.Context, c client.Client, obj client.Object, ...) (controllerutil.OperationResult, error)
• func CreateWorker(ctx context.Context, queue workqueue.RateLimitingInterface, ...)
• func DetermineBackupBucketAssociations(ctx context.Context, c client.Client, seedName string) ([]string, error)
• func DetermineControllerInstallationAssociations(ctx context.Context, c client.Client, seedName string) ([]string, error)
• func DetermineSecretBindingAssociations(ctx context.Context, c client.Client, quota *gardencorev1beta1.Quota) ([]string, error)
• func DetermineShootsAssociatedTo(ctx context.Context, gardenClient client.Reader, obj interface{}) ([]string, error)
• func GetAndCreateOrMergePatch(ctx context.Context, c client.Client, obj client.Object, ...) (controllerutil.OperationResult, error)
• func GetAndCreateOrStrategicMergePatch(ctx context.Context, c client.Client, obj client.Object, ...) (controllerutil.OperationResult, error)
• func GetTasks(annotations map[string]string) []string
• func HasTask(annotations map[string]string, task string) bool
• func ManagedSeedFilterFunc(ctx context.Context, c client.Reader, seedName string) func(obj interface{}) bool
• func ReconcileOncePer24hDuration(objectMeta metav1.ObjectMeta, observedGeneration int64, ...) time.Duration
• func RemoveAllFinalizers(ctx context.Context, writer client.Writer, obj client.Object) error
• func RemoveAllTasks(annotations map[string]string)
• func RemoveFinalizers(ctx context.Context, writer client.Writer, obj client.Object, ...) error
• func RemoveTasks(annotations map[string]string, tasksToRemove ...string)
• func SeedFilterFunc(seedName string) func(obj interface{}) bool
• func SeedOfManagedSeedFilterFunc(ctx context.Context, c client.Reader, seedName string) func(obj interface{}) bool
• func ShootFilterFunc(seedName string) func(obj interface{}) bool
• func ShootIsBeingMigratedToSeed(ctx context.Context, c client.Reader, shoot *gardencorev1beta1.Shoot, ...) bool
• func ShootMigrationFilterFunc(ctx context.Context, c client.Reader, seedName string) func(obj interface{}) bool
• func TypedCreateOrUpdate(ctx context.Context, c client.Client, scheme *runtime.Scheme, ...) (controllerutil.OperationResult, error)
• type WorkerOption
  • func WithLogger(logger logr.Logger) WorkerOption
• type WorkerOptions

Variables

var (
	// Now is a function for returning the current time.
	Now = time.Now
	// RandomDuration is a function for returning a random duration.
	RandomDuration = utils.RandomDuration
)

Functions

func AddFinalizers

func AddFinalizers(ctx context.Context, writer client.Writer, obj client.Object, finalizers ...string) error

AddFinalizers ensures that the given finalizer is present in the given object and optimistic locking. If it is not set, it adds it and issues a patch. Note that this is done with a regular merge-patch since strategic merge-patches do not work with custom resources, see https://github.com/kubernetes/kubernetes/issues/105146.

func AddTasks

func AddTasks(annotations map[string]string, tasksToAdd ...string)

AddTasks adds tasks to the ShootTasks annotation of the passed map.

func BackupBucketFilterFunc

func BackupBucketFilterFunc(seedName string) func(obj interface{}) bool

BackupBucketFilterFunc returns a filtering func for BackupBuckets.

func BackupEntryFilterFunc

func BackupEntryFilterFunc(seedName string) func(obj interface{}) bool

BackupEntryFilterFunc returns a filtering func for BackupEntries.

func BackupEntryIsBeingMigratedToSeed

func BackupEntryIsBeingMigratedToSeed(ctx context.Context, c client.Reader, backupEntry *gardencorev1beta1.BackupEntry, seedName string) bool

BackupEntryIsBeingMigratedToSeed checks if the given BackupEntry is currently being migrated to the seed with the given name, and the source seed has ownerChecks enabled (as it is a prerequisite to successfully force restore a shoot to a different seed).

func BackupEntryMigrationFilterFunc

func BackupEntryMigrationFilterFunc(ctx context.Context, c client.Reader, seedName string) func(obj interface{}) bool

BackupEntryMigrationFilterFunc returns a filtering func for backup entries that are being migrated to a different seed.

func BastionFilterFunc

func BastionFilterFunc(seedName string) func(obj interface{}) bool

BastionFilterFunc returns a filtering func for Bastions.

func ControllerInstallationFilterFunc

func ControllerInstallationFilterFunc(seedName string) func(obj interface{}) bool

ControllerInstallationFilterFunc returns a filtering func for ControllerInstallations.

func CreateOrGetAndMergePatch

func CreateOrGetAndMergePatch(ctx context.Context, c client.Client, obj client.Object, f controllerutil.MutateFn, opts ...client.MergeFromOption) (controllerutil.OperationResult, error)

CreateOrGetAndMergePatch creates or gets and patches (using a merge patch) the given object in the Kubernetes cluster.

The MutateFn is called regardless of creating or patching an object.

It returns the executed operation and an error.

func CreateOrGetAndStrategicMergePatch

func CreateOrGetAndStrategicMergePatch(ctx context.Context, c client.Client, obj client.Object, f controllerutil.MutateFn, opts ...client.MergeFromOption) (controllerutil.OperationResult, error)

CreateOrGetAndStrategicMergePatch creates or gets and patches (using a strategic merge patch) the given object in the Kubernetes cluster.

The MutateFn is called regardless of creating or patching an object.

It returns the executed operation and an error.

func CreateWorker

func CreateWorker(ctx context.Context, queue workqueue.RateLimitingInterface, resourceType string, reconciler reconcile.Reconciler, waitGroup *sync.WaitGroup, workerCh chan<- int, opts ...WorkerOption)

CreateWorker creates and runs a worker goroutine that just processes items in the specified queue. The worker will run until ctx is cancelled. The worker will be added to the wait group when started and marked done when finished.

func DetermineBackupBucketAssociations

func DetermineBackupBucketAssociations(ctx context.Context, c client.Client, seedName string) ([]string, error)

DetermineBackupBucketAssociations determine the BackupBucket resources which are associated to seed with name <seedName>

func DetermineControllerInstallationAssociations

func DetermineControllerInstallationAssociations(ctx context.Context, c client.Client, seedName string) ([]string, error)

DetermineControllerInstallationAssociations determine the ControllerInstallation resources which are associated to seed with name <seedName>

func DetermineSecretBindingAssociations

func DetermineSecretBindingAssociations(ctx context.Context, c client.Client, quota *gardencorev1beta1.Quota) ([]string, error)

DetermineSecretBindingAssociations gets a <bindingLister> to determine the SecretBinding resources which are associated to given Quota <obj>.

func DetermineShootsAssociatedTo

func DetermineShootsAssociatedTo(ctx context.Context, gardenClient client.Reader, obj interface{}) ([]string, error)

DetermineShootsAssociatedTo gets a <shootLister> to determine the Shoots resources which are associated to given <obj> (either a CloudProfile, Seed, Secretbinding a or a ExposureClass object).

func GetAndCreateOrMergePatch

func GetAndCreateOrMergePatch(ctx context.Context, c client.Client, obj client.Object, f controllerutil.MutateFn, opts ...client.MergeFromOption) (controllerutil.OperationResult, error)

GetAndCreateOrMergePatch is similar to controllerutil.CreateOrPatch, but does not care about the object's status section. It reads the object from the client, reconciles the desired state with the existing state using the given MutateFn and creates or patches the object (using a merge patch) accordingly.

The MutateFn is called regardless of creating or updating an object.

It returns the executed operation and an error.

func GetAndCreateOrStrategicMergePatch

func GetAndCreateOrStrategicMergePatch(ctx context.Context, c client.Client, obj client.Object, f controllerutil.MutateFn, opts ...client.MergeFromOption) (controllerutil.OperationResult, error)

GetAndCreateOrStrategicMergePatch is similar to controllerutil.CreateOrPatch, but does not care about the object's status section. It reads the object from the client, reconciles the desired state with the existing state using the given MutateFn and creates or patches the object (using a strategic merge patch) accordingly.

The MutateFn is called regardless of creating or updating an object.

It returns the executed operation and an error.

func GetTasks

func GetTasks(annotations map[string]string) []string

GetTasks returns the list of tasks in the ShootTasks annotation.

func HasTask

func HasTask(annotations map[string]string, task string) bool

HasTask checks if the passed task is part of the ShootTasks annotation.

func ManagedSeedFilterFunc

func ManagedSeedFilterFunc(ctx context.Context, c client.Reader, seedName string) func(obj interface{}) bool

ManagedSeedFilterFunc returns a filtering func for ManagedSeeds that checks if the ManagedSeed references a Shoot scheduled on a Seed, for which the gardenlet is responsible..

func ReconcileOncePer24hDuration

func ReconcileOncePer24hDuration(objectMeta metav1.ObjectMeta, observedGeneration int64, lastOperation *gardencorev1beta1.LastOperation) time.Duration

ReconcileOncePer24hDuration returns the duration until the next reconciliation should happen while respecting that only one reconciliation should happen per 24h. If the deletion timestamp is set or the generation has changed or the last operation does not indicate success or indicates that the last reconciliation happened more than 24h ago then 0 will be returned.

func RemoveAllFinalizers

func RemoveAllFinalizers(ctx context.Context, writer client.Writer, obj client.Object) error

RemoveAllFinalizers ensures that the given object has no finalizers with exponential backoff. If any finalizers are set, it removes them and issues a patch.

func RemoveAllTasks

func RemoveAllTasks(annotations map[string]string)

RemoveAllTasks removes the ShootTasks annotation from the passed map.

func RemoveFinalizers

func RemoveFinalizers(ctx context.Context, writer client.Writer, obj client.Object, finalizers ...string) error

RemoveFinalizers ensures that the given finalizer is not present anymore in the given object and optimistic locking. If it is set, it removes it and issues a patch. Note that this is done with a regular merge-patch since strategic merge-patches do not work with custom resources, see https://github.com/kubernetes/kubernetes/issues/105146.

func RemoveTasks

func RemoveTasks(annotations map[string]string, tasksToRemove ...string)

RemoveTasks removes tasks from the ShootTasks annotation of the passed map.

func SeedFilterFunc

func SeedFilterFunc(seedName string) func(obj interface{}) bool

SeedFilterFunc returns a filtering func for seeds.

func SeedOfManagedSeedFilterFunc

func SeedOfManagedSeedFilterFunc(ctx context.Context, c client.Reader, seedName string) func(obj interface{}) bool

SeedOfManagedSeedFilterFunc returns a filtering func for Seeds that checks if the Seed is owned by a ManagedSeed that references a Shoot scheduled on a Seed, for which the gardenlet is responsible.

func ShootFilterFunc

func ShootFilterFunc(seedName string) func(obj interface{}) bool

ShootFilterFunc returns a filtering func for shoots.

func ShootIsBeingMigratedToSeed

func ShootIsBeingMigratedToSeed(ctx context.Context, c client.Reader, shoot *gardencorev1beta1.Shoot, seedName string) bool

ShootIsBeingMigratedToSeed checks if the given shoot is currently being migrated to the seed with the given name, and the source seed has ownerChecks enabled (as it is a prerequisite to successfully force restore a shoot to a different seed).

func ShootMigrationFilterFunc

func ShootMigrationFilterFunc(ctx context.Context, c client.Reader, seedName string) func(obj interface{}) bool

ShootMigrationFilterFunc returns a filtering func for shoots that are being migrated to a different seed.

func TypedCreateOrUpdate

func TypedCreateOrUpdate(ctx context.Context, c client.Client, scheme *runtime.Scheme, obj *unstructured.Unstructured, alwaysUpdate bool, mutate func() error) (controllerutil.OperationResult, error)

TypedCreateOrUpdate is like controllerutil.CreateOrUpdate, it retrieves the current state of the object from the API server, applies the given mutate func and creates or updates it afterwards. In contrast to controllerutil.CreateOrUpdate it tries to create a new typed object of obj's kind (using the provided scheme) to make typed Get requests in order to leverage the client's cache.

Types

type WorkerOption

type WorkerOption func(*WorkerOptions)

WorkerOption is a func that mutates WorkerOptions.

func WithLogger

func WithLogger(logger logr.Logger) WorkerOption

WithLogger configures the logr.Logger to use for a controller worker. If set, a logger preconfigured with the name and namespace field will be injected into the context.Context on each Reconcile call. It can be retrieved via log.FromContext.

type WorkerOptions

type WorkerOptions struct {
	// contains filtered or unexported fields
}

WorkerOptions are options for a controller's worker.