Skip to content

Commit f30227e

Browse files
committed
Update docs
1 parent 978dbcf commit f30227e

File tree

8 files changed

+67
-24
lines changed

8 files changed

+67
-24
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Terraform Provider for Prisma Cloud Compute by Palo Alto Networks
1+
# Terraform Provider for Prisma Cloud Compute
22
You can find the Prisma Cloud Compute provider in the [Terraform Registry](https://registry.terraform.io/providers/PaloAltoNetworks/prismacloudcompute/latest).
33

44
## Basic setup

docs/data-sources/custom_rule.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "prismacloudcompute_custom_rule Data Source - terraform-provider-prismacloudcompute"
4+
subcategory: ""
5+
description: |-
6+
Use this data source to retrieve ID of a custom rule.
7+
---
8+
9+
# prismacloudcompute_custom_rule (Data Source)
10+
11+
Use this data source to retrieve ID of a custom rule.
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- **name** (String) Unique custom rule name.
21+
22+
### Optional
23+
24+
- **description** (String) Free-form text description of the custom rule.
25+
26+
### Read-Only
27+
28+
- **id** (String) ID of the custom rule.
29+
- **message** (String) Message to display for a custom rule event.
30+
- **prisma_id** (Number) Prisma Cloud Compute ID of the custom rule.
31+
- **script** (String) Custom rule expression.
32+
- **type** (String) Custom rule type. Can be set to 'processes', 'filesystem', 'network-outgoing', 'kubernetes-audit', 'waas-request', or 'waas-response'.
33+
34+

docs/index.md

Lines changed: 5 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,20 @@
11
---
22
# generated by https://github.com/hashicorp/terraform-plugin-docs
3-
page_title: "prismacloudcompute Provider"
4-
subcategory: ""
3+
page_title: "Prisma Cloud Compute Provider"
54
description: |-
6-
5+
The Prisma Cloud Compute provider gives resources to interact with the Prisma Cloud Compute API.
76
---
87

9-
# prismacloudcompute Provider
10-
11-
8+
# Prisma Cloud Compute provider
9+
The Prisma Cloud Compute provider gives resources to interact with the Prisma Cloud Compute API.
1210

1311
## Example Usage
14-
1512
```terraform
1613
terraform {
1714
required_providers {
1815
prismacloudcompute = {
1916
source = "PaloAltoNetworks/prismacloudcompute"
20-
version = "0.1.0"
17+
version = "0.4.0"
2118
}
2219
}
2320
}
@@ -34,15 +31,3 @@ provider "prismacloudcompute" {
3431
# password = "myPassword"
3532
}
3633
```
37-
38-
<!-- schema generated by tfplugindocs -->
39-
## Schema
40-
41-
### Optional
42-
43-
- **config_file** (String) Configuration file in JSON format. See examples/creds.json
44-
- **console_url** (String) The Prisma Cloud Compute Console URL
45-
- **password** (String, Sensitive) Prisma Cloud Compute password
46-
- **project** (String) The Prisma Cloud Compute project
47-
- **skip_cert_verification** (Boolean) Whether or not to skip certificate verification
48-
- **username** (String) Prisma Cloud Compute username

docs/resources/ci_image_vulnerability_policy.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ Optional:
5454
- **disabled** (Boolean) Whether or not to disable the rule.
5555
- **effect** (String) The effect of the rule. Can be set to 'ignore', 'alert', 'block', or 'alert, block'.
5656
- **grace_days** (Number) Number of days to suppress the rule's block effect. Measured from date the vulnerability was fixed. If there's no fix, measured from the date the vulnerability was published.
57+
- **grace_days_policy** (Block List, Max: 1) Composite alternative to grace_days. Allows to set the effect for different severity level. (see [below for nested schema](#nestedblock--rule--grace_days_policy))
5758
- **name** (String) Unique name of the rule.
5859
- **notes** (String) Free-form text field.
5960
- **only_fixed** (Boolean) Whether or not to apply the rule only when vendor fixes are available.
@@ -98,6 +99,17 @@ Optional:
9899

99100

100101

102+
<a id="nestedblock--rule--grace_days_policy"></a>
103+
### Nested Schema for `rule.grace_days_policy`
104+
105+
Optional:
106+
107+
- **critical** (Number)
108+
- **high** (Number)
109+
- **low** (Number)
110+
- **medium** (Number)
111+
112+
101113
<a id="nestedblock--rule--tag_rule"></a>
102114
### Nested Schema for `rule.tag_rule`
103115

docs/resources/image_vulnerability_policy.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,7 @@ Optional:
8686
- **disabled** (Boolean) Whether or not to disable the rule.
8787
- **effect** (String) The effect of the rule. Can be set to 'ignore', 'alert', 'block', or 'alert, block'.
8888
- **grace_days** (Number) Number of days to suppress the rule's block effect. Measured from date the vulnerability was fixed. If there's no fix, measured from the date the vulnerability was published.
89+
- **grace_days_policy** (Block List, Max: 1) Composite alternative to grace_days. Allows to set the effect for different severity level. (see [below for nested schema](#nestedblock--rule--grace_days_policy))
8990
- **name** (String) Unique name of the rule.
9091
- **notes** (String) Free-form text field.
9192
- **only_fixed** (Boolean) Whether or not to apply the rule only when vendor fixes are available.
@@ -130,6 +131,17 @@ Optional:
130131

131132

132133

134+
<a id="nestedblock--rule--grace_days_policy"></a>
135+
### Nested Schema for `rule.grace_days_policy`
136+
137+
Optional:
138+
139+
- **critical** (Number)
140+
- **high** (Number)
141+
- **low** (Number)
142+
- **medium** (Number)
143+
144+
133145
<a id="nestedblock--rule--tag_rule"></a>
134146
### Nested Schema for `rule.tag_rule`
135147

examples/provider/creds.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"console_url": "https://foo.bar.com",
2+
"console_url": "https://console.example.com",
33
"username": "myUsername",
44
"password": "myPassword"
5-
}
5+
}

examples/provider/provider.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ terraform {
22
required_providers {
33
prismacloudcompute = {
44
source = "PaloAltoNetworks/prismacloudcompute"
5-
version = "0.1.0"
5+
version = "0.4.0"
66
}
77
}
88
}

0 commit comments

Comments
 (0)