Gestion des versions des tableaux de bord avec Git

Cette page explique comment utiliser les dossiers Git Databricks pour le contrôle de version et le développement collaboratif de tableaux de bord. Elle décrit également comment mettre en œuvre des processus CI/CD pour développer et déployer des tableaux de bord dans différents Workspace.

Présentation

Les dossiers Git de Databricks suivent les modifications et l'historique des tableaux de bord, prennent en charge la collaboration d'équipe et vous permettent de déployer les tableaux de bord en production et de récupérer les versions précédentes.

Activer le contrôle de code source du tableau de bord

Les administrateurs de Workspace peuvent contrôler l'accès au Workspace à partir de la page d'aperçus. Par default, le paramètre **Prise en charge des tableaux de bord dans les dossiers Git** est **activé**.

Alternative : Contrôle de version manuel

Si vous ne pouvez pas activer les dossiers Git, utilisez le workflow manuel suivant pour suivre les versions du tableau de bord :

1. Exportez votre tableau de bord sous forme de fichier JSON. Le format de fichier est lvdash.json. Consultez Exportez, importez ou remplacez un tableau de bord pour obtenir des instructions d'exportation.
2. Ajoutez ce fichier à un système de contrôle de version, tel que Git.
3. Modifier le fichier. Vous pouvez modifier les valeurs directement dans le fichier texte ou l’upload de nouveau vers votre Workspace et apporter des modifications dans l’interface utilisateur.
4. Enregistrez le nouveau fichier. Si vous avez apporté des modifications dans l'interface utilisateur, exportez votre nouveau fichier. Utilisez votre système de contrôle de version pour suivre les modifications et les versions des tableaux de bord.
5. Mettre à jour le tableau de bord existant. À partir du tableau de bord brouillon existant :
   1. Cliquez sur le menu kebab dans le coin supérieur droit, puis cliquez sur Remplacer le tableau de bord .
   2. Cliquez sur Choisir un fichier dans la boîte de dialogue Remplacer le tableau de bord à partir du fichier . Ensuite, cliquez sur Remplacer .

Fonctionnement de l'intégration Git avec les tableaux de bord

Les dossiers Git de Databricks suivent et gèrent les modifications apportées aux tableaux de bord *brouillons*. Le brouillon de tableau de bord reflète toutes les modifications dans un tableau de bord suivi. Git ne suit pas les configurations de publication et de planification, telles que la sélection de warehouse et la création de planifications. Pour gérer ces configurations, utilisez l'interface utilisateur ou automatisez les modifications avec Declarative Automation Bundles ou l'API REST AI/BI.

• Pour utiliser des bundles pour la gestion des tableaux de bord, consultez le tableau de bord.
• Pour publier et planifier des tableaux de bord avec l'API REST, consultez la référence de l'API Lakeview.

remarque

L'API Lakeview utilise l'ancien nom pour les tableaux de bord AI/BI.

Les dossiers Git Databricks gèrent les opérations Git courantes pour les tableaux de bord et d'autres objets de workspace. Pour en savoir plus, consultez les dossiers Git Databricks.

Application du contrôle de code source aux tableaux de bord

Pour suivre les tableaux de bord avec Git, placez-les dans un dossier Git Databricks. Utilisez l'une des options suivantes :

• Nouveaux dashboards : créez votre dashboard au sein d’un dossier Git Databricks existant pour appliquer le contrôle de code source dès le start.
• Tableaux de bord existants : déplacez un tableau de bord existant dans un dossier Git Databricks pour le suivre avec Git.

Gestion des autorisations pour les tableaux de bord sous contrôle de code source

Les autorisations au niveau du dossier s'appliquent à tous les objets de ce dossier, y compris les tableaux de bord. Les tableaux de bord d'un dossier Git héritent des autorisations du dossier parent en plus des autorisations spécifiques au tableau de bord. La plupart des opérations Git nécessitent l'autorisation CAN MANAGE. Pour en savoir plus, consultez les ACL des dossiers et les ACL des dossiers Git.

Flux de travail de développement recommandé

Clonez le repository dans votre dossier Databricks Git, utilisez des branches de fonctionnalités et soumettez des requêtes de tirage. Le tableau suivant décrit comment utiliser les dossiers Git pour gérer les tableaux de bord pendant les différentes phases de développement et de déploiement.

important

Le changement de branches Git est une opération destructive pour les tableaux de bord. Databricks supprime les tableaux de bord qui n'existent pas sur la Branch cible. Si vous revenez en arrière, les tableaux de bord réapparaîtront avec de nouvelles URL et de nouveaux identifiants, ce qui rompra les Link publiés, les signets et les intégrations d'API. Vérifiez la Branch cible avant de basculer et mettez à jour toutes les références ensuite.

Phase du projet	Workflow	Résultat attendu	Limitations connues
commit initial	Déplacez le tableau de bord dans un dossier Git du workspace. commit et push au repository Git distant.	Git suit le tableau de bord dans un repository distant.
Développement	Les développeurs créent des dossiers Git sur des Branch de développement séparées, généralement dans leurs dossiers personnels. Commit les modifications à la branch de développement. Mergez les Branchs de développement à la main Branch à l'aide de requêtes de tirage.	Les développeurs travaillent indépendamment. Git suit les versions des tableaux de bord.	Les fichiers de tableau de bord utilisent le format JSON. Les query SQL apparaissent sur une seule ligne, ce qui peut rendre les différences difficiles à examiner dans les demandes d'extraction.
Déploiement	Créez un dossier Git sur la Branch de déploiement dans un dossier de niveau supérieur non utilisateur. Consultez CI/CD avec les dossiers Git Databricks. Extrayez les modifications vers le dossier de déploiement. Publiez les tableaux de bord à partir de ce dossier. Supprimer l’accès en édition et restreindre les mises à jour à Git. Partager des tableaux de bord avec des consommateurs.	Les consommateurs accèdent à une version cohérente et publiée du tableau de bord. Vous pouvez partager des tableaux de bord dans le même dossier avec différents publics.	Databricks ne prend pas en charge de manière intégrée la synchronisation d'une branch distante avec un dossier Git dans le workspace, ni le déploiement de Declarative Automation Bundles avec une ressource de tableau de bord à distance. Configurez l'automatisation CI/CD pour automatiser : Extraction des mises à jour du repository distant. Publication des tableaux de bord après la synchronisation. Déploiement des Declarative Automation Bundles après une mise à jour.

Phase du projet	Workflow	Résultat attendu	Limitations connues
commit initial	Déplacez le tableau de bord dans un dossier Git du workspace. commit et push au repository Git distant.	Git suit le tableau de bord dans un repository distant.
Développement	Les développeurs créent des dossiers Git sur des Branch de développement séparées, généralement dans leurs dossiers personnels. Commit les modifications à la branch de développement. Mergez les Branchs de développement à la main Branch à l'aide de requêtes de tirage.	Les développeurs travaillent indépendamment. Git suit les versions des tableaux de bord.	Les fichiers de tableau de bord utilisent le format JSON. Les query SQL apparaissent sur une seule ligne, ce qui peut rendre les différences difficiles à examiner dans les demandes d'extraction.
Déploiement	Créez un dossier Git sur la Branch de déploiement dans un dossier de niveau supérieur non utilisateur. Consultez CI/CD avec les dossiers Git Databricks. Extrayez les modifications vers le dossier de déploiement. Publiez les tableaux de bord à partir de ce dossier. Supprimer l’accès en édition et restreindre les mises à jour à Git. Partager des tableaux de bord avec des consommateurs.	Les consommateurs accèdent à une version cohérente et publiée du tableau de bord. Vous pouvez partager des tableaux de bord dans le même dossier avec différents publics.	Databricks ne prend pas en charge de manière intégrée la synchronisation d'une branch distante avec un dossier Git dans le workspace, ni le déploiement de Declarative Automation Bundles avec une ressource de tableau de bord à distance. Configurez l'automatisation CI/CD pour automatiser : Extraction des mises à jour du repository distant. Publication des tableaux de bord après la synchronisation. Déploiement des Declarative Automation Bundles après une mise à jour.

Pour plus de bonnes pratiques sur la collaboration dans les dossiers Git Databricks, consultez Collaborer à l'aide des dossiers Git.

Limitations

La gestion de versions avec les tableaux de bord AI/BI présente les limitations suivantes :

• Vous pouvez commit un maximum de 100 tableaux de bord dans un seul dossier Git. Cette limite pourrait changer dans une future version.
• Les jobs basés sur Git, tels que les jobs faisant référence à des URL Git au lieu d'identifiants d'asset de workspace ou de chemins, ne fonctionnent pas avec les tableaux de bord.
• La sérialisation des tableaux de bord génère de longues chaînes, ce qui rend la lecture et l'examen des différences lors des pull requests difficiles.
• Le format de fichier du tableau de bord change périodiquement pour inclure de nouveaux champs et d'autres améliorations. Ces changements pourraient apparaître comme des différences dans Git que vous n'avez pas initiées.