make GetProcessSettings not return volumeClaimTemplate for stateless … (#1965)

* make GetProcessSettings not return volumeClaimTemplate for stateless processes

---------

Co-authored-by: Nicole Morales <[email protected]>

Author: nicmorales9

api/v1beta2/foundationdbcluster_types.go

@@ -1266,7 +1266,7 @@ type ProcessSettings struct {
 	PodTemplate *corev1.PodTemplateSpec `json:"podTemplate,omitempty"`
 
 	// VolumeClaimTemplate allows customizing the persistent volume claim for the
-	// pod.
+	// pod.  This will be ignored by the operator for stateless processes.
 	VolumeClaimTemplate *corev1.PersistentVolumeClaim `json:"volumeClaimTemplate,omitempty"`
 
 	// CustomParameters defines additional parameters to pass to the fdbserver
@@ -1289,7 +1289,7 @@ func (cluster *FoundationDBCluster) GetProcessSettings(processClass ProcessClass
 		if merged.PodTemplate == nil {
 			merged.PodTemplate = entry.PodTemplate
 		}
-		if merged.VolumeClaimTemplate == nil {
+		if merged.VolumeClaimTemplate == nil && processClass.IsStateful() { // stateless pods will not use a PVC
 			merged.VolumeClaimTemplate = entry.VolumeClaimTemplate
 		}
 		if merged.CustomParameters == nil {

docs/cluster_spec.md

@@ -437,7 +437,7 @@ ProcessSettings defines process-level settings.
 | Field | Description | Scheme | Required |
 | ----- | ----------- | ------ | -------- |
 | podTemplate | PodTemplate allows customizing the pod. If a container image with a tag is specified the operator will throw an error and stop processing the cluster. | *[corev1.PodTemplateSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#podtemplatespec-v1-core) | false |
-| volumeClaimTemplate | VolumeClaimTemplate allows customizing the persistent volume claim for the pod. | *[corev1.PersistentVolumeClaim](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#persistentvolumeclaim-v1-core) | false |
+| volumeClaimTemplate | VolumeClaimTemplate allows customizing the persistent volume claim for the pod.  This will be ignored by the operator for stateless processes. | *[corev1.PersistentVolumeClaim](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#persistentvolumeclaim-v1-core) | false |
 | customParameters | CustomParameters defines additional parameters to pass to the fdbserver process. | FoundationDBCustomParameters | false |
 
 [Back to TOC](#table-of-contents)

internal/pod_models.go

@@ -320,7 +320,7 @@ func configureVolumesForContainers(cluster *fdbv1beta2.FoundationDBCluster, podS
 	}
 
 	var mainVolumeSource corev1.VolumeSource
-	if usePvc(cluster, processClass) {
+	if processClass.IsStateful() {
 		var volumeClaimSourceName string
 		if volumeClaimTemplate != nil && volumeClaimTemplate.Name != "" {
 			volumeClaimSourceName = fmt.Sprintf("%s-%s", podName, volumeClaimTemplate.Name)
@@ -721,24 +721,9 @@ func getEnvForMonitorConfigSubstitution(cluster *fdbv1beta2.FoundationDBCluster,
 	return env
 }
 
-// usePvc determines whether we should attach a PVC to a pod.
-func usePvc(cluster *fdbv1beta2.FoundationDBCluster, processClass fdbv1beta2.ProcessClass) bool {
-	var storage *resource.Quantity
-	processSettings := cluster.GetProcessSettings(processClass)
-
-	if processSettings.VolumeClaimTemplate != nil {
-		requests := processSettings.VolumeClaimTemplate.Spec.Resources.Requests
-		if requests != nil {
-			storageCopy := requests[corev1.ResourceStorage]
-			storage = &storageCopy
-		}
-	}
-	return processClass.IsStateful() && (storage == nil || !storage.IsZero())
-}
-
 // GetPvc builds a persistent volume claim for a FoundationDB process group.
 func GetPvc(cluster *fdbv1beta2.FoundationDBCluster, processGroup *fdbv1beta2.ProcessGroupStatus) (*corev1.PersistentVolumeClaim, error) {
-	if !usePvc(cluster, processGroup.ProcessClass) {
+	if !processGroup.ProcessClass.IsStateful() {
 		return nil, nil
 	}
 

internal/pod_models_test.go

@@ -1698,32 +1698,6 @@ var _ = Describe("pod_models", func() {
 			})
 		})
 
-		Context("with no volume", func() {
-			BeforeEach(func() {
-				cluster.Spec.Processes = map[fdbv1beta2.ProcessClass]fdbv1beta2.ProcessSettings{fdbv1beta2.ProcessClassGeneral: {VolumeClaimTemplate: &corev1.PersistentVolumeClaim{
-					Spec: corev1.PersistentVolumeClaimSpec{
-						Resources: corev1.ResourceRequirements{
-							Requests: corev1.ResourceList{
-								corev1.ResourceStorage: resource.MustParse("0"),
-							},
-						},
-					},
-				}}}
-				err := NormalizeClusterSpec(cluster, DeprecationOptions{})
-				Expect(err).NotTo(HaveOccurred())
-
-				spec, err = GetPodSpec(cluster, GetProcessGroup(cluster, fdbv1beta2.ProcessClassStorage, 1))
-				Expect(err).NotTo(HaveOccurred())
-			})
-
-			It("should use an EmptyDir volume", func() {
-				Expect(spec.Volumes[0]).To(Equal(corev1.Volume{
-					Name:         "data",
-					VolumeSource: corev1.VolumeSource{EmptyDir: &corev1.EmptyDirVolumeSource{}},
-				}))
-			})
-		})
-
 		Context("with a host-based fault domain", func() {
 			BeforeEach(func() {
 				cluster.Spec.FaultDomain = fdbv1beta2.FoundationDBClusterFaultDomain{}
@@ -2779,44 +2753,6 @@ var _ = Describe("pod_models", func() {
 			})
 		})
 
-		Context("with a volume size of 0", func() {
-			BeforeEach(func() {
-				cluster.Spec.Processes = map[fdbv1beta2.ProcessClass]fdbv1beta2.ProcessSettings{fdbv1beta2.ProcessClassGeneral: {VolumeClaimTemplate: &corev1.PersistentVolumeClaim{
-					Spec: corev1.PersistentVolumeClaimSpec{
-						Resources: corev1.ResourceRequirements{
-							Requests: corev1.ResourceList{
-								corev1.ResourceStorage: resource.MustParse("0"),
-							},
-						},
-					},
-				}}}
-				pvc, err = GetPvc(cluster, GetProcessGroup(cluster, fdbv1beta2.ProcessClassStorage, 1))
-				Expect(err).NotTo(HaveOccurred())
-			})
-
-			It("should return a nil PVC", func() {
-				Expect(pvc).To(BeNil())
-			})
-		})
-
-		Context("with a custom storage class", func() {
-			var class string
-			BeforeEach(func() {
-				class = "local"
-				cluster.Spec.Processes = map[fdbv1beta2.ProcessClass]fdbv1beta2.ProcessSettings{fdbv1beta2.ProcessClassGeneral: {VolumeClaimTemplate: &corev1.PersistentVolumeClaim{
-					Spec: corev1.PersistentVolumeClaimSpec{
-						StorageClassName: &class,
-					},
-				}}}
-				pvc, err = GetPvc(cluster, GetProcessGroup(cluster, fdbv1beta2.ProcessClassStorage, 1))
-				Expect(err).NotTo(HaveOccurred())
-			})
-
-			It("should set the storage class on the PVC", func() {
-				Expect(pvc.Spec.StorageClassName).To(Equal(&class))
-			})
-		})
-
 		Context("for a stateless process group", func() {
 			BeforeEach(func() {
 				pvc, err = GetPvc(cluster, GetProcessGroup(cluster, fdbv1beta2.ProcessClassStateless, 1))
@@ -2845,6 +2781,24 @@ var _ = Describe("pod_models", func() {
 			})
 		})
 
+		Context("with a custom storage class", func() {
+			var class string
+			BeforeEach(func() {
+				class = "local"
+				cluster.Spec.Processes = map[fdbv1beta2.ProcessClass]fdbv1beta2.ProcessSettings{fdbv1beta2.ProcessClassGeneral: {VolumeClaimTemplate: &corev1.PersistentVolumeClaim{
+					Spec: corev1.PersistentVolumeClaimSpec{
+						StorageClassName: &class,
+					},
+				}}}
+				pvc, err = GetPvc(cluster, GetProcessGroup(cluster, fdbv1beta2.ProcessClassStorage, 1))
+				Expect(err).NotTo(HaveOccurred())
+			})
+
+			It("should set the storage class on the PVC", func() {
+				Expect(pvc.Spec.StorageClassName).To(Equal(&class))
+			})
+		})
+
 		Context("with an process group ID prefix", func() {
 			BeforeEach(func() {
 				cluster.Spec.ProcessGroupIDPrefix = "dc1"