From f3ba6a7339e7a7f71aff6ace28c756f7208642e6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oliver=20B=C3=A4hler?= Date: Tue, 23 Feb 2021 18:59:20 +0100 Subject: [PATCH 1/4] Add --dependency-update for upgrade cmd MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Oliver Bähler --- cmd/helm/upgrade.go | 34 ++++++++++++++++++++++++++++++++++ pkg/action/upgrade.go | 2 ++ 2 files changed, 36 insertions(+) diff --git a/cmd/helm/upgrade.go b/cmd/helm/upgrade.go index c2e92fb36..9e9504b8f 100644 --- a/cmd/helm/upgrade.go +++ b/cmd/helm/upgrade.go @@ -30,6 +30,7 @@ import ( "helm.sh/helm/v3/pkg/chart/loader" "helm.sh/helm/v3/pkg/cli/output" "helm.sh/helm/v3/pkg/cli/values" + "helm.sh/helm/v3/pkg/downloader" "helm.sh/helm/v3/pkg/getter" "helm.sh/helm/v3/pkg/storage/driver" ) @@ -105,6 +106,7 @@ func newUpgradeCmd(cfg *action.Configuration, out io.Writer) *cobra.Command { instClient.Wait = client.Wait instClient.WaitForJobs = client.WaitForJobs instClient.Devel = client.Devel + instClient.DependencyUpdate = client.DependencyUpdate instClient.Namespace = client.Namespace instClient.Atomic = client.Atomic instClient.PostRenderer = client.PostRenderer @@ -132,6 +134,7 @@ func newUpgradeCmd(cfg *action.Configuration, out io.Writer) *cobra.Command { return err } + p := getter.All(settings) vals, err := valueOpts.MergeValues(getter.All(settings)) if err != nil { return err @@ -142,7 +145,37 @@ func newUpgradeCmd(cfg *action.Configuration, out io.Writer) *cobra.Command { if err != nil { return err } + + // Only check dependencies if there are any if req := ch.Metadata.Dependencies; req != nil { + // Update all dependencies if DependencyUpdate is true + if client.DependencyUpdate { + man := &downloader.Manager{ + Out: out, + ChartPath: chartPath, + Keyring: client.ChartPathOptions.Keyring, + SkipUpdate: false, + Getters: p, + RepositoryConfig: settings.RepositoryConfig, + RepositoryCache: settings.RepositoryCache, + Debug: settings.Debug, + } + + // reload chart dependencies + if err := man.Update(); err != nil { + return err + } + + // Reload the chart with the updated Chart.lock file. + if ch, err = loader.Load(chartPath); err != nil { + return errors.Wrap(err, "failed reloading chart after repo update") + } + } + + // If CheckDependencies returns an error, we have unfulfilled dependencies. + // As of Helm 2.4.0, this is treated as a stopping condition: + // https://github.com/helm/helm/issues/2209 + // Update all dependencies if DependencyUpdate is true if err := action.CheckDependencies(ch, req); err != nil { return err } @@ -182,6 +215,7 @@ func newUpgradeCmd(cfg *action.Configuration, out io.Writer) *cobra.Command { f.BoolVar(&client.Wait, "wait", false, "if set, will wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. It will wait for as long as --timeout") f.BoolVar(&client.WaitForJobs, "wait-for-jobs", false, "if set and --wait enabled, will wait until all Jobs have been completed before marking the release as successful. It will wait for as long as --timeout") f.BoolVar(&client.Atomic, "atomic", false, "if set, upgrade process rolls back changes made in case of failed upgrade. The --wait flag will be set automatically if --atomic is used") + f.BoolVar(&client.DependencyUpdate, "dependency-update", false, "run helm dependency update before upgrading the chart") f.IntVar(&client.MaxHistory, "history-max", settings.MaxHistory, "limit the maximum number of revisions saved per release. Use 0 for no limit") f.BoolVar(&client.CleanupOnFail, "cleanup-on-fail", false, "allow deletion of new resources created in this upgrade when upgrade fails") f.BoolVar(&client.SubNotes, "render-subchart-notes", false, "if set, render subchart notes along with the parent") diff --git a/pkg/action/upgrade.go b/pkg/action/upgrade.go index b0f294cae..f7956f6d9 100644 --- a/pkg/action/upgrade.go +++ b/pkg/action/upgrade.go @@ -98,6 +98,8 @@ type Upgrade struct { PostRenderer postrender.PostRenderer // DisableOpenAPIValidation controls whether OpenAPI validation is enforced. DisableOpenAPIValidation bool + // Upgrade Chart dependencies before upgrade if true + DependencyUpdate bool } // NewUpgrade creates a new Upgrade object with the given configuration. From 419771c8defbabfb151209bc8f9712aa366977ba Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oliver=20B=C3=A4hler?= Date: Thu, 25 Feb 2021 14:39:02 +0100 Subject: [PATCH 2/4] Implement UpdateDependencies function MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Oliver Bähler --- cmd/helm/install.go | 17 +---------- .../chart-with-subchart-notes/Chart.lock | 6 ++++ cmd/helm/upgrade.go | 22 ++------------ pkg/action/dependency.go | 29 +++++++++++++++++++ 4 files changed, 38 insertions(+), 36 deletions(-) create mode 100644 cmd/helm/testdata/testcharts/chart-with-subchart-notes/Chart.lock diff --git a/cmd/helm/install.go b/cmd/helm/install.go index fac2131c1..998022a0c 100644 --- a/cmd/helm/install.go +++ b/cmd/helm/install.go @@ -31,7 +31,6 @@ import ( "helm.sh/helm/v3/pkg/chart/loader" "helm.sh/helm/v3/pkg/cli/output" "helm.sh/helm/v3/pkg/cli/values" - "helm.sh/helm/v3/pkg/downloader" "helm.sh/helm/v3/pkg/getter" "helm.sh/helm/v3/pkg/release" ) @@ -215,23 +214,9 @@ func runInstall(args []string, client *action.Install, valueOpts *values.Options // https://github.com/helm/helm/issues/2209 if err := action.CheckDependencies(chartRequested, req); err != nil { if client.DependencyUpdate { - man := &downloader.Manager{ - Out: out, - ChartPath: cp, - Keyring: client.ChartPathOptions.Keyring, - SkipUpdate: false, - Getters: p, - RepositoryConfig: settings.RepositoryConfig, - RepositoryCache: settings.RepositoryCache, - Debug: settings.Debug, - } - if err := man.Update(); err != nil { + if chartRequested, err = action.UpdateDependencies(cp, client.ChartPathOptions.Keyring, settings, out, p); err != nil { return nil, err } - // Reload the chart with the updated Chart.lock file. - if chartRequested, err = loader.Load(cp); err != nil { - return nil, errors.Wrap(err, "failed reloading chart after repo update") - } } else { return nil, err } diff --git a/cmd/helm/testdata/testcharts/chart-with-subchart-notes/Chart.lock b/cmd/helm/testdata/testcharts/chart-with-subchart-notes/Chart.lock new file mode 100644 index 000000000..a3e80d6e5 --- /dev/null +++ b/cmd/helm/testdata/testcharts/chart-with-subchart-notes/Chart.lock @@ -0,0 +1,6 @@ +dependencies: +- name: subchart-with-notes + repository: "" + version: 0.0.1 +digest: sha256:eb038c91a8a689391fdbedd7a1016b2512bc3daee2a11afb7f359ba1341f03c6 +generated: "2021-02-25T14:22:08.359847407+01:00" diff --git a/cmd/helm/upgrade.go b/cmd/helm/upgrade.go index 9e9504b8f..62c079f4a 100644 --- a/cmd/helm/upgrade.go +++ b/cmd/helm/upgrade.go @@ -30,7 +30,6 @@ import ( "helm.sh/helm/v3/pkg/chart/loader" "helm.sh/helm/v3/pkg/cli/output" "helm.sh/helm/v3/pkg/cli/values" - "helm.sh/helm/v3/pkg/downloader" "helm.sh/helm/v3/pkg/getter" "helm.sh/helm/v3/pkg/storage/driver" ) @@ -148,28 +147,11 @@ func newUpgradeCmd(cfg *action.Configuration, out io.Writer) *cobra.Command { // Only check dependencies if there are any if req := ch.Metadata.Dependencies; req != nil { - // Update all dependencies if DependencyUpdate is true if client.DependencyUpdate { - man := &downloader.Manager{ - Out: out, - ChartPath: chartPath, - Keyring: client.ChartPathOptions.Keyring, - SkipUpdate: false, - Getters: p, - RepositoryConfig: settings.RepositoryConfig, - RepositoryCache: settings.RepositoryCache, - Debug: settings.Debug, - } - - // reload chart dependencies - if err := man.Update(); err != nil { + // Update all dependencies if DependencyUpdate is true + if ch, err = action.UpdateDependencies(chartPath, client.ChartPathOptions.Keyring, settings, out, p); err != nil { return err } - - // Reload the chart with the updated Chart.lock file. - if ch, err = loader.Load(chartPath); err != nil { - return errors.Wrap(err, "failed reloading chart after repo update") - } } // If CheckDependencies returns an error, we have unfulfilled dependencies. diff --git a/pkg/action/dependency.go b/pkg/action/dependency.go index 4c80d0159..236223740 100644 --- a/pkg/action/dependency.go +++ b/pkg/action/dependency.go @@ -25,9 +25,13 @@ import ( "github.com/Masterminds/semver/v3" "github.com/gosuri/uitable" + "github.com/pkg/errors" "helm.sh/helm/v3/pkg/chart" "helm.sh/helm/v3/pkg/chart/loader" + "helm.sh/helm/v3/pkg/cli" + "helm.sh/helm/v3/pkg/downloader" + "helm.sh/helm/v3/pkg/getter" ) // Dependency is the action for building a given chart's dependency tree. @@ -225,3 +229,28 @@ func (d *Dependency) printMissing(chartpath string, out io.Writer, reqs []*chart } } } + +// UpdateDependencies update dependency charts. +func UpdateDependencies(chartPath string, keyRing string, settings *cli.EnvSettings, out io.Writer, p getter.Providers) (*chart.Chart, error) { + // Update all dependencies if DependencyUpdate is true + man := &downloader.Manager{ + Out: out, + ChartPath: chartPath, + Keyring: keyRing, + SkipUpdate: false, + Getters: p, + RepositoryConfig: settings.RepositoryConfig, + RepositoryCache: settings.RepositoryCache, + Debug: settings.Debug, + } + // Reload chart dependencies + if err := man.Update(); err != nil { + return nil, err + } + // Reload the chart with the updated Chart.lock file. + ch, err := loader.Load(chartPath) + if err != nil { + return nil, errors.Wrap(err, "failed reloading chart after repo update") + } + return ch, nil +} From 583c8c53c41f41461de35a10195ffc426fb7463c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oliver=20B=C3=A4hler?= Date: Thu, 25 Feb 2021 14:39:22 +0100 Subject: [PATCH 3/4] Remove Lock MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Oliver Bähler --- .../testcharts/chart-with-subchart-notes/Chart.lock | 6 ------ 1 file changed, 6 deletions(-) delete mode 100644 cmd/helm/testdata/testcharts/chart-with-subchart-notes/Chart.lock diff --git a/cmd/helm/testdata/testcharts/chart-with-subchart-notes/Chart.lock b/cmd/helm/testdata/testcharts/chart-with-subchart-notes/Chart.lock deleted file mode 100644 index a3e80d6e5..000000000 --- a/cmd/helm/testdata/testcharts/chart-with-subchart-notes/Chart.lock +++ /dev/null @@ -1,6 +0,0 @@ -dependencies: -- name: subchart-with-notes - repository: "" - version: 0.0.1 -digest: sha256:eb038c91a8a689391fdbedd7a1016b2512bc3daee2a11afb7f359ba1341f03c6 -generated: "2021-02-25T14:22:08.359847407+01:00" From b034bc72d07da37d8323bbab285dc797641a0e9a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oliver=20B=C3=A4hler?= Date: Thu, 25 Feb 2021 14:42:53 +0100 Subject: [PATCH 4/4] Add Comments MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Oliver Bähler --- cmd/helm/install.go | 1 + cmd/helm/upgrade.go | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/cmd/helm/install.go b/cmd/helm/install.go index 998022a0c..4e0bc557c 100644 --- a/cmd/helm/install.go +++ b/cmd/helm/install.go @@ -214,6 +214,7 @@ func runInstall(args []string, client *action.Install, valueOpts *values.Options // https://github.com/helm/helm/issues/2209 if err := action.CheckDependencies(chartRequested, req); err != nil { if client.DependencyUpdate { + // Update all dependencies if DependencyUpdate flag is set (Implemented with PR#9399) if chartRequested, err = action.UpdateDependencies(cp, client.ChartPathOptions.Keyring, settings, out, p); err != nil { return nil, err } diff --git a/cmd/helm/upgrade.go b/cmd/helm/upgrade.go index 62c079f4a..2bc654a34 100644 --- a/cmd/helm/upgrade.go +++ b/cmd/helm/upgrade.go @@ -148,7 +148,7 @@ func newUpgradeCmd(cfg *action.Configuration, out io.Writer) *cobra.Command { // Only check dependencies if there are any if req := ch.Metadata.Dependencies; req != nil { if client.DependencyUpdate { - // Update all dependencies if DependencyUpdate is true + // Update all dependencies if DependencyUpdate flag is set (Implemented with PR#9399) if ch, err = action.UpdateDependencies(chartPath, client.ChartPathOptions.Keyring, settings, out, p); err != nil { return err }