Painéis de controle de versão com Git

Esta página explica como usar as pastas Git do Databricks para controle de versão e desenvolvimento colaborativo de dashboards. O documento também descreve como implementar processos de CI/CD para desenvolver e implantar dashboards em diferentes espaços de trabalho.

info

Visualização

Este recurso está em Pré-visualização Pública.

Visão geral

As pastas Git Databricks rastreiam as alterações e o histórico dos painéis, oferecem suporte à colaboração em equipe e permitem implantar painéis em produção e recuperar versões anteriores.

Ativar controle de origem do painel de controle

Os administradores do espaço de trabalho podem controlar o acesso workspace à Pré-visualização Pública na página de Pré-visualizações. Por default, a visualização dos painéis de suporte na pasta Git está ativada .

Alternativa: Controle de versão manual

Se não conseguir ativar a Pré-visualização Pública, utilize o seguinte fluxo de trabalho manual para controlar as versões do painel:

1. Exporte seu painel de controle como um arquivo JSON. O formato do arquivo é lvdash.json. Consulte Exportar, importar ou substituir um painel de controlo 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 os valores diretamente no arquivo de texto ou upload lo de volta para seu 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 o novo arquivo. Utilize seu sistema de controle de versão para rastrear alterações e versões do painel de controle.
5. Atualize o painel de controle existente. A partir do rascunho existente do painel de controle:
   1. Clique no No canto superior direito, clique em "Substituir painel" .
   2. Clique em "Escolher arquivo" na caixa de diálogo "Substituir arquivo" do painel de controle . Em seguida, clique em Sobrescrever .

Como a integração do Git funciona com os painéis de controle

As pastas Git Databricks rastreiam e gerenciam alterações em rascunhos de painéis. O rascunho do painel reflete todas as alterações em um painel monitorado. Git não rastreia configurações de publicação e programação, como seleção de repositório e criação de programas. Para gerenciar essas configurações, use a interface do usuário ou automatize as alterações com Databricks Ativo Bundles ou a API REST AI/BI .

• Para usar pacotes para gerenciamento de painéis, consulte painel.
• Para publicar e programar dashboards com a API REST , consulte a referência API Lakeview .

nota

A API Lakeview usa o nome anterior para painéis de AI/BI .

As pastas Git Databricks gerenciam operações Git comuns para dashboards e outros objetos workspace . Para saber mais, consulte Pastas Git do Databricks.

Aplicando controle de versão a painéis de controle

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

• Novos painéis: Crie seu painel dentro de uma pasta Git existente Databricks para aplicar o controle de versão 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 painéis com controle de versão

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

Fluxo de trabalho de desenvolvimento recomendado

Clone o repositório para sua própria pasta Git Databricks , use branches de recurso e envie solicitações de pull. A tabela a seguir descreve como usar pastas Git para gerenciar painéis durante diferentes fases de desenvolvimento e implantação.

importante

A troca de branches Git é uma operação destrutiva para dashboards. O Databricks remove dashboards que não existem na branch de destino. Se você voltar à versão anterior, os painéis reaparecerão com novos URLs e IDs, o que quebrará os links publicados, os favoritos e as integrações de API. Verifique a ramificação de destino antes de alternar e atualize todas as referências em seguida.

Fase do projeto	Workflow	Resultado esperado	Limitações conhecidas
commitinicial	Mova o painel de controle para uma pasta Git no workspace. Confirme e envie para o repositório Git remoto.	O Git rastreia o painel de controle em um repositório remoto.
Desenvolvimento	Os desenvolvedores criam pastas Git em branches de desenvolvimento separadas, normalmente em seu diretório raiz do Git. Confirme as alterações no branch de desenvolvimento. Mesclar branches de desenvolvimento na branch principal usando pull requests.	Os desenvolvedores trabalham de forma independente. O Git controla as versões do painel de controle.	Os arquivos do painel de controle usam o formato JSON . As consultas SQL aparecem em uma única linha, o que pode dificultar a revisão das diferenças em solicitações de pull.
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. Veja CI/CD com pastas Git do Databricks. Extraia as alterações para a pasta de implantação. Publique painéis de controle a partir desta pasta. Remover o acesso de edição e restringir as atualizações no Git. Compartilhe painéis de controle com os consumidores.	Os consumidores têm acesso a uma versão consistente e publicada do painel de controle. Você pode compartilhar painéis na mesma pasta com públicos diferentes.	Databricks não oferece suporte integrado para sincronizar um branch remoto com uma pasta Git no workspace, nem para implantar Databricks Ativo Bundles com um recurso de dashboard remoto. Configure a automação de CI/CD para automatizar: Obtendo atualizações do repositório remoto. Publicando painéis após a sincronização. implantei Databricks ativo Bundles após uma atualização.

Para obter mais informações sobre as melhores práticas de colaboração em pastas Git do Databricks, consulte Colaborar usando pastas Git.

Limitações

O controle de versão com dashboards AI/BI apresenta as seguintes limitações:

• Você pode commit no máximo 100 dashboards em uma única pasta Git . Esse limite poderá ser alterado durante a Pré-visualização Pública.
• Tarefas baseadas em Git , como tarefas que referenciam URLs Git em vez de IDs ou caminhos ativos workspace , não funcionam com painéis de controle.
• A serialização do painel de controle gera strings longas, o que dificulta a leitura e a revisão das diferenças durante as solicitações de pull.
• O formato do arquivo do painel de controle é alterado periodicamente para incluir novos campos e outras melhorias. Durante a versão prévia pública, essas alterações podem aparecer como diferenças no Git que você não iniciou.