启用代理权限检查和审批门控
Connectors Proxy 中的推荐设置可在默认功能标志设置下,避免将工具的长期凭据暴露在流水线中:工作负载通过 Connectors Proxy 使用短期令牌访问工具,并且只需对 Connector 具有读取(get)权限即可使用。此指南在此设置之上增加两个可选控制:
- 代理权限检查(
enable-connector-proxy-permissions):通过Connectors Proxy使用 Connector 需要connectors/proxy权限,而不仅仅是对 Connector 的读取权限。 - 审批门控(
enable-connectors-approval):只有在AccessPolicy的检查通过后,敏感 Connector 才会提供给工作负载,例如同一PipelineRun中经过批准的 TektonApprovalTask。
有关相关概念,请参阅 Connectors 权限模型 和 Connectors 审批与权限门控。
使用时机
当必须通过平台权限管理通过 Connectors Proxy 使用 Connectors 的行为,或者敏感 Connector(例如生产注册表)只能在审批后使用时,请使用本指南。
开始之前,请考虑以下影响:
- 两个标志的默认值均为
"false"。它们位于同一个共享 ConfigMap 中,并应用于整个 Connectors 安装,而不是单个 Connector 或项目(请参阅功能标志)。请同时启用这两个标志。 - 启用
enable-connectors-approval后,仅具有 Connector 读取权限将不再足以挂载该 Connector。CSI Driver 会使用动词*检查connectors/proxy权限;仅在connectors/proxy上授予get并不能满足该要求。没有该权限的挂载只包含一个.error.json文件,因此工作负载会失败,而不会收到配置。 - 同时启用
enable-connector-proxy-permissions后,代理会对每个请求执行相同的检查。 - 所有挂载 Connectors 的工作负载都会受到影响,因此请先准备好授权,并按照步骤中的顺序操作。
前提条件
-
已安装
ConnectorsCore组件。它会创建用于存储标志的connectors-configConfigMap。 -
你可以编辑
ConnectorsConfig资源。ConnectorsConfig是一个集群单例,因此不要创建第二个。查找现有资源及其命名空间: -
流水线在命名的 ServiceAccount 下运行,因此授权和
AccessPolicy资源可以绑定这些 ServiceAccount。 -
工作负载通过 Connectors CSI Driver 挂载 Connectors。
-
对于使用内置
connectors-approvals-in-pipeline检查的审批,每个使用审批门控 Connector 的流水线都必须在同一PipelineRun中拥有一个 TektonApprovalTask,且位于挂载 Connector 的任务之前。
步骤
请按此顺序操作。启用 enable-connectors-approval 后,挂载的行为会立即改变;而 AccessPolicy 准入 Webhook 会在该标志处于禁用状态时拒绝新的 AccessPolicy 资源。因此,应先处理不依赖 AccessPolicy 的授权,然后立即在该标志之后创建 AccessPolicy 资源。
仅按照更新功能标志中的说明,在 ConnectorsConfig 中更改标志。不要直接编辑 connectors-config ConfigMap 或受管理的 ConnectorsCore 资源。在以下命令中,将 <name> 和 <namespace> 替换为 kubectl get connectorsconfig -A 中的值。
步骤 1:为不受审批门控的 Connectors 准备授权
列出挂载不会受审批门控的 Connectors 的 ServiceAccount。为每个 ServiceAccount 授予对这些 Connector 使用动词 * 的 connectors/proxy 权限,同时保留其已有的读取权限。仅在 connectors/proxy 上授予 get 并不能满足 CSI 检查。
Kubernetes RBAC 授权可以随时创建。例如,在 Connector 所在的命名空间中创建以下 Role 和 RoleBinding 后,<workload-namespace> 的 builder ServiceAccount 便可以使用 <connector-name> Connector:
不要对将受审批门控的 Connectors 授予 connectors/proxy。已经具有 Connector 的 connectors/proxy 权限的工作负载不需要任何 AccessRequest(请参阅 AccessRequest),因此审批不会对其形成门控。挂载审批门控 Connector 的工作负载通过你在步骤 3 中创建的 AccessPolicy 的审批检查获得授权,因此在该 AccessPolicy 存在之前,其挂载会失败。
步骤 2:启用审批门控
将 enable-connectors-approval 设置为 "true":
从现在开始,没有 connectors/proxy 权限的挂载只包含 .error.json。立即继续执行步骤 3,在完成之前不要启动挂载审批门控 Connectors 的运行。
步骤 3:创建 AccessPolicy 资源
在其所保护的 Connectors 所在命名空间中创建 AccessPolicy 资源。
对于每个敏感 Connector:
-
查找并移除覆盖该 Connector 的默认和直接
connectors/proxy授权:例如步骤 1 中的 RBAC 授权,以及任何与其匹配的AccessPolicy的spec.defaultPermission。spec.defaultPermission授权会立即授予代理访问权限,而不会执行任何审批检查(请参阅 AccessPolicy)。只有在没有其他授权向 Connector 授予代理访问权限时,审批才会对其形成门控。 -
创建一个
AccessPolicy,其审批检查会设置由管理员维护的approvers。如果没有approvers,PipelineRun中任何已批准的ApprovalTask都足够,因此能够创建或修改流水线的用户可以设置ApprovalTask审批者并批准运行。请参阅限制可审批者。例如,以下策略仅在
release-managers组的成员批准后,才会释放prod-harborConnector:
对于项目级 Connectors,如果项目的流水线无需审批即可使用这些 Connectors,现在可以在 Connector 所在的命名空间中使用 AccessPolicy 按项目授予代理使用权限,而不是使用步骤 1 中的 RBAC 授权。通过 cpaas.io/project 命名空间选择器绑定流水线 ServiceAccount(请参阅 AccessPolicy)。该选择器仅匹配项目的成员命名空间;项目自身的命名空间则带有 cpaas.io/inner-namespace 标签(请参阅 Connector 资源级别和权限)。如果工作负载也在项目命名空间中运行,请使用第二个 serviceAccounts 条目显式绑定它们,并在其 namespaceSelector.names 中列出该命名空间:
不要使用此类策略匹配审批门控 Connector。
依赖 spec.defaultPermission 之前,请确保其绑定的每个 ServiceAccount 已经拥有对 Connector 所在命名空间中 Connectors 的 get 权限;仅限于特定 Connector 名称的授权是不够的。没有该权限的 ServiceAccount 不会被加入生成的 RoleBinding,而 AccessPolicy 仍会报告 Ready,只有控制器日志会记录被跳过的主体。
步骤 4:启用代理权限检查
将 enable-connector-proxy-permissions 设置为 "true":
随后,代理会对每个请求执行相同的 connectors/proxy 检查。
验证
- 运行一个挂载未启用审批门控的 Connector 的流水线。挂载内容包含配置文件。
- 运行一个使用启用审批门控的 Connector 的流水线。当其
ApprovalTask处于待处理状态时,挂载 Connector 的任务会等待。指定的审批者批准后,挂载内容包含配置文件。
未授权的挂载仅包含 .error.json,由于没有配置,工作负载随后会失败。当 ApprovalTask 被拒绝时,PipelineRun 中位于其后的任务不会运行。要查找未授权挂载的原因:
- 使用
ls -A列出挂载路径,并读取.error.json。 - 使用
kubectl describe pod <pod-name> -n <workload-namespace>检查 Pod 的事件。 - 检查 Pod 对应
AccessRequest的条件。AccessPolicyMatched条件中的原因NoAccessPolicyMatched表示没有任何AccessPolicy与该请求匹配,因此工作负载没有获得 Connector 的授权。有关其他条件和原因,请参阅 AccessRequest 和 Connectors Approval & Permission Gating。
回滚
在 ConnectorsConfig 中将两个标志都设置回 "false":
禁用两个标志后,审批流程将不再生效,通过 Connectors Proxy 使用 Connector 时,再次只需拥有读取权限。此时,任何对启用审批门控的 Connector 具有读取权限的工作负载都可以使用它们,因此请在回滚前检查哪些主体拥有敏感 Connector 的读取权限。