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

相关文章
|
15天前
|
Kubernetes Cloud Native Docker
云原生时代的容器化实践:Docker和Kubernetes入门
【10月更文挑战第37天】在数字化转型的浪潮中,云原生技术成为企业提升敏捷性和效率的关键。本篇文章将引导读者了解如何利用Docker进行容器化打包及部署,以及Kubernetes集群管理的基础操作,帮助初学者快速入门云原生的世界。通过实际案例分析,我们将深入探讨这些技术在现代IT架构中的应用与影响。
56 2
|
18天前
|
监控 Kubernetes Cloud Native
云原生之旅:从理论到实践的探索
【10月更文挑战第34天】本文将引导你走进云原生的世界,从基础概念出发,逐步深入到实际的应用部署。我们将探讨云原生技术如何改变现代软件开发和运维的方式,并展示通过一个简单应用的部署过程来具体理解服务编排、容器化以及自动化管理的实践意义。无论你是云原生技术的初学者还是希望深化理解的开发者,这篇文章都将为你提供有价值的视角和知识。
28 3
|
14天前
|
运维 Kubernetes Cloud Native
云原生技术入门及实践
【10月更文挑战第39天】在数字化浪潮的推动下,云原生技术应运而生,它不仅仅是一种技术趋势,更是企业数字化转型的关键。本文将带你走进云原生的世界,从基础概念到实际操作,一步步揭示云原生的魅力和价值。通过实例分析,我们将深入探讨如何利用云原生技术提升业务灵活性、降低成本并加速创新。无论你是云原生技术的初学者还是希望深化理解的开发者,这篇文章都将为你提供宝贵的知识和启示。
|
5天前
|
Kubernetes Cloud Native 微服务
云原生入门与实践:Kubernetes的简易部署
云原生技术正改变着现代应用的开发和部署方式。本文将引导你了解云原生的基础概念,并重点介绍如何使用Kubernetes进行容器编排。我们将通过一个简易的示例来展示如何快速启动一个Kubernetes集群,并在其上运行一个简单的应用。无论你是云原生新手还是希望扩展现有知识,本文都将为你提供实用的信息和启发性的见解。
|
6天前
|
Cloud Native 安全 Docker
云原生技术在现代应用部署中的实践与思考
本文深入探讨了云原生技术如何在现代应用部署中发挥关键作用,并提供了具体的代码示例来展示其实现。通过分析云原生的核心概念和优势,我们将了解如何利用这些技术来提高应用的可扩展性、可靠性和安全性。文章还将讨论云原生技术的未来发展趋势,以及如何将其应用于实际项目中,以实现更高效和灵活的应用部署。
|
13天前
|
Cloud Native 安全 API
云原生架构下的微服务治理策略与实践####
—透过云原生的棱镜,探索微服务架构下的挑战与应对之道 本文旨在探讨云原生环境下,微服务架构所面临的关键挑战及有效的治理策略。随着云计算技术的深入发展,越来越多的企业选择采用云原生架构来构建和部署其应用程序,以期获得更高的灵活性、可扩展性和效率。然而,微服务架构的复杂性也带来了服务发现、负载均衡、故障恢复等一系列治理难题。本文将深入分析这些问题,并提出一套基于云原生技术栈的微服务治理框架,包括服务网格的应用、API网关的集成、以及动态配置管理等关键方面,旨在为企业实现高效、稳定的微服务架构提供参考路径。 ####
41 5
|
15天前
|
运维 Cloud Native 安全
云原生技术在现代软件开发中的实践与挑战####
【10月更文挑战第21天】 本文将深入探讨云原生技术在现代软件开发中的应用,分析其带来的优势及面临的挑战。通过案例分析和数据支持,揭示云原生化转型的关键因素,并展望未来发展趋势。 ####
34 7
|
14天前
|
负载均衡 监控 Cloud Native
云原生架构下的微服务治理策略与实践####
在数字化转型浪潮中,企业纷纷拥抱云计算,而云原生架构作为其核心技术支撑,正引领着一场深刻的技术变革。本文聚焦于云原生环境下微服务架构的治理策略与实践,探讨如何通过精细化的服务管理、动态的流量调度、高效的故障恢复机制以及持续的监控优化,构建弹性、可靠且易于维护的分布式系统。我们将深入剖析微服务治理的核心要素,结合具体案例,揭示其在提升系统稳定性、扩展性和敏捷性方面的关键作用,为读者提供一套切实可行的云原生微服务治理指南。 ####
|
14天前
|
消息中间件 缓存 Cloud Native
云原生架构下的性能优化实践与挑战####
随着企业数字化转型的加速,云原生架构以其高度解耦、弹性伸缩和快速迭代的特性,成为现代软件开发的首选模式。本文深入探讨了云原生环境下性能优化的关键策略与面临的主要挑战,通过案例分析,揭示了如何有效利用容器化、微服务、动态调度等技术手段提升应用性能,同时指出了在复杂云环境中确保系统稳定性和高效性的难题,为开发者和架构师提供了实战指南。 ####
29 3
|
15天前
|
运维 Kubernetes Cloud Native
深入理解云原生架构:从理论到实践
【10月更文挑战第38天】本文将引导读者深入探索云原生技术的核心概念,以及如何将这些概念应用于实际的软件开发和运维中。我们将从云原生的基本定义出发,逐步展开其背后的设计哲学、关键技术组件,并以一个具体的代码示例来演示云原生应用的构建过程。无论你是云原生技术的初学者,还是希望深化理解的开发者,这篇文章都将为你提供有价值的见解和实操指南。

热门文章

最新文章