feat: add support for volumes and volumeMounts in Image resource, update conversion logic, and enable custom build pod PVCs for kpack builds

Author: vishal24367

pkg/apis/build/v1alpha1/image_types.go

@@ -63,6 +63,10 @@ type ImageBuild struct {
 	// +listType
 	Env       []corev1.EnvVar             `json:"env,omitempty"`
 	Resources corev1.ResourceRequirements `json:"resources,omitempty"`
+	// +listType
+	Volumes []corev1.Volume `json:"volumes,omitempty"`
+	// +listType
+	VolumeMounts []corev1.VolumeMount `json:"volumeMounts,omitempty"`
 }
 
 // +k8s:openapi-gen=true

pkg/apis/build/v1alpha2/build_pod_test.go

@@ -2458,6 +2458,51 @@ func testBuildPod(t *testing.T, when spec.G, it spec.S) {
 				)
 			})
 		})
+
+		when("custom volumes and mounts", func() {
+			it("attaches user-supplied volumes and mounts to all init containers", func() {
+				build.Spec.Volumes = []corev1.Volume{
+					{
+						Name: "sqlite-pvc",
+						VolumeSource: corev1.VolumeSource{
+							PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
+								ClaimName: "my-sqlite-pvc",
+							},
+						},
+					},
+				}
+				build.Spec.VolumeMounts = []corev1.VolumeMount{
+					{
+						Name:      "sqlite-pvc",
+						MountPath: "/workspace/sqlite",
+						ReadOnly:  false,
+					},
+				}
+
+				pod, err := build.BuildPod(config, buildContext)
+				require.NoError(t, err)
+
+				// Check that the volume is present in the pod spec
+				found := false
+				for _, v := range pod.Spec.Volumes {
+					if v.Name == "sqlite-pvc" && v.VolumeSource.PersistentVolumeClaim != nil && v.VolumeSource.PersistentVolumeClaim.ClaimName == "my-sqlite-pvc" {
+						found = true
+					}
+				}
+				assert.True(t, found, "sqlite-pvc volume should be present in pod spec")
+
+				// Check that the mount is present in all init containers
+				for _, c := range pod.Spec.InitContainers {
+					foundMount := false
+					for _, m := range c.VolumeMounts {
+						if m.Name == "sqlite-pvc" && m.MountPath == "/workspace/sqlite" {
+							foundMount = true
+						}
+					}
+					assert.True(t, foundMount, "sqlite-pvc mount should be present in init container %s", c.Name)
+				}
+			})
+		})
 	})
 }
 

pkg/apis/build/v1alpha2/build_validation.go

@@ -25,7 +25,7 @@ func (b *Build) Validate(ctx context.Context) *apis.FieldError {
 }
 
 func (bs *BuildSpec) Validate(ctx context.Context) *apis.FieldError {
-	return validate.ListNotEmpty(bs.Tags, "tags").
+	err := validate.ListNotEmpty(bs.Tags, "tags").
 		Also(validate.Tags(bs.Tags, "tags")).
 		Also(bs.Cache.Validate(ctx).ViaField("cache")).
 		Also(bs.Builder.Validate(ctx).ViaField("builder")).
@@ -36,6 +36,25 @@ func (bs *BuildSpec) Validate(ctx context.Context) *apis.FieldError {
 		Also(validateCnbBindings(ctx, bs.CNBBindings).ViaField("cnbBindings")).
 		Also(bs.validateNodeSelector(ctx)).
 		Also(validateNotary(ctx, bs.Notary).ViaField("notary"))
+
+	// Validate that all volumeMounts refer to a defined volume
+	volumeNames := make(map[string]struct{})
+	for _, v := range bs.Volumes {
+		if _, exists := volumeNames[v.Name]; exists {
+			err = err.Also(apis.ErrGeneric("duplicate volume name", "volumes", v.Name))
+		}
+		volumeNames[v.Name] = struct{}{}
+	}
+	for i, m := range bs.VolumeMounts {
+		if m.Name == "" {
+			err = err.Also(apis.ErrMissingField("name").ViaField("volumeMounts").ViaIndex(i))
+			continue
+		}
+		if _, ok := volumeNames[m.Name]; !ok {
+			err = err.Also(apis.ErrInvalidValue(m.Name, "volumeMounts").ViaIndex(i).Also(apis.ErrGeneric("volumeMount refers to undefined volume", "volumeMounts", m.Name)))
+		}
+	}
+	return err
 }
 
 func resourceCreatedByKpackController(info *authv1.UserInfo) bool {

pkg/apis/build/v1alpha2/image_conversion.go

@@ -76,6 +76,8 @@ func (is *ImageSpec) convertTo(to *v1alpha1.ImageSpec) {
 		to.Build.Env = is.Build.Env
 		to.Build.Resources = is.Build.Resources
 		to.Build.Bindings = is.Build.CNBBindings
+		to.Build.VolumeMounts = is.Build.VolumeMounts
+		to.Build.Volumes = is.Build.Volumes
 	}
 }
 
@@ -283,6 +285,8 @@ func (is *ImageSpec) convertFrom(from *v1alpha1.ImageSpec) {
 		is.Build.Env = from.Build.Env
 		is.Build.Resources = from.Build.Resources
 		is.Build.CNBBindings = from.Build.Bindings
+		is.Build.VolumeMounts = from.Build.VolumeMounts
+		is.Build.Volumes = from.Build.Volumes
 	}
 }
 

pkg/apis/build/v1alpha2/image_types.go

@@ -72,15 +72,15 @@ type ImageBuild struct {
 	Env       []corev1.EnvVar             `json:"env,omitempty"`
 	Resources corev1.ResourceRequirements `json:"resources,omitempty"`
 	// +listType
-	Tolerations          []corev1.Toleration `json:"tolerations,omitempty"`
-	NodeSelector         map[string]string   `json:"nodeSelector,omitempty"`
-	Affinity             *corev1.Affinity    `json:"affinity,omitempty"`
-	RuntimeClassName     *string             `json:"runtimeClassName,omitempty"`
-	SchedulerName        string              `json:"schedulerName,omitempty"`
-	BuildTimeout         *int64              `json:"buildTimeout,omitempty"`
-	CreationTime         string              `json:"creationTime,omitempty"`
-	VolumeMounts  		 []corev1.VolumeMount 	`json:"volumeMounts,omitempty"`
-    Volumes       		 []corev1.Volume      	`json:"volumes,omitempty"`
+	Tolerations      []corev1.Toleration  `json:"tolerations,omitempty"`
+	NodeSelector     map[string]string    `json:"nodeSelector,omitempty"`
+	Affinity         *corev1.Affinity     `json:"affinity,omitempty"`
+	RuntimeClassName *string              `json:"runtimeClassName,omitempty"`
+	SchedulerName    string               `json:"schedulerName,omitempty"`
+	BuildTimeout     *int64               `json:"buildTimeout,omitempty"`
+	CreationTime     string               `json:"creationTime,omitempty"`
+	VolumeMounts     []corev1.VolumeMount `json:"volumeMounts,omitempty"`
+	Volumes          []corev1.Volume      `json:"volumes,omitempty"`
 }
 
 // +k8s:openapi-gen=true