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

Aggrega Wasm 策略插槽 schema

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

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

挂载在裁决角色上的治理插件所消费(在 ir-verdict 角色上为 PolicyInput,在 render-verdict 角色上为 RenderPolicyInput)和输出(PolicyOutput)的传输形态。halt 严重级别的裁决会以构建时诊断信息中止构建;warn 或 info 裁决会被报告,构建继续进行。IR 阶段的输入图是完整的、与能力无关的 IR 图,引用自 ir-v1beta1.schema.json,而不是在此重新声明,因此策略插件看到的节点、边和挂载细节与编译器看到的相同;插件作者需跟踪 IR schema 的版本。渲染阶段的输入携带渲染后的输出文件,而不是图。Go、Rust 和 TypeScript 的载荷类型由此 schema 生成到 plugin-ABI 包中,因此三种语言读写同一种传输数据;guest 从这些包中导入它们,或在插件工具包重新导出它们时通过插件工具包导入。

以下形态之一

  • PolicyInput
  • RenderPolicyInput
  • PolicyOutput

定义

PolicyInput

静态分析传给策略插槽的载荷:完整的 IR 图(与 Topology Builder 输出的形态相同),以及分析器同时枚举出的预计算路由路径。

属性类型必需描述
graphIRGraph是完整的、与能力无关的 IR 图,唯一来源为 ir-v1beta1.schema.json。策略插件基于完整的节点/边/挂载细节进行推理,而不是基于一个狭窄的投影。
precalculated_pathsPrecalculatedPath[]是分析器预先枚举的路由路径,使策略无需重新遍历图即可推理可达性。
sourcesPolicySource[]否宿主在编译时读取并原样传给插件的定义文件,形式为按路径排序的有序列表。宿主将这些字节作为不透明内容读取,不对其进行解析。当挂载未声明任何源时不存在。
settingsobject否宿主原样传给插件的自由格式设置对象。宿主不解析其内容,也不据此执行任何操作。当挂载未声明任何设置时不存在。

不允许其他属性。

PolicyOutput

策略插件输出的响应形态:评估期间触发的裁决,每个触发的裁决对应一条诊断信息。允许型规则不输出任何内容,因此空的 results 数组表示没有裁决被触发。

属性类型必需描述
resultsDiagnostic[]是触发的裁决,每个对应一条诊断信息,按插件输出的顺序排列。没有裁决触发时为空。
errorstring否当 guest 已运行但无法完成操作时设置的失败消息;成功时不存在。它与输出携带的任何诊断信息不同:诊断信息报告的是仍产生了结果的运行中发现的问题,而 error 报告的是操作本身未能完成。宿主将存在的 error 呈现为一次失败的插件调用。

不允许其他属性。

RenderPolicyInput

挂载在 render-verdict 角色上的治理插件接收的载荷:策略据以推理的渲染后输出文件,取代 IR 图。

属性类型必需描述
artifactsRenderedArtifact[]是策略据以推理的渲染后输出文件,形式为按路径排序的有序列表,从而使相同输入的多次运行之间传输内容逐字节一致。
sourcesPolicySource[]否宿主在编译时读取并原样传给插件的定义文件,形式为按路径排序的有序列表。宿主将这些字节作为不透明内容读取,不对其进行解析。当挂载未声明任何源时不存在。
settingsobject否宿主原样传给插件的自由格式设置对象。宿主不解析其内容,也不据此执行任何操作。当挂载未声明任何设置时不存在。

不允许其他属性。

RenderedArtifact

一个渲染后的输出文件:其路径以及该路径上的渲染内容。

属性类型必需描述
pathstring是渲染后文件的输出路径,相对于渲染根目录。
contentstring是该路径上的渲染内容。
treeany否该制品解析后的结构化树,当宿主在将内容传给插件之前对其进行了解析时存在——即插件无法原生读取的源格式的规范 JSON 视图(例如解析为 JSON 的 HCL 制品)。顶层可以是对象、数组或标量,与解析后文档自身的形态一致。当宿主未解析该制品时不存在,此时插件直接读取原生内容。宿主以不透明方式传递该树,原样携带而不解释其内容。
formatstring否制品渲染所用的格式,当生成它的 provider 声明了格式时存在。当生成它的 provider 未声明格式时不存在。

不允许其他属性。

PolicySource

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

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

不允许其他属性。

PrecalculatedPath

分析器实体化的一条预先枚举的路由路径,使策略规则无需重新遍历图即可推理可达性。

属性类型必需描述
path_idstring是该路径的稳定标识符;在相同输入的多次运行之间具有确定性。
nodesstring[]是该路径经过的节点 ID 的有序序列,从源到终点。
attached_featuresstring[]是路径上任一节点所挂载的 Feature 类型 URI 的并集,按字母顺序排序。采用集合成员语义:即使多个节点携带同一个 Feature,它也只出现一次。当路径上没有节点携带任何 Feature 挂载时为空。

不允许其他属性。