This terraform provider allows you to interact with grafana mimir.
Currently only these components could be managed with the api:
Example:
provider "mimir" {
ruler_uri = "http://localhost:8080/prometheus"
alertmanager_uri = "http://localhost:8080"
org_id = "mytenant"
}
- ruler_uri (default prefix: /prometheus)
- alertmanager_uri (default prefix: /)
Warning You may check and adapt provider uri path:
ruler_uri
andalertmanager_uri
.
Grafana Mimir have no authentication support, so this is delegated to a reverse proxy.
See Grafana Mimir authentication and authorization
The provider support basic auth, token.
provider "mimir" {
ruler_uri = "http://localhost:8080/prometheus"
alertmanager_uri = "http://localhost:8080"
org_id = "mytenant"
username = "user"
password = "password"
}
provider "mimir" {
ruler_uri = "http://localhost:8080/prometheus"
alertmanager_uri = "http://localhost:8080"
org_id = "mytenant"
token = "supersecrettoken"
}
provider "mimir" {
ruler_uri = "http://localhost:8080/prometheus"
alertmanager_uri = "http://localhost:8080"
org_id = "mytenant"
header = {
"Custom-Auth" = "Custom value"
}
}
Example:
resource "mimir_rule_group_alerting" "test" {
name = "test1"
namespace = "namespace1"
rule {
alert = "HighRequestLatency"
expr = "job:request_latency_seconds:mean5m{job=\"myjob\"} > 0.5"
for = "10m"
labels = {
severity = "warning"
}
annotations = {
summary = "High request latency"
}
}
}
Example:
resource "mimir_rule_group_recording" "record" {
name = "test1"
namespace = "namespace1"
interval = "6h"
query_offset = "5m"
rule {
expr = "sum by (job) (http_inprogress_requests)"
record = "job:http_inprogress_requests:sum"
}
}
Notification integrations Supported: https://prometheus.io/docs/alerting/latest/configuration/#receiver
Example:
resource "mimir_alertmanager_config" "test" {
route {
group_by = ["..."]
group_wait = "30s"
group_interval = "5m"
repeat_interval = "1h"
receiver = "pagerduty"
child_route {
group_by = ["..."]
group_wait = "30s"
group_interval = "5m"
repeat_interval = "1h"
receiver = "pagerduty"
}
}
receiver {
name = "pagerduty"
pagerduty_configs {
routing_key = "secret"
severity = "info"
details = {
environment = "test"
platform = "sandbox"
}
}
}
}
This provider supports importing existing resources into the terraform state. Import is done according to the various provider/resource configuation settings to contact the API server and obtain data.
To import mimir rule group alerting
The id is build as <namespace>/<name>
Example:
terraform import 'mimir_rule_group_alerting.alert1' namespace1/alert1
mimir_rule_group_alerting.alert1: Importing from ID "namespace1/alert1"...
mimir_rule_group_alerting.alert1: Import prepared!
Prepared mimir_rule_group_alerting for import
mimir_rule_group_alerting.alert1: Refreshing state... [id=namespace1/alert1]
Import successful!
The resources that were imported are shown above. These resources are now in
your Terraform state and will henceforth be managed by Terraform.
To import mimir rule group recording
The id is build as <namespace>/<name>
Example:
terraform import 'mimir_rule_group_recording.record1' namespace1/record1
mimir_rule_group_recording.record1: Importing from ID "namespace1/record1"...
mimir_rule_group_recording.record1: Import prepared!
Prepared mimir_rule_group_recording for import
mimir_rule_group_recording.record1: Refreshing state... [id=namespace1/record1]
Import successful!
The resources that were imported are shown above. These resources are now in
your Terraform state and will henceforth be managed by Terraform.
To import mimir alertmanager config
The id is build as <org_id>
Example:
terraform import 'mimir_alertmanager_config.test' test
mimir_alertmanager_config.test: Importing from ID "test"...
mimir_alertmanager_config.test: Import prepared!
Prepared mimir_alertmanager_config for import
mimir_alertmanager_config.test: Refreshing state... [id=test]
Import successful!
The resources that were imported are shown above. These resources are now in
your Terraform state and will henceforth be managed by Terraform.
Pull requests are always welcome! Please be sure the following things are taken care of with your pull request:
go fmt
is run before pushing- Be sure to add a test case for new functionality (or explain why this cannot be done)