Como criar um pacote de integração contínua

Um conjunto de integração contínua (CI) é um conjunto de instruções de validação associado ao seu projeto do LookML. Um usuário do Looker com a permissão manage_ci pode configurar o seguinte em um conjunto de CI:

Antes de começar

Antes de criar um pacote de CI, você precisa do seguinte:

  • Uma instância do Looker que atenda aos requisitos de CI e esteja ativada para CI.
  • Uma conta de usuário do Looker com a permissão manage_ci, que está incluída no conjunto de permissões de administrador.
  • Um projeto do LookML com pelo menos um commit implantado na produção. Os serviços em segundo plano de CI só podem recuperar a configuração do Git do projeto se ele estiver no modo de produção. Se o projeto existir apenas no modo de desenvolvimento, a CI vai retornar erros ao configurar gatilhos de webhook.

Como criar um pacote de CI

É possível configurar e executar os validadores na página Pacotes do Looker IDE:

Página de pacotes de CI

Para criar um conjunto de CI, siga estas etapas:

  1. No IDE do Looker, clique no ícone Integração contínua na barra de navegação do IDE.
  2. Clique na guia Suítes para abrir a página Suítes.
  3. Na página Pacotes, é possível criar ou editar um pacote:
    • Para criar uma nova suíte, clique no botão Criar suíte.
    • Para editar um pacote, clique no botão Editar pacote.
  4. Insira um nome para o Nome do pacote. Se você estiver editando um pacote, clique no ícone de lápis para mudar o nome dele.
  5. (Opcional) Ative a opção Acionar em uma programação se quiser configurar testes de validação automáticos em uma programação recorrente. Consulte a seção Acionar em uma programação desta página para mais informações.

  6. (Opcional) Ative a opção Acionar em solicitações de pull do Looker se quiser configurar testes de validação automáticos sempre que um desenvolvedor do Looker enviar uma solicitação de envio para seu repositório. Consulte a seção Acionar em solicitações de pull do Looker desta página para mais informações.

    Se você ativar o acionamento de solicitação de envio para um pacote de CI, poderá usar o campo Somente para ramificação de destino para especificar que as solicitações de pull apenas para ramificações específicas no repositório devem acionar uma execução do pacote de CI. Consulte a seção Acionar em solicitações de pull do Looker desta página para mais informações.

  7. (Opcional) Ative a opção Acionar em solicitações de envio do dbt Cloud se quiser configurar testes de validação automáticos sempre que um job de CI do dbt Cloud for executado. Consulte a seção Acionar em solicitações de pull do dbt Cloud desta página para mais informações.

  8. (Opcional) Ative a opção Ativar alertas por e-mail se quiser receber alertas por e-mail com base no status de uma execução de CI. Consulte a seção Configurar alertas desta página para mais informações.

  9. Se quiser, ative as opções de alternância do validador para ativar um validador e configurar as opções dele. Consulte as páginas de documentação de cada um dos validadores para mais detalhes:

  10. Salve as mudanças:

    • Para criar uma nova suíte, clique no botão Criar suíte.
    • Se você estiver editando um pacote, clique no botão Atualizar pacote.

Gatilhos

As execuções de CI podem ser acionadas de várias maneiras:

Acionar com base em uma programação

É possível configurar uma suíte de CI para ser acionada automaticamente em uma programação ativando a opção Acionar em uma programação.

Quando essa opção está ativada, é possível selecionar a frequência e os detalhes para executar automaticamente o conjunto de CI:

  • Mensalmente, em um dia e horário específicos
  • Semanalmente, em um dia e horário específicos
  • Diariamente, em um horário específico
  • Por hora ou a cada 2, 3, 4, 6, 8 ou 12 horas, começando e terminando em horários específicos do dia
  • Minutos: a cada 5, 10, 15, 20 ou 30 minutos, começando e terminando em horários específicos do dia
  • Meses específicos do ano, em um dia e horário específicos
  • Dias específicos da semana em um horário específico

Acionar em solicitações de pull do Looker

Para configurar um pacote de CI para acionamento automático em solicitação de envio, ative a opção Acionar em solicitações de pull do Looker. Para usar o acionamento de solicitação de envio, seu repositório Git precisa ser configurado pelo administrador do Looker na página Administrador de integração contínua do Looker.

Se você ativar os gatilhos de solicitação de envio para um pacote de CI, poderá especificar que as solicitações de pull apenas para ramificações específicas no repositório acionem uma execução do pacote de CI. Para limitar os acionadores automáticos de solicitação de envio de execuções de CI a ramificações específicas no seu repositório, insira uma lista separada por vírgulas das ramificações no campo Somente para ramificação de destino.

Por exemplo, se um repositório tiver três ramificações chamadas main, release_1 e dev, você poderá inserir main, release_1 no campo Somente para ramificação de destino. Isso significa que as execuções de CI serão acionadas quando um desenvolvedor do Looker enviar uma solicitação de envio para a ramificação main ou release_1. Se um desenvolvedor do Looker enviar uma solicitação de envio para a ramificação dev, isso não vai acionar uma execução automática do conjunto de CI.

Acionar em solicitações de pull do dbt Cloud

Se você configurou a integração do dbt Cloud na sua instância, é possível configurar um conjunto de CI para ser acionado automaticamente quando um job de CI do dbt Cloud for concluído. O conjunto de CI verifica se as mudanças nos seus modelos do dbt vão causar erros de SQL nas análises detalhadas do Looker antes da implantação das mudanças do dbt.

Para configurar esse gatilho, ative a opção Acionar em solicitações de pull do dbt Cloud ao criar ou editar um pacote de CI.

Depois de ativar esse acionador, configure as seguintes opções:

  • Job do dbt Cloud: selecione o job de CI do dbt Cloud no campo suspenso que vai acionar este pacote.

  • Atributo do usuário do esquema: selecione o atributo do usuário do Looker que contém o nome do esquema para sua conexão de banco de dados. Somente os atributos de usuário ativados para CI no painel Administrador vão aparecer nessa lista.

Quando você salva o conjunto com esse gatilho ativado, o Looker registra automaticamente um webhook na sua conta do dbt Cloud para detectar a conclusão de jobs.

Para execuções acionadas pelo dbt Cloud, o Looker identifica dinamicamente o esquema temporário criado pela execução do dbt Cloud e substitui o atributo do usuário selecionado pelo nome desse esquema temporário durante a execução da CI.

Configurar alerta

Para receber alertas por e-mail com base no status das suas execuções de CI, configure alertas para um conjunto de CI. Assim, você pode monitorar as execuções de integração contínua sem precisar consultar a página Execuções no IDE do Looker.

Para configurar alertas por e-mail para um conjunto de CI, siga estas etapas ao criar ou editar um conjunto de CI:

  1. Ative a opção Ativar alertas de e-mail.
  2. No campo Endereços de e-mail, insira uma lista separada por vírgulas dos endereços que vão receber os alertas.
  3. Use as caixas de seleção para escolher os status de job que vão acionar um alerta:
    • Falha: aciona um e-mail quando uma execução de CI falha nos testes de validação.
    • Erro: envia um e-mail quando uma execução de CI encontra um erro de sistema ou de configuração.
    • Aprovado: aciona um e-mail quando uma execução de CI é concluída com sucesso.
    • Cancelado: aciona um e-mail quando uma execução de CI é cancelada.

Excluir um pacote

Para excluir um conjunto de CI, siga estas etapas:

  1. No IDE do Looker, clique no ícone Integração contínua na barra de navegação do IDE.
  2. Clique na guia Suítes para abrir a página Suítes.
  3. Na página Suítes, clique no botão Editar suíte.
  4. Na página do pacote, clique no botão Excluir pacote.
  5. Na caixa de diálogo de confirmação, clique no botão Excluir pacote.