Terraform Grafana example

Looking for building your own example?

If you're a learning-by-doing kind of person, you can follow the steps below to build your own example.

Pre-requisites

First of all, you need to have these tools up and running before starting:

• Terraform
• Terraform Cloud (to store .tfstate files)
  • Alternatively, you can use any Remote State backend.
  • Please, bear in mind that you should not store .tfstate files locally in your repository.
• Grafana Cloud instance (with a service account token with enough permissions - e.g. admin)

Step by step

1. Create a main.tf file with a main definition:

   terraform {
     required_providers {
       schemas = {
         source  = "grafana/schemas"
         version = "0.2.0"
       }
   
       grafana = {
         source  = "grafana/grafana"
         version = "2.1.0"
       }
     }
   }
   
   provider "grafana" {
     url  = var.GRAFANA_URL
     auth = var.GRAFANA_TOKEN
   }

2. Create a vars.tf file with the variables' definition (will be read from environment):

   variable "GRAFANA_URL" {
     type        = string
     description = "Fully qualified domain name of your Grafana instance."
   }
   
   variable "GRAFANA_TOKEN" {
     type        = string
     description = "Basic auth password or API token."
   }

3. Initialize a new Terraform working directory:

   terraform init

4. Create a resources.tf file with a basic dashboard and the resource definition:

   data "schemas_core_dashboard" "example" {
     title = "Terraform example"
     description = "Example dashboard built with Terraform"
   }
   
   resource "grafana_dashboard" "example" {
     config_json = data.schemas_core_dashboard.example.rendered_json
   }

5. Set up Grafana and Terraform auth as Actions secrets:

   • GRAFANA_URL with the root url of your instance
   • GRAFANA_TOKEN with your service account token
   • TF_API_TOKEN with your Terraform Cloud API token

   Additionally, you may want to set up the following variables:

   • TF_CLOUD_ORGANIZATION with the id of your Terraform cloud organization
   • TF_WORKSPACE with the id of your Terraform cloud workspace

Contribute

Have you detected a typo or something incorrect, and you are willing to contribute?

Please, open a pull request, and I'll be happy to review it.