Como configurar notificações do Slack

O Cloud Build pode notificar você sobre atualizações no status do build enviando notificações para os canais desejados, como o Slack ou o servidor SMTP. Esta página explica como configurar notificações usando o Notificador do Slack.

Antes de começar

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

    Ative as APIs

Notificadores do Cloud Build

O Cloud Build envia todas as atualizações do status do build com os metadados do build para o Pub/Sub no tópico cloud-builds. Os notificadores do Cloud Build podem ser configurados para ouvir esse tópico, filtrar as mensagens recebidas e enviar mensagens para o serviço.

Os notificadores do Cloud Build são imagens do Docker que podem ser executadas como contêineres no Cloud Run. Quando solicitados por um aplicativo de assinante, os notificadores do Cloud Build usam assinaturas de pull para enviar mensagens ao serviço configurado. Na configuração, todos os notificadores usam uma especificação comum do YAML armazenada no Cloud Storage.

O Cloud Build fornece e mantém imagens de notificador implantáveis no repositório cloud-build-notifiers. A tabela a seguir lista os notificadores disponíveis:

Notificador Descrição
slack usa um webhook do Slack para postar mensagens em um canal do Slack
smtp envia e-mails por um servidor SMTP
http envia um payload JSON para outro endpoint HTTP

Como configurar notificações do Slack

Para configurar as notificações do Slack usando o notificador do Slack:

  1. Crie um aplicativo Slack para o espaço de trabalho do Slack que você quiser.

  2. Ative webhooks de entrada para postar mensagens no Slack pelo Cloud Build.

  3. Navegue até seu aplicativo do Slack para localizar o URL do webhook de entrada. O URL será semelhante ao seguinte:

    http://hooks.slack.com/services/...
    
  4. Armazene o URL do webhook de entrada no Gerenciador de secrets:

    1. Abra a página "Gerenciador de secrets" no Console do Google Cloud:

      Abrir a página "Gerenciador de secrets"

    2. Clique em Criar secret.

    3. Insira um nome para o secret.

    4. Em Valor do secret, adicione o URL de webhook de entrada do aplicativo Slack.

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

  5. Conceda à sua conta de serviço do Cloud Run acesso ao secret:

    1. Acesse a página IAM do Console do 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:

      project-number-compute@developer.gserviceaccount.com
      

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

    3. Abra a página "Gerenciador de secrets" no Console do Google Cloud:

      Abrir a página "Gerenciador de secrets"

    4. Clique no nome do secret que contém o secret do seu aplicativo Slack.

    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 como papel a permissão Acessador de secrets do Gerenciador de secrets.

    8. Clique em Save.

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

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

    apiVersion: cloud-build-notifiers/v1
    kind: SlackNotifier
    metadata:
      name: example-slack-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
    

    Onde:

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

    Para ver o exemplo, consulte o arquivo de configuração do notificado para o notificador do Slack.

    Para ver outros campos que podem ser filtrados, consulte o recurso Build. Para ver mais exemplos de filtros, consulte Como filtrar builds em notificações.

  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.

      gsutil mb gs://bucket-name/
      
    2. Faça o upload do arquivo de configuração do notificador para o bucket:

      gsutil 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. Para ver um exemplo de arquivo de configuração para o notificador do Slack, consulte slack.yaml.example.
  8. Implante o notificador no Cloud Run.

     gcloud run deploy service-name \
       --image=us-east1-docker.pkg.dev/gcb-release/cloud-build-notifiers/slack: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 Slack, gs://bucket-name/config-file-name.
    • project-id é o ID do projeto do 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.

  9. Conceda permissões do Pub/Sub para criar tokens de autenticação no seu projeto:

     gcloud projects add-iam-policy-binding project-id \
       --member=serviceAccount:service-project-number@gcp-sa-pubsub.iam.gserviceaccount.com \
       --role=roles/iam.serviceAccountTokenCreator
    

    Onde:

    • project-id é o ID do projeto do Cloud.
    • project-number é o número do projeto do Cloud.
  10. Crie uma conta de serviço para representar sua identidade de assinatura do Pub/Sub:

    gcloud iam service-accounts create cloud-run-pubsub-invoker \
      --display-name "Cloud Run Pub/Sub Invoker"
    

    Você pode usar cloud-run-pubsub-invoker ou um nome exclusivo no seu projeto do Google Cloud.

  11. Conceda à conta de serviço cloud-run-pubsub-invoker a permissão Invoker do Cloud Run:

    gcloud run services add-iam-policy-binding service-name \
       --member=serviceAccount:cloud-run-pubsub-invoker@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 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
    
  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=cloud-run-pubsub-invoker@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 Cloud.

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

Como automatizar a configuração de notificação para o Slack

O repositório cloud-build-notifiers contém um script de configuração, setup.sh, que automatiza a configuração descrita em Como configurar notificações do Slack. Antes de executar o script, verifique se você criou um secret para o URL de webhook de entrada usando o Gerenciador de secrets, conforme descrito nas etapas acima. Para automatizar a configuração de notificação do Slack, conclua as etapas a seguir:

  1. Clone o repositório do cloud-build-notifiers.

  2. Execute o seguinte comando na raiz do repositório:

     ./setup.sh slack config-path secret-name
    

    Onde:

    • config-path é o caminho para o arquivo de configuração dos notificadores.
    • secret-name é o nome do secret armazenado no Gerenciador de secrets.

Depois de executar o script, você verá a seguinte mensagem:

** NOTIFIER SETUP COMPLETE **

O notificador do Slack foi configurado. Veja o script completo no repositório do cloud-build-notifier ou execute ./setup.sh --help para ver instruções de uso associadas ao script.

A seguir