Cloud Composer 1 | Cloud Composer 2
Questa pagina descrive come utilizzare Cloud Functions per attivare i DAG di Cloud Composer in risposta agli eventi.
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.
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.
gcloud
Enable the Cloud Composer and Cloud Functions APIs:
gcloud services enable cloudfunctions.googleapis.comcomposer.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.
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
Nella console Google Cloud, vai alla pagina Ambienti.
Fai clic sul nome dell'ambiente.
Nella pagina Dettagli ambiente, vai alla scheda Configurazione dell'ambiente.
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
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.
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.
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
:
Inserisci il seguente codice nel file main.py
e apporta le seguenti
sostituzioni:
Sostituisci il valore della variabile
client_id
con il valoreclient_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
suFalse
. - Se utilizzi l'API REST Airflow sperimentale, non sono necessarie modifiche. La variabile
USE_EXPERIMENTAL_API
è già impostata suTrue
.
- Se utilizzi l'API REST Airflow stabile, imposta la variabile
Testa la funzione
Per verificare che la funzione e il DAG funzionino come previsto:
- Attendi il deployment della funzione.
- Carica un file nel bucket Cloud Storage. In alternativa, puoi attivare la funzione manualmente selezionando l'azione Testa la funzione nella console Google Cloud.
- Controlla la pagina DAG nell'interfaccia web di Airflow. Il DAG deve avere un'esecuzione di DAG attiva o già completata.
- 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