Umgebungs-Snapshots speichern und laden

Cloud Composer 1 Cloud Composer 2

Auf dieser Seite wird erläutert, wie Sie den Status Ihrer Umgebung mithilfe von Umgebungs-Snapshots speichern und laden.

Sie können die Umgebung so konfigurieren, dass Snapshots automatisch gespeichert werden. Weitere Informationen finden Sie unter Geplante Snapshots konfigurieren.

Informationen zu Umgebungs-Snapshots

Umgebungs-Snapshots speichern den Status Ihrer Umgebung. Sie können Umgebungs-Snapshots bei Bedarf speichern und laden.

Sie können Snapshots für Folgendes verwenden:

  • Stellen Sie Ihre Umgebung auf einen früheren Zustand zurück. Erstellen Sie Sicherungen Ihrer Umgebung mit Snapshots und laden Sie einen der Snapshots, um Ihre Umgebung wiederherzustellen. Sie können beispielsweise einen Aktualisierungsvorgang rückgängig machen, bei dem PyPI-Pakete installiert oder Airflow-Konfigurationsoptionen überschrieben werden, auch wenn Ihre Umgebung erfolgreich aktualisiert wurde.

  • Parallele Upgrades ausführen und Umgebungen kopieren. Erstellen Sie einen Snapshot einer vorhandenen Umgebung, erstellen Sie eine neue Umgebung, die dieselbe oder eine neuere Version von Cloud Composer verwendet, und wenden Sie dann den Snapshot auf diese neue Umgebung an. Dieser Vorgang ähnelt dem Migrieren. Pausieren Sie DAGs, bevor Sie den Snapshot erstellen, um doppelte DAG-Ausführungen zu vermeiden.

So werden Snapshots gespeichert

Ein Umgebungs-Snapshot ist eine Gruppe von Dateien, die den Status Ihrer Umgebung beschreiben und die Sicherung der Umgebungsdaten speichern.

Sie können mehrere Snapshots Ihrer Umgebung erstellen. Umgebungs-Snapshots sind nicht inkrementell. Sie können einen beliebigen Snapshot unabhängig von anderen Snapshots verwenden.

Cloud Composer löscht keine Snapshots, wenn Sie Ihre Umgebung löschen.

Standardmäßig speichert Cloud Composer Snapshots im Ordner snapshots/ im Bucket Ihrer Umgebung. Sie können auch einen benutzerdefinierten Standort angeben, wenn Sie einen Snapshot erstellen.

In der Cloud Storage-UI werden die Daten der Einfachheit halber als Ordner angezeigt. Buckets funktionieren in einer flachen Dateistruktur. Dies hat keine Auswirkungen auf das Speichern und Laden von Snapshots in der Google Cloud Console. Es ist jedoch ein wichtiger Unterschied, den Sie berücksichtigen sollten, wenn Sie Vorgänge direkt für die Dateien in Ihrem Bucket ausführen. Weitere Informationen finden Sie unter Ordner.

Sicherheitsaspekte für Snapshots

Um dieses Sicherheitsrisiko zu minimieren, können Sie vertrauliche Informationen, die von Airflow-DAGs verwendet werden, wie Schlüssel oder Passwörter, in Secret Manager speichern. Weitere Informationen finden Sie unter Secret Manager für Ihre Umgebung konfigurieren.

Prüfen Sie die Sicherheitsberechtigungen für den Bucket Ihrer Umgebung. Wenn Sie Umgebungs-Snapshots in einem benutzerdefinierten Bucket speichern, müssen Sie die Zugriffsberechtigungen dafür in Ihrem Projekt richtig konfigurieren. Achten Sie beim Zuweisen von Berechtigungen darauf, dass das Dienstkonto dieser Umgebung ausreichende Berechtigungen zum Speichern und Laden von Snapshots aus dem Bucket hat.

Welche Daten werden in Snapshots gespeichert?

Cloud Composer speichert die folgenden Daten in Snapshots:

  • Airflow-Konfigurationsüberschreibungen.
  • Umgebungsvariablen.
  • Liste der benutzerdefinierten PyPI-Pakete als Anforderungen.
  • Eine Sicherung der Airflow-Datenbank, einschließlich des Status der ausgeführten Aufgaben und des DAG-Ausführungsverlaufs.
  • Eine Sicherung der Ordner /dags, /data und /plugins aus dem Bucket der Umgebung.
  • Den Ferrierschlüssel der Umgebung.
  • Weitere Informationen zur Konfiguration der Umgebung, z. B. die Skalierungs- und Leistungsparameter der Umgebung. Cloud Composer verwendet diese Informationen nicht, wenn Snapshots geladen werden.

Welche Daten aus Snapshots geladen werden

Cloud Composer lädt die folgenden Daten aus Snapshots:

  • Airflow-Konfigurationsüberschreibungen.
  • Umgebungsvariablen.
  • Benutzerdefinierte PyPI-Pakete, es sei denn, Sie überspringen die Installation.

  • Der Inhalt der Airflow-Datenbank, einschließlich des Status der ausgeführten Aufgaben und des DAG-Ausführungsverlaufs.

  • Der Inhalt der Ordner /dags, /data und /plugins aus dem Snapshot wird in den Bucket der Umgebung geladen.

  • Der Ferritschlüssel aus dem Snapshot wird verwendet, um die Daten aus dem Snapshot mit dem eigenen Ferrnetschlüssel zu verschlüsseln. Der Ferritschlüssel der Umgebung bleibt unverändert.

Obwohl Cloud Composer einige Informationen zur Konfiguration der Umgebung in Snapshots speichert, wird sie nicht beim Laden von Snapshots verwendet. Die folgenden Parameter Ihrer Umgebung ändern sich beim Laden eines Snapshots nicht:

  • Umgebungskonfiguration, z. B. Umgebungsskalierung und Leistungsparameter
  • Netzwerkkonfiguration der Umgebung.
  • Inhalt des Buckets der Umgebung außerhalb der Ordner /dags, /data und /plugins.
  • Umgebungslabels.

Alle Einstellungen, die Sie in der Cloud Composer-Infrastruktur angewendet haben, ohne die Cloud Composer API zu verwenden, können beim Laden eines Snapshots verloren gehen.

Teilweise abgeschlossene Vorgänge

Wenn Sie einen Snapshot laden, kann der Vorgang erfolgreich, fehlgeschlagen oder teilweise abgeschlossen sein:

  • Bei erfolgreichen Vorgängen werden alle Daten aus dem Snapshot geladen.
  • Fehlgeschlagene Vorgänge führen nicht zu Änderungen.
  • Bei teilweise abgeschlossenen Vorgängen wird ein Teil der Daten aus dem Snapshot geladen. Solche Vorgänge werden als fehlgeschlagen gemeldet, aber die Fehlermeldung gibt an, welche Daten erfolgreich geladen wurden. Wenn beispielsweise PyPI-Pakete installiert sind, die Airflow-Konfigurationsoption aber nicht überschrieben wurde, gibt die Fehlermeldung dies an.

Bei einem teilweise abgeschlossenen Vorgang können Sie versuchen, denselben Snapshot noch einmal zu laden. Cloud Composer überspringt die Schritte, die beim vorherigen Versuch erfolgreich waren. Wenn ein Vorgang beispielsweise bei einer Zeitüberschreitung fehlgeschlagen ist, die Datenbank jedoch erfolgreich geladen wurde, wird die Datenbank beim nächsten Versuch nicht noch einmal geladen.

Hinweis

  • Snapshots werden in Cloud Composer 2.0.9 und höher unterstützt. Cloud Composer 1 unterstützt das Speichern von Umgebungs-Snapshots für Versionen ab 1.18.5.

  • Snapshots erstellen keine Umgebung. Wenn Sie einen Snapshot aus einer Umgebung in eine andere Umgebung laden möchten, müssen Sie zuerst eine neue Umgebung erstellen und dann den Snapshot in diese Umgebung laden.

  • Sie können keine Snapshots in Umgebungen laden, die den Fehlerstatus haben. Solche Umgebungen können nicht durch Laden eines Snapshots korrigiert werden. Sie können einen vorhandenen Snapshot aber weiterhin in eine neue Umgebung laden.

  • Sie können Snapshots nur in dieselbe oder eine spätere Version von Cloud Composer oder Airflow laden. Sie können beispielsweise keinen Snapshot von Cloud Composer 2.0.2 in eine Umgebung mit Cloud Composer 2.0.1 laden. Ein weiteres Beispiel: Sie können keinen Snapshot von Airflow 2.2.3 zu Airflow 2.1.4 laden.

  • Snapshots ändern die Cloud Composer-Version nicht. Wenn Sie für Ihre Umgebung ein Upgrade auf eine neuere Version von Cloud Composer ausführen, dann einen Snapshot von einer älteren Version laden, bleibt die aktuelle Version von Cloud Composer immer in Ihrer Umgebung erhalten. Wenn Sie beispielsweise einen Snapshot von Cloud Composer 2.0.1 in Cloud Composer 2.0.2 laden, wird die Umgebung nicht wieder in Cloud Composer 2.0.1 umgewandelt.

  • Die maximale Größe der Airflow-Datenbank, die Snapshots unterstützt, beträgt 20 GB. Wenn die Datenbank Ihrer Umgebung mehr als 20 GB benötigt, verringern Sie die Größe der Airflow-Datenbank, bevor Sie einen Snapshot speichern.

  • Wenn Sie Snapshots an einem Ort außerhalb des Buckets Ihrer Umgebung speichern, muss das Dienstkonto Ihrer Umgebung Lese- und Schreibberechtigungen für den angegebenen Standort haben. Beispiel: Die Rolle Storage-Objekt-Administrator hat solche Berechtigungen. Sie können sie auf ein Projekt oder einen bestimmten Bucket anwenden.

  • Für das Erstellen und Speichern von Snapshots fallen zusätzliche Kosten an, die für Cloud Storage gelten. Weitere Informationen finden Sie unter Preise.

Umgebungs-Snapshot speichern

Cloud Composer speichert Umgebungs-Snapshots in einem Unterordner, bezogen auf den von Ihnen angegebenen Ordner. Der Ordnername enthält die Projekt-ID, den Speicherort der Umgebung, den Namen der Umgebung und den Zeitstempel für den Snapshot. Beispiel: /snapshots/example-project_us-central1_example-environment_2022-01-05T18-59-00.

Console

So erstellen Sie einen Snapshot Ihrer Umgebung:

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

    Zur Seite Umgebungen“

  2. Klicken Sie in der Liste der Umgebungen auf den Namen Ihrer Umgebung. Die Seite Umgebungsdetails wird geöffnet.

  3. Klicken Sie auf Snapshot speichern.

  4. Wählen Sie im Dialogfeld Snapshot speichern aus, wo der Snapshot gespeichert werden soll:

    • Wählen Sie Snapshot-Ordner im Umgebungs-Bucket verwenden (Standard) aus, um den Snapshot im Ordner /snapshots im Umgebungs-Bucket zu speichern.

    • Wählen Sie Benutzerdefinierten Ordner in einem anderen Bucket verwenden aus, um den Snapshot im benutzerdefinierten Ordner zu speichern, und geben Sie dann einen Speicherort an.

  5. Klicken Sie auf Speichern.

gcloud

Mit dem Befehl gcloud beta composer environments snapshots save wird ein Snapshot Ihrer Umgebung gespeichert.

  • Das Argument snapshot-location gibt einen Ordner an, in dem der Snapshot gespeichert wird. Standardmäßig werden Snapshots im Ordner /snapshots im Bucket Ihrer Umgebung gespeichert. Beispiel: gs://us-central1-example-916807e1-bucket/snapshots. Sie können auch einen anderen Ordner angeben.

Führen Sie den folgenden Befehl aus, um einen Snapshot Ihrer Umgebung zu speichern:

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

Ersetzen Sie:

  • ENVIRONMENT_NAME durch den Namen der Umgebung.
  • LOCATION durch die Region, in der sich die Umgebung befindet.
  • (Optional) SNAPSHOTS_FOLDER durch den URI eines Bucket-Ordners, in dem der Snapshot gespeichert wird. Wenn Sie dieses Argument weglassen, speichert Cloud Composer den Snapshot im Ordner /snapshots im Bucket Ihrer Umgebung.

Im folgenden Beispiel wird der Standardspeicherort verwendet:

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

Im folgenden Beispiel wird ein benutzerdefinierter Ordner gespeichert:

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

API

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

  2. Geben Sie im Anfragetext im Feld snapshotLocation den Ordner an, in dem der Snapshot gespeichert werden soll.

{
  "snapshotLocation": "SNAPSHOTS_FOLDER"
}

Ersetzen Sie:

  • SNAPSHOTS_FOLDER durch den URI eines Bucket-Ordners, in dem der Snapshot gespeichert wird.

Beispiel:

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

Umgebungs-Snapshots können nicht aus Terraform gespeichert und geladen werden.

Das Speichern und Laden von Snapshots sind Aktionen, die in einer Umgebung ausgeführt werden. Die resultierenden Snapshots sind nicht Teil der Definition einer Umgebung. Da Terraform nur die Konfiguration der Cloud Composer-Umgebung verwaltet, können Sie in dieser Umgebung keine Snapshots von Umgebungen speichern oder laden.

Umgebungs-Snapshot laden

Berücksichtigen Sie die folgende Situation. Beispiel: Catch-up ist aktiviert und Airflow führt einen DAG nach einem Zeitplan zwischen dem Zeitpunkt der Erstellung des Snapshots und dem Zeitpunkt des Ladens aus. In diesem Fall hat Airflow nach dem Laden des Snapshots keine Informationen zur ausgeführten DAG-Ausführung, sodass Airflow den DAG für dieselbe Zeit und dieselben Daten noch einmal ausführt.

Ein weiteres Beispiel ist ein DAG mit täglichem Zeitplan. Sie erstellen einen Snapshot, führt Airflow diesen DAG aus und lädt den Snapshot am selben Tag. In diesem Fall führt Airflow den DAG noch einmal aus, auch wenn das Nachholen deaktiviert ist.

Console

So laden Sie einen Snapshot in Ihre Cloud Composer 2-Umgebung:

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

    Zur Seite Umgebungen“

  2. Klicken Sie in der Liste der Umgebungen auf den Namen Ihrer Umgebung. Die Seite Umgebungsdetails wird geöffnet.

  3. Klicken Sie auf Snapshot laden.

  4. Klicken Sie im Dialogfeld Snapshot laden auf Durchsuchen.

  5. Wählen Sie einen Ordner aus, in dem der Snapshot gespeichert wird. Der Name des Ordners enthält die ID Ihres Projekts, den Standort der Umgebung und den Zeitstempel, an dem der Snapshot gespeichert wurde. Beispiel: /snapshots/example-project_us-central1_example-environment_2022-01-05T18-59-00

  6. Optional: Wenn Sie die Installation benutzerdefinierter PyPI-Pakete aus dem Snapshot überspringen möchten, wählen Sie Installation von PyPI-Paketen überspringen aus. Wenn Sie einen Snapshot einer Umgebung mit installierten benutzerdefinierten PyPI-Paketen laden, installiert Cloud Composer diese benutzerdefinierten Pakete nicht.

  7. Klicken Sie auf Laden und warten Sie, bis Cloud Composer den Snapshot lädt.

gcloud

Mit dem Befehl gcloud beta composer environments snapshots load wird ein Snapshot in Ihre Umgebung geladen.

  • Das Argument --snapshot-path gibt einen Ordner an, in dem sich der Snapshot befindet.

    Der Name des Ordners enthält die ID Ihres Projekts, den Standort der Umgebung und den Zeitstempel, an dem der Snapshot gespeichert wurde. Beispiel: gs://us-central1-example-916807e1-bucket/snapshots/example-project_us-central1_example-environment_2022-01-05T18-59-00

  • Optional: Das Argument --skip-pypi-packages-installation überspringt die Installation benutzerdefinierter PyPI-Pakete aus dem Snapshot. Wenn Sie einen Snapshot einer Umgebung mit installierten benutzerdefinierten PyPI-Paketen laden, installiert Cloud Composer diese benutzerdefinierten Pakete nicht.

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

Ersetzen Sie:

  • DESTINATION_ENVIRONMENT_NAME durch den Namen der Umgebung, in die Sie den Snapshot laden möchten.
  • LOCATION durch die Region, in der sich die Umgebung befindet.
  • SNAPSHOT_PATH durch den URI eines Buckets, gefolgt vom Pfad zum Snapshot.

Beispiel:

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. Erstellen Sie eine API-Anfrage environments.loadSnapshot.

  2. Geben Sie im Anfragetext im Feld snapshotPath den URI eines Buckets an, gefolgt vom Pfad zum Snapshot. Der Name des Ordners enthält die ID Ihres Projekts, den Standort der Umgebung und den Zeitstempel, als der Snapshot gespeichert wurde. Beispiel: gs://us-central1-example-916807e1-bucket/snapshots/example-project_us-central1_example-environment_2022-01-05T18-59-00

  3. (Optional) Geben Sie im Anfragetext im Feld skipPypiPackagesInstallation an, ob Cloud Composer die Installation benutzerdefinierter PyPI-Pakete aus dem Snapshot überspringen muss. Wenn Sie einen Snapshot einer Umgebung mit installierten benutzerdefinierten PyPI-Paketen laden, installiert Cloud Composer diese benutzerdefinierten Pakete nicht.

    Dieses Feld ist optional. Wenn Sie dieses Feld weglassen, installiert Cloud Composer PyPI-Pakete aus dem Snapshot.

{
  "snapshotPath": "SNAPSHOT_PATH"
}

Ersetzen Sie:

  • SNAPSHOT_PATH durch den URI eines Bucket-Ordners, in dem der Snapshot gespeichert wird.

Beispiel:

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

Umgebungs-Snapshots können mit Terraform nicht gespeichert und geladen werden.

Das Speichern und Laden von Snapshots sind Aktionen, die in einer Umgebung ausgeführt werden. Die resultierenden Snapshots sind nicht Teil der Definition einer Umgebung. Da Terraform nur die Konfiguration der Cloud Composer-Umgebung verwaltet, können Sie in dieser Umgebung keine Snapshots von Umgebungen speichern oder laden.

Nächste Schritte