Merge pull request #1237 from rabbitmq/pvc-retention-policy-override

Add StatefulSet.Spec.PersistentVolumeClaimRetentionPolicy Override.

Author: MirahImage

api/v1beta1/rabbitmqcluster_types.go

@@ -252,6 +252,11 @@ type StatefulSetSpec struct {
 	// is ready).
 	// +optional
 	MinReadySeconds int32 `json:"minReadySeconds,omitempty" protobuf:"varint,4,opt,name=minReadySeconds"`
+
+	// StatefulSetPersistentVolumeClaimRetentionPolicy describes the policy used for PVCs
+	// created from the StatefulSet VolumeClaimTemplates.
+	// +optional
+	PersistentVolumeClaimRetentionPolicy *appsv1.StatefulSetPersistentVolumeClaimRetentionPolicy `json:"persistenVolumeClaimRetentionPolicy,omitempty" protobuf:"bytes,10,opt,name=persistentVolumeClaimRetentionPolicy"`
 }
 
 // EmbeddedLabelsAnnotations is an embedded subset of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta.

api/v1beta1/zz_generated.deepcopy.go

@@ -668,6 +668,13 @@ spec:
                             minReadySeconds:
                               format: int32
                               type: integer
+                            persistenVolumeClaimRetentionPolicy:
+                              properties:
+                                whenDeleted:
+                                  type: string
+                                whenScaled:
+                                  type: string
+                              type: object
                             podManagementPolicy:
                               type: string
                             replicas:

config/crd/bases/rabbitmq.com_rabbitmqclusters.yaml

@@ -411,6 +411,7 @@ StatefulSetSpec contains a subset of the fields included in k8s.io/api/apps/v1.S
 | *`podManagementPolicy`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#podmanagementpolicytype-v1-apps[$$PodManagementPolicyType$$]__ | podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is `OrderedReady`, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is `Parallel` which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once.
 | *`updateStrategy`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#statefulsetupdatestrategy-v1-apps[$$StatefulSetUpdateStrategy$$]__ | updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template.
 | *`minReadySeconds`* __integer__ | The minimum number of seconds for which a newly created StatefulSet pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready).
+| *`persistenVolumeClaimRetentionPolicy`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#statefulsetpersistentvolumeclaimretentionpolicy-v1-apps[$$StatefulSetPersistentVolumeClaimRetentionPolicy$$]__ | StatefulSetPersistentVolumeClaimRetentionPolicy describes the policy used for PVCs created from the StatefulSet VolumeClaimTemplates.
 |===
 
 

docs/api/rabbitmq.com.ref.asciidoc

@@ -191,6 +191,10 @@ func applyStsOverride(instance *rabbitmqv1beta1.RabbitmqCluster, scheme *runtime
 		}
 	}
 
+	if stsOverride.Spec.PersistentVolumeClaimRetentionPolicy != nil {
+		sts.Spec.PersistentVolumeClaimRetentionPolicy = stsOverride.Spec.PersistentVolumeClaimRetentionPolicy
+	}
+
 	if stsOverride.Spec.Template == nil {
 		return nil
 	}

internal/resource/statefulset.go

@@ -1669,6 +1669,22 @@ default_pass = {{ .Data.data.password }}
 				Expect(*statefulSet.Spec.UpdateStrategy.RollingUpdate.Partition).To(Equal(int32(1)))
 			})
 
+			It("overrides statefulSet.spec.persistentVolumeClaimRetentionPolicy", func() {
+				instance.Spec.Override.StatefulSet = &rabbitmqv1beta1.StatefulSet{
+					Spec: &rabbitmqv1beta1.StatefulSetSpec{
+						PersistentVolumeClaimRetentionPolicy: &appsv1.StatefulSetPersistentVolumeClaimRetentionPolicy{
+							WhenDeleted: "Retain",
+							WhenScaled:  "Delete",
+						},
+					},
+				}
+
+				stsBuilder := builder.StatefulSet()
+				Expect(stsBuilder.Update(statefulSet)).To(Succeed())
+				Expect(string(statefulSet.Spec.PersistentVolumeClaimRetentionPolicy.WhenScaled)).To(Equal("Delete"))
+				Expect(string(statefulSet.Spec.PersistentVolumeClaimRetentionPolicy.WhenDeleted)).To(Equal("Retain"))
+			})
+
 			It("overrides the PVC list", func() {
 				storageClass := "my-storage-class"
 				builder.Instance.Spec.Override.StatefulSet = &rabbitmqv1beta1.StatefulSet{