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

相关文章
|
19天前
|
运维 Cloud Native 持续交付
云原生架构的演进与实践####
【10月更文挑战第16天】 云原生,这一概念自提出以来,便以其独特的魅力和无限的可能性,引领着现代软件开发与部署的新浪潮。本文旨在探讨云原生架构的核心理念、关键技术及其在实际项目中的应用实践,揭示其如何帮助企业实现更高效、更灵活、更可靠的IT系统构建与管理。通过深入剖析容器化、微服务、持续集成/持续部署(CI/CD)等核心技术,结合具体案例,本文将展现云原生架构如何赋能企业数字化转型,推动业务创新与发展。 ####
119 47
|
7天前
|
弹性计算 Kubernetes Cloud Native
云原生架构下的微服务设计原则与实践####
本文深入探讨了在云原生环境中,微服务架构的设计原则、关键技术及实践案例。通过剖析传统单体架构面临的挑战,引出微服务作为解决方案的优势,并详细阐述了微服务设计的几大核心原则:单一职责、独立部署、弹性伸缩和服务自治。文章还介绍了容器化技术、Kubernetes等云原生工具如何助力微服务的高效实施,并通过一个实际项目案例,展示了从服务拆分到持续集成/持续部署(CI/CD)流程的完整实现路径,为读者提供了宝贵的实践经验和启发。 ####
|
8天前
|
Kubernetes 负载均衡 Cloud Native
云原生应用:Kubernetes在容器编排中的实践与挑战
【10月更文挑战第27天】Kubernetes(简称K8s)是云原生应用的核心容器编排平台,提供自动化、扩展和管理容器化应用的能力。本文介绍Kubernetes的基本概念、安装配置、核心组件(如Pod和Deployment)、服务发现与负载均衡、网络配置及安全性挑战,帮助读者理解和实践Kubernetes在容器编排中的应用。
32 4
|
12天前
|
NoSQL Cloud Native atlas
探索云原生数据库:MongoDB Atlas 的实践与思考
【10月更文挑战第21天】本文探讨了MongoDB Atlas的核心特性、实践应用及对云原生数据库未来的思考。MongoDB Atlas作为MongoDB的云原生版本,提供全球分布式、完全托管、弹性伸缩和安全合规等优势,支持快速部署、数据全球化、自动化运维和灵活定价。文章还讨论了云原生数据库的未来趋势,如架构灵活性、智能化运维和混合云支持,并分享了实施MongoDB Atlas的最佳实践。
|
13天前
|
监控 Cloud Native Java
云原生架构下微服务治理策略与实践####
【10月更文挑战第20天】 本文深入探讨了云原生环境下微服务架构的治理策略,通过分析当前技术趋势与挑战,提出了一系列高效、可扩展的微服务治理最佳实践方案。不同于传统摘要概述内容要点,本部分直接聚焦于治理核心——如何在动态多变的分布式系统中实现服务的自动发现、配置管理、流量控制及故障恢复,旨在为开发者提供一套系统性的方法论,助力企业在云端构建更加健壮、灵活的应用程序。 ####
59 10
|
8天前
|
Kubernetes Cloud Native API
云原生架构下微服务治理的深度探索与实践####
本文旨在深入剖析云原生环境下微服务治理的核心要素与最佳实践,通过实际案例分析,揭示高效、稳定的微服务架构设计原则及实施策略。在快速迭代的云计算领域,微服务架构以其高度解耦、灵活扩展的特性成为众多企业的首选。然而,伴随而来的服务间通信、故障隔离、配置管理等挑战亦不容忽视。本研究聚焦于云原生技术栈如何赋能微服务治理,涵盖容器编排(如Kubernetes)、服务网格(如Istio/Envoy)、API网关、分布式追踪系统等关键技术组件的应用与优化,为读者提供一套系统性的解决方案框架,助力企业在云端构建更加健壮、可维护的服务生态。 ####
|
8天前
|
Kubernetes 监控 Cloud Native
云原生应用:Kubernetes在容器编排中的实践与挑战
【10月更文挑战第26天】随着云计算技术的发展,容器化成为现代应用部署的核心趋势。Kubernetes(K8s)作为容器编排领域的佼佼者,以其强大的可扩展性和自动化能力,为开发者提供了高效管理和部署容器化应用的平台。本文将详细介绍Kubernetes的基本概念、核心组件、实践过程及面临的挑战,帮助读者更好地理解和应用这一技术。
36 3
|
13天前
|
NoSQL Cloud Native atlas
探索云原生数据库:MongoDB Atlas 的实践与思考
【10月更文挑战第20天】本文探讨了MongoDB Atlas的核心特性、实践应用及对未来云原生数据库的思考。MongoDB Atlas作为云原生数据库服务,具备全球分布、完全托管、弹性伸缩和安全合规等优势,支持快速部署、数据全球化、自动化运维和灵活定价。文章还讨论了实施MongoDB Atlas的最佳实践和职业心得,展望了云原生数据库的发展趋势。
|
9天前
|
监控 安全 Cloud Native
云原生安全:Istio在微服务架构中的安全策略与实践
【10月更文挑战第26天】随着云计算的发展,云原生架构成为企业数字化转型的关键。微服务作为其核心组件,虽具备灵活性和可扩展性,但也带来安全挑战。Istio作为开源服务网格,通过双向TLS加密、细粒度访问控制和强大的审计监控功能,有效保障微服务间的通信安全,成为云原生安全的重要工具。
27 2
|
8天前
|
监控 Cloud Native 持续交付
云原生技术深度解析:重塑现代应用开发与部署范式####
本文深入探讨了云原生技术的核心概念、关键技术组件及其在现代软件开发中的重要性。通过剖析容器化、微服务架构、持续集成/持续部署(CI/CD)等关键技术,本文旨在揭示云原生技术如何促进应用的敏捷性、可扩展性和高可用性,进而推动企业数字化转型进程。不同于传统摘要仅概述内容要点,本部分将融入具体案例分析,直观展示云原生技术在实际应用中的显著成效与挑战应对策略,为读者提供更加丰富、立体的理解视角。 ####