DAGs mit Cloud Functions auslösen

Cloud Composer 1 Cloud Composer 2

Auf dieser Seite wird beschrieben, wie Sie mit Cloud Functions DAGs als Reaktion auf Ereignisse auslösen.

Airflow wurde für die regelmäßige Ausführung von DAGs entwickelt. Sie können aber auch DAGs 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 angegebenes Ereignis auftritt. Sie können beispielsweise eine Funktion erstellen, die einen DAG auslöst, wenn sich ein Objekt in einem Cloud Storage-Bucket ändert oder eine Nachricht an ein Pub/Sub-Thema gesendet wird.

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.

Hinweis

Die APIs für Ihr Projekt aktivieren

Console

  • Cloud Composer and Cloud Functions APIs aktivieren.

    Aktivieren Sie die APIs

  • gcloud

  • Cloud Composer and Cloud Functions APIs aktivieren.
    gcloud services enable cloudfunctionscomposer
  • Airflow REST API aktivieren

    Abhängig von Ihrer Airflow-Version:

    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 für dieses Beispiel.

    URL des Airflow-Webservers abrufen

    In diesem Beispiel werden REST API-Anfragen an den Airflow-Webserverendpunkt gesendet. Sie verwenden den Teil der URL der Airflow-Weboberfläche vor .appspot.com in Ihrem Cloud Functions-Code.

    Console

    1. Öffnen Sie in der Google Cloud Console die Seite Umgebungen.

      Zur Seite Umgebungen

    2. Klicken Sie auf den Namen Ihrer Umgebung.

    3. Rufen Sie auf der Seite Umgebungsdetails den Tab Umgebungsdetails auf.

    4. Die URL des Airflow-Webservers wird 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 Compute Engine-Region, in der sich die Umgebung befindet.

    client_id des IAM-Proxys abrufen

    Zum Senden einer Anfrage an den Airflow-REST API-Endpunkt benötigt die Funktion die Client-ID des IAM-Proxys, der den Airflow-Webserver schützt.

    Cloud Composer stellt diese Informationen nicht direkt bereit. 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 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 dann in Cloud Shell oder 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 aus Cloud Functions auslösen

    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 mit einer Funktion aus, die Sie später in diesem Leitfaden erstellen.

    import datetime
    
    import airflow
    from airflow.operators.bash_operator 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

    Stellen Sie eine Cloud Functions-Funktion von Python mithilfe der folgenden Konfigurationsparameter und Inhalte bereit.

    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 eine eigene Funktion in einer Produktionsumgebung verwenden, aktivieren Sie diese Option, um vorübergehende Fehler zu beheben.

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

      • Wählen Sie Compute Engine-Standarddienstkonto aus. Mit standardmäßigen IAM-Berechtigungen kann dieses Konto Funktionen ausführen, die auf Cloud Composer-Umgebungen zugreifen.

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

    • Laufzeit und Einstiegspunkt für den Schritt Code. Wählen Sie beim Hinzufügen von Code für dieses Beispiel die Laufzeit von 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:

    requests_toolbelt==0.9.1
    google-auth==2.3.3
    

    Cloud Functions-Code hinzufügen

    Fügen Sie den folgenden Code in die Datei main.py ein und ersetzen Sie die folgenden Werte:

    • Ersetzen Sie den Wert der Variable client_id durch den Wert von 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 für die 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/master/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/master/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 beabsichtigt funktionieren:

    1. Warten Sie, bis die Funktion bereitgestellt ist.
    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 Aktion Funktion testen auswählen.
    3. Prüfen Sie die DAG-Seite auf der Airflow-Weboberfläche. Der DAG sollte einen aktiven oder bereits abgeschlossenen DAG haben.
    4. Prüfen Sie in der Airflow-UI die Aufgabenlogs für diese Ausführung. Sie sollten sehen, dass die Aufgabe print_gcs_info die von der Funktion empfangenen Daten an die Logs ausgibt:
    [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