Skip to content

Commit 17d7003

Browse files
temblekingtembleking
committed
docs: Updated documentation
Signed-off-by: Federico Barcelona <[email protected]>
1 parent 23b1e07 commit 17d7003

File tree

5 files changed

+245
-2
lines changed

5 files changed

+245
-2
lines changed

‎website/docs/d/sysdig_secure_notification_channel.html.markdown‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
---
2+
layout: "sysdig"
3+
page_title: "Sysdig: sysdig_secure_notification_channel"
4+
sidebar_current: "docs-sysdig-secure-notification-channel"
5+
description: |-
6+
Retrieves a Sysdig Secure Notification Channel.
7+
---
8+
9+
# sysdig\_secure\_notification_channel
10+
11+
Retrieves the information of an existing Sysdig Secure Notification Channel.
12+
13+
~> **Note:** This resource is still experimental, and is subject of being changed.
14+
15+
## Example usage
16+
17+
```hcl
18+
data "sysdig_secure_notification_channel" "sample-email" {
19+
name = "Example Channel - Email"
20+
}
21+
```
22+
23+
## Argument Reference
24+
25+
* `name` - (Required) The name of the Notification Channel.
26+
27+
## Attributes Reference
28+
29+
* `enabled` - If false, the channel will not emit notifications.
30+
31+
* `type` - Will be one of the following: "EMAIL", "SNS", "OPSGENIE",
32+
"VICTOROPS", "WEBHOOK", "SLACK", "PAGER_DUTY".
33+
34+
* `notify_when_ok` - Send a new notification when the alert condition is
35+
no longer triggered.
36+
37+
* `notify_when_resolved` - Send a new notification when the alert is manually
38+
acknowledged by a user.
39+
40+
* `send_test_notification` - Send an initial test notification to check
41+
if the notification channel is working.
42+
43+
### Attributes for type EMAIL
44+
45+
* `recipients` - Comma-separated list of recipients that will receive
46+
the message.
47+
48+
### Attributes for type Amazon SNS
49+
50+
* `topics` - List of ARNs from the SNS topics.
51+
52+
### Attributes for type VICTOROPS
53+
54+
* `api_key` - Key for the API.
55+
56+
* `routing_key` - Routing key for VictorOps.
57+
58+
### Attributes for type OPSGENIE
59+
60+
* `api_key` - Key for the API.
61+
62+
### Attributes for type WEBHOOK
63+
64+
* `url` - URL to send the event.
65+
66+
### Attributes for type SLACK
67+
68+
* `url` - URL of the Slack.
69+
70+
* `channel` - Channel name from this Slack.
71+
72+
### Attributes for type PAGERDUTY
73+
74+
* `account` - Pagerduty account.
75+
76+
* `service_key` - Service Key for the Pagerduty account.
77+
78+
* `service_name` - Service name for the Pagerduty account.

‎website/docs/index.html.markdown‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,13 @@ resource "sysdig_secure_policy" "unexpected_inbound_tcp_connection_traefik" {
3434

3535
The following keys can be used to configure the provider.
3636

37-
* `sysdig_monitor_api_token` - (Required) The Sysdig Secure API token, it must be
37+
* `sysdig_monitor_api_token` - (Optional) The Sysdig Secure API token, it must be
3838
present, but you can get it from the `SYSDIG_MONITOR_API_TOKEN` environment variable.
39+
Required if any `sysdig_monitor_*` resource or data source is used.
3940

40-
* `sysdig_secure_api_token` - (Required) The Sysdig Secure API token, it must be
41+
* `sysdig_secure_api_token` - (Optional) The Sysdig Secure API token, it must be
4142
present, but you can get it from the `SYSDIG_SECURE_API_TOKEN` environment variable.
43+
Required if any `sysdig_secure_*` resource or data source is used.
4244

4345
* `sysdig_monitor_url` - (Optional) This is the target Sysdig Secure base API
4446
endpoint. It's intended to be used with OnPrem installations. By defaults it
@@ -51,3 +53,13 @@ The following keys can be used to configure the provider.
5153
points to `https://secure.sysdig.com`, and notice that should not be ended
5254
with an slash. It can also be sourced from the `SYSDIG_SECURE_URL` environment
5355
variable.
56+
57+
* `sysdig_monitor_insecure_tls` - (Optional) Defines if the HTTP client can ignore
58+
the use of invalid HTTPS certificates in the Monitor API. It can be useful for
59+
on-prem installations. It can also be sourced from the `SYSDIG_MONITOR_INSECURE_TLS`
60+
environment variable. By default this is false.
61+
62+
* `sysdig_secure_insecure_tls` - (Optional) Defines if the HTTP client can ignore
63+
the use of invalid HTTPS certificates in the Secure API. It can be useful for
64+
on-prem installations. It can also be sourced from the `SYSDIG_SECURE_INSECURE_TLS`
65+
environment variable. By default this is false.

‎website/docs/r/sysdig_secure_list.html.markdown‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
layout: "sysdig"
3+
page_title: "Sysdig: sysdig_secure_list"
4+
sidebar_current: "docs-sysdig-secure-list"
5+
description: |-
6+
Creates a Sysdig Secure Falco List.
7+
---
8+
9+
# sysdig\_secure\_list
10+
11+
Creates a Sysdig Secure Falco List.
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_list" "allowed_dev_files" {
19+
name = "allowed_dev_files"
20+
items = ["/dev/null", "/dev/stdin", "/dev/stdout", "/dev/stderr", "/dev/random",
21+
"/dev/urandom", "/dev/console", "/dev/kmsg"]
22+
append = true # default: false
23+
}
24+
```
25+
26+
## Argument Reference
27+
28+
* `name` - (Required) The name of the Secure list. It must be unique if it's not in append mode.
29+
30+
* `items` - (Required) Elements in the list. Elements can be another lists.
31+
32+
* `append` - (Optional) Adds these elements to an existing list. Used to extend existing lists provided by Sysdig.
33+
The rules can only be extended once, for example if there is an existing list called "foo", one can have another
34+
append rule called "foo" but not a second one. By default this is false.

‎website/docs/r/sysdig_secure_macro.html.markdown‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
layout: "sysdig"
3+
page_title: "Sysdig: sysdig_secure_macro"
4+
sidebar_current: "docs-sysdig-secure-macro"
5+
description: |-
6+
Creates a Sysdig Secure Falco Macro.
7+
---
8+
9+
# sysdig\_secure\_macro
10+
11+
Creates a Sysdig Secure Falco Macro.
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_macro" "http_port" {
19+
name = "web_port"
20+
condition = "fd.sport=80"
21+
}
22+
23+
resource "sysdig_secure_macro" "https_port" {
24+
name = "web_port"
25+
condition = "or fd.sport=443"
26+
append = true # default: false
27+
}
28+
```
29+
30+
## Argument Reference
31+
32+
* `name` - (Required) The name of the macro. It must be unique if it's not in append mode.
33+
34+
* `condition` - (Required) Macro condition. It can contain lists or other macros.
35+
36+
* `append` - (Optional) Adds these elements to an existing macro. Used to extend existing macros provided by Sysdig.
37+
The macros can only be extended once, for example if there is an existing macro called "foo", one can have another
38+
append macro called "foo" but not a second one. By default this is false.

‎website/docs/r/sysdig_secure_notification_channel.html.markdown‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
---
2+
layout: "sysdig"
3+
page_title: "Sysdig: sysdig_secure_notification_channel"
4+
sidebar_current: "docs-sysdig-secure-notification-channel"
5+
description: |-
6+
Creates a Sysdig Secure Notification Channel.
7+
---
8+
9+
# sysdig\_secure\_notification_channel
10+
11+
Creates a Sysdig Secure Notification Channel.
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" "sample-email" {
19+
name = "Example Channel - Email"
20+
enabled = true
21+
type = "EMAIL"
22+
recipients = "[email protected]"
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+
* `enabled` - (Required) If false, the channel will not emit notifications.
33+
34+
* `type` - (Required) Must be one of the following: "EMAIL", "SNS", "OPSGENIE",
35+
"VICTOROPS", "WEBHOOK", "SLACK", "PAGER_DUTY".
36+
37+
* `notify_when_ok` - (Required) Send a new notification when the alert condition is
38+
no longer triggered.
39+
40+
* `notify_when_resolved` - (Required) Send a new notification when the alert is manually
41+
acknowledged by a user.
42+
43+
* `send_test_notification` - (Optional) Send an initial test notification to check
44+
if the notification channel is working.
45+
46+
### Arguments for type EMAIL
47+
48+
* `recipients` - (Required) Comma-separated list of recipients that will receive
49+
the message.
50+
51+
### Arguments for type Amazon SNS
52+
53+
* `topics` - (Required) List of ARNs from the SNS topics.
54+
55+
### Arguments for type VICTOROPS
56+
57+
* `api_key` - (Required) Key for the API.
58+
59+
* `routing_key` - (Required) Routing key for VictorOps.
60+
61+
### Arguments for type OPSGENIE
62+
63+
* `api_key` - (Required) Key for the API.
64+
65+
### Arguments for type WEBHOOK
66+
67+
* `url` - (Required) URL to send the event.
68+
69+
### Arguments for type SLACK
70+
71+
* `url` - (Required) URL of the Slack.
72+
73+
* `channel` - (Required) Channel name from this Slack.
74+
75+
### Arguments for type PAGERDUTY
76+
77+
* `account` - (Required) Pagerduty account.
78+
79+
* `service_key` - (Required) Service Key for the Pagerduty account.
80+
81+
* `service_name` - (Required) Service name for the Pagerduty account.

0 commit comments

Comments
 (0)