Kubebuilder简介与架构

什么是Kubebuilder

Kubebuilder是一个用Go原因构建Kubernetes APIs的框架，通过使用KubeBuilder，用户可以遵循一套简单的编程框架，使用CRD构建API、Controllers和Admission WebHooks，实现对k8s的扩展。

Kubebuilder中的主要组件包含Manager、Cache、Client与Finalizers。其中，Manager组件主要实现管理外层，负责初始化Controller、Cache、Client的工作，Cache组件负责生成ShareInformer，Watch关注的GVK下的GVR的变化（增、删、改），以触发Controller的Reconcile逻辑；Client组件在工作中实现对资源进行CURD操作，CURD操作封装到Client中进行，其中的写操作（增、删、改）直接访问APIServer，读操作（查）对接的是本地的Cache；Finzlizers组件主要用于处理Kubernetes资源的预删除逻辑，保障资源被删除后能够从Cache中读取到，清理相关的其它资源。

Kubebuilder架构

Kubebuilder这种脚手架中间，将Kubernetes的可扩展能力CRD进行了简化封装，如下图所示，kubebuilder总体上将它设计的资源所属位置划分为四大块：User Defined、API Scaffolds、Controller Runtime、Kubernetes集群。

Kubebuilder Scaffolds是实现这个脚手架最核心的逻辑，它借助APIScaffolder对象模块，实现了CRD的Template和Controller的核心代码块。

在Controller Rumetime模块中，Kubebuilder构建出来的CRD会注册到Scheme模块，它提供了Kinds与对应的Go Type的映射，即给定了Go Type，就能够知道它的GKV（Group Kind Version），这也是Kubernetes所有资源的注册模块。举例来说，我们给定了一个Scheme， “demo1.example.org/v1” .Demo{}， 这个Go Type映射到demo1.example.org/v1的Demo GVk，从kubernetes的APIServer获取的部分JSON内容如下

{
    "apiVersion": "demo1.example.org/v1",
    "kind": "Demo",
    "metadata": {
    }
}

通过这个Go Type，能够正确地获取Group Kind Version的信息，从而提供给Controller，获取期望的状态，即协调的逻辑。而在Controller Runtime中Controller最依赖的除了Scheme之外，还包括Manager的初始化、安装和启动工作。Manager的初始化依赖Controller Runtime库初始化Manager对象，包括Client、Cache等模块的生成工作。然后Client就可以实现对CRD的创建、删除、更新、查询等过程，而查询的逻辑是通过本地的Cache模块实现的。这里的Cache负责监听CRD的变化，它是通过监听Scheme，从而收集所有与Controller有关的Group Kind Version资源，并创建对应的监听器，从而实现当监听到Kubernetes集群中的CRD发生变化触发Controller的协调进程Reconcile工作。

初次之外，Kubebuilder工具生成的内容还包括Finalizer，它用于处理kubernetes资源的预删除逻辑，保障资源被删除后能够从Cache中读取到，清理相关的其它资源，OwnerReference用于清理资源时，对于任何一个资源，若它的OwnerReference字段值为待删除对象，则这个对象也会被清理，支持对象的变更，也会触发Owner对象的Controller对的协调过程；Index用于提供资源的缓存，提升客户端资源的查询效率。