Add alert pausing (#809)

* Add alert pausing

* update docs

* Add paused to example

* Regenerate docs

* Remove test

* Regenerate docs

* Add field in examples an generate docs

* Change paused to is_paused

Author: Alex Moreno

docs/resources/rule_group.md

@@ -43,6 +43,7 @@ resource "grafana_rule_group" "my_alert_rule" {
       "e" = "f"
       "g" = "h"
     }
+    is_paused = false
     data {
       ref_id     = "A"
       query_type = ""
@@ -136,6 +137,7 @@ Optional:
 - `annotations` (Map of String) Key-value pairs of metadata to attach to the alert rule that may add user-defined context, but cannot be used for matching, grouping, or routing. Defaults to `map[]`.
 - `exec_err_state` (String) Describes what state to enter when the rule's query is invalid and the rule cannot be executed. Options are OK, Error, and Alerting. Defaults to `Alerting`.
 - `for` (String) The amount of time for which the rule must be breached for the rule to be considered to be Firing. Before this time has elapsed, the rule is only considered to be Pending. Defaults to `0`.
+- `is_paused` (Boolean) Sets whether the alert should be paused or not. Defaults to `false`.
 - `labels` (Map of String) Key-value pairs to attach to the alert rule that can be used in matching, grouping, and routing. Defaults to `map[]`.
 - `no_data_state` (String) Describes what state to enter when the rule's query returns No Data. Options are OK, NoData, and Alerting. Defaults to `NoData`.
 

examples/resources/grafana_rule_group/resource.tf

@@ -21,6 +21,7 @@ resource "grafana_rule_group" "my_alert_rule" {
       "e" = "f"
       "g" = "h"
     }
+    is_paused = false
     data {
       ref_id     = "A"
       query_type = ""

go.mod

@@ -5,7 +5,7 @@ go 1.18
 require (
 	github.com/Masterminds/semver/v3 v3.2.0
 	github.com/grafana/amixr-api-go-client v0.0.6
-	github.com/grafana/grafana-api-golang-client v0.18.2
+	github.com/grafana/grafana-api-golang-client v0.18.3
 	github.com/grafana/machine-learning-go-client v0.4.0
 	github.com/grafana/synthetic-monitoring-agent v0.14.1
 	github.com/grafana/synthetic-monitoring-api-go-client v0.7.0

go.sum

@@ -79,6 +79,8 @@ github.com/grafana/amixr-api-go-client v0.0.6 h1:dDKSROgxg2NUuNBeF3L/0cfD9nG815O
 github.com/grafana/amixr-api-go-client v0.0.6/go.mod h1:N6x26XUrM5zGtK5zL5vNJnAn2JFMxLFPPLTw/6pDkFE=
 github.com/grafana/grafana-api-golang-client v0.18.2 h1:WPYT4Cyw0uqBHAyO619HykzNsQ98yHKFmPuJonfiW8c=
 github.com/grafana/grafana-api-golang-client v0.18.2/go.mod h1:24W29gPe9yl0/3A9X624TPkAOR8DpHno490cPwnkv8E=
+github.com/grafana/grafana-api-golang-client v0.18.3 h1:z0AhbGG6suChLb8t2fADpEO9ckPWnweYPYoCW3WpF6k=
+github.com/grafana/grafana-api-golang-client v0.18.3/go.mod h1:24W29gPe9yl0/3A9X624TPkAOR8DpHno490cPwnkv8E=
 github.com/grafana/machine-learning-go-client v0.4.0 h1:UAkJPE7xujzFTm0d9ctbX/FsCID8rqejWjnkRPGNM6E=
 github.com/grafana/machine-learning-go-client v0.4.0/go.mod h1:QFfZz8NkqVF8++skjkKQXJEZfpCYd8S0yTWJUpsLLTA=
 github.com/grafana/synthetic-monitoring-agent v0.14.1 h1:UyTCDTFr2gIJujJrspYR9MHGptdNQrbTM5Td36nDinA=

internal/resources/grafana/resource_alerting_rule_group.go

@@ -168,6 +168,12 @@ This resource requires Grafana 9.1.0 or later.
 								Type: schema.TypeString,
 							},
 						},
+						"is_paused": {
+							Type:        schema.TypeBool,
+							Optional:    true,
+							Default:     false,
+							Description: "Sets whether the alert should be paused or not.",
+						},
 					},
 				},
 			},
@@ -325,6 +331,7 @@ func packAlertRule(r gapi.AlertRule) (interface{}, error) {
 		"labels":         r.Labels,
 		"annotations":    r.Annotations,
 		"data":           data,
+		"is_paused":      r.IsPaused,
 	}
 	return json, nil
 }
@@ -349,6 +356,7 @@ func unpackAlertRule(raw interface{}, groupName string, folderUID string, orgID
 		Condition:    json["condition"].(string),
 		Labels:       unpackMap(json["labels"]),
 		Annotations:  unpackMap(json["annotations"]),
+		IsPaused:     json["is_paused"].(bool),
 	}, nil
 }