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

何时使用流水线步骤

FeatureRecipe 提供两种方式来塑造 Feature 所贡献的输出:一种是生成自身文档的模板化 FeatureRecipe,另一种是在渲染输出上运行 Wasm 插件的流水线步骤(pipeline:)。二者解决的是不同的问题。本页是决策指南:仅在两种触发条件下使用流水线步骤,其余情况一律使用模板化 FeatureRecipe。

两种工具

**模板化 FeatureRecipe 是局部的、生成式的。**它通过 Go 模板,从自身的值生成自身的文档——例如 sidecar 的 ConfigMap、策略 CRD、自动扩缩容对象。它输出的一切都是 Feature 的 values: 和 infra: 以及传给其模板的渲染上下文的函数。它从不触及其他实体的输出,只添加自己的文档。如果你需要生成的内容可以根据 Feature 已知的信息写出,那么模板化 FeatureRecipe 就是正确且更简单的工具——无需插件,无需流水线。

**流水线步骤是全局的、变换式的。**它在渲染之后运行,作用于构建已输出的真实文档集。宿主将带键的文档集整体交给该步骤;步骤读取实际内容,选出目标文档,并对其结构返回精确的 RFC 6902 补丁——或者以副作用的形式输出新文档。步骤推理的是已渲染的内容,而不仅仅是 Feature 所声明的内容。这种触及范围正是它存在的全部理由,也是应当谨慎使用它的原因。

使用流水线步骤的两种触发条件

仅当以下条件之一成立时才使用流水线步骤。如果两者都不成立,请改用模板化 FeatureRecipe 生成文档。

  1. **宿主范围补丁——你需要触及另一个已渲染实体的结构。**典型场景是向使用方 component 的 workload 注入环境变量、卷挂载或 sidecar 容器——这是一个并非由该 Feature 本身编写的文档。模板化 FeatureRecipe 无法做到这一点:它生成自己的文档,不会编辑别人的文档。流水线步骤则可以,因为它作用于已渲染的文档集,并能按键定位宿主 component 的文档。

  2. **依赖内容的输出或补丁——输出取决于已渲染文档集包含什么。**当你输出的资源或应用的补丁是构建所产生内容的函数时——例如 Deployment 实际声明的端口、最终出现在 manifest 中的容器名称、chart 展开后的资源——决策就需要掌握已渲染的内容。模板化 FeatureRecipe 根据 Feature 自身的值进行渲染,从不会看到最终的文档集,因此无法做出依赖内容的选择;流水线步骤则先读取内容,再采取行动。

两种触发条件有一个共同点:它们需要只在渲染之后才存在的信息——另一个实体的结构,或已输出的内容本身。局部生成从不需要这些信息,因此局部生成从不需要流水线步骤。

步骤负责变换,策略负责验证

流水线步骤是一个变换器:它会改变已渲染的文档集。它不是检查结果是否可接受的地方。要验证构建——断言打过补丁的 workload 含有 sidecar、没有明文 secret 进入输出、必需的标签存在——请附加一个渲染阶段策略:即位于 render-verdict 角色的治理插件,它在渲染之后针对已输出的产物运行并返回裁决。halt 裁决会停止构建;warn 或 info 裁决仅提供建议而不阻断。

让二者保持分离。不要在流水线步骤中构建验证逻辑,也不要用策略来修改输出——附加在裁决角色上的治理插件只返回裁决、从不打补丁,宿主也只将裁决角色的输出当作决策来读取。步骤塑造输出;render-verdict 策略评判输出。治理插槽页面介绍了全部四种治理角色和裁决严重级别。

步骤可组合

流水线步骤可以声明类型化的输入和输出契约,使其 with: 输入和返回的输出成为经过验证的结构,而非自由格式的数据块。步骤还会返回具名的 outputs,同一流水线中后声明的步骤可以在其自身的 with: 模板中以 .steps.<id>.outputs.<key> 读取前一步骤的输出。这就是两段式模式无需耦合即可组合的方式:Fetcher 步骤输出一个凭据资源,并将所生成 Secret 的名称作为输出发布;Injector 步骤读取该名称,并为使用方 workload 打补丁以挂载它。每个步骤只承担一个关注点,流水线按声明顺序串联它们的输出。

交叉引用