Pruner 配置

概述

Tekton Pruner 根据可配置的基于时间(TTL)和基于历史记录的策略,自动清理已完成的 PipelineRun 和 TaskRun,从而管理 Tekton 资源的生命周期。

配置

Pruner 配置存储在带有 app.kubernetes.io/part-of: tekton-pruner 和 pruner.tekton.dev/config-type: <global|namespace> 标签的 ConfigMap 中。您可以修改此 ConfigMap 以更改 Pruner 的行为。

默认情况下,Tekton Pruner 由 TektonConfig 资源禁用。您可以修改 TektonConfig 资源来配置 Pruner。

本质上,Tekton Operator 会将 Pruner 配置从 TektonConfig 资源同步到 TektonPruner 资源,最终反映到 ConfigMap 中。

WARNING

如果您通过 TektonConfig 部署 Pruner,则必须通过 TektonConfig 配置 Pruner。

如果您只修改 ConfigMap 中的配置,而该配置未同步到 TektonPruner 资源,则配置可能会丢失。

当 TektonConfig 中的配置发生更改,或其他原因触发协调时,ConfigMap 中的配置将被覆盖。

下面简单演示配置 Pruner 的不同方式。

在 ConfigMap 中配置

WARNING

关键:所有 pruner ConfigMap 必须具有以下标签:

labels:
  app.kubernetes.io/part-of: tekton-pruner
  pruner.tekton.dev/config-type: <global|namespace>

这些标签使 pruner webhook 能够验证 ConfigMap,并使控制器能够正确处理它们。

以下是 Tekton Pruner ConfigMap 示例:

apiVersion: v1
data:
  global-config: |
    enforcedConfigLevel: global
    ttlSecondsAfterFinished: 300
    successfulHistoryLimit: 3
    failedHistoryLimit: 3
    historyLimit: 100
kind: ConfigMap
metadata:
  labels:
    app.kubernetes.io/part-of: tekton-pruner
    operator.tekton.dev/operand-name: pruner
    pruner.tekton.dev/config-type: global
    pruner.tekton.dev/release: v0.4.1
  name: tekton-pruner-default-spec

YAML 字段说明:

设置描述示例
ttlSecondsAfterFinished在清理之前保留已完成运行的时间(以秒为单位)300(5 分钟)
successfulHistoryLimit要保留的成功运行的最大数量3
failedHistoryLimit要保留的失败运行的最大数量3
historyLimit每种状态要保留的运行的最大数量(分别应用于成功和失败的运行)5
enforcedConfigLevel配置层级global 或 namespace

enforcedConfigLevel 决定配置层级:

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

在 TektonConfig 中配置

WARNING

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

在 TektonConfig 资源中,Pruner 的配置大致如下:

apiVersion: operator.tekton.dev/v1alpha1
kind: TektonConfig
metadata:
  name: config
spec:
  pruner:
    disabled: true  # Must disable job-based pruner
  tektonpruner:
    disabled: false  # Enable event-based pruner
    global-config:
      enforcedConfigLevel: global  # Options: global, namespace
      ttlSecondsAfterFinished: 86400  # Delete runs older than 24 hours (optional)
      historyLimit: 100              # Used for a status whose own limit is not set (optional)
      successfulHistoryLimit: 50     # Keep only 50 successful runs (optional)
      failedHistoryLimit: 20         # Keep only 20 failed runs (optional)
      namespaces:
        dev-namespace:
          historyLimit: 50
          ttlSecondsAfterFinished: 1800  # 30 minutes for dev
        prod-namespace:
          successfulHistoryLimit: 50      # Cannot exceed the global successfulHistoryLimit
          failedHistoryLimit: 20          # Cannot exceed the global failedHistoryLimit
          ttlSecondsAfterFinished: 86400  # 24 hours for prod, equal to the global limit

namespaces 下的值不能超过相应的根级别值(ttlSecondsAfterFinished、historyLimit、successfulHistoryLimit、failedHistoryLimit);超出这些值的配置将被拒绝。请参阅验证规则。

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 资源。

YAML 字段说明:

  • spec.pruner:此部分包含 job-based pruner 的配置。
    • disabled:是否禁用 job-based pruner。
  • spec.tektonpruner:此部分包含 event-based pruner 的配置。
    • disabled:是否禁用 event-based pruner。
    • enforcedConfigLevel:决定配置层级。有关详细信息,请参阅命名空间配置。
      • global:集群范围的默认值应用于所有命名空间(不允许覆盖命名空间配置)。
      • namespace:允许通过各个命名空间中的 ConfigMap 覆盖命名空间级别的配置。
    • ttlSecondsAfterFinished:在清理之前保留已完成运行的时间(以秒为单位)。有关详细信息,请参阅基于时间的清理(TTL)。
    • historyLimit:每种状态要保留的运行的最大数量(分别应用于成功和失败的运行)。有关详细信息,请参阅基于历史记录的清理。
    • successfulHistoryLimit:要保留的成功运行的最大数量。有关详细信息,请参阅基于历史记录的清理。
    • failedHistoryLimit:要保留的失败运行的最大数量。有关详细信息,请参阅基于历史记录的清理。
    • namespaces:为特定命名空间配置不同的默认清理策略。有关详细信息,请参阅命名空间配置。
    • options:Tekton Pruner 控制器的选项。有关更详细的支持信息,请参阅作为选项的其他字段。

参考