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

Aggrega Wasm Mutator Socket schema

自动生成的参考文档。请勿手动编辑——请从发布的 JSON Schema 重新生成。

Schema id:https://aggrega.ai/schemas/wasm-mutator-v1beta1.schema.json

挂载在 label-transform 角色上的治理插件所消费(MutatorInput)和输出(MutatorOutput)的传输形态。该角色在构建拓扑时运行,即在图构建完成之后、接受裁决之前:插件返回 JSON Patch 文档,宿主只将它们应用到节点标签上,不应用到其他任何地方;若补丁触及图的任何其他部分,构建会中止。Go、Rust 和 TypeScript 的载荷类型由此 schema 生成到 plugin-ABI 包中,因此三种语言读写同一种传输数据;guest 从这些包中导入它们,或在插件工具包重新导出它们时通过插件工具包导入。

以下形态之一

  • MutatorInput
  • MutatorOutput

定义

MutatorInput

宿主在每次调用时传给 mutator 插件的载荷:release 级别的编译上下文,以及拓扑图的投影,其中携带每个节点的标签及其实例声明的值。

属性类型必需描述
compilation_contextCompilationContext是Release 级元数据,mutator 在决定哪些合规、FinOps 或治理规则适用于本次构建时读取这些元数据。
graphMutatorGraph是向 mutator 插件公开的拓扑图投影:每个节点的 Component、其解析后的版本、其标签以及其实例声明的值。它有意比完整的拓扑结果更窄:边和 feature 载荷不予公开,因为 mutator 的职责是打标签,而不是重塑拓扑。公开这些值是为了供读取,使开发者声明的配置能够决定标签;补丁只触及标签而不触及其他任何内容,因此插件无法更改这些值。
sourcesMutatorSource[]否宿主读取并原样传给插件的定义文件,以按路径排序的有序列表形式提供。宿主将这些字节作为不透明内容读取,不对其进行解析。当挂载未声明任何源文件时不存在。
settingsobject否宿主原样传给插件的自由格式设置对象。宿主不解析其内容,也不据此执行任何操作。当挂载未声明任何设置时不存在。

不允许其他属性。

MutatorOutput

mutator 插件输出的响应形态:由宿主应用到拓扑图上的不透明 JSON Patch 文档列表。补丁在 schema 层保持不透明,因此宿主无需重复实现 guest 已实现的 JSON Patch 解析器。

属性类型必需描述
patchesany[]是按顺序应用到拓扑图上的不透明 JSON Patch 文档。
errorstring否guest 已运行但无法完成操作时设置的失败消息;成功时不存在。宿主将存在的 error 呈现为一次失败的插件调用。

不允许其他属性。

CompilationContext

Release 级元数据,mutator 在决定哪些合规、FinOps 或治理规则适用于本次构建时读取这些元数据。

属性类型必需描述
release_namestring是该 Release 的 metadata.name。
environmentstring是该 Release 运行所在的环境标签(例如 dev、staging、prod)。

不允许其他属性。

MutatorGraph

向 mutator 插件公开的拓扑图投影:每个节点的 Component、其解析后的版本、其标签以及其实例声明的值。它有意比完整的拓扑结果更窄:边和 feature 载荷不予公开,因为 mutator 的职责是打标签,而不是重塑拓扑。公开这些值是为了供读取,使开发者声明的配置能够决定标签;补丁只触及标签而不触及其他任何内容,因此插件无法更改这些值。

属性类型必需描述
nodesmap of MutatorNode是以绝对节点 ID 为键的节点。

不允许其他属性。

MutatorNode

mutator 插件据以评估其规则的逐节点投影:该节点实现了哪个 Component、该 Component 解析到了哪个版本、该节点携带哪些标签,以及其实例声明了哪些值。

属性类型必需描述
componentstring是该节点所实例化的底层 Component 的名称。
resolved_versionstring是解析器为该节点锁定的 Component 的确切语义化版本。
labelsmap of string是该节点的鸭子类型标签和本体标签。
valuesobject否节点的组件实例在 Aggregate 中声明的值,按作者书写的键和作者的顺序排列。Aggregate 中的每个模板都已根据其参数求值,因此提升为参数的值以 Release 提供的值或参数的默认值的形式到达。这里只有该实例自身的值:Component 的 schema 声明的默认值,以及 Recipe 或 Feature 贡献的任何内容,都不在其中。Component 声明为敏感的值以隐去的形式到达,与整个图上的治理裁决接收它的方式完全相同:在其位置上是该裁决携带的同一个单键隐去标记对象,指明所声明的原因;没有任何声明触及的同级值则按原样到达。插件读取这些值来决定添加哪些标签;补丁无法触及它们。实例未声明任何值时不存在。

不允许其他属性。

MutatorSource

传给插件的一个定义文件:其基本名称路径和文件内容。两者均原样传递;宿主不解析内容。

属性类型必需描述
pathstring是源文件的基本名称。宿主只提供基本名称,从不提供宿主上的绝对路径,因此传输内容可移植且具有确定性。
contentstring是源文件的内容,作为不透明字符串原样传递。

不允许其他属性。