diff --git a/docs/content/en/schemas/v2beta6.json b/docs/content/en/schemas/v2beta6.json
index 75b69972143..3819cb13870 100755
--- a/docs/content/en/schemas/v2beta6.json
+++ b/docs/content/en/schemas/v2beta6.json
@@ -1243,8 +1243,8 @@
],
"properties": {
"artifactOverrides": {
- "description": "key value pairs. If present, Skaffold will send `--set-string` flag to Helm CLI and append all pairs after the flag.",
- "x-intellij-html-description": "key value pairs. If present, Skaffold will send --set-string
flag to Helm CLI and append all pairs after the flag."
+ "description": "key value pairs where the key represents the parameter used in the `--set-string` Helm CLI flag to define a container image and the value corresponds to artifact i.e. `ImageName` defined in `Build.Artifacts` section. The resulting command-line is controlled by `ImageStrategy`.",
+ "x-intellij-html-description": "key value pairs where the key represents the parameter used in the --set-string
Helm CLI flag to define a container image and the value corresponds to artifact i.e. ImageName
defined in Build.Artifacts
section. The resulting command-line is controlled by ImageStrategy
."
},
"chartPath": {
"type": "string",
@@ -1253,8 +1253,8 @@
},
"imageStrategy": {
"$ref": "#/definitions/HelmImageStrategy",
- "description": "adds image configurations to the Helm `values` file.",
- "x-intellij-html-description": "adds image configurations to the Helm values
file."
+ "description": "controls how an `ArtifactOverrides` entry is turned into `--set-string` Helm CLI flag or flags.",
+ "x-intellij-html-description": "controls how an ArtifactOverrides
entry is turned into --set-string
Helm CLI flag or flags."
},
"name": {
"type": "string",
diff --git a/pkg/skaffold/schema/latest/config.go b/pkg/skaffold/schema/latest/config.go
index 1ef95f88066..b51403db692 100644
--- a/pkg/skaffold/schema/latest/config.go
+++ b/pkg/skaffold/schema/latest/config.go
@@ -508,9 +508,11 @@ type HelmRelease struct {
// ValuesFiles are the paths to the Helm `values` files.
ValuesFiles []string `yaml:"valuesFiles,omitempty"`
- // ArtifactOverrides are key value pairs.
- // If present, Skaffold will send `--set-string` flag to Helm CLI and append all pairs after the flag.
- ArtifactOverrides util.FlatMap `yaml:"artifactOverrides,omitempty,omitempty"`
+ // ArtifactOverrides are key value pairs where the
+ // key represents the parameter used in the `--set-string` Helm CLI flag to define a container
+ // image and the value corresponds to artifact i.e. `ImageName` defined in `Build.Artifacts` section.
+ // The resulting command-line is controlled by `ImageStrategy`.
+ ArtifactOverrides util.FlatMap `yaml:"artifactOverrides,omitempty"`
// Namespace is the Kubernetes namespace.
Namespace string `yaml:"namespace,omitempty"`
@@ -564,7 +566,8 @@ type HelmRelease struct {
// Packaged parameters for packaging helm chart (`helm package`).
Packaged *HelmPackaged `yaml:"packaged,omitempty"`
- // ImageStrategy adds image configurations to the Helm `values` file.
+ // ImageStrategy controls how an `ArtifactOverrides` entry is
+ // turned into `--set-string` Helm CLI flag or flags.
ImageStrategy HelmImageStrategy `yaml:"imageStrategy,omitempty"`
}