-
Notifications
You must be signed in to change notification settings - Fork 125
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 zeebe values #141
Conversation
Rename JavaOpts -> to javaOpts, to follow naming convetion.
Rename create -> enabled to be consistent with other property names
Move probePath to correct section, readinessProbe to make it more clear
Rename created -> enabled to make it consistent
Add all zeebe related values to the ccsm-helm value file and document each of them.
Remove values from sub chart, they are overwritten by parent chart.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great stuff! The conventions are something we could add in a contributing section for the future contributors. That should hopefully avoid some review back and forth in the future.
- ❌ The README for ccsm-helm still lists
zeebe.JavaOpts
and notzeebe.javaOpts
as variable. Same for the zeebe sub-chart README. Though if you want to do that as part of adjusting the README in a separate PR, go ahead 🙂 - ❓ You mention extracting the values to the parent chart; can you explain why? What's the plan, will all sub chart have their values in the parent/umbrella chart? Why is this a better alternative?
Anyway, no need for a second review from my side 👍
Thanks for your fast review @npepinpe ! Regarding:
Multiple things, one is to avoid the duplication (having multiple values files with the same content), which some times lead to problems. Furthermore I would like to have on single place to maintain. Additionally artifacthub also shows only the values file of the parent chart https://artifacthub.io/packages/helm/camunda-cloud-helm/ccsm-helm?modal=values which makes for me sense to add the values here |
Adds the zeebe values to the parent values file and removes them from the old values file, to reduce redundancy. Document all zeebe related variables to follow best practices https://helm.sh/docs/chart_best_practices/values/
This means:
Furthermore introduced own pattern: # [VarName] [conjunction] [definition]
VarName:
The root (chart name) is omitted (e.g. zeebe). This is useful for using --set in helm.
Conjunction:
Need to adjust the README related to the Zeebe values