メインコンテンツまでスキップ

Git を使用したバージョン管理ダッシュボード

このページでは、バージョン管理と共同ダッシュボード開発に Databricks Git フォルダーを使用する方法について説明します。また、さまざまなワークスペースにわたってダッシュボードを開発および展開するための CI/CD プロセスを実装する方法についても説明します。

備考

プレビュー

この機能は パブリック プレビュー段階です。

概要

Databricks Gitフォルダーは、ダッシュボードの変更と履歴を追跡し、チームのコラボレーションをサポートし、ダッシュボードを本番運用にデプロイして以前のバージョンを復元できるようにします。

ダッシュボードのソース管理を有効にする

ワークスペース管理者は、 プレビュー ページからパブリック プレビューへのワークスペースのアクセスを制御できます。 デフォルトでは、 Git フォルダのダッシュボードサポート プレビューは [オン] です。

Git 統合がダッシュボードでどのように機能するか

Databricks Git フォルダーは、 ドラフト ダッシュボードへの変更を追跡および管理します。ダッシュボード ドラフトには、追跡されたダッシュボード内のすべての変更が反映されます。Git は、ウェアハウスの選択やスケジュールの作成など、公開およびスケジュールの構成を追跡しません。これらの構成を管理するには、UI を使用するか、Databricks Asset Bundle または AI/BI REST API を使用して変更を自動化します。

  • ダッシュボード管理にバンドルを使用するには、 「ダッシュボード」を参照してください。
  • REST API を使用してダッシュボードを公開およびスケジュールするには、 Lakeview API リファレンスを参照してください。
注記

Lakeview API は、AI/BI ダッシュボードに以前の名前を使用します。

Databricks Git フォルダーは、ダッシュボードやその他のワークスペース オブジェクトの一般的な Git 操作を管理します。詳細については、 「Databricks Git フォルダーとは」を参照してください。

ダッシュボードへのソース管理の適用

Git でダッシュボードを追跡するには、ダッシュボードを Databricks Git フォルダーに配置します。 次のいずれかのオプションを使用します。

  • 新しいダッシュボード: 既存の Databricks Git フォルダー内にダッシュボードを作成し、最初からソース管理を適用します。
  • 既存のダッシュボード: 既存のダッシュボードを Databricks Git フォルダーに移動して、Git で追跡します。

ソース管理ダッシュボードの権限の管理

フォルダー レベルの権限は、ダッシュボードを含むそのフォルダー内のすべてのオブジェクトに適用されます。Git フォルダー内のダッシュボードは、ダッシュボード固有の権限に加えて、親フォルダーの権限も継承します。ほとんどの Git 操作には CAN MANAGE 権限が必要です。詳細については、 「フォルダー ACL」および「Git フォルダー ACL」を参照してください。

推奨される開発ワークフロー

リポジトリを独自の Databricks Git フォルダーに複製し、機能ブランチを使用して、プル リクエストを送信します。次の表は、開発とデプロイメントのさまざまなフェーズで Git フォルダーを使用してダッシュボードを管理する方法を示しています。

重要

Git ブランチの切り替えはダッシュボードにとって破壊的な操作です。Databricks は、ターゲット ブランチに存在しないダッシュボードを削除します。元に戻すと、ダッシュボードは新しい URL と ID で再表示され、公開されたリンク、ブックマーク、API 統合が壊れます。切り替える前にターゲット ブランチを確認し、切り替え後にすべての参照を更新します。

プロジェクトフェーズ

ワークフロー

期待される結果

既知の制限

初期コミット

  • ダッシュボードをワークスペース内の Git フォルダーに移動します。
  • コミットしてリモート Git リポジトリにプッシュします。

Git はリモート リポジトリ内のダッシュボードを追跡します。

開発

  • 開発者は、 Gitフォルダーを別の開発ブランチ (通常はホームプログラム内) に作成します。
  • 開発ブランチに変更をコミットします。
  • プル リクエストを使用して開発ブランチをメインにマージします。
  • 開発者は独立して作業します。
  • Git はダッシュボードのバージョンを追跡します。

ダッシュボード ファイルはJSON形式を使用します。SQL クエリは 1 行として表示されるため、プル リクエストで差分を確認するのが難しくなる可能性があります。

デプロイメント

  • デプロイメント ブランチ上の、ユーザー以外の最上位フォルダーに Git フォルダーを作成します。Databricks Gitフォルダー ( Repos ) を使用したCI/CD参照してください。
  • 変更を展開フォルダーにプルします。
  • このフォルダーからダッシュボードを公開します。
  • 編集+ アクセスを削除し、Git への更新を制限します。
  • ダッシュボードを消費者と共有します。
  • 消費者は一貫性のある公開バージョンのダッシュボードにアクセスします。
  • 同じフォルダー内のダッシュボードをさまざまなユーザーと共有できます。

Databricks には、リモート ブランチをワークスペース内の Git フォルダーと同期したり、リモートからダッシュボード リソースを使用して Databricks アセット バンドルをデプロイしたりするための組み込みサポートは提供されていません。CI/CD 自動化を設定して、次の作業を自動化します。

  • リモート リポジトリから更新をプルしています。
  • 同期後にダッシュボードを公開します。
  • 更新後に Databricks アセット バンドルをデプロイします。

Databricks Git フォルダーでのコラボレーションに関するその他のベスト プラクティスについては、「 Git フォルダーを使用したコラボレーション」を参照してください。

制限

AI/BI ダッシュボードを使用したソース管理には、次の制限があります。

  • 1 つの Git フォルダーに最大 100 個のダッシュボードをコミットできます。この制限はパブリック プレビュー中に変更される可能性があります。
  • ワークスペース アセット ID やパスではなく Git URL を参照するジョブなどの Git ベースのジョブは、ダッシュボードでは機能しません。
  • ダッシュボードのシリアル化により長い文字列が生成され、プル リクエスト中に差異の読み取りと確認が困難になります。
  • ダッシュボードのファイル形式は、新しいフィールドやその他の改善点を含めるために定期的に変更されます。パブリック プレビュー中は、これらの変更は、ユーザーが開始していない Git の差異として表示される場合があります。