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 上编辑此页
上一页使用 GitLab 事件触发器
下一页问题处理

#创建 TriggerTemplate

TIP

有关 TriggerTemplates 的全面理解,包括其架构、优势和基本原理,请参见 深入理解 TriggerTemplate 文档。

#目录

#概述

TriggerTemplate 是一种资源,用于定义能够实例化和执行的资源蓝图,例如在 EventListener 检测到事件时的 TaskRun 或 PipelineRun。它提供参数化功能,允许您在资源模板的任何地方使用这些参数。

#支持的资源类型

TriggerTemplate 当前支持以下 Tekton Pipelines 资源:

v1beta1 资源类型描述
PipelinePipeline 定义
PipelineRunPipeline 运行实例
TaskTask 定义
TaskRunTask 运行实例

#基本结构

以下是 TriggerTemplate 定义的典型示例:

apiVersion: triggers.tekton.dev/v1beta1
kind: TriggerTemplate
metadata:
  name: pipeline-template
spec:
  params:                           # 参数定义
    - name: gitrevision            # 参数名称
      description: Git 修订版本      # 参数描述
      default: main                 # 默认值(可选)
    - name: gitrepositoryurl
      description: Git 仓库 URL
    - name: message
      description: 打印消息
      default: 这是默认消息
  resourcetemplates:              # 资源模板定义
    - apiVersion: tekton.dev/v1beta1
      kind: PipelineRun
      metadata:
        generateName: simple-pipeline-run-  # 生成的名称前缀
      spec:
        pipelineRef:
          name: simple-pipeline
        params:
          - name: message
            value: $(tt.params.message)    # 使用模板参数
          - name: revision
            value: $(tt.params.gitrevision)

#参数配置

#1. 参数定义

在 spec.params 中定义参数:

spec:
  params:
    - name: param1                # 参数名称
      description: 参数描述        # 参数描述
      default: 默认值             # 可选默认值

#2. 参数使用

在资源模板中使用参数:

  • 基本语法:$(tt.params.parameter_name)
  • 示例:$(tt.params.gitrevision)

#3. 参数类型

TriggerTemplate 中的参数仅支持字符串类型值。每个参数包括以下字段:

  • name: 参数名称(必选)
  • description: 参数描述(可选)
  • default: 默认值,必须是字符串(可选)
NOTE

注意:尽管参数值只能是字符串,您可以在字符串中包含格式化的内容(如 JSON 字符串),并在使用时进行解析。

#JSON 对象处理

传递 JSON 数据时,您需要将其处理为字符串:

# 在 TriggerTemplate 中定义参数
metadata:
  annotations: # 通过添加此配置来允许将 JSON 格式化为字符串
    triggers.tekton.dev/old-escape-quotes: "true" # 
spec:
  params:
    - name: jsonData
      description: JSON 格式数据(作为字符串)
      default: '{"key": "value"}'

# 在资源模板中使用
spec:
  params:
    - name: data
      value: $(tt.params.jsonData)  # 作为字符串传递

#最佳实践

  1. 参数命名与组织

    • 使用清晰、描述性的参数名称
    • 为所有参数提供描述
    • 合理使用默认值
  2. 模板设计

    • 保持模板的可重用性
    • 使用动态名称生成
    • 适当拆分复杂模板
  3. 错误处理

    • 为关键参数提供默认值
    • 使用 CEL 拦截器验证参数
    • 实施适当的错误处理机制

#常见问题

  1. 参数解析错误

    • 检查参数语法
    • 验证 JSON 对象格式
    • 确认参数名称匹配
  2. 资源创建失败

    • 检查资源模板格式
    • 验证参数值
    • 检查系统权限
  3. 命名冲突

    • 使用 generateName
    • 实现唯一性检查

#使用示例

#1. 基本 CI/CD 管道

apiVersion: triggers.tekton.dev/v1beta1
kind: TriggerTemplate
metadata:
  name: ci-pipeline-template
spec:
  params:
    - name: git-revision
      description: Git 提交 SHA
    - name: git-repo-url
      description: Git 仓库 URL
  resourcetemplates:
    - apiVersion: tekton.dev/v1beta1
      kind: PipelineRun
      metadata:
        generateName: ci-run-
      spec:
        pipelineRef:
          name: ci-pipeline
        params:
          - name: revision
            value: $(tt.params.git-revision)
          - name: repo-url
            value: $(tt.params.git-repo-url)

#2. 多环境部署

apiVersion: triggers.tekton.dev/v1beta1
kind: TriggerTemplate
metadata:
  name: deploy-template
spec:
  params:
    - name: environment
      description: 部署环境
      default: development
    - name: image-tag
      description: 镜像标签
  resourcetemplates:
    - apiVersion: tekton.dev/v1beta1
      kind: PipelineRun
      metadata:
        generateName: deploy-$(tt.params.environment)-
      spec:
        pipelineRef:
          name: deploy-pipeline
        params:
          - name: target-environment
            value: $(tt.params.environment)
          - name: image-tag
            value: $(tt.params.image-tag)

#参考链接

  • Tekton Triggers 官方文档
  • TriggerTemplate API 参考
  • Tekton Pipeline 文档