Skip to content

Commit f717895

Browse files
committed
Revise README
1 parent f1c9d26 commit f717895

File tree

2 files changed

+21
-0
lines changed

2 files changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,27 @@ plugin "aws" {
2424

2525
For more configuration about the plugin, see [Plugin Configuration](docs/configuration.md).
2626

27+
**NOTE:** This plugin is bundled with the TFLint binary for backward compatibility, so you can use it without installing it separately. And it is automatically enabled when your Terraform configuration requires AWS provider.
28+
29+
## Getting Started
30+
31+
Terraform is a great tool for Infrastructure as Code. However, many of these tools don't validate provider-specific issues. For example, see the following configuration file:
32+
33+
```hcl
34+
resource "aws_instance" "foo" {
35+
ami = "ami-0ff8a91507f77f867"
36+
instance_type = "t1.2xlarge" # invalid type!
37+
}
38+
```
39+
40+
Since `t1.2xlarge` is an invalid instance type, an error will occur when you run `terraform apply`. But `terraform validate` and `terraform plan` cannot find this possible error in advance. That's because it's an AWS provider-specific issue and it's valid as the Terraform Language.
41+
42+
The goal of this ruleset is to find such errors:
43+
44+
![demo](docs/assets/demo.gif)
45+
46+
By running TFLint with this ruleset in advance, you can fix the problem before the error occurs in production CI/CD pipelines.
47+
2748
## Rules
2849

2950
700+ rules are available. See [Rules](docs/rules/README.md).

docs/assets/demo.gif

281 KB
Loading

0 commit comments

Comments
 (0)