mirror of https://github.com/helm/helm
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
266 lines
8.3 KiB
266 lines
8.3 KiB
/*
|
|
Copyright The Helm Authors.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
package action
|
|
|
|
import (
|
|
"bytes"
|
|
"fmt"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/pkg/errors"
|
|
|
|
"helm.sh/helm/v3/pkg/chartutil"
|
|
"helm.sh/helm/v3/pkg/release"
|
|
helmtime "helm.sh/helm/v3/pkg/time"
|
|
)
|
|
|
|
// Rollback is the action for rolling back to a given release.
|
|
//
|
|
// It provides the implementation of 'helm rollback'.
|
|
type Rollback struct {
|
|
cfg *Configuration
|
|
|
|
Version int
|
|
Timeout time.Duration
|
|
Wait bool
|
|
WaitForJobs bool
|
|
DisableHooks bool
|
|
DryRun bool
|
|
Recreate bool // will (if true) recreate pods after a rollback.
|
|
Force bool // will (if true) force resource upgrade through uninstall/recreate if needed
|
|
CleanupOnFail bool
|
|
MaxHistory int // MaxHistory limits the maximum number of revisions saved per release
|
|
}
|
|
|
|
// NewRollback creates a new Rollback object with the given configuration.
|
|
func NewRollback(cfg *Configuration) *Rollback {
|
|
return &Rollback{
|
|
cfg: cfg,
|
|
}
|
|
}
|
|
|
|
// Run executes 'helm rollback' against the given release.
|
|
func (r *Rollback) Run(name string) error {
|
|
if err := r.cfg.KubeClient.IsReachable(); err != nil {
|
|
return err
|
|
}
|
|
|
|
r.cfg.Releases.MaxHistory = r.MaxHistory
|
|
|
|
r.cfg.Log("preparing rollback of %s", name)
|
|
currentRelease, targetRelease, err := r.prepareRollback(name)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if !r.DryRun {
|
|
r.cfg.Log("creating rolled back release for %s", name)
|
|
if err := r.cfg.Releases.Create(targetRelease); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
r.cfg.Log("performing rollback of %s", name)
|
|
if _, err := r.performRollback(currentRelease, targetRelease); err != nil {
|
|
return err
|
|
}
|
|
|
|
if !r.DryRun {
|
|
r.cfg.Log("updating status for rolled back release for %s", name)
|
|
if err := r.cfg.Releases.Update(targetRelease); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// prepareRollback finds the previous release and prepares a new release object with
|
|
// the previous release's configuration
|
|
func (r *Rollback) prepareRollback(name string) (*release.Release, *release.Release, error) {
|
|
if err := chartutil.ValidateReleaseName(name); err != nil {
|
|
return nil, nil, errors.Errorf("prepareRollback: Release name is invalid: %s", name)
|
|
}
|
|
|
|
if r.Version < 0 {
|
|
return nil, nil, errInvalidRevision
|
|
}
|
|
|
|
currentRelease, err := r.cfg.Releases.Last(name)
|
|
if err != nil {
|
|
return nil, nil, err
|
|
}
|
|
|
|
previousVersion := r.Version
|
|
if r.Version == 0 {
|
|
previousVersion = currentRelease.Version - 1
|
|
}
|
|
|
|
historyReleases, err := r.cfg.Releases.History(name)
|
|
if err != nil {
|
|
return nil, nil, err
|
|
}
|
|
|
|
// Check if the history version to be rolled back exists
|
|
previousVersionExist := false
|
|
for _, historyRelease := range historyReleases {
|
|
version := historyRelease.Version
|
|
if previousVersion == version {
|
|
previousVersionExist = true
|
|
break
|
|
}
|
|
}
|
|
if !previousVersionExist {
|
|
return nil, nil, errors.Errorf("release has no %d version", previousVersion)
|
|
}
|
|
|
|
r.cfg.Log("rolling back %s (current: v%d, target: v%d)", name, currentRelease.Version, previousVersion)
|
|
|
|
previousRelease, err := r.cfg.Releases.Get(name, previousVersion)
|
|
if err != nil {
|
|
return nil, nil, err
|
|
}
|
|
|
|
// Store a new release object with previous release's configuration
|
|
targetRelease := &release.Release{
|
|
Name: name,
|
|
Namespace: currentRelease.Namespace,
|
|
Chart: previousRelease.Chart,
|
|
Config: previousRelease.Config,
|
|
Info: &release.Info{
|
|
FirstDeployed: currentRelease.Info.FirstDeployed,
|
|
LastDeployed: helmtime.Now(),
|
|
Status: release.StatusPendingRollback,
|
|
Notes: previousRelease.Info.Notes,
|
|
// Because we lose the reference to previous version elsewhere, we set the
|
|
// message here, and only override it later if we experience failure.
|
|
Description: fmt.Sprintf("Rollback to %d", previousVersion),
|
|
},
|
|
Version: currentRelease.Version + 1,
|
|
Labels: previousRelease.Labels,
|
|
Manifest: previousRelease.Manifest,
|
|
Hooks: previousRelease.Hooks,
|
|
}
|
|
|
|
return currentRelease, targetRelease, nil
|
|
}
|
|
|
|
func (r *Rollback) performRollback(currentRelease, targetRelease *release.Release) (*release.Release, error) {
|
|
if r.DryRun {
|
|
r.cfg.Log("dry run for %s", targetRelease.Name)
|
|
return targetRelease, nil
|
|
}
|
|
|
|
current, err := r.cfg.KubeClient.Build(bytes.NewBufferString(currentRelease.Manifest), false)
|
|
if err != nil {
|
|
return targetRelease, errors.Wrap(err, "unable to build kubernetes objects from current release manifest")
|
|
}
|
|
target, err := r.cfg.KubeClient.Build(bytes.NewBufferString(targetRelease.Manifest), false)
|
|
if err != nil {
|
|
return targetRelease, errors.Wrap(err, "unable to build kubernetes objects from new release manifest")
|
|
}
|
|
|
|
// pre-rollback hooks
|
|
if !r.DisableHooks {
|
|
if err := r.cfg.execHook(targetRelease, release.HookPreRollback, r.Timeout); err != nil {
|
|
return targetRelease, err
|
|
}
|
|
} else {
|
|
r.cfg.Log("rollback hooks disabled for %s", targetRelease.Name)
|
|
}
|
|
|
|
// It is safe to use "force" here because these are resources currently rendered by the chart.
|
|
err = target.Visit(setMetadataVisitor(targetRelease.Name, targetRelease.Namespace, true))
|
|
if err != nil {
|
|
return targetRelease, errors.Wrap(err, "unable to set metadata visitor from target release")
|
|
}
|
|
results, err := r.cfg.KubeClient.Update(current, target, r.Force)
|
|
|
|
if err != nil {
|
|
msg := fmt.Sprintf("Rollback %q failed: %s", targetRelease.Name, err)
|
|
r.cfg.Log("warning: %s", msg)
|
|
currentRelease.Info.Status = release.StatusSuperseded
|
|
targetRelease.Info.Status = release.StatusFailed
|
|
targetRelease.Info.Description = msg
|
|
r.cfg.recordRelease(currentRelease)
|
|
r.cfg.recordRelease(targetRelease)
|
|
if r.CleanupOnFail {
|
|
r.cfg.Log("Cleanup on fail set, cleaning up %d resources", len(results.Created))
|
|
_, errs := r.cfg.KubeClient.Delete(results.Created)
|
|
if errs != nil {
|
|
var errorList []string
|
|
for _, e := range errs {
|
|
errorList = append(errorList, e.Error())
|
|
}
|
|
return targetRelease, errors.Wrapf(fmt.Errorf("unable to cleanup resources: %s", strings.Join(errorList, ", ")), "an error occurred while cleaning up resources. original rollback error: %s", err)
|
|
}
|
|
r.cfg.Log("Resource cleanup complete")
|
|
}
|
|
return targetRelease, err
|
|
}
|
|
|
|
if r.Recreate {
|
|
// NOTE: Because this is not critical for a release to succeed, we just
|
|
// log if an error occurs and continue onward. If we ever introduce log
|
|
// levels, we should make these error level logs so users are notified
|
|
// that they'll need to go do the cleanup on their own
|
|
if err := recreate(r.cfg, results.Updated); err != nil {
|
|
r.cfg.Log(err.Error())
|
|
}
|
|
}
|
|
|
|
if r.Wait {
|
|
if r.WaitForJobs {
|
|
if err := r.cfg.KubeClient.WaitWithJobs(target, r.Timeout); err != nil {
|
|
targetRelease.SetStatus(release.StatusFailed, fmt.Sprintf("Release %q failed: %s", targetRelease.Name, err.Error()))
|
|
r.cfg.recordRelease(currentRelease)
|
|
r.cfg.recordRelease(targetRelease)
|
|
return targetRelease, errors.Wrapf(err, "release %s failed", targetRelease.Name)
|
|
}
|
|
} else {
|
|
if err := r.cfg.KubeClient.Wait(target, r.Timeout); err != nil {
|
|
targetRelease.SetStatus(release.StatusFailed, fmt.Sprintf("Release %q failed: %s", targetRelease.Name, err.Error()))
|
|
r.cfg.recordRelease(currentRelease)
|
|
r.cfg.recordRelease(targetRelease)
|
|
return targetRelease, errors.Wrapf(err, "release %s failed", targetRelease.Name)
|
|
}
|
|
}
|
|
}
|
|
|
|
// post-rollback hooks
|
|
if !r.DisableHooks {
|
|
if err := r.cfg.execHook(targetRelease, release.HookPostRollback, r.Timeout); err != nil {
|
|
return targetRelease, err
|
|
}
|
|
}
|
|
|
|
deployed, err := r.cfg.Releases.DeployedAll(currentRelease.Name)
|
|
if err != nil && !strings.Contains(err.Error(), "has no deployed releases") {
|
|
return nil, err
|
|
}
|
|
// Supersede all previous deployments, see issue #2941.
|
|
for _, rel := range deployed {
|
|
r.cfg.Log("superseding previous deployment %d", rel.Version)
|
|
rel.Info.Status = release.StatusSuperseded
|
|
r.cfg.recordRelease(rel)
|
|
}
|
|
|
|
targetRelease.Info.Status = release.StatusDeployed
|
|
|
|
return targetRelease, nil
|
|
}
|