Managed Service for Apache Airflow-DAGs mit Cloud Run-Funktionen und der Airflow REST API auslösen

Managed Airflow (Gen 3) | Managed Airflow (Gen 2) | Managed Airflow (Legacy Gen 1)

Auf dieser Seite wird beschrieben, wie Sie mit Cloud Run-Funktionen Managed Service for Apache Airflow-DAGs als Reaktion auf Ereignisse auslösen.

**Hinweis**: Sie können DAGs auch nur mit der Airflow REST API auslösen.

Apache Airflow ist für das regelmäßige Ausführen von DAGs nach Plan konzipiert. Sie können DAGs aber auch als Reaktion auf Ereignisse auslösen lassen. Eine Möglichkeit dazu ist, Cloud Run-Funktionen zu verwenden, um Managed Airflow-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 beliebigen Objekt in einem Bucket lösen eine Funktion aus. Diese Funktion sendet eine Anfrage an die Airflow REST API Ihrer Managed Airflow-Umgebung. Airflow verarbeitet diese Anfrage und führt einen DAG aus. Der DAG gibt Informationen zur Änderung aus.

**Hinweis**: In einer alternativen Anleitung wird beschrieben, wie Sie eine Funktion erstellen, die einen DAG auslöst, wenn eine Nachricht an ein Pub/Sub-Thema gesendet wird.

Hinweis

Netzwerkkonfiguration Ihrer Umgebung prüfen

Diese Lösung funktioniert nicht in Konfigurationen mit privater IP-Adresse und VPC Service Controls, da es in diesen Konfigurationen nicht möglich ist, die Verbindung von Cloud Run-Funktionen zum Airflow-Webserver zu konfigurieren.

In Managed Airflow (Gen 2) können Sie einen anderen Ansatz verwenden: DAGs mit Cloud Run-Funktionen und Pub/Sub-Nachrichten auslösen

Die APIs für Ihr Projekt aktivieren

Console

Aktivieren Sie die Managed Airflow API und die Cloud Run Functions API.

Erforderliche Rollen zum Aktivieren von APIs

Zum Aktivieren von APIs benötigen Sie die IAM-Rolle „Service Usage-Administrator“ (roles/serviceusage.serviceUsageAdmin), die die Berechtigung serviceusage.services.enable enthält. Informationen zum Zuweisen von Rollen.

APIs aktivieren

gcloud

Aktivieren Sie die Managed Airflow API und die Cloud Run Functions API:

Erforderliche Rollen zum Aktivieren von APIs

Zum Aktivieren von APIs benötigen Sie die IAM-Rolle „Service Usage-Administrator“ (roles/serviceusage.serviceUsageAdmin), die die Berechtigung serviceusage.services.enable enthält. Informationen zum Zuweisen von Rollen.

gcloud services enable cloudfunctions.googleapis.com composer.googleapis.com

Airflow REST API aktivieren

Für Airflow 2 ist die stabile REST API bereits standardmäßig aktiviert. Wenn die stabile API in Ihrer Umgebung deaktiviert ist, dann aktivieren Sie sie.

API-Aufrufe an die Airflow REST API mit der Webserver-Zugriffssteuerung zulassen

Cloud Run-Funktionen können die Airflow REST API entweder über eine IPv4- oder IPv6-Adresse erreichen.

Wenn Sie nicht sicher sind, welcher aufrufende IP-Bereich verwendet wird, verwenden Sie die Standardkonfigurationsoption in der Webserver-Zugriffssteuerung All IP addresses have access (default), um Ihre Cloud Run-Funktionen nicht versehentlich zu blockieren.

Cloud Storage-Bucket erstellen

In diesem Beispiel wird ein DAG als Reaktion auf Änderungen in einem Cloud Storage-Bucket ausgelöst. Erstellen Sie einen neuen Bucket zur Verwendung in diesem Beispiel.

Hinweis: Verwenden Sie keine Managed Airflow-Umgebungs-Buckets, da die Funktion sonst mehrmals pro Sekunde ausgelöst werden kann. Für dieses Beispiel empfehlen wir, einen separaten Bucket zu erstellen.

URL des Airflow-Webservers abrufen

In diesem Beispiel werden REST API-Anfragen an den Airflow-Webserver-Endpunkt gesendet. Sie verwenden die URL des Airflow-Webservers in Ihrem Cloud Function-Code.

Console

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

   Zur Seite „Umgebungen“

2. Klicken Sie auf den Namen Ihrer Umgebung.

3. Wechseln Sie auf der Seite Umgebungsdetails zum Tab Umgebungskonfiguration.

4. 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.

Laden Sie einen DAG in Ihre Umgebung hoch.

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.

import datetime

import airflow
from airflow.operators.bash import BashOperator


with airflow.DAG(
    "composer_sample_trigger_response_dag",
    start_date=datetime.datetime(2021, 1, 1),
    # Not scheduled, trigger only
    schedule_interval=None,
) as dag:
    # Print the dag_run's configuration, which includes information about the
    # Cloud Storage object change.
    print_gcs_info = BashOperator(
        task_id="print_gcs_info", bash_command="echo {{ dag_run.conf }}"
    )

Cloud Functions-Funktion bereitstellen, die den DAG auslöst

Sie können eine Cloud Function in Ihrer bevorzugten Sprache bereitstellen, die von Cloud Run Functions oder Cloud Run unterstützt wird. In dieser Anleitung wird eine Cloud Functions-Funktion in Python und Java gezeigt.

Cloud Functions-Funktion-Konfigurationsparameter angeben

• Umgebung. Wählen Sie 1. Generation aus.

• 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 vorübergehende Fehler zu beheben.

• Laufzeitdienstkonto im Abschnitt Laufzeit, Build, Verbindungen und Sicherheitseinstellungen. Verwenden Sie je nach Ihren Einstellungen eine der folgenden Optionen:

  • Wählen Sie Compute Engine-Standarddienstkonto aus. Mit den Standard-IAM-Berechtigungen kann dieses Konto Funktionen ausführen, die auf Managed Airflow-Umgebungen zugreifen.

  • Erstellen Sie ein benutzerdefiniertes Dienstkonto mit der Rolle Composer-Nutzer und geben Sie es als Laufzeit Dienstkonto für diese Funktion an. Diese Option folgt dem Prinzip der geringsten Berechtigung.

• Laufzeit und Einstiegspunkt im Schritt Code:

  • (Python) Wenn Sie Code für dieses Beispiel hinzufügen, wählen Sie die Laufzeit Python 3.7 oder höher aus und geben Sie trigger_dag_gcf als Einstiegspunkt an.

  • (Java) Wenn Sie Code für dieses Beispiel hinzufügen, wählen Sie die Laufzeit Java 17 aus und geben Sie com.example.Example als Einstiegspunkt an.

    Hinweis: In dieser Anleitung werden Cloud Run Functions der 1. Generation verwendet. Das Java-Codebeispiel verwendet die Schnittstelle BackgroundFunction, die nur in der 1. Generation unterstützt wird.

Anforderungen hinzufügen

Python

Geben Sie die Abhängigkeiten in der Datei requirements.txt an:

google-auth==2.38.0
requests==2.34.2; python_version >= '3.10'

Java

Fügen Sie dem Abschnitt dependencies in der Datei pom.xml, die von der Google Cloud Functions-UI generiert wurde, die folgenden Abhängigkeiten hinzu.

    <dependency>
      <groupId>com.google.apis</groupId>
      <artifactId>google-api-services-docs</artifactId>
      <version>v1-rev20210707-1.32.1</version>
    </dependency>
    <dependency>
      <groupId>com.google.api-client</groupId>
      <artifactId>google-api-client</artifactId>
      <version>1.32.1</version>
    </dependency>
    <dependency>
      <groupId>com.google.auth</groupId>
      <artifactId>google-auth-library-credentials</artifactId>
      <version>1.14.0</version>
    </dependency>
    <dependency>
      <groupId>com.google.auth</groupId>
      <artifactId>google-auth-library-oauth2-http</artifactId>
      <version>1.14.0</version>
    </dependency>

Python

Fügen Sie den Code zum Auslösen von DAGs mit der Airflow REST API hinzu. Erstellen Sie eine Datei mit dem Namen composer2_airflow_rest_api.py und fügen Sie den Code für Airflow REST API-Aufrufe in diese Datei ein.

Ändern Sie keine Variablen. Die Cloud Functions-Funktion importiert diese Datei aus der Datei main.py.

**Hinweis**: In der Airflow-Datenbank in Airflow-Versionen vor 2.3.0 ist die Länge des E‑Mail-Felds auf 64 Zeichen begrenzt. Dienstkonten haben manchmal E‑Mail-Adressen, die länger als 64 Zeichen sind. Wenn Sie mit einem solchen Dienstkonto auf die Airflow REST API zugreifen möchten, verwenden Sie die Problemumgehung, die unter Auf Airflow REST API mit einem Dienstkonto zugreifen beschrieben wird.

from __future__ import annotations

from typing import Any

import google.auth
from google.auth.transport.requests import AuthorizedSession
import requests


# Following GCP best practices, these credentials should be
# constructed at start-up time and used throughout
# https://cloud.google.com/apis/docs/client-libraries-best-practices
AUTH_SCOPE = "https://www.googleapis.com/auth/cloud-platform"
CREDENTIALS, _ = google.auth.default(scopes=[AUTH_SCOPE])


def make_composer2_web_server_request(
    url: str, method: str = "GET", **kwargs: Any
) -> google.auth.transport.Response:
    """
    Make a request to Cloud Composer 2 environment's web server.
    Args:
      url: The URL to fetch.
      method: The request method to use ('GET', 'OPTIONS', 'HEAD', 'POST', 'PUT',
        'PATCH', 'DELETE')
      **kwargs: Any of the parameters defined for the request function:
                https://github.com/requests/requests/blob/master/requests/api.py
                  If no timeout is provided, it is set to 90 by default.
    """

    authed_session = AuthorizedSession(CREDENTIALS)

    # Set the default timeout, if missing
    if "timeout" not in kwargs:
        kwargs["timeout"] = 90

    return authed_session.request(method, url, **kwargs)


def trigger_dag(web_server_url: str, dag_id: str, data: dict) -> str:
    """
    Make a request to trigger a dag using the stable Airflow 2 REST API.
    https://airflow.apache.org/docs/apache-airflow/stable/stable-rest-api-ref.html

    Args:
      web_server_url: The URL of the Airflow 2 web server.
      dag_id: The DAG ID.
      data: Additional configuration parameters for the DAG run (json).
    """

    endpoint = f"api/v1/dags/{dag_id}/dagRuns"
    request_url = f"{web_server_url}/{endpoint}"
    json_data = {"conf": data}

    response = make_composer2_web_server_request(
        request_url, method="POST", json=json_data
    )

    if response.status_code == 403:
        raise requests.HTTPError(
            "You do not have a permission to perform this operation. "
            "Check Airflow RBAC roles for your account."
            f"{response.headers} / {response.text}"
        )
    elif response.status_code != 200:
        response.raise_for_status()
    else:
        return response.text

Fügen Sie der Datei main.py den folgenden Code hinzu. Ersetzen Sie den Wert von der web_server_url Variablen durch die Airflow-Webserveradresse, die Sie zuvor abgerufen haben.

# Copyright 2021 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""
Trigger a DAG in a Cloud Composer 2 environment in response to an event,
using Cloud Functions.
"""

from typing import Any

import composer2_airflow_rest_api

def trigger_dag_gcf(data, context=None):
    """
    Trigger a DAG and pass event data.

    Args:
      data: A dictionary containing the data for the event. Its format depends
      on the event.
      context: The context object for the event.

    For more information about the arguments, see:
    https://cloud.google.com/functions/docs/writing/background#function_parameters
    """

    # TODO(developer): replace with your values
    # Replace web_server_url with the Airflow web server address. To obtain this
    # URL, run the following command for your environment:
    # gcloud composer environments describe example-environment \
    #  --location=your-composer-region \
    #  --format="value(config.airflowUri)"
    web_server_url = (
        "https://example-airflow-ui-url-dot-us-central1.composer.googleusercontent.com"
    )
    # Replace with the ID of the DAG that you want to run.
    dag_id = 'composer_sample_trigger_response_dag'

    composer2_airflow_rest_api.trigger_dag(web_server_url, dag_id, data)

Java

Fügen Sie der Datei Example.java den folgenden Code hinzu. Ersetzen Sie den Wert der Variablen webServerUrl durch die Airflow-Webserveradresse, die Sie zuvor abgerufen haben.

// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package com.example;

import com.example.Example.GcsEvent;
import com.google.api.client.http.GenericUrl;
import com.google.api.client.http.HttpContent;
import com.google.api.client.http.HttpRequest;
import com.google.api.client.http.HttpRequestFactory;
import com.google.api.client.http.HttpResponse;
import com.google.api.client.http.HttpResponseException;
import com.google.api.client.http.javanet.NetHttpTransport;
import com.google.api.client.http.json.JsonHttpContent;
import com.google.api.client.json.gson.GsonFactory;
import com.google.auth.http.HttpCredentialsAdapter;
import com.google.auth.oauth2.GoogleCredentials;
import com.google.cloud.functions.BackgroundFunction;
import com.google.cloud.functions.Context;
import java.util.HashMap;
import java.util.Map;
import java.util.logging.Logger;

/**
 * Cloud Function that triggers an Airflow DAG in response to an event (in
 * this case a Cloud Storage event).
 */
public class Example implements BackgroundFunction<GcsEvent> {
  private static final Logger logger = Logger.getLogger(Example.class.getName());

  // TODO(developer): replace with your values
  // Replace webServerUrl with the Airflow web server address. To obtain this
  // URL, run the following command for your environment:
  // gcloud composer environments describe example-environment \
  //  --location=your-composer-region \
  //  --format="value(config.airflowUri)"
  @Override
  public void accept(GcsEvent event, Context context) throws Exception {
    String webServerUrl = "https://example-airflow-ui-url-dot-us-central1.composer.googleusercontent.com";
    String dagName = "composer_sample_trigger_response_dag";
    String url = String.format("%s/api/v1/dags/%s/dagRuns", webServerUrl, dagName);

    logger.info(String.format("Triggering DAG %s as a result of an event on the object %s.",
      dagName, event.name));
    logger.info(String.format("Triggering DAG via the following URL: %s", url));

    GoogleCredentials googleCredentials = GoogleCredentials.getApplicationDefault()
        .createScoped("https://www.googleapis.com/auth/cloud-platform");
    HttpCredentialsAdapter credentialsAdapter = new HttpCredentialsAdapter(googleCredentials);
    HttpRequestFactory requestFactory =
      new NetHttpTransport().createRequestFactory(credentialsAdapter);

    Map<String, Map<String, String>> json = new HashMap<String, Map<String, String>>();
    Map<String, String> conf = new HashMap<String, String>();
    conf.put("bucket", event.bucket);
    conf.put("name", event.name);
    conf.put("generation", event.generation);
    conf.put("operation", context.eventType());
    json.put("conf", conf);
    HttpContent content = new JsonHttpContent(new GsonFactory(), json);
    HttpRequest request = requestFactory.buildPostRequest(new GenericUrl(url), content);
    request.getHeaders().setContentType("application/json");
    HttpResponse response;
    try {
      response = request.execute();
      int statusCode = response.getStatusCode();
      logger.info("Response code: " + statusCode);
      logger.info(response.parseAsString());
    } catch (HttpResponseException e) {
      // https://cloud.google.com/java/docs/reference/google-http-client/latest/com.google.api.client.http.HttpResponseException
      logger.info("Received HTTP exception");
      logger.info(e.getLocalizedMessage());
      logger.info("- 400 error: wrong arguments passed to Airflow API");
      logger.info("- 401 error: check if service account has Composer User role");
      logger.info("- 403 error: check Airflow RBAC roles assigned to service account");
      logger.info("- 404 error: check Web Server URL");
    } catch (Exception e) {
      logger.info("Received exception");
      logger.info(e.getLocalizedMessage());
    }
  }

  /** Details of the storage event. */
  public static class GcsEvent {
    /** Bucket name. */
    String bucket;
    /** Object name. */
    String name;
    /** Object version. */
    String generation;
  }
}

Funktion testen

So prüfen Sie, ob Ihre Funktion und Ihr DAG wie erwartet funktionieren:

1. Warten Sie, bis die Funktion bereitgestellt wurde.
2. Laden Sie eine Datei in Ihren Cloud Storage-Bucket hoch. Alternativ können Sie die Funktion manuell auslösen, indem Sie in der Google Cloud Console die Funktion testen Aktion für diese auswählen.
3. Prüfen Sie die DAG-Seite in der Airflow-Weboberfläche. Der DAG sollte eine aktive oder bereits abgeschlossene DAG-Ausführung haben.
4. Prüfen Sie in der Airflow-UI die Aufgabenlogs für diese Ausführung. Die Aufgabe print_gcs_info gibt die von der Funktion empfangenen Daten in die Logs aus:

Python

[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

Java

[2023-02-08, 08:00:09 UTC] {subprocess.py:86} INFO - Output:
[2023-02-08, 08:00:09 UTC] {subprocess.py:93} INFO - {bucket: example-storage-for-gcf-triggers, generation: 1675843189006715, name: file.txt, operation: google.storage.object.create}
[2023-02-08, 08:00:09 UTC] {subprocess.py:97} INFO - Command exited with return code 0

Nächste Schritte

• Auf die Airflow-UI zugreifen
• Auf die Airflow REST API zugreifen
• DAGs schreiben
• Cloud Run-Funktionen schreiben
• Google Cloud Storage-Trigger