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

开发者社区> 人民邮电出版社> 正文
登录阅读全文

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

简介: 带你读《云原生应用开发 Operator原理与实践》第三章 Kubebuilder 原理3.2 Kubebuilder 模块分析

3.2.5      Finalizers

Finalizers是每种资源在生命周期结束时都会用到的字段。该字段属于KubernetesGC 垃圾收集器,它是一种删除拦截机制,可以让控制器在删除资源前(Pre-delete)进行回调。


Finalizers是在对象删除之前需要执行的逻辑,比如你给资源类型中的每个对象都创建了对应的外部资源,并且希望在 Kuebernetes 删除对应资源的同时删除关联的外部资源,那么可以通过 Finalizers来实现。当 Finalizers 字段存在时,相关资源不允许被强制删除。所有的对象在被彻底删除之前,它的 Finalizers字段必须为空,即必须保证在所有对象被彻底删除之前,与它关联的所有相关资源已被删除。

Finalizers存在于任何一个资源对象的 Meta中,在 Kuebernetes源码中声明为“[ ]string”类型,见代码清单 3-21。

typeObjectMetastruct{

//...

Finalizers[]string

//...DeletionTimestamp*Time

}

 

存在 Finalizers字段的资源对象接收的第一个删除请求,设置metadata.Deletion-Timestamp 字段的值,但不删除具体资源,在设置该字段后,Finalizers列表中的对象只能被删除,不能进行其他操作。

当 metadata.DeletionTimestamp字段为非空时,Controller监听对象并执行对应Finalizers的动作,在所有动作执行完成后,将该 Finalizer从列表中移除。一旦 Finalizers列表为空,就意味着所有 Finalizer 都被执行过,最终 Kubernetes 会删除该资源。

在 OperatorController中,最重要的逻辑就是 Reconcile方法,Finalizers也是在Reconcile中实现的,具体内容见代码清单 3-22。

func(r*CronJobReconciler)Reconcile(reqctrl.Request)(ctrl.Result,error){ctx:=context.Background()

log:=r.Log.WithValues("cronjob",req.NamespacedName)

 

varcronJobbatch.CronJob

iferr:=r.Get(ctx,req.NamespacedName,&cronJob);err!=nil{log.Error(err,"unabletofetchCronJob")

returnctrl.Result{},ignoreNotFound(err)

}


//声明  Finalizer字段,由前⽂可知,类型为字符串

//⾃定义  Finalizer的标识符包含⼀个域名、⼀个正向斜线和Finalizer的名称

myFinalizerName:="storage.finalizers.tutorial.kubebuilder.io"

 

//通过检查 DeletionTimestamp字段是否为0,判断资源是否被删除ifcronJob.ObjectMeta.DeletionTimestamp.IsZero() {

//如果 DeletionTimestamp字段为0,说明资源未被删除,此时需要检测是否存在

Finalizer,如果不存在,则添加,并更新到资源对象中

if!containsString(cronJob.ObjectMeta.Finalizers,myFinalizerName){cronJob.ObjectMeta.Finalizers=append(cronJob.ObjectMeta.

Finalizers,myFinalizerName)

iferr:=r.Update(context.Background(),cronJob);err!=nil{returnctrl.Result{},err

}

}

}else{

//如果DeletionTimestamp字段不为0,说明对象处于删除状态中

ifcontainsString(cronJob.ObjectMeta.Finalizers,myFinalizerName){

//如果存在 Finalizer且与上述声明的 finalizer匹配,那么执⾏对应的 hook

iferr:=r.deleteExternalResources(cronJob);err!=nil{

//如果删除失败,则直接返回对应的 errController会⾃动执⾏重试逻辑

returnctrl.Result{},err

}

 

//如果对应的 hook执⾏成功,那么清空finalizersKuebernetes删除对应资源cronJob.ObjectMeta.Finalizers= removeString(cronJob.ObjectMeta.

Finalizers,myFinalizerName)

iferr:=r.Update(context.Background(),cronJob);err!=nil{returnctrl.Result{},err

}

}

 

returnctrl.Result{},err

}

}

 

func(r*Reconciler)deleteExternalResources(cronJob*batch.CronJob)error{

//删除 cronJob关联的外部资源逻辑

//需要确保实现是幂等的

}

 

funccontainsString(slice[]string,sstring)bool{for_,item:=rangeslice{

ifitem==s{returntrue

}

}

returnfalse

}

 

funcremoveString(slice[]string,sstring)(result[]string){for_,item:=rangeslice{

ifitem==s{continue

}

result=append(result,item)

}

return

}

 

在 Kuebernetes中,只要对象 ObjectMeta中的 Finalizers不为空,对该对象的 Delete作就会转变为Update操作,从代码清单3-22中我们可以看到,UpdateDeletionTimestamp字段的意义是告诉 Kuebernetes的垃圾回收器,在DeletionTimestamp这个时刻之后,只要 Finalizers为空,就立马删除该对象。

所以一般的使用方法就是在创建对象时把Finalizers  设置好任意String),然后处理DeletionTimestamp不为空的Update操作(实际是Delete),根据Finalizers的值执行完所有的Pre-deleteHook(此时可以在Cache中读取被删除对象的任何信息)之后将 Finalizers设置为空即可。

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

分享: