diff --git a/docs/sources/observability-as-code/provision-resources/_index.md b/docs/sources/observability-as-code/provision-resources/_index.md index c8e6b313eec..6e0f1665d67 100644 --- a/docs/sources/observability-as-code/provision-resources/_index.md +++ b/docs/sources/observability-as-code/provision-resources/_index.md @@ -1,5 +1,5 @@ --- -description: Learn about how to provision resource using Git Sync and local file provisioning administration. +description: Learn about how to provision resources using Git Sync and local file provisioning administration. keywords: - observability - configuration @@ -12,6 +12,7 @@ labels: - enterprise - oss title: Provision resources and sync dashboards +menuTitle: Provision resources weight: 300 --- diff --git a/docs/sources/observability-as-code/provision-resources/git-sync-setup.md b/docs/sources/observability-as-code/provision-resources/git-sync-setup.md index fbe43aa7a57..a4bbe8667e7 100644 --- a/docs/sources/observability-as-code/provision-resources/git-sync-setup.md +++ b/docs/sources/observability-as-code/provision-resources/git-sync-setup.md @@ -130,7 +130,7 @@ To connect your GitHub repository, follow these steps: {{< admonition type="caution" >}} -If you're using Git Sync in Grafana Cloud you can only sync specific folders for the moment. Git Sync will be available for your full instance soon. +Git Sync only works with specific folders for the moment. Full-instance sync is not currently supported. Refer to [Supported resources](/docs/grafana//observability-as-code/provision-resources/intro-git-sync#supported-resources) for more details about which resources you can sync. {{< /admonition >}} diff --git a/docs/sources/observability-as-code/provision-resources/intro-git-sync.md b/docs/sources/observability-as-code/provision-resources/intro-git-sync.md index d99fdbdca6e..25ec1d13806 100644 --- a/docs/sources/observability-as-code/provision-resources/intro-git-sync.md +++ b/docs/sources/observability-as-code/provision-resources/intro-git-sync.md @@ -9,6 +9,7 @@ labels: products: - enterprise - oss + - cloud title: Git Sync weight: 100 --- @@ -35,8 +36,18 @@ Using Git Sync, you can: ## How it works +{{< admonition type="caution" >}} + +Git Sync only works with specific folders for the moment. Full-instance sync is not currently supported. + +{{< /admonition >}} + Git Sync is bidirectional and works both with changes done directly in GitHub as well as in the Grafana UI. +### Provisioning folder + +Git Sync creates a folder for all the synchronized resources to live under. You can continue to have unprovisioned resources outside that folder. + ### Make changes in Grafana Whenever you modify a dashboard directly from the UI, Grafana can commit changes to Git upon saving. You can configure settings to either enforce PR approvals before merging in your repository, or allow direct commits. @@ -48,17 +59,41 @@ Grafana periodically polls GitHub at a regular internal to synchronize any chang ### Make changes in your GitHub repositories -With Git Sync, you can make changes in your provisioned files in GitHub and see them in Grafana. Automated workflows ensure those changes are automatically represented in the Grafana database by updating Git. The Grafana UI reads the database and updates the UI to reflect these changes. +With Git Sync, you can make changes to the files in the provisioned folder in GitHub and see them in Grafana. Automated workflows ensure those changes are automatically represented in the Grafana database by updating Git. The Grafana UI reads the database and updates the UI to reflect these changes. ## Known limitations Git Sync is under development and the following limitations apply: +- You can only sync dashboards and folders. Refer to [Supported resources](#supported-resources) for more information. + - If you're using Git Sync in Grafana OSS and Grafana Enterprise, some resources might be in an incompatible data format and can't be synced. - You can only authenticate in GitHub using your Personal Access Token token. - Support for native Git, Git app, and other providers, such as GitLab or Bitbucket, is on the roadmap. -- If you're using Git Sync in Grafana Cloud you can only sync specific folders for the moment. Git Sync will be available for your full instance soon. - Restoring resources from the UI is currently not possible. As an alternative, you can restore dashboards directly in your GitHub repository by raising a PR, and they will be updated in Grafana. +## Supported resources + +Git Sync only supports dashboards and folders. Alerts, panels, and other resources are not supported yet. + +If you're using Git Sync in Grafana OSS or Grafana Enterprise, some supported resources might be in an incompatible data format. If this happens, syncing will be blocked. Compatibility issues will be fixed with an upcoming migration tool. + +### Resource states + +A resource can be: + +| Is the resource? | **Compatible** | **Incompatible** | +| ---------------- | -------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| **Supported** | The resource can be managed with Git Sync. | The resource is supported but has compatibility issues. It **cannot** be managed with Git Sync. | +| **Unsupported** | The resource is **not** supported and **cannot** be managed with Git Sync. | Not applicable. | + +### Instance states + +An instance can be in one of the following states: + +- **Unprovisioned**: None of the instance's resources are being managed by Git Sync. +- **Partially provisioned**: Some of the resources are controlled by Git Sync. +- **Fully provisioned**: All supported resource types are managed by Git Sync. Note that unsupported resources are not managed. + ## Common use cases You can use Git Sync in the following scenarios.