Skip to content

Commit

Permalink
Document version reqs for all alerting resources (#662)
Browse files Browse the repository at this point in the history
  • Loading branch information
alexweav committed Sep 19, 2022
1 parent cb61077 commit 92e798e
Show file tree
Hide file tree
Showing 10 changed files with 38 additions and 3 deletions.
3 changes: 3 additions & 0 deletions docs/resources/contact_point.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ subcategory: "Alerting"
description: |-
Manages Grafana Alerting contact points.
Official documentation https://grafana.com/docs/grafana/next/alerting/contact-pointsHTTP API https://grafana.com/docs/grafana/latest/developers/http_api/alerting_provisioning/#contact-points
This resource requires Grafana 9.1.0 or later.
---

# grafana_contact_point (Resource)
Expand All @@ -14,6 +15,8 @@ Manages Grafana Alerting contact points.
* [Official documentation](https://grafana.com/docs/grafana/next/alerting/contact-points)
* [HTTP API](https://grafana.com/docs/grafana/latest/developers/http_api/alerting_provisioning/#contact-points)

This resource requires Grafana 9.1.0 or later.

## Example Usage

```terraform
Expand Down
6 changes: 6 additions & 0 deletions docs/resources/message_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,20 @@
page_title: "grafana_message_template Resource - terraform-provider-grafana"
subcategory: "Alerting"
description: |-
Manages Grafana Alerting message templates.
Official documentation https://grafana.com/docs/grafana/next/alerting/contact-points/message-templating/HTTP API https://grafana.com/docs/grafana/next/developers/http_api/alerting_provisioning/#templates
This resource requires Grafana 9.1.0 or later.
---

# grafana_message_template (Resource)

Manages Grafana Alerting message templates.

* [Official documentation](https://grafana.com/docs/grafana/next/alerting/contact-points/message-templating/)
* [HTTP API](https://grafana.com/docs/grafana/next/developers/http_api/alerting_provisioning/#templates)

This resource requires Grafana 9.1.0 or later.

## Example Usage

```terraform
Expand Down
6 changes: 6 additions & 0 deletions docs/resources/mute_timing.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,20 @@
page_title: "grafana_mute_timing Resource - terraform-provider-grafana"
subcategory: "Alerting"
description: |-
Manages Grafana Alerting mute timings.
Official documentation https://grafana.com/docs/grafana/next/alerting/notifications/mute-timings/HTTP API https://grafana.com/docs/grafana/next/developers/http_api/alerting_provisioning/#mute-timings
This resource requires Grafana 9.1.0 or later.
---

# grafana_mute_timing (Resource)

Manages Grafana Alerting mute timings.

* [Official documentation](https://grafana.com/docs/grafana/next/alerting/notifications/mute-timings/)
* [HTTP API](https://grafana.com/docs/grafana/next/developers/http_api/alerting_provisioning/#mute-timings)

This resource requires Grafana 9.1.0 or later.

## Example Usage

```terraform
Expand Down
7 changes: 5 additions & 2 deletions docs/resources/notification_policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,19 @@ page_title: "grafana_notification_policy Resource - terraform-provider-grafana"
subcategory: "Alerting"
description: |-
Sets the global notification policy for Grafana. Note that this resource manages the entire notification policy tree, and will overwrite any existing policies.
* Official documentation https://grafana.com/docs/grafana/latest/alerting/notifications/
* HTTP API https://grafana.com/docs/grafana/next/developers/http_api/alerting_provisioning/#notification-policies
Official documentation https://grafana.com/docs/grafana/latest/alerting/notifications/HTTP API https://grafana.com/docs/grafana/next/developers/http_api/alerting_provisioning/#notification-policies
This resource requires Grafana 9.1.0 or later.
---

# grafana_notification_policy (Resource)

Sets the global notification policy for Grafana. Note that this resource manages the entire notification policy tree, and will overwrite any existing policies.

* [Official documentation](https://grafana.com/docs/grafana/latest/alerting/notifications/)
* [HTTP API](https://grafana.com/docs/grafana/next/developers/http_api/alerting_provisioning/#notification-policies)

This resource requires Grafana 9.1.0 or later.

## Example Usage

```terraform
Expand Down
3 changes: 3 additions & 0 deletions docs/resources/rule_group.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ subcategory: "Alerting"
description: |-
Manages Grafana Alerting rule groups.
Official documentation https://grafana.com/docs/grafana/latest/alerting/alerting-rulesHTTP API https://grafana.com/docs/grafana/latest/developers/http_api/alerting_provisioning/#alert-rules
This resource requires Grafana 9.1.0 or later.
---

# grafana_rule_group (Resource)
Expand All @@ -14,6 +15,8 @@ Manages Grafana Alerting rule groups.
* [Official documentation](https://grafana.com/docs/grafana/latest/alerting/alerting-rules)
* [HTTP API](https://grafana.com/docs/grafana/latest/developers/http_api/alerting_provisioning/#alert-rules)

This resource requires Grafana 9.1.0 or later.

## Example Usage

```terraform
Expand Down
2 changes: 2 additions & 0 deletions grafana/resource_alerting_contact_point.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ Manages Grafana Alerting contact points.
* [Official documentation](https://grafana.com/docs/grafana/next/alerting/contact-points)
* [HTTP API](https://grafana.com/docs/grafana/latest/developers/http_api/alerting_provisioning/#contact-points)
This resource requires Grafana 9.1.0 or later.
`,
CreateContext: createContactPoint,
ReadContext: readContactPoint,
Expand Down
4 changes: 4 additions & 0 deletions grafana/resource_alerting_message_template.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,12 @@ import (
func ResourceMessageTemplate() *schema.Resource {
return &schema.Resource{
Description: `
Manages Grafana Alerting message templates.
* [Official documentation](https://grafana.com/docs/grafana/next/alerting/contact-points/message-templating/)
* [HTTP API](https://grafana.com/docs/grafana/next/developers/http_api/alerting_provisioning/#templates)
This resource requires Grafana 9.1.0 or later.
`,
CreateContext: createMessageTemplate,
ReadContext: readMessageTemplate,
Expand Down
6 changes: 5 additions & 1 deletion grafana/resource_alerting_mute_timing.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,13 @@ import (
func ResourceMuteTiming() *schema.Resource {
return &schema.Resource{
Description: `
Manages Grafana Alerting mute timings.
* [Official documentation](https://grafana.com/docs/grafana/next/alerting/notifications/mute-timings/)
* [HTTP API](https://grafana.com/docs/grafana/next/developers/http_api/alerting_provisioning/#mute-timings)
`,
This resource requires Grafana 9.1.0 or later.
`,

CreateContext: createMuteTiming,
ReadContext: readMuteTiming,
Expand Down
3 changes: 3 additions & 0 deletions grafana/resource_alerting_notification_policy.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,11 @@ func ResourceNotificationPolicy() *schema.Resource {
return &schema.Resource{
Description: `
Sets the global notification policy for Grafana. Note that this resource manages the entire notification policy tree, and will overwrite any existing policies.
* [Official documentation](https://grafana.com/docs/grafana/latest/alerting/notifications/)
* [HTTP API](https://grafana.com/docs/grafana/next/developers/http_api/alerting_provisioning/#notification-policies)
This resource requires Grafana 9.1.0 or later.
`,

CreateContext: createNotificationPolicy,
Expand Down
1 change: 1 addition & 0 deletions grafana/resource_alerting_rule_group.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ Manages Grafana Alerting rule groups.
* [Official documentation](https://grafana.com/docs/grafana/latest/alerting/alerting-rules)
* [HTTP API](https://grafana.com/docs/grafana/latest/developers/http_api/alerting_provisioning/#alert-rules)
This resource requires Grafana 9.1.0 or later.
`,
CreateContext: createAlertRuleGroup,
ReadContext: readAlertRuleGroup,
Expand Down

0 comments on commit 92e798e

Please sign in to comment.