watch

Documentation

Index

• func CommonPredicates() predicate.Funcs
• func DeleteOnly() predicate.Funcs
• func SelectNamespacesPredicate(namespaceMap map[string]bool) predicate.Funcs
• type DeprecatedResourceWatcher
  • func NewDeprecatedResourceWatcher() DeprecatedResourceWatcher
  • func (r *DeprecatedResourceWatcher) EnsureMultiplesResourcesAreWatched(dependant client.ObjectKey, log *zap.SugaredLogger, resources ...WatchedObject)
  • func (r *DeprecatedResourceWatcher) EnsureResourcesAreWatched(dependant client.ObjectKey, resourceKind string, log *zap.SugaredLogger, ...)
  • func (r *DeprecatedResourceWatcher) WatchedResourcesSnapshot() map[WatchedObject]map[client.ObjectKey]bool
• type EventHandlerWithDelete
  • func (d *EventHandlerWithDelete) Delete(ctx context.Context, e event.DeleteEvent, _ workqueue.RateLimitingInterface)
• type ResourcesHandler
  • func NewAtlasTeamHandler(r *DeprecatedResourceWatcher) *ResourcesHandler
  • func NewBackupPolicyHandler(r *DeprecatedResourceWatcher) *ResourcesHandler
  • func NewBackupScheduleHandler(r *DeprecatedResourceWatcher) *ResourcesHandler
  • func NewSecretHandler(r *DeprecatedResourceWatcher) *ResourcesHandler
  • func (c *ResourcesHandler) Create(ctx context.Context, e event.CreateEvent, q workqueue.RateLimitingInterface)
  • func (c *ResourcesHandler) Delete(context.Context, event.DeleteEvent, workqueue.RateLimitingInterface)
  • func (c *ResourcesHandler) Generic(context.Context, event.GenericEvent, workqueue.RateLimitingInterface)
  • func (c *ResourcesHandler) Update(ctx context.Context, e event.UpdateEvent, q workqueue.RateLimitingInterface)
• type WatchedObject
  • func (w WatchedObject) String() string

Functions

func CommonPredicates

func CommonPredicates() predicate.Funcs

CommonPredicates returns the predicate which filter out the changes done to any field except for spec (e.g. status) Also we should reconcile if finalizers have changed (see https://blog.openshift.com/kubernetes-operators-best-practices/)

func DeleteOnly

func DeleteOnly() predicate.Funcs

DeleteOnly returns a predicate that will filter out everything except the Delete event

func SelectNamespacesPredicate

func SelectNamespacesPredicate(namespaceMap map[string]bool) predicate.Funcs

Types

type DeprecatedResourceWatcher

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

DeprecatedResourceWatcher is the object containing the map of watched_resource -> []dependant_resource.

func NewDeprecatedResourceWatcher

func NewDeprecatedResourceWatcher() DeprecatedResourceWatcher

NewDeprecatedResourceWatcher creates a new resource watcher.

NOTE: DeprecatedResourceWatcher is DEPRECATED and DISCOURAGED to be used in new implementations. Use controller-runtime intrinsics instead, see https://book.kubebuilder.io/reference/watching-resources/externally-managed.

func (*DeprecatedResourceWatcher) EnsureMultiplesResourcesAreWatched

func (r *DeprecatedResourceWatcher) EnsureMultiplesResourcesAreWatched(dependant client.ObjectKey, log *zap.SugaredLogger, resources ...WatchedObject)

func (*DeprecatedResourceWatcher) EnsureResourcesAreWatched

func (r *DeprecatedResourceWatcher) EnsureResourcesAreWatched(dependant client.ObjectKey, resourceKind string, log *zap.SugaredLogger, watchedObjectsKeys ...client.ObjectKey)

EnsureResourcesAreWatched registers a dependant for the watched objects. This will let the controller to react on the events for the watched objects and trigger reconciliation for dependants.

func (*DeprecatedResourceWatcher) WatchedResourcesSnapshot

func (r *DeprecatedResourceWatcher) WatchedResourcesSnapshot() map[WatchedObject]map[client.ObjectKey]bool

WatchedResourcesSnapshot returns the most recent snapshot of watched resources. Note that entries here can change concurrently.

type EventHandlerWithDelete

type EventHandlerWithDelete struct {
	handler.EnqueueRequestForObject
	Controller interface {
		Delete(ctx context.Context, e event.DeleteEvent) error
	}
}

EventHandlerWithDelete is an extension of EnqueueRequestForObject that will _not_ trigger a reconciliation for a Delete event. Instead, it will call an external controller's Delete() method and pass the event argument unchanged.

func (*EventHandlerWithDelete) Delete

func (d *EventHandlerWithDelete) Delete(ctx context.Context, e event.DeleteEvent, _ workqueue.RateLimitingInterface)

type ResourcesHandler

type ResourcesHandler struct {
	ResourceKind    string
	ResourceWatcher *DeprecatedResourceWatcher
}

ResourcesHandler is a special implementation of 'handler.EventHandler' that checks if the event for WatchedObject must trigger reconciliation for any Operator managed Resource (AtlasProject, AtlasDeployment etc). This is done via consulting the 'TrackedResources' map. The map is stored in relevant Reconciler which ensures it's up-to-date on each reconciliation

func NewAtlasTeamHandler

func NewAtlasTeamHandler(r *DeprecatedResourceWatcher) *ResourcesHandler

func NewBackupPolicyHandler

func NewBackupPolicyHandler(r *DeprecatedResourceWatcher) *ResourcesHandler

func NewBackupScheduleHandler

func NewBackupScheduleHandler(r *DeprecatedResourceWatcher) *ResourcesHandler

func NewSecretHandler

func NewSecretHandler(r *DeprecatedResourceWatcher) *ResourcesHandler

NewSecretHandler TODO Igor: refactor this to create generic constructor

func (*ResourcesHandler) Create

func (c *ResourcesHandler) Create(ctx context.Context, e event.CreateEvent, q workqueue.RateLimitingInterface)

Create handles the Create event for the resource. Note that we implement Create in addition to Update to be able to handle cases when config map or secret is deleted and then created again.

func (*ResourcesHandler) Delete

func (c *ResourcesHandler) Delete(context.Context, event.DeleteEvent, workqueue.RateLimitingInterface)

Delete (Seems we don't need to react on watched resources removal..)

func (*ResourcesHandler) Generic

func (c *ResourcesHandler) Generic(context.Context, event.GenericEvent, workqueue.RateLimitingInterface)

func (*ResourcesHandler) Update

func (c *ResourcesHandler) Update(ctx context.Context, e event.UpdateEvent, q workqueue.RateLimitingInterface)

type WatchedObject

type WatchedObject struct {
	ResourceKind string
	Resource     types.NamespacedName
}

WatchedObject is the object watched by controller. Includes its type and namespace+name

func (WatchedObject) String

func (w WatchedObject) String() string