refactor: disable local registry in some cases

Author: FabianKramm

pkg/devspace/build/build.go

@@ -7,8 +7,6 @@ import (
 	"strings"
 
 	"github.com/loft-sh/devspace/pkg/devspace/build/builder"
-	"github.com/loft-sh/devspace/pkg/devspace/build/builder/buildkit"
-	"github.com/loft-sh/devspace/pkg/devspace/build/builder/docker"
 	"github.com/loft-sh/devspace/pkg/devspace/build/registry"
 	"github.com/loft-sh/devspace/pkg/devspace/build/types"
 	"github.com/loft-sh/devspace/pkg/devspace/config/constants"
@@ -151,38 +149,34 @@ func (c *controller) Build(ctx devspacecontext.Context, images []string, options
 		imageCache.ImageName = imageName
 		imageCache.LocalRegistryImageName = ""
 
-		if registry.UseLocalRegistry(kubeClient, conf, options.SkipPush) && !registry.HasPushPermission(imageConf) {
-			if SupportsLocalRegistry(builder) {
-				// Not able to deploy a local registry without a valid kube context
-				if kubeClient == nil {
-					return fmt.Errorf("unable to push image %s and a valid kube context is not available", imageConf.Image)
-				}
+		if registry.UseLocalRegistry(kubeClient, conf, imageConf, builder, options.SkipPush) && !registry.HasPushPermission(imageConf) {
+			// Not able to deploy a local registry without a valid kube context
+			if kubeClient == nil {
+				return fmt.Errorf("unable to push image %s and a valid kube context is not available", imageConf.Image)
+			}
 
-				registryOptions := registry.NewDefaultOptions().
-					WithNamespace(kubeClient.Namespace()).
-					WithLocalRegistryConfig(conf.LocalRegistry)
+			registryOptions := registry.NewDefaultOptions().
+				WithNamespace(kubeClient.Namespace()).
+				WithLocalRegistryConfig(conf.LocalRegistry)
 
-				// Create and start a local registry if one isn't already running
-				localRegistry, err := registry.GetOrCreateLocalRegistry(ctx, registryOptions)
-				if err != nil {
-					return errors.Wrap(err, "get or create local registry")
-				}
+			// Create and start a local registry if one isn't already running
+			localRegistry, err := registry.GetOrCreateLocalRegistry(ctx, registryOptions)
+			if err != nil {
+				return errors.Wrap(err, "get or create local registry")
+			}
 
-				// Update cache for local registry use
-				imageCache.LocalRegistryImageName, err = localRegistry.RewriteImage(imageName)
-				if err != nil {
-					return errors.Wrap(err, "rewrite image")
-				}
-				ctx.Config().LocalCache().SetImageCache(imageConfigName, imageCache)
+			// Update cache for local registry use
+			imageCache.LocalRegistryImageName, err = localRegistry.RewriteImage(imageName)
+			if err != nil {
+				return errors.Wrap(err, "rewrite image")
+			}
+			ctx.Config().LocalCache().SetImageCache(imageConfigName, imageCache)
 
-				// Reset the builder for local registry usage
-				// TODO: refactor so this isn't necessary!
-				builder, err = c.createBuilder(ctx, imageConfigName, imageConf, imageTags, options)
-				if err != nil {
-					return errors.Wrap(err, "create builder")
-				}
-			} else {
-				ctx.Log().Warnf("unable to push image %s and only docker and buildkit builds support using a local registry", imageConf.Image)
+			// Reset the builder for local registry usage
+			// TODO: refactor so this isn't necessary!
+			builder, err = c.createBuilder(ctx, imageConfigName, imageConf, imageTags, options)
+			if err != nil {
+				return errors.Wrap(err, "create builder")
 			}
 		}
 
@@ -430,14 +424,3 @@ func (c *controller) waitForBuild(ctx devspacecontext.Context, errChan <-chan er
 
 	return nil
 }
-
-func SupportsLocalRegistry(builder builder.Interface) bool {
-	switch builder.(type) {
-	case *buildkit.Builder:
-		return true
-	case *docker.Builder:
-		return true
-	default:
-		return false
-	}
-}

pkg/devspace/build/registry/util.go

@@ -3,8 +3,11 @@ package registry
 import (
 	"context"
 	"fmt"
+	"github.com/loft-sh/devspace/pkg/devspace/build/builder"
+	"github.com/loft-sh/devspace/pkg/devspace/build/builder/kaniko"
 	"io"
 	"net/http"
+	"runtime"
 	"strings"
 
 	"github.com/docker/docker/pkg/jsonmessage"
@@ -120,22 +123,49 @@ func CopyImageToRemote(ctx context.Context, client dockerclient.Client, imageNam
 	return <-errChan
 }
 
-func UseLocalRegistry(client kubectl.Client, config *latest.Config, skipPush bool) bool {
+func UseLocalRegistry(client kubectl.Client, config *latest.Config, imageConfig *latest.Image, imageBuilder builder.Interface, skipPush bool) bool {
 	if skipPush {
 		return false
+	} else if client == nil {
+		return false
 	}
 
-	if client == nil {
+	// TODO: better check for arm64 architectures
+	if runtime.GOARCH != "amd64" {
 		return false
 	}
 
+	// check if builder is kaniko
+	if imageBuilder != nil {
+		_, ok := imageBuilder.(*kaniko.Builder)
+		if ok {
+			return false
+		}
+	}
+
+	// check if image looks weird like localhost / cluster.local
+	if imageConfig != nil {
+		if imageConfig.Kaniko != nil {
+			return false
+		} else if imageConfig.Custom != nil {
+			return false
+		} else if imageConfig.BuildKit != nil && imageConfig.BuildKit.InCluster != nil {
+			return false
+		}
+
+		imageWithoutPort := strings.Split(imageConfig.Image, ":")[0]
+		if imageWithoutPort == "" || imageWithoutPort == "localhost" || imageWithoutPort == "127.0.0.1" || strings.HasSuffix(imageWithoutPort, ".cluster.local") {
+			return false
+		}
+	}
+
+	// check if fallback
 	if !IsLocalRegistryFallback(config) {
 		return IsLocalRegistryEnabled(config)
 	}
 
-	context := client.CurrentContext()
-
 	// Determine if this is a vcluster
+	context := client.CurrentContext()
 	isVClusterContext := strings.Contains(context, "vcluster_")
 
 	// Determine if this is a local kubernetes cluster

pkg/devspace/build/registry/util_test.go

@@ -307,7 +307,7 @@ func TestUseLocalRegistry(t *testing.T) {
 	}
 
 	for _, testCase := range testCases {
-		actual := UseLocalRegistry(testCase.client, testCase.config, testCase.skipPush)
+		actual := UseLocalRegistry(testCase.client, testCase.config, nil, nil, testCase.skipPush)
 		assert.Equal(t, actual, testCase.expected, "Unexpected result in test case %s", testCase.name)
 	}
 }