k8s 自定义 controller 三部曲之二: 自动生成代码
欢迎访问我的 GitHub
这里分类和汇总了欣宸的全部原创(含配套源码):https://github.com/zq2599/blog_demos
本文是《k8s 自定义 controller 三部曲》的第二篇,上一篇我们在 k8s 环境注册了 API 对象 Student,此时如果创建 Student 对象就会在 etcd 保存该对象信息;
三部曲所有文章链接
源码下载
接下来详细讲述应用的编码过程,如果您不想自己写代码,也可以在 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,执行如下命令创建三层目录:
在新建的 bolingcavalry 目录下创建文件 register.go,内容如下:
在新建的 bolingcavalry 目录下创建名为 v1 的文件夹;
在新建的 v1 文件夹下创建文件 doc.go,内容如下:
上述代码中的两行注释,都是代码生成工具会用到的,一个是声明为整个 v1 包下的类型定义生成 DeepCopy 方法,另一个声明了这个包对应的 API 的组名,和 CRD 中的组名一致;
在 v1 文件夹下创建文件 types.go,里面定义了 Student 对象的具体内容:
从上述源码可见,Student 对象的内容已经被设定好,主要有 name 和 school 这两个字段,表示学生的名字和所在学校,因此创建 Student 对象的时候内容就要和这里匹配了;
在 v1 目录下创建 register.go 文件,此文件的作用是通过 addKnownTypes 方法使得 client 可以知道 Student 类型的 API 对象:
至此,为自动生成代码做的准备工作已经完成了,目前为止,$GOPATH/src 目录下的文件和目录结构是这样的:
执行以下命令,会先下载依赖包,再下载代码生成工具,再执行代码生成工作:
如果代码写得没有问题,会看到以下输出:
此时再去 $GOPATH/src/k8s_customize_controller 目录下执行 tree 命令,可见已生成了很多内容:
如上所示,zz_generated.deepcopy.go 就是 DeepCopy 代码文件,client 目录下的内容都是客户端相关代码,在开发 controller 时会用到;
client 目录下的 clientset、informers、listers 的身份和作用可以和前面的图结合来理解;
至此,自动生成代码的步骤已经完成,我们已经为后面编写 controller 做好了充分的准备,接下来的章节就是编写 controller 了,点击链接继续实战:《k8s自定义controller三部曲之三:编写controller代码》
欢迎关注 InfoQ:程序员欣宸
版权声明: 本文为 InfoQ 作者【程序员欣宸】的原创文章。
原文链接:【http://xie.infoq.cn/article/7c754562f42c39813048e9213】。文章转载请联系作者。
评论