带你读《云原生应用开发 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。

相关文章
|
10月前
|
存储 缓存 分布式计算
StarRocks x Iceberg:云原生湖仓分析技术揭秘与最佳实践
本文将深入探讨基于 StarRocks 和 Iceberg 构建的云原生湖仓分析技术,详细解析两者结合如何实现高效的查询性能优化。内容涵盖 StarRocks Lakehouse 架构、与 Iceberg 的性能协同、最佳实践应用以及未来的发展规划,为您提供全面的技术解读。 作者:杨关锁,北京镜舟科技研发工程师
StarRocks x Iceberg:云原生湖仓分析技术揭秘与最佳实践
|
Kubernetes 监控 Cloud Native
云原生时代下的应用开发与部署实践
【10月更文挑战第4天】在云原生的浪潮中,开发者和运维人员面临着新的挑战和机遇。本文将通过实际案例,展示如何在云平台上高效地开发、部署和管理应用,同时确保系统的可扩展性和高可用性。我们将深入探讨容器化技术、微服务架构以及持续集成/持续部署(CI/CD)流程的实施策略,旨在为读者提供一套完整的云原生解决方案框架。
|
Kubernetes Cloud Native 持续交付
云原生技术在现代应用开发中的角色与实践
【9月更文挑战第9天】 随着云计算技术的飞速发展,云原生(Cloud Native)已经成为推动企业数字化转型的核心力量。本文将深入探讨云原生的基本概念、关键技术及其在实际开发中的应用案例,旨在为读者提供一条清晰的云原生技术学习路径和应用指南。通过实例分析,我们将揭示云原生如何优化资源管理、提升应用性能及加快部署速度,进而帮助企业构建更加灵活、可靠和高效的软件系统。
|
Kubernetes Cloud Native 持续交付
云原生技术在现代应用开发中的实践与思考
【10月更文挑战第35天】云原生技术,作为云计算的进阶形态,正引领着软件开发和运维的新潮流。本文将深入探讨云原生技术的核心理念、关键技术组件以及在实际项目中的应用案例,帮助读者理解如何利用云原生技术优化应用架构,提高开发效率和系统稳定性。我们将从容器化、微服务、持续集成/持续部署(CI/CD)等角度出发,结合实际代码示例,展现云原生技术的强大能力。
|
监控 Cloud Native 持续交付
云原生技术深度解析:重塑现代应用开发与部署范式####
本文深入探讨了云原生技术的核心概念、关键技术组件及其在现代软件开发中的重要性。通过剖析容器化、微服务架构、持续集成/持续部署(CI/CD)等关键技术,本文旨在揭示云原生技术如何促进应用的敏捷性、可扩展性和高可用性,进而推动企业数字化转型进程。不同于传统摘要仅概述内容要点,本部分将融入具体案例分析,直观展示云原生技术在实际应用中的显著成效与挑战应对策略,为读者提供更加丰富、立体的理解视角。 ####
|
Kubernetes Cloud Native 持续交付
云原生技术在现代应用开发中的实践与展望
【10月更文挑战第7天】随着技术的不断演进,云计算已从简单的资源租用模式转变为支持复杂、高效、灵活的云原生应用架构。本文将深入探讨云原生技术的核心概念及其在现代应用开发中的应用,通过分析Kubernetes容器编排和微服务架构的实践案例,揭示云原生技术如何推动软件开发的现代化进程。文章旨在为开发者和架构师提供一套实用的云原生应用开发指南,同时展望未来云原生技术的发展方向。
135 8
|
人工智能 Serverless API
云原生应用开发平台CAP:一站式应用开发及生命周期管理解决方案
阿里云的云应用开发平台CAP(Cloud Application Platform)是一款一站式应用开发及应用生命周期管理平台。它提供丰富的Serverless与AI应用模板、高效的开发者工具链及企业级应用管理功能,帮助开发者快速构建、部署和管理云上应用,大幅提升研发、部署和运维效能。
1045 4
|
Kubernetes Cloud Native 持续交付
云原生技术:重塑现代应用开发与部署模式####
本文深入探讨了云原生技术的核心概念、发展历程及其在现代软件开发和部署中的关键作用。通过分析云原生架构的特点,如容器化、微服务、持续集成与持续部署(CI/CD),以及它如何促进应用的可伸缩性、灵活性和效率,本文旨在为读者提供一个关于云原生技术全面而深入的理解。此外,还将探讨实施云原生策略时面临的挑战及应对策略,帮助组织更好地把握数字化转型的机遇。 ####
|
Cloud Native 测试技术 云计算
云原生技术在现代应用开发中的角色与实践
【9月更文挑战第31天】本文深入探讨了云原生技术如何革新现代应用开发流程,通过实际案例分析,揭示了其对提高开发效率、确保系统可扩展性和可靠性的显著影响。文章不仅介绍了云原生的核心概念,还提供了实施策略和最佳实践,旨在为开发者提供一条清晰的云原生转型之路。
|
运维 Cloud Native Android开发
云原生之旅:容器化与微服务架构的融合之道安卓应用开发入门指南
本文将深入探讨云原生技术的核心要素——容器化和微服务架构,并揭示它们如何共同推动现代软件的开发与部署。通过实际案例分析,我们将看到这两种技术如何相辅相成,助力企业实现敏捷、可扩展的IT基础设施。文章旨在为读者提供一条清晰的道路,指引如何在云原生时代利用这些技术构建和优化应用。 本文将引导初学者了解安卓应用开发的基本概念和步骤,从安装开发环境到编写一个简单的“Hello World”程序。通过循序渐进的讲解,让读者快速掌握安卓开发的核心技能,为进一步深入学习打下坚实基础。
236 28

热门文章

最新文章