k8s 自定义 controller 三部曲之二: 自动生成代码

发布于：2022-12-27 ⋅ 阅读:(169) ⋅ 点赞:(0)

  • 接下来详细讲述应用的编码过程，如果您不想自己写代码，也可以在 GitHub 下载完整的应用源码，地址和链接信息如下表所示：

  • 这个 git 项目中有多个文件夹，本章源码在 k8s_customize_controller 这个文件夹下，如下图红框所示：

为什么要做 controller

  • 但如果仅仅是在 etcd 保存 Student 对象是没有什么意义的，试想通过 deployment 创建 pod 时，如果只在 etcd 创建 pod 对象，而不去 node 节点创建容器，那这个 pod 对象只是一条数据而已，没有什么实质性作用，其他对象如 service、pv 也是如此； controller 的作用就是监听指定对象的新增、删除、修改等变化，针对这些变化做出相应的响应（例如新增 pod 的响应为创建 docker 容器），关于 controller 的详细设计，最好的参考就是 Harry (Lei) Zhang 老师在 twitter 上的分享，如下图，地址是： https://twitter.com/resouer/status/1009996649832185856

  • 如上图，API 对象的变化会通过 Informer 存入队列（WorkQueue），在 Controller 中消费队列的数据做出响应，响应相关的具体代码就是我们要做的真正业务逻辑；

自动生成代码是什么

  • 从上图可以发现整个逻辑还是比较复杂的，为了简化我们的自定义 controller 开发，k8s 的大师们利用自动代码生成工具将 controller 之外的事情都做好了，我们只要专注于 controller 的开发就好。

  • 关于 controller 的代码我们留待下一章完成，本章关注的是如何自动生成代码的实战，将上图中 controller 之外的事情都完成了；

开始实战

  • 接下来要做的事情就是编写 API 对象 Student 相关的声明的定义代码，然后用代码生成工具结合这些代码，自动生成 Client、Informet、WorkQueue 相关的代码；

  • 在 $GOPATH/src/目录下创建一个文件夹 k8s_customize_controller ：

  • 进入文件夹 k8s_customize_controller，执行如下命令创建三层目录：

mkdir -p pkg/apis/bolingcavalry

复制代码

  • 在新建的 bolingcavalry 目录下创建文件 register.go ，内容如下：

package bolingcavalry
const (        GroupName = "bolingcavalry.k8s.io"        Version   = "v1")

复制代码

  • 在新建的 bolingcavalry 目录下创建名为 v1 的文件夹；

  • 在新建的 v1 文件夹下创建文件 doc.go ，内容如下：

// +k8s:deepcopy-gen=package
// +groupName=bolingcavalry.k8s.iopackage v1

复制代码

  • 上述代码中的两行注释，都是代码生成工具会用到的，一个是声明为整个 v1 包下的类型定义生成 DeepCopy 方法，另一个声明了这个包对应的 API 的组名，和 CRD 中的组名一致；

  • 在 v1 文件夹下创建文件 types.go ，里面定义了 Student 对象的具体内容：

package v1
import (    metav1 "k8s.io/apimachinery/pkg/apis/meta/v1")
// +genclient// +genclient:noStatus// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
type Student struct {    metav1.TypeMeta   `json:",inline"`    metav1.ObjectMeta `json:"metadata,omitempty"`    Spec              StudentSpec `json:"spec"`}
type StudentSpec struct {    name   string `json:"name"`    school string `json:"school"`}
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// StudentList is a list of Student resourcestype StudentList struct {    metav1.TypeMeta `json:",inline"`    metav1.ListMeta `json:"metadata"`
    Items []Student `json:"items"`}

复制代码

  • 从上述源码可见，Student 对象的内容已经被设定好，主要有 name 和 school 这两个字段，表示学生的名字和所在学校，因此创建 Student 对象的时候内容就要和这里匹配了；

  • 在 v1 目录下创建 register.go 文件，此文件的作用是通过 addKnownTypes 方法使得 client 可以知道 Student 类型的 API 对象：

package v1
import (    metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"    "k8s.io/apimachinery/pkg/runtime"    "k8s.io/apimachinery/pkg/runtime/schema"
    "k8s_customize_controller/pkg/apis/bolingcavalry")
var SchemeGroupVersion = schema.GroupVersion{    Group:   bolingcavalry.GroupName,    Version: bolingcavalry.Version,}
var (    SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)    AddToScheme   = SchemeBuilder.AddToScheme)
func Resource(resource string) schema.GroupResource {    return SchemeGroupVersion.WithResource(resource).GroupResource()}
func Kind(kind string) schema.GroupKind {    return SchemeGroupVersion.WithKind(kind).GroupKind()}
func addKnownTypes(scheme *runtime.Scheme) error {    scheme.AddKnownTypes(        SchemeGroupVersion,        &Student{},        &StudentList{},    )
    // register the type in the scheme    metav1.AddToGroupVersion(scheme, SchemeGroupVersion)    return nil}

复制代码

  • 至此，为自动生成代码做的准备工作已经完成了，目前为止，$GOPATH/src 目录下的文件和目录结构是这样的：

[root@golang src]# tree.└── k8s_customize_controller    └── pkg        └── apis            └── bolingcavalry                ├── register.go                └── v1                    ├── doc.go                    ├── register.go                    └── types.go
5 directories, 4 files

复制代码

  • 执行以下命令，会先下载依赖包，再下载代码生成工具，再执行代码生成工作：

cd $GOPATH/src \&& go get -u k8s.io/apimachinery/pkg/apis/meta/v1 \&& go get -u k8s.io/code-generator/... \&& cd $GOPATH/src/k8s.io/code-generator \&& ./generate-groups.sh all \k8s_customize_controller/pkg/client \k8s_customize_controller/pkg/apis \bolingcavalry:v1

复制代码

  • 如果代码写得没有问题，会看到以下输出：

Generating deepcopy funcsGenerating clientset for bolingcavalry:v1 at k8s_customize_controller/pkg/client/clientsetGenerating listers for bolingcavalry:v1 at k8s_customize_controller/pkg/client/listersGenerating informers for bolingcavalry:v1 at k8s_customize_controller/pkg/client/informers

复制代码

  • 此时再去 $GOPATH/src/k8s_customize_controller 目录下执行 tree 命令，可见已生成了很多内容：

[root@master k8s_customize_controller]# tree.└── pkg    ├── apis    │   └── bolingcavalry    │       ├── register.go    │       └── v1    │           ├── doc.go    │           ├── register.go    │           ├── types.go    │           └── zz_generated.deepcopy.go    └── client        ├── clientset        │   └── versioned        │       ├── clientset.go        │       ├── doc.go        │       ├── fake        │       │   ├── clientset_generated.go        │       │   ├── doc.go        │       │   └── register.go        │       ├── scheme        │       │   ├── doc.go        │       │   └── register.go        │       └── typed        │           └── bolingcavalry        │               └── v1        │                   ├── bolingcavalry_client.go        │                   ├── doc.go        │                   ├── fake        │                   │   ├── doc.go        │                   │   ├── fake_bolingcavalry_client.go        │                   │   └── fake_student.go        │                   ├── generated_expansion.go        │                   └── student.go        ├── informers        │   └── externalversions        │       ├── bolingcavalry        │       │   ├── interface.go        │       │   └── v1        │       │       ├── interface.go        │       │       └── student.go        │       ├── factory.go        │       ├── generic.go        │       └── internalinterfaces        │           └── factory_interfaces.go        └── listers            └── bolingcavalry                └── v1                    ├── expansion_generated.go                    └── student.go
21 directories, 27 files

复制代码

  • 如上所示，zz_generated.deepcopy.go 就是 DeepCopy 代码文件，client 目录下的内容都是客户端相关代码，在开发 controller 时会用到；

  • client 目录下的 clientset、informers、listers 的身份和作用可以和前面的图结合来理解；

  • 至此，自动生成代码的步骤已经完成，我们已经为后面编写 controller 做好了充分的准备，接下来的章节就是编写 controller 了，点击链接继续实战： 《k8s自定义controller三部曲之三：编写controller代码》

网站公告

今日签到

点亮在社区的每一天
去签到

热门文章

最新发布