-
Notifications
You must be signed in to change notification settings - Fork 3
update docs so chart version is optional on helm provisioner #159
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -30,7 +30,7 @@ The following configuration options are available: | |
| | `release_name` | string | (package name) | Specifies the release name for the helm chart. Defaults to the Massdriver package name if not specified. | | ||
| | `.chart.repo` | string | `null` | Specifies the URL of the chart repo (required if using [remote chart](#local-vs-remote-chart)) | | ||
| | `.chart.name` | string | `null` | Specifies the name of the chart from the repo to use (required if using [remote chart](#local-vs-remote-chart)) | | ||
| | `.chart.version` | string | `null` | Specifies the chart version to use (required if using [remote chart](#local-vs-remote-chart)) | | ||
| | `.chart.version` | string | `null` | Specifies the chart version to use (optional if using [remote chart](#local-vs-remote-chart), defaults to latest) | | ||
|
||
| | `debug` | boolean | `true` | Enables the `--debug` flag for Helm (verbose output) | | ||
| | `wait` | boolean | `true` | Enables the `--wait` flag for Helm (waits for pods, PVCs, services, etc. to be ready before marking the release as successful) | | ||
| | `wait_for_jobs` | string | `true` | Enables the `--wait-for-jobs` flag for Helm (waits for jobs to complete before marking the release as successful) | | ||
|
|
||
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.
The documentation on line 44 in the "Local vs Remote Chart" section still states "All 3 fields must be set, or none of them set" which contradicts this change making the chart version optional. Line 44 should be updated to reflect that only
.chart.repoand.chart.nameare required for remote charts, while.chart.versionis optional and defaults to the latest version.