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

Enhancement Request: Improved usability for linting output #62

Open
IAmATeaPot418 opened this issue Nov 11, 2020 · 0 comments
Open

Enhancement Request: Improved usability for linting output #62

IAmATeaPot418 opened this issue Nov 11, 2020 · 0 comments
Labels
enhancement New feature or request

Comments

@IAmATeaPot418
Copy link

IAmATeaPot418 commented Nov 11, 2020

Here are some readability/UX enhancement requests for Kube-Linter.

Here are some initial suggestions for your consideration that I think would improve the user experience. There are several so feel free to cherry-pick as you see merit.

Suggestions:

  1. If there is no namespace then don't output it as but rather show nothing.
  2. Remove /v1 as a means of unique identification. Personally, I'm not sure what the use case for having this would be.
  3. Rather than showing the check that failed in the output why not remove it or add some additional context to it.
  4. "sec-ctx-demo" does not have a read-only root file system is what's important so why not make this the title so it shows what's important first.
  5. I think it would be awesome to showcase the line of code where the issue is occurring to make it simpler to fix.
  6. Alternatively, consider using the file path rather than the object.

Current output

pod.yaml: (object: <no namespace>/security-context-demo /v1, Kind=Pod) container "sec-ctx-demo" does not have a read-only root file system (check: no-read-only-root-fs, remediation: Set readOnlyRootFilesystem to true in your container's securityContext.)

Suggested output

Warning: Container "sec-ctx-demo" does not have a read-only root file system.
 
Check: Check 'no-read-only-root-fs' failed at line 24 in the pod found in /path/to/file.yaml   
Fix: Add the line readOnlyRootFilesystem: true to your container securitycontext after line 24.
@IAmATeaPot418 IAmATeaPot418 added the enhancement New feature or request label Nov 11, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant