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

naming convention for charts and variables

Open jackson-chris opened this issue 1 year ago • 1 comments

Hello, the naming convention says that helm chart name can contain dashes, but variable name not:

Chart names must be lower case letters and numbers. Words may be separated with dashes (-): https://helm.sh/docs/chart_best_practices/conventions/

Variable names should begin with a lowercase letter, and words should be separated with camelcase: https://helm.sh/docs/chart_best_practices/values/

If i have a subchart named subchart-name, I will violate the naming convention with these values.yaml in my umbrella chart:

subchart-name:
  name: nginx

This is a design flaw that seems like we're stuck with but all users using sub charts will face this problem if they use the conventions you've laid out. The closing statement in https://github.com/helm/helm/issues/2192 says that documentation was updated, but I see nothing that warns users of this problem and users are forced to do an internet search on how to work around this problem. I think you should update the documentation correctly. Either by stating that all sub charts should be aliased to a name without hyphens or that if you don't use alias than the workaround using index is required. And that workaround should be clearly documented.

jackson-chris avatar Mar 27 '23 13:03 jackson-chris

In addition using aliases is not ideal because there are a whole list of problems you can run into when using them, a good summary in: https://github.com/helm/helm/issues/9150#issuecomment-750905208

jackson-chris avatar Mar 29 '23 21:03 jackson-chris