Automatize compilações em resposta a eventos de webhook

O Cloud Build permite-lhe definir acionadores de webhook, que podem autenticar e aceitar eventos de webhook recebidos. Estes eventos, enviados para um URL personalizado, permitem-lhe associar diretamente sistemas externos e sistemas de gestão de código fonte externos, como Bitbucket.com, Bitbucket Server ou GitLab, ao Cloud Build através de eventos de webhook.

Com os acionadores de webhook, pode definir um ficheiro de configuração de compilação inline em vez de especificar uma origem quando cria o acionador. A configuração de compilação inline permite-lhe ter controlo sobre as operações git e definir o resto da compilação.

Esta página descreve como pode criar acionadores de webhook para automatizar compilações em resposta a eventos de webhook.

Antes de começar

  • Enable the Cloud Build and Secret Manager APIs.

    Enable the APIs

  • Para usar os comandos gcloud nesta página, instale a CLI do Google Cloud.

Criar acionadores de webhook

Consola

Para criar um acionador de webhook através da Google Cloud consola:

  1. Abra a página Acionadores:

    Abra a página Acionadores de compilação

  2. Selecione o projeto na parte superior da página e clique em Abrir.

  3. Clique em Criar acionador.

  4. Introduza as seguintes definições do acionador:

    • Nome: um nome para o acionador.

    • Região: selecione a região para o seu acionador.

    • Se o ficheiro de configuração de compilação associado ao acionador especificar um pool privado, o Cloud Build usa o pool privado para executar a compilação. Neste caso, a região especificada no acionador tem de corresponder à região onde criou o seu conjunto privado.

    • Se o ficheiro de configuração de compilação associado ao acionador não especificar um conjunto privado, o Cloud Build usa o conjunto predefinido para executar a compilação na mesma região que o acionador.
      • Descrição (opcional): uma descrição do acionador.
      • Evento: selecione Evento de webhook para configurar o acionador de forma a iniciar compilações em resposta a eventos de webhook recebidos.

      • URL do webhook: use o URL do webhook para autenticar eventos de webhook recebidos.

        • Segredo: precisa de um segredo para autenticar eventos de webhook recebidos. Pode criar um novo segredo ou usar um segredo existente. Este segredo é separado do segredo associado à sua chave SSH.

          Para criar um novo segredo:

          1. Selecione Usar um novo segredo (gerado pelo Cloud Build).

          2. Clique em Criar segredo.

            É apresentada a caixa de pop-up Crie um segredo de webhook.

          3. No campo Nome secreto, introduza um nome para o seu segredo.

          4. Clique em Criar segredo para guardar o seu segredo, que é criado e armazenado automaticamente para si no Secret Manager.

            Para usar um segredo existente:

          5. Selecione Usar um segredo existente ou criar o seu próprio.

          6. No campo Secret, selecione o nome do secret que quer usar no menu pendente ou siga as instruções para adicionar um secret por ID do recurso.

          7. No campo Versão secreta, selecione a versão secreta no menu pendente.

            Se usar um segredo existente, pode ter de conceder manualmente a função Secret Manager Secret Accessor à sua conta de serviço do Cloud Build, service-${PROJECT_NUMBER}@gcp-sa-cloudbuild.iam.gserviceaccount.com. Para saber mais, consulte o artigo Conceder a função de gestor de segredos à sua conta de serviço.

          Depois de criar ou selecionar o seu segredo, é apresentada uma pré-visualização do URL do webhook. O URL vai conter uma chave da API gerada pelo Cloud Build e o seu segredo. Se o Cloud Build não conseguir obter a sua chave da API, pode adicioná-la manualmente ao URL ou saber como obter uma chave da API se ainda não tiver uma.

          Pode usar o URL para invocar um evento de webhook fazendo um pedido HTTP através do método POST.

          Use o seguinte comando para invocar um evento de webhook:

          curl -X POST -H "Content-type: application/json" "https://cloudbuild.googleapis.com/v1/projects/${PROJECT_ID}/locations/${REGION}/triggers/${TRIGGER_NAME}:webhook?key=${API_KEY}&secret=${SECRET_VALUE}&trigger=${TRIGGER_NAME}&projectId=${PROJECT_ID}" -d "{}"

          Após concluir estes passos, a função Secret Manager Secret Accessor é concedida automaticamente ao seu agente do serviço Cloud Build, service-${PROJECT_NUMBER}@gcp-sa-cloudbuild.iam.gserviceaccount.com. Se não vir esta função adicionada automaticamente ao seu agente do serviço, conclua os seguintes passos descritos no artigo Conceder a função Secret Manager à sua conta de serviço.

      • Origem (opcional): selecione a origem a criar quando o acionador de webhook for executado. Se estiver a especificar uma configuração de compilação inline, não tem de especificar a seguinte origem. Pode especificar 1st generation (1.ª geração) ou 2nd generation (2.ª geração) como origem. Para saber mais, consulte o artigo Repositórios do Cloud Build.

        • Repositório: na lista de repositórios disponíveis, selecione o repositório desejado.

        • Branch ou Tag: especifique uma expressão regular com o valor da ramificação ou da etiqueta a corresponder. Para obter informações sobre a sintaxe de expressões regulares aceitável, consulte a sintaxe RE2.

        • Controlo de comentários: se selecionou Pedido de envio (apenas app GitHub) como Evento, escolha uma das seguintes opções para controlar se uma compilação é executada automaticamente pelo acionador:

          • Obrigatório, exceto para proprietários e colaboradores: quando um proprietário ou um colaborador do repositório cria ou atualiza um pedido de envio, as compilações são executadas automaticamente pelo acionador. Se um colaborador externo iniciar a ação, as compilações só são executadas depois de um proprietário ou um colaborador comentar /gcbrun no pedido de envio.

          • Obrigatório: quando um pedido de obtenção é criado ou atualizado por qualquer colaborador, as compilações só são executadas depois de um proprietário ou um colaborador comentar /gcbrun no pedido de obtenção. As compilações são executadas sempre que é feita uma alteração a um pedido de obtenção.

          • Não obrigatório: quando um pedido de obtenção é criado ou atualizado por qualquer colaborador, as compilações são executadas automaticamente por acionadores.

      • Configuração: selecione o ficheiro de configuração de compilação localizado no seu repositório remoto ou crie um ficheiro de configuração de compilação inline para usar na sua compilação. Se não especificou um repositório de origem, tem de selecionar um ficheiro de configuração de compilação inline como opção de configuração.

        • Tipo: selecione o tipo de configuração a usar para a sua compilação.
          • Ficheiro de configuração do Cloud Build (YAML ou JSON): use um ficheiro de configuração de compilação para a sua configuração.
          • Dockerfile: use um Dockerfile para a sua configuração.
          • Buildpacks: use buildpacks para a sua configuração.

        • Localização: especifique a localização da configuração.

          • Repositório: se o ficheiro de configuração estiver localizado no seu repositório remoto, indique a localização do ficheiro de configuração de compilação, do Dockerfilediretório ou do diretório de pacotes de compilação. Se o seu tipo de configuração de compilação for Dockerfile ou um buildpack, tem de fornecer um nome para a imagem resultante e, opcionalmente, um limite de tempo para a compilação. Quando tiver indicado o nome da imagem Dockerfile ou do buildpack, é apresentada uma pré-visualização do comando docker build ou pack que a sua compilação vai executar.
          • Variáveis de ambiente do buildpack (opcional): se selecionou buildpacks como o tipo de configuração, clique em Adicionar variável de ambiente do pacote para especificar as variáveis de ambiente e os valores do buildpack. Para saber mais acerca das variáveis de ambiente do buildpack, consulte o artigo Variáveis de ambiente.

          • Inline: se selecionou Ficheiro de configuração do Cloud Build (YAML ou JSON) como opção de configuração, pode especificar a configuração de compilação inline. Clique em Abrir editor para escrever o ficheiro de configuração de compilação na Google Cloud consola com a sintaxe YAML ou JSON. Clique em Concluído para guardar a configuração de compilação.

          No exemplo seguinte, o ficheiro de configuração de compilação inline regista o eco de "hello world":

           steps:
 - name: 'ubuntu'
   args: ['echo', 'hello world']

      • Substituições (opcional): se selecionou o ficheiro de configuração de compilação como a opção de configuração de compilação ou criou um ficheiro de configuração de compilação inline, pode optar por definir variáveis de substituição específicas do acionador através deste campo. Também pode obter dados através de associações de carga útil quando define valores de variáveis de substituição.

      • Filtros (opcional): pode criar uma regra num acionador que determine se o acionador vai executar uma compilação com base nas variáveis de substituição.

      1. Clique em Criar para criar o acionador de compilação.

    gcloud

    (Opcional) Obter uma chave da API

    Para autenticar o seu evento de webhook recebido, precisa de uma chave da API.

    Para obter uma chave da API:

    1. Abra a página Credenciais na Google Cloud consola:

      Abra a página Credenciais

    2. Clique em Criar credenciais.

    3. Clique em Chave da API.

      É apresentada uma caixa de diálogo com a chave da API criada. Tome nota da sua chave da API.

    4. Se quiser restringir a sua chave para aplicações de produtos, clique em Restringir chave para concluir passos adicionais para proteger a sua chave. Caso contrário, clique em Fechar.

      Para saber como restringir a sua chave, consulte o artigo Aplicar restrições de chaves da API.

    (Opcional) Conceder a função Secret Manager à sua conta de serviço

    O Cloud Build concede automaticamente a função Secret Manager Secret Accessor às contas de serviço que requerem a função durante a configuração de segredos. Se não vir esta função concedida automaticamente à conta de serviço necessária, conclua os seguintes passos para adicionar manualmente a função de modo que a sua conta de serviço tenha acesso ao seu segredo:

    1. Abra a página IAM na Google Cloud consola:

      Abra a página IAM

    2. Opcional: para ver as contas fornecidas pela Google, selecione a caixa de verificação Incluir concessões de funções fornecidas pela Google.

    3. Tome nota da conta de serviço de compilação à qual quer conceder a função.

    4. Abra a página Secret Manager na Google Cloud consola:

      Abra a página Secret Manager

    5. Clique no nome do segredo.

      É apresentada a página Detalhes do Secret.

      1. Clique no separador Autorizações.

      2. Clique em Conceder acesso.

        É apresentado o painel Conceder acesso.

      3. Na secção Adicionar membros, adicione o email associado à conta de serviço de compilação.

      4. Na secção Atribuir funções, selecione Secret Manager > Secret Manager Secret Accessor.

      5. Clique em Guardar.

    O que se segue?