logo
Alauda DevOps Pipelines Docs
English
简体中文
English
简体中文
logo
Alauda DevOps Pipelines Docs
导航

概览

介绍
架构
快速开始
生命周期策略
发版日志
特性概述

触发器

介绍
架构

核心概念

Tekton Triggers 核心概念
EventListener
触发器
Interceptor
TriggerBinding
TriggerTemplate
快速开始

实用指南

设置事件监听器
使用 GitLab 事件触发器
创建 TriggerTemplate

问题处理

Pipeline 未被自动触发
permissions

概念

TektonConfig
TektonPipeline
安装

升级

升级路径
升级 Alauda DevOps Pipelines Operator

配置

调整子组件的可选配置项
配置流水线组件的资源配额
Pod 模板配置指南
定期清理 TaskRun 和 PipelineRun 资源

How To

通过 TektonConfig 在 global 集群中部署 tekton-pipelines

管道

介绍
架构

概念

任务
TaskRuns
流水线
PipelineRuns
StepActions
解析器
工作空间
Pod 模板
快速开始

实用指南

调整 Dockerfile 构建适用于 Task 的自定义镜像
Specifying remote pipelines using hub resolvers
Specifying remote tasks using hub resolvers
使用 java-image-build-scan-deploy 管道

故障排查

在 Tekton 中使用自定义镜像时遇到容器创建失败的问题
在 run-script Task 中使用自定义镜像时遇到权限不够的问题
在 Tekton 中遇到无法使用多个基于 PVC 的工作区的问题
权限

结果

介绍
架构

核心概念

核心概念
深入理解 Tekton Results
快速开始
permissions

配置

数据库配置

供应链安全

介绍
架构

概念

核心概念
了解 Tekton Chains

快速开始

Getting Started
签名证明

实用指南

生成镜像签名并验证镜像完整性
构建系统溯源验证
源代码仓库验证
漏洞扫描和验证
Base Image and SBOM Verification
License Compliance Verification
Keyless Signing Verification

配置

链配置
链配置
Authentication for Chains
签名密钥配置

Hub

引言
架构

核心概念

概念
理解 Tekton Hub
权限描述

API Reference

介绍

Kubernetes APIs

Operator

TektonConfig [operator.tekton.dev/v1alpha1]
TektonInstallerSet [operator.tekton.dev/v1alpha1]
TektonPipeline [operator.tekton.dev/v1alpha1]
TektonTrigger [operator.tekton.dev/v1alpha1]
TektonChain [operator.tekton.dev/v1alpha1]
TektonHub [operator.tekton.dev/v1alpha1]
TektonResult [operator.tekton.dev/v1alpha1]
TektonInstallerSet [operator.tekton.dev/v1alpha1]
OpenShift Pipelines as Code [operator.tekton.dev/v1alpha1]

管道

Pipeline [tekton.dev/v1]
任务 [tekton.dev/v1]
PipelineRun [tekton.dev/v1]
TaskRun [tekton.dev/v1]
集群任务 [tekton.dev/v1]
运行 [tekton.dev/v1]
CustomRun [tekton.dev/v1]
StepAction [tekton.dev/v1]
VerificationPolicy [tekton.dev/v1alpha1]
ResolutionRequest [resolution.tekton.dev/v1beta1]

Triggers

触发器 [triggers.tekton.dev/v1beta1]
TriggerTemplate [triggers.tekton.dev/v1beta1]
EventListener [triggers.tekton.dev/v1beta1]
触发绑定 [triggers.tekton.dev/v1beta1]
拦截器 [triggers.tekton.dev/v1alpha1]
集群触发器绑定 [triggers.tekton.dev/v1beta1]
集群拦截器 [triggers.tekton.dev/v1alpha1]

高级 API

Results

Introduction to API Usage
Results 列表
结果详情
结果记录列表
Result logs 列表
📝 在 GitHub 上编辑此页
上一页Interceptor
下一页TriggerTemplate

#TriggerBinding

TriggerBinding 是 Tekton Triggers 中的一个关键组件,它允许您从事件负载中提取字段并将其绑定到命名参数。这些参数随后可以在 TriggerTemplate 中使用,以基于从事件中提取的特定值创建 TaskRuns 和 PipelineRuns 等资源。

#目录

#术语解释

术语描述
TriggerBinding一种 Tekton Triggers 资源,它从事件负载中提取字段并将其绑定到命名参数。
ClusterTriggerBinding一种集群范围的 TriggerBinding 版本,可以在整个集群中重用。
JSONPath一种用于从 JSON 结构中提取数据的查询语言,TriggerBindings 使用它来访问事件数据。
事件负载外部系统触发事件时,EventListener 接收到的数据。

#为什么需要 TriggerBinding

#事件驱动的管道挑战

在 CI/CD 工作流中,外部系统(如 GitHub、GitLab 或其他 webhook 提供者)发送具有特定数据结构的事件。这些事件包含了诸如提交 ID、代码仓库 URL、分支名称以及其他元数据等宝贵信息,这些信息应该在管道执行中使用。

如果没有 TriggerBindings,将没有标准化的方法来:

  • 从复杂的事件负载中提取特定字段
  • 将这些数据转换为管道可用的参数
  • 处理来自不同系统的不同事件结构

#TriggerBinding 解决这些问题的方式

TriggerBinding 提供了一种声明方式来:

  1. 使用 JSONPath 表达式从事件负载中提取特定字段
  2. 将这些字段转换为可以在 TriggerTemplates 中引用的命名参数
  3. 在数据提取与资源创建之间实现关注点分离

这种分离允许团队创建可重用的绑定,可以与不同的模板混合搭配,使事件到管道的过程更加模块化和可维护。

#优势

  • 可重用性:一次创建绑定,可以在多个触发器中重用
  • 灵活性:从 HTTP 头和 JSON 内容负载中提取数据
  • 范围选项:使用命名空间级别的 TriggerBindings 或集群范围的 ClusterTriggerBindings
  • 回退机制:如果找不到某个字段,系统可以使用 TriggerTemplate 中的默认值
  • 组合:多个绑定可以组合在单个触发器中,以提取不同的数据集

#适用场景

TriggerBindings 在以下场景中至关重要:

  1. CI/CD 管道自动化:当代码推送到代码仓库时自动触发管道,提取提交细节供管道使用。

  2. 多环境部署:使用相同的事件数据,但结合特定于环境的绑定,部署到不同的环境。

  3. 自定义 Webhook 处理:从自定义 webhook 中提取相关数据,以使用正确的参数触发适当的管道。

  4. 复杂事件处理:在处理复杂事件结构时,仅需特定嵌套字段以供管道执行。

#约束与限制

  • TriggerBindings 只能提取事件负载中存在的数据
  • JSONPath 表达式必须正确格式化,并用 $() 语法括起来
  • HTTP 头中的字段名称区分大小写
  • JSON 键中的特殊字符(如句点或斜杠)必须用反斜杠转义

#原则

#TriggerBinding 结构和类型

声明 TriggerBinding 有三种方式:

  1. 内联绑定:直接在 Trigger 资源中定义

    apiVersion: triggers.tekton.dev/v1beta1
    kind: Trigger
    metadata:
      name: push-trigger
    spec:
      bindings:
      - name: gitrevision
        value: $(body.head_commit.id)
      - name: gitrepositoryurl
        value: $(body.repository.url)
      template:
        ref: git-clone-template
  2. TriggerBinding 资源:作为单独的资源创建,供多个触发器重用

    apiVersion: triggers.tekton.dev/v1beta1
    kind: TriggerBinding
    metadata:
      name: pipeline-binding
    spec:
      params:
      - name: gitrevision
        value: $(body.head_commit.id)
      - name: gitrepositoryurl
        value: $(body.repository.url)
      - name: contenttype
        value: $(header.Content-Type)
  3. ClusterTriggerBinding:集群范围的绑定,可在整个集群中重用

    apiVersion: triggers.tekton.dev/v1beta1
    kind: ClusterTriggerBinding
    metadata:
      name: pipeline-clusterbinding
    spec:
      params:
        - name: gitrevision
          value: $(body.head_commit.id)
        - name: gitrepositoryurl
          value: $(body.repository.url)
        - name: contenttype
          value: $(header.Content-Type)

#数据访问模式

TriggerBindings 使用用 $() 语法括起来的 JSONPath 表达式来访问数据:

  • HTTP 内容访问:$(body.repository.url)
  • HTTP 头访问:$(header.Content-Type)
  • 拦截器数据访问:$(extensions.field-name)
  • EventListener 上下文访问:$(context.eventID)
  • 特殊字符处理:$(body.dev\.tekton\.dev\/foo)

#配置示例

#基本的 GitHub Webhook TriggerBinding

apiVersion: triggers.tekton.dev/v1beta1
kind: TriggerBinding
metadata:
  name: github-push-binding
spec:
  params:
  - name: gitrevision
    value: $(body.after)
  - name: gitrepositoryurl
    value: $(body.repository.clone_url)
  - name: gitrepositoryname
    value: $(body.repository.name)
  - name: gitusername
    value: $(body.pusher.name)

#多个绑定示例

apiVersion: triggers.tekton.dev/v1beta1
kind: EventListener
metadata:
  name: listener
spec:
  triggers:
    - name: prod-trigger
      bindings:
        - ref: event-binding
        - ref: prod-env
      template:
        ref: pipeline-template
    - name: staging-trigger
      bindings:
        - ref: event-binding
        - ref: staging-env
      template:
        ref: pipeline-template

#重要参数解释

#JSONPath 表达式

JSONPath 表达式是 TriggerBindings 中提取数据的核心机制。

#适用场景

  • 从复杂的 JSON 结构中提取嵌套字段
  • 访问负载中的数组元素
  • 访问整个正文或头部数据

#约束与限制

  • 必须用 $() 语法括起来
  • 嵌套的 $() 括号会解析为最内层表达式
  • 无效的表达式将导致返回空值

#原则/参数解释

常见的 JSONPath 模式:

$(body) -> 被整个主体替换
$(body.key1) -> 主体中 key1 的值
$(body.key2.key3) -> 嵌套值访问
$(body.key4[0]) -> 数组的第一个元素
$(header.Content-Type) -> Content-Type 头的值

#参考资料

  • Tekton Triggers 文档
  • TriggerBinding 官方文档
  • TriggerTemplate 文档
  • EventListener 文档