Um endpoint de implantação de webhook solicita que sua instância do Looker implante alterações de uma ramificação do Git, de um commit de SHA ou de um nome de tag e as envie para a versão de produção do projeto. Consulte a seção Como implantar com webhooks para saber mais sobre os formatos de webhook de implantação do Looker. Na maioria dos projetos, o Looker processa as integrações do Git e implanta atualizações na produção, então você não precisa configurar um webhook de implantação.
No entanto, é necessário usar um webhook de implantação para enviar mudanças à produção se uma das seguintes circunstâncias se aplicar:
- Você envia atualizações para a ramificação de produção remota fora do ambiente de desenvolvimento integrado (IDE) do Looker, o que é comum em fluxos de trabalho de desenvolvimento com ambientes de teste.
- Você quer usar um webhook para implantar com o modo de implantação avançado, que permite especificar a ramificação, o SHA de commit ou o nome da tag que é usado para sua versão de produção do projeto do Looker.
- Você configurou seu projeto do Looker com solicitações de envio do Git, o que significa que você precisa acionar um webhook de implantação depois de mesclar uma solicitação de envio para enviar essas alterações ao ambiente de produção do Looker. A maioria dos serviços de hospedagem do Git tem maneiras de automatizar esse processo se você adicionar o webhook à interface do provedor do Git (em inglês).
Se você for um administrador do Looker, poderá configurar o webhook de implantação para exigir um segredo, de modo que apenas partes autorizadas possam acionar. Os desenvolvedores do Looker que não são administradores podem acessar a página Configuração do projeto, mas não podem mudar as opções nela.
Como adicionar um secret de implantação
O Looker oferece suporte a segredos da Web para os seguintes provedores do Git: GitHub, Bitbucket Server e GitLab.
Para definir um secret de implantação do webhook para o projeto:
- 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.
- Selecione Configuração no painel de configurações do projeto.
- Role até a seção Webhook deploy secret e clique em Set Webhook Secret. O Looker vai gerar automaticamente um token secreto. É possível usar esse secret gerado automaticamente ou digitar seu próprio token secreto.
- Se você estiver usando o secret gerado automaticamente ou criando o próprio, copie o secret de implantação do webhook e cole em um arquivo de texto para ter acesso a ele caso precise adicionar o secret ao webhook do seu repositório. Copie-o neste momento. Depois de sair ou atualizar a página Configuração do projeto, você vai perder o acesso ao secret de implantação do webhook e terá que alterar ou remover esse secret para recuperar o acesso ao projeto.
- Clique em Salvar configuração do projeto.
O webhook de implantação do projeto agora exige esse secret. Para projetos que usam uma instância de preparo do Looker, inclua o secret de implantação do webhook no cabeçalho HTTP para implantar na produção. Para projetos com integração de solicitação de envio do Git, é preciso acessar a interface do provedor do Git para adicionar o secret ao webhook do repositório.
Como configurar o secret para o webhook do repositório Git
Para projetos com integração de solicitação de envio do Git, se você tiver adicionado um secret do webhook de implantação ao projeto do LookML, será necessário acessar a interface do provedor do Git para adicionar o secret ao webhook do repositório. Confira como fazer isso usando o GitHub:
Acesse as configurações do repositório do projeto no site do provedor do Git.
DICA: se você tiver configurado seu projeto para a integração com o Git, poderá usar a opção View Project on Git no menu do Git do projeto no Looker.
Nas configurações do repositório, clique em Webhooks.
Encontre o webhook do seu projeto do LookML e clique no botão Editar.
No campo Secret, cole o secret de implantação do webhook que você copiou da seção Secret de implantação do webhook no Looker.
Clique em Atualizar webhook.
O secret de webhook agora é necessário para implantar mudanças na versão de produção do seu projeto. Se precisar, altere a chave secreta ou remova-a do seu projeto.
Como mudar um secret de implantação
Depois que um secret de implantação do webhook for adicionado ao seu projeto, os administradores do Looker poderão alterar o secret fazendo o seguinte:
- No seu projeto, selecione o ícone Configurações na barra de navegação.
- Role até a seção Webhook Deploy Secret e clique em Redefinir secret. O Looker vai gerar automaticamente um novo token secreto. Você pode usar o secret gerado automaticamente ou digitar seu próprio token secreto.
- Se você estiver usando o secret gerado automaticamente ou criando o próprio, copie o secret de implantação do webhook e cole em um arquivo de texto para ter acesso a ele caso precise adicionar o secret ao webhook do seu repositório. Copie o endereço da área de transferência neste momento. Ao sair ou atualizar a página Configuração do projeto, você perde o acesso ao segredo de implantação do webhook e precisa voltar e mudar ou remover completamente.
- Clique em Salvar configuração do projeto.
Se o projeto estiver configurado com a integração de solicitação de envio do Git, também será necessário acessar a interface do provedor Git para atualizar o secret do webhook para o repositório.
Como remover um secret de implantação
Depois que um secret de implantação do webhook for adicionado ao seu projeto, os administradores do Looker poderão remover o secret da seguinte forma:
- No seu projeto, selecione o ícone Configurações na barra de navegação.
- Role até a seção Webhook Deploy Secret e clique em Remove Secret. Nesse ponto, é possível cancelar a operação e manter a implantação em segredo clicando em Não remover.
- Para remover permanentemente o segredo de implantação do webhook do seu projeto, clique em Salvar configuração do projeto.
Seu projeto não precisa mais de um secret para o webhook de implantação. Se o projeto estiver configurado com a integração de solicitação de envio do Git, acesse a interface do provedor do Git para remover o secret do webhook do repositório. O Looker em si não verificará mais se há um secret no provedor Git. Portanto, não será prejudicial se o webhook do repositório Git ainda tiver um secret configurado. Se você quiser remover o segredo do repositório do Git, consulte Como configurar o segredo para o webhook do repositório do Git para saber como editar o segredo na interface de um provedor do Git.