[release-12.2.2] Docs: Consolidate OaC intros (#114025)
Docs: Consolidate OaC intros (#113895)
* Consolidate
* Edits
* Remove Get started
* Prettier
* Edit
* Removing Grizzly
* Prettier
(cherry picked from commit 2dfcaf9be8)
Co-authored-by: Anna Urbiztondo <anna.urbiztondo@grafana.com>
This commit is contained in:
grafana-delivery-bot[bot]
committed by
GitHub
GitHub
parent
33c4e40634
commit
c9f6582cb6
@@ -110,39 +110,6 @@ The Grafana Operator is particularly fitting for:
|
||||
|
||||
While the Grafana Operator simplifies many aspects of operating Grafana and its resources on Kubernetes, its current support is mainly focused on managing dashboards, folders, and data sources. Advanced features like alerting and plugins (only works for OSS) are not supported yet.
|
||||
|
||||
## Grizzly
|
||||
|
||||
[Grizzly](https://grafana.github.io/grizzly/) is a command line tool that allows you to manage your observability resources with code. Grizzly supports Kubernetes-inspired YAML representation for the Grafana resource, which makes it easier to learn. With Grizzly, you can move dashboards within Grafana instances and also retrieve information about already provisioned Grafana resources. Grizzly currently supports:
|
||||
|
||||
- Grafana dashboards and dashboard folders
|
||||
- Grafana data sources
|
||||
- Prometheus recording rules and alerts in Grafana Cloud
|
||||
- Grafana Cloud Synthetic Monitoring checks
|
||||
|
||||
Grizzly can also deploy dashboards built in Jsonnet using Grafonnet. (Learn more in the [Grafonnet documentation](https://grafana.github.io/grafonnet-lib/api-docs/).)
|
||||
|
||||
The following example shows a Kubernetes-style Grizzly configuration for creating a dashboard:
|
||||
|
||||
```yaml
|
||||
apiVersion: grizzly.grafana.com/v1alpha1
|
||||
kind: Dashboard
|
||||
metadata:
|
||||
name: as-code-dashboard
|
||||
spec:
|
||||
title: as-code dashboard
|
||||
uid: ascode
|
||||
```
|
||||
|
||||
To get started, see the [Grizzly guides](grizzly/dashboards-folders-datasources/) or refer to the [Grizzly’s documentation](https://grafana.github.io/grizzly/).
|
||||
|
||||
### Who is this recommended for?
|
||||
|
||||
Grizzly is best suited for users who are either using Jsonnet to manage Grafana resources or those who prefer a Kubernetes-style YAML definition of their Grafana resources.
|
||||
|
||||
### Known limitations
|
||||
|
||||
Grizzly currently doesn’t support Grafana OnCall and Grafana Alerting resources.
|
||||
|
||||
## Grafana Crossplane provider
|
||||
|
||||
[Grafana Crossplane provider](https://github.com/grafana/crossplane-provider-grafana) is built using Terrajet and provides support for all resources supported by the Grafana Terraform provider. It enables users to define Grafana resources as Kubernetes manifests and it also help users who build their GitOps pipelines around Kubernetes manifests using tools like ArgoCD.
|
||||
|
||||
@@ -12,22 +12,22 @@ canonical: https://grafana.com/docs/grafana/latest/as-code/infrastructure-as-cod
|
||||
|
||||
# Grafana Operator
|
||||
|
||||
[Grafana Operator](https://grafana.github.io/grafana-operator/) is a Kubernetes operator built to help you manage your Grafana instances and its resources from within Kubernetes. The Operator can install and manage local Grafana instances, Dashboards and Datasources through Kubernetes/OpenShift Custom resources. The Grafana Operator Automatically syncs the Kubernetes Custom resources and the actual resources in the Grafana Instance.
|
||||
The [Grafana Operator](https://grafana.github.io/grafana-operator/) is a Kubernetes operator built to help you manage your Grafana instances and its resources in a Kubernetes environment. The Grafana Operator automatically syncs Kubernetes custom resources and actual resources in your Grafana instance, and allows you to install and manage local Grafana instances, dashboards and data sources in Kubernetes or OpenShift.
|
||||
|
||||
## Installing the Grafana Operator
|
||||
## Install the Grafana Operator
|
||||
|
||||
To install the Grafana Operator in your Kubernetes cluster, Run the following command in your terminal:
|
||||
To install the Grafana Operator in your Kubernetes cluster, run the following command in your terminal:
|
||||
|
||||
```
|
||||
helm repo add grafana https://grafana.github.io/helm-charts
|
||||
helm upgrade -i grafana-operator grafana/grafana-operator
|
||||
```
|
||||
|
||||
For other installation methods, Refer [Grafana Operator Installation Documentation](https://grafana.github.io/grafana-operator/docs/installation/).
|
||||
For other installation methods, refer to the [Grafana Operator Installation](https://grafana.github.io/grafana-operator/docs/installation/) documentation.
|
||||
|
||||
## Getting Started
|
||||
## Use the Grafana Operator
|
||||
|
||||
Use the following guide to get started with using Grafana Operator to manage your Grafana instance:
|
||||
Use the following guides to use the Grafana Operator to manage your Grafana instance:
|
||||
|
||||
- [Manage data sources, and dashboards with folders using the Grafana Operator](operator-dashboards-folders-datasources/) describes how to add a folders, data sources, and dashboards, using the [Grafana Operator](https://grafana.github.io/grafana-operator/).
|
||||
- [Manage Dashboards with GitOps Using ArgoCD](manage-dashboards-argocd/) describes how to create and manage dashboards using ArgoCD and [Grafana Operator](https://grafana.github.io/grafana-operator/).
|
||||
|
||||
@@ -5,10 +5,12 @@ keywords:
|
||||
- Grafana Cloud
|
||||
- Grizzly
|
||||
- CLI
|
||||
menuTitle: Grizzly
|
||||
menuTitle: Grizzly (deprecated)
|
||||
title: Grizzly
|
||||
weight: 130
|
||||
weight: 200
|
||||
canonical: https://grafana.com/docs/grafana/latest/as-code/infrastructure-as-code/grizzly/
|
||||
aliases:
|
||||
- ../infrastructure-as-code/grizzly/dashboards-folders-datasources
|
||||
---
|
||||
|
||||
# Grizzly (deprecated)
|
||||
@@ -18,5 +20,3 @@ Grizzly has been removed. It is no longer deployed, enhanced, or supported.
|
||||
|
||||
Use the [Grafana CLI](/docs/grafana/<GRAFANA_VERSION>/observability-as-code/grafana-cli/) instead.
|
||||
{{< /admonition >}}
|
||||
|
||||
[Grizzly](https://grafana.github.io/grizzly/) is a command line tool that allows you to manage your observability resources with code. You can use it to manage dashboards, data sources, Prometheus rules, and Synthetic monitoring.
|
||||
|
||||
-149
@@ -1,149 +0,0 @@
|
||||
---
|
||||
keywords:
|
||||
- Infrastructure as Code
|
||||
- Quickstart
|
||||
- Grafana Cloud
|
||||
- Grizzly
|
||||
title: Creating and managing folders, data sources, and dashboards using Grizzly
|
||||
weight: 100
|
||||
canonical: https://grafana.com/docs/grafana/latest/as-code/infrastructure-as-code/grizzly/dashboards-folders-datasources/
|
||||
---
|
||||
|
||||
# Creating and managing folders, data sources, and dashboards using Grizzly
|
||||
|
||||
Learn how to add a data sources, folders and dashboard, using Grizzly.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Before you begin, you should have the following available:
|
||||
|
||||
- A Grafana Cloud account
|
||||
- An existing Grafana Cloud stack with a Grafana API Key
|
||||
- [Grizzly](https://grafana.github.io/grizzly/installation/) installed on your machine
|
||||
|
||||
## Authentication Setup
|
||||
|
||||
To authenticate with the Grizzly API, you must create environment variables. Run the following commands to create environment variables named `GRAFANA_URL` and `GRAFANA_TOKEN`:
|
||||
|
||||
```shell
|
||||
export GRAFANA_URL=<Grafana-instance-url>
|
||||
export GRAFANA_TOKEN=<Grafana-API-Key>
|
||||
```
|
||||
|
||||
Replace the following field values:
|
||||
|
||||
- `<Grafana-instance-url>` with the URL of your Grafana instance.
|
||||
- `<Grafana-API-Key>` with API key from the Grafana instance.
|
||||
|
||||
## Add a data source
|
||||
|
||||
The following steps use the InfluxDB data source. The required arguments vary depending on the data source you select.
|
||||
|
||||
1. Create a file named `data-source.yml` and add the following:
|
||||
|
||||
```yaml
|
||||
apiVersion: grizzly.grafana.com/v1alpha1
|
||||
kind: Datasource
|
||||
metadata:
|
||||
name: <data-source-name>
|
||||
spec:
|
||||
name: <data-source-name>
|
||||
type: influxdb
|
||||
url: <data-source-url>
|
||||
database: <db-name>
|
||||
user: <username>
|
||||
secureJsonData:
|
||||
password: '<password>'
|
||||
uid: <uid>
|
||||
id: <id>
|
||||
access: proxy
|
||||
```
|
||||
|
||||
1. Replace the following field values:
|
||||
- `<data-source-name>` with the name of the data source to be added in Grafana.
|
||||
- `<data-source-url>` with URL of your data source.
|
||||
- `<username>` with the username for authenticating with your data source.
|
||||
- `<password>` with the password for authenticating with your data source.
|
||||
- `<db-name>` with name of your database.
|
||||
- `<id>` with the ID for your data source in Grafana.
|
||||
- `<uid>` wth the UID for your data source in Grafana.
|
||||
|
||||
## Add a folder
|
||||
|
||||
The following YAML definition creates a folder in your Grafana instance.
|
||||
|
||||
1. Create a file named `folder.yml` and add the following:
|
||||
|
||||
```yaml
|
||||
apiVersion: grizzly.grafana.com/v1alpha1
|
||||
kind: DashboardFolder
|
||||
metadata:
|
||||
name: <folder-name>
|
||||
spec:
|
||||
title: <folder-name>
|
||||
uid: <uid>
|
||||
```
|
||||
|
||||
1. Replace the following field values:
|
||||
- `<folder-name>` with the name of the folder to be added in Grafana.
|
||||
- `<uid>` with the UID for your folder in Grafana.
|
||||
|
||||
## Add a dashboard to the folder
|
||||
|
||||
Use the following YAML definition to create a simple dashboard in the Grafana instance folder from the previous step. To add more than a title and UID to the dashboard, you can convert your dashboard JSON config to YAML and paste it under `spec`.
|
||||
|
||||
1. Create a file named `dashboard.yml` and add the following:
|
||||
|
||||
```yaml
|
||||
apiVersion: grizzly.grafana.com/v1alpha1
|
||||
kind: Dashboard
|
||||
metadata:
|
||||
folder: <folder-name>
|
||||
name: influxdb-cloud-demos
|
||||
spec:
|
||||
title: InfluxDB Cloud Demos
|
||||
uid: influxdb-cloud-demos
|
||||
```
|
||||
|
||||
1. Replace the following field values:
|
||||
- `<folder-name>` with the name of the folder created in the previous step.
|
||||
|
||||
## Using Grizzly CLI
|
||||
|
||||
In a terminal, run the following commands from the directory where all of the YAML definitions are located.
|
||||
|
||||
1. Add the data source.
|
||||
|
||||
```shell
|
||||
grr apply data-source.yml
|
||||
```
|
||||
|
||||
1. Add a folder.
|
||||
|
||||
```shell
|
||||
grr apply folder.yml
|
||||
```
|
||||
|
||||
1. Add a dashboard to the folder.
|
||||
|
||||
```shell
|
||||
grr apply dashboard.yml
|
||||
```
|
||||
|
||||
## Validation
|
||||
|
||||
Once you apply the configurations using the Grizzly CLI, you should be able to verify the following:
|
||||
|
||||
- A new data source (InfluxDB in this example) is visible in Grafana.
|
||||
|
||||
|
||||
|
||||
- A new dashboard and folder in Grafana. In the following image a dashboard named `InfluxDB Cloud Demos` was created inside the `Demos` folder.
|
||||
|
||||
|
||||
|
||||
## Conclusion
|
||||
|
||||
In this guide, you created a data source, folder, and dashboard using Grizzly.
|
||||
|
||||
To learn more about managing Grafana using Grizzly, see the [Grizzly documentation](https://grafana.github.io/grizzly/).
|
||||
Reference in New Issue
Block a user