Make DM teardown state label public (#62)

Signed-off-by: Nate Roiger <[email protected]>
NearNodeFlash · Sep 9, 2022 · 48559b7 · 48559b7
1 parent 017e544
commit 48559b7
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 22 deletions.
diff --git a/api/v1alpha1/nnf_datamovement_types.go b/api/v1alpha1/nnf_datamovement_types.go
@@ -141,6 +141,22 @@ func (n *NnfDataMovementList) GetObjectList() []client.Object {
 	return objectList
 }
 
+const (
+	// DataMovementTeardownStateLabel is the label applied to Data Movement and related resources that describes
+	// the workflow state when the resource is no longer need and can be safely deleted.
+	DataMovementTeardownStateLabel = "nnf.cray.hpe.com/teardown_state"
+)
+
+func AddDataMovementTeardownStateLabel(object metav1.Object, state string) {
+	labels := object.GetLabels()
+	if labels == nil {
+		labels = make(map[string]string)
+	}
+
+	labels[DataMovementTeardownStateLabel] = state
+	object.SetLabels(labels)
+}
+
 func init() {
 	SchemeBuilder.Register(&NnfDataMovement{}, &NnfDataMovementList{})
 }
diff --git a/controllers/integration_test.go b/controllers/integration_test.go
@@ -1138,7 +1138,7 @@ var _ = Describe("Integration Test", func() {
 				}
 				dwsv1alpha1.AddWorkflowLabels(dm, workflow)
 				dwsv1alpha1.AddOwnerLabels(dm, workflow)
-				addTeardownStateLabel(dm, dwsv1alpha1.StatePostRun.String())
+				nnfv1alpha1.AddDataMovementTeardownStateLabel(dm, dwsv1alpha1.StatePostRun.String())
 
 				Expect(k8sClient.Create(context.TODO(), dm)).To(Succeed())
 

diff --git a/controllers/nnf_workflow_controller.go b/controllers/nnf_workflow_controller.go
@@ -58,11 +58,6 @@ const (
 	// prevents the system from deleting the custom resource until the
 	// reconciler has finished in using the resource.
 	finalizerNnfWorkflow = "nnf.cray.hpe.com/nnf_workflow"
-
-	// teardownStateLabel is a label applied to NnfAccess resources to determine when
-	// they should be deleted. The delete code filters by the current workflow state
-	// to only delete the correct NnfAccess resources
-	teardownStateLabel = "nnf.cray.hpe.com/teardown_state"
 )
 
 type nnfResourceState int
@@ -969,8 +964,8 @@ func (r *NnfWorkflowReconciler) startDataInOutState(ctx context.Context, workflo
 
 				dwsv1alpha1.AddWorkflowLabels(dm, workflow)
 				dwsv1alpha1.AddOwnerLabels(dm, workflow)
+				nnfv1alpha1.AddDataMovementTeardownStateLabel(dm, workflow.Status.State)
 				addDirectiveIndexLabel(dm, index)
-				addTeardownStateLabel(dm, workflow.Status.State)
 
 				log.Info("Creating NNF Data Movement", "name", client.ObjectKeyFromObject(dm).String())
 				if err := r.Create(ctx, dm); err != nil {
@@ -1005,8 +1000,8 @@ func (r *NnfWorkflowReconciler) startDataInOutState(ctx context.Context, workflo
 
 		dwsv1alpha1.AddWorkflowLabels(dm, workflow)
 		dwsv1alpha1.AddOwnerLabels(dm, workflow)
+		nnfv1alpha1.AddDataMovementTeardownStateLabel(dm, workflow.Status.State)
 		addDirectiveIndexLabel(dm, index)
-		addTeardownStateLabel(dm, workflow.Status.State)
 
 		log.Info("Creating NNF Data Movement", "name", client.ObjectKeyFromObject(dm).String())
 		if err := r.Create(ctx, dm); err != nil {
@@ -1053,8 +1048,8 @@ func (r *NnfWorkflowReconciler) setupNnfAccessForServers(ctx context.Context, st
 		func() error {
 			dwsv1alpha1.AddWorkflowLabels(access, workflow)
 			dwsv1alpha1.AddOwnerLabels(access, workflow)
+			nnfv1alpha1.AddDataMovementTeardownStateLabel(access, teardownState)
 			addDirectiveIndexLabel(access, index)
-			addTeardownStateLabel(access, teardownState)
 
 			access.Spec = nnfv1alpha1.NnfAccessSpec{
 				DesiredState:    "mounted",
@@ -1095,7 +1090,7 @@ func (r *NnfWorkflowReconciler) finishDataInOutState(ctx context.Context, workfl
 
 	matchingLabels := dwsv1alpha1.MatchingOwner(workflow)
 	matchingLabels[nnfv1alpha1.DirectiveIndexLabel] = strconv.Itoa(index)
-	matchingLabels[teardownStateLabel] = workflow.Status.State
+	matchingLabels[nnfv1alpha1.DataMovementTeardownStateLabel] = workflow.Status.State
 
 	dataMovementList := &nnfv1alpha1.NnfDataMovementList{}
 	if err := r.List(ctx, dataMovementList, matchingLabels); err != nil {
@@ -1336,7 +1331,7 @@ func (r *NnfWorkflowReconciler) startPostRunState(ctx context.Context, workflow
 
 	// Wait for data movement resources to complete
 	matchingLabels := dwsv1alpha1.MatchingOwner(workflow)
-	matchingLabels[teardownStateLabel] = workflow.Status.State
+	matchingLabels[nnfv1alpha1.DataMovementTeardownStateLabel] = workflow.Status.State
 
 	dataMovementList := &nnfv1alpha1.NnfDataMovementList{}
 	if err := r.List(ctx, dataMovementList, matchingLabels); err != nil {

diff --git a/controllers/nnf_workflow_controller_helpers.go b/controllers/nnf_workflow_controller_helpers.go
@@ -117,14 +117,4 @@ func addDirectiveIndexLabel(object metav1.Object, index int) {
 
 	labels[nnfv1alpha1.DirectiveIndexLabel] = strconv.Itoa(index)
 	object.SetLabels(labels)
-}
-
-func addTeardownStateLabel(object metav1.Object, state string) {
-	labels := object.GetLabels()
-	if labels == nil {
-		labels = make(map[string]string)
-	}
-
-	labels[teardownStateLabel] = state
-	object.SetLabels(labels)
-}
+}