Cloud Composer 1 | Cloud Composer 2 | Cloud Composer 3
Esta página o orienta na criação de uma arquitetura de envio baseada em eventos por como acionar DAGs do Cloud Composer em resposta ao Pub/Sub mudanças de tópico. Os exemplos neste tutorial demonstram o processamento do ciclo completo de gerenciamento do Pub/Sub, incluindo o gerenciamento de assinaturas, como parte do processo de DAG. Ele é adequado para alguns dos casos de uso comuns quando você precisa acionar DAGs, mas não quer configurar permissões de acesso extras.
Por exemplo, as mensagens enviadas pelo Pub/Sub podem ser usadas como uma solução se você não quiser fornecer acesso direto a um ambiente do Cloud Composer por motivos de segurança. É possível configurar um função do Cloud Run que cria mensagens do Pub/Sub e e as publica em um tópico do Pub/Sub. Em seguida, é possível criar um DAG extrai mensagens do Pub/Sub e as processa.
Neste exemplo específico, você cria uma função do Cloud Run e implanta dois DAGs. O primeiro DAG extrai mensagens do Pub/Sub e aciona o segundo DAG de acordo com o conteúdo da mensagem do Pub/Sub.
Neste tutorial, consideramos que você já conhece o Python e o console do Google Cloud.
Objetivos
Custos
Neste tutorial, usamos o seguinte componente faturável do Google Cloud:
- Cloud Composer (consulte também os custos extras).
- Pub/Sub
- Funções do Cloud Run
Depois de concluir este tutorial, para evitar o faturamento contínuo, exclua nos recursos criados. Consulte Limpeza para mais detalhes.
Antes de começar
Para este tutorial, você precisa ter uma conta do Google Cloud projeto. Configure o projeto da seguinte maneira:
No console do Google Cloud, selecione ou crie um projeto:
Verifique se o faturamento foi ativado para o projeto. Saiba como verificar se o faturamento está ativado em um projeto.
Verifique se o usuário do projeto do Google Cloud tem os seguintes papéis para criar os recursos necessários:
- Usuário da conta de serviço (
roles/iam.serviceAccountUser
) - Editor do Pub/Sub (
roles/pubsub.editor
) - Administrador de ambiente e de objetos do Storage
(
roles/composer.environmentAndStorageObjectAdmin
) - Administrador de funções do Cloud Run (
roles/cloudfunctions.admin
) - Visualizador de registros (
roles/logging.viewer
)
- Usuário da conta de serviço (
Certifique-se de que o conta de serviço que executa a função do Cloud Run tem permissões suficientes no projeto para acessar o Pub/Sub. Por padrão, as funções do Cloud Run usam a conta de serviço padrão do App Engine. Essa conta de serviço tem o papel Editor, que tem permissões para este tutorial.
Ativar as APIs do projeto
Console
Enable the Cloud Composer, Cloud Run functions, and Pub/Sub APIs.
gcloud
Enable the Cloud Composer, Cloud Run functions, and Pub/Sub APIs:
gcloud services enable composer.googleapis.comcloudfunctions.googleapis.com pubsub.googleapis.com
Terraform
Ative a API Cloud Composer no seu projeto adicionando as seguintes definições de recursos ao script do Terraform:
resource "google_project_service" "composer_api" {
project = "<PROJECT_ID>"
service = "composer.googleapis.com"
// Disabling Cloud Composer API might irreversibly break all other
// environments in your project.
// This parameter prevents automatic disabling
// of the API when the resource is destroyed.
// We recommend to disable the API only after all environments are deleted.
disable_on_destroy = false
// this flag is introduced in 5.39.0 version of Terraform. If set to true it will
//prevent you from disabling composer_api through Terraform if any environment was
//there in the last 30 days
check_if_service_has_usage_on_destroy = true
}
resource "google_project_service" "pubsub_api" {
project = "<PROJECT_ID>"
service = "pubsub.googleapis.com"
disable_on_destroy = false
}
resource "google_project_service" "functions_api" {
project = "<PROJECT_ID>"
service = "cloudfunctions.googleapis.com"
disable_on_destroy = false
}
Substitua <PROJECT_ID>
pelo ID do projeto.
do seu projeto. Por exemplo, example-project
.
criar o ambiente do Cloud Composer
Crie um ambiente do Cloud Composer 2.
Como parte deste procedimento,
você concede o papel Extensão do agente de serviço da API Cloud Composer v2
(roles/composer.ServiceAgentV2Ext
) à conta do agente de serviço do Composer. O Cloud Composer usa essa conta para realizar operações
no seu projeto do Google Cloud.
Criar um tópico do Pub/Sub
Este exemplo aciona um DAG em resposta a uma mensagem enviada para um tópico do Pub/Sub. Crie um tópico do Pub/Sub para usar neste exemplo:
Console
No console do Google Cloud, acesse a página Tópicos do Pub/Sub.
Clique em Criar tópico.
No campo ID do tópico, insira
dag-topic-trigger
como um ID para o tópico.Não altere as outras opções.
Clique em Criar tópico.
gcloud
Para criar um tópico, execute o gcloud pubsub topics create na Google Cloud CLI:
gcloud pubsub topics create dag-topic-trigger
Terraform
Adicione as seguintes definições de recursos ao seu script do Terraform:
resource "google_pubsub_topic" "trigger" {
project = "<PROJECT_ID>"
name = "dag-topic-trigger"
message_retention_duration = "86600s"
}
Substitua <PROJECT_ID>
pelo ID do projeto
do seu projeto. Por exemplo, example-project
.
Fazer upload dos seus DAGs
Faça upload dos DAGs para seu ambiente:
- Salve o seguinte arquivo DAG no seu computador local.
- Substitua
<PROJECT_ID>
pelo ID do projeto. do seu projeto. Por exemplo,example-project
. - Faça upload do arquivo DAG editado para seu ambiente.
O exemplo de código contém dois DAGs: trigger_dag
e target_dag
.
O DAG trigger_dag
se inscreve em um tópico do Pub/Sub, extrai
mensagens do Pub/Sub e aciona outro DAG especificado no ID dele
dos dados das mensagens do Pub/Sub. Neste exemplo, trigger_dag
aciona
o DAG target_dag
, que gera mensagens para os registros de tarefas.
O DAG trigger_dag
contém as seguintes tarefas:
subscribe_task
: inscreva-se em um tópico do Pub/Sub.pull_messages_operator
: lê os dados de uma mensagem do Pub/Sub comPubSubPullOperator
.trigger_target_dag
: acionar outro DAG (neste exemplo,target_dag
) de acordo com os dados nas mensagens extraídas do Pub/Sub tópico.
O DAG target_dag
contém apenas uma tarefa: output_to_logs
. Esta tarefa
imprime mensagens no registro de tarefas com um segundo de atraso.
Implantar uma função do Cloud Run que publique mensagens em um tópico do Pub/Sub
Nesta seção, você implantará uma função do Cloud Run que publica mensagens em um tópico do Pub/Sub.
Criar uma função do Cloud Run e especificar a configuração dela
Console
No console do Google Cloud, acesse a página das funções do Cloud Run.
Clique em Criar função.
No campo Ambiente, selecione 1ª geração.
No campo Nome da função, insira o nome da sua função:
pubsub-publisher
No campo Tipo de gatilho, selecione HTTP.
Na seção Autenticação, selecione Permitir invocações não autenticadas. Essa opção concede usuários não autenticados invocar uma função HTTP.
Clique em "Salvar".
Clique em Próximo para acessar a etapa Código.
Terraform
Considere usar o console do Google Cloud nesta etapa, porque não há maneira simples de gerenciar o código-fonte da função no Terraform.
Este exemplo demonstra como fazer upload de uma função do Cloud Run de um arquivo de arquivamento ZIP local criando um bucket do Cloud Storage, armazenando o arquivo nesse bucket e usando o arquivo do bucket como uma fonte para a função do Cloud Run. Se você usar essa abordagem, o Terraform não vai atualizar automaticamente o código-fonte da função, mesmo que você crie um novo arquivo. Para fazer o upload do código da função novamente, mude o nome do arquivo.
- Faça o download dos arquivos
pubsub_publisher.py
erequirements.txt
. - No arquivo
pubsub_publisher.py
, substitua<PROJECT_ID>
pelo ID do projeto. Por exemplo,example-project
. - Crie um arquivo ZIP chamado
pubsub_function.zip
com opbusub_publisner.py
e o arquivorequirements.txt
. - Salve o arquivo ZIP em um diretório onde o script do Terraform esteja armazenado.
- Adicione as seguintes definições de recursos ao script do Terraform e substitua
<PROJECT_ID>
pelo ID do projeto.
resource "google_storage_bucket" "cloud_function_bucket" {
project = <PROJECT_ID>
name = "<PROJECT_ID>-cloud-function-source-code"
location = "US"
force_destroy = true
uniform_bucket_level_access = true
}
resource "google_storage_bucket_object" "cloud_function_source" {
name = "pubsub_function.zip"
bucket = google_storage_bucket.cloud_function_bucket.name
source = "./pubsub_function.zip"
}
resource "google_cloudfunctions_function" "pubsub_function" {
project = <PROJECT_ID>
name = "pubsub-publisher"
runtime = "python310"
region = "us-central1"
available_memory_mb = 128
source_archive_bucket = google_storage_bucket.cloud_function_bucket.name
source_archive_object = "pubsub_function.zip"
timeout = 60
entry_point = "pubsub_publisher"
trigger_http = true
}
Especificar parâmetros do código da função do Cloud Run
Console
Na etapa Código, no campo Ambiente de execução, selecione o idioma o ambiente de execução usado pela função. Neste exemplo, selecione Python 3.10.
No campo Ponto de entrada, digite
pubsub_publisher
. Esse é o código que é executado quando a função do Cloud Run é executada. O valor dessa flag precisa ser um nome de função ou de classe totalmente qualificado que exista no código-fonte.
Terraform
Pule esta etapa. Os parâmetros da função do Cloud Run já estão definidos no
recurso google_cloudfunctions_function
.
Fazer upload do código da função do Cloud Run
Console
No campo Código-fonte, selecione a opção adequada para saber como fornecer o código-fonte da função. Neste tutorial, adicione o código da função usando as funções do Cloud Run Editor in-line. Como alternativa, você pode fazer upload de um arquivo ZIP ou usar o Cloud Source Repositories.
- Coloque o exemplo de código a seguir no arquivo main.py.
- Substitua
<PROJECT_ID>
pelo ID do projeto do seu projeto. Por exemplo,example-project
.
Terraform
Pule esta etapa. Os parâmetros da função do Cloud Run já estão definidos
o recurso google_cloudfunctions_function
.
Especificar as dependências da função do Cloud Run
Console
Especifique as dependências da função no arquivo de metadados requirements.txt:
Quando você implanta sua função, as funções do Cloud Run fazem o download e instalam
as dependências declaradas no arquivo requirements.txt, uma linha por pacote.
Esse arquivo deve estar no mesmo diretório que o arquivo main.py que contém
o código da função. Para mais detalhes, consulte
Arquivos de requisitos
na documentação do pip
.
Terraform
Pule esta etapa. As dependências de função do Cloud Run são definidas no
arquivo requirements.txt
no arquivo pubsub_function.zip
.
Implantar a função do Cloud Run
Console
Clique em Implantar. Quando a implantação é concluída, a função é exibida com uma marca de seleção verde na página Funções do Cloud Run na console do Google Cloud.
Verifique se a conta de serviço que executa a função do Cloud Run tem permissões suficientes no seu projeto para acessar o Pub/Sub.
Terraform
Inicialize o Terraform:
terraform init
Revise a configuração e verifique se os recursos que o Terraform está criar ou atualizar correspondem às suas expectativas:
terraform plan
Para verificar se a configuração é válida, execute o seguinte comando:
terraform validate
Para aplicar a configuração do Terraform, execute o comando a seguir e digite "yes" no prompt:
terraform apply
Aguarde até que o Terraform exiba a mensagem "Apply complete!".
No console do Google Cloud, navegue até os recursos na UI para fazer que o Terraform tenha criado ou atualizado essas informações.
Testar a função do Cloud Run
Para verificar se a função publica uma mensagem em um tópico do Pub/Sub e que os DAGs de exemplo funcionam conforme o esperado:
Verifique se os DAGs estão ativos:
No console do Google Cloud, acesse a página Ambientes.
Na lista de ambientes, clique no nome do ambiente. A página Detalhes do ambiente é aberta.
Acesse a guia DAGs.
Verifique os valores na coluna State para DAGs com os nomes
trigger_dag
etarget_dag
. Os dois DAGs precisam estar no estadoActive
.
Envie uma mensagem de teste do Pub/Sub. É possível fazer isso no Cloud Shell:
No console do Google Cloud, acesse a página Funções.
Clique no nome da função,
pubsub-publisher
.Acesse a guia Testes.
Na seção Configurar evento acionador, insira o seguinte valor de chave JSON:
{"message": "target_dag"}
. Não modifique a chave-valor porque essa mensagem aciona o DAG de teste mais tarde.Na seção Testar comando, clique em Testar no Cloud Shell.
No terminal do Cloud Shell, aguarde até que um comando apareça automaticamente. Execute este comando pressionando
Enter
.Se a mensagem Autorizar o Cloud Shell for exibida, Clique em Autorizar.
Confira se o conteúdo da mensagem corresponde à mensagem do Pub/Sub. Neste exemplo, a mensagem de saída precisa começar com
Message b'target_dag' with message_length 10 published to
como resposta da sua função.
Verifique se
target_dag
foi acionado:Aguarde pelo menos um minuto para que uma nova execução do DAG de
trigger_dag
seja concluída é concluída.No console do Google Cloud, acesse a página Ambientes.
Na lista de ambientes, clique no nome do ambiente. A página Detalhes do ambiente é aberta.
Acesse a guia DAGs.
Clique em
trigger_dag
para acessar a página de detalhes do DAG. Na guia Execuções será exibida uma lista de execuções do DAG para o DAGtrigger_dag
.Esse DAG é executado a cada minuto e processa todas as mensagens do Pub/Sub enviadas pela função. Se nenhuma mensagem foi enviada, o A tarefa
trigger_target
está marcada comoSkipped
nos registros de execução do DAG. Se os DAGs foram acionados, e a tarefatrigger_target
foi marcada comoSuccess
.Procure várias execuções de DAG recentes para localizar uma em que as três tarefas (
subscribe_task
,pull_messages_operator
etrigger_target
) estejam nos statusSuccess
.Volte para a guia DAGs e verifique se a página Successful run (Execuções bem-sucedidas) do DAG
target_dag
lista uma execução bem-sucedida.
Resumo
Neste tutorial, você aprendeu a usar o Cloud Run functions para publicar mensagens em um tópico do Pub/Sub e implantar um DAG que se inscreve em um tópico do Pub/Sub, extrai mensagens do Pub/Sub e aciona outro DAG especificado no ID do DAG dos dados da mensagem.
Há também formas alternativas de Como criar e gerenciar assinaturas do Pub/Sub e acionar DAGs que estão fora do escopo deste tutorial. Por exemplo, é possível usar funções do Cloud Run para acionar DAGs do Airflow quando ocorre um evento especificado. Confira nossos tutoriais para testar os outros recursos do Google Cloud.
Limpar
Para evitar cobranças na sua conta do Google Cloud pelos recursos usados neste tutorial, exclua o projeto que os contém ou mantenha o projeto e exclua os recursos individuais.
Exclua o projeto
Delete a Google Cloud project:
gcloud projects delete PROJECT_ID
Excluir recursos individuais
Se você planeja ver vários tutoriais e guias de início rápido, a reutilização de projetos pode evitar que você exceda os limites da cota do projeto.
Console
- Exclua o ambiente do Cloud Composer. Você também excluir o bucket do ambiente durante este procedimento.
- Exclua o tópico do Pub/Sub,
dag-topic-trigger
. Exclua a função do Cloud Run.
No console do Google Cloud, acesse as funções do Cloud Run.
Clique na caixa de seleção da função que você quer excluir,
pubsub-publisher
.Clique em Excluir e siga as instruções.
Terraform
- Confirme que o script do Terraform não contém entradas para recursos que ainda são exigidos pelo seu projeto. Por exemplo, manter algumas APIs ativadas e o IAM permissões ainda atribuídas (se você adicionou essas definições ao seu script do Terraform).
- Execute
terraform destroy
. - Exclua manualmente o bucket do ambiente. O Cloud Composer não exclui automaticamente. Você pode fazer isso console ou Google Cloud CLI.
A seguir
- Como testar DAGs
- Testar funções HTTP
- Implantar uma função do Cloud Run
- Teste outros recursos do Google Cloud. Confira nossos tutoriais.