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

Document helm usage #21

Closed
saiyam1814 opened this issue Oct 29, 2020 · 6 comments · Fixed by #90
Closed

Document helm usage #21

saiyam1814 opened this issue Oct 29, 2020 · 6 comments · Fixed by #90
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@saiyam1814
Copy link

any help usage example ?

@viswajithiii
Copy link
Contributor

Hi @saiyam1814, you can run kube-linter lint <dir> where <dir> is a path to a Helm chart (ie, it contains a Chart.yaml).

I will update our documentation to make this more clear, but in the meantime, let me know if this answers your question.

@viswajithiii viswajithiii changed the title helm usage Document helm usage Oct 29, 2020
@viswajithiii viswajithiii added the documentation Improvements or additions to documentation label Oct 30, 2020
@saiyam1814
Copy link
Author

I pointed to the directory but it still shows yaml errors I mean how different the helm chart check is
I have below in the repo
image
I do kube-linter lint .
I checks the yaml file like it usually do.

@kreamkorokke
Copy link
Contributor

@saiyam1814 as of now we actually just started supporting helm, and the errors are reported on the parsed yaml files. So right now the check output will look the same for plain k8s manifests and helm.

I will make sure to communicate this with our main developer as he is out now, and thanks again for pointing this out.

@viswajithiii
Copy link
Contributor

@saiyam1814 kube-linter lint . renders the templates in the Helm chart using the values.yaml file, and runs the checks on the rendered YAMLs. The checks that are actually run are the same as the checks run on the rendered YAML files. Thus, kubelinter lint . on a Helm chart directory is functionally equivalent to something like: helm template . --output-dir /tmp/chart; kube-linter lint /tmp/chart. If kube-linter lint did not do the rendering, it would try to lint the template files directly, which would not work since they are not valid YAMLs. Does that make sense? What is the behaviour you expected to see?

Also, see #48 for some proposed improvements to our Helm support.

@gaurav-nelson gaurav-nelson self-assigned this Nov 3, 2020
@saiyam1814
Copy link
Author

Thanks, I wrote a short blog the other day after kubeLinter was announced.
https://www.civo.com/learn/yaml-best-practices-using-kubelinter

@viswajithiii
Copy link
Contributor

Thanks, I wrote a short blog the other day after kubeLinter was announced.
https://www.civo.com/learn/yaml-best-practices-using-kubelinter

Thanks @saiyam1814! That is a great blog. I will add a link to it in our README. 🙂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants