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

naming convention for charts and variables #1445

Open
jackson-chris opened this issue Mar 27, 2023 · 1 comment
Open

naming convention for charts and variables #1445

jackson-chris opened this issue Mar 27, 2023 · 1 comment

Comments

@jackson-chris
Copy link

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 helm/helm#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
Copy link
Author

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: helm/helm#9150 (comment)

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

No branches or pull requests

1 participant