Um endpoint de implantação de webhook solicita que a instância do Looker implante mudanças de uma ramificação do Git, um SHA de confirmação ou um nome de tag e, em seguida, envie as mudanças para a versão de produção do 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, então você não precisa configurar um webhook de implantação.
No entanto, é necessário usar um webhook de implantação para enviar as 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 do Looker, o que é comum em fluxos de trabalho de desenvolvimento com ambientes de preparação.
- 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 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 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 de Git.
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 Project Configuration, mas não podem mudar as opções.
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 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 automaticamente um 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 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 nesse 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 seu projeto agora exige esse secret. Para projetos que usam uma instância de preparação do Looker, é necessário incluir a chave secreta 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 pull 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 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ê configurou o projeto para integração com o Git, use 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 Edit.
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 necessário, mude o secret ou remova-o do 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 Configurações 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. 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 da área de transferência. 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 fazer alterações 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 do Git para atualizar o secret do webhook para o repositório.
Como remover um secret de implantação
Depois que um segredo de implantação de webhook for adicionado ao seu projeto, se você for administrador do Looker, poderá remover o segredo seguindo estas etapas:
- 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, 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 precisa mais de um secret para o webhook de implantação. Se o projeto estiver configurado com a integração de solicitação de pull do Git, acesse 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 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.