4.0 KiB
| description | keywords | labels | title | weight | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Learn about how to provision resource using Git Sync and local file provisioning administration. |
|
|
Provision resources and sync dashboards | 300 |
Provision resources and sync dashboards
{{< admonition type="caution" >}} Provisioning is an experimental feature introduced in Grafana v12 for open source and Enterprise editions. Engineering and on-call support is not available. Documentation is either limited or not provided outside of code comments. No SLA is provided. This feature is not publicly available in Grafana Cloud yet. Only the cloud-hosted version of GitHub (GitHub.com) is supported at this time. GitHub Enterprise is not yet compatible.
Sign up for Grafana Cloud Git Sync early access using this form. {{< /admonition >}}
Provisioning is an experimental feature that allows you to configure how to store your dashboard JSONs and other files in GitHub repositories using either Git Sync or a local path.
Of the two options, Git Sync is the favorited method for provisioning your dashboards. You can synchronize any new dashboards and changes to existing dashboards from the UI to your configured GitHub repository. If you push a change in the repository, those changes are mirrored in your Grafana instance. See Git Sync workflow.
Alternatively, local file provisioning allows you to include in your Grafana instance resources (such as folders and dashboard JSON files) that are stored in a local file system. See Local file workflow.
Provisioned folders and connections
The dashboards saved in your GitHub repository or local folder appear in Grafana in the 'provisioned' folder. The dashboards and folders saved to the local path are referred to as 'provisioned' resources and are labeled as such in the Grafana UI. You can update any provisioned dashboard that is either stored within a GitHub repository (Git Sync workflow) or in a local file (local file workflow).
You can set a single folder, or multiple folders to a different repository, with up to 10 connections. Alternatively, your entire Grafana instance can be the provisioned folder.
Git Sync workflow
In the Git Sync workflow:
- When you provision resources with Git Sync you can modify them from within the Grafana UI or within the GitHub repository. Changes made in either the repository or the Grafana UI are bidirectional.
- Any changes made in the provisioned files stored in the GitHub repository are reflected in the Grafana database. By default, Grafana polls GitHub every 60 seconds.
- The Grafana UI reads from the database and updates the UI to reflect these changes.
For example, if you update a dashboard within the Grafana UI and click Save to preserve the changes, you'll be notified that the dashboard is provisioned in a GitHub repository. Next you'll be prompted to choose how to preserve the changes: either directly to a branch, or pushed to a new branch using a pull request in GitHub.
For more information, see Introduction to Git Sync and Set up Git Sync.
Local file workflow
In the local file workflow:
- All provisioned resources are changed in the local files.
- Any changes made in the provisioned files are reflected in the Grafana database.
- The Grafana UI reads the database and updates the UI to reflect these changes.
- You can't use the Grafana UI to edit or delete provisioned resources.
Learn more in Set up file provisioning.
Explore provisioning
{{< section withDescriptions="true" depth="5" >}}