public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[DOC] Make Obs as Code docs public (#104843)

Browse Source 
Co-authored-by: Isabel Matwawana <isabel.matwawana@grafana.com>
This commit is contained in:
Kim Nylander
2025-05-05 16:19:17 +02:00
committed by GitHub
co-authored by Isabel Matwawana
parent c90e2e8e5e
commit bad3d7c2db
11 changed files with 4 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/observability-as-code/_index.md
-5
View File
@@ -1,9 +1,4 @@
--- ---
_build:
list: false
noindex: true
cascade:
noindex: true
description: Overview of Observability as Code including description, key features, and explanation of benefits. description: Overview of Observability as Code including description, key features, and explanation of benefits.
keywords: keywords:
- observability - observability
docs/sources/observability-as-code/grafana-cli/_index.md
-3
View File
@@ -1,7 +1,4 @@
--- ---
_build:
list: false
noindex: true
cascade: cascade:
noindex: true noindex: true
description: Overview of Grafana CLI, a command line tool for managing Grafana resources as code. description: Overview of Grafana CLI, a command line tool for managing Grafana resources as code.
docs/sources/observability-as-code/grafana-cli/grafanacli-workflows.md
-3
View File
@@ -1,7 +1,4 @@
--- ---
_build:
list: false
noindex: true
cascade: cascade:
noindex: true noindex: true
description: Learn more about the supported workflows and use cases for Grafana CLI description: Learn more about the supported workflows and use cases for Grafana CLI
docs/sources/observability-as-code/grafana-cli/install-grafana-cli.md
-3
View File
@@ -1,7 +1,4 @@
--- ---
_build:
list: false
noindex: true
cascade: cascade:
noindex: true noindex: true
description: Installation guide for Grafana CLI, a command line tool for managing Grafana Observability as Code description: Installation guide for Grafana CLI, a command line tool for managing Grafana Observability as Code
docs/sources/observability-as-code/grafana-cli/set-up-grafana-cli.md
-3
View File
@@ -1,7 +1,4 @@
--- ---
_build:
list: false
noindex: true
cascade: cascade:
noindex: true noindex: true
description: Configuration guide for Grafana CLI, a command line tool for managing Grafana resources as code. description: Configuration guide for Grafana CLI, a command line tool for managing Grafana resources as code.
docs/sources/observability-as-code/provision-resources/_index.md
+1 -1
View File
@@ -12,7 +12,7 @@ labels:
- enterprise - enterprise
- oss - oss
title: Provision resources and sync dashboards title: Provision resources and sync dashboards
weight: 100 weight: 300
--- ---
# Provision resources and sync dashboards # Provision resources and sync dashboards
docs/sources/observability-as-code/provision-resources/file-path-setup.md
-9
View File
@@ -19,15 +19,6 @@ weight: 200
Local file provisioning is an [experimental feature](https://grafana.com/docs/release-life-cycle/) 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. Enable the `provisioning` and `kubernetesDashboards` feature toggles in Grafana to use this feature. This feature isn't available in Grafana Cloud. Local file provisioning is an [experimental feature](https://grafana.com/docs/release-life-cycle/) 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. Enable the `provisioning` and `kubernetesDashboards` feature toggles in Grafana to use this feature. This feature isn't available in Grafana Cloud.
{{< /admonition >}} {{< /admonition >}}
- [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 />
File provisioning in Grafana lets you include resources, including folders and dashboard JSON files, that are stored in a local file system. File provisioning in Grafana lets you include resources, including folders and dashboard JSON files, that are stored in a local file system.
This page explains how to set up local file provisioning. This page explains how to set up local file provisioning.
docs/sources/observability-as-code/provision-resources/git-sync-setup.md
-9
View File
@@ -19,15 +19,6 @@ weight: 100
Git Sync is an [experimental feature](https://grafana.com/docs/release-life-cycle/) 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. Enable the `provisioning` and `kubernetesDashboards` feature toggles in Grafana to use this feature. Git Sync isn't available in Grafana Cloud. Git Sync is an [experimental feature](https://grafana.com/docs/release-life-cycle/) 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. Enable the `provisioning` and `kubernetesDashboards` feature toggles in Grafana to use this feature. Git Sync isn't available in Grafana Cloud.
{{< /admonition >}} {{< /admonition >}}
- [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 />
Git Sync lets you manage Grafana dashboards as code by storing dashboards JSON files and folders in a remote GitHub repository. Git Sync lets you manage Grafana dashboards as code by storing dashboards JSON files and folders in a remote GitHub repository.
Alternatively, you can configure a local file system instead of using GitHub. Alternatively, you can configure a local file system instead of using GitHub.
Refer to [Set up file provisioning](https://grafana.com/docs/grafana/<GRAFANA_VERSION>/observability-as-code/provision-resources/file-path-setup/) for information. Refer to [Set up file provisioning](https://grafana.com/docs/grafana/<GRAFANA_VERSION>/observability-as-code/provision-resources/file-path-setup/) for information.
docs/sources/observability-as-code/provision-resources/intro-git-sync.md
-9
View File
@@ -19,15 +19,6 @@ weight: 100
Git Sync is an [experimental feature](https://grafana.com/docs/release-life-cycle/) 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. Enable the `provisioning` and `kubernetesDashboards` feature toggles in Grafana to use this feature. Git Sync isn't available in Grafana Cloud. Git Sync is an [experimental feature](https://grafana.com/docs/release-life-cycle/) 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. Enable the `provisioning` and `kubernetesDashboards` feature toggles in Grafana to use this feature. Git Sync isn't available in Grafana Cloud.
{{< /admonition >}} {{< /admonition >}}
- [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 />
Using Git Sync, you can: Using Git Sync, you can:
- Introduce a review process for creating and modifying dashboards - Introduce a review process for creating and modifying dashboards
docs/sources/observability-as-code/provision-resources/provisioned-dashboards.md
-9
View File
@@ -19,15 +19,6 @@ weight: 300
Git Sync and File path provisioning an [experimental feature](https://grafana.com/docs/release-life-cycle/) 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. Enable the `provisioning` and `kubernetesDashboards` feature toggles in Grafana. These features aren't available in Grafana Cloud. Git Sync and File path provisioning an [experimental feature](https://grafana.com/docs/release-life-cycle/) 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. Enable the `provisioning` and `kubernetesDashboards` feature toggles in Grafana. These features aren't available in Grafana Cloud.
{{< /admonition >}} {{< /admonition >}}
- [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 />
Using Provisioning, you can choose to store your dashboard JSON files in either GitHub repositories using Git Sync or a local file path. Using Provisioning, you can choose to store your dashboard JSON files in either GitHub repositories using Git Sync or a local file path.
For more information, refer to the [Dashboards](https://grafana.com/docs/grafana/<GRAFANA_VERSION>/dashboards/) documentation. For more information, refer to the [Dashboards](https://grafana.com/docs/grafana/<GRAFANA_VERSION>/dashboards/) documentation.
docs/sources/observability-as-code/provision-resources/use-git-sync.md
-9
View File
@@ -18,15 +18,6 @@ weight: 400
# Manage provisioned repositories with Git Sync # 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. 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. If you push a change in the repository, those changes are mirrored in your Grafana instance.