Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
amirbenv committed Jan 20, 2021
1 parent ddb6f64 commit e6691bb
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,25 @@ Use "terrascan [command] --help" for more information about a command.
Please refer to our [documentation to integrate with your pipeline](https://docs.accurics.com/projects/accurics-terrascan/en/latest/cicd/).


## Rule Supression
If a rule is generating an expected false positive, you can tell terrascan to skip it.

### Terraform
In terraform scripts, you can specify a rule to skip by inserting a comment with the phrase "ts:skip=RULENAME SKIP_REASON". The comment should be inside the resource.

![tf](https://user-images.githubusercontent.com/74685902/105115888-847b8a00-5a7e-11eb-983e-7f49f7c36ae1.png)

### Kubernetes
In Kubernetes yamls, you can specify a rules to be skipped by adding an annotation as seen in the snippet below
![k8s](https://user-images.githubusercontent.com/74685902/105115885-834a5d00-5a7e-11eb-9190-e8b64d77c5ac.png)

### General Suppresion
Use our config file to manually pick which rules should be applied or supressed from the entire scan. This suitable for edge use cases. Please use in-file suppression to account for known false negative. This ensures that the rule is skipped for a particular resource, not all of them.
![config](https://user-images.githubusercontent.com/74685902/105115887-83e2f380-5a7e-11eb-82b8-a1d18c83a405.png)

### Sample Output
![Screenshot 2021-01-19 at 10 52 47 PM](https://user-images.githubusercontent.com/74685902/105115731-32d2ff80-5a7e-11eb-93b0-2f0620eb1295.png)

## Other Installation Options


Expand Down

0 comments on commit e6691bb

Please sign in to comment.