模块边界路由——将整个子模块放入边界
本示例从一个由 Developer 编写的 Aggregate 编译出两项能力——一个基于
对象存储的 Thanos 指标读取层,以及一个使用 MongoDB 线路协议的文档数据库——
并由 Release 将每项能力分别放入各自的
边界。
两项能力都是模块:可复用的子 aggregate,每个都组合了
多个单 workload 组件,并连接其自身的内部边。该
Aggregate 只给出两个模块的名称,不涉及它们在何处运行。该 Release
通过每个边界一条 aggregates: 条目放置整个模块——运维人员
决定能力在何处运行,而无需跟踪或重述其内部
内容。
文件
| 文件 | 角色 |
|---|---|
aggregate.yaml | 开发者意图:导入指标模块(core/thanos)和文档数据库模块(core/ferretdb)。 |
manifest.yaml | 将两个模块贡献的每个组件类型映射到其 synth helm Recipe,将指标模块附加的凭据 Feature 映射到从模块两个密钥参数各生成一个 Secret 的实现,并将 scrape Feature 映射到其 FeatureRecipe。 |
release.yaml | 运维记录:将每个模块路由到各自的边界,为其中一个模块的一个组件设定规格,并为其附加 scrape Feature。 |
演示内容
- 将整个模块路由到边界。 边界的
aggregates:条目 以模块在 Aggregate 中的名称为键。它放置该模块包含的 每个组件,因此全部三个指标组件生成的产物都输出到observability边界下,两个文档数据库组件则输出到data下。 - 完全不指名任何组件是主要形式。
data边界 仅用一个空的documents: {}路由文档数据库模块。其中 每个组件都会被放置,并采用各自的 schema 默认值;该 Release 只需要 模块的名称,无需了解其他任何内容。 - 通过本地名称配置被路由的组件。 路由条目也可以
配置其所路由模块中的单个组件,按每个组件在该模块内的
本地名称寻址——是
query而不是metrics.query, 因为在模块内部这是它唯一的名称。指名一个组件 不影响其他组件:这里为query设定了规格并指定了 scrape 目标, 而对象存储和 store gateway 则以默认值被路由进来。 - 被路由的组件就是该边界的组件。 它与其他组件一样继承
边界的注解级联,正因如此,被路由模块的每个资源都会获得
边界的
aggrega.ai/namespace值—— 包括路由条目从未提及的组件。 - 路由是放置,而不是另一种成员关系。 一个 未作任何说明而被路由进来的组件,其渲染结果与在该边界中 直接指名且主体为空的同一组件相同。这两种写法是 表达组件归属的两种方式,而非两种行为。
生成示例
你可以用下面的命令构建这个示例,也可以让你的 AI 助手替你构建。
将示例写入一个以其命名的新文件夹:
aggrega scaffold --example module-boundary-routing然后它会打印接下来要运行的命令。第一条命令进入新文件夹:
cd module-boundary-routing构建
此工作区不带 .aggrega-config.yaml,因此标准库实体从 hub 注册表 hub.aggrega.ai 解析,无需目录标志;--auto-pull 会在构建期间写入新克隆所缺少的锁文件:
aggrega build --release release.yaml --auto-pull渲染产物输出到 dist/ 下。Kubernetes 目标离线渲染普通
manifest——无需拉取 chart。
借助 AI 助手
已配置 Aggrega 工具的 AI 助手也能完成同样的操作:把下面这条提示粘贴给它。
只使用 Aggrega 工具,不要自己创建任何文件夹。如果工作区文件夹中还没有 `module-boundary-routing` 文件夹,调用一次 `scaffold` 工具,将 `example` 设为 `module-boundary-routing`,不设 `dir`:它会把示例写入一个新的 `module-boundary-routing` 文件夹。然后调用 `build` 工具,将 `workspace_root` 设为 `module-boundary-routing`、`release` 设为 `release.yaml`、`auto_pull` 设为 true、`write` 设为 true。告诉我构建写入了哪些文件;它们位于 `module-boundary-routing/dist/` 下。放置后的堆栈是什么样子
每个边界的 directory 是放置在其中所有内容的产物根目录,因此
两个模块的组件在磁盘上按路由它们的边界分开:
dist/observability/helm/ metrics-zdobjstore, metrics-zdstore, metrics-zdquerydist/data/helm/ documents-zdproxy, documents-zdbackend文件名包含每个组件的标识,其中模块分隔符以展开形式
写出,因为点号并不是每种资源名称都能包含的字符——Aggregate 中的 metrics.store
在集群中是 metrics-zdstore。组合模块是
唯一会在标识中引入分隔符的操作,因此你直接指名的组件
在两处的写法相同。
每个资源都带有路由边界的命名空间,并记录是哪个 边界放置了它。store gateway 从未在路由条目中被指名, 但仍继承了这两者:
metadata: name: metrics-zdstore namespace: observability [… omitted: the labels every rendered document carries] annotations: aggrega.ai/boundary-path: observability [… omitted: the annotation naming the Recipe that rendered it]指标模块的凭据 Feature 为对象存储的密钥对以及 store gateway 向其出示的密钥对生成的四个 Secret 同样如此:每个都输出到 observability 下,带有该命名空间,并与读取它的 workload 放在一起。
附加到被路由 query 组件上的 scrape Feature 在同一边界下
渲染出自己的产物,其中包含运维人员的 scrape 设置:
apiVersion: monitoring.coreos.com/v1kind: ServiceMonitormetadata: name: metrics-zdquery-scrape [… omitted: the namespace, labels and annotations every rendered document carries]spec: selector: matchLabels: app.kubernetes.io/name: metrics-zdquery endpoints: - port: http interval: 30s path: /metrics