kubebuilder实战之八：知识点小记

阳光穿透心脏的1/2处 2022-11-03 11:42 160阅读 0赞

### 欢迎访问我的GitHub ###

> 这里分类和汇总了欣宸的全部原创(含配套源码)：[https://github.com/zq2599/blog\_demos][https_github.com_zq2599_blog_demos]

### 系列文章链接 ###

1.  [kubebuilder实战之一：准备工作][kubebuilder]
2.  [kubebuilder实战之二：初次体验kubebuilder][kubebuilder_kubebuilder]
3.  [kubebuilder实战之三：基础知识速览][kubebuilder 1]
4.  [kubebuilder实战之四：operator需求说明和设计][kubebuilder_operator]
5.  [kubebuilder实战之五：operator编码][kubebuilder_operator 1]
6.  [kubebuilder实战之六：构建部署运行][kubebuilder 2]
7.  [kubebuilder实战之七：webhook][kubebuilder_webhook]
8.  [kubebuilder实战之八：知识点小记][kubebuilder 3]

### 本篇概览 ###

《kubebuilder实战》系列已经写了七篇，前面曾遇到不少问题，磕磕碰碰解决后，打算在本篇集中小结作为备忘，主要有以下几部分组成：

1.  CRD的Status字段；
2.  选择合适的镜像仓库
3.  本地运行controller时跳过webhook
4.  controller的pod有两个容器
5.  常用操作命令整理

*  接下来挨个整理，今天的内容不写代码，咱们来一次轻松愉快的阅读；

### CRD的Status字段 ###

*  这个坑算是自己挖的，希望您能提前避开；
 *  回顾elasticweb的CRD，其数据结构代码如下图：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70]
 *  该CRD的Status数据结构只有一个字段RealQPS，该字段的Tag（也就是上图红框），里面的omitempty属性**非常重要！！！**
 *  如果RealQPS的Tag中没有omitempty属性，会发生什么事情呢？
 *  实际上，在开发webhook之前，我一时大意漏掉了RealQPS的omitempty属性，但是整个controller可以正常工作，elasticweb的功能也达到了咱们的预期，也就是说status的字段如果没有omitempty属性，不影响operator的功能；
 *  但是，在启用了webhook之后，创建资源对象时就报错了：

zhaoqin@zhaoqindeMBP-2 elasticweb % kubectl apply -f config/samples/elasticweb_v1_elasticweb.yaml
    namespace/dev created
    The ElasticWeb "elasticweb-sample" is invalid: status.realQPS: Invalid value: "null": status.realQPS in body must be of type integer: "null"

*  也就是说，Status数据结构的字段中，如果json tag没有omitempty属性，在启用了webhook之后创建资源对象会失败；

### 选择合适的镜像仓库 ###

*  看过之前文章的您，应该还记得构建镜像的命令：

make docker-build docker-push IMG=bolingcavalry/elasticweb:001

*  因为我在hub.docker.com上注册的帐号是bolingcavalry，因此上述命令可以将做好的本地镜像推送到hub.docker.com的仓库中(记得提前用docker login命令登录)；
 *  只要镜像上传到了hub.docker.com，能访问外网的kubernetes就都可以直接使用这个operator了，非常方便；
 *  但是上传到hub.docker.com的过程是痛苦的，动辄半小时的等待，还伴随着超时退出（镜像加速在下载的时候效果明显，但是上传的时候，我这看似乎没啥效果，可能是我不会用，如果您知道还请指点）；
 *  还好，我在阿里云注册过，可以使用上面的镜像仓库，入口如下图：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70 1]
 *  如下图，新建公开类型的镜像仓库，点击红框2，可以看到详细的登录、上传、拉取命令，点击红框3可以修改登录密码：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70 2]
 *  使用了阿里云的镜像服务后，操作命令改成了如下内容：

make docker-build docker-push IMG=registry.cn-hangzhou.aliyuncs.com/bolingcavalry/elasticweb:001

*  整个上传速度也提升了很多，基本上3分钟内可以完成镜像上传；
 *  如果您没有阿里云帐号，或者对阿里云的速度也不满意，也可以自己搭建镜像仓库，自己的内网中速度当然没的说了，细节不在此展开，这里有两篇参考文章：

1.  [CentOS部署Harbor镜像仓库][CentOS_Harbor]
2.  [群晖DS218+部署Harbor(1.10.3)][DS218_Harbor_1.10.3]

### 本地运行controller时跳过webhook ###

*  controller有两种部署方式：部署在kubernetes环境内，或者在kubernetes环境外独立运行
 *  在编码阶段，我们通常选择在自己电脑上运行controller，这样省去了镜像相关的操作，省时又省事儿；
 *  但是，如果使用了webhook，由于其特殊的鉴权方式，需要将kubernetes签发的证书放置在本地(/tmp/k8s-webhook-server/serving-certs/目录)，这就让我们两难了：

1.  选择部署在kubernetes环境，要制作镜像和上传镜像；
2.  选择运行在kubernetes环境之外，要签发证书放置在指定目录；

*  面对上述两难的纠结，官方给出了一个建议，如果在开发阶段暂时用不上webhook(注意这个前提)，那么在本地运行controller时可以用一点小手段屏蔽掉webhook功能，具体操作由以下两步组成：
 *  首先是修改main.go代码，如下图，红框中是新增的代码，其实就是增加了一个判断，如果环境变量ENABLE\_WEBHOOKS等于false，就不会执行webhook相关逻辑：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70 3]
 *  其次，本地启动controller的命令，以前是make run，现在改成如下命令，即增加了一个参数：

make run ENABLE_WEBHOOKS=false

*  现在controller可以正常启动了，功能也正常，只是webhook相关的功能全部都不生效了；

### controller的pod有两个容器 ###

*  如果controller部署在kubernetes环境内，其是以pod的形态存在的，也就是说咱们写的webhook、reconcile代码都是在这个pod中运行的；
 *  上述pod内实际上有两个容器，用kubectl describe命令看看这个pod，如下图，可见名为manager的容器才是controller代码运行的地方：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70 4]
 *  一个pod中有两个容器，对咱们的日常操作略有影响，简单来说就是使用kubectl logs命令查看controller日志的时候，要用**-c**参数指定容器，完整命令如下：

kubectl logs -f \
    elasticweb-controller-manager-58576f4cb-hzchl \
    -c manager \
    -n elasticweb-system

### 常用操作命令整理 ###

*  最后把常用的操作命令整理出来，便于日常使用：

1.  创建operator项目：

kubebuilder init --domain com.bolingcavalry

1.  创建API

kubebuilder create api \
    --group webapp \
    --version v1 \
    --kind Guestbook

1.  创建webhook

kubebuilder create webhook \
    --group elasticweb \
    --version v1 \
    --kind ElasticWeb \
    --defaulting \
    --programmatic-validation

1.  构建和部署CRD

make install

1.  本地运行controller

make run

1.  构建镜像并推送到仓库

make docker-build docker-push IMG=registry.cn-hangzhou.aliyuncs.com/bolingcavalry/elasticweb:001

1.  controller部署到kubernetes

make deploy IMG=registry.cn-hangzhou.aliyuncs.com/bolingcavalry/elasticweb:001

1.  创建elasticweb资源对象

kubectl apply -f config/samples/elasticweb_v1_elasticweb.yaml

1.  删除elasticweb资源对象

kubectl delete -f config/samples/elasticweb_v1_elasticweb.yaml

1.  删除controller

kustomize build config/default | kubectl delete -f -

1.  删除CRD

make uninstall

1.  查看日志

kubectl logs -f \
    elasticweb-controller-manager-58576f4cb-hzchl \
    -c manager \
    -n elasticweb-system

*  至此，kubebuilder实战期间的知识点小结就完成了，若您正在学习和开发operator，希望本篇的小结能给您一些参考；

### 你不孤单，欣宸原创一路相伴 ###

1.  [Java系列][Java]
2.  [Spring系列][Spring]
3.  [Docker系列][Docker]
4.  [kubernetes系列][kubernetes]
5.  [数据库+中间件系列][Link 1]
6.  [DevOps系列][DevOps]

### 欢迎关注公众号：程序员欣宸 ###

> 微信搜索「程序员欣宸」，我是欣宸，期待与您一同畅游Java世界…

[https_github.com_zq2599_blog_demos]: https://github.com/zq2599/blog_demos
[kubebuilder]: https://xinchen.blog.csdn.net/article/details/113035349
[kubebuilder_kubebuilder]: https://xinchen.blog.csdn.net/article/details/113089414
[kubebuilder 1]: https://xinchen.blog.csdn.net/article/details/113815479
[kubebuilder_operator]: https://xinchen.blog.csdn.net/article/details/113822065
[kubebuilder_operator 1]: https://xinchen.blog.csdn.net/article/details/113836090
[kubebuilder 2]: https://xinchen.blog.csdn.net/article/details/113840999
[kubebuilder_webhook]: https://xinchen.blog.csdn.net/article/details/113922328
[kubebuilder 3]: https://xinchen.blog.csdn.net/article/details/114215218
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70]: /images/20221024/62d86a9951984f8b9120ac9a2c80a86a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70 1]: /images/20221024/b7cd7ff2a53a42c9bb908ee34422d0af.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70 2]: /images/20221024/903fff22fc254f0d80edc1a8f4328eeb.png
[CentOS_Harbor]: https://blog.csdn.net/boling_cavalry/article/details/101100898
[DS218_Harbor_1.10.3]: https://blog.csdn.net/boling_cavalry/article/details/106962214
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70 3]: /images/20221024/a9fdf0c7e96c4cc0af829a9a9412d55b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70 4]: /images/20221024/7a7b8fb7fe6849488d2dfb5c1793c7ea.png
[Java]: https://xinchen.blog.csdn.net/article/details/105068742
[Spring]: https://xinchen.blog.csdn.net/article/details/105086498
[Docker]: https://xinchen.blog.csdn.net/article/details/105086732
[kubernetes]: https://xinchen.blog.csdn.net/article/details/105086794
[Link 1]: https://xinchen.blog.csdn.net/article/details/105086850
[DevOps]: https://xinchen.blog.csdn.net/article/details/105086920