本页面由机器翻译。阅读英文原文。
Aggrega 路径模板上下文 schema
自动生成的参考文档。请勿手动编辑——请从发布的 JSON Schema 重新生成。
Schema id:https://aggrega.ai/schemas/path-template-context-v1beta1.schema.json
在 Aggrega 构建 Release 时,针对 Release.spec.boundaries[].directory 和 Release.spec.boundaries[].subDirectory(以及按组件的 subDirectory 覆盖)求值的 Go 模板所使用的变量允许列表。路径模板使用 missingkey=error(不同于值模板全局采用的 missingkey=zero 机制),并加上解析时校验:路径模板中的每个字段引用都必须出现在相应上下文(directory: 或 subDirectory:)的允许列表中;未知字段会在解析时产生 Loud Guardrail 错误,绝不会在渲染时才产生。语言参考中的“路径模板变量”页面讲解了它与值模板的区别。
顶层类型: object
属性
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
capability | string | 否 | 可用于 directory: 和 subDirectory:。提供该组件的 Recipe 在 spec.capability 中声明的渲染能力,去除任何版本固定——例如 ‘helm’、‘helm-chart’ 或 ‘compose’。subDirectory: 默认为 {{ .capability }},正是它使每种能力的产物落入边界 directory 下各自的子文件夹。在 directory: 模板中,该值按组件解析,因此其子树提供多于一种能力的边界会求值为每种能力一个目录;发布 .parent_boundary.directory 的独立的按边界遍历在绑定任何组件之前运行,此时该值为空。 |
boundary_name | string | 否 | 可用于 directory: 和 subDirectory:。release.spec.boundaries. |
parameters | object | 否 | 可用于 directory: 和 subDirectory:。来自 Release 的类型化参数映射。路径模板可访问 .parameters,这是对 parameters 单次处理生命周期的有意例外——值模板不会获得 .parameters;与环境相关的值通过已完成插值的 Aggregate YAML 流入值模板。 |
component_id | string | 否 | 仅在 subDirectory: 中可用。正在放置的贡献者的标识。对于组件,是其扁平化的按组件实例 ID(例如 ‘backend’ 或 ‘data-layer.main-db’)。对于附加在边界上、其 FeatureRecipe 针对该边界只运行一次(executionScope: boundary)的 Feature,是该附件发出的每个资源在其 aggrega.ai/component-id 标签中携带的组合组件标识(例如,边界 ‘app’ 上的附件 ‘shared’ 为 ‘bfr—app—shared’),在附件的渲染插件限制名称时会被缩短,从而使其命名的目录与该标签一致。在边界级别没有意义,并会在 directory: 模板中被解析时校验拒绝。 |
parent_boundary | object | 否 | 在 directory: 和 subDirectory: 中均可用。父边界已解析的值。通过深度优先遍历填充:遍历时使用父边界已解析的值来求值每个边界的模板;子边界在此处永远看不到自己的值。顶层边界没有父边界,因此在顶层边界中读取 parent_boundary 下的键会使构建中止,并指明该边界、模板字段和缺失的键。 |
manifest | object | 否 | 可用于 directory: 和 subDirectory:。携带按组件求值的已解析 Recipe 元数据。 |
不允许其他属性。
path-template-context.parent_boundary
在 directory: 和 subDirectory: 中均可用。父边界已解析的值。通过深度优先遍历填充:遍历时使用父边界已解析的值来求值每个边界的模板;子边界在此处永远看不到自己的值。顶层边界没有父边界,因此在顶层边界中读取 parent_boundary 下的键会使构建中止,并指明该边界、模板字段和缺失的键。
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
directory | string | 否 | 父边界求值后的 directory 字符串。 |
boundary_name | string | 否 | 父边界的名称(release.spec.boundaries 中的映射键)。 |
parameters | object | 否 | 该 Release 的参数映射——与 .parameters 所携带的映射相同。 |
annotations | map of string | 否 | 级联解析完成后父边界的注解。 |
不允许其他属性。
path-template-context.manifest
可用于 directory: 和 subDirectory:。携带按组件求值的已解析 Recipe 元数据。
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
recipe_name | string | 否 | 通过按组件查找得到的已解析 Recipe 的名称。 |
不允许其他属性。