ghcr.io/tektoncd/results/retention-policy-agent-07427b345034d96a9a27896ebb138518:v0.18.0

Tekton Results

Tekton Results 旨在帮助用户对 CI/CD 工作负载历史进行逻辑分组，并将长期结果存储与 Pipeline 控制器分离。这使您能够：

• 提供 CI/CD 工作流的自定义 Result 元数据，这些元数据在 Tekton TaskRun/PipelineRun CRD 中不可用（例如：运行后操作）
• 将相关工作负载分组（例如：将相关 TaskRun 和 PipelineRun 捆绑为单个单元）
• 使长期结果历史独立于 Pipeline CRD 控制器，从而释放 etcd 资源用于 Run 执行
• 存储 TaskRun/PipelineRun 生成的日志，以便清理已完成的 Run 以节省资源

更多背景信息和设计动机可在 TEP-0021 中找到。

概述

Tekton Results 由 3 个主要组件构成：

• 由持久存储支持的可查询 gRPC API 服务器（最新 API 规范见 proto/v1alpha2）
• 用于监视 TaskRun 和 PipelineRun 更新并向 API 服务器报告的控制器
• 保留策略代理（retention policy agent）：用于从数据库中删除旧数据的代理

Result 的生命周期

sequenceDiagram
actor U as Users
participant PC as Pipeline Controller
participant RW as Result Watcher
participant RA as Result API
U->>PC: Create PipelineRun/TaskRun
RW-->>PC: Watch PipelineRun/TaskRun
Note over PC,RW: Wait for PipelineRun/TaskRun Completion
RW->>RA: Update results database
U--)RA: Get Results

• 用户照常通过 Kubernetes API 创建 TaskRun 或 PipelineRun
• Result Watcher 监听所有 TaskRun/PipelineRun 变更
• 若 TaskRun/PipelineRun 发生变更，Watcher 会使用 Results API 更新（或创建）相应的 Record（必要时创建 Result）。Watcher 还会为原始 TaskRun/PipelineRun 添加标识符注释
• 用户可直接从 API 获取/查询 Result/Record 数据。一旦 TaskRun/PipelineRun 完成并成功存储到 Result API，即可安全地从集群中删除原始 CRD 对象

快速开始

• 安装
• Results API：了解如何连接到 API 并进行查询
• Watcher：了解 Watcher 支持的类型以及它如何确定 Result 分组

数据模型

graph BT
B(TaskRun) --> |Record| A[Result]
C(Log) --> |Record| A
D(PipelineRun) --> |Record| A

• Record 是单个数据实例。通常为执行数据（如 PipelineRun、TaskRun、日志），但也可引用事件/执行的其他相关数据。Record 设计为灵活结构，以支持工具希望围绕 CI 事件提供的任意信息
• Result 是 Record 的聚合器，允许用户将一组 Record 作为单个实体引用。例如，单个 Result 可分组以下 Record：
  • 触发操作的源事件（如拉取请求、推送）
  • 发生的 PipelineRun
  • 响应 PipelineRun 发生的 TaskRun（每个 Task 一个）
  • Cloud Event 交付回执
  • 源状态更新回执

[!NOTE] 并非所有这些数据类型都已被 Watcher 支持，但它们是我们计划支持的数据示例。

有用链接

• 路线图（Roadmap）
• Results API 查询指南（Results API Query Cookbook）

联系方式

• Tekton 社区（Tekton Community）
• #results - Tekton Slack