Configurar notificações do Google Chat

Experimental — googlechat

Este recurso está sujeito aos Termos das Soluções Pré-GA na seção Termos Gerais de Serviço dos Termos Específicos de Serviço. Os recursos pré-GA estão disponíveis "no estado em que se encontram" e podem ter suporte limitado. Para mais informações, consulte as descrições da fase de lançamento.

O Cloud Build pode notificar você sobre atualizações de build enviando notificações para os canais selecionados, como o Slack ou seu servidor SMTP. Esta página explica como configurar notificações usando o notificador do Google Chat.

Antes de começar

• Ative as APIs Cloud Build, Compute Engine, Cloud Run, Pub/Sub e Secret Manager.

  Funções necessárias para ativar APIs

  Para ativar APIs, você precisa da permissão serviceusage.services.enable. Se você criou o projeto, provavelmente já tem essa permissão com o papel de Proprietário (roles/owner). Caso contrário, é possível receber essa permissão com o papel de Administrador do Service Usage (roles/serviceusage.serviceUsageAdmin). Saiba como conceder papéis.

  Ativar as APIs

• Instale a CLI do Google Cloud.

Configurar notificações do Google Chat

A seção a seguir explica como configurar manualmente as notificações de chat do Google Chat usando o notificador do Google Chat. Se você quiser automatizar a configuração, consulte Como automatizar a configuração de notificações.

Para configurar as notificações do Google Chat:

1. Crie um espaço no Google Chat.

2. No espaço criado, crie um webhook de entrada para postar mensagens do Cloud Build no Google Chat. Seu URL será semelhante a este:

   https://chat.googleapis.com/v1/spaces/...
   

3. Armazene o URL do webhook de entrada no Secret Manager:

   1. Abra a página do Secret Manager no console Google Cloud :

      Abra a página do Secret Manager

   2. Clique em Criar secret.

   3. Insira um nome para o secret.

   4. Em Secret value, adicione o URL do webhook de entrada do seu espaço do Google Chat.

   5. Para salvar o secret, clique em Criar secret.

4. Embora a conta de serviço do Cloud Run possa ter o papel de Editor para o projeto, o papel de Editor não é suficiente para acessar o secret no Secret Manager. Para conceder à sua conta de serviço do Cloud Run acesso ao secret, faça o seguinte:

   1. Acesse a página do IAM no console Google Cloud :

      Abrir a página do IAM

   2. Localize a conta de serviço padrão do Compute Engine associada ao seu projeto:

      Sua conta de serviço padrão do Compute Engine será semelhante a esta:

      [e-mail]
      

      Anote a conta de serviço padrão do Compute Engine.

      Observação: por padrão, o Cloud Run executa as imagens do notificador com a conta de serviço padrão do Compute Engine e a utiliza para buscar o secret. Para mais informações sobre contas de serviço em ambiente de execução, consulte Conta de serviço em ambiente de execução.

   3. Abra a página do Secret Manager no console Google Cloud :

      Abra a página do Secret Manager

   4. Clique no nome do secret que contém o secret do webhook do Google Chat.

   5. Na guia Permissões, clique em Adicionar membro.

   6. Adicione a conta de serviço padrão do Compute Engine associada ao projeto como membro.

   7. Selecione a permissão Acessador de secrets do Secret Manager como papel.

   8. Clique em Salvar.

5. Conceda permissão à conta de serviço do Cloud Run para ler dos buckets do Cloud Storage:

   1. Acesse a página do IAM no console Google Cloud :

      Abrir a página do IAM

   2. Localize a conta de serviço padrão do Compute Engine associada ao seu projeto:

      Sua conta de serviço padrão do Compute Engine será semelhante a esta:

      [e-mail]
      

   3. Clique no ícone de lápis na linha que contém sua conta de serviço padrão do Compute Engine. A guia acesso de edição vai aparecer.

   4. Clique em Adicionar outro papel.

   5. Adicione o seguinte papel:

      • Leitor de objetos do Storage
      Observação: se você quiser conceder permissões no nível do bucket e não no nível do projeto, adicione o papel Proprietário do objeto legado do Storage quando você criar um bucket. Para saber mais, consulte Como conceder papéis no nível do projeto, do bucket ou da pasta gerenciada.

   6. Clique em Salvar.

6. Grave um arquivo de configuração do notificador para configurar seu notificador do Google Chat e filtrar eventos de build:

   No exemplo de arquivo de configuração do notificador a seguir, o campo filter usa a Common Expression Language com a variável disponível, build, para filtrar eventos de build com um status SUCCESS:

   apiVersion: cloud-build-notifiers/v1
   kind: GoogleChatNotifier
   metadata:
     name: example-googlechat-notifier
   spec:
     notification:
       filter: build.status == Build.Status.SUCCESS
       delivery:
         webhookUrl:
           secretRef: webhook-url
     secrets:
     - name: webhook-url
       value: projects/PROJECT_ID/secrets/SECRET_NAME/versions/latest
   

   Em que:

   • webhook-url é a variável de configuração usada neste exemplo para fazer referência ao caminho do URL do webhook do Google Chat armazenado no Secret Manager. O nome da variável especificada aqui precisa corresponder ao campo name em secrets.
   • PROJECT_ID é o ID do projeto do Google Cloud .
   • SECRET_NAME é o nome do secret que contém o URL do webhook do Google Chat.

   Para ver o exemplo, consulte o arquivo de configuração do notificador para o notificador do Google Chat.

   Para ver outros campos que podem ser filtrados, consulte o recurso Build. Para outros exemplos de filtragem, consulte Como usar a CEL para filtrar eventos de build.

7. Faça o upload do arquivo de configuração do notificador em um bucket do Cloud Storage:

   1. Se você não tiver um bucket do Cloud Storage, execute o seguinte comando para criar um bucket, em que BUCKET_NAME é o nome que você quer dar ao bucket, sujeito aos requisitos de nomenclatura.

      gcloud storage buckets create gs://BUCKET_NAME/
      

   2. Faça o upload do arquivo de configuração do notificador para o bucket:

      gcloud storage cp CONFIG_FILE_NAME gs://BUCKET_NAME/CONFIG_FILE_NAME
      

      Onde:

      • BUCKET_NAME é o nome do bucket.
      • CONFIG_FILE_NAME é o nome do seu arquivo de configuração.

8. Implante o notificador no Cloud Run.

    gcloud run deploy SERVICE_NAME \
      --image=us-east1-docker.pkg.dev/gcb-release/cloud-build-notifiers/googlechat:latest \
      --no-allow-unauthenticated \
      --update-env-vars=CONFIG_PATH=CONFIG_PATH,PROJECT_ID=PROJECT_ID
   

   Onde:

   • SERVICE_NAME é o nome do serviço do Cloud Run em que você está implantando a imagem;
   • CONFIG_PATH é o caminho para o arquivo de configuração do notificador do Google Chat gs://BUCKET_NAME/CONFIG_FILE_NAME.
   • PROJECT_ID é o ID do projeto do Google Cloud .

   O comando gcloud run deploy extrai a versão mais recente da imagem hospedada do Registro de artefatos de propriedade do Cloud Build. O Cloud Build oferece suporte a imagens do notificador por nove meses. Após nove meses, o Cloud Build exclui a versão da imagem. Se quiser usar uma versão de imagem anterior, você precisará especificar a versão semântica completa da tag de imagem no atributo image do seu comando gcloud run deploy. Versões e tags de imagem anteriores podem ser encontradas no Artifact Registry.

   Observação: ao executar esse comando, talvez seja necessário especificar outros argumentos, como --region ou --platform. Para saber mais sobre parâmetros que podem ser transmitidos ao comando gcloud run deploy, consulte Como implantar no Cloud Run. Se você não conseguir implantar o notificador usando esse comando, consulte o guia de solução de problemas do Cloud Run para saber como resolver erros de implantação.

9. Crie uma conta de serviço para representar sua identidade de assinatura do Pub/Sub:

   gcloud iam service-accounts create SUB_IDENTITY_SERVICE_ACCOUNT \
     --display-name "SUB_IDENTITY_SERVICE_ACCOUNT_DISPLAY_NAME"
   

   Em que:

   • SUB_IDENTITY_SERVICE_ACCOUNT é um nome para a conta de serviço.

   • SUB_IDENTITY_SERVICE_ACCOUNT_DISPLAY_NAME é um nome de exibição para a conta de serviço.

   Observação: essa conta de serviço é diferente da conta de serviço do Pub/Sub, que o Google Cloud cria quando você cria uma assinatura do Pub/Sub pela primeira vez. A conta de serviço do Pub/Sub tem o endereço [e-mail].

10. Conceda à conta de serviço de identidade de assinatura do Pub/Sub as permissões necessárias para criar tokens de autenticação no seu projetoGoogle Cloud .

    gcloud iam service-accounts add-iam-policy-binding \
        SUB_IDENTITY_SERVICE_ACCOUNT@PROJECT_ID.iiam.gserviceaccount.com \
        --member=serviceAccount:[e-mail] \
        --role=roles/iam.serviceAccountTokenCreator
    

    Em que:

    • PROJECT_ID é o ID do projeto do Google Cloud .

    • PROJECT_NUMBER é o número do projeto Google Cloud .

11. Conceda à conta de serviço SUB_IDENTITY_SERVICE_ACCOUNT o papel Invoker do Cloud Run:

    gcloud run services add-iam-policy-binding SERVICE_NAME \
       --member=serviceAccount:SUB_IDENTITY_SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com \
       --role=roles/run.invoker
    

    Em que:

    • SERVICE_NAME é o nome do serviço do Cloud Run em que você está implantando a imagem;

    • PROJECT_ID é o ID do projeto do Google Cloud .

12. Crie o tópico cloud-builds para receber mensagens de atualização da build para seu notificador:

    gcloud pubsub topics create cloud-builds
    

    Também é possível definir um nome de tópico personalizado no arquivo de configuração do build para que as mensagens sejam enviadas ao tópico personalizado. Nesse caso, você criaria um tópico com o mesmo nome personalizado:

    gcloud pubsub topics create topic-name
    

    Para mais informações, consulte Tópicos do Pub/Sub para notificações de build.

13. Crie um assinante de push do Pub/Sub para seu notificador:

     gcloud pubsub subscriptions create subscriber-id \
       --topic=cloud-builds \
       --push-endpoint=SERVICE_URL \
       --push-auth-service-account=SUB_IDENTITY_SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com

Em que: + SUBSCRIBER_ID é o nome que você quer dar à sua assinatura. + SERVICE_URL é o URL gerado pelo Cloud Run para o novo serviço. + PROJECT_ID é o ID do projeto do Google Cloud .

Note: By default, [subscriptions expire after 31 days of inactivity](/pubsub/docs/subscription-overview#lifecycle).
You can adjust or disable the expiration period by including the
[`--expiration-period` flag](/sdk/gcloud/reference/pubsub/subscriptions/create#--expiration-period)
when creating the subscription.

Agora as notificações do seu projeto do Cloud Build estão configuradas. Da próxima vez que você invocar um build, você vai receber uma notificação no Google Chat caso o build corresponda ao filtro que você configurou.

Como usar a CEL para filtrar eventos de build

O Cloud Build usa a CEL com a variável build nos campos listados no recurso Build para acessar os campos associados ao evento de build, como o ID do gatilho, a lista de imagens ou os valores de substituição. Use a string filter para filtrar eventos de build no arquivo de configuração do build usando qualquer campo listado no recurso Build. Para encontrar a sintaxe exata associada ao seu campo, consulte o arquivo cloudbuild.proto.

Como filtrar por ID do acionador

Para filtrar por ID de gatilho, especifique o valor do ID do gatilho no campo filter usando build.build_trigger_id, em que trigger-id é o ID do gatilho como uma string:

filter: build.build_trigger_id == trigger-id

Observação: o ID do gatilho não é o nome do gatilho. Para receber o ID do gatilho, execute o seguinte comando: gcloud beta builds triggers describe trigger-name, em que trigger-name é o nome do gatilho. O comando lista os campos associados ao seu gatilho, incluindo o ID.

Como filtrar por status

Para filtrar por status, especifique o status do build que você quer filtrar no campo filter usando build.status.

O exemplo a seguir mostra como filtrar eventos de build com um status SUCCESS usando o campo filter:

filter: build.status == Build.Status.SUCCESS

Também é possível filtrar builds com status variados. O exemplo a seguir mostra como filtrar eventos de build com um status SUCCESS, FAILURE ou TIMEOUT usando o campo filter:

filter: build.status in [Build.Status.SUCCESS, Build.Status.FAILURE, Build.Status.TIMEOUT]

Para ver valores de status adicionais pelos quais você pode filtrar, consulte Status na referência do recurso do Build.

Como filtrar por tag

Para filtrar por tag, especifique o valor da tag no campo filter usando build.tags, em que tag-name é o nome da tag:

filter: tag-name in build.tags

É possível filtrar com base no número de tags especificadas no evento de build usando size. No exemplo a seguir, o campo filter filtra eventos de build que têm exatamente duas tags especificadas, uma delas como v1:

filter: size(build.tags) == 2 && "v1" in build.tags

Como filtrar por imagens

Para filtrar por imagens, especifique o valor da imagem no campo filter usando build.images, em que image-name é o nome completo da imagem conforme listado no Artifact Registry, como us-east1-docker.pkg.dev/my-project/docker-repo/image-one:

filter: image-name in build.images

No exemplo a seguir, o filter filtra eventos de build com us-east1-docker.pkg.dev/my-project/docker-repo/image-one ou us-east1-docker.pkg.dev/my-project/docker-repo/image-two especificados como nomes de imagem:

filter: "us-east1-docker.pkg.dev/my-project/docker-repo/image-one" in build.images || "us-east1-docker.pkg.dev/my-project/docker-repo/image-one" in build.images

Como filtrar por tempo

É possível filtrar eventos de build com base no tempo de criação, horário de início ou horário de término de um build especificando uma das seguintes opções no campo filter: build.create_time, build.start_time ou build.finish_time.

No exemplo a seguir, o campo filter usa timestamp para filtrar eventos de build com um horário de solicitação para criar o build em 20 de julho de 2020, às 6h:

filter: build.create_time == timestamp("2020-07-20:T06:00:00Z")

Também é possível filtrar eventos de build por comparações de tempo. No exemplo a seguir, o campo filter usa timestamp para filtrar eventos de versão com um horário de início entre 6 de julho de 2020, às 6h, e 30 de julho de 2020, às 6h.

filter: timestamp("2020-07-20:T06:00:00Z") >= build.start_time && build.start_time <= timestamp("2020-07-30:T06:00:00Z")

Para saber mais sobre como os fusos horários são expressos em CEL, consulte a definição de linguagem para fusos horários.

Para filtrar por duração de um build, use duration para comparar carimbos de data/hora. No exemplo a seguir, o campo filter usa duration para filtrar eventos de build com um build executado por pelo menos cinco minutos:

filter: build.finish_time - build.start_time >= duration("5m")

Observação: os carimbos de data/hora estão no formato UTC "Zulu" RFC 3339, com resolução de nanossegundos e até nove dígitos fracionários.

Como filtrar por substituição

É possível filtrar por substituição especificando a variável de substituição no campo filter usando build.substitutions. No exemplo a seguir, o campo filter lista versões que contêm a variável de substituição substitution-variable e verifica se o substitution-variable corresponde ao substitution-value especificado:

filter: build.substitutions[substitution-variable] == substitution-value

Em que:

• substitution-variable é o nome da variável de substituição.
• substitution-value é o nome do valor de substituição.

Também é possível filtrar por padrão os valores das variáveis de substituição. No exemplo a seguir, o campo filter lista os builds que têm o nome da ramificação master e os builds que têm o nome de repositório github.com/user/my-example-repo. As variáveis de substituição padrão BRANCH_NAME e REPO_NAME são transmitidas como chaves para o build.substitutions:

filter: build.substitutions["BRANCH_NAME"] == "master" && build.substitutions["REPO_NAME"] == "github.com/user/my-example-repo"

Se você quiser filtrar strings usando expressões regulares, use a função integrada matches. No exemplo abaixo, o campo filter filtra as criações com status FALHA ou TEMPO LIMITE e também tem uma variável de substituição de versão TAG_NAME com um valor correspondente à expressão regular v{DIGIT}.{DIGIT}.{3 DIGITS})

filter: build.status in [Build.Status.FAILURE, Build.Status.TIMEOUT] && build.substitutions["TAG_NAME"].matches("^v\\d{1}\\.\\d{1}\\.\\d{3}$")

Para ver uma lista de valores de substituição padrão, consulte Como usar substituições padrão.

A seguir

• Saiba mais sobre os notificadores do Cloud Build.
• Saiba como se inscrever para criar notificações.
• Saiba como escrever um arquivo de configuração do build do Cloud Build.