Cloud Composer 1 | Cloud Composer 2 | Cloud Composer 3
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.
Sobre as versões de sintaxe da CLI
O Airflow no Cloud Composer 1 oferece duas sintaxes diferentes para comandos da CLI:
Sintaxe da CLI do Airflow 1.10, disponível em ambientes do Cloud Composer com o Airflow 1.10.
Sintaxe da CLI do Airflow 2, disponível nos ambientes do Cloud Composer com o Airflow 2.
Comandos compatíveis da CLI do Airflow
Para ver uma lista completa de comandos compatíveis com a CLI do Airflow, consulte a referência gcloud composer environments run
.
Antes de começar
Você precisa ter permissões suficientes para usar a linha de comando
gcloud
ferramenta de linha de comando com o Cloud Composer e executar comandos da CLI do Airflow. Para mais informações, consulte controle de acesso.Nas versões do Cloud Composer anteriores à 2.4.0, você precisa acesso ao plano de controle do cluster do ambiente para executar comandos da CLI do Airflow.
Executar comandos da CLI do Airflow
Para executar comandos da CLI do Airflow nos seus ambientes, use gcloud
:
gcloud composer environments run ENVIRONMENT_NAME \
--location LOCATION \
SUBCOMMAND \
-- SUBCOMMAND_ARGUMENTS
Substitua:
ENVIRONMENT_NAME
pelo nome do ambienteLOCATION
pela região em que o ambiente está localizado;SUBCOMMAND
por um dos comandos compatíveis 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
Para a sintaxe da CLI do Airflow 2:
- Especifique comandos compostos da CLI como um subcomando.
- Especifique quaisquer argumentos para comandos compostos como argumentos de subcomando,
após um separador
--
.
gcloud composer environments run example-environment \
dags list -- --output=json
Airflow 1
Para a sintaxe da CLI do Airflow 1.10:
- Especifique comandos da CLI como um subcomando.
- Especifique qualquer argumento depois de um separador
--
.
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.
Exemplo
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
Como executar comandos em um ambiente de IP particular
Para executar comandos da CLI do Airflow em um ambiente de IP particular, execute-os em uma máquina que possa acessar o endpoint do plano de controle do cluster do GKE. Suas opções podem variar dependendo da sua configuração de cluster particular.
Se o acesso ao endpoint público estiver desativado no cluster do ambiente,
não será possível usar os comandos gcloud composer
para executar a CLI do Airflow.
Para executar os comandos da CLI do Airflow, siga estas etapas:
- Criar uma VM na rede VPC
- Adquira as credenciais do cluster. Execute este comando:
bash gcloud container clusters get-credentials CLUSTER_NAME \ --region REGION \ --project PROJECT \ --internal-ip
- Use
kubectl
para executar o comando do Airflow. Exemplo:
kubectl exec deployment/airflow-scheduler -n COMPOSER_NAMESPACE \
--container airflow-scheduler -- airflow dags list
Substitua COMPOSER_NAMESPACE
por um namespace semelhante a:
composer-2-0-28-airflow-2-3-394zxc12411
. Encontre o Cloud Composer
na lista de cargas de trabalho ou usando o comando kubectl get namespaces
.
Se o acesso ao endpoint público estiver ativado no cluster do ambiente, será possível também pode executar comandos da CLI do Airflow em uma máquina com um endereço IP externo às redes autorizadas. Para ativar o acesso pela sua máquina, adicione o endereço externo da sua máquina para o endereço IP lista de redes autorizadas.
Solução de problemas
Sem conectividade ao plano de controle do cluster
Ao executar comandos gcloud composer environments run
ou kubectl
, você pode encontrar o seguinte erro:
Get "https://<IP Address>/api?timeout=32s": dial tcp <IP Address>:443: i/o timeout"
Sintoma: essa mensagem de erro indica que não há rede. conectividade de um computador em que você executa esses comandos.
Solução: siga as diretrizes apresentadas nos
Como executar comandos em um ambiente de IP privado
ou use as instruções disponíveis na
Seção O comando kubectl
expira.