介绍
Pipelines-as-Code (PAC) 可让您将 Tekton pipeline 定义与应用代码放在同一个 Git 仓库中,并在 Git 事件匹配时自动执行这些定义。您无需在集群中编辑 PipelineRuns,而是将它们提交到 .tekton/ 目录下;PAC 会根据对应分支读取正确的 manifest,并为您创建 PipelineRun。
本文档适用对象
- 集群管理员 部署并维护 PAC 组件,将其暴露给 Git provider,并配置集群级设置。
- 项目用户 创建
Repositoryresources,配置按仓库或按组织的 Git 集成,并编写提交到.tekton/下的 PipelineRuns。
Install 章节面向管理员。Guides 和 How To 章节面向用户。
核心能力
- 按仓库集成:通过单个
RepositoryKubernetes resource 引用 Git URL,以及(在 Webhook 模式下)包含 access token 的 Secret。 - Git 事件匹配 —— push、pull request / merge request、tag push、commit comment、issue comment。
- PipelineRun 选择:通过 PipelineRun manifest 上的 annotations(
on-event、on-target-branch、on-cel-expression、on-path-change等)进行选择。 - 状态报告:将状态回传给 Git provider,并以 GitHub Checks 或 commit statuses 的形式展示,同时提供返回集群的链接。
- 基于 comment 的操作 ——
/retest、/cancel,以及在 PipelineRun 上定义的自定义命令。 - GitHub 和 GitLab 集成 —— 本文档涵盖 GitHub App、GitHub Webhook 和 GitLab Webhook 工作流。
- Resolver 集成 —— 可从 Tekton Hub、远程 Git URL 或其他 resolver 拉取 tasks,而无需将它们打包到仓库中。
工作原理
PAC 由三个 controller 侧组件和一个 Kubernetes resource 组成:
- Repository resource — 一个有命名空间的
pipelinesascode.tekton.dev/v1alpha1resource,用于将 Git repository URL 绑定到其凭据(Webhook 模式)或不绑定任何凭据(GitHub App 模式,此时凭据为集群级)。 - PAC Webhook — Git provider 向其发送事件的 HTTP 接收端。它使用与 provider 共享的
webhook.secret值验证签名。 - PAC Controller — 查找匹配的
Repository,从相关 ref 上的.tekton/获取 PipelineRun manifest,通过 annotation grammar 进行过滤,并在Repository的 namespace 中创建PipelineRun。 - PAC Watcher — 观察
PipelineRun,并将完成状态(以及 provider 支持时的中间步骤)回传给 Git provider。
完整流程见 Core Concepts。
使用 PAC 的前提条件
基础设施:
- 安装了 Tekton Operator 的 Kubernetes cluster。
- 已部署 PAC 组件,并对 Internet 或承载 Git provider 的网络开放;请参见 Manage PAC Component。
- 对计划运行 pipeline 的 namespace 具有
kubectl访问权限。
知识要求:
- Tekton 基础知识 —
Pipeline、PipelineRun、Task、TaskRun。 - Kubernetes 基础知识 — namespace、Secrets、custom resources。
- 熟悉您将集成的 Git provider,例如 GitHub 或 GitLab。
接下来去哪里
- 首次使用 — 从 Quick Start 开始,查看一个端到端的最小示例。
- 设置真实仓库 — 在 Guides 中选择对应指南。
- 了解资源 — 阅读 Core Concepts。
- 组件部署 — 参见 Manage PAC Component。
- 故障排查 — 参见 Common Issues。
相关文档
- Define PipelineRuns in Git — 在
.tekton/下定义并对 PipelineRuns 进行版本管理。 - Trigger Pipelines — 了解 Git 操作如何映射为事件。