Skip to content

Commit 3a02210

Browse files
author
Felipe Costa
authored
Update README with new variables update
1 parent b49997e commit 3a02210

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ Pipeline scanner uses Cloud Conformity's [Template Scanner](https://www.cloudcon
1212
## Usage
1313

1414
To use the script, specify the following required environment variables:
15-
* `cc_apikey`
16-
* `cc_region`
17-
* `template`
18-
* `acceptedQty` (Options: LOW | MEDIUM | HIGH | VERY-HIGH | EXTREME, Default: LOW)
15+
* `cc_apikey` (Cloud One COnformity API KEY)
16+
* `cc_region` (Cloud One COnformity account region)
17+
* `templatePath` (Path of the template to be scanned)
18+
* `maxExtreme | maxVeryHigh | maxHigh | maxMedium | maxLow` (Choose any of the options and set a number of how many violations are accepted)
1919

2020
**PS.: ALWAYS use secrets to expose your credentials!**
2121

@@ -39,9 +39,13 @@ jobs:
3939
uses: raphabot/conformity-template-scanner-pipeline@version
4040
env:
4141
cc_apikey: ${{ secrets.apikey }}
42-
acceptedQty: LOW
42+
maxExtreme: 0
43+
maxVeryHigh: 1
44+
maxHigh: 3
45+
maxMedium: 5
46+
maxLow:10
4347
cc_region: us-west-2
44-
template: template.yaml
48+
templatePath: template/infrastructure.yaml
4549
```
4650
4751
## Support

0 commit comments

Comments
 (0)