kube-on-kube-operator 开发(二)

本文主要讲述 kubernetes-operator 的开发过程,kubernetes-operator 已经开发了一个多月,其核心功能已经实现,其中的架构以及功能设计主要来自于一些生产环境的经验以及自己从事 kubernetes 运维开发两年多的一些工作经验,如有问题望指正。

kubernetes-operator 组件介绍

kubernetes-operator 中主要包含一个自定义的 controller 和一个 HTTP Server,如下图所示,controller 主要是监听 CRD 的变化以及使其达到终态,HTTP Server 提供了多个 RESTful API,用于操作 CRD(创建、删除、扩缩容、接收回调等)。

除此之外还有其他的组件,ansibleinit、precheck、admission-webhook,ansibleinit 是一个二进制文件用来作为容器内的 1 号进程,会调用 ansible 相关的命令以及处理信号、子进程收割等。precheck 主要用于在对集群操作前检查目标宿主机的环境,由于对集群的操作需要耗费数十秒,为了保证成功率需要在部署前检查宿主的环境。admission-webhook 暂时用于校验 CR 中字段,比如集群执行扩容操作时,master 等字段的值肯定是不能改变的。

kubernetes-operator 的开发

下面主要讲 kubernetes-operator 中核心组件的开发,主要有以下几步:

  • 定义 CRD
  • 生成代码
  • 开发 controller
  • 开发 RESTful API

定义 CRD

下面是 CRD 的定义,kubernetes-operator 中的自定义资源为 KubernetesCluster,项目中简称为 ecs

apiVersion: apiextensions.k8s.io/v1beta1
kind: CustomResourceDefinition
metadata:
  name: kubernetesclusters.ecs.yun.com
spec:
  group: ecs.yun.com
  names:
    kind: KubernetesCluster
    listKind: KubernetesClusterList
    plural: kubernetesclusters
    singular: kubernetescluster
    shortNames:
    - ecs
  scope: Namespaced
  subresources:
    status: {}
  version: v1
  versions:
  - name: v1
    served: true
    storage: true

将 CRD 部署到 kubernetes 集群中,CRD 中的自定义资源KubernetesCluster(CR) 就成为了 kubernetes 中的一种资源,和 pod、deployment 等类似。

生成代码

生成代码可以参考上一篇文章使用 code-generator 为 CustomResources 生成代码,此处不再详解。

开发 controller

如下所示是 controller 最简单的一个声明:

for {
  desired := getDesiredState()
  current := getCurrentState()
  makeChanges(desired, current)
}

所有 controller 也都是以此进行演变的,controller 的代码模式或者套路可以参考sample-controller 或者 kube-controller-manager 中所有 controller 的实现。

下面是 kubernetes-operator 中 controller 实现的一个流程图:

更新 CR 都是客户端的操作,所以在设计时客户端都是操作 annotation 中的字段,然后 operator 监听到相关的时间后会进行处理。例如,当用户要创建一个集群时,首先客户端将 app.kubernetes.io/operation设置为 creating,此时 operator watch 到 CR 变化后会处理新建集群的操作,operator 会创建一个用来部署集群的 job,以及创建 configmap 来保存本次的操作记录以及关联对应的 job,也能用来查询本次操作的日志,然后会更新 CR 中 status.phase 中的 Creating (新创建的 CR status.phase 为 ""),接下来为 CR 设置 finalizers,最后会启动一个 goroutine 检测 job 的状态。此时需要等待 job 的完成以及回调,若 job 失败或者超时都会被最后启动的 goroutine 检测到,job 成功与否都会触发更新 CR status.phase 的操作。若 job 执行完成成功回调,客户端会更新 app.kubernetes.io/operationcreate-finished,客户端更新完成后会触发一次事件,然后 operator 会将 status.phase 更新为 Running 状态,否则 job 异常 operator 会直接更新 status.phase 为 Failed

关于 CR 中 app.kubernetes.io/operation 字段以及 status.phase 中所有的定义请参见 kubernetes-operator/pkg/enum/task.go

开发 RESTful API

在前后端分离的场景中,RESTful API 的开发仅需要一个 route 框架即可,kubernetes-operator 中用的是 mux,具体的代码在 kubernetes-operator/pkg/server 下。

总结

本文主要讲述了 kubernetes-operator 中主要的模块以及 controller 的具体实现,其中许多细节暂未提及到,详细的实现请参考代码,该项目只是笔者利用业余时间进行开发的,毕竟个人精力有限,笔者当前主要集中在 kube-on-kube 的开发上,在阅读文章或者代码的过程中如有问题可以随时留言,笔者会持续迭代版本。下一篇文章会讲述如何使用二进制文件部署 kubernetes 集群。

参考:

https://github.com/kubernetes/community/blob/8decfe4/contributors/devel/controllers.md

https://github.com/kubernetes/sample-controller

https://engineering.bitnami.com/articles/a-deep-dive-into-kubernetes-controllers.html

https://www.cnblogs.com/gaorong/p/8854934.html

https://yucs.github.io/2017/12/21/2017-12-21-operator/

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,843评论 6 502
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,538评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 163,187评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,264评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,289评论 6 390
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,231评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,116评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,945评论 0 275
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,367评论 1 313
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,581评论 2 333
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,754评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,458评论 5 344
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,068评论 3 327
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,692评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,842评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,797评论 2 369
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,654评论 2 354