Add Observability as Code documentation (#104301)

Co-authored-by: Kim Nylander <kim.nylander@grafana.com> Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
2025-04-22 16:53:41 +00:00
parent e42cca9527
commit 576bf66e03
8 changed files with 943 additions and 0 deletions
@@ -0,0 +1,84 @@
+---
+description: Instructions for working with Git Sync to perform common tasks, such as saving dashboards to GitHub and synchronizing changes with Grafana.
+keywords:
+  - as code
+  - as-code
+  - dashboards
+  - git integration
+  - git sync
+  - github
+labels:
+  products:
+    - enterprise
+    - oss
+title: Manage provisioned repositories with Git Sync
+menuTitle: Manage repositories
+weight: 400
+---
+
+# Manage provisioned repositories with Git Sync
+
+- [Provision resources and sync dashboards](/docs/grafana/<GRAFANA_VERSION>/observability-as-code/provision-resources/)
+  - [Git Sync](/docs/grafana/<GRAFANA_VERSION>/observability-as-code/provision-resources/intro-git-sync/)
+  - [Set up Git Sync](/docs/grafana/<GRAFANA_VERSION>/observability-as-code/provision-resources/git-sync-setup/)
+  - [Set up file provisioning](/docs/grafana/<GRAFANA_VERSION>/observability-as-code/provision-resources/file-path-setup/)
+  - [Work with provisioned dashboards](/docs/grafana/<GRAFANA_VERSION>/observability-as-code/provision-resources/provisioned-dashboards/)
+  - [Manage provisioned repositories with Git Sync](/docs/grafana/<GRAFANA_VERSION>observability-as-code/provision-resources/use-git-sync/)
+
+<hr />
+
+After you have set up Git Sync, you can synchronize dashboards and changes to existing dashboards to your configured GitHub repository.
+If you push a change in the repository, those changes are mirrored in your Grafana instance.
+
+## View current status of synchronization
+
+Each repository synchronized with Git Sync has a dashboard that provides a summary of resources, health, pull status, webhook, sync jobs, resources, and files.
+Use the detailed information accessed in **View** to help troubleshoot and understand the health of your repository's connection with Grafana.
+
+To view the current status, follow these steps.
+
+1. Log in to your Grafana server with an account that has the Grafana Admin or Editor flag set.
+1. Select **Administration** in the left-side menu and then **Provisioning**.
+1. Locate the repository you are interested in.
+1. If you see a green `Up-to-date` label next to the repository name, then everything is syncing as expected.
+1. Select **View** to access detailed dashboards and reports about the synchronization history of your repository.
+
+## Synchronize changes
+
+Synchronizing resources from provisioned repositories into your Grafana instance pulls the resources into the selected folder. Existing dashboards with the same `uid` are overwritten.
+
+To sync changes from your dashboards with your Git repository:
+
+1. From the left menu, select **Administration** > **Provisioning**.
+1. Select **Pull** under the repository you want to sync.
+1. Wait for the synchronization process to complete.
+
+## Remove a repository
+
+To delete a repository, follow these steps.
+
+1. Log in to your Grafana server with an account that has the Grafana Admin or Editor flag set.
+1. Select **Administration** in the left-side menu and then **Provisioning**.
+1. Locate the repository you are interested in.
+1. Select the trashcan icon in the right side to delete the chosen entry.
+1. Select **Delete** to confirm.
+
+## Troubleshoot synchronization
+
+Monitor the **View** status page for synchronization issues and status updates. Common events include:
+
+- Sync started
+- Sync completed
+- Sync failed (with error details)
+- Sync issues
+
+### Dashboard sync errors
+
+- If dashboards are not syncing, check if the repository URL is correct and accessible from the Grafana instance.
+- Ensure that the configured repository branch exists and is correctly referenced.
+- Check for conflicts in the repository that may prevent syncing.
+
+### Dashboard import errors
+
+- Validate the JSON format of the dashboard files before importing.
+- If the import fails, check Grafana logs for error messages and troubleshoot accordingly.