启用内置 Tekton Hub

概述

从 v4.12.0 开始,内置的 Tekton Hub 不再默认部署,未来的发布版本(包括 LTS 版本)也不会默认部署它。Tekton catalog 产物现在由平台独立的 ArtifactHub 组件提供。ArtifactHub 有自己的生命周期,因此 catalog 更新——新工具、Task 修复、版本升级——可以更快地交付,并且不依赖于 operator 的发布节奏。

operator 仍然完全支持将内置 Tekton Hub 作为过渡性选项进行部署。本指南介绍如何启用它、如何在 operator 升级期间保持其正常运行,以及新的默认行为会如何影响现有环境。

本节中的其他指南(例如 Tekton Hub 配置 和 自定义 Catalog)默认假定已按照本指南启用了内置 Tekton Hub。

开关的工作原理

operator 是否部署内置 Tekton Hub 由一个 operator 级别的开关控制:tekton-operator 命名空间中 tekton-config-defaults ConfigMap 里的 AUTOINSTALL_TEKTONHUB 键。默认值为 "false"。

只有同时满足以下两个条件时,operator 才会部署内置 Tekton Hub:

  • TektonConfig CR 使用 profile: all。
  • AUTOINSTALL_TEKTONHUB 设置为 "true"。

当开关关闭时(默认状态),operator 会确保 TektonHub CR 不存在——任何已部署的内置 Tekton Hub 都会被主动移除。

WARNING

在开关关闭的情况下,operator 会主动删除 TektonHub CR。手动应用 TektonHub manifest 也无济于事——operator 会再次将其移除。因此,必须先打开该开关。

启用内置 Tekton Hub

开关值会注入到 operator 的环境变量中,而这不会热重载——修改 ConfigMap 后必须重启 operator Pod。

# 1) Turn the switch on
$ kubectl -n tekton-operator patch configmap tekton-config-defaults \
    --type merge -p '{"data":{"AUTOINSTALL_TEKTONHUB":"true"}}'

# 2) Restart the operator so it re-reads the environment
$ kubectl -n tekton-operator delete pod -l name=tekton-operator

# 3) The operator creates the TektonHub CR for a profile=all TektonConfig shortly
#    after the restart. If the command below reports NotFound, the CR has not been
#    created yet — wait a moment and re-run it.
$ kubectl wait --for=condition=Ready tektonhub/hub --timeout=600s
NOTE

请使用 kubectl delete pod 重启 operator,而不是 kubectl rollout restart:在 OLM 管理的集群上,OLM 会撤销 rollout restart 在 Deployment 上设置的重启注解,因此 operator Pod 永远不会被重新创建。删除 Pod 在所有场景下都会生效。ConfigMap 中的值本身不会被 OLM 撤销。

将 Catalog 固定到升级前的镜像

operator bundle 不再包含 catalog 引用的工具镜像(例如 buildah、golang、maven 等)。因此,新 catalog 中引用的工具镜像版本可能并不存在于你的环境中。对于 air-gapped 安装尤其如此,因为新版本的镜像同步列表中不再包含这些工具镜像。另一方面,你的升级前 catalog 中引用的工具镜像是可以保证存在的,因为它们是与之前的版本一起同步的。

因此,在升级后重新启用内置 Tekton Hub 时,建议将 catalog 固定到升级前的 catalog 镜像,以确保升级不会影响你现有的 pipeline。

步骤 1——升级前,记录当前的 catalog 镜像:

$ kubectl -n tekton-pipelines get deployment tekton-hub-api \
    -o jsonpath='{.spec.template.spec.initContainers[?(@.name=="catalog-sidecar")].image}'

步骤 2——升级后,按照上面的说明启用该开关,然后通过 TektonConfig CR 固定已记录的镜像:

apiVersion: operator.tekton.dev/v1alpha1
kind: TektonConfig
metadata:
  name: config
spec:
  profile: all
  hub:
    options:
      deployments:
        tekton-hub-api:                   # deployment name, must match exactly
          spec:
            template:
              spec:
                initContainers:
                  - name: catalog-sidecar # init container name, must match exactly
                    image: <catalog-image-recorded-before-the-upgrade>
WARNING

这两个名称都必须完全匹配,并且它们的失败方式不同:不匹配的 deployment 名称会被静默忽略,而不匹配的 init container 名称不会覆盖 catalog-sidecar——它会新增一个 init container 到 deployment 中,这可能导致 Pod 无法启动。为此目的,spec.hub 下除 options 之外的其他子字段不被接受。

升级会移除什么,哪些会保留

当你升级到 v4.12.0 或更高版本且开关关闭时(默认状态):

  • TektonHub CR 和所有内置 Tekton Hub 工作负载都会被移除。TektonConfig CR 会保持 Ready 状态。
  • 随 catalog 一起导入到 kube-public 命名空间中的 Task overview-template ConfigMap 会与 Tekton Hub 一起被移除。
  • kube-public 命名空间中的工具镜像 ConfigMap(catalog-tool-image-*)和邮件模板 ConfigMap 会被保留。它们将继续指向升级前的工具镜像地址,而这些地址在你的 registry 中是存在的。
  • 在开关关闭的全新安装中,这些 catalog ConfigMap 都不会被导入。

重新启用内置 Tekton Hub 会恢复 overview-template ConfigMap,并重新应用随新 operator 版本捆绑的 catalog 中的工具镜像 ConfigMap:新 catalog 中存在的条目会被创建或更新为新的工具镜像地址,而只存在于升级前 catalog 中的条目则保持不变。请注意,将 catalog 镜像固定(见上文)会固定 hub 提供的 Task 和 Pipeline 定义;它不会阻止这些 ConfigMap 被刷新。

再次禁用

要恢复默认行为,请将开关重新设置为 "false",并以相同方式重启 operator:

$ kubectl -n tekton-operator patch configmap tekton-config-defaults \
    --type merge -p '{"data":{"AUTOINSTALL_TEKTONHUB":"false"}}'

$ kubectl -n tekton-operator delete pod -l name=tekton-operator

随后,operator 会再次移除已部署的内置 Tekton Hub。