external-secrets — Kubernetes 密钥同步 operator
本示例将一个小型的真实技术栈(即 external-secrets operator)
从一个由 Developer 编写的 Aggregate 编译到 Kubernetes,底层使用官方
external-secrets Helm chart。
external-secrets 将外部密钥管理系统(HashiCorp Vault、AWS Secrets Manager、Google Secret Manager、Azure Key
Vault 等)中的密钥材料同步到原生 Kubernetes Secrets 中,并在
源发生变化时保持同步。它是一个集群范围的控制器,通过自己的自定义资源扩展集群 API,
而不是供应用路由访问的服务器,因此它
不接受 uses 边,它发布的唯一内容是 Prometheus 服务器获取
其指标的位置:应用通过声明 ExternalSecret 和
SecretStore 资源来获取密钥,operator 则生成相应的
Kubernetes Secret。
文件
| 文件 | 角色 |
|---|---|
aggregate.yaml | Developer 意图:单个 external-secrets 组件(core/security/external-secrets),随该 release 一起安装自定义资源定义。 |
manifest.yaml | 将组件类型映射到官方来源的 Recipe(external-secrets)。 |
release.yaml | 面向 Kubernetes 目标的 Operator 记录:operator 的计算资源规格。 |
演示内容
- 单一编写入口。 单个 Aggregate 是 operator 是什么的唯一事实来源; Manifest 则说明如何实现它。
- 开发者的值传递到渲染结果。 开发者的
install_crds值被写入 chart 的installCRDs值,从而随 release 将 external-secrets 自定义资源定义带入集群。 - 扩展集群的控制器,无拓扑边。 external-secrets 向集群 API
添加自己的自定义资源;使用方通过声明这些资源来请求密钥,因此该组件不连接
uses边, 除指标位置外不导出任何内容。 - 单一一致的 operator。 chart 将控制器、webhook 和证书控制器渲染为一个 operator;捆绑的 provider 子 chart 处于关闭状态,因此不会引入外部数据存储、缓存或消息代理。对相同输入的多次运行, 渲染输出逐字节相同。
- 可复现的镜像。 该 Recipe 将全部三个容器镜像固定到一个可解析的 release 标签(
ghcr.io/external-secrets/external-secrets:v2.7.0),因此渲染出的工作负载引用的是固定的版本。
生成示例
你可以用下面的命令构建这个示例,也可以让你的 AI 助手替你构建。
将示例写入一个以其命名的新文件夹:
aggrega scaffold --example external-secrets-operator然后它会打印接下来要运行的命令。第一条命令进入新文件夹:
cd external-secrets-operator构建
此工作区不带 .aggrega-config.yaml,因此标准库实体从 hub 注册表 hub.aggrega.ai 解析,无需目录标志:
aggrega pull --release release.yamlaggrega build --release release.yaml渲染产物位于 dist/ 下。构建在执行 aggrega pull 时通过 OCI 引用解析上游 chart,并将其固定在锁文件中。
借助 AI 助手
已配置 Aggrega 工具的 AI 助手也能完成同样的操作:把下面这条提示粘贴给它。
只使用 Aggrega 工具,不要自行创建任何文件夹。如果工作区文件夹中还没有 `external-secrets-operator` 文件夹,调用一次 `scaffold` 工具,将 `example` 设为 `external-secrets-operator`,且不设置 `dir`:它会把示例写入新的 `external-secrets-operator` 文件夹。然后调用 `build` 工具,将 `workspace_root` 设为 `external-secrets-operator`,`release` 设为 `release.yaml`,`auto_pull` 设为 true,`write` 设为 true。告诉我这次构建写入了哪些文件;它们位于 `external-secrets-operator/dist/` 下。渲染结果
构建将 external-secrets operator 输出为一组 Kubernetes 对象:
- 24 个用于 external-secrets API 的
CustomResourceDefinition(ExternalSecret、SecretStore、ClusterSecretStore以及相关的推送和生成器 资源), - 三个
Deployment:控制器、webhook 和证书 控制器, - 绑定它们的 RBAC:多个
ClusterRole、多个ClusterRoleBinding、一个Role和 一个RoleBinding, - 三个
ServiceAccount,每个工作负载一个, - 一个用于 webhook 的
Service, - 两个
ValidatingWebhookConfiguration, - 一个占位
Secret,由证书控制器在运行时填入 webhook 的 服务证书。
全部三个容器镜像都固定到其 release 标签,因此工作负载引用的是固定的镜像。