From 7e17f4201cbfb3b94c33de3be73155db296bd769 Mon Sep 17 00:00:00 2001 From: shashank-reddy-nr Date: Thu, 6 Jun 2024 22:34:18 +0530 Subject: [PATCH 1/3] docs(notifications): updates to references of newer alternatives to deprecated resources --- website/docs/r/alert_channel.html.markdown | 2 +- website/docs/r/alert_policy_channel.html.markdown | 2 +- website/docs/r/notification_channel.html.markdown | 4 ++-- website/docs/r/notification_destination.html.markdown | 5 ++++- website/docs/r/workflow.html.markdown | 5 ++++- 5 files changed, 12 insertions(+), 6 deletions(-) diff --git a/website/docs/r/alert_channel.html.markdown b/website/docs/r/alert_channel.html.markdown index a99ddef09..d1f69381c 100644 --- a/website/docs/r/alert_channel.html.markdown +++ b/website/docs/r/alert_channel.html.markdown @@ -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 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) with [`newrelic_notification_destination`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/resources/notification_destination). This [`guide`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/guides/getting_started#add-a-notification-channel) will help you understand how to use the above mentioned new resources together. ## Example Usage diff --git a/website/docs/r/alert_policy_channel.html.markdown b/website/docs/r/alert_policy_channel.html.markdown index f368c92fe..6e78635f0 100644 --- a/website/docs/r/alert_policy_channel.html.markdown +++ b/website/docs/r/alert_policy_channel.html.markdown @@ -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 the next major release. For managing channel resources in Workflows, use [`newrelic_workflow`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/resources/workflow). This [`guide`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/guides/getting_started#add-a-notification-channel) will help you understand how to use the above mentioned new resource. ## Example Usage diff --git a/website/docs/r/notification_channel.html.markdown b/website/docs/r/notification_channel.html.markdown index 1a3440979..3ebf695a9 100644 --- a/website/docs/r/notification_channel.html.markdown +++ b/website/docs/r/notification_channel.html.markdown @@ -347,7 +347,7 @@ Additionally, the channel id isn't available via the UI, and you'd need to look That being said, importing is possible using - ```terraform import newrelic_notification_destination.foo ``` -## Additional Information +## Moving from Legacy Alert Channels to Notification Channels More details about the channels API can be found [here](https://docs.newrelic.com/docs/apis/nerdgraph/examples/nerdgraph-api-notifications-channels). -~> **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. +The [`newrelic_alert_channel`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/resources/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) with [`newrelic_notification_destination`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/resources/notification_destination). This [`guide`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/guides/getting_started#add-a-notification-channel) will help you understand how to use the above mentioned new resources together. diff --git a/website/docs/r/notification_destination.html.markdown b/website/docs/r/notification_destination.html.markdown index ae712e297..0de914b18 100644 --- a/website/docs/r/notification_destination.html.markdown +++ b/website/docs/r/notification_destination.html.markdown @@ -289,6 +289,9 @@ resource "newrelic_notification_destination" "foo" { ~> **NOTE:** Sensitive data such as destination API keys, service keys, auth object etc. are not returned from the underlying API for security reasons and may not be set in state when importing. -## Additional Information + +## Moving from Legacy Alert Channels to Notification Channels 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). + +The [`newrelic_alert_channel`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/resources/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) with [`newrelic_notification_destination`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/resources/notification_destination). This [`guide`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/guides/getting_started#add-a-notification-channel) will help you understand how to use the above mentioned new resources together. diff --git a/website/docs/r/workflow.html.markdown b/website/docs/r/workflow.html.markdown index 6e7289040..6657cd8c9 100644 --- a/website/docs/r/workflow.html.markdown +++ b/website/docs/r/workflow.html.markdown @@ -331,9 +331,12 @@ resource "newrelic_workflow" "workflow-example" { } ``` -## Additional Information +## Moving from Legacy Alert Policy Channels to Workflows More details about the workflows can be found [here](https://docs.newrelic.com/docs/alerts-applied-intelligence/applied-intelligence/incident-workflows/incident-workflows/). +The [`newrelic_alert_policy_channel`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/resources/alert_policy_channel) resource is deprecated and will be removed in the next major release. For managing alert policy channel resources in Workflows, use [`newrelic_workflow`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/resources/workflow). This [`guide`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/guides/getting_started#add-a-notification-channel) will help you understand how to use the above mentioned new resource. + + ## v3.3 changes In version v3.3 we renamed the following arguments: From a3247b18102ead150cdf57be121f7ca131a66acb Mon Sep 17 00:00:00 2001 From: shashank-reddy-nr Date: Fri, 7 Jun 2024 15:32:59 +0530 Subject: [PATCH 2/3] docs: updated refs doc of deprecating resrcs from PR comments --- website/docs/r/alert_channel.html.markdown | 2 +- website/docs/r/alert_policy_channel.html.markdown | 2 +- website/docs/r/notification_channel.html.markdown | 8 ++++++-- website/docs/r/notification_destination.html.markdown | 10 +++++++--- website/docs/r/workflow.html.markdown | 8 ++++++-- 5 files changed, 21 insertions(+), 9 deletions(-) diff --git a/website/docs/r/alert_channel.html.markdown b/website/docs/r/alert_channel.html.markdown index d1f69381c..f74765b2a 100644 --- a/website/docs/r/alert_channel.html.markdown +++ b/website/docs/r/alert_channel.html.markdown @@ -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) with [`newrelic_notification_destination`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/resources/notification_destination). This [`guide`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/guides/getting_started#add-a-notification-channel) will help you understand how to use the above mentioned new resources together. +-> **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 diff --git a/website/docs/r/alert_policy_channel.html.markdown b/website/docs/r/alert_policy_channel.html.markdown index 6e78635f0..4c9ce52d9 100644 --- a/website/docs/r/alert_policy_channel.html.markdown +++ b/website/docs/r/alert_policy_channel.html.markdown @@ -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_workflow`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/resources/workflow). This [`guide`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/guides/getting_started#add-a-notification-channel) will help you understand how to use the above mentioned new resource. +-> **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 diff --git a/website/docs/r/notification_channel.html.markdown b/website/docs/r/notification_channel.html.markdown index 3ebf695a9..ca1081095 100644 --- a/website/docs/r/notification_channel.html.markdown +++ b/website/docs/r/notification_channel.html.markdown @@ -347,7 +347,11 @@ Additionally, the channel id isn't available via the UI, and you'd need to look That being said, importing is possible using - ```terraform import newrelic_notification_destination.foo ``` -## Moving from Legacy Alert Channels to Notification Channels +## 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. -The [`newrelic_alert_channel`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/resources/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) with [`newrelic_notification_destination`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/resources/notification_destination). This [`guide`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/guides/getting_started#add-a-notification-channel) will help you understand how to use the above mentioned new resources together. +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. \ No newline at end of file diff --git a/website/docs/r/notification_destination.html.markdown b/website/docs/r/notification_destination.html.markdown index 0de914b18..e7b80d323 100644 --- a/website/docs/r/notification_destination.html.markdown +++ b/website/docs/r/notification_destination.html.markdown @@ -289,9 +289,13 @@ resource "newrelic_notification_destination" "foo" { ~> **NOTE:** Sensitive data such as destination API keys, service keys, auth object etc. are not returned from the underlying API for security reasons and may not be set in state when importing. - -## Moving from Legacy Alert Channels to Notification Channels +## 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). -The [`newrelic_alert_channel`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/resources/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) with [`newrelic_notification_destination`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/resources/notification_destination). This [`guide`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/guides/getting_started#add-a-notification-channel) will help you understand how to use the above mentioned new resources together. +### 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. \ No newline at end of file diff --git a/website/docs/r/workflow.html.markdown b/website/docs/r/workflow.html.markdown index 6657cd8c9..942d444cd 100644 --- a/website/docs/r/workflow.html.markdown +++ b/website/docs/r/workflow.html.markdown @@ -331,11 +331,15 @@ resource "newrelic_workflow" "workflow-example" { } ``` -## Moving from Legacy Alert Policy Channels to Workflows +## 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/). -The [`newrelic_alert_policy_channel`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/resources/alert_policy_channel) resource is deprecated and will be removed in the next major release. For managing alert policy channel resources in Workflows, use [`newrelic_workflow`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/resources/workflow). This [`guide`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/guides/getting_started#add-a-notification-channel) will help you understand how to use the above mentioned new resource. +### 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 resource [`newrelic_alert_channel`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/resources/alert_channel)), both of which 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: From 802d025a1f3dcebb4b62235ae28cd6ad9ae69ca1 Mon Sep 17 00:00:00 2001 From: Pulipelly Shashank Reddy Date: Mon, 10 Jun 2024 15:12:08 +0530 Subject: [PATCH 3/3] docs: corrected sentence formation Co-authored-by: pranav-new-relic <127438038+pranav-new-relic@users.noreply.github.com> --- website/docs/r/workflow.html.markdown | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/website/docs/r/workflow.html.markdown b/website/docs/r/workflow.html.markdown index 942d444cd..f5485927c 100644 --- a/website/docs/r/workflow.html.markdown +++ b/website/docs/r/workflow.html.markdown @@ -335,7 +335,9 @@ resource "newrelic_workflow" "workflow-example" { 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 resource [`newrelic_alert_channel`](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/resources/alert_channel)), both of which are **deprecated** and will be **removed in a future major release**, as stated in the documentation of both of these resources. +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.