feat: add ingore-path kaniko flag support (#8340)

GoogleContainerTools · Jan 20, 2023 · 7d346f5 · 7d346f5
1 parent a325b29
commit 7d346f5
Show file tree

Hide file tree

Showing 6 changed files with 45 additions and 1 deletion.
diff --git a/docs-v2/content/en/schemas/v4beta2.json b/docs-v2/content/en/schemas/v4beta2.json
@@ -2523,6 +2523,15 @@
           "x-intellij-html-description": "building outside of a container.",
           "default": "false"
         },
+        "ignorePaths": {
+          "items": {
+            "type": "string"
+          },
+          "type": "array",
+          "description": "a list of ignored paths when making an image snapshot.",
+          "x-intellij-html-description": "a list of ignored paths when making an image snapshot.",
+          "default": "[]"
+        },
         "image": {
           "type": "string",
           "description": "Docker image used by the Kaniko pod. Defaults to the latest released version of `gcr.io/kaniko-project/executor`.",
@@ -2729,7 +2738,8 @@
         "label",
         "buildArgs",
         "volumeMounts",
-        "contextSubPath"
+        "contextSubPath",
+        "ignorePaths"
       ],
       "additionalProperties": false,
       "type": "object",

diff --git a/pkg/skaffold/build/gcb/kaniko_test.go b/pkg/skaffold/build/gcb/kaniko_test.go
@@ -397,6 +397,17 @@ func TestKanikoBuildSpec(t *testing.T) {
 				kaniko.LabelFlag, "label2",
 			},
 		},
+		{
+			description: "with IgnorePaths",
+			artifact: &latest.KanikoArtifact{
+				DockerfilePath: "Dockerfile",
+				IgnorePaths:    []string{"/var", "/tmp"},
+			},
+			expectedArgs: []string{
+				kaniko.IgnorePathFlag, "/var",
+				kaniko.IgnorePathFlag, "/tmp",
+			},
+		},
 	}
 	store := mockArtifactStore{
 		"img2": "img2:tag",

diff --git a/pkg/skaffold/build/kaniko/args.go b/pkg/skaffold/build/kaniko/args.go
@@ -174,6 +174,12 @@ func Args(artifact *latest.KanikoArtifact, tag, context string) ([]string, error
 	}
 	args = append(args, sRegArgs...)
 
+	var ignPathArgs []string
+	for _, r := range artifact.IgnorePaths {
+		ignPathArgs = append(ignPathArgs, IgnorePathFlag, r)
+	}
+	args = append(args, ignPathArgs...)
+
 	registryCertificate, err := util.MapToFlag(artifact.RegistryCertificate, RegistryCertificateFlag)
 	if err != nil {
 		return args, err

diff --git a/pkg/skaffold/build/kaniko/args_test.go b/pkg/skaffold/build/kaniko/args_test.go
@@ -407,6 +407,18 @@ func TestArgs(t *testing.T) {
 			},
 			wantErr: false,
 		},
+		{
+			description: "with IgnorePaths",
+			artifact: &latest.KanikoArtifact{
+				DockerfilePath: "dir/Dockerfile",
+				IgnorePaths:    []string{"/tmp", "/proc"},
+			},
+			expectedArgs: []string{
+				IgnorePathFlag, "/tmp",
+				IgnorePathFlag, "/proc",
+			},
+			wantErr: false,
+		},
 	}
 
 	defaultExpectedArgs := []string{

diff --git a/pkg/skaffold/build/kaniko/types.go b/pkg/skaffold/build/kaniko/types.go
@@ -107,4 +107,6 @@ const (
 	DefaultDockerConfigPath = "/kaniko/.docker"
 	// DefaultSecretMountPath for kaniko pod
 	DefaultSecretMountPath = "/secret"
+	// IgnorePath additional flag
+	IgnorePathFlag = "--ignore-path"
 )
diff --git a/pkg/skaffold/schema/latest/config.go b/pkg/skaffold/schema/latest/config.go
@@ -1387,6 +1387,9 @@ type KanikoArtifact struct {
 
 	// ContextSubPath is to specify a sub path within the context.
 	ContextSubPath string `yaml:"contextSubPath,omitempty" skaffold:"filepath"`
+
+	// IgnorePaths is a list of ignored paths when making an image snapshot.
+	IgnorePaths []string `yaml:"ignorePaths,omitempty"`
 }
 
 // DockerArtifact describes an artifact built from a Dockerfile,