X as Code 并没有你想象中的那么美好

问题就是期望与现实之间的距离

cat-g6d2ab9c6a_640.jpg

我们团队正在推行 Everything as Code(X as Code),也就是尽量将软件工程中的逻辑放到代码中。比如基础设施、业务代码构建逻辑即CI pipeline、告警规则、业务环境配置、架构图等。没有看错,架构图我们都会被写成代码。

经过半年多实践,X as Code给我们带来了以下好处:

  • 能做到自动化最大化;
  • 可进行code review;
  • 在发布前,就可以进行逻辑验证,比如安全校验;
  • 配置之间可以实现相互引用,极大地扩展了配置管理的想象力;
  • 轻松实现模块化;

当我们实现了X as Code,它是美好的。但是实现过程中,是有不小代价的。

以下是我们在实践X as Code过程中,遇到的问题。

问题1:代码仓库采用单仓带来的问题

软件工程的逻辑代码,包括了整个公司的不同平台,不同系统,不同环境,不同元数据等。如何管理这些代码呢?

我们选择了单仓(monorepo)的方式,也就是将所有的代码放在一个仓库中。

那么,该如何组织单仓库下的目录结构?这是我们需要思考的第一个问题(这个主题需要单独写一篇文章)。

除此之外,单仓会强迫开发人员认真的写git commit message,合理的安排commit记录。因为单仓中不只有一个平台的代码了。你需要认真commit,以方便后面搜索commit记录。

问题2: 提MR时,该找谁review?

在使用GitLab进行代码托管的情况下,commiter提MR后,该找谁进行review呢?这需要我们设计一个机制。

理想状态下,在commiter提MR后,DevOps平台应该能根据MR的内容自动化找到相应的reviewer。这依赖于CODEROWNERS机制。可参考GitLab的 Code Owners

如果没有这样的DevOps平台,就需要commiter自行根据CODEROWNERS指定reviewer。

问题3:构建工具采用Bazel带来的问题

采用单仓后,构建工具就需要换成能很好支持单仓的构建工具。我们选择了Bazel。遇到的问题还不少:

  1. Bazel对Windows支持不够友好,而我们绝大数人都是Windows系统。所以,这些人无法在本地构建代码。这时云端IDE的好处就体现出来了;
  2. Bazel普及率太低了。需要你花时间对团队进行培训;
  3. Bazel rule(理解为一种构建插件)还不够丰富,遇到找不到的rule,就需要自己实现了。比如对Kong的配置的校验,就需要自己实现;

问题4:采用主干开发带来的问题

所有的代码都放在一个仓库中时,分支管理不好就是灾难。越多人同时操作该仓库,问题越多。为此,我们采用基于主干开发的方式。

而这种方式,在行业里并不流行(在国内是这样的,不知道国外如何)。所以,你得培训。

说回来,基于主干开发的方式学习起来比Gitflow容易多了。

问题5:依赖关系管理要求更严格带来的问题

依赖管理更严格指的是:

  1. 每一项依赖都必须指定明确的固定的版本号,不应该像npm那样自动对版本号进行升级;
  2. 强制单一版本,即一个依赖项在整个工程中,它应该只有一个版本。不应该像Maven工程中有N个Fastjson版本;
  3. 需要控制依赖的可见性。在单仓中,测试环境的配置不应该引用生产环境的配置。这需要构建工具的支持。

依赖管理更严格本身是合理的。我们本应该这样。

问题是使用npm的程序员很难理解>=version有害的,绝大数程序员不知道“依赖的可见性控制”是什么鬼。

问题6:配置的定义与配置的使用分离带来的问题

在X as Code之后,配置之间可以很容易的相互引用。我们在设计配置时,会将配置的定义与使用分离。比如配置在代码仓库中定义成JSON的格式(配置定义的地方),但是,最终使用时,我们可以将其转成YAML的格式,然后将该YAML内容更新到ETCD等配置中心(应用程序真正使用配置的地方)中。

配置的定义与配置的使用分离本身是合理的。我们本应该这样。

问题是,习惯性使用Springboot的Profile管理配置的程序员,无法理解为什么要在另一个地方定义配置。

是因为他们在开发过程没有考虑到软件的规模化问题。

问题7:采用单一制品版本号带来的问题

在采用单仓管理X as Code时,整个仓库会打包成多个制品,而不是一个制品,比如测试环境的配置一个制品、生产环境的一个制品。而这些制品,我们都会赋予一个相同制品版本号。

采用单一制品版本号本身是合理的,我们本应该这样。

问题大家无法理解这种方式,为什么A系统的制品和B系统的是同一个版本号?

单一制品版本号降低了我们对制品管理及版本号管理的成本。

问题8:如何保证代码中的敏感信息的安全?

这个问题,我们目前还没有非常好的解决。

小结

全文写下来,其实就是我们在实践X as Code及单仓过程中遇到的问题。很多问题是团队认知上和编码习惯上的问题。毕竟,单仓的实践在整个行业中,还很少,大家很难一下改掉过去的习惯。

如果你要实践X as Code,请做好准备。

我们没有做好团队认知上和编码习惯方面的准备工作,导致推行起来很吃力。

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

推荐阅读更多精彩内容