保存并加载环境快照

Cloud Composer 1 | Cloud Composer 2 | Cloud Composer 3

本页面介绍了如何使用环境快照保存和加载环境的状态。

您可以将环境配置为自动保存快照。如需了解详情，请参阅配置计划快照。

环境快照简介

环境快照会存储您的环境的状态。您可以按需保存和加载环境快照。

您可以使用快照执行以下操作：

  • 将您的环境恢复到早期状态。使用快照创建环境的备份，然后加载其中一个快照来恢复环境。例如，即使在已成功更新环境后，您也可以回滚会安装 PyPI 软件包或替换 Airflow 配置选项的更新操作。

  • 执行并排升级和复制环境。创建现有环境的快照，创建一个使用相同或更新版本的 Cloud Composer 的新环境，然后将快照应用于这个新环境。此过程与迁移类似。创建快照之前，请务必暂停 DAG，以避免重复的 DAG 运行。

快照的存储方式

环境快照是一组文件，用于描述环境状态并存储环境数据的备份。

您可以为自己的环境创建多个快照。环境快照不是增量快照。您可以独立于其他快照使用任何快照。

删除环境时，Cloud Composer 不会删除快照。

默认情况下，Cloud Composer 会将快照存储在环境存储桶的 snapshots/ 文件夹中。您还可以在创建快照时指定自定义位置。

为了方便起见，Cloud Storage 界面将数据显示为文件夹，而存储分区使用的是平面文件结构。这不会改变您在 Google Cloud 控制台中保存和加载快照的方式，但当您直接对存储桶中的文件执行操作时，请记住这一点。如需了解详情，请参阅对象命名空间。

快照的安全注意事项

为了降低此安全风险，您可以将 Airflow DAG 使用的敏感信息（例如密钥或密码）存储在 Secret Manager 中。如需了解详情，请参阅为您的环境配置 Secret Manager。

请务必检查环境存储桶的安全权限。如果将环境快照存储在自定义存储桶中，请确保在项目中正确配置该存储桶的访问权限。分配权限时，请确保环境的服务帐号具有足够的权限，可以保存并从存储桶加载快照。

快照中保存哪些数据

Cloud Composer 会将以下数据保存在快照中：

  • Airflow 配置替换。
  • 环境变量。
  • 自定义 PyPI 软件包列表（作为要求）。
  • Airflow 数据库的备份，包括已执行任务的状态和 DAG 运行历史记录。
  • 环境存储桶中的 /dags、/data 和 /plugins 文件夹的备份。
  • 环境的 fernet 密钥。
  • 有关环境配置的其他信息，例如环境的规模和性能参数。Cloud Composer 不会在加载快照时使用此信息。

从快照中加载哪些数据

Cloud Composer 会从快照加载以下数据：

  • Airflow 配置替换。
  • 环境变量。

  • 自定义 PyPI 软件包（除非您选择跳过安装它们）。

  • Airflow 数据库的内容，包括已执行任务的状态和 DAG 运行历史记录。

  • 快照中的 /dags、/data 和 /plugins 文件夹的内容会加载到环境的存储桶中。

  • 快照中的铁网络密钥用于通过环境自己的铁网络密钥重新加密快照中的数据。该环境的铁网络密钥保持不变。

虽然 Cloud Composer 会将一些有关环境配置的信息存储在快照中，但在加载快照时不使用这些信息。加载快照时，环境的以下参数不会更改：

  • 环境配置，例如环境规模和性能参数。
  • 环境的网络配置。
  • /dags、/data 和 /plugins 文件夹之外的环境存储桶的内容。
  • 环境标签。

加载快照时，您在 Cloud Composer 基础架构中应用的所有设置都可能会在未使用 Cloud Composer API 的情况下丢失。

关于部分完成的操作

加载快照时，操作可能成功、失败或部分完成：

  • 成功的操作会从快照中加载所有数据。
  • 失败的操作不会带来任何变化。
  • 部分完成的操作会从快照中加载一部分数据。此类操作会报告为失败，但错误消息会指明已成功加载的数据。例如，如果安装了 PyPI 软件包，但 Airflow 配置选项替换未成功，则错误消息会指出这一点。

对于部分完成的操作，您可以尝试再次加载同一快照。Cloud Composer 会跳过在上一次尝试中成功执行的步骤。例如，如果某项操作因超时而失败，但数据库已成功加载，则下一次尝试不会再次加载数据库。

准备工作

  • Cloud Composer 2 2.0.9 版及更高版本支持快照。Cloud Composer 1 支持保存 1.18.5 及更高版本的环境快照。

  • 快照不会创建环境。如果要将某个环境中的快照加载到其他环境，您首先需要创建一个新环境，然后将快照加载到其中。

  • 您无法将快照加载到处于错误状态的环境。无法通过加载快照来修复此类环境。您仍然可以将现有快照加载到新环境。

  • 您只能将快照加载到相同或更高版本的 Cloud Composer 或 Airflow 中。例如，您无法将 Cloud Composer 2.0.2 中的快照加载到 Cloud Composer 2.0.1 环境中。再举一个例子，您不能将快照从 Airflow 2.2.3 加载到 Airflow 2.1.4。

  • 快照不会更改 Cloud Composer 版本。如果您将环境升级到更高版本的 Cloud Composer，然后从早期版本加载快照，则您的环境仍会保留其当前版本的 Cloud Composer。例如，将快照从 Cloud Composer 2.0.1 加载到 Cloud Composer 2.0.2 不会将环境还原为 Cloud Composer 2.0.1。

  • 支持快照的 Airflow 数据库大小上限为 20 GB。如果环境的数据库占用的空间超过 20 GB，请在保存快照之前减小 Airflow 数据库的大小。

  • 在环境的存储桶中，对象名称的最大长度不得超过 1024 个符号。否则，无法创建快照。

  • 如果将快照保存在环境存储桶之外的位置，则环境的服务帐号必须拥有指定位置的读写权限。例如，Storage Object Admin 角色具有此类权限。您可以将其应用于项目或特定存储桶。

  • 创建和存储快照会产生额外费用，而这与 Cloud Storage 相关。如需了解详情，请参阅价格。

保存环境快照

Cloud Composer 会将环境快照保存在与您指定的文件夹相对的子文件夹中。文件夹名称包含项目 ID、环境的位置、环境名称以及保存快照时的时间戳。例如：/snapshots/example-project_us-central1_example-environment_2022-01-05T18-59-00。

控制台

如需创建环境的快照，请执行以下操作：

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

    转到“环境”

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

  3. 点击保存快照。

  4. 在保存快照对话框中，选择快照的存储位置：

    • 如需将快照存储在环境存储桶的 /snapshots 文件夹中，请选择在环境存储桶中使用快照文件夹（默认）。

    • 如需将快照存储在自定义文件夹中，请选择使用其他存储桶中的自定义文件夹，然后指定位置。

  5. 点击保存。

gcloud

gcloud beta composer environments snapshots save 命令会保存您的环境的快照。

  • snapshot-location 参数指定保存快照的文件夹。默认情况下，快照保存在环境存储桶的 /snapshots 文件夹中。例如 gs://us-central1-example-916807e1-bucket/snapshots。您还可以指定任何其他文件夹。

如需保存环境的快照，请运行以下命令：

gcloud beta composer environments snapshots save \
  ENVIRONMENT_NAME \
  --location LOCATION \
  --snapshot-location "SNAPSHOTS_FOLDER"

您需要在其中：

  • ENVIRONMENT_NAME 替换为环境的名称。
  • LOCATION 替换为环境所在的区域。
  • （可选）将 SNAPSHOTS_FOLDER 替换为存储快照的存储桶文件夹的 URI。如果省略此参数，Cloud Composer 会将快照保存到环境存储桶的 /snapshots 文件夹中。

以下示例使用默认位置：

gcloud beta composer environments snapshots save \
  example-environment \
  --location us-central1

以下示例将保存到自定义文件夹：

gcloud beta composer environments snapshots save \
  example-environment \
  --location us-central1 \
  --snapshot-location "gs://example-bucket/environment_snapshots"

API

  1. 构建 environments.saveSnapshot API 请求。

  2. 在请求正文的 snapshotLocation 字段中，指定要保存快照的文件夹。

{
  "snapshotLocation": "SNAPSHOTS_FOLDER"
}

您需要在其中：

  • 将 SNAPSHOTS_FOLDER 替换为保存快照的存储桶文件夹的 URI。

示例：

// POST https://composer.googleapis.com/v1beta1/projects/example-project/
// locations/us-central1/environments/example-environment:saveSnapshot

{
  "snapshotLocation": "gs://us-central1-example-916807e1-bucket/snapshots"
}

Terraform

无法从 Terraform 保存和加载环境快照。

保存和加载快照是对环境执行的操作，生成的快照不属于环境定义。由于 Terraform 仅管理 Cloud Composer 环境的配置，因此您无法从中保存或加载环境快照。

加载环境快照

请考虑以下情况。例如，如果启用追赶功能，则 Airflow 会按照从创建快照到加载快照的时间表执行 DAG。在这种情况下，在您加载快照后，Airflow 没有关于所发生的 DAG 运行的信息，因此 Airflow 再次运行该 DAG，同时获取相同的数据。

再举一个例子，假设某个 DAG 每天运行一次。您可以先截取快照，然后 Airflow 执行此 DAG，并在同一天加载快照。在这种情况下，即使已停用追赶功能，Airflow 也会再次运行 DAG。

控制台

如需将快照加载到 Cloud Composer 2 环境中，请执行以下操作：

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

    转到“环境”

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

  3. 点击加载快照。

  4. 在加载快照对话框中，点击浏览。

  5. 选择一个存储快照的文件夹。文件夹名称列出了项目的 ID、环境的位置和保存快照时的时间戳。例如 /snapshots/example-project_us-central1_example-environment_2022-01-05T18-59-00。

  6. （可选）如需跳过从快照安装自定义 PyPI 软件包的操作，请选择跳过 PyPI 软件包安装。如果您加载安装了自定义 PyPI 软件包的环境快照，Cloud Composer 不会安装这些自定义软件包。

  7. 点击加载，然后等待 Cloud Composer 加载快照。

gcloud

gcloud beta composer environments snapshots load 命令会将快照加载到您的环境中。

  • --snapshot-path 参数指定快照所在的文件夹。

    文件夹名称列出了项目的 ID、环境的位置和保存快照时的时间戳。例如 gs://us-central1-example-916807e1-bucket/snapshots/example-project_us-central1_example-environment_2022-01-05T18-59-00。

  • （可选）--skip-pypi-packages-installation 参数会跳过从快照安装自定义 PyPI 软件包的操作。如果您加载安装了自定义 PyPI 软件包的环境快照，Cloud Composer 不会安装这些自定义软件包。

gcloud beta composer environments snapshots load \
  DESTINATION_ENVIRONMENT_NAME \
  --location LOCATION \
  --snapshot-path "SNAPSHOT_PATH"

您需要在其中：

  • 将 DESTINATION_ENVIRONMENT_NAME 替换为您要加载快照的环境的名称。
  • LOCATION 替换为环境所在的区域。
  • 将 SNAPSHOT_PATH 替换为存储桶的 URI，后跟快照路径。

示例：

gcloud beta composer environments snapshots load \
  example-environment \
  --location us-central1 \
  --snapshot-path "gs://us-central1-example-916807e1-bucket/snapshots/example-project_us-central1_example-environment_2022-01-05T18-59-00"

API

  1. 构建 environments.loadSnapshot API 请求。

  2. 在请求正文的 snapshotPath 字段中，指定存储桶的 URI，后跟快照的路径。文件夹名称列出了项目的 ID、环境的位置以及保存快照时的时间戳。例如 gs://us-central1-example-916807e1-bucket/snapshots/example-project_us-central1_example-environment_2022-01-05T18-59-00。

  3. （可选）在请求正文的 skipPypiPackagesInstallation 字段中，指定 Cloud Composer 是否必须跳过从快照安装自定义 PyPI 软件包的操作。如果您加载安装了自定义 PyPI 软件包的环境快照，Cloud Composer 不会安装这些自定义软件包。

    此字段是可选字段。如果省略此字段，Cloud Composer 会从快照安装 PyPI 软件包。

{
  "snapshotPath": "SNAPSHOT_PATH"
}

您需要在其中：

  • 将 SNAPSHOT_PATH 替换为存储快照的存储桶文件夹的 URI。

示例：

// POST https://composer.googleapis.com/v1beta1/projects/example-project/
// locations/us-central1/environments/example-environment:loadSnapshot

{
  "snapshotPath": "gs://us-central1-example-916807e1-bucket/snapshots/example-project_us-central1_example-environment_2022-01-05T18-59-00",
  "skipPypiPackagesInstallation": "False"
}

Terraform

无法使用 Terraform 保存和加载环境快照。

保存和加载快照是对环境执行的操作，生成的快照不属于环境定义。由于 Terraform 仅管理 Cloud Composer 环境的配置，因此您无法从中保存或加载环境快照。

后续步骤