Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Clarify usage of ArtifactOverrides, ImageStrategy #4487

Merged
merged 2 commits into from
Sep 10, 2020
Merged

Clarify usage of ArtifactOverrides, ImageStrategy #4487

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ed808f3
Clarify usage of ArtifactOverrides, ImageStrategy
Jul 17, 2020
f02a302
Remove duplicated omitempty tag
Jul 23, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/content/en/schemas/v2beta6.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <code>--set-string</code> 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 <code>--set-string</code> Helm CLI flag to define a container image and the value corresponds to artifact i.e. <code>ImageName</code> defined in <code>Build.Artifacts</code> section. The resulting command-line is controlled by <code>ImageStrategy</code>."
},
"chartPath": {
"type": "string",
Expand All @@ -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 <code>values</code> file."
"description": "controls how an `ArtifactOverrides` entry is turned into `--set-string` Helm CLI flag or flags.",
"x-intellij-html-description": "controls how an <code>ArtifactOverrides</code> entry is turned into <code>--set-string</code> Helm CLI flag or flags."
},
"name": {
"type": "string",
Expand Down
11 changes: 7 additions & 4 deletions pkg/skaffold/schema/latest/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"`
Expand Down Expand Up @@ -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"`
}

Expand Down