Acessar a interface da Web do Airflow

Cloud Composer 3 | Cloud Composer 2 | Cloud Composer 1

O Apache Airflow inclui uma interface do usuário da Web chamada interface do Airflow, que pode ser usada para gerenciar DAGs do Airflow, conferir logs de execução de DAGs, monitorar o Airflow e realizar ações administrativas.

Sobre o servidor da Web do Airflow

Todos os ambientes do Cloud Composer têm um servidor da Web que executa a interface do Airflow. O servidor da Web faz parte da arquitetura do ambiente do Cloud Composer.

O servidor da Web analisa os arquivos de definição do DAG na pasta dags/ e pode acessar os dados e recursos do DAG para carregar o DAG e atender a solicitações HTTP.

O servidor da Web atualiza os DAGs a cada 60 segundos, que é o worker_refresh_interval padrão no Cloud Composer. Um erro do servidor da Web poderá ocorrer se ele não puder analisar todos os DAGs dentro do intervalo de atualização.

O carregamento dos DAGs poderá exceder 60 segundos se houver um grande número desses arquivos ou uma carga de trabalho incomum para carregá-los. Para garantir que o servidor da Web permaneça acessível seja qual for o tempo de carregamento do DAG, configure o carregamento de DAGs assíncrono para analisá-los e carregá-los em segundo plano a um intervalo pré-configurado (disponível no composer-1.7.1-airflow-1.10.2 e em versões posteriores). Essa configuração também pode reduzir o tempo de atualização do DAG.

Além de exceder o intervalo de atualização do worker, o servidor da Web pode lidar normalmente com falhas de carregamento do DAG na maioria dos casos. Os DAGs que travam ou encerram o servidor da Web podem causar erros no navegador. Para mais informações, consulte Como resolver problemas de DAGs.

Se você continuar tendo problemas com o servidor da Web devido à análise do DAG, recomendamos que use o carregamento de DAGs assíncrono.

Antes de começar

  • Você precisa ter um papel que possa ver os ambientes do Cloud Composer. Para mais informações, consulte Controle de acesso.

  • Durante a criação do ambiente, o Cloud Composer configura o URL do servidor da Web que executa a interface do Airflow. Não é possível personalizar o URL.

  • O recurso Controle de acesso da interface do Airflow (controle de acesso baseado em papéis do Airflow) para a interface do Airflow é compatível com ambientes do Cloud Composer que executam o Composer versão 1.13.4 ou mais recente, o Airflow versão 1.10.10 ou mais recente e o Python 3.

Acessar a interface do Airflow

O serviço do servidor da Web do Airflow é implantado no domínio appspot.com e concede acesso à interface do Airflow. O Cloud Composer 1 oferece acesso à interface com base nas identidades do usuário e nas vinculações de políticas do IAM definidas para os usuários. O Cloud Composer 1 usa o Identity-Aware Proxy para essa finalidade.

Depois de criar um novo ambiente do Cloud Composer, levará até 25 minutos para que a interface termine de ser hospedada e se torne acessível.

Acessar a interface do Airflow no console do Google Cloud

Para acessar a interface do Airflow no console do Google Cloud:

  1. No console do Google Cloud, acesse a página Ambientes.

    Acessar "Ambientes"

  2. Na coluna Servidor da Web do Airflow, siga o link Airflow do ambiente.

  3. Faça login com uma Conta do Google que tenha as permissões apropriadas.

Acessar o URL da interface do Airflow com a Google Cloud CLI

É possível acessar a interface do Airflow em qualquer navegador da Web. Para conferir o URL da interface do Airflow, execute o seguinte comando na CLI do Google Cloud:

gcloud composer environments describe ENVIRONMENT_NAME \
  --location LOCATION

Substitua:

  • ENVIRONMENT_NAME: o nome do ambiente;
  • LOCATION: a região em que o ambiente está localizado.

O comando gcloud mostra as propriedades de um ambiente do Cloud Composer, incluindo o URL da interface do Airflow. O URL está listado como airflowUri.

config:
  airflowUri: https://example-tp.appspot.com

Configurar o carregamento assíncrono de DAG

Quando o carregamento assíncrono do DAG está ativado, o servidor da Web do Airflow cria um novo processo. Esse processo carrega DAGs em segundo plano, envia DAGs recém-carregados em intervalos definidos pela opção dagbag_sync_interval e, em seguida, fica suspenso.

O processo é ativado periodicamente para recarregar os DAGs, o intervalo é definido pela opção collect_dags_interval.

Para ativar o carregamento de DAG assíncrono:

  1. Desative a serialização do DAG. O carregamento assíncrono do DAG não pode ser usado com a serialização do DAG. Usar as opções de configuração async_dagbag_loader e store_serialized_dags do Airflow produz erros HTTP 503 e interrompe o ambiente.

  2. Substitua as seguintes opções de configuração do Airflow:

    Seção Chave Valor Observações
    webserver async_dagbag_loader True O padrão é False.
    webserver collect_dags_interval 30 O padrão é 30. Use um valor menor para fazer atualizações mais rápidas.
    webserver dagbag_sync_interval 10 O padrão é 10.
    webserver worker_refresh_interval 3600 O padrão é 60. Com o carregamento de DAG assíncrono, é possível usar um intervalo de atualização maior.

Reiniciar o servidor da Web

Ao depurar ou solucionar problemas de ambientes do Cloud Composer, alguns problemas podem ser resolvidos com a reinicialização do servidor da Web do Airflow. Reinicie o servidor da Web usando a API restartWebServer ou o comando restart-web-server na CLI do Google Cloud:

gcloud beta composer environments restart-web-server ENVIRONMENT_NAME \
  --location=LOCATION

Substitua:

  • ENVIRONMENT_NAME: o nome do ambiente;
  • LOCATION: a região em que o ambiente está localizado.

Configurar o acesso à rede do servidor da Web

Os parâmetros de acesso do servidor da Web do Airflow não dependem da configuração de rede do seu ambiente. Em vez disso, configure o acesso ao servidor da Web separadamente. Por exemplo, um ambiente de IP particular ainda pode ter a IU do Airflow acessível pela Internet.

Não é possível configurar os intervalos de IP permitidos como endereços IP particulares.

Console

  1. No console do Google Cloud, acesse a página Ambientes.

    Acessar "Ambientes"

  2. Na lista de ambientes, clique no nome do seu ambiente. A página Detalhes do ambiente é aberta.

  3. Acesse a guia Configuração do ambiente.

  4. Na seção Configuração de rede, encontre o item Controle de acesso ao servidor da Web e clique em Editar.

  5. Na caixa de diálogo Controle de acesso à rede do servidor da Web:

    • Para conceder acesso ao servidor da Web do Airflow de todos os endereços IP, selecione Permitir acesso de todos os endereços IP.

    • Para restringir o acesso somente a intervalos de IP específicos, selecione Permitir acesso apenas de endereços IP específicos . No campo Intervalo de IP, especifique um intervalo de IP na notação CIDR. No campo Descrição, especifique uma descrição opcional para este intervalo. Se você quiser especificar mais de um intervalo, clique em Adicionar intervalo de IP.

    • Para proibir o acesso de todos os endereços IP, selecione Permitir acesso somente de endereços IP específicos e clique em Excluir item ao lado da entrada de intervalo vazia.

gcloud

Quando você atualiza um ambiente, os seguintes argumentos controlam os parâmetros de acesso do servidor da Web:

  • --web-server-allow-all fornece acesso ao Airflow a partir de todos os endereços IP. Essa é a opção padrão.

  • --web-server-allow-ip restringe o acesso apenas a intervalos de IP de origem específicos. Para especificar vários intervalos de IP, use esse argumento várias vezes.

  • --web-server-deny-all proíbe o acesso a todos os endereços IP.

gcloud composer environments update ENVIRONMENT_NAME \
    --location LOCATION \
    --web-server-allow-ip ip_range=WS_IP_RANGE,description=WS_RANGE_DESCRIPTION

Substitua:

  • ENVIRONMENT_NAME: o nome do ambiente;
  • LOCATION: a região em que o ambiente está localizado.
  • WS_IP_RANGE: o intervalo de IP, na notação CIDR, que pode acessar a interface do Airflow.
  • WS_RANGE_DESCRIPTION: a descrição do intervalo de IP.

Exemplo:

gcloud composer environments update example-environment \
    --location us-central1 \
    --web-server-allow-ip ip_range=192.0.2.0/24,description="example range" \
    --web-server-allow-ip ip_range=192.0.4.0/24,description="example range 2"

API

  1. Crie uma solicitação de API [environments.patch][api-patch].

  2. Nesta solicitação:

    1. No parâmetro updateMask, especifique a máscara config.webServerNetworkAccessControl.

    2. No corpo da solicitação, especifique como os registros de tarefas do Airflow precisam ser salvos:

      • Para conceder acesso ao Airflow de todos os endereços IP, especifique um elemento config vazio (o elemento webServerNetworkAccessControl não pode estar presente).

      • Para restringir o acesso apenas a intervalos de IP específicos, especifique um ou mais intervalos em allowedIpRanges.

      • Para proibir o acesso de todos os endereços IP, especifique um elemento webServerNetworkAccessControl vazio. O elemento webServerNetworkAccessControl precisa estar presente, mas não pode conter um elemento allowedIpRanges.

{
  "config": {
    "webServerNetworkAccessControl": {
      "allowedIpRanges": [
        {
          "value": "WS_IP_RANGE",
          "description": "WS_RANGE_DESCRIPTION"
        }
      ]
    }
  }
}

Substitua:

  • WS_IP_RANGE: o intervalo de IP, na notação CIDR, que pode acessar a interface do Airflow.
  • WS_RANGE_DESCRIPTION: a descrição do intervalo de IP.

Exemplo:

// PATCH https://composer.googleapis.com/v1/projects/example-project/
// locations/us-central1/environments/example-environment?updateMask=
// config.webServerNetworkAccessControl

{
  "config": {
    "webServerNetworkAccessControl": {
      "allowedIpRanges": [
        {
          "value": "192.0.2.0/24",
          "description": "example range"
        },
        {
          "value": "192.0.4.0/24",
          "description": "example range 2"
        }
      ]
    }
  }
}

Terraform

No bloco allowed_ip_range, no web_server_network_access_control, especifique os intervalos de IP que podem acessar o servidor da Web.

resource "google_composer_environment" "example" {
  provider = google-beta
  name = "ENVIRONMENT_NAME"
  region = "LOCATION"

  config {

    web_server_network_access_control {

      allowed_ip_range {
        value = "WS_IP_RANGE"
        description = "WS_RANGE_DESCRIPTION"
      }

    }

  }
}

Substitua:

  • WS_IP_RANGE: o intervalo de IP, na notação CIDR, que pode acessar a interface do Airflow.
  • WS_RANGE_DESCRIPTION: a descrição do intervalo de IP.

Exemplo:

resource "google_composer_environment" "example" {
  provider = google-beta
  name = "example-environment"
  region = "us-central1"

  config {

    web_server_network_access_control {
      allowed_ip_range {
        value = "192.0.2.0/24"
        description = "example range"
      },
      allowed_ip_range {
        value = "192.0.4.0/24"
        description = "example range 2"
      }

    }
}

A seguir