Esegui un ambiente Airflow locale con lo strumento dell'interfaccia a riga di comando dello sviluppo locale di Composer

Cloud Composer 1 | Cloud Composer 2

Questa sezione descrive come creare, configurare ed eseguire un ambiente Airflow locale utilizzando lo strumento dell'interfaccia a riga di comando di sviluppo locale di Composer.

Informazioni sullo strumento dell'interfaccia a riga di comando per lo sviluppo locale di Composer

Lo strumento per l'interfaccia a riga di comando dello sviluppo locale di Composer semplifica lo sviluppo dei DAG di Apache Airflow per Cloud Composer 2 eseguendo un ambiente Airflow in locale. Questo ambiente Airflow locale utilizza un'immagine di una versione specifica di Cloud Composer.

Puoi creare un ambiente Airflow locale basato su un ambiente Cloud Composer esistente. In questo caso, l'ambiente Airflow locale prende l'elenco dei pacchetti PyPI installati e i nomi variabile di ambiente dal tuo ambiente Cloud Composer.

Puoi utilizzare questo ambiente Airflow locale per test e sviluppo, come il test di nuovi codici DAG, pacchetti PyPI o opzioni di configurazione di Airflow.

Prima di iniziare

  • Lo strumento dell'interfaccia a riga di comando per lo sviluppo locale di Composer supporta solo immagini Cloud Composer 2. Puoi utilizzare qualsiasi versione di Cloud Composer 2 con lo strumento dell'interfaccia a riga di comando di sviluppo locale di Composer.

  • Lo strumento dell'interfaccia a riga di comando dello sviluppo locale di Composer crea ambienti Airflow locali in una directory in cui esegui il comando composer-dev create. Per accedere all'ambiente Airflow locale in un secondo momento, esegui i comandi dello strumento nel percorso in cui hai creato inizialmente l'ambiente locale. Tutti i dati per l'ambiente locale sono archiviati in una sottodirectory nel percorso in cui hai creato l'ambiente locale: ./composer/<local_environment_name>.

  • Il computer deve avere spazio su disco sufficiente per archiviare le immagini di Cloud Composer. Lo strumento dell'interfaccia a riga di comando dello sviluppo locale di Composer archivia un file immagine per ogni versione di Cloud Composer. Ad esempio, se disponi di due ambienti Airflow locali con versioni di Cloud Composer diverse, lo strumento dell'interfaccia a riga di comando di Composer Local Development archivia due immagini di Cloud Composer.

  • Lo strumento dell'interfaccia a riga di comando dello sviluppo locale di Composer utilizza l'output colorato. Puoi disabilitare l'output colorato con la variabile NO_COLOR=1: NO_COLOR=1 composer-dev <other commands>.

  • Se hai un solo ambiente locale, puoi omettere il nome dell'ambiente locale da tutti i comandi composer-dev, ad eccezione di run-airflow-cmd.

  • Installa le dipendenze dello strumento dell'interfaccia a riga di comando di Composer locale per lo sviluppo:

  • Installa Docker. Docker deve essere installato e in esecuzione nel sistema locale. Per verificare che Docker sia in esecuzione, puoi eseguire qualsiasi comando dell'interfaccia a riga di comando Docker, come docker ps.

Configura le credenziali

Se non l'hai già fatto, richiedi nuove credenziali utente da utilizzare per Credenziali predefinite dell'applicazione:

gcloud auth application-default login

Accedi a gcloud CLI con il tuo Account Google:

gcloud auth login

Tutte le chiamate API effettuate dallo strumento dell'interfaccia a riga di comando dello sviluppo locale di Composer e dai DAG vengono eseguite dall'account che utilizzi nellgcloud CLI. Ad esempio, se un DAG nel tuo ambiente Airflow locale legge i contenuti di un bucket Cloud Storage, questo account deve disporre delle autorizzazioni per accedere al bucket. È diverso dagli ambienti di Cloud Composer, in cui l'account di servizio di un ambiente effettua le chiamate.

Installa lo strumento dell'interfaccia a riga di comando per lo sviluppo locale di Composer

Clona il repository dell'interfaccia a riga di comando per lo sviluppo locale di Composer:

git clone https://github.com/GoogleCloudPlatform/composer-local-dev.git

Nella directory di primo livello del repository clonato, esegui:

pip install .

A seconda della configurazione di pip, il percorso in cui viene installato lo strumento potrebbe non essere nella variabile PATH. In questo caso, pip mostra un messaggio di avviso. Puoi utilizzare le informazioni di questo messaggio di avviso per aggiungere questa directory alla variabile PATH nel tuo sistema operativo.

Crea un ambiente Airflow locale con una versione specifica di Cloud Composer

Per elencare le versioni disponibili di Cloud Composer, esegui:

composer-dev list-available-versions --include-past-releases --limit 10

Per creare un ambiente Airflow locale con parametri predefiniti, esegui:

composer-dev create \
  --from-image-version IMAGE_VERSION \
  LOCAL_ENVIRONMENT_NAME

Altri parametri:

composer-dev create \
  --from-image-version IMAGE_VERSION \
  --project PROJECT_ID \
  --port WEB_SERVER_PORT \
  --dags-path LOCAL_DAGS_PATH \
  LOCAL_ENVIRONMENT_NAME

Sostituisci:

  • IMAGE_VERSION con il nome dell'immagine Cloud Composer.
  • PROJECT_ID con l'ID progetto.
  • WEB_SERVER_PORT con la porta su cui il server web Airflow deve rimanere in ascolto.
  • LOCAL_DAGS_PATH con il percorso di una directory locale in cui si trovano i file DAG.
  • LOCAL_ENVIRONMENT_NAME con il nome di questo ambiente Airflow locale.

Esempio:

composer-dev create \
  --from-image-version composer-2.5.2-airflow-2.6.3 \
  example-local-environment

Crea un ambiente Airflow locale da un ambiente Cloud Composer

Solo le seguenti informazioni vengono recuperate da un ambiente Cloud Composer:

Altre informazioni e parametri di configurazione dell'ambiente, come i file DAG, la cronologia delle esecuzioni dei DAG, le variabili Airflow e le connessioni, non vengono copiati dal tuo ambiente Cloud Composer.

Per creare un ambiente Airflow locale da un ambiente Cloud Composer esistente:

composer-dev create LOCAL_ENVIRONMENT_NAME \
    --from-source-environment ENVIRONMENT_NAME \
    --location LOCATION \
    --project PROJECT_ID \
    --port WEB_SERVER_PORT \
    --dags-path LOCAL_DAGS_PATH

Sostituisci:

  • LOCAL_ENVIRONMENT_NAME con un nome per l'ambiente Airflow locale.
  • ENVIRONMENT_NAME con il nome dell'ambiente Cloud Composer.
  • LOCATION con la regione in cui si trova l'ambiente Cloud Composer.
  • PROJECT_ID con l'ID progetto.
  • WEB_SERVER_PORT con una porta per il server web Airflow locale.
  • LOCAL_DAGS_PATH con un percorso di una directory locale in cui si trovano i DAG.

Esempio:

composer-dev create example-local-environment \
  --from-source-environment example-environment \
  --location us-central1 \
  --project example-project \
  --port 8081 \
  --dags-path example_directory/dags

Avvia un ambiente Airflow locale

Per avviare un ambiente Airflow locale, esegui:

composer-dev start LOCAL_ENVIRONMENT_NAME

Sostituisci:

  • LOCAL_ENVIRONMENT_NAME con il nome di un ambiente Airflow locale.

Arresta o riavvia un ambiente Airflow locale

Quando riavvii un ambiente Airflow locale, lo strumento a riga di comando dello sviluppo locale di Composer riavvia il container Docker in cui viene eseguito l'ambiente. Tutti i componenti di Airflow vengono arrestati e riavviati. Di conseguenza, tutte le esecuzioni di DAG eseguite durante un riavvio vengono contrassegnate come non riuscite .

Per riavviare o avviare un ambiente Airflow locale arrestato, esegui:

composer-dev restart LOCAL_ENVIRONMENT_NAME

Sostituisci:

  • LOCAL_ENVIRONMENT_NAME con il nome di un ambiente Airflow locale.

Per arrestare un ambiente Airflow locale, esegui:

composer-dev stop LOCAL_ENVIRONMENT_NAME

Aggiunta e aggiornamento dei DAG

I DAG vengono archiviati nella directory specificata nel parametro --dags-path al momento della creazione dell'ambiente Airflow locale. Per impostazione predefinita, questa directory è ./composer/<local_environment_name>/dags. Puoi ottenere la directory utilizzata dal tuo ambiente con il comando describe.

Per aggiungere e aggiornare i DAG, modifica i file in questa directory. Non è necessario riavviare l'ambiente Airflow locale.

Visualizza i log dell'ambiente Airflow locale

Puoi visualizzare i log recenti da un container Docker che esegue l'ambiente Airflow locale. In questo modo puoi monitorare gli eventi relativi ai container e controllare la presenza di errori nei log di Airflow, come conflitti di dipendenze causati dall'installazione di pacchetti PyPI.

Per visualizzare i log da un container Docker che esegue l'ambiente Airflow locale, esegui:

composer-dev logs LOCAL_ENVIRONMENT_NAME --max-lines 10

Per seguire il flusso di log, ometti l'argomento --max-lines:

composer-dev logs LOCAL_ENVIRONMENT_NAME

Esegui un comando dell'interfaccia a riga di comando di Airflow

Puoi eseguire comandi dell'interfaccia a riga di comando di Airflow nel tuo ambiente Airflow locale.

Per eseguire un comando dell'interfaccia a riga di comando di Airflow:

composer-dev run-airflow-cmd LOCAL_ENVIRONMENT_NAME \
  SUBCOMMAND SUBCOMMAND_ARGUMENTS

Esempio:

composer-dev run-airflow-cmd example-local-environment dags list -o table

Configura gli ambienti Airflow locali

Lo strumento dell'interfaccia a riga di comando dello sviluppo locale di Composer archivia i parametri di configurazione per un ambiente Airflow locale, come le variabili di ambiente e i requisiti dei pacchetti PyPI nella directory dell'ambiente locale (./composer/<local_environment_name>).

La configurazione viene applicata quando viene avviato un ambiente Airflow locale. Ad esempio, se aggiungi requisiti per i pacchetti PyPI in conflitto, lo strumento dell'interfaccia a riga di sviluppo locale di Composer segnala gli errori all'avvio dell'ambiente locale.

Recupero di un elenco e dello stato degli ambienti Airflow locali

Per elencare tutti gli ambienti Airflow locali disponibili e visualizzarne lo stato:

composer-dev list

Per descrivere un ambiente specifico e ottenere dettagli come la versione dell'immagine, il percorso dei DAG e l'URL del server web di un ambiente:

composer-dev describe LOCAL_ENVIRONMENT_NAME

Sostituisci:

  • LOCAL_ENVIRONMENT_NAME con il nome dell'ambiente Airflow locale.

Elenco immagini utilizzate dagli ambienti Airflow locali

Per elencare tutte le immagini utilizzate dallo strumento dell'interfaccia a riga di comando dello sviluppo locale di Composer, esegui:

docker images --filter=reference='*/cloud-airflow-releaser/*/*'

Installazione dei plug-in e modifica dei dati

I plug-in e i dati per un ambiente Airflow locale vengono recuperati dalla directory dell'ambiente locale: ./composer/<local_environment_name>/data e ./composer/<local_environment_name>/plugins.

Per modificare i contenuti delle directory /data e /plugins, aggiungi o rimuovi file in queste directory. Docker propaga automaticamente le modifiche ai file nell'ambiente Airflow locale.

Lo strumento dell'interfaccia a riga di comando dello sviluppo locale di Composer non supporta la specifica di una directory diversa per dati e plug-in.

Configura le variabili di ambiente

Per configurare le variabili di ambiente, modifica il file variables.env nella directory di ambiente: ./composer/<local_environment_name>/variables.env.

Il file variables.env deve contenere le definizioni delle coppie chiave-valore, una riga per ogni variabile di ambiente. Per modificare le opzioni di configurazione di Airflow, utilizza il formato AIRFLOW__SECTION__KEY. Per ulteriori informazioni sulle variabili di ambiente disponibili, consulta il riferimento sulla configurazione di Airflow.

EXAMPLE_VARIABLE=True
ANOTHER_VARIABLE=test
AIRFLOW__WEBSERVER__DAG_DEFAULT_VIEW=graph

Per applicare le modifiche, riavvia l'ambiente Airflow locale.

Installare o rimuovere pacchetti PyPI

Per installare o rimuovere i pacchetti PyPI, modifica il file requirements.txt nella directory dell'ambiente: ./composer/<local_environment_name>/requirements.txt.

I requisiti devono seguire il formato specificato in PEP-508, dove ogni requisito è specificato in minuscolo ed è costituito dal nome del pacchetto con extra facoltativi e identificatori di versione.

Per applicare le modifiche, riavvia l'ambiente Airflow locale.

Passa a un'altra immagine Cloud Composer

Puoi utilizzare qualsiasi immagine di Cloud Composer 2 con lo strumento a riga di comando Local Development di Composer e passare da un'immagine all'altra. Questo approccio è diverso dall'upgrade dell'ambiente Cloud Composer perché i parametri di configurazione dell'ambiente Airflow locale vengono applicati all'avvio.

Ad esempio, dopo il rilascio di una nuova versione di Cloud Composer, puoi cambiare il tuo ambiente per utilizzare la nuova versione e mantenere la configurazione esistente dell'ambiente Airflow locale. Come ulteriore esempio, puoi passare da una versione di Airflow all'altra all'interno di una versione specifica di Cloud Composer.

Per modificare l'immagine dell'ambiente utilizzata dall'ambiente Airflow locale:

  1. Modifica il file di configurazione dell'ambiente locale: ./composer/<local_environment_name>/config.json.

  2. Modifica il valore del parametro composer_image_version. Per visualizzare i valori disponibili, puoi elencare le versioni di Cloud Composer disponibili.

  3. Per applicare le modifiche, riavvia l'ambiente Airflow locale.

Elimina un ambiente Airflow locale

Attenzione: assicurati di aver salvato tutti i dati richiesti dall'ambiente, ad esempio log e configurazione.

Per eliminare un ambiente Airflow locale, esegui questo comando:

composer-dev remove LOCAL_ENVIRONMENT_NAME

Se l'ambiente è in esecuzione, aggiungi il flag --force per forzarne la rimozione.

Elimina immagini Docker

Per eliminare tutte le immagini scaricate dallo strumento dell'interfaccia a riga di comando di Composer locale, esegui:

docker rmi $(docker images --filter=reference='*/cloud-airflow-releaser/*/*' -q)

Risoluzione dei problemi

Questa sezione fornisce soluzioni ai problemi comuni.

Impossibile avviare un ambiente locale su MacOS

Se hai installato il pacchetto composer-dev in una directory in cui Docker non può accedervi, l'ambiente locale potrebbe non avviarsi.

Ad esempio, se Python è installato nella directory /opt, come quando lo installi con la configurazione Homebrew predefinita su MacOS, anche il pacchetto composer-dev viene installato nella directory /opt. Poiché Docker è conforme alle regole della sandbox di Apple, la directory /opt non è disponibile per impostazione predefinita. Inoltre, non puoi aggiungerlo tramite l'interfaccia utente (Impostazioni > Risorse > Condivisione file).

In questo caso, lo strumento dell'interfaccia a riga di comando dello sviluppo locale di Composer genera un messaggio di errore simile all'esempio seguente:

Failed to create container with an error: 400 Client Error for ...
Bad Request ("invalid mount config for type "bind": bind source path does not exist:
/opt/homebrew/lib/python3.9/site-packages/composer_local_dev/docker_files/entrypoint.sh

Possible reason is that composer-dev was installed in the path that is
not available to Docker. See...")

Puoi utilizzare una delle seguenti soluzioni:

  • Installa Python o il pacchetto composer-dev in un'altra directory, in modo che Docker possa accedere al pacchetto.
  • Modifica manualmente il file ~/Library/Group\ Containers/group.com.docker/settings.json e aggiungi /opt a filesharingDirectories.