Tekton Pipeline 任务(Task)配置完全指南

Tekton Pipeline 任务(Task)配置完全指南

pipeline A cloud-native Pipeline resource. 项目地址: https://gitcode.com/gh_mirrors/pipelin/pipeline

概述

在Tekton Pipeline中，Task(任务)是构建CI/CD流程的基本执行单元。本文将深入解析Task的配置方法，帮助开发者掌握如何定义和优化Task。

Task核心概念

Task是一组有序步骤(Steps)的集合，每个步骤都是一个容器镜像的执行实例。Task在Kubernetes集群中以Pod形式运行，具有以下特点：

• 默认情况下Task属于特定命名空间
• 通过集群解析器可以跨集群访问Task
• 每个Task执行完成后才会执行下一个Task

注意：推荐使用集群解析器访问跨集群Task，ClusterTasks已被弃用。

Task配置详解

基础配置

每个Task定义必须包含以下字段：

apiVersion: tekton.dev/v1  # API版本
kind: Task                 # 资源类型
metadata:                  # 元数据
  name: example-task       # Task名称
spec:                      # 规格定义
  steps:                   # 执行步骤
    - name: step1          # 步骤名称
      image: ubuntu        # 容器镜像

步骤(Steps)配置

Steps是Task的核心部分，定义了一系列按顺序执行的容器：

steps:
  - name: build
    image: golang:1.17
    script: |
      #!/bin/sh
      go build -o /workspace/app .

步骤特性

1. 资源限制：可以为每个步骤设置CPU和内存限制

steps:
  - name: resource-limited
    computeResources:
      requests:
        memory: 1Gi
        cpu: 500m
      limits:
        memory: 2Gi
        cpu: 800m

2. 脚本执行：支持直接在步骤中编写脚本

steps:
  - image: python
    script: |
      #!/usr/bin/env python3
      print("Hello from Python!")

3. 超时控制：设置步骤执行超时时间

steps:
  - name: timeout-example
    image: busybox
    script: |
      sleep 60
    timeout: 30s  # 30秒后超时

错误处理机制

Tekton提供了灵活的错误处理方式：

1. 忽略步骤错误：使用onError: continue让Task继续执行

steps:
  - name: may-fail
    image: alpine
    onError: continue
    script: |
      exit 1  # 故意失败但不会中断Task

2. 获取步骤退出码：后续步骤可以读取前一步的退出码

cat $(steps.step-may-fail.exitCode.path)

3. 失败时产生结果：即使步骤失败也可以输出结果

steps:
  - name: fail-with-result
    onError: continue
    image: busybox
    script: |
      echo "123" > $(results.result1.path)
      exit 1

输入输出配置

1. 参数(Parameters)：定义Task的可配置参数

params:
  - name: dockerfile
    type: string
    description: Dockerfile路径
    default: /workspace/Dockerfile

2. 工作区(Workspaces)：定义持久化存储

workspaces:
  - name: source
    description: 源代码目录

3. 结果(Results)：定义Task输出结果

results:
  - name: build-image
    description: 构建的镜像名称

高级特性

1. Sidecar容器：运行辅助容器

sidecars:
  - name: redis
    image: redis

2. 步骤模板：定义公共容器配置

stepTemplate:
  env:
    - name: COMMON_ENV
      value: shared-value

3. 输出重定向：重定向stdout/stderr到文件

steps:
  - name: redirect
    image: busybox
    stdoutConfig:
      path: /logs/output.log

实用示例

Docker镜像构建任务

apiVersion: tekton.dev/v1
kind: Task
metadata:
  name: build-push
spec:
  params:
    - name: dockerfile
      type: string
      default: Dockerfile
  steps:
    - name: build
      image: gcr.io/kaniko-project/executor
      args:
        - --dockerfile=$(params.dockerfile)
        - --destination=gcr.io/my-project/image

多步骤测试任务

apiVersion: tekton.dev/v1
kind: Task
metadata:
  name: test-suite
spec:
  steps:
    - name: unit-test
      image: golang
      script: |
        go test ./...
        
    - name: integration-test
      image: python
      script: |
        pytest tests/

调试技巧

1. 检查文件结构：Task运行时会在容器中创建特殊目录：

   • /workspace - 工作区挂载点
   • /tekton/results - 结果输出目录

2. 检查Pod状态：使用kubectl检查TaskRun对应的Pod状态

3. 非root用户运行：可以配置步骤以非root用户运行

steps:
  - name: non-root
    image: alpine
    securityContext:
      runAsUser: 1000

最佳实践

1. 为每个Task添加清晰的描述
2. 合理设置资源限制
3. 使用参数提高Task复用性
4. 为关键步骤添加超时控制
5. 合理处理步骤失败情况

通过本文的详细解析，开发者可以全面掌握Tekton Task的配置方法，构建出高效可靠的CI/CD流水线。

pipeline A cloud-native Pipeline resource. 项目地址: https://gitcode.com/gh_mirrors/pipelin/pipeline