带你读《云原生应用开发 Operator原理与实践》第三章 Kubebuilder 原理3.3 Controller-runtime 模块分析(六)-阿里云开发者社区

开发者社区> 人民邮电出版社> 正文

带你读《云原生应用开发 Operator原理与实践》第三章 Kubebuilder 原理3.3 Controller-runtime 模块分析(六)

简介: 带你读《云原生应用开发 Operator原理与实践》第三章 Kubebuilder 原理3.3 Controller-runtime 模块分析
+关注继续查看

创建:

Controller的创建一般使用 pkg/builder/controller.go下的 Builder对象。例如, 代码清单 3-31创建了一个监听ReplicaSet对象的 Controller,Controller使用 replicaSet-Reconcile作为 Reconciler接口的实现来进行状态同步。

ControllerManagedBy(manager).

For(&appsv1.ReplicaSet{}).

Owns(&corev1.Pod{}).Build(replicaSetReconcile)

 

详细地说,创建 Controller基本分为 4步。

第一步,通过ControllerManagedBymmanager.Manager*Builder方法实例化一个 Builder对象,其中传入的 Manager提供创建 Controller所需的依赖。

第二步,使用 For(objectclient.Object,opts...ForOption)方法设置需要监听的资源类型。除了 For()方法外,还可以通过代码清单 3-32设置监听的资源类型。

//监听Object,并将 Object对应的Owner加⼊队列。例如,在上⾯的例⼦中监听Pod对象,根据

Pod的 Owner将 Pod所属的ReplicaSet资源加⼊队列

func(blder*Builder)Owns(objectclient.Object,opts...OwnsOption)*Builder{}

 

//监听指定资源,使⽤指定⽅法对事件进⾏处理。建议使⽤For()和 Owns(),⽽不是直接使⽤Watches() ⽅法

func(blder*Builder)Watches(srcsource.Source,eventhandlerhandler.EventHandler,opts...WatchesOption)*Builder{}

 

其中 ForOption、OwnsOption、WatchesOption主要用于设置监听属性,例如,使用Predicates设置事件的过滤器。

第三步,设置 Controller的其他属性,见代码清单 3-33。

//设置事件的过滤器,选择部分create/update/delete/generic事件触发同步

func(blder*Builder)WithEventFilter(ppredicate.Predicate)*Builder{}

//设置 Controller的属性参数,其中Options结构如下,对应上⾯介绍的 Controller中的属性func(blder*Builder) WithOptions(optionscontroller.Options) *Builder{}typeOptionsstruct {

MaxConcurrentReconcilesintReconcilerreconcile.ReconcilerRateLimiterratelimiter.RateLimiterLoglogr.Logger

CacheSyncTimeouttime.Duration

}

 

//设置logger

func(blder*Builder)WithLogger(loglogr.Logger)*Builder{}

//设置Controller的名称,Controller的名称会出现在监控、⽇志等信息中。在默认情况下,Controller

使⽤⼩写字⺟命名。


func(blder*Builder)Named(namestring)*Builder{}

 

第四步,使用Completerreconcile.Reconcilererror方法或Buildrreconcile.Reconciler)

(controller.Controller,error)完成创建,两者是一样的。

 

1. Reconciler

 

Reconciler(协调器)是提供给 Controller 的一个函数,可以随时使用对象的   Name和 Namespace对其进行调用。当它被调用时,Reconciler将确保集群中资源的状态和预设的状态保持一致。例如,ReplicaSet指定 5个副本,但系统中仅存在3个 Pod时,Reconciler将再创建 2个Pod,并向 Pod的 OwnerReference中添加该 ReplicaSet的名称,同时设置“controller=true”属性。

Reconciler需要开发者自己实现,并在创建 Controller时,通过 Builder.Complete() 或 Bu-ilder.Build()方法传递给Controller。Reconciler接口定义在pkg/reconcile/reconcile.go下,只有一个该方法:Reconcile(context.Context,Request) (Result,error)。

该方法中 Request包含了需要处理对象的 Name和 Namespace,Result决定了是否


 

需要将对象重新加入队列以及如何加入队列(见代码清单3-34

typeRequeststruct{types.NamespacedName

}

 

typeResultstruct{

//Requeue告诉Controller是否需要重新将对象加⼊队列,默认为False

Requeuebool

 

//RequeueAfter⼤于0表示Controller需要在设置的时间间隔后,将对象重新加⼊队列

//注意,当设置了RequeueAfter,就表示Requeue为 True,即⽆须RequeueAfter

Requeue=True被同时设置

RequeueAftertime.Duration

}

 

Reconciler 主要有以下特性。

(1)  包含 Controller的所有业务逻辑。

(2)  Reconciler通常在单个对象类型上工作,某个Reconciler一般只会处理一种类型的资源。

(3)  提供了待处理对象的 Name和 Namespace。

(4) 协调者不关心负责触发协调的事件内容或事件类型。无论是对象的增加、删除还是更新操作,Reconciler中接收的都是对象的名称和命名空间。

2. Predicate


Predicate(过滤器)Controller.Watch的可选参数,用于过滤事件。其接口与部分实现在 pkg/predicate/predicate.go下。接口见代码清单 3-35,4个方法分别对应 4种类型的事件过滤,如果通过过滤,则返回 True。

typePredicateinterface{Create(event.CreateEvent)boolDelete(event.DeleteEvent)boolUpdate(event.UpdateEvent)boolGeneric(event.GenericEvent)bool

}

 

Controller-runtime内置了5种 Predicate的实现。


(1)      Funcs:是一个基本结构,结构包含4 个函数对象成员,分别是Predicate的 4个方法的实现。开发者需要根据自己的需求设置相应的成员 ,对于未设置的成员,默认会接受所有对应的事件(见代码清单3-36)。

typeFuncsstruct{

CreateFuncfunc(event.CreateEvent)boolDeleteFuncfunc(event.DeleteEvent)boolUpdateFuncfunc(event.UpdateEvent)boolGenericFuncfunc(event.GenericEvent)bool


}

(2)      ResourceVersionChangedPredicate:只实现了 Update 事件过滤的方法,过滤掉资源对象 ResourceVersion未改变的 Update事件,其他如 Create、Delete类型的事件直接接受。

(3)      GenerationChangedPredicate:类似于 ResourceVersionChangedPredicate,也只实现了 Update事件的过滤。

GenerationChangedPredicate会跳过资源对象 metadata.generation未改变的事件。当对对象的Spec字段进行写操作时,KubernetesAPI服务器会累加对象的metadata.generation字段。因此,GenerationChangedPredicate允许 Controller忽略 Spec未更改而仅元数据 Metadata或状态字段 Status 发生更改的更新事件。需要注意的是,对于开发者定义的 CRD,只有当开启了状态子资源时,metadata.generation 字段才会增加。

上面提到的仅在写入 Spec字段时 metadata.generation字段才增加的情况, 并不适用于所有的 API对象, 例如 Deployment对象, 在写入 metadata.annotationss时,metadata.generation也会增加。另外,由于使用了此 Predicate,Controller的同步不会被只包含状态(Status)更改的事件触发,因此,无法用于同步或恢复对象的状态值。

(4)      AnnotationChangedPredicate:只实现了 Update事件的过滤,此 Predicate跳过对象的 Annotations 字段无变化的更新事件,可以与 GenerationChangedPredicate一起使用,用于同时需要响应对象Spec与Annotation字段更新的Controller(见代码清单3-37)。

Controller.Watch(

&source.Kind{Type:v1.MyCustomKind},

&handler.EnqueueRequestForObject{},

predicate.Or(predicate.GenerationChangedPredicate{},predicate.

AnnotationChangedPredicate{}))

 

(5)      LabelChangedPredicate:只实现了 Update 事件的过滤,跳过标签(Label)未改变的 Update时间,也可以和上面 AnnotationChangedPredicate一样,结合Generation-

ChangedPredicate 用于同时响应对象 Spec与 Label 字段更新的 Controller。

除以上 5种 Predicate 外,还有两个代表逻辑运算符的方法——Or() 与 And(),两个方法可以传递多个 Predicate接口,最终返回一个 Predicate,代表逻辑运算结果。

从上面的例子可以看到,Predicate可以通过 Controller的 Watch() 方法设置。另外, 也可以在创建 Controller时, 将 Predicate通过 Builder.WithEventFilter() 传递到Controller中, 或是通过 pkg/builder/options.go下的 WithPredicates() 方法, 转换成实现 ForOption、OwnsOption、WatchesOption接口的 builder.Predicates结构,在 Buil-der.For()、Builder.Owns()、Builder.Watches() 方法中设置。

Predicate 主要有以下特性。

(1)        接受一个事件,并将该事件是否通过过滤条件的结果返回。如果通过,该事件将被加入待处理事件队列中。

(2)        Predicate 是可选项,可以不设置。如果不设置,默认事件都将被加入待处理事件队列中。

(3)        用户可以使用内置的 Predicate,但是可以设置自定义 Predicate。

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
怎么设置阿里云服务器安全组?阿里云安全组规则详细解说
阿里云服务器安全组设置规则分享,阿里云服务器安全组如何放行端口设置教程
6330 0
《区块链DAPP开发入门、代码实现、场景应用》笔记1——天外飞仙DAPP
Solidity编程语言解决了编写智能合约的不友好的问题,但是当合约编译并部署之后,对与这些接口的访问,对于一般的使用者来说,门槛有点高, 对普通用户来说也是非常不友好,为了使广大用户理解并方便快捷的访问区块链,以及区块链上的智能合约系统,开发者必须提供操作界面和结果查看界面,来简化用户访问和操作区块链的方式。
3948 0
iOS开发笔记 6、View Controllers【MVC】
了解和熟悉这个对后续的开发很重要。   关于这个的参考资料 ■ View Controller Programming Guide for iOS For information about structuring and managing your application’s user interface http://developer.
853 0
C# WinForm多线程开发(二) ThreadPool 与 Timer
原文地址:点击打开链接 [摘要]本文介绍C# WinForm多线程开发之ThreadPool 与 Timer,并提供详细的示例代码供参考。 本文接上文,继续探讨WinForm中的多线程问题,再次主要探讨threadpool 和timer。 一 、ThreadPool 线程池(ThreadPool)是一种相对较简单的方法,它适应于一些需要多个线程而又较短任务(如一些常
1332 0
人工智能在媒体领域的研究和应用
本文整理自2017云栖大会-成都峰会上华西都市报高级数据产品经理黄传能的分享讲义。讲义主要分享了交互方式对媒体智能化的影响,并分享了,并分享了智能融媒体的探索,封面智能融媒体的实现与多项媒体人工智能方面的实践。
1209 0
安卓开发ScrollView嵌套ListView只显示一行
在用列表控件做一个“更多功能”的界面的时候 1 2 7 8 12 13 17 18 23 27 28 33 37 38 39 原本用ScrollView嵌套...
891 0
472
文章
0
问答
文章排行榜
最热
最新
相关电子书
更多
文娱运维技术
立即下载
《SaaS模式云原生数据仓库应用场景实践》
立即下载
《看见新力量:二》电子书
立即下载