Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create FAQ section #64

Merged
merged 3 commits into from
Jan 28, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -260,3 +260,34 @@ Releases are created via GitHub Workflows. You can find more information about t

### Beta
To release a new beta version, run `make beta-bumpversion` to increment the patch version and push a tag to GitHub to start the beta release process. You can find more information about this [here](docs/github_workflow.md)

### FAQs
1. With the newest version of config-lint being able to handle configuration files written in Terraform v0.12 syntax, is it still
backwards compatible with configuration files written in the Terraform v0.11?
- Yes the new version of config-lint is able to handle parsing Terraform configuration files written in both v0.11 and v0.12 syntax.
- To choose the between parsing Terraform 0.11 vs 0.12 syntax, you can pass in the flag option `-tfparser` followed
by either `tf11` or `tf12`. For example:
- `config-lint -tfparser tf12 -rules example_rule.yml example_config/example_file.tf`
2. I'm running into errors when trying to run the newest version of config-lint against configuration files
written in Terraform v0.12 syntax. Where should be the first place to check for resolving this?
- The first thing to check is to make sure you're passing in the correct `-tfparser` flag option.
Depending on which Terraform syntax the configuration file is written in, refer to the FAQ #1 above for
passing in the correct flag option values.
- For configuration files that contain Terraform v0.12 syntax, you should confirm that whatever rule.yml file/files you pass in
have the `type:` key set to `Terraform12`. For example in this rule.yml file:
```
version: 1
description: Rules for Terraform configuration files
type: Terraform12
files:
- "*.tf"
rules:
- id: AMI_SET
message: Testing
resource: aws_instance
assertions:
- key: ami
op: eq
value: ami-f2d3638a
```