helm-www icon indicating copy to clipboard operation
helm-www copied to clipboard

Update or remove missingkey documentation

Open joebowbeer opened this issue 2 years ago • 2 comments

The missingkey option documented in tips and tricks is settable somehow?

I can't find any examples and AFAICT no one else can figure out how to use it in helm v3 either:

https://github.com/helm/helm/issues/5744#issuecomment-494153879 https://github.com/helm/helm/issues/5744#issuecomment-703652296 https://github.com/helm/helm/issues/5417#issuecomment-473372043 https://github.com/helm/helm/issues/5180#issue-400200752

Related:

https://github.com/helm/helm/issues/9273 https://github.com/helm/helm/issues/7483#issuecomment-620296071

Please update the doc or remove the missingkey reference from tips and tricks.

Output of helm version: v3.6.3

joebowbeer avatar Aug 12 '22 21:08 joebowbeer

I agree that's hard to read. The first paragraph is establishing a behavior that the author expects the reader to be familiar with (go-templates). Then goes on to say, "There may be situations where a chart developer wants to enforce this behavior for select values ..." implying that the following required function may be used in templates to enforce the setting of specific keys.

As @bacongobbler has also mentioned, you can also define a json schema to be explicit about your values expectations without resorting to flagging keys all throughout your templates.

PRs to helm-www would be gladly accepted to make this more readable.

@helm/helm-core-maintainers can someone please move this to helm-www

joejulian avatar Sep 08 '22 23:09 joejulian

Apparently this continues to be one of the top-searched questions for helm. Some newer examples of related auto-closed issues:

  • helm/helm#10388
  • helm/helm#10706
  • helm/helm#10846
  • helm/helm#11114

I'd like to mention one workaround for the missing (or unknown?) way to set the "missingkey" option: One can define a json schema as described in the docs. When reviewing the topic in the documentation it might be good to place a hint to this. The method is a bit cumbersome, but robust.

chr1st1ank avatar Nov 16 '22 22:11 chr1st1ank