Merge pull request #2584 from 89luca89/local_docker_build

feat: support local builds with docker/podman for local registry

Author: FabianKramm

.gitignore

@@ -24,6 +24,9 @@ tags
 # VS Code
 .vscode/ipch
 
+# Vim
+*.vim
+
 /ui/node_modules
 /ui/build/static/js/*.js.map
 

devspace-schema.json

@@ -1230,6 +1230,10 @@
           "type": "boolean",
           "description": "Enabled enables the local registry for pushing images.\nWhen unset the local registry will be used as a fallback if there are no push permissions for the registry.\nWhen `true` the local registry will always be used.\nWhen `false` the local registry will never be used."
         },
+        "localbuild": {
+          "type": "boolean",
+          "description": "LocalBuild enables use of local docker builder instead of building in the cluster"
+        },
         "namespace": {
           "type": "string",
           "description": "Namespace where the local registry is deployed. Default is the current context's namespace"

docs/pages/configuration/_partials/v2beta1/localRegistry/localbuild.mdx

@@ -0,0 +1,13 @@
+
+<details className="config-field" data-expandable="false" open>
+<summary>
+
+### `localbuild` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">boolean</span> <span className="config-field-default">false</span> <span className="config-field-enum"></span> {#localRegistry-localbuild}
+
+LocalBuild enables use of local docker builder instead of building in the cluster
+
+</summary>
+
+
+
+</details>

docs/pages/configuration/_partials/v2beta1/localRegistry_reference.mdx

@@ -1,5 +1,6 @@
 
 import PartialEnabled from "./localRegistry/enabled.mdx"
+import PartialLocalbuild from "./localRegistry/localbuild.mdx"
 import PartialNamespace from "./localRegistry/namespace.mdx"
 import PartialName from "./localRegistry/name.mdx"
 import PartialImage from "./localRegistry/image.mdx"
@@ -10,6 +11,9 @@ import PartialPersistencereference from "./localRegistry/persistence_reference.m
 <PartialEnabled />
 
 
+<PartialLocalbuild />
+
+
 <PartialNamespace />
 
 

docs/pages/configuration/localRegistry/README.mdx

@@ -17,6 +17,7 @@ Local registry configuration is defined in the `localRegistry` section of the `d
     defaultValue="default"
     values={[
         { label: 'Defaults', value: 'default', },
+        { label: 'Build locally with Docker/Podman', value: 'localbuild', },
         { label: 'Force Local Registry', value: 'force', },
         { label: 'Persistence', value: 'persistence', },
     ]
@@ -30,10 +31,21 @@ Local registry configuration is defined in the `localRegistry` section of the `d
 # localRegistry:
 #   name: registry
 #   namespace: [KUBE CONTEXT NAMESPACE]
+#   localbuild: false
 #   image: registry:2.8.1
 #   port: 5000
 ```
 
+</TabItem>
+<TabItem value="localbuild">
+
+```yaml
+# The local registry will not use buildkit on the cluster, but your docker/podman daemon
+# and then push it to the local registry in the cluster
+localRegistry:
+  localbuild: true
+```
+
 </TabItem>
 <TabItem value="persistence">
 

docs/schemas/config-openapi.json

@@ -1238,6 +1238,10 @@
                 "type": "boolean",
                 "description": "Enabled enables the local registry for pushing images.\nWhen unset the local registry will be used as a fallback if there are no push permissions for the registry.\nWhen `true` the local registry will always be used.\nWhen `false` the local registry will never be used."
               },
+              "localbuild": {
+                "type": "boolean",
+                "description": "LocalBuild enables use of local docker builder instead of building in the cluster"
+              },
               "namespace": {
                 "type": "string",
                 "description": "Namespace where the local registry is deployed. Default is the current context's namespace"

e2e/tests/deploy/deploy.go

@@ -482,7 +482,7 @@ var _ = DevSpaceDescribe("deploy", func() {
 		framework.ExpectNoError(err)
 		framework.ExpectEqual(deployment.Spec.Template.Spec.Containers[0].Name, "nginx")
 		framework.ExpectEqual(deployment.Spec.Template.Spec.Containers[0].Image, "nginx:1.23.3")
-		framework.ExpectEqual(deployment.Spec.Template.GetObjectMeta().GetLabels(), map[string]string {"app": "nginx", "test": "test123"})
+		framework.ExpectEqual(deployment.Spec.Template.GetObjectMeta().GetLabels(), map[string]string{"app": "nginx", "test": "test123"})
 		framework.ExpectEqual(deployment.Spec.Template.Spec.Containers[1].Name, "busybox")
 		framework.ExpectEqual(deployment.Spec.Template.Spec.Containers[2].Name, "alpine")
 		// Ensure the wildcard works
@@ -533,7 +533,7 @@ var _ = DevSpaceDescribe("deploy", func() {
 		framework.ExpectNoError(err)
 		framework.ExpectEqual(deployment.Spec.Template.Spec.Containers[0].Name, "nginx")
 		framework.ExpectEqual(deployment.Spec.Template.Spec.Containers[0].Image, "nginx:1.23.3")
-		framework.ExpectEqual(deployment.Spec.Template.GetObjectMeta().GetLabels(), map[string]string {"app": "nginx", "test": "test123"})
+		framework.ExpectEqual(deployment.Spec.Template.GetObjectMeta().GetLabels(), map[string]string{"app": "nginx", "test": "test123"})
 		framework.ExpectEqual(deployment.Spec.Template.Spec.Containers[1].Name, "busybox")
 		framework.ExpectEqual(deployment.Spec.Template.Spec.Containers[2].Name, "alpine")
 		// Ensure the wildcard works
@@ -542,7 +542,6 @@ var _ = DevSpaceDescribe("deploy", func() {
 		framework.ExpectEqual(deployment.Spec.Template.Spec.Containers[2].Env[0], v1.EnvVar{Name: "test", Value: "test123"})
 	})
 
-
 	ginkgo.It("should deploy helm chart from specific branch in git repo", func() {
 		tempDir, err := framework.CopyToTempDir("tests/deploy/testdata/helm_git_branch")
 		framework.ExpectNoError(err)

e2e/tests/localregistry/localregistry.go

@@ -3,11 +3,15 @@ package localregistry
 import (
 	"bytes"
 	"context"
-	"github.com/loft-sh/devspace/pkg/devspace/build/localregistry"
-	"github.com/onsi/ginkgo/v2"
+	"fmt"
 	"os"
 	"time"
 
+	"github.com/google/go-containerregistry/pkg/name"
+	"github.com/google/go-containerregistry/pkg/v1/remote"
+	"github.com/loft-sh/devspace/pkg/devspace/build/localregistry"
+	"github.com/onsi/ginkgo/v2"
+
 	"github.com/sirupsen/logrus"
 	appsv1 "k8s.io/api/apps/v1"
 	corev1 "k8s.io/api/core/v1"
@@ -83,6 +87,7 @@ var _ = DevSpaceDescribe("localregistry", func() {
 			done <- devCmd.RunDefault(f)
 		}()
 
+		var registryHost string
 		ginkgo.By("Waiting for registry service node port")
 		gomega.Eventually(func() (*corev1.Service, error) {
 			service, err := getRegistryService(ctx, kubeClient, ns)
@@ -93,6 +98,7 @@ var _ = DevSpaceDescribe("localregistry", func() {
 			if service != nil {
 				registryPort := localregistry.GetServicePort(service)
 				if registryPort.NodePort != 0 {
+					registryHost = fmt.Sprintf("localhost:%d", registryPort.NodePort)
 					return service, nil
 				}
 			}
@@ -109,6 +115,11 @@ var _ = DevSpaceDescribe("localregistry", func() {
 		gomega.Eventually(selectContainerImage(kubeClient, ns, "app", "container2"), pollingDurationLong, pollingInterval).
 			Should(gomega.MatchRegexp(`^localhost`))
 
+		// make sure we've pushed the image correctly
+		ginkgo.By("Checking registry for pushed image")
+		gomega.Eventually(getImages(ctx, registryHost), pollingDurationLong, pollingInterval).
+			Should(gomega.ContainElement("my-docker-username/helloworld"))
+
 		err = <-done
 		framework.ExpectNoError(err)
 	})
@@ -480,3 +491,18 @@ func readFile(name string) func() (string, error) {
 		return string(out), nil
 	}
 }
+func getImages(ctx context.Context, registryHost string) func() ([]string, error) {
+	return func() ([]string, error) {
+		registry, err := name.NewRegistry(registryHost)
+		if err != nil {
+			return nil, err
+		}
+
+		images, err := remote.Catalog(ctx, registry)
+		if err != nil {
+			return nil, err
+		}
+
+		return images, nil
+	}
+}

e2e/tests/localregistry/testdata/local-registry-docker/devspace.yaml

@@ -1,7 +1,8 @@
 version: v2beta1
 name: local-registry
-localRegistry: 
+localRegistry:
   enabled: true
+  localbuild: true
 images:
   app:
     image: my-docker-username/helloworld

go.mod

@@ -20,7 +20,8 @@ require (
 	github.com/ghodss/yaml v1.0.0
 	github.com/gliderlabs/ssh v0.3.5
 	github.com/go-resty/resty/v2 v2.7.0
-	github.com/google/go-containerregistry v0.7.0
+	github.com/google/go-containerregistry v0.13.0
+	github.com/mgutz/ansi v0.0.0-20170206155736-9520e82c474b
 	github.com/google/uuid v1.3.0
 	github.com/gorilla/websocket v1.4.2
 	github.com/invopop/jsonschema v0.3.0
@@ -45,7 +46,7 @@ require (
 	github.com/sabhiram/go-gitignore v0.0.0-20180611051255-d3107576ba94
 	github.com/sirupsen/logrus v1.9.0
 	github.com/skratchdot/open-golang v0.0.0-20160302144031-75fb7ed4208c
-	github.com/spf13/cobra v1.5.0
+	github.com/spf13/cobra v1.6.0
 	github.com/spf13/pflag v1.0.5
 	github.com/vmware-labs/yaml-jsonpath v0.3.2
 	golang.org/x/crypto v0.2.0
@@ -70,7 +71,7 @@ require (
 
 require (
 	github.com/Azure/go-ansiterm v0.0.0-20210617225240-d185dfc1b5a1 // indirect
-	github.com/Microsoft/go-winio v0.5.2 // indirect
+	github.com/Microsoft/go-winio v0.6.0 // indirect
 	github.com/PuerkitoBio/purell v1.1.1 // indirect
 	github.com/PuerkitoBio/urlesc v0.0.0-20170810143723-de5bf2ad4578 // indirect
 	github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be // indirect
@@ -79,6 +80,7 @@ require (
 	github.com/containerd/console v1.0.3 // indirect
 	github.com/containerd/containerd v1.6.18 // indirect
 	github.com/containerd/continuity v0.3.0 // indirect
+	github.com/containerd/stargz-snapshotter/estargz v0.13.0 // indirect
 	github.com/containerd/typeurl v1.0.2 // indirect
 	github.com/cpuguy83/go-md2man/v2 v2.0.2 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
@@ -111,7 +113,7 @@ require (
 	github.com/iancoleman/orderedmap v0.0.0-20190318233801-ac98e3ecb4b0 // indirect
 	github.com/imdario/mergo v0.3.12 // indirect
 	github.com/inconshreveable/go-update v0.0.0-20160112193335-8152e7eb6ccf // indirect
-	github.com/inconshreveable/mousetrap v1.0.0 // indirect
+	github.com/inconshreveable/mousetrap v1.0.1 // indirect
 	github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 // indirect
 	github.com/josharian/intern v1.0.0 // indirect
 	github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51 // indirect
@@ -135,7 +137,7 @@ require (
 	github.com/morikuni/aec v1.0.0 // indirect
 	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
 	github.com/opencontainers/go-digest v1.0.0 // indirect
-	github.com/opencontainers/image-spec v1.0.3-0.20220303224323-02efb9a75ee1 // indirect
+	github.com/opencontainers/image-spec v1.1.0-rc2 // indirect
 	github.com/opencontainers/runc v1.1.3 // indirect
 	github.com/prometheus/client_golang v1.14.0 // indirect
 	github.com/prometheus/client_model v0.3.0 // indirect
@@ -151,6 +153,7 @@ require (
 	github.com/tonistiigi/vt100 v0.0.0-20210615222946-8066bb97264f // indirect
 	github.com/toqueteos/trie v1.0.0 // indirect
 	github.com/ulikunitz/xz v0.5.9 // indirect
+	github.com/vbatts/tar-split v0.11.2 // indirect
 	github.com/xanzy/ssh-agent v0.2.1 // indirect
 	github.com/xeipuuv/gojsonpointer v0.0.0-20180127040702-4e3ac2762d5f // indirect
 	github.com/xeipuuv/gojsonreference v0.0.0-20180127040603-bd5ef7bd5415 // indirect
@@ -161,11 +164,13 @@ require (
 	go.opentelemetry.io/otel/sdk v1.4.1 // indirect
 	go.opentelemetry.io/otel/trace v1.4.1 // indirect
 	go.opentelemetry.io/proto/otlp v0.12.0 // indirect
-	golang.org/x/oauth2 v0.0.0-20220718184931-c8730f7fcb92 // indirect
+	golang.org/x/mod v0.8.0 // indirect
+	golang.org/x/oauth2 v0.1.0 // indirect
 	golang.org/x/sync v0.1.0 // indirect
 	golang.org/x/sys v0.5.0 // indirect
 	golang.org/x/term v0.5.0 // indirect
 	golang.org/x/time v0.1.0 // indirect
+	golang.org/x/tools v0.6.0 // indirect
 	google.golang.org/appengine v1.6.7 // indirect
 	google.golang.org/genproto v0.0.0-20220706185917-7780775163c4 // indirect
 	gopkg.in/inf.v0 v0.9.1 // indirect