Cloud Composer 1 Cloud Composer 2
Auf dieser Seite wird beschrieben, wie Sie mit Cloud Functions Cloud Composer-DAGs als Reaktion auf Ereignisse auslösen.
Apache Airflow ist so konzipiert, dass DAGs nach einem regelmäßigen Zeitplan ausgeführt werden. Sie können DAGs aber auch als Reaktion auf Ereignisse auslösen. Eine Möglichkeit dafür ist die Verwendung von Cloud Functions, um Cloud Composer-DAGs auszulösen, wenn ein bestimmtes Ereignis eintritt.
Im vorliegenden Beispiel wird bei jeder Änderung an einem Cloud Storage-Bucket ein DAG ausgeführt. Änderungen an einem Objekt in einem Bucket lösen eine Funktion aus. Diese Funktion stellt eine Anfrage an die Airflow REST API Ihrer Cloud Composer-Umgebung. Airflow verarbeitet diese Anfrage und führt einen DAG aus. Der DAG gibt Informationen zur Änderung aus.
Hinweise
Netzwerkkonfiguration der Umgebung prüfen
Diese Lösung funktioniert nicht in Konfigurationen für private IP-Adressen und VPC Service Controls, da in diesen Konfigurationen keine Verbindung von Cloud Functions zum Airflow-Webserver konfiguriert werden kann.
In Cloud Composer 2 können Sie einen anderen Ansatz verfolgen: DAGs mit Cloud Functions und Pub/Sub-Nachrichten auslösen
Die APIs für Ihr Projekt aktivieren
Console
Enable the Cloud Composer and Cloud Functions APIs.
gcloud
Enable the Cloud Composer and Cloud Functions APIs:
gcloud services enable cloudfunctions.googleapis.comcomposer.googleapis.com
Airflow REST API aktivieren
Abhängig von Ihrer Airflow-Version:
- Bei Airflow 2 ist die stabile REST API bereits standardmäßig aktiviert. Wenn in Ihrer Umgebung die stabile API deaktiviert ist, aktivieren Sie die stabile REST API.
- Aktivieren Sie für Airflow 1 die experimentelle REST API.
API-Aufrufe an die Airflow REST API mithilfe der Webserverzugriffssteuerung zulassen
Cloud Functions kann die Airflow REST API entweder über IPv4- oder IPv6-Adresse kontaktieren.
Wenn Sie sich nicht sicher sind, welcher IP-Bereich aufgerufen werden soll, verwenden Sie die Standardkonfigurationsoption All IP addresses have access (default)
in der Webserverzugriffssteuerung, um Ihre Cloud Functions-Funktionen nicht versehentlich zu blockieren.
Cloud Storage-Bucket erstellen
In diesem Beispiel wird als Reaktion auf Änderungen in einem Cloud Storage-Bucket ein DAG ausgelöst. Erstellen Sie einen neuen Bucket, den Sie in diesem Beispiel verwenden möchten.
URL des Airflow-Webservers abrufen
In diesem Beispiel werden REST API-Anfragen an den Endpunkt des Airflow-Webservers gestellt.
Sie verwenden den Teil der URL der Airflow-Weboberfläche vor .appspot.com
in Ihrem Cloud Function-Code.
Console
Rufen Sie in der Google Cloud Console die Seite Umgebungen auf.
Klicken Sie auf den Namen Ihrer Umgebung.
Wechseln Sie auf der Seite Umgebungsdetails zum Tab Umgebungskonfiguration.
Die URL des Airflow-Webservers ist im Element Airflow-Web-UI aufgeführt.
gcloud
Führen Sie dazu diesen Befehl aus:
gcloud composer environments describe ENVIRONMENT_NAME \
--location LOCATION \
--format='value(config.airflowUri)'
Ersetzen Sie:
ENVIRONMENT_NAME
durch den Namen der Umgebung.LOCATION
durch die Region, in der sich die Umgebung befindet.
client_id des IAM-Proxys abrufen
Für eine Anfrage an den Airflow REST API-Endpunkt benötigt die Funktion die Client-ID des Identity and Access Management-Proxys, der den Airflow-Webserver schützt.
Cloud Composer stellt diese Informationen nicht direkt zur Verfügung. Stellen Sie stattdessen eine nicht authentifizierte Anfrage an den Airflow-Webserver und erfassen Sie die Client-ID aus der Weiterleitungs-URL:
cURL
curl -v AIRFLOW_URL 2>&1 >/dev/null | grep -o "client_id\=[A-Za-z0-9-]*\.apps\.googleusercontent\.com"
Ersetzen Sie AIRFLOW_URL
durch die URL der Airflow-Weboberfläche.
Suchen Sie in der Ausgabe nach dem String, der auf client_id
folgt. Beispiel:
client_id=836436932391-16q2c5f5dcsfnel77va9bvf4j280t35c.apps.googleusercontent.com
Python
Speichern Sie den folgenden Code in einer Datei mit dem Namen get_client_id.py
. Geben Sie die Werte für project_id
, location
und composer_environment
ein und führen Sie dann den Code in Cloud Shell oder Ihrer lokalen Umgebung aus.
DAG in Ihre Umgebung hochladen
Laden Sie einen DAG in Ihre Umgebung hoch. Der folgende Beispiel-DAG gibt die empfangene DAG-Ausführungskonfiguration aus. Sie lösen diesen DAG über eine Funktion aus, die Sie später in dieser Anleitung erstellen.
Cloud Functions-Funktion bereitstellen, die den DAG auslöst
Sie können eine Cloud Function mit Ihrer bevorzugten Sprache bereitstellen, die von Cloud Functions oder Cloud Run unterstützt wird. In dieser Anleitung wird eine in Python und Java implementierte Cloud Functions-Funktion veranschaulicht.
Cloud Functions-Funktion-Konfigurationsparameter angeben
Trigger Wählen Sie für dieses Beispiel einen Trigger aus, der arbeitet, wenn ein neues Objekt in einem Bucket erstellt oder ein vorhandenes Objekt überschrieben wird.
Triggertyp Cloud Storage
Ereignistyp Abschließen/Erstellen
Bucket Wählen Sie einen Bucket aus, der diese Funktion auslösen muss.
Bei Fehler noch einmal versuchen Wir empfehlen, diese Option für dieses Beispiel zu deaktivieren. Wenn Sie Ihre eigene Funktion in einer Produktionsumgebung verwenden, aktivieren Sie diese Option, um temporäre Fehler zu beheben.
Laufzeitdienstkonto im Bereich Laufzeit, Build, Verbindungen und Sicherheitseinstellungen Verwenden Sie je nach Bedarf eine der folgenden Optionen:
Wählen Sie Compute Engine-Standarddienstkonto aus. Mit IAM-Standardberechtigungen kann dieses Konto Funktionen ausführen, die auf Cloud Composer-Umgebungen zugreifen.
Erstellen Sie ein benutzerdefiniertes Dienstkonto mit der Rolle Composer User und geben Sie es als Laufzeitdienstkonto für diese Funktion an. Diese Option folgt dem Prinzip der geringsten Berechtigung.
Laufzeit und Einstiegspunkt im Schritt Code. Wählen Sie beim Hinzufügen von Code für dieses Beispiel die Laufzeit Python 3.7 oder höher aus und geben Sie
trigger_dag
als Einstiegspunkt an.
Anforderungen hinzufügen
Geben Sie die Abhängigkeiten in der Datei requirements.txt
an:
Fügen Sie den folgenden Code in die Datei main.py
ein und ersetzen Sie Folgendes:
Ersetzen Sie den Wert der Variablen
client_id
durch den Wertclient_id
, den Sie zuvor erhalten haben.Ersetzen Sie den Wert der Variable
webserver_id
durch die Mandantenprojekt-ID, die Teil der URL der Airflow-Weboberfläche vor.appspot.com
ist. Sie haben die URL der Airflow-Weboberfläche bereits abgerufen.Geben Sie die von Ihnen verwendete Airflow REST API-Version an:
- Wenn Sie die stabile Airflow API verwenden, legen Sie die Variable
USE_EXPERIMENTAL_API
aufFalse
fest. - Wenn Sie die experimentelle Airflow REST API verwenden, sind keine Änderungen erforderlich. Die Variable
USE_EXPERIMENTAL_API
ist bereits aufTrue
festgelegt.
- Wenn Sie die stabile Airflow API verwenden, legen Sie die Variable
Funktion testen
So prüfen Sie, ob Funktion und DAG wie vorgesehen funktionieren:
- Warten Sie, bis die Funktion bereitgestellt ist.
- Laden Sie eine Datei in Ihren Cloud Storage-Bucket hoch. Alternativ können Sie die Funktion auch manuell auslösen. Wählen Sie dazu in der Google Cloud Console die Aktion Funktion testen dafür aus.
- Rufen Sie die DAG-Seite in der Airflow-Weboberfläche auf. Der DAG sollte eine aktive oder bereits abgeschlossene DAG-Ausführung haben.
- Prüfen Sie in der Airflow-UI die Tasklogs für diese Ausführung. Die Aufgabe
print_gcs_info
sollte die von der Funktion empfangenen Daten an die Logs ausgeben:
[2021-04-04 18:25:44,778] {bash_operator.py:154} INFO - Output:
[2021-04-04 18:25:44,781] {bash_operator.py:158} INFO - Triggered from GCF:
{bucket: example-storage-for-gcf-triggers, contentType: text/plain,
crc32c: dldNmg==, etag: COW+26Sb5e8CEAE=, generation: 1617560727904101,
... }
[2021-04-04 18:25:44,781] {bash_operator.py:162} INFO - Command exited with
return code 0h
Nächste Schritte
- Airflow-UI aufrufen
- Auf die Airflow REST API zugreifen
- DAGs schreiben
- Cloud Functions-Funktionen schreiben
- Google Cloud Storage-Trigger