Um endpoint de implantação de webhook solicita que a instância do Looker implante mudanças de uma ramificação do Git, de um SHA de confirmação ou de um nome de tag e, em seguida, envie as mudanças 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. Para a maioria dos projetos, o Looker lida com as integrações do Git e implanta atualizações na produção para que você não precise 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 Looker IDE, o que é comum em fluxos de trabalho de desenvolvimento com ambientes de preparo.
- Você quer usar um webhook para implantar com o modo de implantação avançado, que permite especificar a ramificação, o SHA do commit ou o nome da tag usada para a 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ê é um administrador do Looker, pode configurar o webhook de implantação para exigir um secret que só possa ser acionado por partes autorizadas. 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 secrets da Web dos seguintes provedores do Git: GitHub, Bitbucket Server e GitLab.
Para definir um segredo de implantação de webhook no seu 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 um token secreto automaticamente. É possível usar esse secret gerado automaticamente ou digitar seu próprio token secreto.
- Se você estiver usando o secret gerado automaticamente ou criando seu próprio, copie e cole o secret de implantação do webhook em um arquivo de texto para tê-lo em mãos caso seja necessário adicionar o secret ao webhook do repositório. Copie-o neste momento. Ao sair ou atualizar a página Configuração do projeto, você perde o acesso ao secret de implantação do webhook e precisa mudar ou remover o secret de implantação do webhook 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, acesse a interface do provedor do Git para adicionar o segredo 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. Por exemplo, veja como fazer isso usando o GitHub:
Acesse as configurações do repositório do projeto no site do provedor do Git.
DICA: se você configurou seu projeto para a integração do Git, pode 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 do webhook agora é necessário para implantar alterações na versão de produção do projeto. Se precisar, altere a chave secreta ou remova-a do seu projeto.
Como mudar um secret de implantação
Depois que um segredo de implantação de webhook for adicionado ao projeto, se você for administrador do Looker, poderá mudar o segredo seguindo estas etapas:
- No seu projeto, selecione o ícone Settings na barra de navegação.
- Role até a seção Webhook deploy secret e clique em Redefinir chave secreta. O Looker vai gerar automaticamente um novo token secreto. É possível usar esse secret gerado automaticamente ou digitar seu próprio novo token.
- Se você estiver usando o secret gerado automaticamente ou criando seu próprio, copie e cole o secret de implantação do webhook em um arquivo de texto para tê-lo em mãos caso seja necessário adicionar o secret ao webhook do repositório. Copie o endereço da área de transferência 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 voltar e mudar ou remover totalmente o secret de implantação do webhook.
- 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 secret de implantação do webhook do projeto, clique em Salvar configuração do projeto.
Seu projeto não exige mais um secret para o webhook de implantação. Se o projeto estiver configurado com a integração de solicitação de envio do Git, será possível acessar a interface do provedor do Git para remover o secret do webhook do repositório. O Looker não vai mais verificar um segredo no lado do provedor do Git. Portanto, não há problema se o webhook do repositório do Git ainda tiver um segredo configurado. Se você quiser remover o secret do repositório Git, consulte Como configurar o secret para o webhook do repositório Git para ver informações sobre como editar o secret na interface de um provedor Git.