Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
wfg committed Jan 4, 2022
1 parent 978dbcf commit f30227e
Show file tree
Hide file tree
Showing 8 changed files with 67 additions and 24 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Terraform Provider for Prisma Cloud Compute by Palo Alto Networks
# Terraform Provider for Prisma Cloud Compute
You can find the Prisma Cloud Compute provider in the [Terraform Registry](https://registry.terraform.io/providers/PaloAltoNetworks/prismacloudcompute/latest).

## Basic setup
Expand Down
34 changes: 34 additions & 0 deletions docs/data-sources/custom_rule.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "prismacloudcompute_custom_rule Data Source - terraform-provider-prismacloudcompute"
subcategory: ""
description: |-
Use this data source to retrieve ID of a custom rule.
---

# prismacloudcompute_custom_rule (Data Source)

Use this data source to retrieve ID of a custom rule.



<!-- schema generated by tfplugindocs -->
## Schema

### Required

- **name** (String) Unique custom rule name.

### Optional

- **description** (String) Free-form text description of the custom rule.

### Read-Only

- **id** (String) ID of the custom rule.
- **message** (String) Message to display for a custom rule event.
- **prisma_id** (Number) Prisma Cloud Compute ID of the custom rule.
- **script** (String) Custom rule expression.
- **type** (String) Custom rule type. Can be set to 'processes', 'filesystem', 'network-outgoing', 'kubernetes-audit', 'waas-request', or 'waas-response'.


25 changes: 5 additions & 20 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,20 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "prismacloudcompute Provider"
subcategory: ""
page_title: "Prisma Cloud Compute Provider"
description: |-
The Prisma Cloud Compute provider gives resources to interact with the Prisma Cloud Compute API.
---

# prismacloudcompute Provider


# Prisma Cloud Compute provider
The Prisma Cloud Compute provider gives resources to interact with the Prisma Cloud Compute API.

## Example Usage

```terraform
terraform {
required_providers {
prismacloudcompute = {
source = "PaloAltoNetworks/prismacloudcompute"
version = "0.1.0"
version = "0.4.0"
}
}
}
Expand All @@ -34,15 +31,3 @@ provider "prismacloudcompute" {
# password = "myPassword"
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Optional

- **config_file** (String) Configuration file in JSON format. See examples/creds.json
- **console_url** (String) The Prisma Cloud Compute Console URL
- **password** (String, Sensitive) Prisma Cloud Compute password
- **project** (String) The Prisma Cloud Compute project
- **skip_cert_verification** (Boolean) Whether or not to skip certificate verification
- **username** (String) Prisma Cloud Compute username
12 changes: 12 additions & 0 deletions docs/resources/ci_image_vulnerability_policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ Optional:
- **disabled** (Boolean) Whether or not to disable the rule.
- **effect** (String) The effect of the rule. Can be set to 'ignore', 'alert', 'block', or 'alert, block'.
- **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.
- **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))
- **name** (String) Unique name of the rule.
- **notes** (String) Free-form text field.
- **only_fixed** (Boolean) Whether or not to apply the rule only when vendor fixes are available.
Expand Down Expand Up @@ -98,6 +99,17 @@ Optional:



<a id="nestedblock--rule--grace_days_policy"></a>
### Nested Schema for `rule.grace_days_policy`

Optional:

- **critical** (Number)
- **high** (Number)
- **low** (Number)
- **medium** (Number)


<a id="nestedblock--rule--tag_rule"></a>
### Nested Schema for `rule.tag_rule`

Expand Down
12 changes: 12 additions & 0 deletions docs/resources/image_vulnerability_policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ Optional:
- **disabled** (Boolean) Whether or not to disable the rule.
- **effect** (String) The effect of the rule. Can be set to 'ignore', 'alert', 'block', or 'alert, block'.
- **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.
- **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))
- **name** (String) Unique name of the rule.
- **notes** (String) Free-form text field.
- **only_fixed** (Boolean) Whether or not to apply the rule only when vendor fixes are available.
Expand Down Expand Up @@ -130,6 +131,17 @@ Optional:



<a id="nestedblock--rule--grace_days_policy"></a>
### Nested Schema for `rule.grace_days_policy`

Optional:

- **critical** (Number)
- **high** (Number)
- **low** (Number)
- **medium** (Number)


<a id="nestedblock--rule--tag_rule"></a>
### Nested Schema for `rule.tag_rule`

Expand Down
4 changes: 2 additions & 2 deletions examples/provider/creds.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"console_url": "https://foo.bar.com",
"console_url": "https://console.example.com",
"username": "myUsername",
"password": "myPassword"
}
}
2 changes: 1 addition & 1 deletion examples/provider/provider.tf
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ terraform {
required_providers {
prismacloudcompute = {
source = "PaloAltoNetworks/prismacloudcompute"
version = "0.1.0"
version = "0.4.0"
}
}
}
Expand Down
File renamed without changes.

0 comments on commit f30227e

Please sign in to comment.