docs: Add values.schema.json and NOTES.txt - #935
Conversation
This is mostly copied over from hive-operator since the files are not templated. Having a schema makes Helm validate values on install, upgrade, lint and template AND shows as a nice reference on ArtifactHub. One thing to note is that we include the "global" block even if it's not used by us. This is due to https://helm.sh/de/docs/chart_template_guide/subcharts_and_globals/ In short: When used as a subchart Helm injects a "global" into every subchart. If we don't declare it validation will fail when used as a subchart. This also documents all used values in values.yaml itself and adds a NOTES.txt which is displayed automatically after an install.
Techassi
left a comment
Techassi
left a comment
There was a problem hiding this comment.
Not templated on purpose.
I can see why the schema is not templated (because the values.yaml file it describes is also not templated), but why is the NOTES.txt file not templated? I don't see anything operator-specific in there (other than its name, which can easily be templated).
Techassi
moved this from Development: Waiting for Review
to Development: In Review
in Stackable Engineering
|
Because it would require special handling for listener, secret and commons. The text would otherwise not fit. "This installs the Stackable operator for Trino only." -> "This installs the Stackable operator for Commons operator only" or similar. |
I really hope that's the case, because otherwise it will be painful to rollout a particular change across all operators.
Special casing is fine and in this particular instance it doesn't seem to be super complicated to do. |
|
I don't have a strong opinion, I can also try to put up a PR with the special casing of this so you/we can see what it'd look like if you prefer. Your call. |
|
The templating PR has been merged. Can you still approve this for the schema? |
lfrancke
moved this from Development: In Review
to Development: Done
in Stackable Engineering
3 participants
Ports of
globalthingThis will go into each repository. Not templated on purpose.