Documentation for automated readers
A curated documentation index is available at: https://grafana.com/llms.txt
A complete documentation index is available at: https://grafana.com/llms-full.txt
These indexes can help with page discovery before fetching individual documents.
This page is also available in Markdown, which may be easier for automated readers and AI tools to parse than HTML. The Markdown version is available at https://grafana.com/docs/grafana-cloud/learn-and-build/as-code/git-sync/scenarios/single-instance.md, or by sending Accept: text/markdown to https://grafana.com/docs/grafana-cloud/learn-and-build/as-code/git-sync/scenarios/single-instance/. For broader documentation discovery, the curated index is available at https://grafana.com/llms.txt and the complete index is available at https://grafana.com/llms-full.txt.
Single instance Git Sync
Use a single Grafana instance synchronized with a Git repository. This is the foundation for Git Sync and helps you understand bidirectional synchronization.
Before you begin, ensure you have the following:
- A Git repository hosted on a compatible Git provider.
- A Grafana instance that meets the Git Sync setup prerequisites.
Use it for
Use this scenario in the following situations:
- Getting started: You want to learn how Git Sync works before implementing complex scenarios.
- Personal projects: Individual developers manage their own dashboards.
- Small teams: You have one environment and no complex workflows.
- Development environments: You need quick prototyping and testing.
Architecture
In this scenario, one Repository resource connects a single Grafana instance to one path on one branch:
┌─────────────────────────────────────────────┐
│ GitHub Repository │
│ Repository: your-org/grafana-manifests │
│ Branch: main │
│ │
│ grafana-manifests/ │
│ └── grafana/ │
│ ├── dashboard-1.json │
│ ├── dashboard-2.json │
│ └── dashboard-3.json │
└─────────────────────────────────────────────┘
↕
Git Sync (bidirectional)
↕
┌─────────────────────────────┐
│ Grafana Instance │
│ │
│ Repository Resource: │
│ - url: grafana-manifests │
│ - branch: main │
│ - path: grafana/ │
│ │
│ Creates folder: │
│ "grafana-manifests" │
└─────────────────────────────┘Repository structure
The following examples show how the same dashboards appear in Git and in Grafana.
In Git:
your-org/grafana-manifests
└── grafana/
├── dashboard-1.json
├── dashboard-2.json
└── dashboard-3.jsonIn Grafana Dashboards view:
Dashboards
└── 📁 grafana-manifests/
├── Dashboard 1
├── Dashboard 2
└── Dashboard 3- A folder titled
grafana-manifestscontains all synced dashboards. The folder takes its title from the Repository resource’s Display name, orspec.titleif you configure Git Sync as code. In the setup wizard, the display name defaults to the repository path, for exampleyour-org/grafana-manifests. This example uses the shortergrafana-manifests. - If you choose folderless sync instead, Grafana doesn’t create this folder and places the dashboards at the top level of Dashboards. Refer to Sync targets.
- Each JSON file becomes a dashboard, displayed in the folder with its title.
- Users browse dashboards organized under this folder structure.
Configuration parameters
Configure your Grafana instance to synchronize with the following parameters:
- Repository:
your-org/grafana-manifests - Branch:
main - Path:
grafana/
How it works
Git Sync keeps Grafana and Git synchronized in both directions:
- From Grafana to Git: When users create or modify dashboards in Grafana, Git Sync commits changes to the
grafana/directory on themainbranch. - From Git to Grafana: When you add or modify dashboard JSON files in the
grafana/directory, Git Sync pulls these changes into Grafana.
Learn more
Refer to the following documents to learn more:
Was this page helpful?
Related resources from Grafana Labs


