Skip to content

Commit e7ccff6

Browse files
Merge pull request #127 from Traceableai/terraform-revamp-api-naming
ENGTAI-63700 Terraform revamp api naming
2 parents c01d4ea + 676b987 commit e7ccff6

26 files changed

+1681
-36
lines changed

.gitignore

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,4 @@
22
terraform.tfstate*
33
.terraform*
44
dist/
5-
.env
6-
main.tf
5+
.env

docs/resources/agent_token.md

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

1111
Traceable Agent Token Resource
1212

13-
##Example Usage
13+
## Example Usage
1414
```
1515
resource "traceable_agent_token" "example" {
1616
name = "test-token"

docs/resources/api_naming.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "traceable_api_naming Resource - terraform-provider-traceable"
4+
subcategory: ""
5+
description: |-
6+
Manages a API naming rule
7+
---
8+
9+
# traceable_api_naming (Resource)
10+
11+
Manages a API naming rule
12+
13+
## Example Usage
14+
15+
```
16+
resource "traceable_api_naming" "test" {
17+
name = "sample-api-naming-rule"
18+
disabled = false
19+
service_names=["nginx"]
20+
environment_names=[] #empty for all env
21+
values=["someval"]
22+
regexes=["namedep"]
23+
}
24+
```
25+
26+
27+
<!-- schema generated by tfplugindocs -->
28+
## Schema
29+
30+
### Required
31+
32+
- `disabled` (Boolean) Flag to enable or disable the rule
33+
- `environment_names` (Set of String) List of environment names to apply the rule
34+
- `name` (String) The name of the API naming rule
35+
- `regexes` (Set of String) List of regex patterns for the rule
36+
- `service_names` (Set of String) List of service names to apply the rule
37+
- `values` (Set of String) Corresponding values for the regex patterns
38+
39+
### Read-Only
40+
41+
- `id` (String) Identifier of the API Naming Rule

docs/resources/custom_signature.md

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

1111
Manages a custom signature rule
1212

13-
##Example Usage
13+
## Example Usage
1414
```
1515
resource "traceable_custom_signature" "test" {
1616
name = "test-rule"
@@ -27,19 +27,6 @@ resource "traceable_custom_signature" "test" {
2727
match_value = "secret"
2828
}
2929
]
30-
custom_sec_rule = <<EOF
31-
SecRule REQUEST_HEADERS:key-sec "@rx val-sec" \
32-
"id:92100120,\
33-
phase:2,\
34-
block,\
35-
msg:'Test sec Rule',\
36-
tag:'attack-protocol',\
37-
tag:'traceable/labels/OWASP_2021:A4,CWE:444,OWASP_API_2019:API8',\
38-
tag:'traceable/severity/HIGH',\
39-
tag:'traceable/type/safe,block',\
40-
severity:'CRITICAL',\
41-
setvar:'tx.anomaly_score_pl1=+tx.critical_anomaly_score'"
42-
EOF
4330
}
4431
4532
action = {

docs/resources/data_loss_prevention_request_based.md

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

1111
Traceable Data Loss Prevention Request Based Resource
1212

13-
##Example Usage
13+
## Example Usage
1414
```
1515
resource "traceable_data_loss_prevention_request_based" "test" {
1616
name = "test-rule"

docs/resources/data_loss_prevention_user_based.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,18 @@ description: |-
1010

1111
Traceable DLP User Based
1212

13-
##Example Usage
13+
## Example Usage
1414
```
1515
resource "traceable_data_loss_prevention_user_based" "test" {
16-
name = "%s"
16+
name = "sample-dlp-user-based-rule"
1717
description = "Example DLP user-based rule"
1818
enabled = true
1919
environments = ["dev", "prod"]
2020
2121
action = {
2222
action_type = "BLOCK"
23-
duration = "%s"
24-
event_severity = "%s"
23+
duration = "PT60S"
24+
event_severity = "MEDIUM"
2525
}
2626
threshold_configs=[
2727
{

docs/resources/data_set.md

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

1111
Traceable DataSet
1212

13-
##Example Usage
13+
## Example Usage
1414
```
1515
resource "traceable_data_set" "test" {
1616
name = "test-dataset"

docs/resources/enumeration.md

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

1111
Traceable Enumeration Resource
1212

13-
##Example Usage
13+
## Example Usage
1414
```
1515
resource "traceable_enumeration" "test"{
1616
name = "enumeration-test-rule"

docs/resources/malicious_email_domain.md

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

1111
Traceable Malicious Email Domain Resource
1212

13-
##Example Usage
13+
## Example Usage
1414
```
1515
resource "traceable_malicious_email_domain" "test" {
1616
name = "testrule"

docs/resources/malicious_ip_range.md

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

1111
Traceable Malicious IP Range Resource
1212

13-
##Example Usage
13+
## Example Usage
1414
```
1515
resource "traceable_malicious_ip_range" "block_sample"{
1616
name = "traceable-source"

0 commit comments

Comments
 (0)