Avoid logging failure message repeatedly in PVC cleanup

Since setting a workspace to the errored status will queue another reconcile, we only log the "failed to clean up common PVC" message if the workspace status is not already set to errored. Signed-off-by: Angel Misevski <[email protected]>
amisevsk · Jul 4, 2022 · 225fbf1 · 225fbf1
1 parent e3805fb
commit 225fbf1
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/controllers/workspace/finalize.go b/controllers/workspace/finalize.go
@@ -113,7 +113,10 @@ func (r *DevWorkspaceReconciler) finalizeStorage(ctx context.Context, log logr.L
 			log.Info(storageErr.Message)
 			return reconcile.Result{RequeueAfter: storageErr.RequeueAfter}, nil
 		case *storage.ProvisioningError:
-			log.Error(storageErr, "Failed to clean up DevWorkspace storage")
+			if workspace.Status.Phase != dw.DevWorkspaceStatusError {
+				// Avoid repeatedly logging error unless it's relevant
+				log.Error(storageErr, "Failed to clean up DevWorkspace storage")
+			}
 			finalizeStatus.phase = dw.DevWorkspaceStatusError
 			finalizeStatus.setConditionTrue(dw.DevWorkspaceError, err.Error())
 			return reconcile.Result{}, nil