Skip to content

Commit 1bc789e

Browse files
author
Marina Limeira
committed
Docs fixes -- comments from PR
1 parent 1fcfcc7 commit 1bc789e

File tree

2 files changed

+10
-8
lines changed

2 files changed

+10
-8
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1-
# TFLint Ruleset AWS CIS
1+
# TFLint Ruleset CIS AWS Foundations Benchmark
22

3-
![CIS Benchmark Version](https://img.shields.io/badge/CIS%20benchmark%20version-1.5.0-green)
3+
![CIS AWS Foundations Benchmark Version](https://img.shields.io/badge/CIS%20benchmark%20version-1.5.0-green)
44
![https://gruntwork.io/?ref=repo_cis_compliance_aws"](https://img.shields.io/badge/maintained%20by-gruntwork.io-%235849a6.svg)
55

6-
Tflint rules for CIS compliance checks. These rules work in addition to the recommendations from [Gruntwork's CIS Service Catalog](https://github.com/gruntwork-io/terraform-aws-cis-service-catalog).
6+
Tflint rules for CIS AWS Foundations Benchmark compliance checks. These rules work in addition to the recommendations from [Gruntwork's CIS Service Catalog](https://github.com/gruntwork-io/terraform-aws-cis-service-catalog).
7+
8+
> :warning: **This repository is a WIP. It only contains one single rule so far, to validate Security Groups, that is hard to enforce in any other way ([see Rules section](#rules)). In the future, we may add other CIS AWS Foundations Benchmark rules.**
79
810

911
## Requirements
@@ -19,7 +21,7 @@ You can install the plugin with `tflint --init`. Declare a config in `.tflint.hc
1921
plugin "aws-cis" {
2022
enabled = true
2123
22-
version = "0.0.1"
24+
version = "<VERSION>"
2325
source = "github.com/gruntwork-io/tflint-ruleset-aws-cis"
2426
}
2527
```
@@ -32,7 +34,7 @@ plugin "aws-cis" {
3234

3335
## Terragrunt
3436

35-
It's recommended that these rules are added into your Terragrunt project, using [Before Hooks or After Hooks](https://terragrunt.gruntwork.io/docs/features/hooks/#tflint-hook).
37+
An effective way to enforce these rules is to add them to your Terragrunt configuration using [Before Hooks](https://terragrunt.gruntwork.io/docs/features/hooks/#tflint-hook).
3638

3739
```hcl
3840
terraform {
@@ -43,12 +45,12 @@ terraform {
4345
}
4446
```
4547

46-
In the root of the Terragrunt project, add a `.tflint.hcl` file:
48+
In the root of the Terragrunt project, add a `.tflint.hcl` file, replacing `<VERSION>` below with the latest version from the [releases page](https://github.com/gruntwork-io/tflint-ruleset-aws-cis/releases):
4749

4850
```hcl
4951
plugin "aws" {
5052
enabled = true
51-
version = "0.0.1"
53+
version = "<VERSION>"
5254
source = "github.com/gruntwork-io/tflint-ruleset-aws-cis"
5355
}
5456
```

docs/rules/aws_security_group_rule_invalid_cidr_block.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Error: cidr_blocks can not contain '0.0.0.0/0' when allowing 'ingress' access to
2323

2424
## Why
2525

26-
CIS AWS Benckmark has two recommendations regarding Security Group's CIDR blocks:
26+
CIS AWS Foundations Benchmark has two recommendations regarding Security Group's CIDR blocks:
2727
- 5.2 ensures no security groups allow ingress from 0.0.0.0/0 to remote server administration ports
2828
- 5.3 ensures no security groups allow ingress from ::/0 to remote server administration ports
2929

0 commit comments

Comments
 (0)