Painéis de controle de versão com Git

Esta página explica como usar pastas Git do Databricks para controle de versão e desenvolvimento de dashboard colaborativo. Ele também descreve como implementar processos de CI/CD para desenvolver e implantar painéis em diferentes workspaces.

Visão geral

As pastas Git do Databricks acompanham as alterações e o histórico do painel, dão suporte à colaboração da equipe e permitem implantar painéis na produção e recuperar versões anteriores.

Habilitar o controle do código-fonte do painel

Os administradores do workspace podem controlar o acesso ao workspace na página Visualizações. Por padrão, a configuração Dashboards de suporte na pasta Git está Ativada.

Alternativa: controle de versão manual

Se você não puder habilitar pastas Git, use o seguinte fluxo de trabalho manual para acompanhar as versões do painel:

  1. Exporte seu painel como um arquivo JSON. O formato de arquivo é lvdash.json. Consulte Exportar, importar ou substituir um painel para obter instruções de exportação.
  2. Adicione esse arquivo a um sistema de controle de versão, como o Git.
  3. Edite o arquivo. Você pode editar valores no arquivo de texto diretamente ou carregá-los de volta no workspace e fazer alterações na interface do usuário.
  4. Salve o novo arquivo. Se você fez alterações na interface do usuário, exporte seu novo arquivo. Use o sistema de controle de versão para controlar as alterações e as versões do painel.
  5. Atualize o painel existente. No painel de rascunho existente:
    1. Clique no menu kebab Ícone de menu Kebab. no canto superior direito e clique em Substituir painel.
    2. Clique em Escolher arquivo na caixa de diálogo Substituir painel do arquivo. Em seguida, clique em Substituir.

Como a integração do Git funciona com dashboards

As pastas Git do Databricks rastreiam e gerenciam alterações em dashboards de rascunho. O rascunho do painel de controle reflete todas as alterações em um painel monitorado. O Git não acompanha as configurações de publicação e agendamento, como seleção de armazém e criação de agendamento. Para gerenciar essas configurações, use a interface do usuário ou automatize as alterações com Pacotes de Automação Declarativa ou a API REST de IA/BI.

  • Para usar pacotes para o gerenciamento de painel, consulte o painel.
  • Para publicar e agendar painéis com a API REST, consulte a referência da API lakeview .

Observação

A API lakeview usa o nome anterior para painéis de IA/BI.

As pastas Git do Databricks gerenciam operações comuns do Git para dashboards e outros objetos de workspace. Para saber mais, confira as pastas git do Azure Databricks.

Aplicando o controle do código-fonte a dashboards

Para gerenciar dashboards com o Git, coloque-os em uma pasta Git do Databricks. Use uma das seguintes opções:

  • Novos painéis: Crie seu painel dentro de uma pasta Git do Databricks existente para aplicar o controle do código-fonte desde o início.
  • Painéis existentes: Mova um painel existente para uma pasta Git do Databricks para rastreá-lo com o Git.

Gerenciando permissões para dashboards controlados pelo código-fonte

As permissões no nível da pasta se aplicam a todos os objetos dentro dessa pasta, incluindo painéis. Os painéis em uma pasta Git herdam as permissões da pasta pai, além de permissões específicas do painel. A maioria das operações do Git exige a permissão CAN MANAGE. Para saber mais, consulte ACLs de pasta e ACLs de pasta git.

Clone o repositório para a sua própria pasta Git no Databricks, utilize feature branches e envie pull requests. A tabela a seguir descreve como usar pastas Git para gerenciar dashboards durante diferentes fases de desenvolvimento e implantação.

Importante

Trocar branches do Git é uma operação destrutiva para dashboards. O Azure Databricks elimina dashboards que não existem no branch de destino. Se você reverter a alteração, os dashboards reaparecerão com novas URLs e IDs, o que invalida links publicados, favoritos e integrações de API. Verifique o branch de destino antes de alternar e atualize todas as referências em seguida.

Fase do projeto Workflow Resultado esperado Limitações conhecidas
Confirmação inicial
  • Mova o painel para uma pasta Git no workspace.
  • Confirme e envie por push para o repositório Git remoto.
O Git rastreia o painel em um repositório remoto.
Desenvolvimento
  • Os desenvolvedores criam pastas Git em branches de desenvolvimento separados, normalmente em suas pastas domésticas.
  • Confirmar alterações no branch de desenvolvimento.
  • Mesclar branches de desenvolvimento à principal usando solicitações de pull.
  • Os desenvolvedores trabalham de forma independente.
  • O Git controla as versões do painel.
Implantação
  • Crie uma pasta Git no branch de implantação em uma pasta de nível superior que não seja de usuário. Consulte CI/CD com pastas Git do Databricks.
  • Efetuar pull de alterações na pasta de implantação.
  • Publique painéis desta pasta.
  • Remova o acesso "edit+" e restrinja as atualizações ao Git.
  • Compartilhe dashboards com consumidores.
  • Os consumidores acessam uma versão consistente e publicada do painel.
  • Você pode compartilhar painéis na mesma pasta com públicos diferentes.
O Databricks não fornece suporte interno para sincronizar um branch remoto com uma pasta Git no workspace ou implantar Pacotes de Automação Declarativa com um recurso de painel remoto. Configure a automação de CI/CD para automatizar:
  • Obtendo atualizações do repositório remoto.
  • Publicar painéis após a sincronização.
  • Implantando pacotes de automação declarativa após uma atualização.

Para obter mais práticas recomendadas sobre colaboração em pastas Git do Databricks, consulte Colaborar usando pastas Git.

Limitações

O controle do código-fonte com painéis de IA/BI tem as seguintes limitações:

  • Trabalhos baseados em Git, como trabalhos que fazem referência a URLs do Git em vez de IDs ou caminhos de ativos do workspace, não funcionam com dashboards.