Skip to content

stop reconciling workspace when PVC cleanup job fails #851

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AObuchow merged 1 commit into from
Jun 3, 2022
Merged

stop reconciling workspace when PVC cleanup job fails #851

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 14 additions & 12 deletions controllers/workspace/finalize.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,19 +50,21 @@ func (r *DevWorkspaceReconciler) workspaceNeedsFinalize(workspace *dw.DevWorkspa
}

func (r *DevWorkspaceReconciler) finalize(ctx context.Context, log logr.Logger, workspace *dw.DevWorkspace) (reconcile.Result, error) {
workspace.Status.Message = "Cleaning up resources for deletion"
workspace.Status.Phase = devworkspacePhaseTerminating
err := r.Client.Status().Update(ctx, workspace)
if err != nil && !k8sErrors.IsConflict(err) {
return reconcile.Result{}, err
}
if workspace.Status.Phase != dw.DevWorkspaceStatusError {

@AObuchowAObuchowJun 2, 2022

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are potentially other places where the workspace status phase may be set to Error that do not concern the common PVC cleanup job.

For example, finalizeServiceAccount() may set the workspace status phase to Error. Furthermore, it is possible that in the future, other unrelated conditions may set the workspace's status phase to Error.

Thus, it might be best to also check the workspaces condition message for "Failed to clean up DevWorkspace storage" in the finalize function (unless this bug also occurs with finalizeServiceAccount(), which may be likely? 🤔 )

workspace.Status.Message = "Cleaning up resources for deletion"
workspace.Status.Phase = devworkspacePhaseTerminating
err := r.Client.Status().Update(ctx, workspace)
if err != nil && !k8sErrors.IsConflict(err) {
return reconcile.Result{}, err
}

for _, finalizer := range workspace.Finalizers {
switch finalizer {
case storageCleanupFinalizer:
return r.finalizeStorage(ctx, log, workspace)
case serviceAccountCleanupFinalizer:
return r.finalizeServiceAccount(ctx, log, workspace)
for _, finalizer := range workspace.Finalizers {
switch finalizer {
case storageCleanupFinalizer:
return r.finalizeStorage(ctx, log, workspace)
case serviceAccountCleanupFinalizer:
return r.finalizeServiceAccount(ctx, log, workspace)
}
}
}
return reconcile.Result{}, nil
Expand Down