Add buildCacheMB helm chart value

- This value is used to set the size of the persistent disk we allocate for caching when building images with kpack. - it defaults to 2GiB which is similar to the 2GB default size that kpack allocates. - The new setting allows customers building large applicaitons to take advantage of caching. #2634
cloudfoundry · Jun 27, 2023 · cb13ea1 · cb13ea1
1 parent f52cf8e
commit cb13ea1
Show file tree

Hide file tree

Showing 10 changed files with 49 additions and 6 deletions.
diff --git a/README.helm.md b/README.helm.md
@@ -42,6 +42,7 @@ Here are all the values that can be set for the chart:
   - `lifecycle`: Default lifecycle for apps.
     - `stack` (_String_): Stack.
     - `stagingRequirements`:
+      - `buildCacheMB` (_Integer_): Persistent disk in MB for caching staging artifacts across builds.
       - `diskMB` (_Integer_): Disk in MB for staging.
       - `memoryMB` (_Integer_): Memory in MB for staging.
     - `type` (_String_): Lifecycle type (only `buildpack` accepted currently).

diff --git a/controllers/config/config.go b/controllers/config/config.go
@@ -41,6 +41,7 @@ type ControllerConfig struct {
 	BuilderReadinessTimeout   string `yaml:"builderReadinessTimeout"`
 	ContainerRepositoryPrefix string `yaml:"containerRepositoryPrefix"`
 	ContainerRegistryType     string `yaml:"containerRegistryType"`
+	BuildCacheMB              int    `yaml:"buildCacheMB"`
 }
 
 type CFProcessDefaults struct {
@@ -50,9 +51,10 @@ type CFProcessDefaults struct {
 }
 
 const (
-	defaultTaskTTL       = 30 * 24 * time.Hour
-	defaultTimeout int64 = 60
-	defaultJobTTL        = 24 * time.Hour
+	defaultTaskTTL            = 30 * 24 * time.Hour
+	defaultTimeout      int64 = 60
+	defaultJobTTL             = 24 * time.Hour
+	defaultBuildCacheMB       = 2048
 )
 
 func LoadFromPath(path string) (*ControllerConfig, error) {
@@ -70,6 +72,10 @@ func LoadFromPath(path string) (*ControllerConfig, error) {
 		config.SpaceFinalizerAppDeletionTimeout = tools.PtrTo(defaultTimeout)
 	}
 
+	if config.BuildCacheMB == 0 {
+		config.BuildCacheMB = defaultBuildCacheMB
+	}
+
 	return &config, nil
 }
 

diff --git a/controllers/config/config_test.go b/controllers/config/config_test.go
@@ -45,6 +45,7 @@ var _ = Describe("LoadFromPath", func() {
 			JobTTL:                           "jobTTL",
 			LogLevel:                         zapcore.DebugLevel,
 			SpaceFinalizerAppDeletionTimeout: tools.PtrTo(int64(42)),
+			BuildCacheMB:                     1024,
 		}
 	})
 
@@ -80,6 +81,7 @@ var _ = Describe("LoadFromPath", func() {
 			JobTTL:                           "jobTTL",
 			LogLevel:                         zapcore.DebugLevel,
 			SpaceFinalizerAppDeletionTimeout: tools.PtrTo(int64(42)),
+			BuildCacheMB:                     1024,
 		}))
 	})
 
@@ -112,6 +114,16 @@ var _ = Describe("LoadFromPath", func() {
 			Expect(retConfig.SpaceFinalizerAppDeletionTimeout).To(gstruct.PointTo(Equal(int64(60))))
 		})
 	})
+
+	When("the staging build cache size is not set", func() {
+		BeforeEach(func() {
+			cfg.BuildCacheMB = 0
+		})
+
+		It("uses the default", func() {
+			Expect(retConfig.BuildCacheMB).To(Equal(2048))
+		})
+	})
 })
 
 var _ = Describe("ParseTaskTTL", func() {

diff --git a/helm/korifi/controllers/configmap.yaml b/helm/korifi/controllers/configmap.yaml
@@ -38,6 +38,7 @@ data:
     builderReadinessTimeout: {{ required "builderReadinessTimeout is required" .Values.kpackImageBuilder.builderReadinessTimeout }}
     containerRepositoryPrefix: {{ .Values.global.containerRepositoryPrefix | quote }}
     builderServiceAccount: kpack-service-account
+    buildCacheMB: {{ .Values.api.lifecycle.stagingRequirements.buildCacheMB }}
     {{- if .Values.global.eksContainerRegistryRoleARN }}
     containerRegistryType: "ECR"
     {{- end }}

diff --git a/helm/korifi/values.schema.json b/helm/korifi/values.schema.json
@@ -182,9 +182,13 @@
                 "diskMB": {
                   "description": "Disk in MB for staging.",
                   "type": "integer"
+                },
+                "buildCacheMB": {
+                  "description": "Persistent disk in MB for caching staging artifacts across builds.",
+                  "type": "integer"
                 }
               },
-              "required": ["memoryMB", "diskMB"]
+              "required": ["memoryMB", "diskMB", "buildCacheMB"]
             }
           },
           "required": ["type", "stack", "stagingRequirements"]

diff --git a/helm/korifi/values.yaml b/helm/korifi/values.yaml
@@ -46,6 +46,7 @@ api:
     stagingRequirements:
       memoryMB: 1024
       diskMB: 1024
+      buildCacheMB: 2048
 
   builderName: kpack-image-builder
   userCertificateExpirationWarningDuration: 168h

diff --git a/kpack-image-builder/controllers/buildworkload_controller.go b/kpack-image-builder/controllers/buildworkload_controller.go
@@ -39,6 +39,7 @@ import (
 	corev1 "k8s.io/api/core/v1"
 	k8serrors "k8s.io/apimachinery/pkg/api/errors"
 	"k8s.io/apimachinery/pkg/api/meta"
+	"k8s.io/apimachinery/pkg/api/resource"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/apimachinery/pkg/types"
@@ -648,7 +649,12 @@ func (r *BuildWorkloadReconciler) reconcileKpackImage(
 		return err
 	}
 
-	_, err := controllerutil.CreateOrPatch(ctx, r.k8sClient, &desiredKpackImage, func() error {
+	cacheSize, err := resource.ParseQuantity(fmt.Sprintf("%dMi", r.controllerConfig.BuildCacheMB))
+	if err != nil {
+		log.Error(err, "failed to parse image cache size")
+		return err
+	}
+	_, err = controllerutil.CreateOrPatch(ctx, r.k8sClient, &desiredKpackImage, func() error {
 		desiredKpackImage.Labels = map[string]string{
 			BuildWorkloadLabelKey: buildWorkload.Name,
 		}
@@ -671,6 +677,11 @@ func (r *BuildWorkloadReconciler) reconcileKpackImage(
 				Services: buildWorkload.Spec.Services,
 				Env:      buildWorkload.Spec.Env,
 			},
+			Cache: &buildv1alpha2.ImageCacheConfig{
+				Volume: &buildv1alpha2.ImagePersistentVolumeCache{
+					Size: &cacheSize,
+				},
+			},
 		}
 		if customBuilderName != "" {
 			desiredKpackImage.Spec.Builder.Kind = "Builder"
@@ -679,7 +690,7 @@ func (r *BuildWorkloadReconciler) reconcileKpackImage(
 		}
 
 		// Cannot use SetControllerReference here as multiple BuildWorkloads can "own" the same Image.
-		err := controllerutil.SetOwnerReference(buildWorkload, &desiredKpackImage, r.scheme)
+		err = controllerutil.SetOwnerReference(buildWorkload, &desiredKpackImage, r.scheme)
 		if err != nil {
 			log.Info("failed to set OwnerRef on Kpack Image", "reason", err)
 			return err

diff --git a/kpack-image-builder/controllers/buildworkload_controller_test.go b/kpack-image-builder/controllers/buildworkload_controller_test.go
@@ -22,6 +22,7 @@ import (
 	corev1 "k8s.io/api/core/v1"
 	k8serrors "k8s.io/apimachinery/pkg/api/errors"
 	"k8s.io/apimachinery/pkg/api/meta"
+	"k8s.io/apimachinery/pkg/api/resource"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/types"
 )
@@ -160,6 +161,7 @@ var _ = Describe("BuildWorkloadReconciler", func() {
 
 					g.Expect(kpackImage.Spec.Builder.Kind).To(Equal("ClusterBuilder"))
 					g.Expect(kpackImage.Spec.Builder.Name).To(Equal("cf-kpack-builder"))
+					g.Expect(kpackImage.Spec.Cache.Volume.Size.Equal(resource.MustParse("1024Mi"))).To(BeTrue())
 				}).Should(Succeed())
 			})
 

diff --git a/kpack-image-builder/controllers/suite_test.go b/kpack-image-builder/controllers/suite_test.go
@@ -124,6 +124,7 @@ var _ = BeforeSuite(func() {
 		ClusterBuilderName:        "cf-kpack-builder",
 		ContainerRepositoryPrefix: "image/registry/tag",
 		BuilderServiceAccount:     "builder-service-account",
+		BuildCacheMB:              1024,
 	}
 
 	imageRepoCreator = new(fake.RepositoryCreator)

diff --git a/scripts/assets/values-template.yaml b/scripts/assets/values-template.yaml
@@ -9,6 +9,10 @@ api:
   apiServer:
     url: localhost
   image: cloudfoundry/korifi-api:latest
+  lifecycle:
+    stagingRequirements:
+      buildCacheMB: 1024
+
 
 controllers:
   taskTTL: 5s