SparseCheckout when Spec.Update.Path specified

Signed-off-by: kane8n <[email protected]>

Author: kane8n

api/v1beta2/imageupdateautomation_types.go

@@ -90,6 +90,8 @@ type UpdateStrategy struct {
 	// Path to the directory containing the manifests to be updated.
 	// Defaults to 'None', which translates to the root path
 	// of the GitRepositoryRef.
+	// When a path is specified, sparse checkout will be enabled to limit the checkout scope
+	// to the specified directory, reducing clone size and time.
 	// +optional
 	Path string `json:"path,omitempty"`
 }

config/crd/bases/image.toolkit.fluxcd.io_imageupdateautomations.yaml

@@ -586,6 +586,8 @@ spec:
                       Path to the directory containing the manifests to be updated.
                       Defaults to 'None', which translates to the root path
                       of the GitRepositoryRef.
+                      When a path is specified, sparse checkout will be enabled to limit the checkout scope
+                      to the specified directory, reducing clone size and time.
                     type: string
                   strategy:
                     default: Setters

docs/api/v1beta2/image-automation.md

@@ -887,7 +887,9 @@ string
 <em>(Optional)</em>
 <p>Path to the directory containing the manifests to be updated.
 Defaults to &lsquo;None&rsquo;, which translates to the root path
-of the GitRepositoryRef.</p>
+of the GitRepositoryRef.
+When a path is specified, sparse checkout will be enabled to limit the checkout scope
+to the specified directory, reducing clone size and time.</p>
 </td>
 </tr>
 </tbody>

docs/spec/v1beta1/imageupdateautomations.md

@@ -611,11 +611,17 @@ type UpdateStrategy struct {
 	// Path to the directory containing the manifests to be updated.
 	// Defaults to 'None', which translates to the root path
 	// of the GitRepositoryRef.
+	// When a path is specified, sparse checkout will be enabled to limit the checkout scope
+	// to the specified directory, reducing clone size and time.
 	// +optional
 	Path string `json:"path,omitempty"`
 }
 ```
 
+By default, the `path` is empty, which means that the root of the git repository is used.
+If a path is specified, the controller will use a sparse checkout to limit the checkout scope to the specified directory, which can reduce clone size and time.
+But this can be disabled by starting the controller with `--feature-gates=GitSparseCheckout=false`.
+
 **Setters strategy**
 
 At present, there is one strategy: "Setters". This uses field markers referring to image policies,

internal/controller/imageupdateautomation_controller.go

@@ -396,6 +396,10 @@ func (r *ImageUpdateAutomationReconciler) reconcile(ctx context.Context, sp *pat
 	if r.features[features.GitShallowClone] {
 		checkoutOpts = append(checkoutOpts, source.WithCheckoutOptionShallowClone())
 	}
+	if r.features[features.GitSparseCheckout] && obj.Spec.Update.Path != "" {
+		checkoutOpts = append(checkoutOpts, source.WithCheckoutOptionSparseCheckoutDirectories(obj.Spec.Update.Path))
+	}
+
 	// If full sync is still not needed, configure last observed commit to
 	// perform optimized clone and obtain a non-concrete commit if the remote
 	// has not changed.

internal/features/features.go

@@ -34,6 +34,9 @@ const (
 	// GitAllBranchReferences enables the download of all branch head references
 	// when push branches are configured. When enabled fixes fluxcd/flux2#3384.
 	GitAllBranchReferences = "GitAllBranchReferences"
+	// GitSparseCheckout enables the use of sparse checkout when pulling source from
+	// Git repositories.
+	GitSparseCheckout = "GitSparseCheckout"
 	// CacheSecretsAndConfigMaps controls whether Secrets and ConfigMaps should
 	// be cached.
 	//
@@ -55,6 +58,10 @@ var features = map[string]bool{
 	// opt-out from v0.28
 	GitAllBranchReferences: true,
 
+	// GitSparseCheckout
+	// opt-out from v0.42
+	GitSparseCheckout: true,
+
 	// CacheSecretsAndConfigMaps
 	// opt-in from v0.29
 	CacheSecretsAndConfigMaps: false,

internal/source/source.go

@@ -21,6 +21,7 @@ import (
 	"errors"
 	"fmt"
 	"os"
+	"path/filepath"
 	"strings"
 	"text/template"
 	"time"
@@ -196,6 +197,14 @@ func WithCheckoutOptionShallowClone() CheckoutOption {
 	}
 }
 
+// WithCheckoutOptionRecurseSubmodules is a CheckoutOption option to configure
+// SparseCheckoutDirectories.
+func WithCheckoutOptionSparseCheckoutDirectories(updatePath string) CheckoutOption {
+	return func(cc *repository.CloneConfig) {
+		cc.SparseCheckoutDirectories = []string{filepath.Clean(updatePath)}
+	}
+}
+
 // CheckoutSource clones and checks out the source. If a push branch is
 // configured that doesn't match with the checkout branch, a checkout to the
 // push branch is also performed. This ensures any change and push operation

internal/source/source_test.go

@@ -222,13 +222,14 @@ func TestSourceManager_CheckoutSource(t *testing.T) {
 
 func test_sourceManager_CheckoutSource(t *testing.T, proto string) {
 	tests := []struct {
-		name         string
-		autoGitSpec  *imagev1.GitSpec
-		gitRepoRef   *sourcev1.GitRepositoryRef
-		shallowClone bool
-		lastObserved bool
-		wantErr      bool
-		wantRef      string
+		name                    string
+		autoGitSpec             *imagev1.GitSpec
+		gitRepoRef              *sourcev1.GitRepositoryRef
+		shallowClone            bool
+		sparseCheckoutDirectory string
+		lastObserved            bool
+		wantErr                 bool
+		wantRef                 string
 	}{
 		{
 			name: "checkout for single branch",
@@ -275,6 +276,42 @@ func test_sourceManager_CheckoutSource(t *testing.T, proto string) {
 			wantErr:      false,
 			wantRef:      "main",
 		},
+		{
+			name: "with sparse checkout",
+			autoGitSpec: &imagev1.GitSpec{
+				Push: &imagev1.PushSpec{Branch: "main"},
+				Checkout: &imagev1.GitCheckoutSpec{
+					Reference: sourcev1.GitRepositoryRef{Branch: "main"},
+				},
+			},
+			sparseCheckoutDirectory: "testdata/appconfig/deploy.yaml",
+			wantErr:                 false,
+			wantRef:                 "main",
+		},
+		{
+			name: "with sparse checkout for current directory",
+			autoGitSpec: &imagev1.GitSpec{
+				Push: &imagev1.PushSpec{Branch: "main"},
+				Checkout: &imagev1.GitCheckoutSpec{
+					Reference: sourcev1.GitRepositoryRef{Branch: "main"},
+				},
+			},
+			sparseCheckoutDirectory: "./",
+			wantErr:                 false,
+			wantRef:                 "main",
+		},
+		{
+			name: "with sparse checkout for different push branch",
+			autoGitSpec: &imagev1.GitSpec{
+				Push: &imagev1.PushSpec{Branch: "foo"},
+				Checkout: &imagev1.GitCheckoutSpec{
+					Reference: sourcev1.GitRepositoryRef{Branch: "main"},
+				},
+			},
+			sparseCheckoutDirectory: "testdata/appconfig/deploy.yaml",
+			wantErr:                 false,
+			wantRef:                 "foo",
+		},
 		{
 			name: "with last observed commit",
 			autoGitSpec: &imagev1.GitSpec{
@@ -386,6 +423,9 @@ func test_sourceManager_CheckoutSource(t *testing.T, proto string) {
 			if tt.shallowClone {
 				opts = append(opts, WithCheckoutOptionShallowClone())
 			}
+			if tt.sparseCheckoutDirectory != "" {
+				opts = append(opts, WithCheckoutOptionSparseCheckoutDirectories(tt.sparseCheckoutDirectory))
+			}
 			if tt.lastObserved {
 				opts = append(opts, WithCheckoutOptionLastObserved(headRev))
 			}