mirror of
https://github.com/ceph/ceph-csi.git
synced 2024-12-11 07:30:24 +00:00
dbbca6ebf8
update controller-runtime to latest release. Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
136 lines
6.6 KiB
Go
136 lines
6.6 KiB
Go
/*
|
|
Copyright 2018 The Kubernetes Authors.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
package handler
|
|
|
|
import (
|
|
"context"
|
|
|
|
"k8s.io/client-go/util/workqueue"
|
|
"sigs.k8s.io/controller-runtime/pkg/client"
|
|
"sigs.k8s.io/controller-runtime/pkg/event"
|
|
"sigs.k8s.io/controller-runtime/pkg/reconcile"
|
|
)
|
|
|
|
// EventHandler enqueues reconcile.Requests in response to events (e.g. Pod Create). EventHandlers map an Event
|
|
// for one object to trigger Reconciles for either the same object or different objects - e.g. if there is an
|
|
// Event for object with type Foo (using source.Kind) then reconcile one or more object(s) with type Bar.
|
|
//
|
|
// Identical reconcile.Requests will be batched together through the queuing mechanism before reconcile is called.
|
|
//
|
|
// * Use EnqueueRequestForObject to reconcile the object the event is for
|
|
// - do this for events for the type the Controller Reconciles. (e.g. Deployment for a Deployment Controller)
|
|
//
|
|
// * Use EnqueueRequestForOwner to reconcile the owner of the object the event is for
|
|
// - do this for events for the types the Controller creates. (e.g. ReplicaSets created by a Deployment Controller)
|
|
//
|
|
// * Use EnqueueRequestsFromMapFunc to transform an event for an object to a reconcile of an object
|
|
// of a different type - do this for events for types the Controller may be interested in, but doesn't create.
|
|
// (e.g. If Foo responds to cluster size events, map Node events to Foo objects.)
|
|
//
|
|
// Unless you are implementing your own EventHandler, you can ignore the functions on the EventHandler interface.
|
|
// Most users shouldn't need to implement their own EventHandler.
|
|
type EventHandler = TypedEventHandler[client.Object, reconcile.Request]
|
|
|
|
// TypedEventHandler enqueues reconcile.Requests in response to events (e.g. Pod Create). TypedEventHandlers map an Event
|
|
// for one object to trigger Reconciles for either the same object or different objects - e.g. if there is an
|
|
// Event for object with type Foo (using source.Kind) then reconcile one or more object(s) with type Bar.
|
|
//
|
|
// Identical reconcile.Requests will be batched together through the queuing mechanism before reconcile is called.
|
|
//
|
|
// * Use TypedEnqueueRequestForObject to reconcile the object the event is for
|
|
// - do this for events for the type the Controller Reconciles. (e.g. Deployment for a Deployment Controller)
|
|
//
|
|
// * Use TypedEnqueueRequestForOwner to reconcile the owner of the object the event is for
|
|
// - do this for events for the types the Controller creates. (e.g. ReplicaSets created by a Deployment Controller)
|
|
//
|
|
// * Use TypedEnqueueRequestsFromMapFunc to transform an event for an object to a reconcile of an object
|
|
// of a different type - do this for events for types the Controller may be interested in, but doesn't create.
|
|
// (e.g. If Foo responds to cluster size events, map Node events to Foo objects.)
|
|
//
|
|
// Unless you are implementing your own TypedEventHandler, you can ignore the functions on the TypedEventHandler interface.
|
|
// Most users shouldn't need to implement their own TypedEventHandler.
|
|
//
|
|
// TypedEventHandler is experimental and subject to future change.
|
|
type TypedEventHandler[object any, request comparable] interface {
|
|
// Create is called in response to a create event - e.g. Pod Creation.
|
|
Create(context.Context, event.TypedCreateEvent[object], workqueue.TypedRateLimitingInterface[request])
|
|
|
|
// Update is called in response to an update event - e.g. Pod Updated.
|
|
Update(context.Context, event.TypedUpdateEvent[object], workqueue.TypedRateLimitingInterface[request])
|
|
|
|
// Delete is called in response to a delete event - e.g. Pod Deleted.
|
|
Delete(context.Context, event.TypedDeleteEvent[object], workqueue.TypedRateLimitingInterface[request])
|
|
|
|
// Generic is called in response to an event of an unknown type or a synthetic event triggered as a cron or
|
|
// external trigger request - e.g. reconcile Autoscaling, or a Webhook.
|
|
Generic(context.Context, event.TypedGenericEvent[object], workqueue.TypedRateLimitingInterface[request])
|
|
}
|
|
|
|
var _ EventHandler = Funcs{}
|
|
|
|
// Funcs implements eventhandler.
|
|
type Funcs = TypedFuncs[client.Object, reconcile.Request]
|
|
|
|
// TypedFuncs implements eventhandler.
|
|
//
|
|
// TypedFuncs is experimental and subject to future change.
|
|
type TypedFuncs[object any, request comparable] struct {
|
|
// Create is called in response to an add event. Defaults to no-op.
|
|
// RateLimitingInterface is used to enqueue reconcile.Requests.
|
|
CreateFunc func(context.Context, event.TypedCreateEvent[object], workqueue.TypedRateLimitingInterface[request])
|
|
|
|
// Update is called in response to an update event. Defaults to no-op.
|
|
// RateLimitingInterface is used to enqueue reconcile.Requests.
|
|
UpdateFunc func(context.Context, event.TypedUpdateEvent[object], workqueue.TypedRateLimitingInterface[request])
|
|
|
|
// Delete is called in response to a delete event. Defaults to no-op.
|
|
// RateLimitingInterface is used to enqueue reconcile.Requests.
|
|
DeleteFunc func(context.Context, event.TypedDeleteEvent[object], workqueue.TypedRateLimitingInterface[request])
|
|
|
|
// GenericFunc is called in response to a generic event. Defaults to no-op.
|
|
// RateLimitingInterface is used to enqueue reconcile.Requests.
|
|
GenericFunc func(context.Context, event.TypedGenericEvent[object], workqueue.TypedRateLimitingInterface[request])
|
|
}
|
|
|
|
// Create implements EventHandler.
|
|
func (h TypedFuncs[object, request]) Create(ctx context.Context, e event.TypedCreateEvent[object], q workqueue.TypedRateLimitingInterface[request]) {
|
|
if h.CreateFunc != nil {
|
|
h.CreateFunc(ctx, e, q)
|
|
}
|
|
}
|
|
|
|
// Delete implements EventHandler.
|
|
func (h TypedFuncs[object, request]) Delete(ctx context.Context, e event.TypedDeleteEvent[object], q workqueue.TypedRateLimitingInterface[request]) {
|
|
if h.DeleteFunc != nil {
|
|
h.DeleteFunc(ctx, e, q)
|
|
}
|
|
}
|
|
|
|
// Update implements EventHandler.
|
|
func (h TypedFuncs[object, request]) Update(ctx context.Context, e event.TypedUpdateEvent[object], q workqueue.TypedRateLimitingInterface[request]) {
|
|
if h.UpdateFunc != nil {
|
|
h.UpdateFunc(ctx, e, q)
|
|
}
|
|
}
|
|
|
|
// Generic implements EventHandler.
|
|
func (h TypedFuncs[object, request]) Generic(ctx context.Context, e event.TypedGenericEvent[object], q workqueue.TypedRateLimitingInterface[request]) {
|
|
if h.GenericFunc != nil {
|
|
h.GenericFunc(ctx, e, q)
|
|
}
|
|
}
|