Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: correct references to destinations, workflows in legacy resources and more #2685

Merged
merged 3 commits into from
Jun 10, 2024
Merged

docs: correct references to destinations, workflows in legacy resources and more #2685

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7e17f42
docs(notifications): updates to references of newer alternatives to d…
shashank-reddy-nr Jun 6, 2024
a3247b1
docs: updated refs doc of deprecating resrcs from PR comments
shashank-reddy-nr Jun 7, 2024
802d025
docs: corrected sentence formation
shashank-reddy-nr Jun 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion website/docs/r/alert_channel.html.markdown
View file
Open in desktop
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 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.
pranav-new-relic marked this conversation as resolved.
Show resolved Hide resolved

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/alert_policy_channel.html.markdown
View file
Open in desktop
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 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.
pranav-new-relic marked this conversation as resolved.
Show resolved Hide resolved

## Example Usage

Expand Down
4 changes: 2 additions & 2 deletions website/docs/r/notification_channel.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <destination_id>```

## 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).
pranav-new-relic marked this conversation as resolved.
Show resolved Hide resolved

~> **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.
pranav-new-relic marked this conversation as resolved.
Show resolved Hide resolved
5 changes: 4 additions & 1 deletion website/docs/r/notification_destination.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
pranav-new-relic marked this conversation as resolved.
Show resolved Hide resolved

pranav-new-relic marked this conversation as resolved.
Show resolved Hide resolved
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.
pranav-new-relic marked this conversation as resolved.
Show resolved Hide resolved
5 changes: 4 additions & 1 deletion website/docs/r/workflow.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/).
pranav-new-relic marked this conversation as resolved.
Show resolved Hide resolved

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.


pranav-new-relic marked this conversation as resolved.
Show resolved Hide resolved
## v3.3 changes
In version v3.3 we renamed the following arguments:

Expand Down
Loading