知识卡片

普通读书笔记卡 · 5230.a.3.a.2

Jsonnet模板消除重复

理解等级:中级

生成目标格式:Jsonnet 原生输出 JSON,对 JSON/YAML/HCL 等消费者足够;其他格式需先在配置语言中表示数据(映射、列表、字符串到处通用),再写或复用序列化函数(Jsonnet 标准库能输出 INI、XML);Bash 脚本这类难以表示的,最后才用字符串模板。

驱动多个应用:一旦能生成各种格式,就能在一处统一、同步并去重——例如只定义一次端口,同时输出 Nginx 配置和 Terraform 防火墙配置;同一个文件配置监控仪表板、保留策略和告警通知管道;在 VM 启动脚本和磁盘镜像构建脚本之间挪动初始化命令来权衡性能。配置还能嵌套(Cassandra 配置嵌入 Deployment Manager 或 ConfigMap),好的语言能处理恼人的字符串转义。Jsonnet 支持输出“文件名 → 内容”的对象,一次生成多个文件。

Kubernetes 案例:K8s 每个配置项是一个 JSON 对象,磁盘上通常写成 YAML 流再用 kubectl 提交。YAML 抽象能力不足(只有锚点,K8s 不支持)。要复制四个只有命名空间、标签等小差异的 Service,遵循不可变基础设施就得存四份——重要差异被掩盖。Jsonnet 写法: - 在 templates.libsonnet 里定义抽象模板 MyTemplate,local service = self 让嵌套对象能引用外层; - tier:: error 'Needs tier'——双冒号是隐藏字段(不输出,否则 K8s 会拒绝未知字段),仍可被覆盖和引用;不覆盖就触发错误,相当于纯虚/抽象方法; - 各实例 templates.MyTemplate { tier: 'backend', metadata+: { namespace: 'prod' } },+: 做合并覆盖;命名空间默认 default。 乍看更冗长,但实例越多越省事。模板与函数的区别:函数只能参数化,模板能覆盖父对象的任何字段——这就是第14章说的“逃离简单”的逃生舱(例如单独改 sessionAffinity: 'ClientIP')。

迁移流程:把一个 YAML 变体转为 JSON → 用 Jsonnet 格式化器整理 → 手工加抽象和实例化。差异越微妙(字符串略不同、数组多元素、对所有元素的同一修改),配置语言越有价值。抽象共性带来与编程模块化相同的好处:跨环境(prod/stage/dev/test)、架构、地区管理几乎相同的配置;基础设施团队维护可复用组件(API 框架、缓存、MapReduce)的模板,应用团队实例化后补充细节。注意 YAML 可写出 JSON 无法表达的内容(NaN、非字符串键),但 K8s 也不允许这些。

译文提示:本书为社区机器辅助译本,本卡按上下文和官方英文版理解,引文保留中文原样。

这张卡片看不懂?

已有反馈 · 0 / 10 条

    还没有人提交反馈。

    在整书笔记中的位置

    原书出处 · 1 处

    参考来源

    - 位置:《谷歌站点可靠性工作手册》第15章《第15章 配置细节》15 集成配置语言;以特定格式生成配置;驱动多个应用程序;集成现有应用程序:Kubernetes(源文件:extracted/谷歌站点可靠性工作手册/_epub-src/OEBPS/Text/21.html,来源项目 book-sources) - 结论依据:第15章说明配置语言如何输出目标格式并从一处驱动多个应用,以Kubernetes为例用Jsonnet抽象模板、隐藏字段与error实现抽象方法、+:合并覆盖来消除四份YAML的重复,比较模板与函数的抽象能力,并给出从YAML迁移的流程与团队间复用模板的用法。 - 原始内容:该模板本身不能使用,因为引用service.tier会触发错误构造,从而使用给定的文本引发运行时错误。