feat: Added no-push,compressedCaching flag features to skaffold kaniko

Author: rayshoo

docs-v2/content/en/schemas/v4beta14.json

@@ -2834,6 +2834,12 @@
           "x-intellij-html-description": "to add timestamps to log format.",
           "default": "false"
         },
+        "noPush": {
+          "type": "boolean",
+          "description": "if you only want to build the image, without pushing to a registry.",
+          "x-intellij-html-description": "if you only want to build the image, without pushing to a registry.",
+          "default": "false"
+        },
         "ociLayoutPath": {
           "type": "string",
           "description": "to specify a directory in the container where the OCI image layout of a built image will be placed. This can be used to automatically track the exact image built by kaniko.",
@@ -2941,6 +2947,7 @@
         "cleanup",
         "insecure",
         "insecurePull",
+        "noPush",
         "force",
         "logTimestamp",
         "reproducible",
@@ -2998,6 +3005,11 @@
           "description": "enables caching of run layers (default=true).",
           "x-intellij-html-description": "enables caching of run layers (default=true)."
         },
+        "compressedCaching": {
+          "type": "boolean",
+          "description": "increases memory usage but reduces build runtime (default=true).",
+          "x-intellij-html-description": "increases memory usage but reduces build runtime (default=true)."
+        },
         "hostPath": {
           "type": "string",
           "description": "specifies a path on the host that is mounted to each pod as read only cache volume containing base images. If set, must exist on each node and prepopulated with kaniko-warmer.",
@@ -3019,7 +3031,8 @@
         "hostPath",
         "ttl",
         "cacheCopyLayers",
-        "cacheRunLayers"
+        "cacheRunLayers",
+        "compressedCaching"
       ],
       "additionalProperties": false,
       "type": "object",

pkg/skaffold/build/gcb/kaniko_test.go

@@ -127,6 +127,17 @@ func TestKanikoBuildSpec(t *testing.T) {
 				fmt.Sprintf("%s=%t", kaniko.CacheRunLayersFlag, true),
 			},
 		},
+		{
+			description: "with CompressedCaching is false",
+			artifact: &latest.KanikoArtifact{
+				DockerfilePath: "Dockerfile",
+				Cache:          &latest.KanikoCache{CompressedCaching: boolPtr(false)},
+			},
+			expectedArgs: []string{
+				kaniko.CacheFlag,
+				fmt.Sprintf("%s=%t", kaniko.CompressedCachingFlag, false),
+			},
+		},
 		{
 			description: "with Cleanup",
 			artifact: &latest.KanikoArtifact{
@@ -231,6 +242,16 @@ func TestKanikoBuildSpec(t *testing.T) {
 				kaniko.LogTimestampFlag,
 			},
 		},
+		{
+			description: "with NoPush",
+			artifact: &latest.KanikoArtifact{
+				DockerfilePath: "Dockerfile",
+				NoPush:         true,
+			},
+			expectedArgs: []string{
+				kaniko.NoPushFlag,
+			},
+		},
 		{
 			description: "with OCILayoutPath",
 			artifact: &latest.KanikoArtifact{
@@ -447,12 +468,19 @@ func TestKanikoBuildSpec(t *testing.T) {
 		Timeout:     "10m",
 	})
 
-	defaultExpectedArgs := []string{
-		"--destination", "gcr.io/nginx",
-		"--dockerfile", "Dockerfile",
-	}
-
 	for _, test := range tests {
+		var defaultExpectedArgs []string
+		if test.artifact.NoPush {
+			defaultExpectedArgs = []string{
+				"--dockerfile", "Dockerfile",
+			}
+		} else {
+			defaultExpectedArgs = []string{
+				"--destination", "gcr.io/nginx",
+				"--dockerfile", "Dockerfile",
+			}
+		}
+
 		testutil.Run(t, test.description, func(t *testutil.T) {
 			artifact := &latest.Artifact{
 				ImageName: "img1",

pkg/skaffold/build/kaniko/args.go

@@ -28,9 +28,16 @@ import (
 
 // Args returns kaniko command arguments
 func Args(artifact *latest.KanikoArtifact, tag, context string) ([]string, error) {
-	args := []string{
-		"--destination", tag,
-		"--dockerfile", filepath.ToSlash(filepath.Join(artifact.ContextSubPath, artifact.DockerfilePath)),
+	var args []string
+	if artifact.NoPush {
+		args = []string{
+			"--dockerfile", filepath.ToSlash(filepath.Join(artifact.ContextSubPath, artifact.DockerfilePath)),
+		}
+	} else {
+		args = []string{
+			"--destination", tag,
+			"--dockerfile", filepath.ToSlash(filepath.Join(artifact.ContextSubPath, artifact.DockerfilePath)),
+		}
 	}
 
 	if context != "" {
@@ -62,6 +69,9 @@ func Args(artifact *latest.KanikoArtifact, tag, context string) ([]string, error
 		if artifact.Cache.CacheRunLayers != nil {
 			args = append(args, fmt.Sprintf("%s=%t", CacheRunLayersFlag, *artifact.Cache.CacheRunLayers))
 		}
+		if artifact.Cache.CompressedCaching != nil {
+			args = append(args, fmt.Sprintf("%s=%t", CompressedCachingFlag, *artifact.Cache.CompressedCaching))
+		}
 	}
 
 	if artifact.Target != "" {
@@ -72,11 +82,13 @@ func Args(artifact *latest.KanikoArtifact, tag, context string) ([]string, error
 		args = append(args, CleanupFlag)
 	}
 
-	var tags []string
-	for _, r := range artifact.Destination {
-		tags = append(tags, DestinationFlag, r)
+	if artifact.NoPush {
+		args = append(args, NoPushFlag)
+	} else {
+		for _, r := range artifact.Destination {
+			args = append(args, DestinationFlag, r)
+		}
 	}
-	args = append(args, tags...)
 
 	if artifact.DigestFile != "" {
 		args = append(args, DigestFileFlag, artifact.DigestFile)

pkg/skaffold/build/kaniko/args_test.go

@@ -26,6 +26,8 @@ import (
 )
 
 func TestArgs(t *testing.T) {
+	disableCompressedCache := false
+
 	tests := []struct {
 		description  string
 		artifact     *latest.KanikoArtifact
@@ -86,16 +88,18 @@ func TestArgs(t *testing.T) {
 			artifact: &latest.KanikoArtifact{
 				DockerfilePath: "dir/Dockerfile",
 				Cache: &latest.KanikoCache{
-					Repo:     "gcr.io/ngnix",
-					HostPath: "/cache",
-					TTL:      "2",
+					Repo:              "gcr.io/ngnix",
+					HostPath:          "/cache",
+					TTL:               "2",
+					CompressedCaching: &disableCompressedCache,
 				},
 			},
 			expectedArgs: []string{
 				CacheFlag,
 				CacheRepoFlag, "gcr.io/ngnix",
 				CacheDirFlag, "/cache",
 				CacheTTLFlag, "2",
+				fmt.Sprintf("%s=%t", CompressedCachingFlag, false),
 			},
 			wantErr: false,
 		},
@@ -202,6 +206,17 @@ func TestArgs(t *testing.T) {
 			},
 			wantErr: false,
 		},
+		{
+			description: "with NoPush",
+			artifact: &latest.KanikoArtifact{
+				DockerfilePath: "dir/Dockerfile",
+				NoPush:         true,
+			},
+			expectedArgs: []string{
+				NoPushFlag,
+			},
+			wantErr: false,
+		},
 		{
 			description: "with OCILayoutPath",
 			artifact: &latest.KanikoArtifact{
@@ -425,13 +440,21 @@ func TestArgs(t *testing.T) {
 		},
 	}
 
-	defaultExpectedArgs := []string{
-		"--destination", "gcr.io/nginx",
-		"--dockerfile", "dir/Dockerfile",
-		"--context", fmt.Sprintf("dir://%s", DefaultEmptyDirMountPath),
-	}
-
 	for _, test := range tests {
+		var defaultExpectedArgs []string
+		if test.artifact.NoPush {
+			defaultExpectedArgs = []string{
+				"--dockerfile", "dir/Dockerfile",
+				"--context", fmt.Sprintf("dir://%s", DefaultEmptyDirMountPath),
+			}
+		} else {
+			defaultExpectedArgs = []string{
+				"--destination", "gcr.io/nginx",
+				"--dockerfile", "dir/Dockerfile",
+				"--context", fmt.Sprintf("dir://%s", DefaultEmptyDirMountPath),
+			}
+		}
+
 		testutil.Run(t, test.description, func(t *testutil.T) {
 			got, err := Args(test.artifact, "gcr.io/nginx", fmt.Sprintf("dir://%s", DefaultEmptyDirMountPath))
 			if (err != nil) != test.wantErr {

pkg/skaffold/build/kaniko/types.go

@@ -31,6 +31,8 @@ const (
 	CacheRepoFlag = "--cache-repo"
 	// CacheTTLFlag additional flag
 	CacheTTLFlag = "--cache-ttl"
+	// CompressedCaching additional flag
+	CompressedCachingFlag = "--compressed-caching"
 	// TargetFlag additional flag
 	TargetFlag = "--target"
 	// CleanupFlag additional flag
@@ -57,6 +59,8 @@ const (
 	LogFormatFlag = "--log-format"
 	// LogTimestampFlag additional flag
 	LogTimestampFlag = "--log-timestamp"
+	// NoPushFlag additional flag
+	NoPushFlag = "--no-push"
 	// OCILayoutFlag additional flag
 	OCILayoutFlag = "--oci-layout-path"
 	// RegistryCertificateFlag additional flag

pkg/skaffold/schema/defaults/defaults.go

@@ -389,6 +389,7 @@ func setKanikoArtifactDefaults(a *latest.KanikoArtifact) {
 	a.DigestFile = valueOrDefault(a.DigestFile, constants.DefaultKanikoDigestFile)
 	if a.Cache != nil {
 		a.Cache.CacheRunLayers = valueOrDefaultBool(a.Cache.CacheRunLayers, true)
+		a.Cache.CompressedCaching = valueOrDefaultBool(a.Cache.CompressedCaching, true)
 	}
 	a.CopyMaxRetries = valueOrDefaultInt(a.CopyMaxRetries, kaniko.DefaultCopyMaxRetries)
 	a.CopyTimeout = valueOrDefault(a.CopyTimeout, kaniko.DefaultCopyTimeout)

pkg/skaffold/schema/latest/config.go

@@ -501,6 +501,8 @@ type KanikoCache struct {
 	CacheCopyLayers bool `yaml:"cacheCopyLayers,omitempty"`
 	// CacheRunLayers enables caching of run layers (default=true).
 	CacheRunLayers *bool `yaml:"cacheRunLayers,omitempty"`
+	// CompressedCaching increases memory usage but reduces build runtime (default=true).
+	CompressedCaching *bool `yaml:"compressedCaching,omitempty"`
 }
 
 // ClusterDetails *beta* describes how to do an on-cluster build.
@@ -1432,6 +1434,9 @@ type KanikoArtifact struct {
 	// InsecurePull if you want to pull images from a plain HTTP registry.
 	InsecurePull bool `yaml:"insecurePull,omitempty"`
 
+	// NoPush if you only want to build the image, without pushing to a registry.
+	NoPush bool `yaml:"noPush,omitempty"`
+
 	// Force building outside of a container.
 	Force bool `yaml:"force,omitempty"`