MySQL Operator 02 | 脚手架选型 & 工程创建

高日耀 资深数据库内核研发

毕业于华中科技大学,喜欢研究主流数据库架构和源码,并长期从事分布式数据库内核研发。曾参与分布式 MPP 数据库 CirroData 内核开发(东方国信),现主要负责 MySQL 系列产品内核开发(青云科技)。

本文是 MySQL Operator 设计第二篇,上一篇 介绍了 MySQL Operator 架构概览和设计思路。这一期将介绍 Operator 脚手架选型和工程创建过程。

| Operator 脚手架选型

建筑工地在建设房子的时候,最开始都要搭建一个脚手架,便于更快更安全的施工造房子。同样, Operator 工程的构建也要搭建一个脚手架,方便后续快速的开发和迭代,而 Kubernetes 社区有很多成熟的构建脚手架的工具供我们选择。

脚手架构建工具

目前社区活跃度和使用率最高的是 Operator SDKKubebuilder。它们都使用官方的 controller-tools 和 controller-runtime,有相同的布局,不同点在于:

Kubebuilder

  • 包含 envtest 包,允许 Operator 开发人员使用独立的 etcd 和 apiserver 运行简单的测试
  • 自动生成 Makefile 以帮助用户执行 Operator 任务(构建、测试、运行、代码生成等)
  • 使用 kustomize 构建部署清单
  • 改进了对准入和 CRD 转换 WebHooks 的支持

Operator SDK

  • 更好的支持 Ansible 和 Helm operator 这类上层操作
  • 与 Operator LifecycleManager(OLM) 的集成,OLM 是 Operator Framework 的一个关键组件,对于第 2 天集群操作非常重要,比如管理 Operator 实时升级
  • 包含记分卡子命令,它可以帮助您理解 Operator 是否遵循最佳实践
  • 包括 e2e 测试框架,它简化了对实际集群测试操作的过程

目前两个社区逐渐在融合,Operator SDK 也在不断向 Kubebuilder 靠拢,因此我们选择更原生、更嫡系的 Kubebuilder (目前到了 3.0 版本) 作为 Operator 工程的脚手架。

| 创建工程

初始化 Operator 和 Controller API

Kubebuilder 为 Operator 代码库中涉及的各种组件(如 CRD 和 Controller-API)的代码生成提供了快速教程和简单的脚手架,其架构如下所示:

file

创建步骤

按以下两个步骤创建工程:

1.初始化 Operator 工程

初始化域名设置为 radondb.com,将自动生成了镜像制作脚本,Makefile,配置文件以及 main.go 。指令如下:

kubebuilder init --domain=radondb.com

2.创建 Controller

API、GVK(group, version, kind) 分别指定为 mysql, v1alpha1, MysqlCluster。

controller 参数设置为 true 意思是自动生成控制器初始的代码文件。指令如下:

kubebuilder create api --group mysql --version v1alpha1 --kind MysqlCluster --resource=true --controller=true

通过两条指令生成的文件目录对比,执行第二条指令后,多了 api 目录,crd 目录以及 controllers 目录。

file

Project Layout 概览

以下为 radondb-mysql-kubernetes 项目的当前目录结构及功能介绍。

file

| 总结

Operator 基于 Kubernetes 的资源和控制器概念之上构建,同时又包含了应用程序特定的领域知识。创建 Operator 的关键是 CRD(自定义资源)的设计。下一篇我们将解析 radondb-mysql-kubernetes 项目中自定义 CRD 的设计。

相关阅读

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

推荐阅读更多精彩内容

  • ![Flask](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAW...
    极客学院Wiki阅读 7,240评论 0 3
  • 不知不觉易趣客已经在路上走了快一年了,感觉也该让更多朋友认识知道易趣客,所以就谢了这篇简介,已做创业记事。 易趣客...
    Physher阅读 3,411评论 1 2
  • 双胎妊娠有家族遗传倾向,随母系遗传。有研究表明,如果孕妇本人是双胎之一,她生双胎的机率为1/58;若孕妇的父亲或母...
    邺水芙蓉hibiscus阅读 3,697评论 0 2
  • 晴天,拥抱阳光,拥抱你。雨天,想念雨滴,想念你。 我可以喜欢你吗可以啊 我还可以喜欢你吗可以,可是你要知道我们不可...
    露薇霜凝阅读 1,213评论 1 2