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 中。
如果您通过 TektonConfig 部署 Pruner,则必须通过 TektonConfig 配置 Pruner。
如果您只修改 ConfigMap 中的配置,而该配置未同步到 TektonPruner 资源,则配置可能会丢失。
当 TektonConfig 中的配置发生更改,或其他原因触发协调时,ConfigMap 中的配置将被覆盖。
下面简单演示配置 Pruner 的不同方式。
在 ConfigMap 中配置
关键:所有 pruner ConfigMap 必须具有以下标签:
这些标签使 pruner webhook 能够验证 ConfigMap,并使控制器能够正确处理它们。
以下是 Tekton Pruner ConfigMap 示例:
YAML 字段说明:
enforcedConfigLevel 决定配置层级:
global:集群范围的默认值应用于所有命名空间(不允许覆盖命名空间配置)namespace:允许通过各个命名空间中的 ConfigMap 覆盖命名空间级别的配置
在 TektonConfig 中配置
启用 Pruner 会立即删除其涵盖的每个命名空间中的运行。启用之前,请阅读命名空间配置中推荐设置的警告,并按照其中的步骤操作。
在 TektonConfig 资源中,Pruner 的配置大致如下:
namespaces 下的值不能超过相应的根级别值(ttlSecondsAfterFinished、historyLimit、successfulHistoryLimit、failedHistoryLimit);超出这些值的配置将被拒绝。请参阅验证规则。
重要:Tekton Pruner 是一种 event-based pruner,默认处于禁用状态。要启用 event-based pruner,现有的 job-based pruner 必须处于禁用状态。
- 两个 pruner(
job-based和event-based)不能同时启用 event-basedpruner 会实时响应资源事件,从而提供更高效的清理
如果您希望使用 job-based pruner,请参阅定期清理 TaskRun 和 PipelineRun 资源。
YAML 字段说明:
spec.pruner:此部分包含job-basedpruner 的配置。disabled:是否禁用job-basedpruner。
spec.tektonpruner:此部分包含event-basedpruner 的配置。disabled:是否禁用event-basedpruner。enforcedConfigLevel:决定配置层级。有关详细信息,请参阅命名空间配置。global:集群范围的默认值应用于所有命名空间(不允许覆盖命名空间配置)。namespace:允许通过各个命名空间中的 ConfigMap 覆盖命名空间级别的配置。
ttlSecondsAfterFinished:在清理之前保留已完成运行的时间(以秒为单位)。有关详细信息,请参阅基于时间的清理(TTL)。historyLimit:每种状态要保留的运行的最大数量(分别应用于成功和失败的运行)。有关详细信息,请参阅基于历史记录的清理。successfulHistoryLimit:要保留的成功运行的最大数量。有关详细信息,请参阅基于历史记录的清理。failedHistoryLimit:要保留的失败运行的最大数量。有关详细信息,请参阅基于历史记录的清理。namespaces:为特定命名空间配置不同的默认清理策略。有关详细信息,请参阅命名空间配置。options:Tekton Pruner 控制器的选项。有关更详细的支持信息,请参阅作为选项的其他字段。