search

awslabs / serverless-rules

Compilation of rules to validate infrastructure-as-code templates against recommended practices for serverless applications.
https://awslabs.github.io/serverless-rules/
MIT No Attribution
403 stars 25 forks source link

What is different with terraform-linters / tflint ? #41

Closed patsevanton closed 3 years ago

patsevanton commented 3 years ago

Hello! Thanks for serverless-rules What is different with terraform-linters / tflint ? Thanks!

nmoutschen commented 3 years ago

Hey @patsevanton !

Do you mean how it differs from the tflint tool or from the tflint ruleset for AWS?

On the tflint tool, this is a plugin that adds additional, prescriptive rules for tflint. Basically, you use this plugin with tflint: https://awslabs.github.io/serverless-rules/tflint/

For the AWS ruleset, the AWS ruleset checks if terraform configuration files are correct and help you make sure you can apply them without issue. The ruleset in this repository adds prescriptive guidance based on recommended practices. Your terraform file can be correct and will deploy to AWS even if you don't match some of the rules defined here, but this contains recommendations on how you could improve your serverless applications.

For example, you can build applications without enabling Lambda tracing, but we recommend using distributed tracing. That rule actually has a section explaining when you might not use Lambda tracing.

The goal of this project is to have a quick assessment on those recommendations, so that you might discover recommended practices, and give you remediation paths.

patsevanton commented 3 years ago

Thanks!