带你读《云原生应用开发 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对象,根据

PodOwnerPod所属的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 的一个函数,可以随时使用对象的   NameNamespace对其进行调用。当它被调用时,Reconciler将确保集群中资源的状态和预设的状态保持一致。例如,ReplicaSet指定 5个副本,但系统中仅存在3Pod时,Reconciler将再创建 2Pod,并向 PodOwnerReference中添加该 ReplicaSet的名称,同时设置“controller=true”属性。

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

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


 

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

typeRequeststruct{types.NamespacedName

}

 

typeResultstruct{

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

Requeuebool

 

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

//注意,当设置了RequeueAfter,就表示RequeueTrue,即⽆须RequeueAfter

Requeue=True被同时设置

RequeueAftertime.Duration

}

 

Reconciler 主要有以下特性。

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

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

(3)  提供了待处理对象的 NameNamespace。

(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内置了5Predicate的实现。


(1)      Funcs:是一个基本结构,结构包含4 个函数对象成员,分别是Predicate4方法的实现。开发者需要根据自己的需求设置相应的成员 ,对于未设置的成员,默认会接受所有对应的事件(见代码清单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一起使用,用于同时需要响应对象SpecAnnotation字段更新的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 用于同时响应对象 SpecLabel 字段更新的 Controller。

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

从上面的例子可以看到,Predicate可以通过 ControllerWatch() 方法设置。另外, 也可以在创建 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。

相关文章
|
1月前
|
Kubernetes Cloud Native 持续交付
云原生技术在现代应用开发中的角色与实践
【9月更文挑战第9天】 随着云计算技术的飞速发展,云原生(Cloud Native)已经成为推动企业数字化转型的核心力量。本文将深入探讨云原生的基本概念、关键技术及其在实际开发中的应用案例,旨在为读者提供一条清晰的云原生技术学习路径和应用指南。通过实例分析,我们将揭示云原生如何优化资源管理、提升应用性能及加快部署速度,进而帮助企业构建更加灵活、可靠和高效的软件系统。
|
11天前
|
Cloud Native 测试技术 云计算
云原生技术在现代应用开发中的角色与实践
【9月更文挑战第31天】本文深入探讨了云原生技术如何革新现代应用开发流程,通过实际案例分析,揭示了其对提高开发效率、确保系统可扩展性和可靠性的显著影响。文章不仅介绍了云原生的核心概念,还提供了实施策略和最佳实践,旨在为开发者提供一条清晰的云原生转型之路。
|
19天前
|
Kubernetes Cloud Native 持续交付
云原生技术在现代应用开发中的实践与思考
【9月更文挑战第23天】本文将深入探讨云原生技术如何革新现代应用的开发流程。通过分析云原生的核心概念、优势以及实际应用案例,我们旨在揭示这一新兴技术范式如何助力开发者和企业更高效、灵活地构建和部署应用程序。文章还将提供具体代码示例,展示云原生技术在实际项目中的应用,帮助读者更好地理解和掌握该技术。
|
20天前
|
Cloud Native 持续交付 开发者
云原生技术在现代应用开发中的应用与实践
【9月更文挑战第22天】本文将深入探讨云原生技术如何革新现代应用开发,通过实际案例分析其对提高开发效率、促进持续集成与交付的显著影响。我们将从云原生的基本概念出发,逐步展开到容器化、微服务架构、自动化管理的实践操作,以及这些技术如何协同工作以支持复杂应用的快速迭代和扩展。文章旨在为开发者提供一套云原生技术的实践框架,帮助他们构建更加灵活、可维护的应用系统。
|
1月前
|
Cloud Native 持续交付 云计算
云原生技术在现代应用开发中的应用与实践
【9月更文挑战第12天】随着云计算技术的飞速发展,云原生已成为推动企业数字化转型的关键技术之一。本文将深入探讨云原生的基本概念、核心价值及其在现代应用开发中的实际应用案例,旨在为读者提供一套清晰的云原生应用开发指南。通过分析容器化、微服务架构、持续部署等核心技术的实践过程,我们将揭示云原生如何助力开发者高效构建、部署和管理可扩展的应用。你将看到代码示例,这些示例均选自真实世界的开发场景,帮助你理解云原生技术的强大功能和灵活性。
|
29天前
|
运维 Cloud Native 持续交付
云原生技术:探索现代应用开发的新纪元
本文深入探讨了云原生技术的崛起,以及它如何彻底改变现代应用开发和部署的方式。我们将从云原生的基本概念入手,逐步解析其核心技术如容器化、微服务架构及自动化运维,并展示这些技术如何帮助开发者和企业实现更高效、更灵活的应用管理。通过实际案例分析,我们将揭示云原生技术在提升开发效率、优化资源利用和增强系统可扩展性方面的巨大潜力。
|
1月前
|
Cloud Native 持续交付 开发者
云原生技术在现代应用开发中的角色与实践
【9月更文挑战第12天】本文将探索云原生技术的核心概念及其在现代软件开发中的应用。通过分析容器化、微服务架构、持续集成/持续部署(CI/CD)和DevOps文化的融合,我们旨在揭示如何利用这些技术提升软件的可靠性、可扩展性和交付速度。同时,文章还将展示一个简化的代码示例,以直观地说明云原生技术的实际应用。
|
2月前
|
运维 Cloud Native Android开发
云原生之旅:容器化与微服务架构的融合之道安卓应用开发入门指南
本文将深入探讨云原生技术的核心要素——容器化和微服务架构,并揭示它们如何共同推动现代软件的开发与部署。通过实际案例分析,我们将看到这两种技术如何相辅相成,助力企业实现敏捷、可扩展的IT基础设施。文章旨在为读者提供一条清晰的道路,指引如何在云原生时代利用这些技术构建和优化应用。 本文将引导初学者了解安卓应用开发的基本概念和步骤,从安装开发环境到编写一个简单的“Hello World”程序。通过循序渐进的讲解,让读者快速掌握安卓开发的核心技能,为进一步深入学习打下坚实基础。
46 1
|
2月前
|
Kubernetes Cloud Native 持续交付
云原生技术在现代应用开发中的应用
【8月更文挑战第29天】本文将探讨云原生技术在现代应用开发中的重要性,包括其概念、优势和实践。我们将通过代码示例来展示如何在云平台上构建和部署云原生应用。
|
4月前
|
运维 Cloud Native 持续交付
云原生技术:现代应用开发的革命性变革
云原生技术正在重新定义软件开发和部署的方式。通过采用容器、微服务、持续集成与持续交付(CI/CD)等关键技术,企业可以显著提升开发效率、缩短上市时间,并提高应用的可扩展性和可靠性。本文深入探讨了云原生技术的核心组件及其带来的实际业务价值,展示了其在现代应用开发中的革命性影响。
52 1