安装 Python 依赖项

Cloud Composer 1 | Cloud Composer 2 | Cloud Composer 3

注意 ：本页面尚未针对 Cloud Composer 3 进行修订，它会显示 Cloud Composer 2 的内容。

本页面介绍了如何为 Cloud Composer 环境安装 Python 软件包。

Cloud Composer 映像中的预安装和自定义 PyPI 软件包简介

Cloud Composer 映像包含预安装和自定义 PyPI 软件包。

• 预安装的 PyPI 软件包是指您的环境的 Cloud Composer 映像中包含的软件包。每个 Cloud Composer 映像都包含专用于您的 Cloud Composer 和 Airflow 版本的 PyPI 软件包。

• 自定义 PyPI 软件包是指除了预安装的软件包外，您还可以在环境中安装的软件包。

注意 ：如果您打算升级到更高版本的 Cloud Composer，可以执行升级检查。此检查会报告您环境中的自定义 PyPI 软件包是否与新 Cloud Composer 映像中的预安装软件包有任何冲突。

用于管理 Cloud Composer 环境的 PyPI 软件包的选项

选项	适用情形
从 PyPI 安装	在您的环境中安装软件包的默认方式
从具有公共 IP 地址的代码库中安装	软件包托管在 PyPI 以外的软件包代码库中。此代码库具有公共 IP 地址
从 Artifact Registry 代码库安装	软件包托管在 Artifact Registry 代码库中
从项目网络中的代码库安装	您的环境无法访问公共互联网。软件包托管在项目网络的软件包代码库中。
作为本地 Python 库进行安装	在 PyPI 中找不到该软件包，并且该库没有任何外部依赖项，例如 dist-packages。
安装插件	该软件包提供特定于插件的功能，例如修改 Airflow 网页界面。
PythonVirtualenvOperator	您不希望为所有 Airflow 工作器安装该软件包，否则该软件包与预安装的软件包存在冲突。该软件包可在 PyPI 中找到，并且没有外部依赖项。
KubernetesPodOperator 和 GKE 运算符	您需要无法通过 pip（例如 dist-packages）安装或位于内部 pip 服务器上的外部依赖项。此选项需要更多设置和维护。除非其他选项都行不通，然后再考虑此方案。

准备工作

• 您必须具有可以触发环境更新操作的角色。此外，环境的服务账号必须具有拥有足够权限来执行更新操作的角色。如需了解详情，请参阅访问权限控制。
• 如果您的环境受 VPC Service Controls 边界保护，则在安装 PyPI 依赖项之前，您必须向更多用户身份授予对服务边界所保护的服务的访问权限，并启用对私有 PyPI 代码库的支持。
• 要求必须遵循 PEP-508 中指定的格式，其中每项要求均以小写形式指定，并且包含软件包名称（可选 extras 和版本说明符）。

• PyPI 依赖项更新会在 Artifact Registry 中生成 Docker 映像。

  警告 ：请勿修改或删除 Cloud Composer 在 Artifact Registry 中或代码库本身中构建的映像。请勿将您自己的图片上传到代码库。而是应该为您的映像创建和维护自己的代码库（例如，为 KubernetesPodOperator 使用的映像）。请勿自行删除此代码库。在您删除环境后，相应代码库也会被删除。

• 如果更新因某个依赖项冲突而失败，那么您的环境将继续使用其现有依赖项运行。如果操作成功，您可以开始在 DAG 中使用新安装的 Python 依赖项。

• 在 2024 年 4 月 29 日或之后启用了 Cloud Composer API 的项目。除非您的组织替换 constraints/cloudbuild.disableCreateDefaultServiceAccount 政策，否则新项目在启用 API 时不会预配旧版 Cloud Build 服务帐号。由于在 Cloud Composer 环境中安装自定义 PyPI 软件包时，系统默认使用 Cloud Build，因此软件包安装可能会失败。默认情况下，系统将改用环境的服务帐号，因此请务必将访问您的专用软件包所需的所有额外权限授予该服务帐号。如果您希望使用其他帐号运行构建，则可以使用所选服务帐号替换 COMPOSER_AGENT_BUILD_SERVICE_ACCOUNT 环境变量。应根据 Cloud Build 文档配置此服务帐号以运行构建，并且环境的服务帐号应对其具有 iam.serviceAccounts.actAs 权限。

查看 PyPI 软件包列表

您可以以多种格式获取适用于您的环境的软件包列表。

查看预安装的软件包

如需查看您的环境的预安装软件包列表，请参阅环境的 Cloud Composer 映像对应的软件包列表。

查看所有软件包

如需查看您环境中的所有软件包（包括预安装和自定义软件包），请执行以下操作：

gcloud

以下 gcloud CLI 命令会返回环境中 Airflow 工作器的 python -m pip list 命令的结果。您可以使用 --tree 参数获取 python -m pipdeptree --warn 命令的结果。

gcloud beta composer environments list-packages \
    ENVIRONMENT_NAME \
    --location LOCATION

您需要在其中：

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

查看自定义 PyPI 软件包

控制台

1. 在 Google Cloud 控制台中，前往环境页面。

   转到“环境”

2. 在环境列表中，点击您的环境名称。环境详情页面会打开。

3. 转到 PyPI 软件包标签页。

gcloud

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

您需要在其中：

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

在 Cloud Composer 环境中安装自定义软件包

本部分介绍了在您的环境中安装自定义软件包的不同方法。

从 PyPI 安装软件包

如果软件包没有外部依赖项或与预安装的软件包冲突，则可以从 Python Package Index 安装该软件包。

注意 ：您可以放宽已安装的自定义 PyPI 软件包的版本限制。例如，请将版本指定为 >=1.0.1，而不是 ==1.0.1。

如需为您的环境添加、更新或删除 Python 依赖项，请按如下所述操作：

控制台

1. 在 Google Cloud 控制台中，前往环境页面。

   转到“环境”

2. 在环境列表中，点击您的环境名称。环境详情页面会打开。

3. 转到 PyPI 软件包标签页。

4. 点击修改

5. 点击添加软件包。

6. 在 PyPI 软件包部分中，指定软件包名称以及可选的版本说明符和 extra。

   例如：

   • scikit-learn
   • scipy，>=0.13.3
   • nltk，[machine_learning]

7. 点击保存。

gcloud

gcloud CLI 提供了几个可用于自定义 PyPI 软件包的协议：

• --update-pypi-packages-from-file 会将所有现有的自定义 PyPI 软件包替换为指定的软件包。系统会移除您未指定的软件包。
• --update-pypi-package 会更新或安装一个软件包。
• --remove-pypi-packages 移除指定的软件包。
• --clear-pypi-packages 会移除所有软件包。

通过文件安装要求

requirements.txt 文件中的每个要求说明符都必须位于单独的一行。

例如：

scipy>=0.13.3
scikit-learn
nltk[machine_learning]

更新您的环境，并在 --update-pypi-packages-from-file 参数中指定 requirements.txt 文件。

gcloud composer environments update ENVIRONMENT_NAME \
    --location LOCATION \
     --update-pypi-packages-from-file requirements.txt

您需要在其中：

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

安装一个软件包

更新您的环境，并在 --update-pypi-package 参数中指定软件包、版本和 extra。

gcloud composer environments update ENVIRONMENT_NAME \
    --location LOCATION \
     --update-pypi-package PACKAGE_NAMEEXTRAS_AND_VERSION

您需要在其中：

• ENVIRONMENT_NAME 替换为环境的名称。
• LOCATION 替换为环境所在的区域。
• 将 PACKAGE_NAME 替换为软件包的名称。
• 将 EXTRAS_AND_VERSION 替换为可选的 version 和 extras 说明符。如需省略版本和 extra，请指定空值。

注意 ：根据您的执行环境，您可能需要对 > 等特殊字符进行转义。为避免潜在问题，请将软件包名称和版本括在引号中，例如："scipy>=0.13.0"。

示例：

gcloud composer environments update example-environment \
    --location us-central1 \
    --update-pypi-package "scipy>=0.13.3"

移除软件包

更新您的环境，然后在 --remove-pypi-packages 参数中指定要删除的软件包：

gcloud composer environments update ENVIRONMENT_NAME \
    --location LOCATION \
     --remove-pypi-packages PACKAGE_NAMES

您需要在其中：

• ENVIRONMENT_NAME 替换为环境的名称。
• LOCATION 替换为环境所在的区域。
• 将 PACKAGE_NAMES 替换为以英文逗号分隔的软件包列表。

示例：

gcloud composer environments update example-environment \
    --location us-central1 \
    --remove-pypi-packages scipy,scikit-learn

API

构建 environments.patch API 请求。

在此请求中：

1. 在参数 updateMask 中，指定该掩码：

   • 使用 config.softwareConfig.pypiPackages 掩码将所有现有软件包替换为指定的软件包。系统会删除您未指定的软件包。
   • 使用 config.softwareConfig.envVariables.PACKAGE_NAME 添加或更新特定软件包。如需添加或更新多个软件包，请使用英文逗号分隔多个掩码。

2. 在请求正文中，为版本和 extra 指定软件包和值：

   {
     "config": {
       "softwareConfig": {
         "pypiPackages": {
           "PACKAGE_NAME": "EXTRAS_AND_VERSION"
         }
       }
     }
   }
   

   您需要在其中：

   • 将 PACKAGE_NAME 替换为软件包的名称。
   • 将 EXTRAS_AND_VERSION 替换为可选的 version 和 extras 说明符。如需省略版本和 extra，请指定空值。
   • 如需添加多个软件包，请将软件包的额外条目添加到 pypiPackages。

示例：

// PATCH https://composer.googleapis.com/v1/projects/example-project/
// locations/us-central1/environments/example-environment?updateMask=
// config.softwareConfig.pypiPackages.EXAMPLE_PACKAGE,
// config.softwareConfig.pypiPackages.ANOTHER_PACKAGE
{
  "config": {
    "softwareConfig": {
      "pypiPackages": {
        "EXAMPLE_PACKAGE": "",
        "ANOTHER_PACKAGE": ">=1.10.3"
      }
    }
  }
}

Terraform

software_config 代码块中的 pypi_packages 代码块会指定软件包。

resource "google_composer_environment" "example" {
  provider = google-beta
  name = "ENVIRONMENT_NAME"
  region = "LOCATION"

  config {

    software_config {

      pypi_packages = {
          PACKAGE_NAME = "EXTRAS_AND_VERSION"
      }

    }
  }
}

您需要在其中：

• ENVIRONMENT_NAME 替换为环境的名称。
• LOCATION 替换为环境所在的区域。
• 将 PACKAGE_NAME 替换为软件包的名称。
• 将 EXTRAS_AND_VERSION 替换为可选的 version 和 extras 说明符。如需省略版本和 extra，请指定空值。
• 如需添加多个软件包，请将软件包的额外条目添加到 pypi_packages。

示例：

resource "google_composer_environment" "example" {
  provider = google-beta
  name = "example-environment"
  region = "us-central1"

  config {

    software_config {
      pypi_packages = {
          scipy = ">=1.10.3"
          scikit-learn = ""
          nltk = "[machine_learning]"
      }
    }
  }
}

从公共代码库安装软件包

您可以安装托管在具有公共 IP 地址的其他代码库中的软件包。

软件包必须正确配置，以便默认的 pip 工具可以安装。

注意 ：Cloud Composer 不支持 pip 自定义，并且无法解决默认 pip 工具提供的解析机制之外的软件包依赖项和冲突。

如需从具有公共地址的软件包代码库进行安装，请执行以下操作：

1. 创建一个 pip.conf 文件，并在文件中包含以下信息（如果适用）：

   • 代码库的网址（在 index-url 参数中）
   • 代码库的访问凭据
   • 非默认 pip 安装选项

   示例：

   [global]
   index-url=https://example.com/
   

2. （可选）在某些情况下，您可能需要从多个代码库提取软件包，例如当公共代码库包含要安装的某些特定软件包时，您希望从 PyPI 安装所有其他软件包：

   1. 配置 Artifact Registry 虚拟代码库。
   2. 添加多个代码库的配置（如果需要，包括 PyPI），并定义 pip 搜索代码库的顺序。
   3. 在 index-url 参数中指定虚拟代码库的网址。

3. 确定环境存储桶的 URI。

4. 将 pip.conf 文件上传到环境存储桶中的 /config/pip/ 文件夹。

5. 使用可用的方法之一安装软件包。

从 Artifact Registry 代码库安装软件包

您可以在项目中将软件包存储在 Artifact Registry 代码库中，并将环境配置为从该代码库中安装。

注意 ：如果您使用 VPC Service Controls，则可以在 VPC 模式下创建 Artifact Registry PyPI 代码库。在这种情况下，请按照私有代码库的流程分配权限。

配置角色和权限：

1. 您的环境的服务帐号必须具有 iam.serviceAccountUser 角色。

2. 确保 Cloud Build 服务帐号具有从 Artifact Registry 代码库读取数据的权限。

3. 如果您的环境限制了对项目中其他服务的访问，例如您使用 VPC Service Controls：

   1. 将访问 Artifact Registry 代码库的权限分配给环境的服务帐号，而不是 Cloud Build 服务帐号。

   2. 确保您的项目中已配置与 Artifact Registry 代码库的连接。

如需从 Artifact Registry 代码库安装自定义 PyPI 软件包，请执行以下操作：

1. 创建一个 pip.conf 文件，并在文件中包含以下信息（如果适用）：

   • Artifact Registry 代码库的网址（在 index-url 参数中）
   • 代码库的访问凭据
   • 非默认 pip 安装选项

   对于 Artifact Registry 代码库，请将 /simple/ 附加到代码库网址：

   [global]
   index-url = https://us-central1-python.pkg.dev/example-project/example-repository/simple/
   

2. （可选）在某些情况下，您可能需要从多个代码库提取软件包，例如，当您的 Artifact Registry 代码库包含要安装的某些特定软件包时，您希望从 PyPI 安装所有其他软件包：

   1. 配置 Artifact Registry 虚拟代码库。
   2. 添加多个代码库的配置（如果需要，包括 PyPI），并定义 pip 搜索代码库的顺序。
   3. 在 index-url 参数中指定虚拟代码库的网址。

3. 将此 pip.conf 文件上传到环境存储桶中的 /config/pip/ 文件夹。例如：gs://us-central1-example-bucket/config/pip/pip.conf。

4. 使用可用的方法之一安装软件包。

从私有代码库安装软件包

您可以在项目的网络中托管私有代码库，并将环境配置为从该代码库安装 Python 软件包。

配置角色和权限：

1. 您的 Cloud Composer 环境的服务帐号必须具有 iam.serviceAccountUser 角色。

2. 如果您从项目网络中的代码库安装自定义 PyPI 软件包，并且此代码库没有公共 IP 地址：

   1. 将访问此代码库的权限分配给环境的服务帐号。

   2. 请确保在您的项目中配置了与此代码库的连接。

如需从项目网络中托管的私有代码库安装软件包，请执行以下操作：

1. 创建一个 pip.conf 文件，并在文件中包含以下信息（如果适用）：

   • 项目网络中代码库的 IP 地址
   • 代码库的访问凭据
   • 非默认 pip 安装选项

   示例：

   [global]
   index-url=https://192.0.2.10/
   

2. （可选）在某些情况下，您可能需要从多个代码库提取软件包，例如当私有代码库包含要安装的某些特定软件包时，您希望从 PyPI 安装所有其他软件包：

   1. 配置 Artifact Registry 虚拟代码库。
   2. 添加多个代码库的配置（如果需要，包括 PyPI），并定义 pip 搜索代码库的顺序。
   3. 在 index-url 参数中指定虚拟代码库的网址。

3. （可选）在 2.2.1 及更高版本的 Cloud Composer 中，从私有代码库安装软件包时，您可以使用自定义证书。为此，请执行以下操作：

   1. 将证书文件上传到环境存储桶中的 /config/pip/ 文件夹。

      注意 ：请勿上传私钥。请仅上传 PEM 格式的公共证书文件包。请验证证书包是否包含正确的根 CA。

   2. 在 pip.conf 中，在 cert 参数中指定证书文件的名称。请勿更改 /etc/pip/ 文件夹。

      示例：

      [global]
      cert =/etc/pip/example-certificate.pem
      

4. 将 pip.conf 文件上传到环境存储桶中的 /config/pip/ 文件夹。例如：gs://us-central1-example-bucket/config/pip/pip.conf。

5. 使用可用的方法之一安装软件包。

安装本地 Python 库

如需安装内部或本地 Python 库，请执行以下操作：

1. 将依赖项放在环境存储桶的 dags/ 文件夹的子目录中。如需从子目录导入某个模块，该模块的路径中的每个子目录都必须包含一个 __init__.py 软件包标记文件。

   在以下示例中，依赖项为 coin_module.py：

   dags/
     use_local_deps.py  # A DAG file.
     dependencies/
       __init__.py
       coin_module.py
   

2. 从 DAG 定义文件导入该依赖项。

   例如：

from dependencies import coin_module

注意 ：如果缺少 __init__.py 文件，则会发生导入错误。目录和文件名必须是有效的 Python 标识符。

使用依赖于共享对象库的软件包

某些 PyPI 软件包取决于系统级库。 虽然 Cloud Composer 不支持系统库，但您可以使用以下方法：

• 使用 KubernetesPodOperator。将运营商映像设置为自定义 build 映像。如果软件包在安装期间由于未满足的系统依赖项而失败，请使用此选项。

• 将共享对象库上传到环境的存储桶中。如果您的 PyPI 软件包已成功安装，但在运行时失败，请使用此选项。

  1. 手动查找 PyPI 依赖项的共享对象库（.so 文件）。
  2. 将共享对象库上传到环境存储桶中的 /plugins 文件夹。
  3. 设置以下环境变量：LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/home/airflow/gcs/plugins

注意 ：plugins/ 文件夹中的文件会同步到本地文件系统。上传大型 .so 文件可能会影响环境和 Airflow Web 服务器的性能。

在专用 IP 环境中安装软件包

本部分介绍了如何在专用 IP 环境中安装软件包。

您的环境可能无权访问公共互联网，具体取决于您的项目配置方式。

具有公共互联网访问权限的专用 IP 环境

如果您的专用 IP 环境可以访问公共互联网，则可以使用适用于公共 IP 环境的选项来安装软件包：

• 从 PyPI 安装。在这种情况下，无需特殊配置。按照从 PyPI 安装软件包中所述的步骤进行操作。
• 从具有公共 IP 地址的代码库中安装。按照从私有代码库安装软件包中所述的过程操作。
• 从项目网络内托管的专用 PyPI 代码库进行安装。

无法访问互联网的专用 IP 环境

如果您的专用 IP 环境无法访问公共互联网，则可以使用以下任一方法安装软件包：

• 使用项目网络中托管的专用 PyPI 代码库。
• 在项目网络中使用代理服务器虚拟机连接到公共互联网上的 PyPI 代码库。请在环境存储桶的 /config/pip/pip.conf 文件中指定代理地址。
• 使用 Artifact Registry 代码库作为软件包的唯一来源。为此，请按照说明重新定义 index-url 参数。
• 如果您的安全政策允许从 VPC 网络访问外部 IP 地址，则您可以通过配置 Cloud NAT，允许从公共互联网上的代码库安装软件包。
• 将 Python 依赖项放入环境存储桶的 /dags 文件夹中，将其作为本地库安装。如果依赖项树很大，这可能不是一个好选择。

安装到受资源位置限制的专用 IP 环境

保证项目符合资源位置限制要求，禁止使用某些工具。具体而言，Cloud Build 不能用于软件包安装，因此无法直接访问公共互联网上的代码库。

如需在此类环境中安装 Python 依赖项，请遵循无法访问互联网的专用 IP 环境的相关指南。

将 Python 依赖项安装到 VPC Service Controls 边界中的专用 IP 环境

使用 VPC Service Controls 边界保护项目会导致进一步的安全限制。具体而言，Cloud Build 不能用于软件包安装，因此无法直接访问公共互联网上的代码库。

如需为边界内的专用 IP 环境安装 Python 依赖项，请遵循无法访问互联网的专用 IP 环境的相关指南。

后续步骤

• 排查软件包安装问题
• 排查更新和升级问题