介绍

Tekton Results 旨在帮助用户对 CI/CD 工作负载的历史记录进行逻辑分组,并将长期 Results 存储与 Pipeline controller 分离。这使你可以:

  • 提供关于 CI/CD 工作流的自定义 Results 元数据,这些信息在 Tekton TaskRun/PipelineRun CRD 中不可用(例如,post-run actions)
  • 将相关工作负载分组在一起(例如,将相关的 TaskRuns 和 PipelineRuns 打包为一个单元)
  • 使长期 Results 历史独立于 Pipeline CRD controller,从而释放 etcd 资源以供运行执行使用。
  • 存储由 TaskRun/PipelineRun 生成的日志,以便可以清理已完成的运行来节省资源。

更多背景信息和设计动机可参考 TEP-0021。

Overview

Tekton Results 由两个主要组件组成:

  • 一个可通过 API 查询的 gRPC API server,后端由持久化存储支持(请参阅项目源代码中 proto/v1alpha2 的最新 API 规范)。
  • 一个 watcher controller,用于监视 TaskRun 和 PipelineRun 的更新,并将其报告给 API server。

Results 的生命周期

  1. 用户像往常一样通过 Kubernetes API 创建 TaskRun 或 PipelineRun。
  2. Results Watcher 监听所有 TaskRun/PipelineRun 的变更。
  3. 如果 TaskRun/PipelineRun 发生变化,watcher 会使用 Results API 更新(或创建)相应的 Record(必要时也会创建 Result)。
    • watcher 还会使用一个标识符为原始 TaskRun/PipelineRun 添加注解。
  4. 用户可以直接从 API 获取/查询 Results/Records 数据。一旦 TaskRun/PipelineRun 完成并成功存储到 Results API,原始 CRD 对象就可以安全地从集群中删除。

数据模型

  • record 是一条单独的数据实例。它们通常是执行数据(例如,PipelineRun、TaskRun、日志),但也可以引用有关事件/执行的其他数据。Record 的设计目标是灵活支持工具希望提供的任何 CI 事件信息。
  • Results 是 record 的聚合器,允许用户将一组 record 作为单个实体进行引用。例如,你可能会有一个 Results,分组了以下 record:
    • 触发操作的源事件(例如,pull request、push)。
    • 创建的 PipelineRun。
    • 为响应 PipelineRun 而创建的 TaskRuns。
    • 云事件的接收。
    • 源状态更新的接收。

(注:watcher 当前不支持所有这些类型的数据,但这些示例代表了我们计划支持的数据类型。)