1. EventHandler
EventHandler(事件句柄)是Controller.Watch的参数,当事件产生时,EventHandler将返回对象的 Name和 Namespace,作为 Request被添加到待处理事件队列中。例如,将来自 Source的 PodCreate事件提供给 EnqueueHandler,EventHandler将生成一个Request 添加到队列中,这个 Request包含该 Pod的Name和 Namespace。EventHandler的接口定义在目录 pkg/handler/eventhandler.go下,分别定义了 4类事件加入队列的方式(见代码清单3-38)。
typeEventHandlerinterface{
//定义如何响应Create事件
Create(event.CreateEvent,workqueue.RateLimitingInterface)
//定义如何响应 Update事件
Update(event.UpdateEvent,workqueue.RateLimitingInterface)
//定义如何响应Delete事件
Delete(event.DeleteEvent,workqueue.RateLimitingInterface)
//定义如何响应Generic事件
Generic(event.GenericEvent,workqueue.RateLimitingInterface)
}
在目录pkg/handler/eventhandlergo下,提供了内置的3种 EventHandler接口的实现。
(1) Funcs:包含4个函数对象类型的成员,分别实现了EventHandler接口的4个方法,开发者根据需要设置 4 个成员,如果某个成员未设置,默认将对对应的事件不进行反应。
(2) EnqueueRequestForOwner:将事件中资源对象的Owner加入队列。例如, 因ReplicaSet而创建的 Pod,发送过来的Pod事件被 EnqueueRequestForOwner处理后,加入相应的 ReplicaSet资源队列。
(3) EnqueueRequestsFromMapFunc:用于自定义资源的映射,是一个私有类,需要通过 EnqueueRequestsFromMapFunc(fnMapFunc)EventHandler方法创建。其中MapFunc是一个函数对象,将一个资源对象映射为多个 reconcile.Request,定义见代码清单 3-39
typeMapFuncfunc(client.Object)[]reconcile.Request
EnqueueRequestsFromMapFunc对应 4类事件, 它会将事件中的资源对象取出
(Update会同时取出更改前、更改后的两个资源对象),用MapFunc进行映射,将映射的所有 reconcile.Request加入队列。例如,当集群规模发生变动,导致 Node资源变化时,需要触发 Service进行同步的场景。
EventHandler可以通过 Builder.Watches()方法在创建 Controller时设置,也可以在Controller的Controller.Watch()方法中传入设置。但最终都会传入Source.Start()方法中,用于设置 Source处理事件的逻辑。
EventHandler 主要有以下特性。
(1) 通过将 Request加入队列处理一个或多个对象的事件。
(2) 可以将一个事件映射为另一个相同类型对象的 Request。
(3) 可以将一个事件映射为另一个不同类型对象的 Request。例如,将一个 Pod事件映射为一个纳管这个 Pod的 ReplicaSet类型 Request。
(4) 用户应该只使用提供的 Eventhandler实现,而不是使用自定义 Eventhandler实现。
2. Source
resource.Source(事件源)是Controller.Watch的参数。它提供了一个事件流。事件通常来自WatchKubernetesAP(I 如PodCreate、Update、Delete)。例如,source.Kind
为 GroupVersionKind使用了 KubernetesAPI的 Watch端点,以提供 Create、Update、Delete事件。
Source接口定义在目录 pkg/source/source.go下,见代码清单 3-40。
typeSourceinterface{
//Start() 是 Controller-runtime的内部⽅法,应该仅由Controller调⽤,⽤于在Informer
中注册EventHandler,将reconcile.Requests加⼊⼯作队列workqueue.RateLimitingInterface
Start(context.Context,handler.EventHandler,workqueue.RateLimitingInterface,
...predicate.Predicate)error
}
Source的实现在 pkg/source/source.go下,主要包括 3种。
(1) Informer:用于提供来自集群内部的事件,例如,PodCreate事件。
(2) Kind:与 Informer类似 ,也用于提供来自集群内部的事件。不同的是 Informer结构直接继承 cache.Informer,需要开发者自己设置;而 Kind 会根据设置的资源对象类型,自动生成 cache.Informer。
Builder创建 Controller时, 会根据 Builder.For()、Builder.Owns()、Builder.Watches()方法中设置的资源对象类型在Builder.Build() 中创建相应的 Kind,并调用 Controller.Watch()方法将 Kind传入 Controller。
(3) Channel:用于提供集群外部的事件,例如,GitHubWebHook回调。Channel要求用户连接外部的源(如HttpHandler),以便将GenericEvents写入底层的Channel结构中。
除了以上 3种事件源外,用户还可以实现自己的 Source,如果用户自己实现相应的 Inject接口,Controller会在调用 Watch()方法时, 将依赖注入。其中 Inject接口是Manager为Controller传递依赖的方式,主要定义在目录 pkg/runtime/inject/inject.go下。
事件源主要有以下特性。
(1)一般通过 WatchAPI为 Kubernetes对象提供事件流(例如,对象创建、更新和删除)。
(2)用户应该只使用提供的事件源实现,而非使用自定义实现。