指定维护窗口

Cloud Composer 1 | Cloud Composer 2

本页面介绍如何为您的环境定义维护窗口。

维护窗口简介

维护窗口是您允许 Cloud Composer 执行维护操作的时间段。例如，您可以在 DAG 调度时间之外指定维护期，以确保关键任务的执行不会中断。

通过维护期，您可以控制对环境进行维护的时间段：

如果您为自己的环境定义了自定义维护期，则 Cloud Composer 会在这些指定的周期内执行维护。
如果您没有为环境定义维护期，Cloud Composer 将随时执行维护。

维护窗口期间会发生什么

指定维护窗口时，您需要在一周内为维护操作提供至少 12 小时的时间：

在维护窗口期间，您的环境仍然可用。当维护操作正在进行时，环境的某些组件可能会暂时不可用。
这 12 小时是 Cloud Composer 有足够的时间来安排和执行所有维护操作。这并不意味着维护操作需要整整 12 小时，甚至每周进行一次。

您仍然可以在维护期内运行 DAG，前提是某些任务可以中断并重试。如果您在维护期内运行 DAG，请确保启用任务重试功能。您可以在 Airflow 配置、DAG 或任务级别配置任务重试。

维护操作可能会对您的环境产生以下影响：

暂时可能无法更改环境的某些参数或升级到较新版本。
对 Airflow 数据库直接进行 SQL 查询可能需要比平时更长的时间，并且可能需要重试。
Airflow 界面可能暂时无法使用
某些 Airflow 任务可能会中断。维护操作完成后，Airflow 会为这些任务安排重试（如果未以其他方式配置）。

默认维护窗口

默认情况下，如果您通过 Google Cloud 控制台、API 或 Terraform 创建 Cloud Composer 1 环境，则没有定义维护期。我们建议您为新环境和现有环境指定维护期。

如果您使用 gcloud CLI 创建环境，则您的环境的默认维护期为每周周日、周五和周六的 00:00:00 到 04:00:00 (GMT)。

如何使用维护窗口

维护操作可能会影响 DAG 和 Airflow 任务的执行，因此我们建议您执行以下操作：

定义 Cloud Composer 环境的维护窗口。
通过在 DAG 中使用 start_date 和 schedule_interval 参数，安排在指定维护窗口之外运行的 DAG。

为新环境指定维护窗口

您可以在创建环境时指定维护窗口。如需了解详情，请参阅创建环境。

为现有环境指定维护窗口

控制台

如需定义或更改现有环境的维护窗口，请更新环境：

在 Google Cloud 控制台中，转到环境页面。

转到“环境”
选择您的环境。
转到环境配置标签页。
在维护窗口条目旁边，点击修改。
在维护窗口对话框中，选中设置维护窗口的自定义时间复选框。
设置开始时间、时区、天数和长度，以便指定 7 天的滚动期内，时间表的总时间至少 12 小时。例如，每个星期一、星期三和星期五的 4 小时提供了所需的时间。
点击保存，然后等待您的环境更新。

gcloud

更新环境时，以下参数定义了维护窗口参数：

--maintenance-window-start 设置自定义维护窗口的开始时间。
--maintenance-window-end 设置维护窗口的结束时间。
--maintenance-window-recurrence 设置维护窗口重复。

gcloud composer environments update ENVIRONMENT_NAME \
    --location LOCATION \
    --maintenance-window-start 'DATETIME_START' \
    --maintenance-window-end 'DATETIME_END' \
    --maintenance-window-recurrence 'MAINTENANCE_RECURRENCE'

您需要将其中的：

将 ENVIRONMENT_NAME 替换为环境的名称。
将 DATETIME_START 替换为采用日期/时间输入格式的开始日期和时间。只有一天中所指定的时间，指定的日期会被忽略。
将 DATETIME_END 替换为采用日期/时间输入格式的结束日期和时间。只有一天中所指定的时间，指定的日期会被忽略。指定的日期和时间必须晚于开始日期。
将 MAINTENANCE_RECURRENCE 替换为用于恢复维护窗口的 RFC 5545 RRULE。Cloud Composer 支持两种格式：
FREQ=DAILY 格式指定每日重复。
FREQ=WEEKLY;BYDAY=SU,MO,TU,WE,TH,FR,SA 格式指定在一周中的选定几天重复。

以下示例指定星期日、星期三和星期六世界协调时间 (UTC) 01:00 到 07:00 之间的 6 小时维护窗口。2023 年 1 月 1 日这一日期会被忽略。

gcloud composer environments update example-environment \
  --location us-central1 \
  --maintenance-window-start '2023-01-01T01:00:00Z' \
  --maintenance-window-end '2023-01-01T07:00:00Z' \
  --maintenance-window-recurrence 'FREQ=WEEKLY;BYDAY=SU,WE,SA'

API

构建 environments.patch API 请求。
在此请求中：
1. 在参数 updateMask 中，指定 config.maintenanceWindow 掩码。
2. 在请求正文中，指定维护窗口的参数。

{
  "config": {
    "maintenanceWindow": {
      "startTime": "DATETIME_START",
      "endTime": "DATETIME_END",
      "recurrence": "MAINTENANCE_RECURRENCE"
    }
  }
}

您需要将其中的：

将 DATETIME_START 替换为采用日期/时间输入格式的开始日期和时间。只有一天中所指定的时间，指定的日期会被忽略。
将 DATETIME_END 替换为采用日期/时间输入格式的结束日期和时间。只有一天中所指定的时间，指定的日期会被忽略。指定的日期和时间必须晚于开始日期。
将 MAINTENANCE_RECURRENCE 替换为用于恢复维护窗口的 RFC 5545 RRULE。Cloud Composer 支持两种格式：
- FREQ=DAILY 格式指定每日重复。
- FREQ=WEEKLY;BYDAY=SU,MO,TU,WE,TH,FR,SA 格式指定在一周中的选定几天重复。

以下示例指定星期日、星期三和星期六世界协调时间 (UTC) 01:00 到 07:00 之间的 6 小时维护窗口。2023 年 1 月 1 日这一日期会被忽略。

  // PATCH https://composer.googleapis.com/v1/projects/example-project/
  // locations/us-central1/environments/example-environment?updateMask=
  // config.maintenanceWindow

  {
    "config": {
      "maintenanceWindow": {
        "startTime": "2023-01-01T01:00:00Z",
        "endTime": "2023-01-01T07:00:00Z",
        "recurrence": "FREQ=WEEKLY;BYDAY=SU,WE,SA"
      }
    }
  }

Terraform

maintenance_window 块为您的环境指定维护窗口：

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

  config {
    maintenance_window {
      start_time = "DATETIME_START"
      end_time = "DATETIME_END"
      recurrence = "MAINTENANCE_RECURRENCE"
    }
  }
}

您需要将其中的：

ENVIRONMENT_NAME 替换为环境的名称。
LOCATION 替换为环境所在的区域。
将 DATETIME_START 替换为采用日期/时间输入格式的开始日期和时间。只有一天中所指定的时间，指定的日期会被忽略。
将 DATETIME_END 替换为采用日期/时间输入格式的结束日期和时间。只有一天中所指定的时间，指定的日期会被忽略。指定的日期和时间必须晚于开始日期。
将 MAINTENANCE_RECURRENCE 替换为用于恢复维护窗口的 RFC 5545 RRULE。Cloud Composer 支持两种格式：
- FREQ=DAILY 格式指定每日重复。
- FREQ=WEEKLY;BYDAY=SU,MO,TU,WE,TH,FR,SA 格式指定在一周中的选定几天重复。

以下示例指定星期日、星期三和星期六世界协调时间 (UTC) 01:00 到 07:00 之间的 6 小时维护窗口。2023 年 1 月 1 日这一日期会被忽略。

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

  config {
    maintenance_window {
      start_time = "2023-01-01T01:00:00Z"
      end_time = "2023-01-01T07:00:00Z"
      recurrence = "FREQ=WEEKLY;BYDAY=SU,WE,SA"
    }
  }
}

指定维护窗口

维护窗口简介

维护窗口期间会发生什么

默认维护窗口

如何使用维护窗口

为新环境指定维护窗口

为现有环境指定维护窗口

控制台

gcloud

API

Terraform

后续步骤