部署 Manual Approval Gate
目录
功能概述使用场景前提条件步骤1. 创建ManualApprovalGate CR2. 验证 controller 健康状况3. 重新配置或强制执行滚动更新4. 卸载 Manual Approval Gate操作结果故障排除推荐设置了解更多功能概述
Manual Approval Gate 提供支持 ApprovalTask 自定义任务的集群范围 controller 和 webhook。管理员必须创建并维护 ManualApprovalGate custom resource(CR),以便平台用户可以在其流水线中插入手动审批。本指南介绍如何在 tekton-pipelines 中部署 Manual Approval Gate 组件、自定义运行时选项,以及如何安全地卸载该组件。
使用场景
- 通过配置托管 controller,为集群中的所有团队启用手动审批。
- 通过 Operator 的
optionscontract 调整 controller 部署(例如副本数、资源限制或 ConfigMap),而不是编辑 manifests。 - 不再需要审批任务时清理该功能。
前提条件
Alauda DevOps Pipelinesv4.7.0 或更高版本,并具有 cluster-admin 访问权限。kubectl已配置为连接目标集群。
步骤
1. 创建 ManualApprovalGate CR
将 manifest 保存为 manual-approval-gate.yaml 并应用:
spec.targetNamespace决定创建 controller 部署、webhook 和 ConfigMap 的位置。我们建议使用tekton-pipelines,以便该组件与其他 Tekton 服务相邻,但你可以将其指向任意 namespace,前提是该 namespace 在应用 CR 之前已存在(或已创建)。如果选择其他 namespace,请在下面的命令和检查中将tekton-pipelines替换为该 namespace。- 使用
spec.options可以覆盖 Deployment、ConfigMap 或镜像字段,而无需编辑生成的 YAML。有关详细语法,请参阅调整子组件的可选配置项。
2. 验证 controller 健康状况
CR 的 READY condition 必须报告 True,并且你应能看到 controller 和 webhook Deployment 正在 tekton-pipelines 中运行。
3. 重新配置或强制执行滚动更新
-
修补 CR 以调整副本数或其他选项;Operator 会自动滚动更新工作负载:
-
检查 Operator 是否已将该值应用到 Deployment,然后等待滚动更新完成。第一条命令必须打印
spec.options中的值(上文的2);第二条命令会在滚动更新完成后返回,并打印deployment "manual-approval-gate-controller" successfully rolled out: -
若要撤销某个选项,请在
spec.options中显式设置之前的值(例如"replicas":1),并按照上文所示等待滚动更新完成,然后再移除该条目。仅移除条目会使最后应用的值保持不变。
4. 卸载 Manual Approval Gate
删除 CR 也会删除集群中的每个 ApprovalTask。删除 CR 之前,请列出所有 namespace 中的 ApprovalTask 对象及其状态,并确保没有对象仍处于 pending 状态。普通的 kubectl get approvaltasks -A 不会显示状态,因此请将其作为一列打印:
STATE 列显示 pending、approved 或 rejected。
已完成的 ApprovalTask 对象是记录谁批准了运行的唯一凭据(请参阅推荐设置)。删除 CR 之前,请导出必须保留的对象,例如导出全部对象:
然后删除 CR,并检查其 Deployment 是否已消失:
删除 CR 会移除 Manual Approval Gate 的 Deployment、Service 和 Webhook。它还会删除 approvaltasks.openshift-pipelines.org CRD,以及集群中的每个 ApprovalTask。重新创建 CR 会再次安装 CRD。
操作结果
kubectl get manualapprovalgates显示具有READY=True、VERSION=<release>和空REASON的实例。REASON列显示Ready条件的消息;实例就绪时该消息为空。kubectl get pods -n tekton-pipelines | grep manual-approval-gate列出状态为Running的 controller 和 webhook Pod。- 删除后,
kubectl get pods,services -n tekton-pipelines | grep manual-approval不输出任何内容,并且approvaltasks.openshift-pipelines.orgCRD 和每个ApprovalTask都已被删除。重新创建 CR 会再次安装 CRD。
故障排除
ManualApprovalGateCR 显示READYFalse:REASON列显示Ready条件的消息,例如Installer set not ready: <message>。运行kubectl describe manualapprovalgate manual-approval-gate检查事件,然后查看 Operator 日志(kubectl logs -n tekton-operator deploy/tekton-operator --all-containers)。spec.options中拼写错误的字段或权限不足是最常见的根本原因。- Controller/webhook Pod 反复崩溃重启:读取失败 Pod 中最后一个失败容器的日志,例如
kubectl logs <pod-name> -n tekton-pipelines --previous,以确认进程读取的 TLS Secret 或 ConfigMap 是否缺失。重新应用未发生变化的 CR 不会改变这一情况,并且 Operator 会根据其 Deployment、StatefulSet、ClusterRole、ClusterRoleBinding 和 ServiceAccount 的事件协调已安装的对象,而不是根据 ConfigMap 或 Secret 的事件进行协调,因此不要期待重新应用会重新创建缺失的对象。下次协调已安装对象时,Operator 会再次创建安装所需的缺失 ConfigMap 或 Secret;已安装对象的协调可由所列类型之一的事件触发,例如反复崩溃重启的 Deployment 的状态变化。对象恢复且 Pod 已重启后,kubectl get pods -n tekton-pipelines | grep manual-approval-gate会列出状态为Running的 controller 和 webhook Pod。 - 未创建
ApprovalTask资源:确保ManualApprovalGateCR 仍存在且具有READY=True。如果 CR 已被删除或运行失败,请先重新安装,然后再让用户重新运行流水线。
推荐设置
启用时机。当发布必须记录批准者(例如在发布到生产环境之前)时,部署 Manual Approval Gate。Controller 和 webhook 作用域为集群级别,可为每个命名空间提供服务,因此平台管理员应为整个集群安装一个 ManualApprovalGate CR。
推荐值。按照步骤部分中的说明,使用 spec.targetNamespace: tekton-pipelines 创建单个 manual-approval-gate CR,并且只能通过 spec.options 更改运行时设置。对于流水线作者添加的批准步骤(请参阅 Tekton Pipelines 的手动批准门),使用 用户和组标识符 中描述的规范标识符,将批准者声明为指定用户或组(group:<name>)。根据发布策略设置 numberOfApprovalsRequired(用法示例使用 "1");每个批准组成员计为一次批准。设置 PipelineRun.spec.timeouts.pipeline 和 PipelineRun.spec.timeouts.tasks 时,应涵盖批准步骤之前运行的任务、完整的批准窗口(批准步骤 timeout,例如 "24h")以及批准步骤之后运行的任务:两者都从 PipelineRun 开始时(status.startTime)开始计时,而 timeouts.tasks 涵盖所有非 finally 任务(请参阅 PipelineRuns 的超时部分)。例如,对两者都设置 72h,可为 "24h" 批准步骤前后的其他任务预留 48 小时。如果还设置了 timeouts.finally,请将 timeouts.pipeline 设置为至少 timeouts.tasks 加上 timeouts.finally。如果批准步骤处于等待状态时 PipelineRun 超时,Tekton 会取消批准步骤,但在自 ApprovalTask 创建后经过批准超时(步骤的 CustomRun 的 spec.timeout,如果该字段为空则为 60 分钟)之前,ApprovalTask 仍保持 pending;随后 Controller 会将其标记为 rejected,并使 CustomRun 失败,即使没有人拒绝批准。处理待批准项之前,请检查 PipelineRun 状态;Tekton Pipelines 的手动批准门 介绍了 CustomRun 持有的值。从 ApprovalTask 的 status.approversResponse 中读取批准记录。ApprovalTask 会与其 PipelineRun 一起被删除。Tekton Results 会存储 PipelineRun、TaskRun 和 CustomRun,但不会存储 ApprovalTask 对象;批准步骤中存储的 CustomRun 会保留其最终状态,而不会记录批准者,因此如果必须保留更长时间,请在运行被清理之前导出该记录。
前提条件。Alauda DevOps Pipelines v4.7.0 或更高版本,以及创建 ManualApprovalGate CR 的集群范围权限,例如 cluster-admin(命名空间级别的 admin 无法创建它)。批准者必须能够在运行批准步骤的命名空间中 patch approvaltasks.openshift-pipelines.org 资源。批准者的用户名和组名必须与平台 Identity Provider 公开的标识符匹配。