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 Cloud Run-Funktionen verwenden, um Managed Service for Apache Airflow-DAGs als Reaktion auf Ereignisse auszulösen.

Apache Airflow ist für die regelmäßige Ausführung von DAGs konzipiert. Sie können DAGs aber auch als Reaktion auf Ereignisse auslösen. Eine Möglichkeit hierfür ist die Verwendung von Cloud Run Functions, um Managed Airflow-DAGs auszulösen, wenn ein bestimmtes Ereignis eintritt.

Weitere Möglichkeiten:

Das Beispiel in diesem Leitfaden zeigt eine Funktion, die als Reaktion auf ein Ereignis einen DAG auslöst:

  1. Sie konfigurieren Trigger für Ihre Funktion in Cloud Run Functions.
  2. Wenn die Funktion ausgelöst wird, wird eine Anfrage gesendet, um einen DAG über die Airflow REST API Ihrer Managed Airflow-Umgebung auszulösen. Die Anfrage enthält die Kennung und den Typ des Ereignisses sowie die Nutzlast des Ereignisses.
  3. Airflow verarbeitet diese Anfrage und führt den in der Anfrage angegebenen DAG aus. Der DAG gibt die Daten aus, die von der Funktion an ihn übergeben wurden.

Hinweis

In diesem Abschnitt werden die Vorbereitungsschritte aufgeführt.

Netzwerkkonfiguration Ihrer Umgebung prüfen

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

Die APIs für Ihr Projekt aktivieren

Console

Aktivieren Sie die Managed Airflow- und Cloud Run Functions APIs, falls sie noch nicht aktiviert sind.

Rollen, die zum Aktivieren von APIs erforderlich sind

Zum Aktivieren von APIs benötigen Sie die Berechtigung serviceusage.services.enable. Wenn Sie das Projekt erstellt haben, haben Sie diese Berechtigung wahrscheinlich bereits über die Rolle „Inhaber“ (roles/owner). Andernfalls können Sie diese Berechtigung über die Rolle „Service Usage-Administrator“ (roles/serviceusage.serviceUsageAdmin) erhalten. Informationen zum Zuweisen von Rollen

APIs aktivieren

gcloud

Aktivieren Sie die Managed Airflow und Cloud Run Functions APIs, falls sie noch nicht aktiviert sind:

Rollen, die zum Aktivieren von APIs erforderlich sind

Zum Aktivieren von APIs benötigen Sie die Berechtigung serviceusage.services.enable. Wenn Sie das Projekt erstellt haben, haben Sie diese Berechtigung wahrscheinlich bereits über die Rolle „Inhaber“ (roles/owner). Andernfalls können Sie diese Berechtigung über die Rolle „Service Usage-Administrator“ (roles/serviceusage.serviceUsageAdmin) erhalten. Informationen zum Zuweisen von Rollen 

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

Airflow REST API aktivieren

Je nach Airflow-Version:

API-Aufrufe an die Airflow REST API über die Netzwerkzugriffssteuerung des Webservers zulassen

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

Wenn Sie sich nicht sicher sind, welcher IP-Bereich für Aufrufe verwendet wird, verwenden Sie in der Webserver-Zugriffssteuerung die Standardkonfigurationsoption All IP addresses have access (default), um Ihre Cloud Run-Funktionen nicht versehentlich zu blockieren. Sie können den Netzwerkzugriff des Webservers später jederzeit konfigurieren.

URL des Airflow-Webservers abrufen

In diesem Beispiel werden REST API-Anfragen an den Airflow-Webserver-Endpunkt gesendet. Sie verwenden den Teil der Airflow-Weboberflächen-URL vor .appspot.com 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. Rufen Sie auf der Seite Umgebungsdetails den Tab Umgebungskonfiguration auf.

  4. Die URL des Airflow-Webservers wird unter 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

Um eine Anfrage an den Airflow REST API-Endpunkt zu senden, benötigt die Funktion die Client-ID des Identity and Access Management-Proxys, der den Airflow-Webserver schützt.

Managed Airflow stellt diese Informationen nicht direkt zur Verfügung. Stattdessen können Sie eine nicht authentifizierte Anfrage an den Airflow-Webserver senden und die Client-ID aus der Weiterleitungs-URL erfassen:

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 nach client_id. 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 den Code in Cloud Shell oder in Ihrer lokalen Umgebung aus. 

# This script is intended to be used with Composer 1 environments
# In Composer 2, the Airflow Webserver is not in the tenant project
# so there is no tenant client ID
# See https://cloud.google.com/composer/docs/composer-2/environment-architecture
# for more details
import google.auth
import google.auth.transport.requests
import requests
import six.moves.urllib.parse

# Authenticate with Google Cloud.
# See: https://cloud.google.com/docs/authentication/getting-started
credentials, _ = google.auth.default(
    scopes=["https://www.googleapis.com/auth/cloud-platform"]
)
authed_session = google.auth.transport.requests.AuthorizedSession(credentials)

# project_id = 'YOUR_PROJECT_ID'
# location = 'us-central1'
# composer_environment = 'YOUR_COMPOSER_ENVIRONMENT_NAME'

environment_url = (
    "https://composer.googleapis.com/v1beta1/projects/{}/locations/{}"
    "/environments/{}"
).format(project_id, location, composer_environment)
composer_response = authed_session.request("GET", environment_url)
environment_data = composer_response.json()
composer_version = environment_data["config"]["softwareConfig"]["imageVersion"]
if "composer-1" not in composer_version:
    version_error = (
        "This script is intended to be used with Composer 1 environments. "
        "In Composer 2, the Airflow Webserver is not in the tenant project, "
        "so there is no tenant client ID. "
        "See https://cloud.google.com/composer/docs/composer-2/environment-architecture for more details."
    )
    raise (RuntimeError(version_error))
airflow_uri = environment_data["config"]["airflowUri"]

# The Composer environment response does not include the IAP client ID.
# Make a second, unauthenticated HTTP request to the web server to get the
# redirect URI.
redirect_response = requests.get(airflow_uri, allow_redirects=False)
redirect_location = redirect_response.headers["location"]

# Extract the client_id query parameter from the redirect.
parsed = six.moves.urllib.parse.urlparse(redirect_location)
query_string = six.moves.urllib.parse.parse_qs(parsed.query)
print(query_string["client_id"][0])

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.

import datetime

import airflow
from airflow.operators.bash_operator import BashOperator

with airflow.DAG(
        'composer_sample_trigger_response_dag',
        start_date=datetime.datetime(2026, 1, 1),
        # Not scheduled, trigger only
        schedule=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 }}}}')

Funktion bereitstellen, die den DAG auslöst

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

Konfigurationsparameter für Funktionen angeben

  • Trigger: Wählen Sie einen oder mehrere Eventarc-Trigger für Ihre Funktion aus.

    Weitere Informationen zum Erstellen von Triggern finden Sie unter Trigger mit Eventarc erstellen. Sie können beispielsweise Funktionen aus Cloud Storage mit Eventarc auslösen.

  • Dienstkonto: Das Dienstkonto, das Sie für den Trigger angeben, muss über genügend Berechtigungen verfügen, um DAGs in Managed Airflow-Umgebungen auszulösen.

    Wir empfehlen, dem Prinzip der geringsten Berechtigung zu folgen und dem Dienstkonto nur die Rolle Composer-Nutzer (composer.user) zuzuweisen. Weitere Informationen zum Konfigurieren von Berechtigungen finden Sie unter Rollen und Berechtigungen für Cloud Run-Ziele.

  • Funktionseinstiegspunkt:

    • (Python) Wenn Sie Code für dieses Beispiel hinzufügen, wählen Sie die Laufzeit Python 3.10 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:

requests-toolbelt==1.0.0
google-auth==2.38.0
google-cloud-pubsub==2.28.0

Funktionscode hinzufügen

Fügen Sie den folgenden Code in die Datei main.py ein und nehmen Sie die folgenden Änderungen vor:

  • Ersetzen Sie den Wert der Variablen client_id durch den Wert client_id, den Sie zuvor abgerufen 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 auf False fest.
    • Wenn Sie die experimentelle Airflow REST API verwenden, sind keine Änderungen erforderlich. Die Variable USE_EXPERIMENTAL_API ist bereits auf True festgelegt.


from google.auth.transport.requests import Request
from google.oauth2 import id_token
import requests


IAM_SCOPE = "https://www.googleapis.com/auth/iam"
OAUTH_TOKEN_URI = "https://www.googleapis.com/oauth2/v4/token"
# If you are using the stable API, set this value to False
# For more info about Airflow APIs see https://cloud.google.com/composer/docs/access-airflow-api
USE_EXPERIMENTAL_API = True


def trigger_dag(data, context=None):
    """Makes a POST request to the Composer DAG Trigger API

    When called via Google Cloud Functions (GCF),
    data and context are Background function parameters.

    For more info, refer to
    https://cloud.google.com/functions/docs/writing/background#functions_background_parameters-python

    To call this function from a Python script, omit the ``context`` argument
    and pass in a non-null value for the ``data`` argument.

    This function is currently only compatible with Composer v1 environments.
    """

    # Fill in with your Composer info here
    # Navigate to your webserver's login page and get this from the URL
    # Or use the script found at
    # https://github.com/GoogleCloudPlatform/python-docs-samples/blob/main/composer/rest/get_client_id.py
    client_id = "YOUR-CLIENT-ID"
    # This should be part of your webserver's URL:
    # {tenant-project-id}.appspot.com
    webserver_id = "YOUR-TENANT-PROJECT"
    # The name of the DAG you wish to trigger
    dag_name = "composer_sample_trigger_response_dag"

    if USE_EXPERIMENTAL_API:
        endpoint = f"api/experimental/dags/{dag_name}/dag_runs"
        json_data = {"conf": data, "replace_microseconds": "false"}
    else:
        endpoint = f"api/v1/dags/{dag_name}/dagRuns"
        json_data = {"conf": data}
    webserver_url = "https://" + webserver_id + ".appspot.com/" + endpoint
    # Make a POST request to IAP which then Triggers the DAG
    make_iap_request(webserver_url, client_id, method="POST", json=json_data)


# This code is copied from
# https://github.com/GoogleCloudPlatform/python-docs-samples/blob/main/iap/make_iap_request.py
# START COPIED IAP CODE
def make_iap_request(url, client_id, method="GET", **kwargs):
    """Makes a request to an application protected by Identity-Aware Proxy.
    Args:
      url: The Identity-Aware Proxy-protected URL to fetch.
      client_id: The client ID used by Identity-Aware Proxy.
      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.
    Returns:
      The page body, or raises an exception if the page couldn't be retrieved.
    """
    # Set the default timeout, if missing
    if "timeout" not in kwargs:
        kwargs["timeout"] = 90

    # Obtain an OpenID Connect (OIDC) token from metadata server or using service
    # account.
    google_open_id_connect_token = id_token.fetch_id_token(Request(), client_id)

    # Fetch the Identity-Aware Proxy-protected URL, including an
    # Authorization header containing "Bearer " followed by a
    # Google-issued OpenID Connect token for the service account.
    resp = requests.request(
        method,
        url,
        headers={"Authorization": "Bearer {}".format(google_open_id_connect_token)},
        **kwargs,
    )
    if resp.status_code == 403:
        raise Exception(
            "Service account does not have permission to "
            "access the IAP-protected application."
        )
    elif resp.status_code != 200:
        raise Exception(
            "Bad response from application: {!r} / {!r} / {!r}".format(
                resp.status_code, resp.headers, resp.text
            )
        )
    else:
        return resp.text


# END COPIED IAP CODE

Funktion testen

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

  1. Warten Sie, bis die Funktion bereitgestellt wurde.
  2. Lösen Sie die Funktion gemäß dem angegebenen Trigger aus. Sie können die Funktion auch manuell auslösen, indem Sie in der Google Cloud Console die Aktion Funktion testen für sie auswählen.
  3. Sehen Sie sich die DAG-Seite in der Airflow-Weboberfläche an. Der DAG sollte einen aktiven oder bereits abgeschlossenen DAG-Lauf haben.
  4. Sehen Sie sich in der Airflow-UI die Aufgabenlogs für diesen Lauf an. Sie sollten sehen, dass die Daten, die von der Funktion empfangen wurden, von der Aufgabe print_gcs_info in die Logs ausgegeben werden:

Beispielausgabe:

[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