启用代理权限检查和审批门控
Connectors Proxy 中推荐的设置通过默认功能标志设置,确保工具的长期凭据不会进入流水线:工作负载通过 Connectors Proxy 使用短期令牌访问工具,并且对 Connector 具有读取(get)权限即可使用它。本指南在此设置之上增加两个可选控制:
- 代理权限检查(
enable-connector-proxy-permissions):通过Connectors Proxy使用 Connector 时,需要connectors/proxy权限,而不仅仅是对 Connector 的读取权限。 - 审批门控(
enable-connectors-approval):只有在AccessPolicy的检查通过后,敏感 Connector 才会被提供给工作负载,例如同一PipelineRun中已批准的 TektonApprovalTask。
有关相关概念,请参阅 Connectors Permission Model 和 Connectors Approval & Permission Gating。
使用时机
当必须通过平台权限管理通过 Connectors Proxy 使用 Connector 的行为,或者只有在审批通过后才能使用敏感 Connector(例如生产环境的 registry)时,请使用本指南。
开始之前,请考虑其影响:
- 两个标志的默认值均为
"false"。它们位于同一个共享 ConfigMap 中,适用于整个 Connectors 安装,而非单个 Connector 或项目(请参阅 Feature Flags)。请同时启用这两个标志。 - 启用
enable-connectors-approval后,仅具有 Connector 读取权限将不足以挂载它。CSI Driver 会使用动词*检查connectors/proxy权限;仅在connectors/proxy上授予get无法满足该权限。没有该权限的挂载仅包含一个.error.json文件,因此工作负载会失败,而不会接收到配置。 - 同时启用
enable-connector-proxy-permissions后,代理会对每个请求执行相同的检查。 - 每个挂载 Connector 的工作负载都会受到影响,因此请先准备好授权,并按照 Steps 中的顺序操作。
前提条件
-
已安装
ConnectorsCore组件。它会创建用于存储标志的connectors-configConfigMap。 -
你可以编辑
ConnectorsConfig资源。ConnectorsConfig是一个集群单例,因此不要创建第二个。查找现有资源及其命名空间: -
流水线在命名的 ServiceAccount 下运行,以便授权和
AccessPolicy资源可以绑定这些 ServiceAccount。 -
工作负载通过 Connectors CSI Driver 挂载 Connector。
-
对于使用内置
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:为不受审批门控的 Connector 准备授权
列出挂载不受审批门控的 Connector 的 ServiceAccount。为每个 ServiceAccount 授予对这些 Connector 使用 connectors/proxy 权限以及动词 *,此外还要保留它们已有的读取权限。仅在 connectors/proxy 上授予 get 不足以满足 CSI 检查。
Kubernetes RBAC 授权可以随时创建。例如,在 Connector 所在的命名空间中创建以下 Role 和 RoleBinding,可以让 <workload-namespace> 的 builder ServiceAccount 使用 <connector-name> Connector:
不要向将受审批门控的 Connector 授予 connectors/proxy。如果工作负载已经拥有 Connector 的 connectors/proxy 权限,则不需要 AccessRequest(请参阅 AccessRequest),因此审批不会对其进行门控。挂载受审批门控 Connector 的工作负载通过你在步骤 3 中创建的 AccessPolicy 的审批检查获得授权,因此在该 AccessPolicy 存在之前,其挂载会失败。
步骤 2:启用审批门控
将 enable-connectors-approval 设置为 "true":
从现在起,不具有 connectors/proxy 权限的挂载只包含 .error.json。立即继续执行步骤 3,在完成之前不要启动挂载受审批门控 Connector 的运行。
步骤 3:创建 AccessPolicy 资源
在其所保护的 Connector 所在命名空间中创建 AccessPolicy 资源。
对于每个敏感 Connector:
-
查找并移除覆盖该 Connector 的默认和直接
connectors/proxy授权:例如步骤 1 中的 RBAC 授权,以及任何匹配该 Connector 的AccessPolicy的spec.defaultPermission。spec.defaultPermission授权会立即授予代理访问权限,而无需任何审批检查(请参阅 AccessPolicy)。仅当没有其他授权向 Connector 授予代理访问权限时,审批才会对其进行门控。 -
创建一个
AccessPolicy,其审批检查设置approvers,并由管理员维护。如果没有approvers,则PipelineRun中任何已批准的ApprovalTask都足够,因此能够创建或修改流水线的用户可以设置ApprovalTask审批者并批准运行。请参阅限制审批者。例如,以下策略仅在
release-managers组的成员批准后,才会释放prod-harborConnector:
对于流水线在项目中使用且无需审批的项目级 Connector,现在可以通过在 Connector 所在命名空间中使用 AccessPolicy,按项目授予代理使用权限,而不是使用步骤 1 中的 RBAC 授权。通过 cpaas.io/project 命名空间选择器绑定流水线 ServiceAccount(请参阅 AccessPolicy)。该选择器仅匹配项目的成员命名空间;项目自身的命名空间则带有 cpaas.io/inner-namespace 标签(请参阅 Connector Resource Levels and Permissions)。如果工作负载也在项目命名空间中运行,请使用第二个 serviceAccounts 条目显式绑定它们,并在其 namespaceSelector.names 中列出该命名空间:
不要使用此类策略匹配受审批门控的 Connector。
依赖 spec.defaultPermission 之前,请确保它绑定的每个 ServiceAccount 已经拥有对 Connector 所在命名空间中 Connector 的 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,因此请在回滚前审查谁拥有敏感 Connector 的读取权限。