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

Aggrega Wasm FeatureRecipe 流水线步骤插槽 schema

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

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

feature-recipe 流水线步骤插件插槽所消费(FRPStepInput)和输出(FRPStepOutput)的线上数据形态。FRP 步骤针对 Recipe 或 FeatureRecipe 中声明的每个内联流水线条目运行一次:宿主将带键的文档集整体交给该步骤,步骤按内容选出其目标文档,并返回按键寻址的 RFC 6902 补丁,以及副作用和诊断信息。这是一份有别于 label-transform 角色的独立 guest 契约;该角色对整个拓扑图只运行一次,并返回不透明的标签补丁。Go、Rust 和 TypeScript 的载荷类型由此 schema 生成到 plugin-ABI 包中,因此三种语言读写同一种线上数据;guest 从这些包中导入它们,或在插件工具包重新导出它们时通过插件工具包导入。

以下形态之一

  • FRPStepInput
  • FRPStepOutput

定义

FRPStepInput

feature-recipe-pipeline 客体在一个流水线步骤中接收的载荷:宿主整体交付的带键文档集、Recipe 为该步骤声明的步骤本地输入、渲染时上下文、该步骤在流水线中的位置,以及已运行步骤的记录。

属性类型必需描述
documentsDocumentSet是流水线客体作为输入面接收的、带键且以作用域为根的可寻址单元集合。宿主整体交付该集合,不解释其内容;客体按内容选择目标文档,并按键寻址其补丁。
step_inputobject否该步骤渲染后的 with 块,是客体作为步骤本地输入读取的、按作者顺序排列的键集。保留作者顺序,使相同输入的多次运行产生字节完全相同的载荷。
contextobject是宿主交给该步骤的渲染时上下文,以其 JSON 文档的字节形式携带;本 schema 不声明该对象,宿主也不会从中读回任何内容。Recipe 或组件作用域 FeatureRecipe 的步骤接收:parameters,即按名称排序的 Release 参数值,没有参数时不存在;annotations,即节点的注解,按各自写入的位置分为 aggregate、release 和 catalog,各自为空时不存在;以及 boundary,即节点所在的边界:name、path(其各段)、sync_wave(为 0 时不存在)、directory、sub_directory(没有时不存在)和 annotations(Release 的各边界向下级联到该节点的注解集合,其自身 Release 条目的注解最后叠加;为空时不存在)。边界作用域 FeatureRecipe 没有宿主组件,其步骤接收:parameters;仅携带 release 分组的 annotations,即该边界自身的注解集合;以及一个携带其 name、path 并以同一集合作为 annotations 的 boundary。同一 FeatureRecipe 的 provider 渲染接收相同的上下文。步骤不设置缩进宽度 yaml_indent。
step_indexinteger是该步骤在流水线中从零开始的位置。
preceding_stepsPrecedingStep[]否在该步骤之前运行的流水线步骤,供客体查看此前发生的内容。

不允许其他属性。

FRPStepOutput

feature-recipe-pipeline 客体为一个流水线步骤返回的载荷:宿主应用于带键文档集的 RFC 6902 补丁、该步骤产生的副作用,以及客体报告的任何诊断。

属性类型必需描述
patchesJSONPatchOp[]否该步骤针对带键集合中的文档发出的结构化 RFC 6902 操作。每个操作按作用域和键指明目标文档,再显式指明 op、path 和 value。这与 label-transform 角色的不透明补丁列表不同:FRP 步骤的补丁由宿主应用,并在步骤失败时通过快照恢复,因此这里的操作是显式的而非不透明的。
side_effectsSideEffect[]否该步骤在修补现有文档之外产生的效果(例如发出 CRD 或写入文件)。
diagnosticsDiagnostic[]否客体报告的诊断。每个元素都采用共享的 Wasm 插件诊断形态。
outputsobject否客体为该步骤返回的可寻址输出,是按作者顺序排列的键集,用于填充该步骤的输出,供后续步骤或模板读取。保留作者顺序,使相同输入的多次运行产生字节完全相同的载荷。步骤不返回输出时不存在。
errorstring否当 guest 已运行但无法完成操作时设置的失败消息;成功时不存在。它与输出携带的任何诊断信息不同:诊断信息报告的是仍产生了结果的运行中发现的问题,而 error 报告的是操作本身未能完成。宿主将存在的 error 呈现为一次失败的插件调用。

不允许其他属性。

DocumentSet

流水线客体作为输入面接收的、带键且以作用域为根的可寻址单元集合。宿主整体交付该集合,不解释其内容;客体按内容选择目标文档,并按键寻址其补丁。

属性类型必需描述
ownUnit 映射是该节点自身的渲染输出,以单元令牌为键。保留键顺序,使该集合以稳定顺序进入传输,且相同输入的多次运行产生字节完全相同的载荷。
hostUnit 映射否组件作用域 FeatureRecipe 所附加的组件的渲染输出——即跨实体的表面。对于 Recipe 步骤和边界作用域 FeatureRecipe 步骤不存在,因为它们没有宿主组件。保留键顺序,使该集合以稳定顺序进入传输,且相同输入的多次运行产生字节完全相同的载荷。

不允许其他属性。

Unit

provider 发出的输出所切分成的一个可寻址片段——一段输出的混合视图。结构化单元携带一棵树(可按 RFC 6902 寻址的视图),是 PATCH 目标;不透明单元只携带其媒体类型和字节(没有树),是 SELECT 和 EMIT 目标,但不是 PATCH 目标。

属性类型必需描述
tokenstring是编解码器分配的不透明位置地址——对单文档文件是发出的文件名,当一个文件携带多个文档时是 <filename>#<ordinal>(文件顺序)。客体将其视为不透明:它按内容选择单元并回传该令牌,从不解析它。
bytesstring否该单元的原始字节,即重组的来源。重组在构造上保证字节保真:未改动的字节从这里原样重新拼接。每个工具包以其自身的字段类型携带这些字节——该类型为字节类型时为原始字节,为字符串时为 base64 编码、由步骤解码以还原——生成的编码器在该字段与传输携带字节的形式之间进行转换。
media_typestring否该单元的内容类型(例如内置 YAML 编解码器的 application/yaml),让客体知道自己看到的是什么。
treeany否编解码器生成时为该单元可按 RFC 6902 寻址的规范化视图,未生成时不存在。有树的单元是结构化的(PATCH 目标);没有树的单元是不透明的。该文档对宿主不透明,宿主不解释字节而直接透传,因此在此 schema 层中树可携带任意 JSON 值。

不允许其他属性。

JSONPatchOp

FRP 步骤针对带键集合中某一文档发出的一个 RFC 6902 JSON-Patch 操作。scope 和 key 指明目标文档;op、path、value 和 from 承载针对该文档内某位置的操作。

属性类型必需描述
scopestring(枚举)是操作所针对的文档根:own(该节点自身渲染的文档)或 host(组件作用域 FeatureRecipe 所附加的组件的文档)。允许的值:"own"、"host"
keystring是指定根内的发出文件名键——客体在运行时从其按内容选择的文档中得知的键。
opstring是RFC 6902 操作:add、remove、replace、move、copy、test 之一。
pathstring是指向指定文档内目标位置的 RFC 6901 JSON Pointer。
valueany否add、replace 和 test 的操作数,其他情况下省略。客体编写的任意 JSON 文档片段,宿主以不透明方式透传;在此 schema 层中可携带任意 JSON 值。
fromstring否move 和 copy 的源指针,其他情况下省略。

不允许其他属性。

SideEffect

feature-recipe-pipeline 步骤在修补现有文档之外产生的一个效果。kind 为 emit_crd 或 emit_file;schema 将其保留为开放字符串,以便新增类型时不破坏 ABI,而遇到任何其他类型时构建会中止。kind 为 emit_crd 时,crd 携带 CRD 文档且省略 file;kind 为 emit_file 时,file 携带要写入的文件且省略 crd。

属性类型必需描述
kindstring是效果类型:emit_crd 或 emit_file。schema 将该字段保留为开放字符串,以便新增类型时不破坏 ABI;遇到任何其他类型时构建会中止,并指出节点、副作用和该类型。
scopestring(枚举)否发出内容所归入的文档根:own(该节点自身的集合)或 host(所附加宿主组件的集合)。scope 缺省时在应用时视为 own。允许的值:"own"、"host"
crdany否kind 为 emit_crd 时该步骤发出的 CRD 文档。对宿主不透明,宿主不解释而直接透传;在此 schema 层中可携带任意 JSON 值。
fileSideEffectFile否emit_file 副作用写入的文件:目标路径和文件内容。

不允许其他属性。

SideEffectFile

emit_file 副作用写入的文件:目标路径和文件内容。

属性类型必需描述
pathstring是文件写入的目标路径。
contentstring是要写入的文件内容。

不允许其他属性。

PrecedingStep

在当前步骤之前运行的一个流水线步骤,供 guest 检查其之前发生的内容:该步骤的流水线索引、它所指定的插件,以及该步骤产生的副作用。

属性类型必需描述
indexinteger是前一步骤在流水线中从零开始的位置。
plugin_uristring是前一个流水线条目在其 plugin 字段中按原样写出的插件。
side_effectsSideEffect[]否前一步骤产生的副作用。

不允许其他属性。