Wartungsfenster angeben

Cloud Composer 1 | Cloud Composer 2 | Cloud Composer 3

Auf dieser Seite wird erläutert, wie Sie Wartungsfenster für Ihre Umgebungen definieren.

Wartungsfenster

Ein Wartungsfenster ist ein Zeitraum, in dem Sie Cloud Composer erlauben, Wartungsvorgänge auszuführen. Sie können beispielsweise dafür sorgen, dass die Ausführung kritischer Aufgaben nicht unterbrochen wird, indem Sie Wartungsfenster außerhalb der DAG-Zeitplanzeiten angeben.

Mit Wartungsfenstern haben Sie die Kontrolle über die Zeiträume, in denen Ihre Umgebung gewartet werden kann:

  • Wenn Sie benutzerdefinierte Wartungsfenster für Ihre Umgebung definieren, führt Cloud Composer während dieser definierten Zeiträume eine Wartung aus.

  • Wenn Sie keine Wartungsfenster für Ihre Umgebung definieren, führt Cloud Composer jederzeit eine Wartung aus.

Was passiert während Wartungsfenstern?

Wenn Sie Wartungsfenster angeben, stellen Sie für Wartungsvorgänge mindestens 12 Stunden pro Woche zur Verfügung:

  • Ihre Umgebung bleibt während der Wartungsfenster verfügbar. Einige Komponenten Ihrer Umgebung sind während der Wartung möglicherweise vorübergehend nicht verfügbar.

  • Die 12 Stunden sind erforderlich, damit Cloud Composer genügend Zeit hat, um alle Wartungsvorgänge zu planen und durchzuführen. Das bedeutet nicht, dass Wartungen ganze 12 Stunden dauern oder sogar wöchentlich stattfinden.

Sie können Ihre DAGs weiterhin während Wartungsfenstern ausführen, solange es akzeptabel ist, dass einige Aufgaben unterbrochen und wiederholt werden können. Wenn Sie DAGs während der Wartungsfenster ausführen, müssen Sie das Wiederholen von Aufgaben aktivieren. Sie können Aufgabenwiederholungen auf der Airflow-Konfigurations-, DAG- oder Aufgabenebene konfigurieren.

Wartungsvorgänge haben folgende Auswirkungen auf Ihre Umgebung:

  • Die Airflow-UI ist möglicherweise vorübergehend nicht verfügbar.

  • Das Ändern einiger Parameter Ihrer Umgebung oder ein Upgrade auf eine neuere Version ist vorübergehend nicht möglich.

  • Direkte SQL-Abfragen an die Airflow-Datenbank können länger als gewöhnlich dauern und einen erneuten Versuch erfordern.

  • Einige Airflow-Aufgaben können unterbrochen werden. Nach Abschluss des Wartungsvorgangs plant Airflow Wiederholungsversuche für diese Aufgaben, sofern nicht anders konfiguriert.

Standardwartungsfenster

Standardmäßig haben Cloud Composer 1-Umgebungen keine definierten Wartungsfenster, wenn Sie diese mit der Google Cloud Console, der API oder Terraform erstellen. Wir empfehlen, Wartungsfenster für Ihre neuen und vorhandenen Umgebungen anzugeben.

Wenn Sie Ihre Umgebung mit der gcloud CLI erstellen, hat sie wöchentlich freitags, samstags und sonntags Standardwartungsfenster von 00:00:00 bis 04:00:00 (GMT).

Wartungsfenster einsetzen

Wartungsvorgänge können sich auf die Ausführung Ihrer DAGs- und Airflow-Aufgaben auswirken. Daher empfehlen wir Folgendes:

  1. Definieren Sie Wartungsfenster für Ihre Cloud Composer-Umgebungen.

  2. Planen Sie DAG-Ausführungen außerhalb festgelegter Wartungsfenster mithilfe der Parameter start_date und schedule_interval in Ihren DAGs.

Wartungsfenster für neue Umgebungen angeben

Sie können Wartungsfenster beim Erstellen einer Umgebung angeben. Weitere Informationen finden Sie unter Umgebungen erstellen.

Wartungsfenster für vorhandene Umgebungen angeben

Console

Wenn Sie Wartungsfenster für eine vorhandene Umgebung definieren oder ändern möchten, aktualisieren Sie die Umgebung:

  1. Rufen Sie in der Google Cloud Console die Seite Umgebungen auf.

    Zur Seite Umgebungen“

  2. Wählen Sie Ihre Umgebung aus.

  3. Rufen Sie den Tab Umgebungskonfiguration auf.

  4. Klicken Sie neben dem Eintrag Wartungsfenster auf Bearbeiten.

  5. Klicken Sie im Kästchen Wartungsfenster das Kästchen Benutzerdefinierte Zeit für Wartungsfenster festlegen an.

  6. Legen Sie Startzeit, Zeitzone, Tage und Länge fest, sodass die kombinierte Zeit für den angegebenen Zeitplan beträgt mindestens 12 Stunden in einem 7-tägigen rollierenden Zeitfenster. Zum Beispiel bietet ein Zeitraum von vier Stunden jeden Montag, Mittwoch und Freitag die erforderliche Zeitmenge.

  7. Klicken Sie auf Speichern und warten Sie, bis die Umgebung aktualisiert wurde.

gcloud

Beim Aktualisieren einer Umgebung definieren die folgenden Argumente Wartungsfensterparameter:

  • --maintenance-window-start legt den Beginn eines Wartungsfensters fest.
  • --maintenance-window-end legt das Ende eines Wartungsfensters fest.
  • --maintenance-window-recurrence legt die Wiederholung des Wartungsfensters fest.
gcloud composer environments update ENVIRONMENT_NAME \
    --location LOCATION \
    --maintenance-window-start 'DATETIME_START' \
    --maintenance-window-end 'DATETIME_END' \
    --maintenance-window-recurrence 'MAINTENANCE_RECURRENCE'

Ersetzen Sie:

  • ENVIRONMENT_NAME durch den Namen der Umgebung.
  • DATETIME_START durch das Startdatum und die Uhrzeit im Eingabeformat Datum/Uhrzeit. Es wird nur die angegebene Uhrzeit verwendet. Das angegebene Datum wird ignoriert.
  • DATETIME_END durch das Enddatum und die Uhrzeit im Eingabeformat Datum/Uhrzeit. Es wird nur die angegebene Uhrzeit verwendet. Das angegebene Datum wird ignoriert. Das angegebene Datum und die angegebene Uhrzeit müssen nach dem Startdatum liegen.

  • MAINTENANCE_RECURRENCE mit einer RFC 5545 RRULE für Wiederholungsversuche von Wartungsfenstern. Cloud Composer unterstützt zwei Formate:

  • Das Format FREQ=DAILY gibt eine tägliche Wiederholung an.

  • Das Format FREQ=WEEKLY;BYDAY=SU,MO,TU,WE,TH,FR,SA gibt eine Wiederholung an ausgewählten Wochentagen an.

Im folgenden Beispiel wird ein sechsstündiges Wartungsfenster zwischen 01:00 und 07:00 Uhr (UTC) angegeben, das mittwochs, samstags und sonntags stattfindet. Das Datum 1. Januar 2023 wird ignoriert.

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

  1. Erstellen Sie eine API-Anfrage environments.patch.

  2. In dieser Anfrage:

    1. Geben Sie im updateMask-Parameter die config.maintenanceWindow-Maske an.

    2. Geben Sie im Anfragetext die Parameter für Wartungsfenster an.

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

Ersetzen Sie:

  • DATETIME_START durch das Startdatum und die Uhrzeit im Eingabeformat Datum/Uhrzeit. Es wird nur die angegebene Uhrzeit verwendet. Das angegebene Datum wird ignoriert.
  • DATETIME_END durch das Enddatum und die Uhrzeit im Eingabeformat Datum/Uhrzeit. Es wird nur die angegebene Uhrzeit verwendet. Das angegebene Datum wird ignoriert. Das angegebene Datum und die angegebene Uhrzeit müssen nach dem Startdatum liegen.

  • MAINTENANCE_RECURRENCE mit einer RFC 5545 RRULE für Wiederholungsversuche von Wartungsfenstern. Cloud Composer unterstützt zwei Formate:

    • Das Format FREQ=DAILY gibt eine tägliche Wiederholung an.
    • Das Format FREQ=WEEKLY;BYDAY=SU,MO,TU,WE,TH,FR,SA gibt eine Wiederholung an ausgewählten Wochentagen an.

Im folgenden Beispiel wird ein sechsstündiges Wartungsfenster zwischen 01:00 und 07:00 Uhr (UTC) angegeben, das mittwochs, samstags und sonntags stattfindet. Das Datum 1. Januar 2023 wird ignoriert.

  // 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

Der Block maintenance_window gibt die Wartungsfenster für Ihre Umgebung an:

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"
    }
  }
}

Ersetzen Sie:

  • ENVIRONMENT_NAME durch den Namen der Umgebung.
  • LOCATION durch die Region, in der sich die Umgebung befindet.
  • DATETIME_START durch das Startdatum und die Uhrzeit im Eingabeformat Datum/Uhrzeit. Es wird nur die angegebene Uhrzeit verwendet. Das angegebene Datum wird ignoriert.
  • DATETIME_END durch das Enddatum und die Uhrzeit im Eingabeformat Datum/Uhrzeit. Es wird nur die angegebene Uhrzeit verwendet. Das angegebene Datum wird ignoriert. Das angegebene Datum und die angegebene Uhrzeit müssen nach dem Startdatum liegen.

  • MAINTENANCE_RECURRENCE mit einer RFC 5545 RRULE für Wiederholungsversuche von Wartungsfenstern. Cloud Composer unterstützt zwei Formate:

    • Das Format FREQ=DAILY gibt eine tägliche Wiederholung an.
    • Das Format FREQ=WEEKLY;BYDAY=SU,MO,TU,WE,TH,FR,SA gibt eine Wiederholung an ausgewählten Wochentagen an.

Im folgenden Beispiel wird ein sechsstündiges Wartungsfenster zwischen 01:00 und 07:00 Uhr (UTC) angegeben, das mittwochs, samstags und sonntags stattfindet. Das Datum 1. Januar 2023 wird ignoriert.

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"
    }
  }
}

Nächste Schritte