Como configurar notificações HTTP

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 HTTP.

Antes de começar

  • Ative as APIs Cloud Build, Cloud Run, and Pub/Sub.

    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 push 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 HTTP

Para usar o notificador do HTTP e enviar solicitações POST para um determinado URL de destinatário:

  1. Grave um arquivo de configuração para configurar seu notificador do HTTP 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: HTTPNotifier
    metadata:
      name: example-http-notifier
    spec:
      notification:
        filter: build.status == Build.Status.SUCCESS
        delivery:
          # The `http(s)://` protocol prefix is required.
          url: url
    

    Onde:

    • url é a variável de configuração usada neste exemplo para especificar o URL da solicitação.
    • url é o URL que você quer especificar como seu servidor destinatário.

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

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

  2. 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 HTTP, consulte http.yaml.example.
  3. Implante o notificador no Cloud Run.

     gcloud run deploy service-name \
       --image=us-east1-docker.pkg.dev/gcb-release/cloud-build-notifiers/http:latest \
       --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 seu notificador HTTP, 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.

  4. 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.
  5. 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.

  6. 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.
  7. Crie o tópico cloud-builds para receber mensagens de atualização da build para seu notificador:

    gcloud pubsub topics create cloud-builds
    
  8. 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. Na próxima vez que você invocar um build, o servidor HTTP de destino no URL especificado receberá payloads JSON que correspondem ao recurso Build caso a versão corresponder ao filtro que você configurou.

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

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 HTTP. Para automatizar a configuração de notificação do HTTP, conclua as etapas a seguir:

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

  2. Execute o seguinte comando na raiz do repositório, em que config-path é o caminho para o arquivo de configuração dos notificadores:

     ./setup.sh http config-path
    

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

** NOTIFIER SETUP COMPLETE **

Seu notificador de HTTP está 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