跳转到内容
AggregaAggrega
选择语言: 简体中文
本页面由机器翻译。阅读英文原文。

按角色划分的实体

每种实体类型都有一个通常负责编写它的角色。本页是完整的对照图——当你清楚自己关注的问题、但还不确定它属于哪个文件时,可以查阅本页。角色分配是指导性的,而非由编译器强制执行(参见 角色画像);它说明在结构良好的设置中,通常由谁负责某种类型。

对照图一览

角色实体类型关注点
开发者Aggregate应用意图:应用是什么、需要什么
平台架构师Component、Feature可复用、带版本的目录契约
平台运维Recipe、FeatureRecipe、用于 provider 渲染的 PluginProvider 特定的转换,生成渲染后的基础设施
平台操作员Manifest、Release路由与部署连接
跨角色支持SchemaLibrary、MappingLibrary、WorkloadLibrary、ArtifactLibrary、Plugin、Workload共享结构、扩展代码,以及由平台拥有的编译器类型

开发者

Aggregate——开发者唯一的编写界面,也是应用拓扑的唯一事实来源。它声明应用由哪些组件构成、每个组件接受的 values、其行为属于应用意图的 Features(及其 values)、为按环境变化而暴露的 parameters,以及将组件连接在一起的 uses 边。它刻意与物理基础设施无关:Aggregate 中没有任何内容指定云、集群或 provider。正是这种与能力无关的特性,让一个 Aggregate 可以部署到任何地方。

平台架构师

Component——针对一类构建块的可复用、带版本的契约。它通过 JSON Schema 声明开发者可以提供的 values、传递给使用方的 provides 输出,以及为连接而暴露的 usesSchema 插槽。Components 携带驱动策略和渲染的语义标签。架构师保持 Component 契约的稳定,以便开发者可以依赖它。

Feature——开发者或操作员可以添加到组件上的可附加能力:指标导出器、AI 网关上的敏感文本掩码、凭据绑定。Feature 声明它需要什么以及与什么不兼容;它如何实现——生成的资源,或写入其组件已渲染内容中的设置——则位于其 FeatureRecipe 中。

平台运维

Recipe——Component 针对特定 provider 的实现。它通过模板将 Component 声明的值映射到具体 provider 的输出——Helm release、Compose 服务、Terraform 模块——并将 provides 值传递给使用方。Recipe 从不更改 Component 声明的面向开发者的值;它只决定这些值如何渲染。

FeatureRecipe——Feature 针对特定 provider 的实现,在绑定时应用。它为给定 provider 生成 Feature 附加所隐含的资源,或将其隐含的设置写入所附加组件已渲染的内容中。

Provider 渲染 Plugin — provider 是将 Recipe 的输入转换为 provider 原生清单的 Wasm 客体。它以带有 pluginType: provider 的 Plugin 形式交付,该 Plugin 声明它所渲染的 provider 名称及其 provider 插槽契约。运维团队(或插件作者)提供 provider,使 Recipes 有可用于渲染的 provider。已随附的 provider 及其契约,参见 Providers 概览。

在 Recipe 中安全地读取凭据

凭据经由 inject 管道 .context.inject.env 到达 Recipe,其内容是作者所选的任意文本,因此可能包含模板无法原样写入 YAML 的字符。在双引号标量中,双引号会提前结束该值,反斜杠会开始一个转义:构建会停止,或者反斜杠会被悄无声息地丢失。请在写入该值的位置对这两者进行转义:

variables:
{{- $env := optional (default dict .context.inject) "env" dict }}
DB_PASSWORD: "{{ optional $env "DB_PASSWORD" "" | replace "\\" "\\\\" | replace "\"" "\\\"" }}"

optional 从管道的映射中读取该键,并以空值作为回退,因此未被交付的密码会渲染为空文本。两个 replace 调用先转义反斜杠,再转义引号,按此顺序是为了不让引号自身的转义被再次转义,其他字符则保持原样。通过 index 读取的值(键不存在时会停止)也原样适用这两个 replace 调用。

这种形式无法承载的一个字符是换行符。YAML 会把双引号标量中的换行折叠为空格,因此包含换行的凭据在交付时,换行处会变成空格。将凭据写入其 injectMapping 的 FeatureRecipe 则改为通过 toJson 写入,它同样能承载引号、反斜杠和换行符,如 FeatureRecipe 参考所示。

该 FeatureRecipe 会在 Recipe 读取凭据所用的机制下写入凭据——对应 .context.inject.env 的 env:、file:、arg:,或组件自有的、以其自身名称命名的机制。.context.inject.all 由这些机制构建,从不来自映射的输出,因此写在 all: 下的映射将不会交付任何内容;构建会因此停止,并给出该附加项、该键和该 FeatureRecipe。

平台操作员

Manifest——路由层。它告诉编译器对于给定目标由哪个 Recipe 实现每个 Component,从而使同一个 Aggregate 可以在不同环境中指向不同实现——生产环境用云 Recipe,本地测试用 Compose Recipe——而无需修改开发者的文件。

Release——唯一的编译输入,记录一个环境构建的内容。它指向 Aggregate 和 Manifest,填充开发者暴露的 parameters,附加其输入属于运维层面的 Features,用 infra 为开发者附加的 Features 设定规模,并在架构师声明的插槽范围内连接自己的边。Release 填充已暴露的变化点;它不能引入新的应用 values 或新的计算资源——这些只能来自 Aggregate。

跨角色支持类型

这些类型服务于各个角色的作者,而不归属于某一个角色。

SchemaLibrary——在许多 Components 和 Features 中重复出现的 schema 结构的共享库。当相同的结构(例如 pod 资源块)出现在许多实体中时,架构师会将其提取为一个 SchemaLibrary 条目,使其只需定义和更新一次。

MappingLibrary——供 Recipes 和 FeatureRecipes 使用的可复用映射逻辑共享库,使常见转换模式只有单一来源,而不是被复制。

WorkloadLibrary——可复用 Workload 内容的共享库,使在许多 Recipes 中重复出现的部署结构只需声明一次,并导入到每个 workload: 块中。

ArtifactLibrary——可复用制品包的共享库:属于同一组的具名辅助输出文件集合,例如 CRD 及其 RBAC。Recipe 或 FeatureRecipe 在一个 artifacts: 条目中导入一个包,并输出其中的每个文件。

Plugin——扩展类型。除 provider 渲染外,Plugins 还打包提供领域特定智能的 WebAssembly 代码——策略验证、变更、lint 检查及其他插槽。Plugin 编写是平台团队的关注点,为其他所有角色提供支持。

Workload——由平台拥有的编译器类型,而不是开发者或操作员作为顶层实体手写的文件。它在 Recipe 的 workload: 块中使用,Recipe 渲染所用的 provider 在其中将规范化的 workload 结构转换为其原生形式。Recipe 作者通过该块与其交互;Workload 参考 记录了该结构。

下一步