Modo de implantação avançado

Com a integração padrão do Looker Git, os desenvolvedores do Looker confirmam as mudanças na ramificação de desenvolvimento e, em seguida, as mesclam na ramificação de produção. Em seguida, ao implantar no ambiente do Looker, ele usa o commit mais recente na ramificação de produção. Consulte a página de documentação Usar o controle de versão e a implantação para conferir o fluxo de trabalho padrão do Git e outras opções para implementações avançadas do Git.

Para implementações avançadas do Git em que você não quer que a versão mais recente da ramificação de produção seja usada para o ambiente do Looker, um administrador do Looker pode ativar o modo de implantação avançado. Quando ativado, o modo de implantação avançado permite que um desenvolvedor com permissão deploy especifique uma tag ou um SHA de commit diferente para implantar no ambiente de produção do Looker, em vez de usar o commit mais recente na ramificação de produção. Se você quiser implantar um commit de uma ramificação diferente, use o modo de implantação avançada webhook ou endpoint da API.

O modo de implantação avançado ajuda a consolidar repositórios em fluxos de trabalho de desenvolvedores com vários ambientes, em que cada ambiente aponta para uma versão diferente de uma base de código. Ele também dá a um ou vários desenvolvedores ou administradores um maior controle sobre as mudanças implantadas na produção.

Quando o modo de implantação avançado está ativado, o Looker não solicita que os desenvolvedores implantem as mudanças na produção. Em vez disso, o Looker solicita que os desenvolvedores mesclem as mudanças na ramificação de produção. A partir daí, as mudanças só podem ser implantadas das seguintes maneiras:

• Como usar o Deployment Manager
• Acionar um webhook
• Usar um endpoint da API

Observação: para projetos com o modo de implantação avançado ativado, se o projeto nunca foi implantado na produção, a implantação inicial precisa ser feita com o gerenciador de implantação. Não é possível usar a API ou o webhook para a implantação inicial de um projeto com o modo de implantação avançado ativado. Depois da implantação inicial na produção (mesmo que ela tenha sido feita sem o modo de implantação avançado), é possível usar o webhook ou a API para implantar mudanças subsequentes na produção com o modo de implantação avançado.

Como ativar o modo de implantação avançado

Para ativar o modo de implantação avançado:

1. No ambiente de desenvolvimento integrado do Looker, acesse a página Project Configuration selecionando o ícone Settings no menu de ícones e, em seguida, a guia Configuration.
2. Na página Project Configuration, marque a caixa de seleção ao lado de Enable Advanced Deploy Mode na seção Deployment.
3. Selecione o botão Save Project Configuration para salvar a mudança.

Controle de versão com o modo de implantação avançado

Quando o modo de implantação avançado está ativado, o implantar na produção do Looker não é mais uma opção para os desenvolvedores. Em vez disso, quando o desenvolvedor faz um commit, o botão do Git pede que ele mescle as mudanças na ramificação principal, em vez de implantar na produção.

As mudanças são implantadas na produção usando um webhook, a API ou o gerenciador de implantação.

Deployment Manager

Para projetos com o modo de implantação avançado ativado, os desenvolvedores do Looker que têm a permissão deploy podem usar o gerenciador de implantação para implantar um commit ou uma tag no ambiente de produção do Looker.

Para acessar o gerenciador de implantação, selecione o ícone Deploy no menu de ícones.

O Deployment Manager mostra todas as confirmações e tags que foram implantadas anteriormente usando o modo de implantação avançado.

Observação: conforme descrito na seção Implantação de um commit do Deployment Manager nesta página, é possível implantar um commit com ou sem uma tag. Se você implantar um commit com uma tag, o Deployment Manager vai mostrar o SHA da tag, que é diferente do SHA do commit. Você pode usar o histórico de confirmação do projeto do Looker para conferir o SHA de confirmação associado a uma tag. Caso contrário, se você implantar um commit sem uma tag, o gerenciador de implantação vai mostrar o SHA do commit, que é o mesmo que você encontra na interface do seu provedor do Git ou no histórico de commits do seu projeto do Looker.

Se você ainda não usou o modo de implantação avançado para implantar um commit, clique no botão Select Commit para conferir o histórico de commits com os commits que os desenvolvedores do Looker mesclaram na ramificação de produção.

Para projetos que usaram o modo de implantação avançado para implantar um commit, o histórico de commits também vai mostrar as tags associadas a um commit, se houver, e indicar qual commit é a versão atual usada para produção.

Se a ramificação de produção tiver confirmações mais recentes do que a implantada, o gerenciador de implantação vai mostrar essas informações e a confirmação mais recente que os desenvolvedores do Looker mesclaram à ramificação de produção.

Como implantar um commit do Deployment Manager

Há várias maneiras de implantar um commit no Gerenciador de implantação:

1. Para implantar um commit que ainda não foi implantado, clique no botão Select Commit para selecionar entre todos os commits que foram mesclados à ramificação de produção remota. Se você quiser implantar um commit de uma ramificação diferente, use o modo de implantação avançada webhook ou endpoint da API.
2. Para implantar a confirmação de mesclagem mais recente na ramificação de produção remota, clique no botão Deploy Latest.
3. Para implantar um commit ou uma tag que já foi implantada, clique no menu de Opções de três pontos do gerenciador de implantação e em Implantar na produção.

Se você escolher uma confirmação que não foi implantada anteriormente, o gerenciador de implantação vai mostrar o menu Deploy Commit. Para implantar um commit no menu Deploy Commit, siga estas etapas:

1. Para implantar o commit sem atribuir uma tag, selecione Deploy without tagging e Deploy to Environment. Caso contrário, mantenha a opção Marcar e implantar selecionada.

2. Especifique uma tag para a confirmação. Uma tag do Git marca a importância da confirmação no histórico do repositório, como um número de versão ou nome da versão. Observe o seguinte sobre as tags do Git:

   • As tags do Git precisam ser exclusivas no repositório. Não é possível usar a mesma tag para duas confirmações diferentes no repositório.
   • As tags do Git não podem conter espaços ou determinados caracteres especiais. Consulte a documentação da referência do Git para saber mais sobre as regras de nomenclatura de referências no Git.

3. Opcionalmente, você pode adicionar uma descrição para a tag para fornecer mais detalhes sobre a confirmação.

4. Selecione Deploy to Environment para implantar o commit na versão de produção da instância do Looker.

Depois que você implantar um commit, o Deployment Manager vai marcá-lo como a versão atual no ambiente de produção do Looker.

Implantação com webhooks

Para projetos com o modo de implantação avançado, use o webhook de implantação para implantar as mudanças na produção.

Observação: quando o modo de implantação avançado está ativado para um novo projeto, é necessário usar o Deployment Manager para a implantação inicial do projeto na produção. Depois que o projeto for implantado na produção (mesmo que tenha sido inicialmente implantado sem o modo de implantação avançado), você poderá usar o webhook de implantação para implantar mudanças subsequentes usando o modo de implantação avançado.

Para configurar o webhook de implantação, primeiro adicione um segredo de webhook ao seu projeto do Looker na página Configuração do projeto. A adição de um secret de webhook garante que apenas partes autorizadas possam acionar o webhook de implantação.

Dois webhooks estão disponíveis para implantar mudanças na produção com o modo de implantação avançado ativado. Um webhook é para implantar a cabeça de uma ramificação, e o outro é para implantar uma tag ou SHA do Git específica.

O webhook para implantar a cabeça de uma ramificação usa este formato:

<Looker URL>/webhooks/projects/<LookML project name>/deploy/branch/<Git branch name>

O webhook para implantar uma tag ou um SHA de commit usa este formato:

<Looker URL>/webhooks/projects/<LookML project name>/deploy/ref/<commit SHA or tag>

Substitua as informações nos colchetes angulares < > pelas informações específicas do endereço da instância, do projeto do LookML e do nome da ramificação ou da tag de confirmação. Confira um exemplo de webhook para implantar o nome da tag v1.0 do projeto e_faa na instância do Looker docsexamples.dev.looker.com:

https://docsexamples.dev.looker.com/webhooks/projects/e_faa/deploy/ref/v1.0

Implantar com a API

Para projetos com modo de implantação avançado, use a API Looker para implantar mudanças na produção.

Observação: quando o modo de implantação avançado está ativado para um novo projeto, é necessário usar o Deployment Manager para a implantação inicial do projeto na produção. Depois que o projeto for implantado na produção (mesmo que tenha sido inicialmente sem o modo de implantação avançado), você poderá usar a API para implantar mudanças subsequentes na produção usando o modo de implantação avançado.

Para implantar com a API, o usuário da API que faz a chamada precisa ter a permissão deploy. Consulte as páginas de documentação Autenticação da API Looker e Introdução à API para mais informações sobre como autenticar e usar a API Looker.

Para implantar com a API, use o endpoint deploy_ref_to_production. Esse endpoint pode ser chamado de várias maneiras. Os exemplos a seguir são para os métodos HTTPS e SDK.

HTTPS

Observação: ao usar os exemplos a seguir, substitua as informações nos colchetes angulares < > pelas informações específicas do endereço da instância, do projeto do LookML, do nome da ramificação, do SHA ou da tag.

Para implantar manualmente usando o endpoint da API deploy_ref_to_production, consulte os exemplos a seguir, que usam o método HTTPS. Para mais informações e exemplos de como chamar manualmente a API usando solicitações CURL, consulte o readme do GitHub Como fazer a autenticação na API ou use o API Explorer. É possível instalar o API Explorer na sua instância do Looker no Looker Marketplace.

Use os exemplos a seguir em uma solicitação HTTPS para implantar a cabeça de uma ramificação ou uma tag ou SHA de confirmação específica pelo endpoint da API deploy_ref_to_production:

Implantar a cabeça de uma ramificação: <HOST_URL>/api/4.0/projects/<PROJECT_ID>/deploy_ref_to_production?branch=<BRANCH_NAME>

Implantar um SHA ou tag de commit: <HOST_URL>/api/4.0/projects/<PROJECT_ID>/deploy_ref_to_production?ref=<SHA_OR_TAG>

SDK

Observação: ao usar os exemplos a seguir, substitua as informações nos colchetes angulares < > pelas informações específicas do seu projeto da LookML e do nome da ramificação, SHA ou tag.

Como alternativa, use um dos SDKs do Looker em vez de fazer solicitações manuais à API. Os SDKs lidam com os detalhes de autenticação, a serialização de parâmetros e respostas e outras questões.

A implantação com o deploy_ref_to_production e o método do SDK fica assim:

Implantar a cabeça de uma ramificação: deploy_ref_to_production(<PROJECT_ID>, {branch: <BRANCH_NAME>})

Implantar um SHA ou tag de commit: deploy_ref_to_production(<PROJECT_ID>, {ref: <SHA_OR_TAG>})