feat(helm): add valueFiles field to specify custom value files #1099
Conversation
edvald
force-pushed
the
helm-value-files
branch
from
3501676 to
718010c
Compare
| key: some-value | ||
| ``` | ||
|
|
||
| This will effectively create a new YAML with the supplies values and pass it to Helm when rendering/deploying the chart. This is particularly handy when you want to template in the values (see the next section for a good example). |
| key: prod-value | ||
| ``` | ||
|
|
||
| In this example, `some.key` is set to `"prod-value"` for the `prod` environment, and `other.key` keep the default value set in `values.default.yaml`. |
There was a problem hiding this comment.
keep => keeps. Or maybe better, maintains.
|
|
||
| In this example, `some.key` is set to `"prod-value"` for the `prod` environment, and `other.key` keep the default value set in `values.default.yaml`. | ||
|
|
||
| If you were to also set the `values` field in the Module configuration, the values there would take precedence over both of the value files. |
There was a problem hiding this comment.
May drop the "hypothetical past tense" (or whatever it's called) and just say: "If you also set the values field [...], the values there take..."
| in \`valueFiles\`). | ||
| `), | ||
| valueFiles: joiArray(joi.string().posixPath({ subPathOnly: true })) | ||
| .description(dedent` |
There was a problem hiding this comment.
Shouldn't this be deline? Noticed some extra new lines in the generated doc above (although not visible to when rendered as markdown).
There was a problem hiding this comment.
No, that'll bunch up all the paragraphs, right? It's too much text for a single paragraph imo.
| const chartPath = await getChartPath(module) | ||
| const gardenValuesPath = getGardenValuesPath(chartPath) | ||
|
|
||
| const valueFiles = module.spec.valueFiles |
There was a problem hiding this comment.
Could you add a comment saying that the gardenValuesPath takes precedence over the other value files and is therefore appended last.
edvald
force-pushed
the
helm-value-files
branch
from
718010c to
12c7ae5
Compare
|
Addressed the comments, to be squashed on merge. |
What this PR does / why we need it:
Previously you could only (easily) provide custom values to charts via the
valueskey. Having different value files based on context/environment is a pretty common practice with Helm, so we should enable that.You could for example have a base values file with defaults, and then a custom one based on environment:
You can still use the current
valuesfield, which will take precedence over the files listed undervalueFiles.Which issue(s) this PR fixes:
Closes #1098
Special notes for your reviewer:
See if the docs and the schema makes sense, as documented.
Does this PR introduce a user-facing change?:
Yes