Skip to content

Commit e1a2da8

Browse files
authored
docs: Update some resources in the documentation (#99)
* docs: Add `extra_headers` documentation * docs: Add extra docs for attribute reference * docs: Enhance team name field description * fix(ci): Solve problems with webhooks
1 parent 91a7daf commit e1a2da8

24 files changed

+141
-8
lines changed

sysdig/resource_sysdig_monitor_notification_channel_webhook_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ func monitorNotificationChannelWebhookWithName(name string) string {
4444
resource "sysdig_monitor_notification_channel_webhook" "sample-webhook" {
4545
name = "Example Channel %s - Webhook"
4646
enabled = true
47-
url = "localhost:8080"
47+
url = "http://1.1.1.1:8080"
4848
notify_when_ok = false
4949
notify_when_resolved = false
5050
send_test_notification = false

sysdig/resource_sysdig_secure_notification_channel_webhook_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ func secureNotificationChannelWebhookWithName(name string) string {
4545
resource "sysdig_secure_notification_channel_webhook" "sample-webhook" {
4646
name = "Example Channel %s - Webhook"
4747
enabled = true
48-
url = "localhost:8080"
48+
url = "http://1.1.1.1:8080"
4949
notify_when_ok = false
5050
notify_when_resolved = false
5151
send_test_notification = false

website/docs/index.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,18 @@ resource "sysdig_secure_policy" "unexpected_inbound_tcp_connection_traefik" {
3030
}
3131
```
3232

33+
## Example with extra headers
34+
35+
```hcl
36+
provider "sysdig" {
37+
sysdig_monitor_api_token = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
38+
sysdig_secure_api_token = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
39+
extra_headers = {
40+
"Proxy-Authorization": "Basic xxxxxxxxxxxxxxxx"
41+
}
42+
}
43+
```
44+
3345
## Configuration Reference
3446

3547
The following keys can be used to configure the provider.
@@ -63,3 +75,6 @@ The following keys can be used to configure the provider.
6375
the use of invalid HTTPS certificates in the Secure API. It can be useful for
6476
on-prem installations. It can also be sourced from the `SYSDIG_SECURE_INSECURE_TLS`
6577
environment variable. By default this is false.
78+
79+
* `extra_headers` - (Optional) Defines extra HTTP headers that will be added to the client
80+
while performing HTTP API calls.

website/docs/r/sysdig_monitor_alert_anomaly.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ is fired.
7878
In addition to all arguments above, the following attributes are exported, which are common to all the
7979
alerts in Sysdig Monitor:
8080

81+
* `id` - ID of the alert created.
8182
* `version` - Current version of the resource in Sysdig Monitor.
8283
* `team` - Team ID that owns the alert.
8384

website/docs/r/sysdig_monitor_alert_downtime.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ is fired.
7474
In addition to all arguments above, the following attributes are exported, which are common to all the
7575
alerts in Sysdig Monitor:
7676

77+
* `id` - ID of the alert created.
7778
* `version` - Current version of the resource in Sysdig Monitor.
7879
* `team` - Team ID that owns the alert.
7980

website/docs/r/sysdig_monitor_alert_event.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@ is fired.
8383
In addition to all arguments above, the following attributes are exported, which are common to all the
8484
alerts in Sysdig Monitor:
8585

86+
* `id` - ID of the alert created.
8687
* `version` - Current version of the resource in Sysdig Monitor.
8788
* `team` - Team ID that owns the alert.
8889

website/docs/r/sysdig_monitor_alert_group_outlier.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ is fired.
7777
In addition to all arguments above, the following attributes are exported, which are common to all the
7878
alerts in Sysdig Monitor:
7979

80+
* `id` - ID of the alert created.
8081
* `version` - Current version of the resource in Sysdig Monitor.
8182
* `team` - Team ID that owns the alert.
8283

website/docs/r/sysdig_monitor_alert_metric.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ is fired.
8282
In addition to all arguments above, the following attributes are exported, which are common to all the
8383
alerts in Sysdig Monitor:
8484

85+
* `id` - ID of the alert created.
8586
* `version` - Current version of the resource in Sysdig Monitor.
8687
* `team` - Team ID that owns the alert.
8788

website/docs/r/sysdig_monitor_notification_channel_email.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,15 @@ resource "sysdig_monitor_notification_channel_email" "sample_email" {
4343
* `send_test_notification` - (Optional) Send an initial test notification to check
4444
if the notification channel is working. Default is false.
4545

46+
## Attributes Reference
47+
48+
In addition to all arguments above, the following attributes are exported:
49+
50+
* `id` - (Computed) The ID of the Notification Channel.
51+
52+
* `version` - (Computed) The current version of the Notification Channel.
53+
54+
4655
## Import
4756

4857
Email notification channels for Monitor can be imported using the ID, e.g.

website/docs/r/sysdig_monitor_notification_channel_opsgenie.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,14 @@ resource "sysdig_monitor_notification_channel_opsgenie" "sample-opsgenie" {
4141
* `send_test_notification` - (Optional) Send an initial test notification to check
4242
if the notification channel is working. Default is false.
4343

44+
## Attributes Reference
45+
46+
In addition to all arguments above, the following attributes are exported:
47+
48+
* `id` - (Computed) The ID of the Notification Channel.
49+
50+
* `version` - (Computed) The current version of the Notification Channel.
51+
4452
## Import
4553

4654
Opsgenie notification channels for Monitor can be imported using the ID, e.g.

0 commit comments

Comments
 (0)