访问具有员工身份联合的环境

Cloud Composer 1 | Cloud Composer 2 | Cloud Composer 3

本页面介绍了如何通过员工身份联合配置用户对 Cloud Composer 环境的访问权限。

Cloud Composer 中的员工身份联合简介

借助员工身份联合,您可以使用外部身份提供方 (IdP) 通过 IAM 对员工(一组用户,例如员工、合作伙伴和承包商)进行身份验证和授权,以便用户可以访问 Google Cloud 服务。如需详细了解员工身份联合,请参阅员工身份联合

如果您的项目中配置了员工身份联合,则您可以通过以下方式访问环境:

  • Google Cloud 控制台中的 Cloud Composer 页面
  • Airflow 界面
  • Google Cloud CLI,包括运行 Airflow CLI 命令
  • Cloud Composer API
  • Airflow REST API

准备工作

  • 从 2.1.11 版和 Airflow 2.4.3 版开始创建的所有新 Cloud Composer 环境都支持员工身份联合。您无需以任何特定方式配置环境来支持员工身份联合。

  • 在 2.1.11 版和 Airflow 2.4.3 版之前创建以及升级到更高版本的环境不支持员工身份联合。您可以检查您的环境是否支持员工身份联合

  • 员工身份联合的 Cloud Storage 限制适用于环境的存储桶。具体而言,您必须对环境的存储桶启用统一存储桶级访问权限,才能让外部身份将其 DAG 和文件上传到此存储桶。

  • 从 Airflow 发送的电子邮件仅包含 Google 帐号的 Airflow 界面网址。对于外部身份,外部身份只能通过 Airflow 界面网址访问 Airflow 界面,因此必须调整链接(对于外部身份,请将其更改为网址)。

通过员工身份联合设置对环境的访问权限

本部分介绍了为外部身份配置对 Cloud Composer 环境的访问权限的步骤。

配置身份提供商

按照配置员工身份联合指南为身份提供方配置员工身份联合。

向外部身份授予 IAM 角色

在 Identity and Access Management 中,向外部身份组授予 IAM 角色,以便它们可以访问您的环境并与之互动:

  • 如需查看特定于 Cloud Composer 的角色列表,请参阅向用户授予角色。例如,拥有 Environment User and Storage Object Viewer (composer.environmentAndStorageObjectViewer) 角色的用户可以查看环境、访问 Airflow 界面、通过 DAG 界面查看和触发 DAG,以及查看环境存储分区中的对象。

  • 如需了解如何向外部用户分配这些角色,请参阅向主账号授予 IAM 角色

  • 如需了解在 IAM 政策中表示外部身份的格式,请参阅在 IAM 政策中表示员工池用户

检查新用户是否在 Airflow 界面访问权限控制中收到正确的 Airflow 角色

Cloud Composer 为外部身份处理 Airflow 用户的方式与处理 Google 帐号用户的方式相同。系统使用的是主帐号标识符,而不是电子邮件地址。当外部身份首次访问 Airflow 界面时,系统会自动在基于 Airflow 角色的访问控制系统中注册一个具有默认角色的 Airflow 用户。

请在 Airflow 界面访问权限控制中检查新用户是否获得了正确的 Airflow 角色。您可以采用以下两种方法:

  • 允许外部身份在首次访问 Airflow 界面后接收默认角色。如果需要,Airflow 管理员用户可以将此角色更改为其他角色。
  • 添加 Airflow 用户记录并将用户名和电子邮件地址字段设置为主账号标识符,从而使用一组必需的角色预注册外部身份。这样,外部身份将获得您分配给他们的角色,而不是默认角色。

检查环境是否支持员工身份联合

如需检查您的环境是否支持员工身份联合,请运行以下 Google Cloud CLI 命令。如果输出显示 URI,则表示您的环境支持员工身份联合。

gcloud composer environments describe ENVIRONMENT_NAME \
  --location LOCATION \
  --format="value(config.airflowByoidUri)"

您需要在其中:

  • ENVIRONMENT_NAME 替换为环境的名称。
  • LOCATION 替换为环境所在的区域。

示例:

gcloud composer environments describe example-environment \
  --location us-central1 \
  --format="value(config.airflowByoidUri)"

访问 Google Cloud 控制台中的 Cloud Composer 页面

Google Cloud 员工身份联合控制台提供对 Cloud Composer 页面的访问权限。

通过 Google Cloud 员工身份联合控制台中的 Composer 页面,您可以访问用于管理环境、Cloud Composer 日志、监控和 DAG 界面的界面。

联合控制台中指向 Airflow 界面的所有链接均指向外部身份的 Airflow 界面接入点。

对于早于 2.1.11 的环境和/或低于 2.4.3 的 Airflow 版本,其 Airflow 界面链接可能会被标记为“不可用”。这表示此环境在 Airflow 界面中不支持员工身份联合用户。只能使用 Google 帐号访问此环境的 Airflow 界面。

访问 Airflow 界面

Cloud Composer 环境的 Airflow 界面有两个网址:一个用于 Google 帐号,另一个用于外部身份。外部身份必须通过外部身份的网址访问 Airflow 界面。

  • 外部身份的网址为 https://<UNIQUE_ID>.composer.byoid.googleusercontent.com

  • Google 账号的网址是 https://<UNIQUE_ID>.composer.googleusercontent.com

只有使用外部身份进行了身份验证的用户才能访问外部身份的网址。如果用户在未登录的情况下访问外部身份的网址,系统会先将其重定向到用于指定员工池提供方名称的身份验证门户,然后将其重定向到其身份提供方以登录,最后重定向到环境的 Airflow 界面。

在 Google Cloud 控制台中访问 DAG 界面

DAG 界面作为联合控制台的一部分提供给外部身份用户。您可以使用 IAM 政策控制访问权限。

它还会考虑具有完整员工身份联合支持的环境中基于角色的访问权限,并且该访问权限可用于通过设置角色来限制各个用户可以看到哪些 DAG,如使用 Airflow 界面访问权限控制中所述。

访问 Google Cloud CLI

如需通过 Google Cloud CLI 访问您的环境,外部身份必须执行以下操作:

  1. 使用外部身份通过 Google Cloud CLI 登录。
  2. 运行 gcloud composer environments 命令。

访问 Cloud Composer API

Cloud Composer API 可与外部身份搭配使用,以便使用支持的身份验证方法(如 OAuth 令牌)管理所有 Composer 环境。

Airflow REST API

Airflow REST API 可在外部身份的端点上使用,并采用 OAuth 令牌等受支持的身份验证方法。

如需获取环境的外部身份端点的网址,请使用 gcloud composer environments describe 命令,如检查环境是否支持员工身份联合部分所示。

后续步骤