Attiva i DAG di Cloud Composer con Cloud Functions e l'API REST Airflow

Cloud Composer 1 | Cloud Composer 2

Questa pagina descrive come utilizzare Cloud Functions per attivare i DAG di Cloud Composer in risposta agli eventi.

Nota: puoi anche attivare i DAG utilizzando solo l'API REST Airflow.

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

L'esempio in questa guida esegue un DAG ogni volta che si verifica una modifica in un bucket Cloud Storage. Le modifiche a qualsiasi oggetto in un bucket attivano una funzione. Questa funzione invia una richiesta all'API REST Airflow del tuo ambiente Cloud Composer. Airflow elabora questa richiesta ed esegue un DAG. Il DAG restituisce informazioni sulla modifica.

Nota: una guida alternativa mostra come creare una funzione che attivi un DAG quando viene eseguito il push di un messaggio a un argomento Pub/Sub.

Prima di iniziare

Controlla la configurazione di rete del tuo ambiente

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

In Cloud Composer 2, puoi utilizzare un altro approccio: Attivare i DAG utilizzando Cloud Functions e i messaggi Pub/Sub

Abilita le API per il tuo progetto

Console

Enable the Cloud Composer and Cloud Functions APIs.

Enable the APIs

gcloud

Enable the Cloud Composer and Cloud Functions APIs:

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

Abilita l'API REST Airflow

A seconda della versione di Airflow:

• Per Airflow 2, l'API REST stabile è già abilitata per impostazione predefinita. Se nel tuo ambiente l'API stabile è disabilitata, abilita l'API REST stabile.
• Per Airflow 1, abilita l'API REST sperimentale.

Consenti chiamate API all'API REST Airflow utilizzando Controllo accesso server web

Cloud Functions può contattare l'API REST Airflow utilizzando un indirizzo IPv4 o IPv6.

Se non sai quale sarà l'intervallo IP delle chiamate, utilizza un'opzione di configurazione predefinita in Webserver Access Control, ovvero All IP addresses have access (default) per non bloccare accidentalmente le tue funzioni Cloud Functions.

crea un bucket Cloud Storage

Questo esempio attiva un DAG in risposta alle modifiche in un bucket Cloud Storage. Crea un nuovo bucket da utilizzare in questo esempio.

Nota: non utilizzare i bucket di ambiente Cloud Composer perché ciò potrebbe causare l'attivazione della funzione più volte al secondo. Ai fini di questo esempio, consigliamo di creare un bucket separato.

Recuperare l'URL del server web Airflow

Questo esempio invia richieste API REST all'endpoint del server web Airflow. Devi utilizzare la parte dell'URL dell'interfaccia web di Airflow prima di .appspot.com nel codice della funzione Cloud Function.

Console

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

   Vai a Ambienti

2. Fai clic sul nome dell'ambiente.

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

4. L'URL del server web Airflow è elencato nella voce dell'interfaccia utente 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

Attenzione: questa guida è per Cloud Composer 1 e i passaggi descritti non funzionano in Cloud Composer 2. Segui invece le istruzioni nella pagina Attivare i DAG con Cloud Functions per Cloud Composer 2.

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.

Cloud Composer non fornisce queste informazioni direttamente. 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 codice seguente 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. L'esempio di DAG seguente restituisce la configurazione dell'esecuzione di DAG ricevuta. Puoi attivare 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(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 }}"
    )

Esegui il deployment di una Cloud Function che attiva il DAG

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

Specifica i parametri di configurazione della funzione Cloud Functions

• Attiva. Per questo esempio, seleziona un trigger che funzioni quando viene creato un nuovo oggetto in un bucket o quando un oggetto esistente viene sovrascritto.

  • Tipo di attivatore. di archiviazione ideale in Cloud Storage.

  • Tipo di evento. Finalizza / Crea.

  • Bucket. Seleziona un bucket che deve attivare questa funzione.

  • Riprova in caso di errore. Consigliamo di disabilitare questa opzione per le finalità di questo esempio. Se utilizzi la tua funzione in un ambiente di produzione, abilita questa opzione per gestire gli errori temporanei.

• Account di servizio di runtime nella sezione Impostazioni di runtime, build, connessioni e sicurezza. Utilizza una delle seguenti opzioni, a seconda delle tue preferenze:

  • Seleziona Account di servizio predefinito di Compute Engine. Con le autorizzazioni IAM predefinite, questo account può eseguire funzioni che accedono agli ambienti Cloud Composer.

  • Crea un account di servizio personalizzato con il ruolo Utente Composer e specificalo come account di servizio di runtime per questa funzione. Questa opzione segue il principio del privilegio minimo.

• Runtime e punto di ingresso, nel passaggio Codice. Quando aggiungi il codice per questo esempio, seleziona il runtime Python 3.7 o versioni successive e specifica trigger_dag come punto di ingresso.

Aggiungi requisiti

Specifica le dipendenze nel file requirements.txt:

requests-toolbelt==1.0.0
google-auth==2.19.1
google-cloud-pubsub==2.17.0

Inserisci il seguente codice nel file main.py e apporta le seguenti sostituzioni:

• Sostituisci il valore della variabile client_id con il valore client_id 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 del giorno .appspot.com. Hai ottenuto l'URL dell'interfaccia web di Airflow in precedenza.

• Specifica la versione dell'API REST Airflow in uso:

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

Nota: a volte gli account di servizio contengono indirizzi email più lunghi di 64 caratteri. Per accedere all'API REST Airflow con un account di servizio di questo tipo, utilizza la soluzione alternativa descritta in Accedere all'API REST Airflow utilizzando un account di servizio.

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. Carica un file nel bucket Cloud Storage. In alternativa, puoi attivare la funzione manualmente selezionando l'azione Testa la funzione nella console Google Cloud.
3. Controlla la pagina DAG nell'interfaccia web di Airflow. Il DAG deve avere un'esecuzione di DAG attiva o già completata.
4. Nella 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:

[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

• Accedi alla UI di Airflow
• Accedi all'API REST Airflow
• Scrittura di DAG
• Scrivere funzioni Cloud Functions
• Trigger di Cloud Storage