Accedi all'interfaccia a riga di comando di Airflow

Cloud Composer 1 | Cloud Composer 2 | Cloud Composer 3

Apache Airflow dispone di un'interfaccia a riga di comando (CLI) che puoi utilizzare per eseguire come l'attivazione e la gestione dei DAG e l'ottenimento di informazioni sulle esecuzioni dei DAG e attività, aggiungendo ed eliminando connessioni e utenti.

Informazioni sulle versioni della sintassi della CLI

Airflow in Cloud Composer 1 fornisce due diverse sintassi per i comandi dell'interfaccia a riga di comando:

Comandi dell'interfaccia a riga di comando Airflow supportati

Per un elenco completo dei comandi dell'interfaccia a riga di comando di Airflow supportati, consulta gcloud composer environments run riferimento.

Prima di iniziare

  • Devi disporre di autorizzazioni sufficienti per utilizzare lo strumento a riga di comando gcloud con Cloud Composer ed eseguire i comandi della CLI di Airflow. Per maggiori informazioni informazioni, consulta la sezione Controllo dell'accesso.

  • Nelle versioni di Cloud Composer precedenti alla 2.4.0, devi avere accesso al piano di controllo del cluster del tuo ambiente per eseguire i comandi Airflow CLI.

Esegui i comandi dell'interfaccia a riga di comando di Airflow

Per eseguire i comandi dell'interfaccia a riga di comando di Airflow nei tuoi ambienti, utilizza gcloud:

gcloud composer environments run ENVIRONMENT_NAME \
    --location LOCATION \
    SUBCOMMAND \
    -- SUBCOMMAND_ARGUMENTS

Sostituisci:

Separatore di argomenti sottocomando

Separa gli argomenti per il comando dell'interfaccia a riga di comando di Airflow specificato con --:

Airflow 2

Per la sintassi dell'interfaccia a riga di comando Airflow 2:

  • Specifica i comandi CLI composti come sottocomando.
  • Specifica eventuali argomenti per i comandi composti come argomenti del sottocomando, dopo un separatore --.
gcloud composer environments run example-environment \
    dags list -- --output=json

Airflow 1

Per la sintassi dell'interfaccia a riga di comando Airflow 1.10:

  • Specifica i comandi CLI come sottocomando.
  • Specifica eventuali argomenti dopo un separatore --.
gcloud composer environments run example-environment \
    list_dags -- --report

Località predefinita

La maggior parte dei comandi gcloud composer richiede una posizione. Puoi specificare località con il flag --location o per impostare la località predefinita.

Esempio

Ad esempio, per attivare un DAG denominato sample_quickstart con l'ID 5077 in il tuo ambiente Cloud Composer:

Flusso d'aria 2 

gcloud composer environments run example-environment \
    --location us-central1 dags trigger -- sample_quickstart \
    --run-id=5077

Flusso d'aria 1 

gcloud composer environments run example-environment \
    --location us-central1 trigger_dag -- sample_quickstart \
    --run_id=5077

Eseguire comandi in un ambiente IP privato

Per eseguire i comandi dell'interfaccia a riga di comando di Airflow in un ambiente IP privato, su una macchina in grado di accedere dall'endpoint del piano di controllo. Le opzioni possono variare a seconda del configurazione del cluster privato.

Se l'accesso all'endpoint pubblico è disattivato nel cluster del tuo ambiente, non è possibile utilizzare i comandi gcloud composer per eseguire Airflow CLI. Per poter eseguire i comandi dell'interfaccia a riga di comando di Airflow, svolgi i seguenti passaggi:

  1. Crea una VM nella rete VPC
  2. Acquisisci le credenziali del cluster. Esegui questo comando: bash gcloud container clusters get-credentials CLUSTER_NAME \ --region REGION \ --project PROJECT \ --internal-ip
  • Usa kubectl per eseguire il comando Airflow. Ad esempio:
kubectl exec deployment/airflow-scheduler -n COMPOSER_NAMESPACE \
  --container airflow-scheduler -- airflow dags list

Sostituisci COMPOSER_NAMESPACE con uno spazio dei nomi simile a: composer-2-0-28-airflow-2-3-394zxc12411. Puoi trovare Cloud Composer nell'elenco dei carichi di lavoro o utilizzando il comando kubectl get namespaces.

Se l'accesso agli endpoint pubblici è abilitato nel cluster del tuo ambiente, puoi anche eseguire i comandi dell'interfaccia a riga di comando di Airflow da una macchina con un indirizzo IP esterno aggiunto alle reti autorizzate. Per abilitare l'accesso dal tuo computer, aggiungi il token dalla macchina all'indirizzo esterno della macchina elenco di reti autorizzate.

Risoluzione dei problemi

Nessuna connettività al control plane del cluster

Con gcloud composer environments run in esecuzione o kubectl, potresti riscontrare il seguente errore:

Get "https://<IP Address>/api?timeout=32s": dial tcp <IP Address>:443: i/o timeout"

Sintomo: questo messaggio di errore indica che non è presente alcuna connettività di rete da un computer su cui esegui questi comandi.

Soluzione: segui le linee guida riportate nella sezione Eseguire comandi in un ambiente IP privato o utilizza le istruzioni disponibili nella sezione Il comando kubectl ha esaurito il tempo di attesa.