Try to make the deleteClaim default more clear (#12313)

scholzj · web-flow · commit 69b52fc10946 · 2026-01-14T18:38:38.000+01:00
Signed-off-by: Jakub Scholz &lt;www@scholzj.com&gt;
diff --git a/api/src/main/java/io/strimzi/api/kafka/model/kafka/PersistentClaimStorage.java b/api/src/main/java/io/strimzi/api/kafka/model/kafka/PersistentClaimStorage.java
@@ -103,7 +103,8 @@ public void setSelector(Map<String, String> selector) {
         this.selector = selector;
     }
 
-    @Description("Specifies if the persistent volume claim has to be deleted when the cluster is un-deployed.")
+    @Description("Specifies whether the persistent volume claim is deleted when a Kafka node is deleted. " +
+            "Optional. Defaults to `false`.")
     @JsonProperty(defaultValue = "false")
     @JsonInclude(JsonInclude.Include.NON_DEFAULT)
     public boolean isDeleteClaim() {
diff --git a/api/src/test/resources/crds/v1/045-Crd-kafkanodepool.yaml b/api/src/test/resources/crds/v1/045-Crd-kafkanodepool.yaml
@@ -69,7 +69,7 @@ spec:
                     description: The storage class to use for dynamic volume allocation.
                   deleteClaim:
                     type: boolean
-                    description: Specifies if the persistent volume claim has to be deleted when the cluster is un-deployed.
+                    description: Specifies whether the persistent volume claim is deleted when a Kafka node is deleted. Optional. Defaults to `false`.
                   id:
                     type: integer
                     minimum: 0
@@ -111,7 +111,7 @@ spec:
                           description: The storage class to use for dynamic volume allocation.
                         deleteClaim:
                           type: boolean
-                          description: Specifies if the persistent volume claim has to be deleted when the cluster is un-deployed.
+                          description: Specifies whether the persistent volume claim is deleted when a Kafka node is deleted. Optional. Defaults to `false`.
                         id:
                           type: integer
                           minimum: 0
diff --git a/documentation/modules/appendix_crds.adoc b/documentation/modules/appendix_crds.adoc
@@ -689,7 +689,7 @@ It must have the value `persistent-claim` for the type `PersistentClaimStorage`.
 |Specifies a specific persistent volume to use. It contains key:value pairs representing labels for selecting such a volume.
 |deleteClaim
 |boolean
-|Specifies if the persistent volume claim has to be deleted when the cluster is un-deployed.
+|Specifies whether the persistent volume claim is deleted when a Kafka node is deleted. Optional. Defaults to `false`.
 |overrides
 |xref:type-PersistentClaimStorageOverride-{context}[`PersistentClaimStorageOverride`] array
 |**The `overrides` property has been deprecated.** The storage overrides for individual brokers are not supported anymore since Strimzi 0.46.0. As of Strimzi 0.46.0, the storage overrides for individual brokers are not supported anymore and this option is ignored.
diff --git a/documentation/modules/cruise-control/proc-cruise-control-moving-data.adoc b/documentation/modules/cruise-control/proc-cruise-control-moving-data.adoc
@@ -369,6 +369,8 @@ spec:
 
 .. Delete the unused PVCs.
 +
+Unless `deleteClaim: true` is set in the volume configuration, the PVCs are not deleted automatically when the node pool configuration is updated, and you have to delete them manually.
++
 PVCs are named using the format `data-<id>-<kafka_cluster_name>-kafka-<pod_id>`. 
 You can list them using:
 +
@@ -384,7 +386,7 @@ Then delete the unused PVCs:
 kubectl delete pvc data-<id>-<kafka_cluster_name>-kafka-<pod_id> -n my-project
 ----
 +
-NOTE: Deleting a PVC removes the underlying storage unless `deleteClaim: false` is set in the volume configuration.
+NOTE: Deleting a PVC removes the underlying storage.
 
 .. (Optional) Delete the helper pod used earlier:
 +
diff --git a/packaging/helm-charts/helm3/strimzi-kafka-operator/crds/045-Crd-kafkanodepool.yaml b/packaging/helm-charts/helm3/strimzi-kafka-operator/crds/045-Crd-kafkanodepool.yaml
@@ -70,7 +70,7 @@ spec:
                       description: The storage class to use for dynamic volume allocation.
                     deleteClaim:
                       type: boolean
-                      description: Specifies if the persistent volume claim has to be deleted when the cluster is un-deployed.
+                      description: Specifies whether the persistent volume claim is deleted when a Kafka node is deleted. Optional. Defaults to `false`.
                     id:
                       type: integer
                       minimum: 0
@@ -112,7 +112,7 @@ spec:
                             description: The storage class to use for dynamic volume allocation.
                           deleteClaim:
                             type: boolean
-                            description: Specifies if the persistent volume claim has to be deleted when the cluster is un-deployed.
+                            description: Specifies whether the persistent volume claim is deleted when a Kafka node is deleted. Optional. Defaults to `false`.
                           id:
                             type: integer
                             minimum: 0
@@ -1354,7 +1354,7 @@ spec:
                       description: The storage class to use for dynamic volume allocation.
                     deleteClaim:
                       type: boolean
-                      description: Specifies if the persistent volume claim has to be deleted when the cluster is un-deployed.
+                      description: Specifies whether the persistent volume claim is deleted when a Kafka node is deleted. Optional. Defaults to `false`.
                     id:
                       type: integer
                       minimum: 0
@@ -1408,7 +1408,7 @@ spec:
                             description: The storage class to use for dynamic volume allocation.
                           deleteClaim:
                             type: boolean
-                            description: Specifies if the persistent volume claim has to be deleted when the cluster is un-deployed.
+                            description: Specifies whether the persistent volume claim is deleted when a Kafka node is deleted. Optional. Defaults to `false`.
                           id:
                             type: integer
                             minimum: 0
diff --git a/packaging/install/cluster-operator/045-Crd-kafkanodepool.yaml b/packaging/install/cluster-operator/045-Crd-kafkanodepool.yaml
@@ -69,7 +69,7 @@ spec:
                     description: The storage class to use for dynamic volume allocation.
                   deleteClaim:
                     type: boolean
-                    description: Specifies if the persistent volume claim has to be deleted when the cluster is un-deployed.
+                    description: Specifies whether the persistent volume claim is deleted when a Kafka node is deleted. Optional. Defaults to `false`.
                   id:
                     type: integer
                     minimum: 0
@@ -111,7 +111,7 @@ spec:
                           description: The storage class to use for dynamic volume allocation.
                         deleteClaim:
                           type: boolean
-                          description: Specifies if the persistent volume claim has to be deleted when the cluster is un-deployed.
+                          description: Specifies whether the persistent volume claim is deleted when a Kafka node is deleted. Optional. Defaults to `false`.
                         id:
                           type: integer
                           minimum: 0
@@ -1353,7 +1353,7 @@ spec:
                     description: The storage class to use for dynamic volume allocation.
                   deleteClaim:
                     type: boolean
-                    description: Specifies if the persistent volume claim has to be deleted when the cluster is un-deployed.
+                    description: Specifies whether the persistent volume claim is deleted when a Kafka node is deleted. Optional. Defaults to `false`.
                   id:
                     type: integer
                     minimum: 0
@@ -1407,7 +1407,7 @@ spec:
                           description: The storage class to use for dynamic volume allocation.
                         deleteClaim:
                           type: boolean
-                          description: Specifies if the persistent volume claim has to be deleted when the cluster is un-deployed.
+                          description: Specifies whether the persistent volume claim is deleted when a Kafka node is deleted. Optional. Defaults to `false`.
                         id:
                           type: integer
                           minimum: 0

Original file line number	Diff line number	Diff line change
`@@ -103,7 +103,8 @@ public void setSelector(Map<String, String> selector) {`
`103`	`103`	`this.selector = selector;`
`104`	`104`	`}`
`105`	`105`
`106`		`- @Description("Specifies if the persistent volume claim has to be deleted when the cluster is un-deployed.")`
	`106`	`+ @Description("Specifies whether the persistent volume claim is deleted when a Kafka node is deleted. " +`
	`107`	+ "Optional. Defaults to `false`.")
`107`	`108`	`@JsonProperty(defaultValue = "false")`
`108`	`109`	`@JsonInclude(JsonInclude.Include.NON_DEFAULT)`
`109`	`110`	`public boolean isDeleteClaim() {`
Original file line number	Diff line number	Diff line change
`@@ -369,6 +369,8 @@ spec:`
`369`	`369`
`370`	`370`	`.. Delete the unused PVCs.`
`371`	`371`	`+`
	`372`	+Unless `deleteClaim: true` is set in the volume configuration, the PVCs are not deleted automatically when the node pool configuration is updated, and you have to delete them manually.
	`373`	`++`
`372`	`374`	PVCs are named using the format `data-<id>-<kafka_cluster_name>-kafka-<pod_id>`.
`373`	`375`	`You can list them using:`
`374`	`376`	`+`
`@@ -384,7 +386,7 @@ Then delete the unused PVCs:`
`384`	`386`	`kubectl delete pvc data-<id>-<kafka_cluster_name>-kafka-<pod_id> -n my-project`
`385`	`387`	`----`
`386`	`388`	`+`
`387`		-NOTE: Deleting a PVC removes the underlying storage unless `deleteClaim: false` is set in the volume configuration.
	`389`	`+NOTE: Deleting a PVC removes the underlying storage.`
`388`	`390`
`389`	`391`	`.. (Optional) Delete the helper pod used earlier:`
`390`	`392`	`+`