如果您使用过 helm 图表,您可能熟悉验证 value.yaml 的挑战。虽然 helm 的内置 json 模式验证有效,但它可能很麻烦且具有限制性。今天,我想向您介绍 helm cel,这是一个插件,它将 google 通用表达语言 (cel) 的强大功能引入 helm 图表验证中。
什么是 cel?
在深入探讨之前,让我们快速了解一下 cel 是什么。通用表达式语言 (cel) 是 google 创建的一种简单表达式语言,可让您编写简洁、强大的验证规则。它用于 kubernetes crd 验证、istio 配置以及云原生生态系统中的许多其他项目。
为什么使用 cel 而不是 json 模式?
- 更具表现力:cel 允许您以更自然和可读的方式编写复杂的验证规则
- 熟悉的语法:如果您来自 python 或 JavaScript 等编程语言,cel 的语法会感觉很自然
- 类型安全:cel 提供强大的类型检查,同时保持灵活性
- 专为云原生而构建:cel 已在整个 kubernetes 生态系统中使用
入门
首先,安装插件:
您将在图表目录中创建一个values.cel.yaml 文件,而不是创建values.schema.json。这是一个简单的例子:
rules: - expr: "has(values.service) && has(values.service.port)" desc: "service port is required" - expr: "values.service.port >= 1 && values.service.port <= 65535" desc: "service port must be between 1 and 65535" - expr: "!(has(values.replicacount)) || values.replicacount >= 1" desc: "if replicacount is set, it must be at least 1"
验证您的图表:
helm cel ./mychart
现实世界的例子
让我们看看一些常见的验证模式以及它们如何在 json schema 和 cel 中表达。
1. 必填字段
json 架构:
{ "required": ["service"], "properties": { "service": { "required": ["port"], "properties": { "port": { "type": "integer" } } } } }
cel:
rules: - expr: "has(values.service) && has(values.service.port)" desc: "service port is required"
2. 条件要求
json 架构:
{ "if": { "properties": { "persistence": { "const": true } } }, "then": { "required": ["storageclass"] } }
cel:
rules: - expr: "!has(values.persistence) || !values.persistence || has(values.storageclass)" desc: "storageclass is required when persistence is enabled"
3. 复杂的验证
对于复杂的验证,json 模式可能会变得非常冗长。这是一个 cel 示例,在 json 模式中会复杂得多:
rules: - expr: | !has(values.resources) || (!has(values.resources.limits) && !has(values.resources.requests)) || (has(values.resources.limits.memory) && has(values.resources.requests.memory) && int(values.resources.requests.memory) <= int(values.resources.limits.memory)) desc: "if resources are specified, memory request must not exceed memory limit"
有意义的错误消息
helm cel 的最佳功能之一是其清晰的错误消息。当验证失败时,您会得到如下有用的输出:
❌ Validation failed: replica count must be at least 1 Rule: values.replicaCount >= 1 Path: replicaCount Current value: 0
性能考虑因素
cel 表达式可以高效地编译和计算。该插件为您的 helm 工作流程增加了最小的开销,使其适合开发和 ci/cd 管道。
下一步
结论
helm cel 带来了一种更具表现力和可维护性的方式来验证您的 helm 图表。如果您发现自己在与 json schema 作斗争或想要更灵活的验证规则,请尝试一下。熟悉的语法、强大的表达式和清晰的错误消息的组合使其成为任何 helm 用户工具包的宝贵补充。
您希望看到什么验证模式?请在下面的评论中告诉我!