Merge pull request #8 from DataDog/agaillard/custom-params

[local] Add annotations defined params to volume creation request

Author: antoine-gaillard

pkg/controller/controller.go

@@ -614,7 +614,15 @@ func (p *csiProvisioner) prepareProvision(ctx context.Context, claim *v1.Persist
 		}
 	}
 
-	if vacName != "" {
+	// Get mutable parameters from claim annotations
+	mutableParameters := make(map[string]string)
+	for k, v := range claim.Annotations {
+		if param, ok := strings.CutPrefix(k, p.driverName+"/"); ok {
+			mutableParameters[param] = v
+		}
+	}
+
+	if vacName != "" || len(mutableParameters) > 0 {
 		rc.modifyVolume = true
 	}
 
@@ -665,6 +673,7 @@ func (p *csiProvisioner) prepareProvision(ctx context.Context, claim *v1.Persist
 		CapacityRange: &csi.CapacityRange{
 			RequiredBytes: int64(volSizeBytes),
 		},
+		MutableParameters: mutableParameters,
 	}
 
 	if dataSource != nil && (rc.clone || rc.snapshot) {
@@ -769,6 +778,7 @@ func (p *csiProvisioner) prepareProvision(ctx context.Context, claim *v1.Persist
 			return nil, controller.ProvisioningFinished, fmt.Errorf("VAC %s referenced in PVC is for driver %s which does not match driver name %s", vacName, vac.DriverName, p.driverName)
 		}
 
+		// Override any mutable parameters set through annotation on the claim
 		req.MutableParameters = vac.Parameters
 	}
 
@@ -903,12 +913,21 @@ func (p *csiProvisioner) Provision(ctx context.Context, options controller.Provi
 		pvReadOnly = true
 	}
 
+	// Add mutable parameters as annotations so that volume modifier skips them.
+	annotations := map[string]string{}
+	for k, v := range options.PVC.Annotations {
+		if strings.HasPrefix(k, p.driverName+"/") {
+			annotations[k] = v
+		}
+	}
+
 	result.csiPVSource.VolumeHandle = p.volumeIdToHandle(rep.Volume.VolumeId)
 	result.csiPVSource.VolumeAttributes = volumeAttributes
 	result.csiPVSource.ReadOnly = pvReadOnly
 	pv := &v1.PersistentVolume{
 		ObjectMeta: metav1.ObjectMeta{
-			Name: pvName,
+			Name:        pvName,
+			Annotations: annotations,
 		},
 		Spec: v1.PersistentVolumeSpec{
 			AccessModes:  options.PVC.Spec.AccessModes,

pkg/controller/controller_test.go

@@ -564,6 +564,12 @@ func createFakePVCWithVAC(requestBytes int64, vacName string) *v1.PersistentVolu
 	return claim
 }
 
+// createFakePVCWithVAC returns PVC with Annotations
+func createFakePVCWithAnnotations(requestBytes int64, annotations map[string]string) *v1.PersistentVolumeClaim {
+	claim := createFakeNamedPVC(requestBytes, "fake-pvc", annotations)
+	return claim
+}
+
 // fakeClaim returns a valid PVC with the requested settings
 func fakeClaim(name, namespace, claimUID string, capacity int64, boundToVolume string, phase v1.PersistentVolumeClaimPhase, class *string, mode string) *v1.PersistentVolumeClaim {
 	claim := v1.PersistentVolumeClaim{
@@ -2376,6 +2382,46 @@ func provisionTestcases() (int64, map[string]provisioningTestcase) {
 			},
 			expectState: controller.ProvisioningFinished,
 		},
+		"normal provision with custom params in annotations": {
+			pluginCapabilities: provisionWithVACCapabilities,
+			expectCreateVolDo: func(t *testing.T, ctx context.Context, req *csi.CreateVolumeRequest) {
+				if !reflect.DeepEqual(req.MutableParameters, map[string]string{"iops": "10000"}) {
+					t.Errorf("Missing or incorrect mutable parameters")
+				}
+			},
+			volOpts: controller.ProvisionOptions{
+				StorageClass: &storagev1.StorageClass{
+					ReclaimPolicy: &deletePolicy,
+					Parameters: map[string]string{
+						"fstype":     "ext3",
+						"test-param": "from-sc",
+					},
+				},
+				PVName: "test-name",
+				PVC:    createFakePVCWithAnnotations(requestedBytes, map[string]string{driverName + "/iops": "10000"}),
+			},
+			expectedPVSpec: &pvSpec{
+				Name: "test-testi",
+				Annotations: map[string]string{
+					annDeletionProvisionerSecretRefName:      "",
+					annDeletionProvisionerSecretRefNamespace: "",
+					driverName + "/iops":                     "10000",
+				},
+				ReclaimPolicy: v1.PersistentVolumeReclaimDelete,
+				Capacity: v1.ResourceList{
+					v1.ResourceName(v1.ResourceStorage): bytesToQuantity(requestedBytes),
+				},
+				CSIPVS: &v1.CSIPersistentVolumeSource{
+					Driver:       "test-driver",
+					VolumeHandle: "test-volume-id",
+					FSType:       "ext3",
+					VolumeAttributes: map[string]string{
+						"storage.kubernetes.io/csiProvisionerIdentity": "test-provisioner",
+					},
+				},
+			},
+			expectState: controller.ProvisioningFinished,
+		},
 		"normal provision with VolumeAttributesClass but feature gate is disabled": {
 			featureGates: map[featuregate.Feature]bool{
 				features.VolumeAttributesClass: false,