Um endpoint de implantação de webhook solicita que sua instância do Looker implante alterações de uma ramificação do Git, um SHA de confirmação ou um nome de tag e envie as alterações para a versão de produção do projeto. Consulte a seção Como implantar com webhooks para conhecer 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. Assim, você não precisa configurar um webhook de implantação.
No entanto, você precisa usar um webhook de implantação para enviar alterações para produção se alguma das circunstâncias a seguir 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ê quer 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 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 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 Git tem maneiras de automatizar esse processo se você adicionar o webhook à interface do provedor Git.
Se você é um administrador do Looker, configure o webhook de implantação para exigir um secret para que apenas partes autorizadas possam acioná-lo. Os desenvolvedores do Looker que não são administradores podem visualizar a página Configurações do projeto, mas não podem mudar as opções.
Como adicionar um secret de implantação
O Looker oferece suporte a secrets da Web para os seguintes provedores Git: GitHub, Bitbucket Server e GitLab.
Para definir um secret de implantação do webhook no seu projeto:
- Em 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 gera um token secreto automaticamente. Use esse secret gerado automaticamente ou digite seu próprio token secreto.
- Se você estiver usando o secret gerado automaticamente ou criando seu próprio secret, copie o secret de implantação do webhook e cole em um arquivo de texto para tê-lo em mãos se precisar adicionar o secret ao webhook do repositório. Copie-o neste momento. Depois de sair ou atualizar a página Configurações do projeto, você vai perder o acesso ao secret de implantação do webhook e terá que mudar ou remover o secret para recuperar o acesso ao projeto.
- Clique em Save Project Configuration.
O webhook de implantação do projeto agora exige 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 integração de solicitação de envio Git, você precisa acessar a interface do seu provedor Git para adicionar o secret ao webhook do seu repositório.
Como configurar o secret para o webhook do repositório Git
Em projetos com integração de solicitação de envio do Git, se você tiver adicionado um secret de webhook de implantação ao projeto LookML, precisará acessar a interface do provedor Git para adicionar o secret ao webhook do repositório. Confira um exemplo de como fazer isso usando o GitHub:
Navegue até as configurações do repositório do seu 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 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.
O secret do webhook agora é necessário para implantar alterações na versão de produção do seu projeto. Se precisar, mude ou remova a senha do seu projeto.
Como alterar um secret de implantação
Depois que um secret de implantação do webhook for adicionado ao projeto, se você for um administrador do Looker, mude 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 Reset Secret. O Looker vai gerar um novo token secreto automaticamente. Use esse secret gerado automaticamente ou digite seu próprio token novo.
- Se você estiver usando o secret gerado automaticamente ou criando seu próprio secret, copie o secret de implantação do webhook e cole em um arquivo de texto para tê-lo em mãos se precisar adicionar o secret ao webhook do repositório. Copie-o da área de transferência neste momento. Depois de sair ou atualizar a página Project Settings, você vai perder o acesso ao secret de implantação do webhook e terá que voltar e alterar ou remover o secret totalmente.
- Clique em Save Project Configuration.
Se o projeto estiver configurado com a integração de solicitação de envio Git, você também vai precisar acessar a interface do 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 do webhook for adicionado ao projeto, se você for um administrador do Looker, poderá 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. Neste momento, é possível cancelar a operação e manter o secret de implantação clicando em Don't Remove.
- Para remover permanentemente o secret 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 de solicitação de envio Git, acesse a interface do provedor Git para remover o secret do webhook do seu repositório. O Looker em si não vai mais verificar se há um secret no provedor Git, então não há problema se o webhook do repositório Git ainda tiver um secret configurado. Se você quiser remover o secret do repositório Git, consulte Como configurar o secret para o webhook do seu repositório Git (em inglês) para saber como editar o secret na interface de um provedor Git.