Skip to content

Commit fd62e63

Browse files
ppcanoppcano
authored
Alerting: use notification template group naming (#1908)
1 parent 31f247d commit fd62e63

File tree

7 files changed

+34
-34
lines changed

7 files changed

+34
-34
lines changed

‎docs/resources/message_template.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,26 @@
33
page_title: "grafana_message_template Resource - terraform-provider-grafana"
44
subcategory: "Alerting"
55
description: |-
6-
Manages Grafana Alerting message templates.
7-
Official documentation https://grafana.com/docs/grafana/latest/alerting/set-up/provision-alerting-resources/terraform-provisioning/HTTP API https://grafana.com/docs/grafana/latest/developers/http_api/alerting_provisioning/#templates
6+
Manages Grafana Alerting notification template groups, including notification templates.
7+
Official documentation https://grafana.com/docs/grafana/latest/alerting/set-up/provision-alerting-resources/terraform-provisioning/HTTP API https://grafana.com/docs/grafana/latest/developers/http_api/alerting_provisioning/#notification-template-groups
88
This resource requires Grafana 9.1.0 or later.
99
---
1010

1111
# grafana_message_template (Resource)
1212

13-
Manages Grafana Alerting message templates.
13+
Manages Grafana Alerting notification template groups, including notification templates.
1414

1515
* [Official documentation](https://grafana.com/docs/grafana/latest/alerting/set-up/provision-alerting-resources/terraform-provisioning/)
16-
* [HTTP API](https://grafana.com/docs/grafana/latest/developers/http_api/alerting_provisioning/#templates)
16+
* [HTTP API](https://grafana.com/docs/grafana/latest/developers/http_api/alerting_provisioning/#notification-template-groups)
1717

1818
This resource requires Grafana 9.1.0 or later.
1919

2020
## Example Usage
2121

2222
```terraform
2323
resource "grafana_message_template" "my_template" {
24-
name = "My Reusable Template"
25-
template = "{{define \"My Reusable Template\" }}\n template content\n{{ end }}"
24+
name = "My Notification Template Group"
25+
template = "{{define \"custom.message\" }}\n template content\n{{ end }}"
2626
}
2727
```
2828

@@ -31,8 +31,8 @@ resource "grafana_message_template" "my_template" {
3131

3232
### Required
3333

34-
- `name` (String) The name of the message template.
35-
- `template` (String) The content of the message template.
34+
- `name` (String) The name of the notification template group.
35+
- `template` (String) The content of the notification template group.
3636

3737
### Optional
3838

‎examples/resources/grafana_message_template/resource.tf

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
resource "grafana_message_template" "my_template" {
2-
name = "My Reusable Template"
3-
template = "{{define \"My Reusable Template\" }}\n template content\n{{ end }}"
2+
name = "My Notification Template Group"
3+
template = "{{define \"custom.message\" }}\n template content\n{{ end }}"
44
}

‎internal/resources/grafana/resource_alerting_message_template.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ import (
1919
func resourceMessageTemplate() *common.Resource {
2020
schema := &schema.Resource{
2121
Description: `
22-
Manages Grafana Alerting message templates.
22+
Manages Grafana Alerting notification template groups, including notification templates.
2323
2424
* [Official documentation](https://grafana.com/docs/grafana/latest/alerting/set-up/provision-alerting-resources/terraform-provisioning/)
25-
* [HTTP API](https://grafana.com/docs/grafana/latest/developers/http_api/alerting_provisioning/#templates)
25+
* [HTTP API](https://grafana.com/docs/grafana/latest/developers/http_api/alerting_provisioning/#notification-template-groups)
2626
2727
This resource requires Grafana 9.1.0 or later.
2828
`,
@@ -41,12 +41,12 @@ This resource requires Grafana 9.1.0 or later.
4141
Type: schema.TypeString,
4242
Required: true,
4343
ForceNew: true,
44-
Description: "The name of the message template.",
44+
Description: "The name of the notification template group.",
4545
},
4646
"template": {
4747
Type: schema.TypeString,
4848
Required: true,
49-
Description: "The content of the message template.",
49+
Description: "The content of the notification template group.",
5050
StateFunc: func(v interface{}) string {
5151
return strings.TrimSpace(v.(string))
5252
},

‎internal/resources/grafana/resource_alerting_message_template_test.go

+12-12
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ func TestAccMessageTemplate_basic(t *testing.T) {
2525
Config: testutils.TestAccExample(t, "resources/grafana_message_template/resource.tf"),
2626
Check: resource.ComposeTestCheckFunc(
2727
alertingMessageTemplateCheckExists.exists("grafana_message_template.my_template", &tmpl),
28-
resource.TestCheckResourceAttr("grafana_message_template.my_template", "name", "My Reusable Template"),
29-
resource.TestCheckResourceAttr("grafana_message_template.my_template", "template", "{{define \"My Reusable Template\" }}\n template content\n{{ end }}"),
28+
resource.TestCheckResourceAttr("grafana_message_template.my_template", "name", "My Notification Template Group"),
29+
resource.TestCheckResourceAttr("grafana_message_template.my_template", "template", "{{define \"custom.message\" }}\n template content\n{{ end }}"),
3030
testutils.CheckLister("grafana_message_template.my_template"),
3131
),
3232
},
@@ -40,16 +40,16 @@ func TestAccMessageTemplate_basic(t *testing.T) {
4040
// Test update with heredoc template doesn't change
4141
{
4242
Config: testutils.TestAccExampleWithReplace(t, "resources/grafana_message_template/resource.tf", map[string]string{
43-
`template = "{{define \"My Reusable Template\" }}\n template content\n{{ end }}"`: `template = <<-EOT
44-
{{define "My Reusable Template" }}
43+
`template = "{{define \"custom.message\" }}\n template content\n{{ end }}"`: `template = <<-EOT
44+
{{define "custom.message" }}
4545
template content
4646
{{ end }}
4747
EOT`,
4848
}),
4949
Check: resource.ComposeTestCheckFunc(
5050
alertingMessageTemplateCheckExists.exists("grafana_message_template.my_template", &tmpl),
51-
resource.TestCheckResourceAttr("grafana_message_template.my_template", "name", "My Reusable Template"),
52-
resource.TestCheckResourceAttr("grafana_message_template.my_template", "template", "{{define \"My Reusable Template\" }}\n template content\n{{ end }}"),
51+
resource.TestCheckResourceAttr("grafana_message_template.my_template", "name", "My Notification Template Group"),
52+
resource.TestCheckResourceAttr("grafana_message_template.my_template", "template", "{{define \"custom.message\" }}\n template content\n{{ end }}"),
5353
),
5454
},
5555
// Test update content.
@@ -59,20 +59,20 @@ EOT`,
5959
}),
6060
Check: resource.ComposeTestCheckFunc(
6161
alertingMessageTemplateCheckExists.exists("grafana_message_template.my_template", &tmpl),
62-
resource.TestCheckResourceAttr("grafana_message_template.my_template", "name", "My Reusable Template"),
63-
resource.TestCheckResourceAttr("grafana_message_template.my_template", "template", "{{define \"My Reusable Template\" }}\n different content\n{{ end }}"),
62+
resource.TestCheckResourceAttr("grafana_message_template.my_template", "name", "My Notification Template Group"),
63+
resource.TestCheckResourceAttr("grafana_message_template.my_template", "template", "{{define \"custom.message\" }}\n different content\n{{ end }}"),
6464
),
6565
},
6666
// Test rename.
6767
{
6868
Config: testutils.TestAccExampleWithReplace(t, "resources/grafana_message_template/resource.tf", map[string]string{
69-
"My Reusable Template": "A Different Template",
69+
"My Notification Template Group": "A Different Template",
7070
}),
7171
Check: resource.ComposeTestCheckFunc(
7272
alertingMessageTemplateCheckExists.exists("grafana_message_template.my_template", &tmpl),
7373
resource.TestCheckResourceAttr("grafana_message_template.my_template", "name", "A Different Template"),
74-
resource.TestCheckResourceAttr("grafana_message_template.my_template", "template", "{{define \"A Different Template\" }}\n template content\n{{ end }}"),
75-
alertingMessageTemplateCheckExists.destroyed(&models.NotificationTemplate{Name: "My Reusable Template"}, nil),
74+
resource.TestCheckResourceAttr("grafana_message_template.my_template", "template", "{{define \"custom.message\" }}\n template content\n{{ end }}"),
75+
alertingMessageTemplateCheckExists.destroyed(&models.NotificationTemplate{Name: "My Notification Template Group"}, nil),
7676
),
7777
},
7878
},
@@ -128,7 +128,7 @@ func testAccMessageTemplate_inOrg(name string) string {
128128
resource "grafana_message_template" "my_template" {
129129
org_id = grafana_organization.test.id
130130
name = "my-template"
131-
template = "{{define \"My Reusable Template\" }}\n template content\n{{ end }}"
131+
template = "{{define \"custom.message\" }}\n template content\n{{ end }}"
132132
}
133133
`, name)
134134
}

‎pkg/generate/testdata/generate/alerting-in-org.tf

+2-2
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ resource "grafana_mute_timing" "my_mute_timing" {
3535

3636
resource "grafana_message_template" "my_template" {
3737
org_id = grafana_organization.test.id
38-
name = "My Reusable Template"
39-
template = "{{define \"My Reusable Template\" }}\n template content\n{{ end }}"
38+
name = "My Notification Template Group"
39+
template = "{{define \"custom.message\" }}\n template content\n{{ end }}"
4040
}
4141

4242
resource "grafana_folder" "rule_folder" {

‎pkg/generate/testdata/generate/alerting-in-org/imports.tf

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ import {
1919
}
2020

2121
import {
22-
to = grafana_message_template._2_My_Reusable_Template
23-
id = "2:My Reusable Template"
22+
to = grafana_message_template._2_My_Notification_Template_Group
23+
id = "2:My Notification Template Group"
2424
}
2525

2626
import {

‎pkg/generate/testdata/generate/alerting-in-org/resources.tf

+4-4
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,11 @@ resource "grafana_folder" "_2_alert-rule-folder" {
4343
uid = "alert-rule-folder"
4444
}
4545

46-
# __generated__ by Terraform from "2:My Reusable Template"
47-
resource "grafana_message_template" "_2_My_Reusable_Template" {
48-
name = "My Reusable Template"
46+
# __generated__ by Terraform from "2:My Notification Template Group"
47+
resource "grafana_message_template" "_2_My_Notification_Template_Group" {
48+
name = "My Notification Template Group"
4949
org_id = grafana_organization.alerting-org.id
50-
template = "{{define \"My Reusable Template\" }}\n template content\n{{ end }}"
50+
template = "{{define \"custom.message\" }}\n template content\n{{ end }}"
5151
}
5252

5353
# __generated__ by Terraform from "2:My Mute Timing"

0 commit comments

Comments
 (0)