资源组

使用选择器将不同的修剪策略应用于不同的 PipelineRuns/TaskRuns 集合。

重要:选择器仅适用于命名空间级 ConfigMap(tekton-pruner-namespace-spec)。在全局配置中,namespaces.<namespace> 下的选择器会被拒绝;请参阅ConfigMap 验证。

必须使用命名空间级别:命名空间 ConfigMap,以及本页中的每个选择器组,仅在应用于其命名空间的 enforcedConfigLevel 为 namespace 时才会生效:如果 TektonConfig 的 spec.tektonpruner.global-config.namespaces.<namespace> 条目设置了值,则使用该值;否则使用 spec.tektonpruner.global-config.enforcedConfigLevel(请参阅命名空间配置)。global 是 Operator 默认值(没有 enforcedConfigLevel 的 global-config 会回退到 resource):在 namespace 之外的任何级别,webhook 仍会接受命名空间 ConfigMap,但 Pruner 会忽略它。

WARNING

命名空间级 ConfigMap 不在 TektonConfig 生命周期管理范围内。如果之后需要备份或恢复 Tekton 配置,请单独保存这些 ConfigMap。

工作原理

  • 按 PipelineRuns/TaskRuns 上的标签或注解匹配
  • 首个匹配项优先:组按顺序评估;其选择器与某个运行匹配的第一个组决定该运行的值。如果 ConfigMap 包含 name 条目,则会先检查该运行的 Pipeline 或 Task 的此条目
  • 回退:未匹配的资源,以及匹配组未设置的字段,使用命名空间或全局默认值
  • 共享计数:组的历史记录限制会统计与该组选择器匹配的每个运行,包括先被更早组匹配的运行。当某个运行完成且没有组匹配,或其组未设置该历史记录限制时,应用命名空间范围的历史记录限制;该限制会统计所有组的运行,并删除较早的运行,而不考虑其所属组的限制(请参阅基于历史记录的修剪)
  • 组的历史记录限制:对于每种类型(pipelineRuns、taskRuns),webhook 会将各组的 successfulHistoryLimit 值之和限制在命名空间 ConfigMap 顶层 successfulHistoryLimit 以内;如果未设置,则使用其顶层 historyLimit,再否则使用全局配置中的内联 namespaces.<namespace> 条目,之后是全局值,最后是 100;failedHistoryLimit 的工作方式相同(请参阅Pipeline 特定限制)。顶层值本身会根据全局值进行检查,但顶层 historyLimit 仅根据全局 historyLimit 进行检查(未设置时为 100)。因此,只有当全局 historyLimit 不高于该值时,全局 successfulHistoryLimit(或 failedHistoryLimit)才会限制总和,如推荐设置中所述;否则,顶层 historyLimit 可以将上限提高到全局 historyLimit
  • 位置:必须位于命名空间 ConfigMap 中,而不是全局 ConfigMap

下面设置历史记录限制的示例需要最多 55 个成功运行(多层原生应用:10 + 15 + 30)。仅当上限至少等于该总和时,webhook 才会接受这些设置,例如在 Operator 默认全局配置(historyLimit: 100,没有 successfulHistoryLimit)下。在推荐设置的全局值(successfulHistoryLimit: 5、historyLimit: 5)下,webhook 会拒绝其中每一个,并显示包含 sum of selector successfulHistoryLimit (<sum>) cannot exceed upper bound (5) 的消息。请将全局值提高到至少所需的总和,或降低组值。

选择器类型

标签选择器:

apiVersion: v1
kind: ConfigMap
metadata:
  name: tekton-pruner-namespace-spec
  namespace: my-app
  labels:
    app.kubernetes.io/part-of: tekton-pruner
    pruner.tekton.dev/config-type: namespace
data:
  ns-config: |
    pipelineRuns:
      - selector:
          - matchLabels:
              environment: production
              tier: frontend
        ttlSecondsAfterFinished: 604800
        successfulHistoryLimit: 10

注解选择器:

data:
  ns-config: |
    pipelineRuns:
      - selector:
          - matchAnnotations:
              tekton.dev/release: "true"
        ttlSecondsAfterFinished: 2592000

混合选择器(标签和注解必须同时匹配):

data:
  ns-config: |
    pipelineRuns:
      - selector:
          - matchLabels:
              app: myapp
            matchAnnotations:
              critical: "true"
        successfulHistoryLimit: 50

常见模式

按 Pipeline 类型:

apiVersion: v1
kind: ConfigMap
metadata:
  name: tekton-pruner-namespace-spec
  namespace: my-app
  labels:
    app.kubernetes.io/part-of: tekton-pruner
    pruner.tekton.dev/config-type: namespace
data:
  ns-config: |
    ttlSecondsAfterFinished: 3600
    pipelineRuns:
      - selector:
          - matchLabels:
              pipeline-type: build
        ttlSecondsAfterFinished: 300
      - selector:
          - matchLabels:
              pipeline-type: test
        ttlSecondsAfterFinished: 3600
      - selector:
          - matchLabels:
              pipeline-type: release
        ttlSecondsAfterFinished: 604800
        successfulHistoryLimit: 20

按环境:

data:
  ns-config: |
    pipelineRuns:
      - selector:
          - matchLabels:
              env: dev
        ttlSecondsAfterFinished: 300
      - selector:
          - matchLabels:
              env: staging
        ttlSecondsAfterFinished: 86400
      - selector:
          - matchLabels:
              env: prod
        ttlSecondsAfterFinished: 604800

按重要性:

data:
  ns-config: |
    pipelineRuns:
      - selector:
          - matchLabels:
              critical: "true"
        ttlSecondsAfterFinished: 2592000
        successfulHistoryLimit: 50
      - selector:
          - matchLabels:
              critical: "false"
        ttlSecondsAfterFinished: 3600
        successfulHistoryLimit: 3

顺序很重要

首个匹配项优先:选择器按从最具体到最不具体的顺序排列:

data:
  ns-config: |
    pipelineRuns:
      - selector:
          - matchLabels:
              env: prod
              critical: "true"
        ttlSecondsAfterFinished: 2592000
      - selector:
          - matchLabels:
              env: prod
        ttlSecondsAfterFinished: 604800
      - selector:
          - matchLabels:
              app: myapp
        ttlSecondsAfterFinished: 3600

最佳实践

  1. 对基于选择器的组使用命名空间 ConfigMap
  2. 按选择器的具体程度排序,从最具体到最不具体(首个匹配项优先)
  3. 对于需要独立历史记录限制的组,使用不同的标签值(例如 tier: frontend 和 tier: backend):组会统计与其选择器匹配的每个运行,包括之前被其他组匹配的运行
  4. 在生产环境使用前进行测试:运行完成后,其 pruner.tekton.dev/ttlSecondsAfterFinished 注解会显示 Pruner 为其选择的 TTL(命令以及意外值的原因请参阅Pipeline 特定 TTL)。组的历史记录限制不会在运行中留下此类值(请参阅 Pipeline 特定限制)

高级配置

多层原生应用

data:
  ns-config: |
    pipelineRuns:
      - selector:
          - matchLabels:
              tier: frontend
        ttlSecondsAfterFinished: 604800
        successfulHistoryLimit: 10
      - selector:
          - matchLabels:
              tier: backend
        ttlSecondsAfterFinished: 1209600
        successfulHistoryLimit: 15
      - selector:
          - matchLabels:
              tier: database
        ttlSecondsAfterFinished: 2592000
        successfulHistoryLimit: 30

发布类型

data:
  ns-config: |
    pipelineRuns:
      - selector:
          - matchLabels:
              release-type: feature
        ttlSecondsAfterFinished: 604800
      - selector:
          - matchLabels:
              release-type: hotfix
        ttlSecondsAfterFinished: 2592000
      - selector:
          - matchLabels:
              release-type: major
        ttlSecondsAfterFinished: 7776000

如果 Tekton Results 存储这些运行,请将其保留期设置得长于此处最长的 TTL(请参阅与集群内修剪的关系)。

为 Pipeline 添加标签

为 PipelineRuns 添加标签以进行分组:

apiVersion: tekton.dev/v1
kind: PipelineRun
metadata:
  generateName: my-pipeline-
  labels:
    pipeline-type: release
    env: prod
    critical: "true"
spec:
  pipelineRef:
    name: my-pipeline

相关内容