Acessar a interface de linha de comando do Airflow

Cloud Composer 3 | Cloud Composer 2 | Cloud Composer 1

O Apache Airflow tem uma interface de linha de comando (CLI) que pode ser usada para realizar tarefas, como acionar e gerenciar DAGs, receber informações sobre execuções e tarefas do DAG, adicionar e excluir conexões e usuários.

Comandos compatíveis da CLI do Airflow

O Airflow no Cloud Composer 1 oferece duas sintaxes diferentes para comandos da CLI:

Para conferir uma lista completa de comandos da CLI do Airflow com suporte, consulte a referência do comando gcloud composer environments run.

Antes de começar

  • Você precisa ter permissões para usar a Google Cloud CLI com o Cloud Composer e executar comandos da CLI do Airflow.

Executar comandos da CLI do Airflow

Para executar comandos da CLI do Airflow nos seus ambientes, use CLI gcloud:

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

Substitua o seguinte :

  • ENVIRONMENT_NAME: o nome do ambiente;
  • LOCATION: a região em que o ambiente está localizado.
  • SUBCOMMAND: um dos comandos da CLI do Airflow.
  • SUBCOMMAND_ARGUMENTS com argumentos para o comando da CLI do Airflow.

Separador de argumentos de subcomando

Separe os argumentos do comando da CLI do Airflow especificado com --:

Airflow 2

  • Especifique comandos CLI compostos como um subcomando.
  • Especifique qualquer argumento para comandos compostos como argumentos de subcomando, após um separador --.

Exemplo:

gcloud composer environments run example-environment \
    dags list -- --output=json

Airflow 1

  • Especifique comandos da CLI como um subcomando.
  • Especifique qualquer argumento depois de um separador --.

Exemplo:

gcloud composer environments run example-environment \
    list_dags -- --report

Local padrão

A maioria dos comandos gcloud composer requer um local. Especifique o local com a sinalização --location ou definindo o local padrão.

Por exemplo, para acionar um DAG chamado sample_quickstart com o ID 5077 no seu ambiente do Cloud Composer:

Airflow 2 

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

Airflow 1 

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

A seguir