fix: common PVC cleanup job to be assigned to a correct node (#1415)

* fix: common PVC cleanup job to be assigned to a correct node

Signed-off-by: Oleksii Kurinnyi <[email protected]>

* Update pkg/constants/constants.go

Co-authored-by: Rohan Kumar  <[email protected]>
Signed-off-by: Oleksii Kurinnyi <[email protected]>

* Update pkg/provision/storage/cleanup.go

Co-authored-by: David Kwon <[email protected]>
Signed-off-by: Oleksii Kurinnyi <[email protected]>

---------

Signed-off-by: Oleksii Kurinnyi <[email protected]>
Co-authored-by: Rohan Kumar <[email protected]>
Co-authored-by: David Kwon <[email protected]>

Author: 3 people

pkg/constants/constants.go

@@ -96,3 +96,8 @@ const (
 	// ProjectCloneDisable specifies that project cloning should be disabled.
 	ProjectCloneDisable = "disable"
 )
+
+const (
+	// SelectedNodeAnnotation annotation is added to a PVC that is triggered by a scheduler to be dynamically provisioned. Its value is the name of the selected node.
+	SelectedNodeAnnotation = "volume.kubernetes.io/selected-node"
+)

pkg/provision/storage/cleanup.go

@@ -120,6 +120,13 @@ func getSpecCommonPVCCleanupJob(workspace *common.DevWorkspaceWithConfig, cluste
 		pvcName = workspace.Config.Workspace.PVCName
 	}
 
+	targetNode, err := getCommonPVCTargetNode(workspace, clusterAPI)
+	if err != nil {
+		clusterAPI.Logger.Info("Error getting target node for PVC", "PVC", fmt.Sprintf("%s/%s", workspace.Namespace, workspace.Config.Workspace.PVCName), "error", err)
+	} else if targetNode == "" {
+		clusterAPI.Logger.Info("PVC does not have a target node annotation", "PVC", fmt.Sprintf("%s/%s", workspace.Namespace, workspace.Config.Workspace.PVCName))
+	}
+
 	jobLabels := map[string]string{
 		constants.DevWorkspaceIDLabel:      workspaceId,
 		constants.DevWorkspaceNameLabel:    workspace.Name,
@@ -189,11 +196,30 @@ func getSpecCommonPVCCleanupJob(workspace *common.DevWorkspaceWithConfig, cluste
 							},
 						},
 					},
+					Affinity: &corev1.Affinity{},
 				},
 			},
 		},
 	}
 
+	if targetNode != "" {
+		job.Spec.Template.Spec.Affinity.NodeAffinity = &corev1.NodeAffinity{
+			RequiredDuringSchedulingIgnoredDuringExecution: &corev1.NodeSelector{
+				NodeSelectorTerms: []corev1.NodeSelectorTerm{
+					{
+						MatchExpressions: []corev1.NodeSelectorRequirement{
+							{
+								Key:      corev1.LabelHostname,
+								Operator: corev1.NodeSelectorOpIn,
+								Values:   []string{targetNode},
+							},
+						},
+					},
+				},
+			},
+		}
+	}
+
 	podTolerations, nodeSelector, err := nsconfig.GetNamespacePodTolerationsAndNodeSelector(workspace.Namespace, clusterAPI)
 	if err != nil {
 		return nil, err
@@ -226,3 +252,22 @@ func commonPVCExists(workspace *common.DevWorkspaceWithConfig, clusterAPI sync.C
 	}
 	return true, nil
 }
+
+func getCommonPVCTargetNode(workspace *common.DevWorkspaceWithConfig, clusterAPI sync.ClusterAPI) (string, error) {
+	namespacedName := types.NamespacedName{
+		Name:      workspace.Config.Workspace.PVCName,
+		Namespace: workspace.Namespace,
+	}
+	pvc := &corev1.PersistentVolumeClaim{}
+	err := clusterAPI.Client.Get(clusterAPI.Ctx, namespacedName, pvc)
+	if err != nil {
+		return "", err
+	}
+
+	targetNode := ""
+	if pvc.Annotations != nil {
+		targetNode = pvc.Annotations[constants.SelectedNodeAnnotation]
+	}
+
+	return targetNode, nil
+}