Add repo field to helm release (#5410)

* add ability to specify repo for helm release * update schema
GoogleContainerTools · Mar 3, 2021 · 31cf2f1 · 31cf2f1
1 parent ba2390d
commit 31cf2f1
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 0 deletions.
diff --git a/docs/content/en/schemas/v2beta13.json b/docs/content/en/schemas/v2beta13.json
@@ -1550,6 +1550,11 @@
           "x-intellij-html-description": "specifies whether the chart path is remote, or exists on the host filesystem.",
           "default": "false"
         },
+        "repo": {
+          "type": "string",
+          "description": "specifies the helm repository for remote charts. If present, Skaffold will send `--repo` Helm CLI flag or flags.",
+          "x-intellij-html-description": "specifies the helm repository for remote charts. If present, Skaffold will send <code>--repo</code> Helm CLI flag or flags."
+        },
         "setFiles": {
           "additionalProperties": {
             "type": "string"
@@ -1621,6 +1626,7 @@
         "skipBuildDependencies",
         "useHelmSecrets",
         "remote",
+        "repo",
         "upgradeOnChange",
         "overrides",
         "packaged",

diff --git a/pkg/skaffold/deploy/helm/args.go b/pkg/skaffold/deploy/helm/args.go
@@ -40,6 +40,7 @@ type installOpts struct {
 	force        bool
 	helmVersion  semver.Version
 	postRenderer string
+	repo         string
 }
 
 // constructOverrideArgs creates the command line arguments for overrides
@@ -152,6 +153,11 @@ func (h *Deployer) installArgs(r latest.HelmRelease, builds []build.Artifact, va
 		args = append(args, "--namespace", o.namespace)
 	}
 
+	if o.repo != "" {
+		args = append(args, "--repo")
+		args = append(args, o.repo)
+	}
+
 	if r.CreateNamespace != nil && *r.CreateNamespace && !o.upgrade {
 		if o.helmVersion.LT(helm32Version) {
 			return nil, createNamespaceErr(h.bV.String())

diff --git a/pkg/skaffold/deploy/helm/deploy.go b/pkg/skaffold/deploy/helm/deploy.go
@@ -308,6 +308,7 @@ func (h *Deployer) deployRelease(ctx context.Context, out io.Writer, releaseName
 		force:       h.forceDeploy,
 		chartPath:   r.ChartPath,
 		helmVersion: helmVersion,
+		repo:        r.Repo,
 	}
 
 	var installEnv []string

diff --git a/pkg/skaffold/deploy/helm/helm_test.go b/pkg/skaffold/deploy/helm/helm_test.go
@@ -89,6 +89,21 @@ var testDeployEnvTemplateNamespacedConfig = latest.HelmDeploy{
 	}},
 }
 
+var testDeployConfigRemoteRepo = latest.HelmDeploy{
+	Releases: []latest.HelmRelease{{
+		Name:      "skaffold-helm",
+		ChartPath: "examples/test",
+		ArtifactOverrides: map[string]string{
+			"image": "skaffold-helm",
+		},
+		Overrides: schemautil.HelmOverrides{Values: map[string]interface{}{"foo": "bar"}},
+		SetValues: map[string]string{
+			"some.key": "somevalue",
+		},
+		Repo: "https://charts.helm.sh/stable",
+	}},
+}
+
 var testDeployConfigTemplated = latest.HelmDeploy{
 	Releases: []latest.HelmRelease{{
 		Name:      "skaffold-helm",
@@ -591,6 +606,17 @@ func TestHelmDeploy(t *testing.T) {
 			builds:             testBuilds,
 			expectedNamespaces: []string{"testReleaseFOOBARNamespace"},
 		},
+		{
+			description: "helm3.1 deploy with repo success",
+			commands: testutil.
+				CmdRunWithOutput("helm version --client", version31).
+				AndRun("helm --kube-context kubecontext get all skaffold-helm --kubeconfig kubeconfig").
+				AndRun("helm --kube-context kubecontext dep build examples/test --kubeconfig kubeconfig").
+				AndRun("helm --kube-context kubecontext upgrade skaffold-helm examples/test --repo https://charts.helm.sh/stable -f skaffold-overrides.yaml --set-string image=docker.io:5000/skaffold-helm:3605e7bc17cf46e53f4d81c4cbc24e5b4c495184 --set some.key=somevalue --kubeconfig kubeconfig").
+				AndRun("helm --kube-context kubecontext get all skaffold-helm --kubeconfig kubeconfig"),
+			helm:   testDeployConfigRemoteRepo,
+			builds: testBuilds,
+		},
 		{
 			description: "helm3.1 namespaced context deploy success",
 			commands: testutil.

diff --git a/pkg/skaffold/schema/latest/config.go b/pkg/skaffold/schema/latest/config.go
@@ -731,6 +731,10 @@ type HelmRelease struct {
 	// Remote specifies whether the chart path is remote, or exists on the host filesystem.
 	Remote bool `yaml:"remote,omitempty"`
 
+	// Repo specifies the helm repository for remote charts.
+	// If present, Skaffold will send `--repo` Helm CLI flag or flags.
+	Repo string `yaml:"repo,omitempty"`
+
 	// UpgradeOnChange specifies whether to upgrade helm chart on code changes.
 	// Default is `true` when helm chart is local (`remote: false`).
 	// Default is `false` if `remote: true`.