快速开始

本指南帮助您快速了解如何为 Tekton Pruner 创建第一个配置。

前提条件

  1. 环境要求
  • 已安装 Tekton Operator
  • 确保已通过 Operator 安装并准备好 Tekton Pipelines
  1. 所需工具
  • kubectl 命令行工具

步骤 1:配置 Tekton Pruner

WARNING

重要:Tekton Pruner 是一个 event-based pruner,默认处于禁用状态。要启用 event-based pruner,必须禁用现有的 job-based pruner。

  • 不能同时启用两个 pruner(job-based 和 event-based)
  • event-based pruner 会实时响应资源事件,从而提供更高效的清理

如果您希望使用 job-based pruner,请参阅定期清理 TaskRun 和 PipelineRun 资源。

WARNING

启用 Pruner 会立即删除运行记录,且会影响其涵盖的每个命名空间。在启用之前,请阅读命名空间配置中推荐设置部分的警告,并按照其中的步骤操作。

应用以下配置,将 Tekton Pruner 配置为在 5 分钟后删除已完成的资源,并保留最近的 3 次运行记录:

kubectl patch tektonconfigs.operator.tekton.dev config --type=merge -p='{
  "spec": {
    "pruner": {
      "disabled": true
    },
    "tektonpruner": {
      "disabled": false,
      "global-config": {
        "enforcedConfigLevel": "global",
        "ttlSecondsAfterFinished": 300,
        "successfulHistoryLimit": 3,
        "failedHistoryLimit": 3
      }
    }
  }
}'
# tektonconfig.operator.tekton.dev/config patched
设置描述示例
ttlSecondsAfterFinished清理前保留已完成运行记录的时间(以秒为单位)300(5 分钟)
successfulHistoryLimit要保留的成功运行记录的最大数量3
failedHistoryLimit要保留的失败运行记录的最大数量3
historyLimit每种状态要保留的运行记录的最大数量(分别应用于成功和失败的运行记录)5
enforcedConfigLevel配置层级global 或 namespace

enforcedConfigLevel 确定配置层级:

  • global:集群范围的默认设置应用于所有命名空间(不允许命名空间覆盖)
  • namespace:允许通过各个命名空间中的 ConfigMap 进行命名空间级别的覆盖

有关更多信息,请参阅 Pruner 配置。

步骤 2:测试配置

创建测试 PipelineRun 以验证清理功能:

# Create a simple pipeline
kubectl apply -f - <<EOF
apiVersion: tekton.dev/v1
kind: Pipeline
metadata:
  name: hello-pipeline
spec:
  tasks:
    - name: hello
      taskSpec:
        steps:
          - name: echo
            image: busybox:latest
            command: ['echo']
            args: ['hello world']
EOF

# Create multiple runs
for i in {1..5}; do
  kubectl create -f - <<EOF
apiVersion: tekton.dev/v1
kind: PipelineRun
metadata:
  generateName: hello-pipeline-run-
spec:
  pipelineRef:
    name: hello-pipeline
EOF
done

# Watch pruning in action (after 5 minutes + completion time)
kubectl get pipelineruns -w

后续步骤