Skip to content

Commit 160daf5

Browse files
temblekingtembleking
committed
docs: Add documentation for the new Notification Channel resources
Signed-off-by: Federico Barcelona <[email protected]>
1 parent 1299af3 commit 160daf5

16 files changed

+667
-1
lines changed

‎website/docs/r/sysdig_monitor_notification_channel_email.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
layout: "sysdig"
3+
page_title: "Sysdig: sysdig_monitor_notification_channel_email"
4+
sidebar_current: "docs-sysdig-monitor-notification-channel-email"
5+
description: |-
6+
Creates a Sysdig Monitor Notification Channel of type Email.
7+
---
8+
9+
# sysdig\_monitor\_notification_channel\_email
10+
11+
Creates a Sysdig Monitor Notification Channel of type Email.
12+
13+
~> **Note:** This resource is still experimental, and is subject of being changed.
14+
15+
## Example usage
16+
17+
```hcl
18+
resource "sysdig_monitor_notification_channel_email" "sample_email" {
19+
name = "Example Channel - Email"
20+
recipients = ["[email protected]", "[email protected]"]
21+
enabled = true
22+
notify_when_ok = false
23+
notify_when_resolved = false
24+
send_test_notification = false
25+
}
26+
```
27+
28+
## Argument Reference
29+
30+
* `name` - (Required) The name of the Notification Channel. Must be unique.
31+
32+
* `recipients` - (Required) List of recipients that will receive
33+
the message.
34+
35+
* `enabled` - (Optional) If false, the channel will not emit notifications. Default is true.
36+
37+
* `notify_when_ok` - (Optional) Send a new notification when the alert condition is
38+
no longer triggered. Default is false.
39+
40+
* `notify_when_resolved` - (Optional) Send a new notification when the alert is manually
41+
acknowledged by a user. Default is false.
42+
43+
* `send_test_notification` - (Optional) Send an initial test notification to check
44+
if the notification channel is working. Default is false.

‎website/docs/r/sysdig_monitor_notification_channel_opsgenie.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
layout: "sysdig"
3+
page_title: "Sysdig: sysdig_monitor_notification_channel"
4+
sidebar_current: "docs-sysdig-monitor-notification-channel"
5+
description: |-
6+
Creates a Sysdig Monitor Notification Channel of type OpsGenie.
7+
---
8+
9+
# sysdig\_monitor\_notification\_channel\_opsgenie
10+
11+
Creates a Sysdig Monitor Notification Channel of type OpsGenie.
12+
13+
~> **Note:** This resource is still experimental, and is subject of being changed.
14+
15+
## Example usage
16+
17+
```hcl
18+
resource "sysdig_monitor_notification_channel_opsgenie" "sample-opsgenie" {
19+
name = "Example Channel - OpsGenie"
20+
enabled = true
21+
api_key = "2349324-342354353-5324-23"
22+
notify_when_ok = false
23+
notify_when_resolved = false
24+
}
25+
```
26+
27+
## Argument Reference
28+
29+
* `name` - (Required) The name of the Notification Channel. Must be unique.
30+
31+
* `api_key` - (Required) Key for the API.
32+
33+
* `enabled` - (Optional) If false, the channel will not emit notifications. Default is true.
34+
35+
* `notify_when_ok` - (Optional) Send a new notification when the alert condition is
36+
no longer triggered. Default is false.
37+
38+
* `notify_when_resolved` - (Optional) Send a new notification when the alert is manually
39+
acknowledged by a user. Default is false.
40+
41+
* `send_test_notification` - (Optional) Send an initial test notification to check
42+
if the notification channel is working. Default is false.

‎website/docs/r/sysdig_monitor_notification_channel_pagerduty.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
layout: "sysdig"
3+
page_title: "Sysdig: sysdig_monitor_notification_channel_pagerduty"
4+
sidebar_current: "docs-sysdig-monitor-notification-channel-pagerduty"
5+
description: |-
6+
Creates a Sysdig Monitor Notification Channel of type Pagerduty.
7+
---
8+
9+
# sysdig\_monitor\_notification\_channel\_pagerduty
10+
11+
Creates a Sysdig Monitor Notification Channel of type Pagerduty.
12+
13+
~> **Note:** This resource is still experimental, and is subject of being changed.
14+
15+
## Example usage
16+
17+
```hcl
18+
resource "sysdig_monitor_notification_channel_pagerduty" "sample-pagerduty" {
19+
name = "Example Channel - Pagerduty"
20+
enabled = true
21+
account = "account"
22+
service_key = "XXXXXXXXXX"
23+
service_name = "sysdig"
24+
notify_when_ok = false
25+
notify_when_resolved = false
26+
send_test_notification = false
27+
}
28+
```
29+
30+
## Argument Reference
31+
32+
* `name` - (Required) The name of the Notification Channel. Must be unique.
33+
34+
* `account` - (Required) Pagerduty account.
35+
36+
* `service_key` - (Required) Service Key for the Pagerduty account.
37+
38+
* `service_name` - (Required) Service name for the Pagerduty account.
39+
40+
* `enabled` - (Optional) If false, the channel will not emit notifications. Default is true.
41+
42+
* `notify_when_ok` - (Optional) Send a new notification when the alert condition is
43+
no longer triggered. Default is false.
44+
45+
* `notify_when_resolved` - (Optional) Send a new notification when the alert is manually
46+
acknowledged by a user. Default is false.
47+
48+
* `send_test_notification` - (Optional) Send an initial test notification to check
49+
if the notification channel is working. Default is false.

‎website/docs/r/sysdig_monitor_notification_channel_slack.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
layout: "sysdig"
3+
page_title: "Sysdig: sysdig_monitor_notification_channel_slack"
4+
sidebar_current: "docs-sysdig-monitor-notification-channel-slack"
5+
description: |-
6+
Creates a Sysdig Monitor Notification Channel of type Slack.
7+
---
8+
9+
# sysdig\_monitor\_notification\_channel\_slack
10+
11+
Creates a Sysdig Monitor Notification Channel of type Slack.
12+
13+
~> **Note:** This resource is still experimental, and is subject of being changed.
14+
15+
## Example usage
16+
17+
```hcl
18+
resource "sysdig_monitor_notification_channel_slack" "sample-slack" {
19+
name = "Example Channel - Slack"
20+
enabled = true
21+
url = "https://hooks.slack.cwom/services/XXXXXXXXX/XXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXX"
22+
channel = "#sysdig"
23+
notify_when_ok = false
24+
notify_when_resolved = false
25+
}
26+
```
27+
28+
## Argument Reference
29+
30+
* `name` - (Required) The name of the Notification Channel. Must be unique.
31+
32+
* `url` - (Required) URL of the Slack.
33+
34+
* `channel` - (Required) Channel name from this Slack.
35+
36+
* `enabled` - (Optional) If false, the channel will not emit notifications. Default is true.
37+
38+
* `notify_when_ok` - (Optional) Send a new notification when the alert condition is
39+
no longer triggered. Default is false.
40+
41+
* `notify_when_resolved` - (Optional) Send a new notification when the alert is manually
42+
acknowledged by a user. Default is false.
43+
44+
* `send_test_notification` - (Optional) Send an initial test notification to check
45+
if the notification channel is working. Default is false.

‎website/docs/r/sysdig_monitor_notification_channel_sns.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
layout: "sysdig"
3+
page_title: "Sysdig: sysdig_monitor_notification_channel_sns"
4+
sidebar_current: "docs-sysdig-monitor-notification-channel-sns"
5+
description: |-
6+
Creates a Sysdig Monitor Notification Channel of type Amazon SNS.
7+
---
8+
9+
# sysdig\_monitor\_notification\_channel\_sns
10+
11+
Creates a Sysdig Monitor Notification Channel of type Amazon SNS.
12+
13+
~> **Note:** This resource is still experimental, and is subject of being changed.
14+
15+
## Example usage
16+
17+
```hcl
18+
resource "sysdig_monitor_notification_channel_sns" "sample-amazon-sns" {
19+
name = "Example Channel - Amazon SNS"
20+
enabled = true
21+
topics = ["arn:aws:sns:us-east-1:273489009834:my-alerts2", "arn:aws:sns:us-east-1:279948934544:my-alerts"]
22+
notify_when_ok = false
23+
notify_when_resolved = false
24+
send_test_notification = false
25+
}
26+
```
27+
28+
## Argument Reference
29+
30+
* `name` - (Required) The name of the Notification Channel. Must be unique.
31+
32+
* `topics` - (Required) List of ARNs from the SNS topics.
33+
34+
* `enabled` - (Optional) If false, the channel will not emit notifications. Default is true.
35+
36+
* `notify_when_ok` - (Optional) Send a new notification when the alert condition is
37+
no longer triggered. Default is false.
38+
39+
* `notify_when_resolved` - (Optional) Send a new notification when the alert is manually
40+
acknowledged by a user. Default is false.
41+
42+
* `send_test_notification` - (Optional) Send an initial test notification to check
43+
if the notification channel is working. Default is false.

‎website/docs/r/sysdig_monitor_notification_channel_victorops.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
layout: "sysdig"
3+
page_title: "Sysdig: sysdig_monitor_notification_channel_victorops"
4+
sidebar_current: "docs-sysdig-monitor-notification-channel-victorops"
5+
description: |-
6+
Creates a Sysdig Monitor Notification Channel of type VictorOps.
7+
---
8+
9+
# sysdig\_monitor\_notification\_channel\_victorops
10+
11+
Creates a Sysdig Monitor Notification Channel of type VictorOps.
12+
13+
~> **Note:** This resource is still experimental, and is subject of being changed.
14+
15+
## Example usage
16+
17+
```hcl
18+
resource "sysdig_monitor_notification_channel_victorops" "sample-victorops" {
19+
name = "Example Channel - VictorOps"
20+
enabled = true
21+
api_key = "1234342-4234243-4234-2"
22+
routing_key = "My team"
23+
notify_when_ok = false
24+
notify_when_resolved = false
25+
send_test_notification = false
26+
}
27+
```
28+
29+
## Argument Reference
30+
31+
* `name` - (Required) The name of the Notification Channel. Must be unique.
32+
33+
* `api_key` - (Required) Key for the API.
34+
35+
* `routing_key` - (Required) Routing key for VictorOps.
36+
37+
* `enabled` - (Optional) If false, the channel will not emit notifications. Default is true.
38+
39+
* `notify_when_ok` - (Optional) Send a new notification when the alert condition is
40+
no longer triggered. Default is false.
41+
42+
* `notify_when_resolved` - (Optional) Send a new notification when the alert is manually
43+
acknowledged by a user. Default is false.
44+
45+
* `send_test_notification` - (Optional) Send an initial test notification to check
46+
if the notification channel is working. Default is false.

‎website/docs/r/sysdig_monitor_notification_channel_webhook.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
layout: "sysdig"
3+
page_title: "Sysdig: sysdig_monitor_notification_channel_webhook"
4+
sidebar_current: "docs-sysdig-monitor-notification-channel-webhook"
5+
description: |-
6+
Creates a Sysdig Monitor Notification Channel of type Webhook.
7+
---
8+
9+
# sysdig\_monitor\_notification\_channel\_webhook
10+
11+
Creates a Sysdig Monitor Notification Channel of type Webhook.
12+
13+
~> **Note:** This resource is still experimental, and is subject of being changed.
14+
15+
## Example usage
16+
17+
```hcl
18+
resource "sysdig_monitor_notification_channel_webhook" "sample-webhook" {
19+
name = "Example Channel - Webhook"
20+
enabled = true
21+
url = "localhost:8080"
22+
notify_when_ok = false
23+
notify_when_resolved = false
24+
send_test_notification = false
25+
}
26+
```
27+
28+
## Argument Reference
29+
30+
* `name` - (Required) The name of the Notification Channel. Must be unique.
31+
32+
* `url` - (Required) URL to send the event.
33+
34+
* `enabled` - (Optional) If false, the channel will not emit notifications. Default is true.
35+
36+
* `notify_when_ok` - (Optional) Send a new notification when the alert condition is
37+
no longer triggered. Default is false.
38+
39+
* `notify_when_resolved` - (Optional) Send a new notification when the alert is manually
40+
acknowledged by a user. Default is false.
41+
42+
* `send_test_notification` - (Optional) Send an initial test notification to check
43+
if the notification channel is working. Default is false.

‎website/docs/r/sysdig_secure_notification_channel.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ description: |-
1010

1111
Creates a Sysdig Secure Notification Channel.
1212

13-
~> **Note:** This resource is still experimental, and is subject of being changed.
13+
!> **Warning:** This resource is deprecated and will be removed. Please use the different `sysdig_secure_notification_channel_*` resources.
1414

1515
## Example usage
1616

‎website/docs/r/sysdig_secure_notification_channel_email.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
layout: "sysdig"
3+
page_title: "Sysdig: sysdig_secure_notification_channel_email"
4+
sidebar_current: "docs-sysdig-secure-notification-channel-email"
5+
description: |-
6+
Creates a Sysdig Secure Notification Channel of type Email.
7+
---
8+
9+
# sysdig\_secure\_notification_channel\_email
10+
11+
Creates a Sysdig Secure Notification Channel of type Email.
12+
13+
~> **Note:** This resource is still experimental, and is subject of being changed.
14+
15+
## Example usage
16+
17+
```hcl
18+
resource "sysdig_secure_notification_channel_email" "sample_email" {
19+
name = "Example Channel - Email"
20+
recipients = ["[email protected]", "[email protected]"]
21+
enabled = true
22+
notify_when_ok = false
23+
notify_when_resolved = false
24+
send_test_notification = false
25+
}
26+
```
27+
28+
## Argument Reference
29+
30+
* `name` - (Required) The name of the Notification Channel. Must be unique.
31+
32+
* `recipients` - (Required) List of recipients that will receive
33+
the message.
34+
35+
* `enabled` - (Optional) If false, the channel will not emit notifications. Default is true.
36+
37+
* `notify_when_ok` - (Optional) Send a new notification when the alert condition is
38+
no longer triggered. Default is false.
39+
40+
* `notify_when_resolved` - (Optional) Send a new notification when the alert is manually
41+
acknowledged by a user. Default is false.
42+
43+
* `send_test_notification` - (Optional) Send an initial test notification to check
44+
if the notification channel is working. Default is false.

0 commit comments

Comments
 (0)