Um endpoint de implantação de webhook solicita que sua instância do Looker implante mudanças de uma ramificação do Git, um SHA de commit ou um nome de tag e, em seguida, envie as mudanças para a versão de produção do seu projeto. Consulte a seção Implantação com webhooks para ver 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. Portanto, não é necessário configurar um webhook de implantação.
No entanto, você precisa usar um webhook de implantação para enviar mudanças à produção se alguma das seguintes circunstâncias se aplicar:
- Você envia atualizações para a ramificação de produção remota fora do IDE do Looker, o que é comum em fluxos de trabalho de desenvolvimento com ambientes de staging.
- 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 usado na 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 é necessário acionar um webhook de implantação depois de mesclar uma solicitação de envio para enviar essas mudanças ao 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 seu provedor do Git.
Se você for um administrador do Looker, poderá configurar o webhook de implantação para exigir um secret e permitir que apenas partes autorizadas o acionem. 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 dela.
Como adicionar um secret de implantação
O Looker é compatível com segredos da Web para os seguintes provedores Git: GitHub, Bitbucket Server e GitLab.
Para definir um secret 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. Você pode usar esse secret gerado automaticamente ou digitar seu próprio token secreto.
- Se você estiver usando o secret gerado automaticamente ou criando um 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 link nesse momento. Depois que você sair ou atualizar a página Configuração do projeto, vai perder o acesso ao secret de implantação do webhook e precisará mudar ou remover o secret para recuperar o acesso ao projeto.
- Clique em Salvar configuração do projeto.
O webhook de implantação do seu projeto agora exige esse secret. Para projetos que usam uma instância de teste do Looker, inclua a chave secreta de implantação do webhook no cabeçalho HTTP para fazer a implantação em produção. Para projetos com integração de solicitação de envio do Git, acesse a interface do seu provedor do Git para adicionar o secret ao webhook do seu 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ê adicionou um secret de webhook de implantação ao seu projeto LookML, acesse a interface do provedor do Git para adicionar o secret ao webhook do seu repositório. Por exemplo, veja como fazer isso usando o GitHub:
Navegue até as configurações do repositório do projeto no site do seu provedor Git.
DICA: se você configurou seu projeto para integração com o Git, use a opção Ver projeto no 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 Webhook Deploy Secret no Looker.
Clique em Atualizar webhook.
Agora, o secret do webhook é obrigatório para implantar mudanças na versão de produção do projeto. Se necessário, mude o secret ou remova o secret do seu projeto.
Como mudar um secret de implantação
Depois que um segredo de implantação de webhook for adicionado ao seu projeto, se você for um administrador do Looker, poderá mudar o segredo 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 Reset Secret. O Looker vai gerar automaticamente um novo token secreto. Você pode usar esse secret gerado automaticamente ou digitar seu próprio token secreto.
- Se você estiver usando o secret gerado automaticamente ou criando um 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. Não se esqueça de copiar 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 precisará 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, acesse a interface do seu provedor Git para atualizar o secret do webhook do repositório.
Como remover um secret de implantação
Depois que um secret de implantação de webhook for adicionado ao seu projeto, se você for um administrador do Looker, poderá remover o secret fazendo o seguinte:
- No seu projeto, selecione o ícone Configurações na barra de navegação.
- Role a tela até a seção Webhook Deploy Secret e clique em Remove Secret. Neste ponto, você pode cancelar a operação e manter o segredo de implantação 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 exige mais um secret para o webhook de implantação. Se o projeto estiver configurado com a integração solicitação de envio Git, acesse a interface do provedor Git para remover o secret do webhook do repositório. O Looker não vai mais verificar um secret no final do provedor Git. Portanto, não há problema se o webhook do repositório Git ainda tiver um secret configurado. Se você quiser remover o segredo do seu repositório Git, consulte Configurar o segredo para o webhook do repositório Git e saiba como editar o segredo na interface de um provedor Git.