refactor: use deployment instead of replica set as replacement

Author: FabianKramm

pkg/devspace/config/loader/validate.go

@@ -327,36 +327,6 @@ func validateImages(config *latest.Config) error {
 	return nil
 }
 
-func isDevPodUnique(index string, rp *latest.DevPod, rps map[string]*latest.DevPod) bool {
-	for i, r := range rps {
-		if i == index {
-			continue
-		}
-
-		if r.ImageSelector != "" && r.ImageSelector == rp.ImageSelector {
-			return false
-		} else if len(r.LabelSelector) > 0 && len(rp.LabelSelector) > 0 && strMapEquals(r.LabelSelector, rp.LabelSelector) {
-			return false
-		}
-	}
-
-	return true
-}
-
-func strMapEquals(a, b map[string]string) bool {
-	if len(a) != len(b) {
-		return false
-	}
-
-	for k, v := range a {
-		if w, ok := b[k]; !ok || v != w {
-			return false
-		}
-	}
-
-	return true
-}
-
 func validateDev(config *latest.Config) error {
 	for devPodName, devPod := range config.Dev {
 		if devPodName == "" {
@@ -365,22 +335,22 @@ func validateDev(config *latest.Config) error {
 		if encoding.IsUnsafeName(devPodName) {
 			return fmt.Errorf("dev[%s] has to match the following regex: %v", devPodName, encoding.UnsafeNameRegEx.String())
 		}
-		if len(devPod.LabelSelector) == 0 && devPod.ImageSelector == "" {
-			return errors.Errorf("dev[%s]: image selector and label selector are nil", devPodName)
+		if len(devPod.LabelSelector) == 0 && devPod.ImageSelector == "" && devPod.Pod == "" {
+			return errors.Errorf("dev[%s]: image selector, pod and label selector are nil", devPodName)
 		}
 
 		definedSelectors := 0
+		if devPod.Pod != "" {
+			definedSelectors++
+		}
 		if devPod.ImageSelector != "" {
 			definedSelectors++
 		}
 		if len(devPod.LabelSelector) > 0 {
 			definedSelectors++
 		}
 		if definedSelectors > 1 {
-			return errors.Errorf("dev[%s]: image selector and label selector cannot both be defined", devPodName)
-		}
-		if !isDevPodUnique(devPodName, devPod, config.Dev) {
-			return errors.Errorf("dev[%s]: image selector or label selector is not unique", devPodName)
+			return errors.Errorf("dev[%s]: image selector, pod and label selector cannot all be defined", devPodName)
 		}
 
 		err := validateDevContainer(fmt.Sprintf("dev[%s]", devPodName), &devPod.DevContainer, false)

pkg/devspace/config/remotecache/schema.go

@@ -68,8 +68,8 @@ type DevPodCache struct {
 	// Namespace is the namespace where the replace happened
 	Namespace string `yaml:"namespace,omitempty"`
 
-	// ReplicaSet is the replica set that was created by DevSpace
-	ReplicaSet string `yaml:"replicaSet,omitempty"`
+	// Deployment is the deployment that was created by DevSpace
+	Deployment string `yaml:"deployment,omitempty"`
 
 	// TargetKind is the kind of the original parent
 	TargetKind string `yaml:"parentKind,omitempty"`

pkg/devspace/config/versions/latest/schema.go

@@ -750,6 +750,7 @@ type KubectlConfig struct {
 
 type DevPod struct {
 	Name          string            `yaml:"name,omitempty" json:"name,omitempty"`
+	Pod           string            `yaml:"pod,omitempty" json:"pod,omitempty"`
 	ImageSelector string            `yaml:"imageSelector,omitempty" json:"imageSelector,omitempty"`
 	LabelSelector map[string]string `yaml:"labelSelector,omitempty" json:"labelSelector,omitempty"`
 	Namespace     string            `yaml:"namespace,omitempty" json:"namespace,omitempty"`
@@ -770,14 +771,24 @@ type DevContainer struct {
 	// Target Container architecture to use for the devspacehelper (currently amd64 or arm64). Defaults to amd64
 	Arch ContainerArchitecture `yaml:"arch,omitempty" json:"arch,omitempty"`
 
-	PortMappingsReverse []*PortMapping   `yaml:"reverseForward,omitempty" json:"reverseForward,omitempty"`
-	Container           string           `yaml:"container,omitempty" json:"container,omitempty"`
-	Terminal            *Terminal        `yaml:"terminal,omitempty" json:"terminal,omitempty"`
-	Logs                *Logs            `yaml:"logs,omitempty" json:"logs,omitempty"`
-	Attach              *Attach          `yaml:"attach,omitempty" json:"attach,omitempty"`
-	ReplaceImage        string           `yaml:"replaceImage,omitempty" json:"replaceImage,omitempty"`
-	PersistPaths        []PersistentPath `yaml:"persistPaths,omitempty" json:"persistPaths,omitempty"`
-	Sync                []*SyncConfig    `yaml:"sync,omitempty" json:"sync,omitempty" patchStrategy:"merge" patchMergeKey:"localSubPath"`
+	PortMappingsReverse  []*PortMapping   `yaml:"reverseForward,omitempty" json:"reverseForward,omitempty"`
+	Container            string           `yaml:"container,omitempty" json:"container,omitempty"`
+	Command              []string         `yaml:"command,omitempty" json:"command,omitempty"`
+	Args                 []string         `yaml:"args,omitempty" json:"args,omitempty"`
+	Env                  []EnvVar         `yaml:"env,omitempty" json:"env,omitempty"`
+	RestartHelperPath    string           `yaml:"restartHelperPath,omitempty" json:"restartHelperPath,omitempty"`
+	DisableRestartHelper bool             `yaml:"disableRestartHelper,omitempty" json:"disableRestartHelper,omitempty"`
+	Terminal             *Terminal        `yaml:"terminal,omitempty" json:"terminal,omitempty"`
+	Logs                 *Logs            `yaml:"logs,omitempty" json:"logs,omitempty"`
+	Attach               *Attach          `yaml:"attach,omitempty" json:"attach,omitempty"`
+	ReplaceImage         string           `yaml:"replaceImage,omitempty" json:"replaceImage,omitempty"`
+	PersistPaths         []PersistentPath `yaml:"persistPaths,omitempty" json:"persistPaths,omitempty"`
+	Sync                 []*SyncConfig    `yaml:"sync,omitempty" json:"sync,omitempty" patchStrategy:"merge" patchMergeKey:"localSubPath"`
+}
+
+type EnvVar struct {
+	Name  string `yaml:"name" json:"name"`
+	Value string `yaml:"value" json:"value"`
 }
 
 type Attach struct {

pkg/devspace/config/versions/v1beta11/upgrade.go

@@ -515,6 +515,13 @@ func (c *Config) mergeDevConfig(log log.Logger) (map[string]*next.DevPod, error)
 		}
 	}
 
+	// disable sync replace
+	for k := range devPods {
+		for i := range devPods[k].Containers {
+			devPods[k].Containers[i].DisableRestartHelper = true
+		}
+	}
+
 	// flatten dev containers
 	for k := range devPods {
 		if len(devPods[k].Containers) == 1 {

pkg/devspace/config/versions/versions.go

@@ -165,7 +165,7 @@ func Parse(data map[string]interface{}, log log.Logger) (*latest.Config, error)
 	decoder.KnownFields(true)
 	err = decoder.Decode(latestConfig)
 	if err != nil {
-		return nil, errors.Errorf("Error loading config: %v", err)
+		return nil, errors.Errorf("error loading config: %v", err)
 	}
 
 	// Upgrade config to latest

pkg/devspace/devpod/devpod.go

@@ -2,13 +2,12 @@ package devpod
 
 import (
 	"context"
+	"fmt"
 	"github.com/loft-sh/devspace/pkg/devspace/config/loader"
 	"github.com/loft-sh/devspace/pkg/devspace/kubectl/selector"
 	"github.com/loft-sh/devspace/pkg/devspace/services/logs"
 	"github.com/loft-sh/devspace/pkg/devspace/services/terminal"
-	"github.com/loft-sh/devspace/pkg/util/log"
 	"github.com/loft-sh/devspace/pkg/util/tomb"
-	"github.com/sirupsen/logrus"
 	"github.com/skratchdot/open-golang/open"
 	"net/http"
 	"os"
@@ -28,6 +27,9 @@ import (
 
 var (
 	openMaxWait = 5 * time.Minute
+
+	terminalDevPodMutex syncpkg.Mutex
+	terminalDevPod      *devPod
 )
 
 type devPod struct {
@@ -122,46 +124,29 @@ func (d *devPod) startWithRetry(ctx *devspacecontext.Context, devPodConfig *late
 	// Create a new tomb and run it
 	tombCtx := t.Context(ctx.Context)
 	ctx = ctx.WithContext(tombCtx)
-	var (
-		hasTerminal bool
-		err         error
-	)
 	<-t.NotifyGo(func() error {
-		hasTerminal, err = d.start(ctx, devPodConfig, options, t)
-		return err
+		return d.start(ctx, devPodConfig, options, t)
 	})
-	if hasTerminal {
-		err = t.Wait()
-		if err != nil {
-			// if we just lost connection we wait here until stopped
-			if _, ok := t.Err().(DevPodLostConnection); ok {
-				<-d.done
-				return nil
-			}
-
-			return err
-		}
-		return nil
-	} else if !t.Alive() {
+	if !t.Alive() {
 		return t.Err()
 	}
 
 	return nil
 }
 
-func (d *devPod) start(ctx *devspacecontext.Context, devPodConfig *latest.DevPod, opts Options, parent *tomb.Tomb) (hasTerminal bool, err error) {
+func (d *devPod) start(ctx *devspacecontext.Context, devPodConfig *latest.DevPod, opts Options, parent *tomb.Tomb) error {
 	// check first if we need to replace the pod
 	if !opts.DisablePodReplace && needPodReplace(devPodConfig) {
 		err := podreplace.NewPodReplacer().ReplacePod(ctx, devPodConfig)
 		if err != nil {
-			return false, errors.Wrap(err, "replace pod")
+			return errors.Wrap(err, "replace pod")
 		}
 	} else {
 		devPodCache, ok := ctx.Config.RemoteCache().GetDevPod(devPodConfig.Name)
-		if ok && devPodCache.ReplicaSet != "" {
+		if ok && devPodCache.Deployment != "" {
 			_, err := podreplace.NewPodReplacer().RevertReplacePod(ctx, &devPodCache)
 			if err != nil {
-				return false, errors.Wrap(err, "replace pod")
+				return errors.Wrap(err, "replace pod")
 			}
 		}
 	}
@@ -170,7 +155,7 @@ func (d *devPod) start(ctx *devspacecontext.Context, devPodConfig *latest.DevPod
 	if devPodConfig.ImageSelector != "" {
 		imageSelectorObject, err := runtimevar.NewRuntimeResolver(ctx.WorkingDir, true).FillRuntimeVariablesAsImageSelector(ctx.Context, devPodConfig.ImageSelector, ctx.Config, ctx.Dependencies)
 		if err != nil {
-			return false, err
+			return err
 		}
 
 		imageSelector = []string{imageSelectorObject.Image}
@@ -179,12 +164,13 @@ func (d *devPod) start(ctx *devspacecontext.Context, devPodConfig *latest.DevPod
 	// wait for pod to be ready
 	ctx.Log.Infof("Waiting for pod to become ready...")
 	options := targetselector.NewEmptyOptions().
-		ApplyConfigParameter("", devPodConfig.LabelSelector, imageSelector, devPodConfig.Namespace, "").
+		ApplyConfigParameter("", devPodConfig.LabelSelector, imageSelector, devPodConfig.Namespace, devPodConfig.Pod).
 		WithWaitingStrategy(targetselector.NewUntilNewestRunningWaitingStrategy(time.Millisecond * 500)).
 		WithSkipInitContainers(true)
+	var err error
 	d.selectedPod, err = targetselector.NewTargetSelector(options).SelectSingleContainer(ctx.Context, ctx.KubeClient, ctx.Log)
 	if err != nil {
-		return false, errors.Wrap(err, "waiting for pod to become ready")
+		return errors.Wrap(err, "waiting for pod to become ready")
 	}
 	ctx.Log.Debugf("Selected pod:container %s:%s", d.selectedPod.Pod.Name, d.selectedPod.Container.Name)
 
@@ -217,17 +203,17 @@ func (d *devPod) start(ctx *devspacecontext.Context, devPodConfig *latest.DevPod
 	// start sync and port forwarding
 	err = d.startSyncAndPortForwarding(ctx, devPodConfig, newTargetSelector(d.selectedPod.Pod.Name, d.selectedPod.Pod.Namespace, d.selectedPod.Container.Name, parent), opts, parent)
 	if err != nil {
-		return false, err
+		return err
 	}
 
 	// start logs or terminal
 	terminalDevContainer := d.getTerminalDevContainer(devPodConfig)
 	if terminalDevContainer != nil {
-		return true, d.startTerminal(ctx, terminalDevContainer, parent)
+		return d.startTerminal(ctx, terminalDevContainer, opts, parent)
 	}
 
 	// TODO attach
-	return false, d.startLogs(ctx, devPodConfig, parent)
+	return d.startLogs(ctx, devPodConfig, parent)
 }
 
 func (d *devPod) startLogs(ctx *devspacecontext.Context, devPodConfig *latest.DevPod, parent *tomb.Tomb) error {
@@ -262,19 +248,28 @@ func (d *devPod) getTerminalDevContainer(devPodConfig *latest.DevPod) *latest.De
 	return devContainer
 }
 
-func (d *devPod) startTerminal(ctx *devspacecontext.Context, devContainer *latest.DevContainer, parent *tomb.Tomb) error {
+func (d *devPod) startTerminal(ctx *devspacecontext.Context, devContainer *latest.DevContainer, opts Options, parent *tomb.Tomb) error {
 	parent.Go(func() error {
+		err := setTerminalDevPod(d)
+		if err != nil {
+			return err
+		}
+
 		// make sure the global log is silent
-		before := log.GetBaseInstance().GetLevel()
-		log.GetBaseInstance().SetLevel(logrus.PanicLevel)
-		err := terminal.StartTerminal(ctx, devContainer, newTargetSelector(d.selectedPod.Pod.Name, d.selectedPod.Pod.Namespace, d.selectedPod.Container.Name, parent), os.Stdout, os.Stderr, os.Stdin, parent)
-		log.GetBaseInstance().SetLevel(before)
+		err = terminal.StartTerminal(ctx, devContainer, newTargetSelector(d.selectedPod.Pod.Name, d.selectedPod.Pod.Namespace, d.selectedPod.Container.Name, parent), os.Stdout, os.Stderr, os.Stdin, parent)
+		terminalDevPodMutex.Lock()
+		terminalDevPod = nil
+		terminalDevPodMutex.Unlock()
 		if err != nil {
 			return errors.Wrap(err, "error in terminal forwarding")
 		}
 
 		// kill ourselves here
-		parent.Kill(nil)
+		if !opts.ContinueOnTerminalExit && opts.KillApplication != nil {
+			go opts.KillApplication()
+		} else {
+			parent.Kill(nil)
+		}
 		return nil
 	})
 
@@ -345,6 +340,34 @@ func needPodReplaceContainer(devContainer *latest.DevContainer) bool {
 	if devContainer.Terminal != nil && !devContainer.Terminal.Disabled && !devContainer.Terminal.DisableReplace {
 		return true
 	}
+	if len(devContainer.Env) > 0 {
+		return true
+	}
+	if len(devContainer.Command) > 0 {
+		return true
+	}
+	if devContainer.Args != nil {
+		return true
+	}
+	if !devContainer.DisableRestartHelper {
+		for _, s := range devContainer.Sync {
+			if s.OnUpload != nil && s.OnUpload.RestartContainer {
+				return true
+			}
+		}
+	}
 
 	return false
 }
+
+func setTerminalDevPod(devPod *devPod) error {
+	terminalDevPodMutex.Lock()
+	defer terminalDevPodMutex.Unlock()
+
+	if terminalDevPod != nil {
+		return fmt.Errorf("error starting terminal as it is currently already used by another dev pod")
+	}
+
+	terminalDevPod = devPod
+	return nil
+}

pkg/devspace/devpod/manager.go

@@ -13,9 +13,14 @@ import (
 )
 
 type Options struct {
+	ContinueOnTerminalExit bool `long:"continue-on-terminal-exit" description:"Continue on terminal exit"`
+
 	DisableSync           bool `long:"disable-sync" description:"If enabled will not start any sync configuration"`
 	DisablePortForwarding bool `long:"disable-port-forwarding" description:"If enabled will not start any port forwarding configuration"`
 	DisablePodReplace     bool `long:"disable-pod-replace" description:"If enabled will not replace any pods"`
+
+	// KillApplication kills the whole pipeline including all dev pods
+	KillApplication func()
 }
 
 type Manager interface {

pkg/devspace/helm/generic/generic.go

@@ -7,7 +7,6 @@ import (
 	"github.com/loft-sh/devspace/pkg/util/command"
 	"io/ioutil"
 	"os"
-	"os/exec"
 	"path/filepath"
 	"strings"
 
@@ -89,11 +88,7 @@ func (c *client) Exec(ctx *devspacecontext.Context, args []string, helmConfig *l
 	}
 	result, err := command.Output(ctx.Context, ctx.WorkingDir, c.helmPath, args...)
 	if err != nil {
-		if exitError, ok := err.(*exec.ExitError); ok {
-			return nil, fmt.Errorf("error during '%s %s':\n %s%s => %v", c.helmPath, strings.Join(args, " "), string(result), string(exitError.Stderr), err)
-		}
-
-		return nil, fmt.Errorf("error during '%s %s':\n %s => %v %s", c.helmPath, strings.Join(args, " "), string(result), err)
+		return nil, fmt.Errorf("%s %v", string(result), err)
 	}
 
 	return result, nil

pkg/devspace/pipeline/engine/pipelinehandler/commands/deploy.go

@@ -76,14 +76,13 @@ func applySetValues(ctx *devspacecontext.Context, name, objName string, set, set
 		return nil, err
 	}
 
+	if rawConfig[name] == nil {
+		rawConfig[name] = map[string]interface{}{}
+	}
 	_, ok := rawConfig[name].(map[string]interface{})
 	if !ok {
 		return ctx, nil
 	}
-
-	if rawConfig[name] == nil {
-		rawConfig[name] = map[string]interface{}{}
-	}
 	if rawConfig[name].(map[string]interface{})[objName] == nil {
 		rawConfig[name].(map[string]interface{})[objName] = map[string]interface{}{}
 	}