Configurar o código secreto da implementação do webhook

Um ponto final de implementação de webhook pede à sua instância do Looker para implementar alterações a partir de um ramo do Git, um SHA de commit ou um nome de etiqueta e, em seguida, envia as alterações para a versão de produção do seu projeto. (Consulte a secção Implementação com webhooks para ver os formatos de webhook de implementação do Looker.) Para a maioria dos projetos, o Looker processa as integrações do Git e implementa atualizações na produção, pelo que não precisa de configurar um webhook de implementação.

No entanto, precisa de usar um webhook de implementação para enviar alterações para a produção se se aplicar alguma das seguintes circunstâncias:

  • Envia atualizações para o ramo de produção remoto fora do IDE do Looker, o que é comum em fluxos de trabalho de programação com ambientes de preparação.
  • Quer usar um webhook para a implementação com o modo de implementação avançado, que lhe permite especificar a ramificação, o SHA de confirmação ou o nome da etiqueta que é usado para a versão de produção do projeto do Looker.
  • Configurou o seu projeto do Looker com pedidos de envio do Git, o que significa que tem de acionar um webhook de implementação assim que unir um pedido de envio para enviar essas alterações para o seu ambiente de produção do Looker. A maioria dos serviços de alojamento Git tem formas de automatizar este processo se adicionar o webhook à interface do seu fornecedor Git.

Se for administrador do Looker, pode configurar o webhook de implementação para exigir um segredo, de modo que apenas as partes autorizadas o possam acionar. Os programadores do Looker que não sejam administradores podem ver a página Configuração do projeto, mas não podem alterar as opções aí apresentadas.

Adicionar um segredo de implementação

O Looker suporta segredos da Web para os seguintes fornecedores de Git: GitHub, Bitbucket Server e GitLab.

Para definir um segredo de implementação de webhook para o seu projeto:

  1. No modo de desenvolvimento, abra o seu projeto e selecione o ícone de definições na barra de navegação do IDE para abrir o painel de definições do projeto.
  2. Selecione Configuração no painel de definições do projeto.
  3. Desloque a página até à secção Código secreto da implementação do webhook e, de seguida, clique em Definir código secreto do webhook. O Looker gera automaticamente um token secreto. Pode usar este segredo gerado automaticamente ou introduzir o seu próprio token secreto.
  4. Quer esteja a usar o segredo gerado automaticamente ou a criar o seu próprio segredo, copie o segredo de implementação do webhook e cole-o num ficheiro de texto para o ter caso precise de adicionar o segredo ao webhook do seu repositório. Certifique-se de que o copia neste momento. Depois de sair ou atualizar a página Configuração do projeto, perde o acesso ao segredo de implementação do webhook e tem de alterar ou remover o segredo de implementação do webhook para recuperar o acesso ao seu projeto.
  5. Clique em Guardar configuração do projeto.

O webhook de implementação do seu projeto requer agora este segredo. Para projetos que usam uma instância de preparação do Looker, tem de incluir o segredo de implementação do webhook no cabeçalho HTTP para fazer a implementação em produção. Para projetos com a integração de pedidos de obtenção do Git, tem de aceder à interface do seu fornecedor do Git para adicionar o segredo ao webhook do seu repositório.

Configurar o segredo para o webhook do seu repositório Git

Para projetos com integração de pedidos de envio do Git, se tiver adicionado um segredo de webhook de implementação ao seu projeto do LookML, tem de aceder à interface do seu fornecedor do Git para adicionar o segredo ao webhook do seu repositório. Por exemplo, veja como o fazer através do GitHub:

  1. Navegue até às definições do repositório do seu projeto no Website do fornecedor de Git.

    SUGESTÃO: se configurou o seu projeto para integração do Git, pode usar a opção Ver projeto no Git no menu Git do projeto no Looker.

  2. Nas definições do repositório, clique em Webhooks.

  3. Encontre o webhook do seu projeto LookML e, de seguida, clique no respetivo botão Editar.

  4. No campo Segredo, cole o código secreto da implementação do webhook que copiou da secção Código secreto da implementação do webhook no Looker.

  5. Clique em Atualizar webhook.

Agora, o segredo do webhook é necessário para implementar alterações na versão de produção do seu projeto. Se precisar, pode alterar o segredo ou remover o segredo do seu projeto.

Alterar um segredo de implementação

Depois de adicionar um segredo de implementação de webhook ao seu projeto, se for um administrador do Looker, pode alterar o segredo da seguinte forma:

  1. No seu projeto, selecione o ícone Definições na barra de navegação.
  2. Desloque a página até à secção Webhook Deploy Secret e clique em Reset Secret. O Looker gera automaticamente um novo token secreto. Pode usar este segredo gerado automaticamente ou introduzir o seu próprio novo token secreto.
  3. Quer esteja a usar o segredo gerado automaticamente ou a criar o seu próprio segredo, copie o segredo de implementação do webhook e cole-o num ficheiro de texto para o ter caso precise de adicionar o segredo ao webhook do seu repositório. Certifique-se de que o copia da área de transferência neste momento. Depois de sair ou atualizar a página Configuração do projeto, perde o acesso ao segredo de implementação do webhook e tem de voltar atrás e alterá-lo ou removê-lo por completo.
  4. Clique em Guardar configuração do projeto.

Se o seu projeto estiver configurado com a integração de pedidos de envio do Git, também tem de aceder à interface do seu fornecedor do Git para atualizar o segredo do webhook do seu repositório.

Remover um código secreto de implementação

Depois de adicionar um segredo de implementação de webhook ao seu projeto, se for um administrador do Looker, pode remover o segredo da seguinte forma:

  1. No seu projeto, selecione o ícone Definições na barra de navegação.
  2. Desloque a página até à secção Segredo de implementação do webhook e clique em Remover segredo. Neste ponto, pode cancelar a operação e manter o segredo de implementação clicando em Não remover.
  3. Para remover permanentemente o segredo de implementação do webhook do seu projeto, clique em Guardar configuração do projeto.

O seu projeto já não requer um segredo para o webhook de implementação. Se o seu projeto estiver configurado com a integração de pedidos de envio do Git, pode aceder à interface do seu fornecedor do Git para remover o segredo do webhook do seu repositório. O próprio Looker vai deixar de verificar um segredo no lado do fornecedor do Git, pelo que não há problema se o webhook do seu repositório Git ainda tiver um segredo configurado. Se quiser remover o segredo do seu repositório Git, consulte o artigo Configurar o segredo para o webhook do seu repositório Git para obter informações sobre como editar o segredo na interface de um fornecedor de Git.