Skip to content

Commit

Permalink
docs: correct references to destinations, workflows in legacy resourc…
Browse files Browse the repository at this point in the history
…es and more (#2685)
  • Loading branch information
shashank-reddy-nr authored Jun 10, 2024
1 parent b4828a8 commit a471600
Show file tree
Hide file tree
Showing 5 changed files with 23 additions and 3 deletions.
2 changes: 1 addition & 1 deletion website/docs/r/alert_channel.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ description: |-

Use this resource to create and manage New Relic alert channels.

-> **WARNING:** The `newrelic_alert_channel` resource is deprecated and will be removed in the next major release. For managing channel resources in Workflows, use [`newrelic_notification_channel`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/resources/notification_channel).
-> **WARNING:** The `newrelic_alert_channel` resource is **deprecated** and will be **removed in a future major release**. As an alternative, you can set up channels using a combination of the newer resources [`newrelic_notification_destination`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/resources/notification_destination) and [`newrelic_notification_channel`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/resources/notification_channel). We **strongly recommend** migrating to these new resources at the earliest. Please refer to [this example](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/guides/getting_started#add-a-notification-channel) for a detailed illustration on setting up channels with these resources.

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/alert_policy_channel.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ description: |-

Use this resource to map alert policies to alert channels in New Relic.

-> **WARNING:** The `newrelic_alert_policy_channel` resource is deprecated and will be removed in the next major release. For managing channel resources in Workflows, use [`newrelic_notification_channel`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/resources/notification_channel).
-> **WARNING:** The `newrelic_alert_policy_channel` resource is **deprecated** and will be **removed in a future major release**. As an alternative, you can map channels to policies using the resource [`newrelic_workflow`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/resources/workflow), with the channels to be mapped created using a combination of the newer resources [`newrelic_notification_destination`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/resources/notification_destination) and [`newrelic_notification_channel`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/resources/notification_channel). We **strongly recommend** migrating to these new resources at the earliest. Please refer to [this example](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/guides/getting_started#add-a-notification-channel) for a detailed illustration on setting up channels and workflows with these resources.

## Example Usage

Expand Down
6 changes: 5 additions & 1 deletion website/docs/r/notification_channel.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -349,5 +349,9 @@ That being said, importing is possible using -

## Additional Information
More details about the channels API can be found [here](https://docs.newrelic.com/docs/apis/nerdgraph/examples/nerdgraph-api-notifications-channels).
### Moving from Legacy Alert Channels to Notification Channels
As described in the documentation of this resource, channels can be created and managed using [`newrelic_notification_destination`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/resources/notification_destination) and [`newrelic_notification_channel`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/resources/notification_channel). A combination of these resources is an alternative to the legacy resource [`newrelic_alert_channel`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/resources/alert_channel), which is **deprecated** and will be **removed in a future major release**, as stated in the documentation of the resource.

~> **NOTE:** [`newrelic_alert_channel`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/resources/alert_channel) and [`newrelic_alert_policy_channel`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/resources/alert_policy_channel) are legacy resources.
If you're currently using `newrelic_alert_channel` to manage channels, we **strongly recommend** migrating to these notifications-based resources at the earliest.

Please refer to the examples in this page, or [this example](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/guides/getting_started#add-a-notification-channel) for illustrations on setting up channels with these resources.
7 changes: 7 additions & 0 deletions website/docs/r/notification_destination.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -292,3 +292,10 @@ resource "newrelic_notification_destination" "foo" {
## Additional Information
More information about destinations integrations can be found in NewRelic [documentation](https://docs.newrelic.com/docs/alerts-applied-intelligence/notifications/notification-integrations/).
More details about the destinations API can be found [here](https://docs.newrelic.com/docs/apis/nerdgraph/examples/nerdgraph-api-notifications-destinations).

### Moving from Legacy Alert Channels to Notification Channels
As stated in the documentation of this resource and [`newrelic_notification_channel`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/resources/notification_channel), destinations, created using the resource [`newrelic_notification_destination`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/resources/notification_destination) can be paired with [`newrelic_notification_channel`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/resources/notification_channel) to set up channels. These resources combined, are an alternative to the legacy resource [`newrelic_alert_channel`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/resources/alert_channel), which is **deprecated** and will be **removed in a future major release**, as stated in the documentation of the resource.

If you're currently using `newrelic_alert_channel` to manage channels, we **strongly recommend** migrating to these notifications-based resources at the earliest.

Please refer to the examples in this page, or [this example](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/guides/getting_started#add-a-notification-channel) for illustrations on setting up channels with these resources.
9 changes: 9 additions & 0 deletions website/docs/r/workflow.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -334,6 +334,15 @@ resource "newrelic_workflow" "workflow-example" {
## Additional Information
More details about the workflows can be found [here](https://docs.newrelic.com/docs/alerts-applied-intelligence/applied-intelligence/incident-workflows/incident-workflows/).

### Moving from Legacy Alert Policy Channels to Workflows
As described in the documentation of this resource, mapping alert channels (created using [`newrelic_notification_destination`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/resources/notification_destination) and [`newrelic_notification_channel`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/resources/notification_channel)) to policies can be performed using the `newrelic_workflow` resource, which is an alternative to the legacy resource [`newrelic_alert_policy_channel`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/resources/alert_policy_channel) (which consumes alert channels created using the legacy resource [`newrelic_alert_channel`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/resources/alert_channel)).

Both of the legacy resources mentioned above, `newrelic_alert_channel` and `newrelic_alert_policy_channel` are **deprecated** and will be **removed in a future major release**, as stated in the documentation of both of these resources.

If you're currently using `newrelic_alert_channel` and `newrelic_alert_policy_channel` to manage alert channels linked to policies, we **strongly recommend** migrating to these workflows and notifications-based resources at the earliest.

Please refer to the examples in this page, or [this example](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/guides/getting_started#add-a-notification-channel) for illustrations on setting up channels and workflows with these resources.

## v3.3 changes
In version v3.3 we renamed the following arguments:

Expand Down

0 comments on commit a471600

Please sign in to comment.