使用 Airflow 界面访问权限控制

Cloud Composer 1 | Cloud Composer 2 | Cloud Composer 3

本页介绍了 Airflow 界面的各种访问权限控制机制。 和 DAG 界面。除了 IAM 提供的访问控制之外,您还可以使用这些机制在环境的 Airflow 界面和 DAG 界面中区分用户。

Cloud Composer 中 Airflow 界面访问权限控制概览

在 Cloud Composer 中,对 Airflow 界面DAG 界面的访问权限以及这些界面中数据和操作的可见性在两个级别受控:

  1. 对 Cloud Composer 中的 Airflow 界面和 DAG 界面的访问权限 由 IAM 控制

    如果某个账号没有在您的项目中查看 Cloud Composer 环境的角色,则无法使用 Airflow 界面和 DAG 界面。

    IAM 不会提供任何额外的精细控制 Airflow 界面或 DAG 界面中的权限控制。

  2. Apache Airflow 访问权限控制模型允许 根据用户角色降低 Airflow 界面和 DAG 界面中的可见性。

    Apache Airflow 访问控制是 Airflow 的一项功能,它拥有自己的用户、角色、权限模型,与 IAM 不同。

Apache Airflow 访问权限控制使用基于资源的权限。所有 Airflow 拥有特定 Airflow 角色的用户将获得此角色的权限。例如: 拥有具有 can delete on Connections 权限的角色的 Airflow 用户 可以在 Airflow 界面的“连接”页面上删除连接。

您还可以为个别 DAG 分配 DAG 级权限。例如,您可以通过此功能实现以下目的:只有具有特定 Airflow 角色的用户才能在 Airflow 界面中看到特定 DAG。在 Cloud Composer 中,您可以 自动分配 DAG 级权限; (根据 DAG 文件在环境的 存储分区。

如果您想通过员工身份联合为外部身份设置访问权限,请先在 IAM 中授予对您环境的访问权限,如向外部身份授予 IAM 角色部分所述。之后,您可以照常使用 Airflow 界面访问控制功能。外部身份的 Airflow 用户改为使用其主账号标识符 电子邮件地址,并为其他用户填充不同的值 记录字段比 Google 账号多。

管理 Airflow 角色和访问权限控制设置

拥有“管理员”角色(或同等角色)的用户可以查看和修改访问权限控制 Airflow 界面中的设置。

在 Airflow 界面中,您可以通过安全菜单配置访问权限控制设置。如需详细了解 Airflow 访问权限控制 可用权限和默认角色,请参阅 Airflow 界面访问权限控制文档

Airflow 拥有自己的用户列表。拥有管理员权限的用户 角色(或同等角色)可以查看已打开 Airflow 界面的用户列表 并且已在 Airflow 中注册。此列表还包括由管理员手动预注册的用户,如以下部分所述。

在 Airflow 界面中注册用户

当新用户首次打开 Cloud Composer 环境的 Airflow 界面时,系统会自动注册新用户。

注册时,系统会向用户授予 [webserver]rbac_user_registration_role Airflow 配置选项中指定的角色。您可以 通过替换此 具有不同值的 Airflow 配置选项。

如果未指定,则默认注册角色为 Op(在采用 Airflow 2.

如需为 Airflow 界面创建基本角色配置,建议执行以下步骤:

  1. 环境管理员会打开新创建的 Airflow 界面 环境

  2. 为管理员账号授予 Admin 角色。在具有 Airflow 2 的环境中,新账号的默认角色为 Op。如需分配 Admin 角色,请使用 gcloud CLI 运行以下 Airflow CLI 命令

      gcloud composer environments run ENVIRONMENT_NAME \
        --location LOCATION \
        users add-role -- -e USER_EMAIL -r Admin
    

    您需要将其中的:

    • ENVIRONMENT_NAME 替换为环境的名称。
    • LOCATION 替换为环境所在的区域。
    • USER_EMAIL 替换为用户账号的电子邮件地址。
  3. 管理员现在可以为新用户配置访问权限控制,包括向其他用户授予 Admin 角色。

预注册用户

用户会自动注册 Google 用户账号的数字 ID(而非 作为其用户名。您也可以手动预注册用户 然后添加名为“用户名”字段的用户记录,为他们分配角色 用户的主电子邮件地址。如果电子邮件地址与预注册的用户记录匹配的用户首次登录 Airflow 界面,则该用户的用户名会被替换为目前(首次登录时)通过其电子邮件地址识别的用户 ID。关系 介于 Google 身份(电子邮件地址)和用户账号(用户 ID) 不是固定的无法预注册 Google 群组。

如需预注册用户,您可以使用 Airflow 界面,也可以通过 Google Cloud CLI 运行 Airflow CLI 命令。

如需通过 Google Cloud CLI 预注册具有自定义角色的用户,请运行以下 Airflow CLI 命令

gcloud composer environments run ENVIRONMENT_NAME \
  --location LOCATION \
  users create -- \
  -r ROLE \
  -e USER_EMAIL \
  -u USER_EMAIL \
  -f FIRST_NAME \
  -l LAST_NAME \
  --use-random-password # The password value is required, but is not used

替换以下内容:

  • ENVIRONMENT_NAME:环境的名称
  • LOCATION:环境所在的区域
  • ROLE:用户的 Airflow 角色,例如 Op
  • USER_EMAIL:用户的电子邮件地址
  • FIRST_NAMELAST_NAME:用户的名字和姓氏

示例:

gcloud composer environments run example-environment \
  --location us-central1 \
  users create -- \
  -r Op \
  -e "example-user@example.com" \
  -u "example-user@example.com" \
  -f "Name" \
  -l "Surname" \
  --use-random-password

移除用户

从 Airflow 中删除用户不会撤消该用户的访问权限, 在他们下次访问 Airflow 界面时自动重新注册。接收者 撤消对整个 Airflow 界面的访问权限,移除composer.environments.get 从其针对您的项目的允许政策中获取的权限。

您还可以将用户的角色更改为“公开”,这将保留用户注册,但会移除 Airflow 界面的所有权限。

自动配置 DAG 级权限

每个文件夹的角色注册功能会自动创建一个 每个子文件夹的自定义 Airflow 角色 直接在 /dags 文件夹中授予此角色的 DAG 级访问权限,允许其访问 源文件存储在相应子文件夹中的 DAG。这个 可简化自定义 Airflow 角色及其对 DAG 的访问权限的管理。

按文件夹注册角色的工作原理

按文件夹注册角色是一种自动配置角色及其 DAG 级权限的方法。因此,它可能会与授予 DAG 级权限的其他 Airflow 机制发生冲突:

为防止此类冲突,还应启用按文件夹的角色注册 会改变这些机制的行为。

在 Airflow 2 中:

  • 您可以通过 access_control 属性向 DAG 授予角色访问权限 在 DAG 源代码中定义
  • 手动授予 DAG 权限(通过 Airflow 界面或 gcloud CLI)可能会导致冲突。例如,如果您 手动将 DAG 级权限授予文件夹级角色,这些 执行特定任务时 同步 DAG。建议不要手动授予 DAG 权限。
  • 角色拥有通过“按文件夹”注册的 DAG 访问权限的集合 角色注册,并在access_control DAG

直接位于顶层 /dags 文件夹中的 DAG 不会被自动分配给 任何文件夹级角色任何文件夹级角色都无法访问这些文件夹。其他角色(例如“管理员”“操作员”“用户”或已获授权的任何自定义角色)都可以通过 Airflow 界面和 DAG 界面访问这些权限。

如果您将 DAG 上传到名称与内置 Airflow 角色和 Cloud Composer 创建的角色匹配的子文件夹,则这些子文件夹中 DAG 的权限仍会分配给这些角色。例如,上传一个 /dags/Admin 文件夹的 DAG 会将此 DAG 的权限授予管理员 角色。内置 Airflow 角色包括 Admin、Op、User、Viewer 和 Public。 Cloud Composer 会在每个文件夹之后创建 NoDag 和 UserNoDag 角色注册功能已启用。

Airflow 在 Airflow 调度器中处理 DAG 时会执行按文件夹角色注册。如果您的环境中有超过 100 个 DAG,您可能会发现 DAG 解析时间增加。如果是这种情况,我们建议为调度程序分配更多内存和 CPU。您 还可以提高[scheduler]parsing_processes Airflow 的价值 配置选项。

将 DAG 自动分配给每个文件夹的角色

如需将 DAG 自动分配给每个文件夹的角色,请执行以下操作:

  1. 替换以下 Airflow 配置选项:

    部分
    webserver rbac_autoregister_per_folder_roles True
  2. 将新的用户注册角色更改为无权访问任何 DAG 的角色。 这样一来,新用户将无法访问任何 DAG,除非管理员向其账号分配了具有特定 DAG 权限的角色。

    UserNoDags 是由 Cloud Composer 创建的角色,仅当 已启用每个文件夹的角色注册功能。此角色相当于“用户”角色,但没有对任何 DAG 的访问权限。

    替换以下 Airflow 配置选项:

    部分
    webserver rbac_user_registration_role UserNoDags

  3. 确保用户已在 Airflow 中注册

  4. 您可以使用以下任一方法为用户分配角色:

    • 让 Airflow 自动根据 DAG 子文件夹创建角色,然后将用户分配给这些角色。
    • 为 DAG 子文件夹预先创建空角色,并使角色名称与子文件夹的名称一致,然后将用户分配给这些角色。例如: 为 /dags/CustomFolder 文件夹创建一个名为 CustomFolder
  5. 将 DAG 上传到名称与分配给用户的角色相符的子文件夹。 这些子文件夹必须位于/dags 环境的存储桶中。Airflow 会向此类子文件夹中的 DAG 添加权限,以便只有具有相应角色的用户才能通过 Airflow 界面和 DAG 界面访问这些 DAG。

手动配置 DAG 级权限

您可以配置 DAG 级权限:可让自定义角色 指定对特定用户群组可见的 DAG。

如需在 Airflow 界面中配置 DAG 级权限,请执行以下操作:

  1. 管理员创建空角色以对 DAG 进行分组。
  2. 管理员为用户分配适当的角色。
  3. 管理员或用户为角色分配 DAG。
  4. 在 Airflow 界面中,用户只能看到分配给其所在群组的 DAG。

您可以通过 DAG 属性或 Airflow 界面。

在 Airflow 界面中为角色分配 DAG

管理员可以将必需的 DAG 级权限分配给 Airflow 界面中的角色。

DAG 界面不支持此操作。

将 DAG 分配给 DAG 属性中的角色

您可以将 DAG 的 access_control DAG 参数,指定 分配给该 DAG 的 DAG 分组角色。

调度器在解析 DAG 时应用 DAG 级权限。

dag = DAG(
  access_control={
    'DagGroup': {'can_edit', 'can_read'},
  },
  ...
  )

将 Airflow 界面中的审核日志映射到用户

Airflow 界面中的审核日志会映射到 Google 用户账号的数字 ID。对于 例如,如果用户暂停某个 DAG,则系统会向日志中添加一个条目。

您可以在 Airflow 界面的浏览 > 审核日志页面上查看审核日志。

Airflow 2 中“审核日志”页面上的条目
图 1:Airflow 2 中“审核日志”页面上的条目

典型条目会在所有者字段中列出一个数字 ID: accounts.google.com:NUMERIC_ID。您可以将数字 ID 映射到 安全性 > 列出用户页面。此页面适用于具有 Admin 角色的用户。

请注意, Google 身份(电子邮件地址)和用户账号(用户 ID) 不是固定的

后续步骤