Programar uma função do Cloud Run orientada a eventos

Este tutorial mostra como acionar uma função do Cloud Run orientada a eventos usando o Cloud Scheduler e direcionando um tópico do Pub/Sub. Use uma função orientada a eventos quando ela precisar ser acionada diretamente em resposta a eventos no seu Google Cloud projeto, como mensagens em um tópico do Pub/Sub ou mudanças em um bucket do Cloud Storage.

Também é possível programar uma função HTTP direcionando o endpoint HTTP dela. Use uma função HTTP quando precisar que a função tenha um endpoint de URL e responda a solicitações HTTP, como para webhooks. Para mais informações, consulte Tipos de funções do Cloud Run.

Programar a execução de uma função do Cloud Run é um caso de uso comum do Cloud Scheduler. Com este tutorial, você vai:

1. criar uma função simples do Cloud Run que assine um tópico do Pub/Sub;
2. criar um job do Cloud Scheduler que publique uma mensagem no tópico do Pub/Sub;
3. executar o job do Cloud Scheduler;
4. verificar se a função do Cloud Run foi acionada pelo job do Cloud Scheduler.

Custos

Neste documento, você vai usar os seguintes componentes faturáveis do Google Cloud:

• Cloud Run functions
• Cloud Scheduler
• Pub/Sub

Para gerar uma estimativa de custo baseada na projeção de uso, use a calculadora de preços.

Novos usuários do Google Cloud podem estar qualificados para um teste sem custo financeiro.

Antes de começar

Faça login na sua Google Cloud conta do. Se você começou a usar o Google Cloud, crie uma conta para avaliar o desempenho dos nossos produtos em situações reais. Clientes novos também recebem US $300 em créditos para executar, testar e implantar cargas de trabalho.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud Build, Cloud Functions, Cloud Run Admin, Cloud Scheduler, Eventarc APIs.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the APIs

Create a service account:

1. Ensure that you have the Create Service Accounts IAM role (roles/iam.serviceAccountCreator) and the Project IAM Admin role (roles/resourcemanager.projectIamAdmin). Learn how to grant roles.

2. In the Google Cloud console, go to the Create service account page.

   Go to Create service account
3. Select your project.

4. In the Service account name field, enter a name. The Google Cloud console fills in the Service account ID field based on this name.

   In the Service account description field, enter a description. For example, Service account for quickstart.

5. Click Create and continue.

6. Grant the Cloud Run > Cloud Run Invoker role to the service account.

   To grant the role, find the Select a role list, then select Cloud Run > Cloud Run Invoker.

   Note: The Role field affects which resources the service account can access in your project. You can revoke these roles or grant additional roles later.
7. Click Continue.

8. Click Done to finish creating the service account.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud Build, Cloud Functions, Cloud Run Admin, Cloud Scheduler, Eventarc APIs.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the APIs

Create a service account:

1. Ensure that you have the Create Service Accounts IAM role (roles/iam.serviceAccountCreator) and the Project IAM Admin role (roles/resourcemanager.projectIamAdmin). Learn how to grant roles.

2. In the Google Cloud console, go to the Create service account page.

   Go to Create service account
3. Select your project.

4. In the Service account name field, enter a name. The Google Cloud console fills in the Service account ID field based on this name.

   In the Service account description field, enter a description. For example, Service account for quickstart.

5. Click Create and continue.

6. Grant the Cloud Run > Cloud Run Invoker role to the service account.

   To grant the role, find the Select a role list, then select Cloud Run > Cloud Run Invoker.

   Note: The Role field affects which resources the service account can access in your project. You can revoke these roles or grant additional roles later.
7. Click Continue.

8. Click Done to finish creating the service account.

É necessário conceder o papel de invocador do Cloud Run porque nas funções do Cloud Run (2ª geração), as permissões de invocação estão disponíveis ao gerenciar o serviço subjacente do Cloud Run.

1. Por padrão, as funções do Cloud Run usam a conta de serviço padrão do Compute Engine criada automaticamente para a conta de serviço do ambiente de execução. Você pode usar essa conta de serviço para testar este tutorial. No entanto, dependendo da configuração da política da organização, a conta de serviço padrão pode não receber automaticamente o papel de editor no projeto. Nesse caso, é necessário conceder à conta de serviço os seguintes papéis:
   1. Gravador do Artifact Registry (roles/artifactregistry.writer)
   2. Gravador de registros (roles/logging.logWriter)
   3. Leitor de objetos do Storage (roles/storage.objectViewer)

Criar uma função do Cloud Run orientada a eventos

Crie uma função orientada a eventos que seja acionada diretamente em resposta a eventos no seu Google Cloud projeto. Neste caso, uma mensagem publicada em um tópico do Pub/Sub.

1. No Google Cloud console do, acesse a página Funções do Cloud Run.

   Acessar as funções do Cloud Run

2. Clique em Criar função.

3. Na seção Noções básicas, faça o seguinte:

   1. Na lista Ambiente, selecione 2ª geração.
   2. Insira um nome para a função.
   3. Na lista Região, selecione uma região.

4. Na seção Acionador, faça o seguinte:

   1. Na lista Tipo de acionador, selecione Cloud Pub/Sub.
   2. Na lista Tópico do Cloud Pub/Sub , selecione um tópico existente ou, para criar um novo, clique em Criar um tópico. Anote o nome do tópico, porque você vai precisar dele em uma etapa posterior.

   3. Clique em Mais opções.

      O painel Acionador do Eventarc é aberto.

5. No painel Acionador do Eventarc, faça o seguinte:

   1. Se for necessário permitir que o serviço do Pub/Sub crie os tokens de identidade necessários para invocar a função, clique em Conceder.
   2. Na lista Conta de serviço, selecione a conta de serviço que você criou anteriormente.
   3. Aceite os outros padrões.

   4. Clique em Salvar acionador.

      O painel Acionador do Eventarc é fechado.

6. Aceite os outros padrões e clique em Próxima.

7. Não modifique o idioma padrão do ambiente de execução e o exemplo de código. O código não usa nenhum serviço de nuvem e não precisa de permissões adicionais ativadas. Clique em Implantar.

Criar um job do Cloud Scheduler

Crie um job do Cloud Scheduler com um destino do Pub/Sub.

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

   Acessar o Cloud Scheduler

2. Clique em Click Criar job.

3. Insira um nome para o job.

4. Na lista Região, selecione uma região.

5. Especifique a frequência do job usando um formato unix-cron:

   30 16 * * 7
   

   Para mais informações, consulte Formato e fuso horário do cron job.

6. Na lista Fuso horário, selecione um fuso horário.

7. Clique em Continuar.

8. Na lista Tipo de destino, selecione Pub/Sub.

9. Selecione o tópico do Pub/Sub criado anteriormente.

10. No campo Corpo da mensagem, insira uma string a ser enviada ao tópico de destino do Pub/Sub. Por exemplo: "Olá, mundo!"

11. Clique em Criar.

Você criou um cron job que envia uma mensagem para o tópico do Pub/Sub às 16h30 aos domingos. Sua função do Cloud Run está inscrita nesse tópico.

Executar o job do Cloud Scheduler

Agora é possível executar o job criado.

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

   Acessar o Cloud Scheduler

2. Marque a caixa de seleção do job criado e clique em Forçar execução.

   Quando é invocado inicialmente, o primeiro job criado em um projeto pode levar alguns minutos para ser configurado e executado.

3. Depois que o job for executado, o Status da última execução vai indicar Success.

Verificar os resultados nas funções do Cloud Run

É possível verificar se a função do Cloud Run foi acionada e executada corretamente pelo cron job.

1. No Google Cloud console do, acesse a página Funções do Cloud Run.

   Acessar as funções do Cloud Run

2. Clique no nome da função.

   A página Detalhes da função é aberta e o gráfico Invocações/segundo mostra a primeira invocação da função.

3. Clique na guia Registros.

   Você verá uma entrada de registro semelhante a Hello, YOUR_STRING!

Liberar espaço

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.

Excluir projeto

Cuidado: excluir um projeto tem os seguintes efeitos:

• Tudo no projeto é excluído. Se você tiver usado um projeto atual para as tarefas neste documento, a exclusão dele incluirá a exclusão de quaisquer outros trabalhos feitos nele.
• Os IDs do projeto personalizados são perdidos. Ao criar o projeto, você pode ter criado um ID do projeto personalizado para ser usado no futuro. Para preservar os URLs que usam o ID do projeto, como um URL appspot.com, exclua recursos específicos do projeto, em vez de excluir o projeto inteiro.

Se você planeja explorar várias arquiteturas, tutoriais e guias de início rápido, a reutilização de projetos pode evitar que você exceda limites da cota.

1. No Google Cloud console, acesse a página Gerenciar recursos.

   Acessar "Gerenciar recursos"

2. Na lista de projetos, selecione o projeto que você quer excluir e clique em Excluir.
3. Na caixa de diálogo, digite o ID do projeto e clique em Desligar para excluir o projeto.

Excluir recursos do tutorial

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

   Acessar o Cloud Scheduler

2. Clique na caixa de seleção que está próxima ao job.

3. Clique em Excluir e confirme a sua exclusão.

4. No Google Cloud console, acesse a página Pub/Sub.

   Ir para o Pub/Sub

5. Marque a caixa de seleção ao lado do tópico.

6. Clique em Excluir e confirme a sua exclusão.

7. No Google Cloud console do, acesse a página Funções do Cloud Run.

   Acessar as funções do Cloud Run

8. Marque a caixa de seleção ao lado da função.

9. Clique em Excluir e confirme a sua exclusão.

10. No Google Cloud console do, acesse a página Contas de serviço.

    Acessar a página "Contas de serviço"

11. Marque a caixa de seleção ao lado da conta de serviço criada.

12. Clique em Excluir e confirme a sua exclusão.

A seguir

• Usar o Cloud Scheduler para acionar o Cloud Run em uma programação