allow toggling of use of PV annotation to mark its pre-resize capacity

Author: sunpa93

cmd/csi-resizer/main.go

@@ -68,6 +68,8 @@ var (
 
 	handleVolumeInUseError = flag.Bool("handle-volume-inuse-error", true, "Flag to turn on/off capability to handle volume in use error in resizer controller. Defaults to true if not set.")
 
+	enableFSResizeAnnotation = flag.Bool("enable-fs-resize-annotation", true, "Flag to turn on/off capability to add an annotation to PV to denote its size prior to resize and to remove it upon completion of filesystem resize.")
+
 	version = "unknown"
 )
 
@@ -153,7 +155,7 @@ func main() {
 	resizerName := csiResizer.Name()
 	rc := controller.NewResizeController(resizerName, csiResizer, kubeClient, *resyncPeriod, informerFactory,
 		workqueue.NewItemExponentialFailureRateLimiter(*retryIntervalStart, *retryIntervalMax),
-		*handleVolumeInUseError)
+		*handleVolumeInUseError, *enableFSResizeAnnotation)
 	run := func(ctx context.Context) {
 		informerFactory.Start(wait.NeverStop)
 		rc.Run(*workers, ctx)

pkg/controller/controller.go

@@ -66,8 +66,9 @@ type resizeController struct {
 	// a cache to store PersistentVolume objects
 	volumes cache.Store
 	// a cache to store PersistentVolumeClaim objects
-	claims                 cache.Store
-	handleVolumeInUseError bool
+	claims                   cache.Store
+	handleVolumeInUseError   bool
+	enableFSResizeAnnotation bool
 }
 
 // NewResizeController returns a ResizeController.
@@ -78,7 +79,8 @@ func NewResizeController(
 	resyncPeriod time.Duration,
 	informerFactory informers.SharedInformerFactory,
 	pvcRateLimiter workqueue.RateLimiter,
-	handleVolumeInUseError bool) ResizeController {
+	handleVolumeInUseError,
+	enableFSResizeAnnotation bool) ResizeController {
 	pvInformer := informerFactory.Core().V1().PersistentVolumes()
 	pvcInformer := informerFactory.Core().V1().PersistentVolumeClaims()
 	eventBroadcaster := record.NewBroadcaster()
@@ -91,17 +93,18 @@ func NewResizeController(
 		pvcRateLimiter, fmt.Sprintf("%s-pvc", name))
 
 	ctrl := &resizeController{
-		name:                   name,
-		resizer:                resizer,
-		kubeClient:             kubeClient,
-		pvSynced:               pvInformer.Informer().HasSynced,
-		pvcSynced:              pvcInformer.Informer().HasSynced,
-		claimQueue:             claimQueue,
-		volumes:                pvInformer.Informer().GetStore(),
-		claims:                 pvcInformer.Informer().GetStore(),
-		eventRecorder:          eventRecorder,
-		usedPVCs:               newUsedPVCStore(),
-		handleVolumeInUseError: handleVolumeInUseError,
+		name:                     name,
+		resizer:                  resizer,
+		kubeClient:               kubeClient,
+		pvSynced:                 pvInformer.Informer().HasSynced,
+		pvcSynced:                pvcInformer.Informer().HasSynced,
+		claimQueue:               claimQueue,
+		volumes:                  pvInformer.Informer().GetStore(),
+		claims:                   pvcInformer.Informer().GetStore(),
+		eventRecorder:            eventRecorder,
+		usedPVCs:                 newUsedPVCStore(),
+		handleVolumeInUseError:   handleVolumeInUseError,
+		enableFSResizeAnnotation: enableFSResizeAnnotation,
 	}
 
 	// Add a resync period as the PVC's request size can be resized again when we handling
@@ -321,7 +324,7 @@ func (ctrl *resizeController) syncPVC(key string) error {
 		return fmt.Errorf("expected volume but got %+v", volumeObj)
 	}
 
-	if ctrl.isNodeExpandComplete(pvc, pv) && metav1.HasAnnotation(pv.ObjectMeta, util.AnnPreResizeCapacity) {
+	if ctrl.enableFSResizeAnnotation && ctrl.isNodeExpandComplete(pvc, pv) && metav1.HasAnnotation(pv.ObjectMeta, util.AnnPreResizeCapacity) {
 		if err := ctrl.deletePreResizeCapAnnotation(pv); err != nil {
 			return fmt.Errorf("failed removing annotation %s from pv %q: %v", util.AnnPreResizeCapacity, pv.Name, err)
 		}
@@ -568,7 +571,7 @@ func (ctrl *resizeController) updatePVCapacity(pv *v1.PersistentVolume, oldCapac
 	newPV := pv.DeepCopy()
 	newPV.Spec.Capacity[v1.ResourceStorage] = newCapacity
 
-	if fsResizeRequired {
+	if ctrl.enableFSResizeAnnotation && fsResizeRequired {
 		// only update annotation if there already isn't one
 		if !metav1.HasAnnotation(pv.ObjectMeta, util.AnnPreResizeCapacity) {
 			if newPV.ObjectMeta.Annotations == nil {

pkg/controller/controller_test.go

@@ -41,6 +41,7 @@ func TestController(t *testing.T) {
 		// does PVC being expanded has Failed Precondition errors
 		pvcHasInUseErrors              bool
 		disableVolumeInUseErrorHandler bool
+		enableFSResizeAnnotation       bool
 	}{
 		{
 			Name:          "Invalid key",
@@ -98,13 +99,14 @@ func TestController(t *testing.T) {
 			CallCSIExpand: true,
 		},
 		{
-			Name:                   "PV nodeExpand Complete",
-			PVC:                    createPVC(2, 1),
-			PV:                     createPV(1, "testPVC", defaultNS, "foobar", &fsVolumeMode),
-			CreateObjects:          true,
-			NodeResize:             true,
-			CallCSIExpand:          true,
-			expectDeleteAnnotation: true,
+			Name:                     "PV nodeExpand Complete",
+			PVC:                      createPVC(2, 1),
+			PV:                       createPV(1, "testPVC", defaultNS, "foobar", &fsVolumeMode),
+			CreateObjects:            true,
+			NodeResize:               true,
+			CallCSIExpand:            true,
+			expectDeleteAnnotation:   true,
+			enableFSResizeAnnotation: true,
 		},
 		{
 			Name:              "Block Resize PVC with FS resize",
@@ -232,7 +234,7 @@ func TestController(t *testing.T) {
 			t.Fatalf("Test %s: Unable to create resizer: %v", test.Name, err)
 		}
 
-		controller := NewResizeController(driverName, csiResizer, kubeClient, time.Second, informerFactory, workqueue.DefaultControllerRateLimiter(), !test.disableVolumeInUseErrorHandler)
+		controller := NewResizeController(driverName, csiResizer, kubeClient, time.Second, informerFactory, workqueue.DefaultControllerRateLimiter(), !test.disableVolumeInUseErrorHandler, test.enableFSResizeAnnotation)
 
 		ctrlInstance, _ := controller.(*resizeController)
 
@@ -285,7 +287,7 @@ func TestController(t *testing.T) {
 		}
 
 		// check if pre resize capacity annotation get properly populated after volume resize if node expand is required
-		if test.PV != nil && test.CreateObjects {
+		if test.enableFSResizeAnnotation && test.PV != nil && test.CreateObjects {
 			volObj, _, _ := ctrlInstance.volumes.GetByKey("testPV")
 			pv := volObj.(*v1.PersistentVolume)
 			requestCap, statusCap := test.PVC.Spec.Resources.Requests[v1.ResourceStorage], test.PVC.Status.Capacity[v1.ResourceStorage]
@@ -295,7 +297,7 @@ func TestController(t *testing.T) {
 		}
 
 		// check if pre resize capacity annotation gets properly deleted after node expand
-		if test.PVC != nil && test.CreateObjects && test.expectDeleteAnnotation {
+		if test.enableFSResizeAnnotation && test.PVC != nil && test.CreateObjects && test.expectDeleteAnnotation {
 			ctrlInstance.markPVCResizeFinished(test.PVC, test.PVC.Spec.Resources.Requests[v1.ResourceStorage])
 			time.Sleep(time.Second * 2)
 			volObj, _, _ := ctrlInstance.volumes.GetByKey("testPV")
@@ -363,7 +365,7 @@ func TestResizePVC(t *testing.T) {
 			t.Fatalf("Test %s: Unable to create resizer: %v", test.Name, err)
 		}
 
-		controller := NewResizeController(driverName, csiResizer, kubeClient, time.Second, informerFactory, workqueue.DefaultControllerRateLimiter(), true /* disableVolumeInUseErrorHandler*/)
+		controller := NewResizeController(driverName, csiResizer, kubeClient, time.Second, informerFactory, workqueue.DefaultControllerRateLimiter(), true /* disableVolumeInUseErrorHandler*/, true /*enableFsResizeAnnotation*/)
 
 		ctrlInstance, _ := controller.(*resizeController)