Slide 3 of 3

Deploy a dashboard with Git Sync

Hands-on: sync your dashboard JSON with Git Sync

Use the dashboard JSON you exported with the Foundation SDK. Connect Git Sync to a GitHub repository, commit that JSON into the synced path, and verify the dashboard appears as a provisioned dashboard in Grafana.

StepWhat you’ll doOutcome
1. Open ProvisioningSign in as Grafana Admin and go to Administration > General > ProvisioningGit Sync setup screen
2. Connect GitHubChoose GitHub and authenticate (personal access token or another method you use)Grafana can access your repository
3. Configure the repositorySet repository, branch, and path for folder syncA repository resource watching that path
4. Commit your JSONAdd the Foundation SDK dashboard JSON file under the synced path and pushJSON available for sync
5. Pull and verifyUse Pull if needed, then open Dashboards and find the provisioned dashboardLive dashboard from Git

Before you start

Make sure you have the following:

  • Grafana Admin access on your instance
  • A GitHub repository you can commit to
  • Dashboard JSON exported from the Foundation SDK (with a stable UID)
  • Authentication for GitHub (for example a personal access token)

Set up, then practice

Complete steps 1–3 with the Git Sync setup docs (this journey’s connection path). Then commit your SDK JSON (steps 4–5) and verify the provisioned dashboard.

After Git Sync is connected, these learning paths help you navigate Provisioning and work with provisioned dashboards in the UI. They assume a repository is already configured; they do not replace the setup docs or the SDK JSON commit in the table above.

Learning path

Use Git Sync to manage resources

Welcome to the learning path that shows you how to use Git Sync to manage your Grafana resources with version control.

10 min
Beginner
Docs & blog posts

Open in Grafana Cloud

Complete this learning path directly in your Grafana Cloud stack with an interactive learning experience.

Learning path

Work with dashboards using Git Sync

Welcome to the learning path that shows you how to create, edit, and manage dashboards using Git Sync workflows with version control.

16 min
Beginner
Docs & blog posts

Open in Grafana Cloud

Complete this learning path directly in your Grafana Cloud stack with an interactive learning experience.