Attivare i DAG di Managed Service for Apache Airflow con le funzioni Cloud Run e l'API REST di Airflow

Managed Airflow (terza generazione) | Managed Airflow (seconda generazione) | Managed Airflow (prima generazione legacy)

Questa pagina descrive come utilizzare Cloud Run Functions per attivare i DAG di Managed Service for Apache Airflow in risposta agli eventi.

Apache Airflow è progettato per eseguire i DAG in base a una pianificazione regolare, ma puoi anche attivarli in risposta agli eventi. Un modo per farlo è utilizzare Cloud Run Functions per attivare i DAG di Managed Airflow quando si verifica un evento specificato.

Inoltre puoi:

L'esempio in questa guida mostra una funzione che attiva un DAG in risposta a un evento:

  1. Configura i trigger per la funzione in Cloud Run Functions.
  2. Quando la funzione viene attivata, effettua una richiesta per attivare un DAG tramite l'API REST Airflow del tuo ambiente Airflow gestito. La richiesta contiene l'identificatore e il tipo dell'evento, nonché il relativo payload.
  3. Airflow elabora questa richiesta ed esegue il DAG specificato nella richiesta. Il DAG restituisce i dati che gli sono stati passati dalla funzione.

Prima di iniziare

Questa sezione elenca i passaggi preparatori.

Controlla la configurazione di rete dell'ambiente

Questa soluzione non funziona nelle configurazioni IP privato e Controlli di servizio VPC perché non è possibile configurare la connettività da Cloud Run Functions al server web Airflow in queste configurazioni.

Abilita le API per il tuo progetto

Console

Abilita le API Airflow gestito e Cloud Run Functions.

Ruoli richiesti per abilitare le API

Per abilitare le API, devi disporre dell'autorizzazione serviceusage.services.enable. Se hai creato il progetto, probabilmente hai già questa autorizzazione tramite il ruolo Proprietario (roles/owner). In caso contrario, puoi ottenere questa autorizzazione tramite il ruolo Amministratore utilizzo servizi (roles/serviceusage.serviceUsageAdmin). Scopri come concedere i ruoli.

Abilita le API

gcloud

Abilita le API Airflow gestito e Cloud Run Functions:

Ruoli richiesti per abilitare le API

Per abilitare le API, devi disporre dell'autorizzazione serviceusage.services.enable. Se hai creato il progetto, probabilmente hai già questa autorizzazione tramite il ruolo Proprietario (roles/owner). In caso contrario, puoi ottenere questa autorizzazione tramite il ruolo Amministratore utilizzo servizi (roles/serviceusage.serviceUsageAdmin). Scopri come concedere i ruoli. 

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

Abilita l'API REST Airflow

A seconda della versione di Airflow:

Consenti le chiamate API all'API REST Airflow utilizzando il controllo dell'accesso alla rete del server web

Cloud Run Functions può raggiungere l'API REST Airflow tramite un indirizzo IPv4 o IPv6.

Se non sai quale sarà l'intervallo IP di chiamata, utilizza un'opzione di configurazione predefinita in Controllo dell'accesso al server web , ovvero All IP addresses have access (default) , per non bloccare accidentalmente Cloud Run Functions. Puoi sempre configurare l'accesso alla rete del server web in un secondo momento.

Recupera l'URL del server web Airflow

Questo esempio effettua richieste API REST all'endpoint del server web Airflow. Nel codice di Cloud Function, utilizza la parte dell'URL dell'interfaccia web di Airflow prima di .appspot.com.

Console

  1. Nella Google Cloud console, vai alla pagina Ambienti.

    Vai ad Ambienti

  2. Fai clic sul nome dell'ambiente.

  3. Nella pagina Dettagli ambiente, vai alla scheda Configurazione ambiente.

  4. L'URL del server web Airflow è elencato nell'elemento UI web di Airflow.

gcloud

Esegui questo comando:

gcloud composer environments describe ENVIRONMENT_NAME \
    --location LOCATION \
    --format='value(config.airflowUri)'

Sostituisci:

  • ENVIRONMENT_NAME con il nome dell'ambiente.
  • LOCATION con la regione in cui si trova l'ambiente.

Recupera il client_id del proxy IAM

Per effettuare una richiesta all'endpoint API REST Airflow, la funzione richiede l'ID client del proxy Identity and Access Management che protegge il server web Airflow.

Managed Airflow non fornisce direttamente queste informazioni. Effettua invece una richiesta non autenticata al server web Airflow e acquisisci l'ID client dall'URL di reindirizzamento:

cURL 

curl -v AIRFLOW_URL 2>&1 >/dev/null | grep -o "client_id\=[A-Za-z0-9-]*\.apps\.googleusercontent\.com"

Sostituisci AIRFLOW_URL con l'URL dell'interfaccia web di Airflow.

Nell'output, cerca la stringa che segue client_id. Ad esempio:

client_id=836436932391-16q2c5f5dcsfnel77va9bvf4j280t35c.apps.googleusercontent.com

Python

Salva il seguente codice in un file denominato get_client_id.py. Inserisci i valori per project_id, location e composer_environment, quindi esegui il codice in Cloud Shell o nel tuo ambiente locale. 

# 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])

Carica un DAG nel tuo ambiente

Carica un DAG nel tuo ambiente. Il seguente DAG di esempio restituisce la configurazione di esecuzione del DAG ricevuta. Attiva questo DAG da una funzione che creerai più avanti in questa guida.

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 }}}}')

Esegui il deployment di una funzione che attiva il DAG

Puoi eseguire il deployment di una funzione utilizzando il linguaggio che preferisci supportato da Cloud Run Functions o Cloud Run. Questo tutorial mostra una Cloud Function implementata in Python e Java.

Specifica i parametri di configurazione della funzione

  • Trigger: seleziona un trigger Eventarc o più trigger per la funzione.

    Per saperne di più sulla creazione dei trigger, consulta Creare trigger con Eventarc. Ad esempio, puoi attivare le funzioni da Cloud Storage utilizzando Eventarc.

  • Account di servizio: l'account di servizio specificato per il trigger deve disporre di autorizzazioni sufficienti per attivare i DAG negli ambienti Airflow gestito.

    Ti consigliamo di seguire il principio del privilegio minimo e di concedere solo il ruolo Utente Composer (composer.user). Per saperne di più sulla configurazione delle autorizzazioni, consulta Ruoli e autorizzazioni per le destinazioni Cloud Run.

  • Entry point della funzione:

    • (Python) Quando aggiungi il codice per questo esempio, seleziona il runtime Python 3.10 o versioni successive e specifica trigger_dag come entry point.

Aggiungi i requisiti

Specifica le dipendenze nel file requirements.txt:

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

Aggiungi codice per la funzione

Inserisci il seguente codice nel file main.py ed effettua le seguenti sostituzioni:

  • Sostituisci il valore della variabile client_id con il valore client_id che hai ottenuto in precedenza.

  • Sostituisci il valore della variabile webserver_id con l'ID progetto tenant, che fa parte dell'URL dell'interfaccia web di Airflow prima di .appspot.com. Hai ottenuto l'URL dell'interfaccia web di Airflow in precedenza.

  • Specifica la versione dell'API REST Airflow che utilizzi:

    • Se utilizzi l'API REST Airflow stabile, imposta la variabile USE_EXPERIMENTAL_API su False.
    • Se utilizzi l'API REST Airflow sperimentale, non sono necessarie modifiche. La variabile USE_EXPERIMENTAL_API è già impostata su True.


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

Testa la funzione

Per verificare che la funzione e il DAG funzionino come previsto:

  1. Attendi il deployment della funzione.
  2. Attiva la funzione in base al trigger specificato. Puoi anche attivare la funzione manualmente selezionando l'azione Testa la funzione nella Google Cloud console.
  3. Controlla la pagina DAG nell'interfaccia web di Airflow. Il DAG deve avere un'esecuzione del DAG attiva o già completata.
  4. Nell'UI di Airflow, controlla i log delle attività per questa esecuzione. Dovresti vedere che l'attività print_gcs_info restituisce i dati ricevuti dalla funzione ai log:

Output di esempio:

[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

Passaggi successivi