Como configurar o secret de implantação do webhook

Um endpoint de implantação do webhook solicita que a instância do Looker implante alterações de uma ramificação do Git, um SHA de confirmação ou um nome de tag e, em seguida, envia as alterações para a versão de produção do seu projeto. Na maioria dos projetos, o Looker lida com as integrações do Git e implanta as atualizações na produção para que você não precise configurar um webhook de implantação.

No entanto, você precisará usar um webhook de implantação para enviar alterações à produção, se alguma das seguintes circunstâncias se aplicar:

  • Você envia atualizações para a ramificação de produção remota fora do ambiente de desenvolvimento integrado do Looker, o que é comum em fluxos de trabalho de desenvolvimento com ambientes de preparo.
  • Você pretende usar um webhook para implantar com o modo de implantação avançado, que permite especificar a ramificação, o SHA de confirmação ou o nome da tag usado na sua versão de produção do projeto do Looker.
  • Você configurou seu projeto do Looker com solicitações de envio do Git. Isso significa que é preciso acionar um webhook de implantação depois de mesclar uma solicitação de envio para enviar essas alterações ao seu ambiente de produção do Looker. A maioria dos serviços de hospedagem do Git tem maneiras de automatizar isso se você adicionar o webhook à interface do provedor do Git.

Se você for um administrador do Looker, poderá configurar o webhook de implantação para exigir um secret e acionar apenas as partes autorizadas.

Os desenvolvedores do Looker que não são administradores podem ver a página Configurações do projeto, mas não podem mudar as opções.

Como adicionar um secret de implantação

Para definir um secret de implantação do webhook no projeto, siga estas etapas:

  1. No Modo de desenvolvimento, abra seu projeto e selecione o ícone de configurações na barra de navegação do ambiente de desenvolvimento integrado para abrir o painel de configurações do projeto.
  2. Selecione Configuração no painel de configurações do projeto.
  3. Role para baixo até a seção Secret Deploy Secret e clique em Set Webhook Secret. O Looker gera automaticamente um token do secret. É possível usar o secret gerado automaticamente ou digitar seu próprio token secreto.
  4. Se você estiver usando o secret gerado automaticamente ou criando seu próprio secret, copie o secret de implantação do webhook e cole-o em um arquivo de texto para que você tenha isso se precisar adicionar o secret ao webhook do seu repositório. Copie-o agora. Ao sair ou atualizar a página Configurações do projeto, você perderá o acesso ao secret de implantação do webhook e precisará mudar ou remover o secret de implantação do webhook para recuperar o acesso ao projeto.
  5. Clique em Save Project Configuration.

O webhook de implantação do seu projeto agora requer esse secret. Para projetos que usam uma instância de preparo do Looker, é necessário incluir o secret de implantação do webhook no cabeçalho HTTP para implantar na produção. Para projetos com a integração de solicitação de envio do Git, você precisa acessar a interface do provedor do Git e adicionar o secret ao webhook do seu repositório.

Como configurar o secret do webhook do repositório Git

Para projetos com integração de solicitação de envio do Git, se você adicionou um secret de webhook de implantação ao seu projeto LookML, será necessário acessar a interface do provedor do Git para adicionar o secret ao webhook do seu repositório. Veja um exemplo de como fazer isso usando o GitHub:

  1. Navegue até as configurações de repositório do seu projeto no site do provedor do Git.

    DICA: se você configurou seu projeto para a integração do Git, use a opção Ver projeto no Git no menu do Git do seu projeto no Looker.

  2. Nas configurações do seu repositório, clique em Webhooks.

  3. Encontre o webhook do projeto LookML e clique no botão Edit.

  4. Na caixa de texto Secret, cole a chave secreta de implantação do webhook que você copiou na seção Chave de implantação do webhook no Looker.

  5. Clique em Atualizar webhook.

Agora, o secret do webhook é necessário para implantar as alterações na versão de produção do seu projeto. Se precisar, mude o secret ou remova o secret do seu projeto.

Como alterar um secret de implantação

Depois que uma chave secreta de implantação do webhook for adicionada ao seu projeto, se você for um administrador do Looker, altere o secret fazendo o seguinte:

  1. No seu projeto, selecione o ícone Configurações na barra de navegação.
  2. Role para baixo até a seção Secret Deploy Secret e clique em Reset Secret. O Looker gera automaticamente um novo token secreto. É possível usar o secret gerado automaticamente ou digitar seu novo token.
  3. Se você estiver usando o secret gerado automaticamente ou criando seu próprio secret, copie o secret de implantação do webhook e cole-o em um arquivo de texto para que você tenha isso se precisar adicionar o secret ao webhook do seu repositório. Copie o conteúdo da área de transferência. Ao sair ou atualizar a página Configurações do projeto, você perderá o acesso à chave secreta de implantação do webhook e terá que voltar e alterá-la ou removê-la totalmente.
  4. Clique em Save Project Configuration.

Se o projeto estiver configurado com a integração de solicitação de envio do Git, você também precisará acessar a interface do provedor do Git e # atualizar o secret do webhook para seu repositório.

Como remover um secret de implantação

Depois que uma chave secreta de implantação do webhook for adicionada ao seu projeto, se você for um administrador do Looker, remova o secret fazendo o seguinte:

  1. No seu projeto, selecione o ícone Configurações na barra de navegação.
  2. Role para baixo até a seção Secret Deploy Deploy Secret e clique em Remove Secret. Neste ponto, é possível cancelar a operação e manter a chave secreta de implantação clicando em Don't Remove.
  3. Para remover permanentemente o secret de implantação do webhook do projeto, clique em Salvar configuração do projeto.

Seu projeto não exige mais um secret do webhook de implantação. Caso seu projeto esteja configurado com a integração de solicitação de envio do Git, agora será possível acessar a interface do seu provedor do Git para remover a chave secreta do webhook do seu repositório. O próprio Looker não verificará mais um secret no provedor do Git. Por isso, não custa nada se o webhook do repositório Git ainda tiver um secret configurado. Se você quiser remover o secret do seu repositório Git, consulte Como configurar o secret para o repositório Git do seu repositório Git e veja informações sobre como editar o secret em uma interface do provedor Git.