部署 Manual Approval Gate

功能概述

Manual Approval Gate 提供支持 ApprovalTask 自定义任务的集群范围 controller 和 webhooks。管理员必须创建并维护 ManualApprovalGate 自定义资源(CR),以便平台用户可以在其流水线中插入手动审批。本指南介绍如何在 tekton-pipelines 中部署 Manual Approval Gate 组件、自定义运行时选项,以及安全地卸载该组件。

使用场景

  • 通过配置受管 controller,为集群中的所有团队启用手动审批。
  • 通过 Operator 的 options contract 调整 controller 部署(例如副本数、资源限制或 ConfigMaps),而无需编辑 manifests。
  • 不再需要审批任务时清理该功能。

先决条件

  • Alauda Container Platform Pipelines v4.6.0 或更高版本,并具有 cluster-admin 访问权限。
  • 已针对目标集群配置 kubectl。

步骤

1. 创建 ManualApprovalGate CR

将 manifest 保存为 manual-approval-gate.yaml 并应用:

apiVersion: operator.tekton.dev/v1alpha1
kind: ManualApprovalGate
metadata:
  name: manual-approval-gate
spec:
  targetNamespace: tekton-pipelines
  options:
    disabled: false
kubectl apply -f manual-approval-gate.yaml
  • spec.targetNamespace 决定创建 controller 部署、webhooks 和 ConfigMaps 的位置。我们建议使用 tekton-pipelines,这样该组件会与其他 Tekton 服务相邻,但也可以将其指向任意 namespace,前提是该 namespace 在应用 CR 前已存在(或已创建)。
  • 使用 spec.options 覆盖 Deployments、ConfigMaps 或镜像字段,而无需编辑生成的 YAML。有关详细语法,请参阅调整子组件的可选配置项。

2. 验证 controller 健康状况

$ kubectl get manualapprovalgates.operator.tekton.dev manual-approval-gate

NAME                   VERSION          READY   REASON
manual-approval-gate   v0.7.0-4f10729   True
$ kubectl get deployment -n tekton-pipelines | grep manual-approval-gate

manual-approval-gate-controller     1/1     1            1           1h1m
manual-approval-gate-webhook        1/1     1            1           1h1m

CR 的 READY condition 必须报告 True,并且应看到 controller 和 webhook Deployments 在 tekton-pipelines 中运行。

3. 重新配置或强制执行滚动更新

  • 修补 CR 以调整副本数或其他选项;Operator 会自动滚动更新工作负载:

    kubectl patch manualapprovalgate manual-approval-gate \
      --type merge \
      --patch '{"spec":{"options":{"deployments":{"manual-approval-gate-controller":{"spec":{"replicas":2}}}}}}'

4. 卸载 Manual Approval Gate

$ kubectl delete manualapprovalgate manual-approval-gate
$ kubectl get deployment -n tekton-pipelines | grep manual-approval-gate

CRD 会继续安装,以便稍后重新创建 CR,但 Deployments、Services 和 Webhooks 应会消失。

操作结果

  • kubectl get manualapprovalgates 显示该实例,其中 READY=True、VERSION=<release> 和 REASON 为空或为 Installed。
  • kubectl get pods -n tekton-pipelines | grep manual-approval-gate 列出状态为 Running 的 controller 和 webhook pods。
  • 删除后,不会再有带有相同标签的 pods 或 services,且在重新创建 CR 之前,Operator 会停止协调 ApprovalTask 资源。

故障排除

  • ManualApprovalGate CR 卡在 NotReady 状态:运行 kubectl describe manualapprovalgate manual-approval-gate 检查事件,然后查看 Operator 日志(kubectl logs -n tekton-operator deploy/tekton-operator)。spec.options 中字段拼写错误或权限不足是最常见的根本原因。
  • Controller/webhook pods 反复崩溃重启:在 tekton-pipelines 中描述失败的 pods,以确认是否缺少 TLS secrets 或 configuration maps。重新应用 CR 通常会自动重新创建这些资源。
  • 未创建 ApprovalTask 资源:确保 ManualApprovalGate CR 仍然存在并具有 READY=True。如果 CR 已被删除或出现故障,请先重新安装,然后再让用户重新运行 pipelines。

了解更多