question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Document reasoning behind rule checks

See original GitHub issue

Is your feature request related to a problem? Please describe. When running checkov, you get pointed to rule violations with a one line explanation of what is wrong, ex. Ensure Amazon EKS public endpoint disabled. However, there’s no deeper explanation on why that’s something to be concerned about, only that it’s suggested that you fix it. Also, fixing it with respect to making checkov happy is one thing, but supporting, external steps to make it work may be bigger than the one line configuration change. Tooling like this is a great opportunity to educate users on good practices, common problems, and solutions.

Describe the solution you’d like I would like to see documentation that explains why each rule is there (ie. what exactly is the problem?) and suggestions on how to fix it (ie. what configuration to change/add/update, as well as external changes to support it). Since each rule is supposed to be based on ‘best practices’, there should be a valid explanation of what problem the rule identifies actually is. Likewise, if these are ‘best practices’, then well known solution patterns should be available easily and conveniently. Similarly, examples, when applicable, of when this violation might safely be ignored/disabled should be discussed.

Describe alternatives you’ve considered The alternative is to internet search phrases around the one line suggestion in the output to try to find help on why it’s a problem, and what to do about it.

Additional context TFLint does a decent job of this: https://github.com/terraform-linters/tflint/blob/v0.14.0/docs/rules/aws_db_instance_default_parameter_group.md, and Rubocop at least links out to an external explanation: https://docs.rubocop.org/en/stable/cops_lint/

Issue Analytics

  • State:closed
  • Created 4 years ago
  • Comments:5 (4 by maintainers)

github_iconTop GitHub Comments

3reactions
schosterbarakcommented, Feb 4, 2020

Working on it! stay tuned.

1reaction
schosterbarakcommented, Jul 2, 2020

@bol @mgrecar you can now view a link to guide on each check output: image

Read more comments on GitHub >

github_iconTop Results From Across the Web

Rule 34. Producing Documents, Electronically Stored ...
The responding party may state that it will produce copies of documents or of electronically stored information instead of permitting inspection. The production ......
Read more >
View Document - Arizona Court Rules
Rule 34. Producing Documents, Electronically Stored Information, and Tangible Things, or Entering Onto Land, for Inspection and Other Purposes. Currentness.
Read more >
Examining Documents | USCIS
You must examine the documentation your employee presents to complete Section 2 of Form I-9, Employment Eligibility Verification.
Read more >
Supreme Court Rules - Rule 58 - Rules of Civil Procedure
A party who produces documents for inspection shall produce them as they are kept in the usual course of business so long as...
Read more >
Civil Rule 34. Producing Documents, Electronically Stored ...
Rule 34. Producing Documents, Electronically Stored Information, and Tangible. Things, or Entering onto Land, for Inspection and Other Purposes.
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found