AccessPolicy

概述

AccessPolicy 是一种命名空间范围的资源,用于控制谁可以通过 Connectors Proxy 使用 Connectors。

它定义了三项内容:

  • 策略涵盖哪些 Connectors
  • 默认授予代理访问权限,还是仅在检查通过后授予访问权限
  • 哪些主体适用此访问模型

在 Connectors Approval 模型中,AccessPolicy 是策略定义,而实际的运行时请求则由 AccessRequest 单独跟踪。

INFO

请在阅读 Connectors Approval & Permission Gating 后阅读本文档。

本文档重点介绍管理员设计的长期规则:

  • 涵盖哪些 Connectors
  • 哪些主体应获得默认代理访问权限
  • 授予临时代理访问权限前必须通过哪些检查

本文档不会重复介绍某个工作负载的完整运行时生命周期。相关内容请参阅 AccessRequest。

INFO

在此模型中,使用 connector 是指通过 Connectors Proxy 使用 connector 的无密钥访问路径,可以直接使用,也可以通过 Connectors CSI Driver 使用。

AccessPolicy 不控制 Connectors API 访问权限。Connectors API 使用独立的 connectors/apis 权限,这些权限通常用于 UI 资源发现或其他基于 API 的集成。

可用性

AccessPolicy 是 Connectors Approval 功能的一部分。

使用前,请启用:

  • enable-connectors-approval
  • enable-connector-proxy-permissions

有关更多信息,请参阅 Feature Flags。

了解 AccessPolicy

“使用 Connector”的含义

AccessPolicy 关注的是代理访问,而不是读取 Connector 对象或通过 Connectors API 浏览资源。

使用 connector 的典型示例包括:

  • 工作负载向 Connector 的代理地址发送请求
  • Pod 通过 Connectors CSI Driver 挂载 Connector 配置,然后通过代理使用目标工具
  • 流水线工作负载仅在审批通过后,获得使用敏感 Connector 的临时权限

以下典型示例不属于 AccessPolicy 的范围:

  • 读取 Connector 对象本身
  • 通过 Connectors API 浏览分支、标签或其他面向 UI 的资源
  • 向平台用户授予 Connectors APIs 权限

AccessPolicy 的工作原理

AccessPolicy 位于 Connector 定义与运行时访问之间:

  • Connector:定义如何访问目标工具以及如何向其进行身份验证
  • AccessPolicy:选择 Connectors,并定义谁可以通过这些 Connectors 提供的 Connectors Proxy 访问目标工具
  • AccessRequest:记录一次需要进行面向审批评估的运行时访问尝试
  • 生成的 Role 和 RoleBinding:系统根据策略模板创建的已实例化 RBAC 对象

如果你首先需要了解这些组件如何协同工作的端到端概览,请参阅 Connectors Approval & Permission Gating。本文档将重点放在策略设计和策略匹配上。

从高层次来看,流程如下:

  1. 工作负载尝试通过 Connectors Proxy 或 Connectors CSI Driver 使用 Connector。
  2. 系统评估匹配的 AccessPolicy。
  3. 如果策略使用 defaultPermission,且工作负载的 ServiceAccount 在涵盖范围内,则允许访问。
  4. 如果策略使用 checkGrantedPermission,系统会在 AccessRequest 中跟踪运行时尝试,并仅在检查通过后授予配置的代理权限。

有关运行时请求的资源架构,请参阅 AccessRequest API Reference。

两种访问模型

对于一个 Connector,AccessPolicy 通常使用以下两种代理访问模型之一:

  • Granting Default Proxy Access 与 defaultPermission:匹配的 ServiceAccounts 可以立即通过 Connector 代理访问目标工具
  • Granting Access After Approval 与 checkGrantedPermission:运行时请求必须通过检查后,才会授予代理权限

实际上,这意味着通过一个 Connector 的访问通常只有两种情况:在已知范围内始终允许,或针对敏感使用场景受审批控制。接下来的两个部分将首先介绍这两种模型,后续的 常见配置模式 部分将说明如何将它们限定到特定的 Connectors 和 ServiceAccounts。

授予默认代理访问权限

spec.defaultPermission 是策略中立即授予代理访问权限、无需任何审批检查的部分。

以下情况通常适合使用此方式:

  • Connector 在命名空间或项目内的风险较低
  • 一个范围内的所有工作负载都应直接通过 Connector 代理访问目标工具
  • 需要稳定、非临时的权限模型

在大多数情况下,内置的 connectors-use-connectors-proxy 模板是合适的起点。它是由核心 Connectors 组件安装的角色模板,可为匹配的 Connector 授予 connectors/proxy 权限。

当 Connector 应始终可在命名空间、项目或集群范围内使用时,通常只需在策略中配置此权限部分。

有关如何确定此模型涵盖哪些 Connectors 和 ServiceAccounts,请参阅常见配置模式。

示例

以下策略会立即向 builder 和 deployer 授予 devops 中所有 OCI Connectors 的代理访问权限:

apiVersion: connectors.alauda.io/v1alpha1
kind: AccessPolicy
metadata:
  name: oci-default-access
  namespace: devops
spec:
  connector:
    matchLabels:
      connectors.alauda.io/connectorclass: oci
  defaultPermission:
    roleTemplate:
      ref:
        configMap:
          name: connectors-use-connectors-proxy
    bindingTemplate:
      serviceAccounts:
        - names:
            - builder
            - deployer
          namespaceSelector:
            names:
              - devops

在审批后授予访问权限

spec.checkGrantedPermission 仅在所有配置的检查通过后授予代理权限。

以下情况通常适合使用此方式:

  • Connector 具有敏感性
  • 访问权限应仅针对一次运行时活动授予
  • 审批是交付或提升工作流的一部分

最常见的内置组合是:

  • checks[].ref.configMap.name: connectors-approvals-in-pipeline
  • roleTemplate.ref.configMap.name: connectors-use-connectors-proxy-in-pod

该组合意味着:

  • 查找与运行时对象关联的审批资源
  • 等待审批结果为通过
  • 仅向该特定运行时上下文授予绑定到 Pod 的代理权限

connectors-approvals-in-pipeline 是由核心 Connectors 组件安装的内置检查模板。在流水线场景中,它使用运行时的 Pod 上下文,通过 tekton.dev/pipelineRun 查找相关的 Tekton ApprovalTask。

connectors-use-connectors-proxy-in-pod 是由核心 Connectors 组件安装的内置角色模板。它授予 connectors/proxy/v1/pod/{.object.metadata.namespace}/{.object.metadata.name},将权限绑定到运行时记录的某个特定 Pod 上。

你仍然可以使用常见配置模式中的相同 Connector 选择模式;区别在于,访问权限会在检查成功后,按运行时上下文授予。

示例

以下策略应用于 prod-harbor Connector。它不授予默认访问权限,而是等待内置的流水线审批检查,然后授予绑定到 Pod 的代理权限。

apiVersion: connectors.alauda.io/v1alpha1
kind: AccessPolicy
metadata:
  name: prod-harbor-approval
  namespace: devops
spec:
  connector:
    names:
      - prod-harbor
  checkGrantedPermission:
    spec:
      checks:
        - name: manual-approval
          ref:
            configMap:
              name: connectors-approvals-in-pipeline
      roleTemplate:
        ref:
          configMap:
            name: connectors-use-connectors-proxy-in-pod

如需进一步要求由特定人员或组进行审批,请将 params (例如 approvers 和 numberOfApprovalsRequired)添加到检查规则中。请参阅 限制审批者。

常见配置模式

选择要保护的 Connectors

AccessPolicy 仅匹配与策略本身位于同一命名空间中的 Connectors。

目标 Connectors 在 spec.connector 中定义:

  • 留空以匹配命名空间中的所有 Connectors
  • 使用 names 指定目标 Connectors
  • 使用 matchLabels 或 matchExpressions 指定目标 Connector 组

这是将一个策略映射到一个 Connector、部分 Connectors 或某个作用域中的所有 Connectors 的主要机制。

示例

  • 匹配当前命名空间中的所有 Connectors。

    apiVersion: connectors.alauda.io/v1alpha1
    kind: AccessPolicy
    metadata:
      name: allow-team-a-proxy
      namespace: team-a
    spec:
      connector: {}
  • 按名称匹配一个特定的 Connector。

    apiVersion: connectors.alauda.io/v1alpha1
    kind: AccessPolicy
    metadata:
      name: prod-harbor-policy
      namespace: devops
    spec:
      connector:
        names:
          - prod-harbor
  • 匹配一个命名空间中多个明确命名的 Connectors。

    apiVersion: connectors.alauda.io/v1alpha1
    kind: AccessPolicy
    metadata:
      name: release-connectors
      namespace: devops
    spec:
      connector:
        names:
          - prod-harbor
          - prod-gitlab
  • 匹配命名空间中属于某个 ConnectorClass 的所有 Connectors。

    apiVersion: connectors.alauda.io/v1alpha1
    kind: AccessPolicy
    metadata:
      name: all-oci-connectors
      namespace: devops
    spec:
      connector:
        matchLabels:
          connectors.alauda.io/connectorclass: oci
  • 使用环境或用途等自定义标签匹配部分 Connectors。

    apiVersion: connectors.alauda.io/v1alpha1
    kind: AccessPolicy
    metadata:
      name: prod-release-connectors
      namespace: devops
    spec:
      connector:
        matchExpressions:
          - key: env
            operator: In
            values:
              - prod
          - key: usage
            operator: In
            values:
              - release

选择哪些 ServiceAccounts 获取默认访问权限

使用 defaultPermission 时,bindingTemplate.serviceAccounts 定义哪些 ServiceAccounts 可以通过 Connectors Proxy 使用匹配的 Connector。

每个条目包含:

  • names:要绑定的 ServiceAccount 名称
  • namespaceSelector:这些 ServiceAccounts 所属的命名空间

如果希望选定命名空间中的所有 ServiceAccounts,请使用空的 names 列表。

示例

  • 允许当前命名空间中的所有 ServiceAccounts。这是命名空间级 Connector 的常见模式。

    defaultPermission:
      roleTemplate:
        ref:
          configMap:
            name: connectors-use-connectors-proxy
      bindingTemplate:
        serviceAccounts:
          - names: []
            namespaceSelector:
              names:
                - devops
  • 仅允许一个命名空间中选定的 ServiceAccounts,例如 devops 中的 builder 和 deployer。

    defaultPermission:
      roleTemplate:
        ref:
          configMap:
            name: connectors-use-connectors-proxy
      bindingTemplate:
        serviceAccounts:
          - names:
              - builder
              - deployer
            namespaceSelector:
              names:
                - devops
  • 允许某个项目中的所有 ServiceAccounts。当 Connector 在项目级别共享且项目命名空间使用 cpaas.io/project 标记时,这种方式很有用。

    defaultPermission:
      roleTemplate:
        ref:
          configMap:
            name: connectors-use-connectors-proxy
      bindingTemplate:
        serviceAccounts:
          - names: []
            namespaceSelector:
              matchLabels:
                cpaas.io/project: devops
  • 允许某个项目中所有命名空间内的一个指定 ServiceAccount,例如 devops 项目中的 builder。

    defaultPermission:
      roleTemplate:
        ref:
          configMap:
            name: connectors-use-connectors-proxy
      bindingTemplate:
        serviceAccounts:
          - names:
              - builder
            namespaceSelector:
              matchLabels:
                cpaas.io/project: devops
  • 允许集群中的所有 ServiceAccounts。这对于集群共享的 Connector 很有用。在这种情况下,必须在与共享 Connector 相同的命名空间中创建 AccessPolicy。

    defaultPermission:
      roleTemplate:
        ref:
          configMap:
            name: connectors-use-connectors-proxy
      bindingTemplate:
        serviceAccounts:
          - names: []
            namespaceSelector: {}

状态

AccessPolicy.status 可帮助 operator 确认策略是否已按预期应用。

重要的状态字段包括:

  • matchedConnectors:当前与 spec.connector 匹配的 Connectors
  • conditions:策略的协调状态

此状态有助于在调查运行时访问行为之前,检查是否选择了预期的 Connectors。

后续步骤