Add comments about processRejectedDevicesForDeviceLinks

Author: gnufied

pkg/diskmaker/controllers/lv/reconcile.go

@@ -501,6 +501,14 @@ func (r *LocalVolumeReconciler) Reconcile(ctx context.Context, request ctrl.Requ
 	return ctrl.Result{Requeue: true, RequeueAfter: requeueTime}, nil
 }
 
+// processRejectedDevicesForDeviceLinks reconciles devices which were rejected for PV creation
+// but otherwise matched user specified path in LocalVolume object.
+//
+// This handles LVDL creation for clusters which were upgraded from older versions of OCP
+// and also updates preferredSymlink, fileSystemUUID and validLinks for PVs which are already
+// mounted and in-use by kubelet.
+//
+// This function is called periodically with Reconcile loop every defaultRequeueTime (1 minute)
 func (r *LocalVolumeReconciler) processRejectedDevicesForDeviceLinks(ctx context.Context, rejectedDevices map[string][]internal.DiskLocation) {
 	for storageClassName, diskLocationArray := range rejectedDevices {
 		symLinkDirPath := path.Join(r.symlinkLocation, storageClassName)

pkg/diskmaker/controllers/lv/reconcile_test.go

@@ -578,7 +578,6 @@ func getFakeDiskMaker(t *testing.T, symlinkLocation string, objs ...runtime.Obje
 	)
 
 	return lvReconciler, tc
-
 }
 
 func getDeiveIDs() []string {

pkg/diskmaker/controllers/lvset/reconcile.go

@@ -264,6 +264,14 @@ func (r *LocalVolumeSetReconciler) Reconcile(ctx context.Context, request ctrl.R
 	return ctrl.Result{Requeue: true, RequeueAfter: requeueTime}, nil
 }
 
+// processRejectedDevicesForDeviceLinks reconciles devices which were rejected for PV creation
+// but otherwise matched user specified path in LocalVolumeSet object.
+//
+// This handles LVDL creation for clusters which were upgraded from older versions of OCP
+// and also updates preferredSymlink, fileSystemUUID and validLinks for PVs which are already
+// mounted and in-use by kubelet.
+//
+// This function is called periodically with Reconcile loop every defaultRequeueTime (1 minute)
 func (r *LocalVolumeSetReconciler) processRejectedDevicesForDeviceLinks(ctx context.Context, lvset *localv1alpha1.LocalVolumeSet, rejectedDevices []internal.BlockDevice, symLinkDir, storageClassName string) {
 	klog.V(2).InfoS("processing rejected devices for LocalVolumeDeviceLink")
 	for _, blockDevice := range rejectedDevices {

pkg/internal/device_link_handler.go

@@ -34,6 +34,9 @@ func NewDeviceLinkHandler(currentSymlink string, client client.Client) *DeviceLi
 	}
 }
 
+// Create creates a LVDL object without fully setting all status fields.
+// This can be used before creation of PV during normal provisioning operation and
+// status can be updated afterwards.
 func (dl *DeviceLinkHandler) Create(ctx context.Context, pvName, namespace string, ownerObj runtime.Object) (*v1.LocalVolumeDeviceLink, error) {
 	existing := &v1.LocalVolumeDeviceLink{}
 	key := types.NamespacedName{Name: pvName, Namespace: namespace}