Skip to content

[ws-manager-mk2] Refactor workspace status conditions #16896

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.

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
merged 2 commits into from
Mar 20, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
30 changes: 4 additions & 26 deletions components/ws-daemon/pkg/controller/workspace_controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -170,20 +170,9 @@ func (wsc *WorkspaceController) handleWorkspaceInit(ctx context.Context, ws *wor

if failure != "" {
log.Error(initErr, "could not initialize workspace", "name", ws.Name)
ws.Status.Conditions = wsk8s.AddUniqueCondition(ws.Status.Conditions, metav1.Condition{
Type: string(workspacev1.WorkspaceConditionContentReady),
Status: metav1.ConditionFalse,
Message: failure,
Reason: "InitializationFailure",
LastTransitionTime: metav1.Now(),
})
ws.Status.SetCondition(workspacev1.NewWorkspaceConditionContentReady(metav1.ConditionFalse, "InitializationFailure", failure))
} else {
ws.Status.Conditions = wsk8s.AddUniqueCondition(ws.Status.Conditions, metav1.Condition{
Type: string(workspacev1.WorkspaceConditionContentReady),
Status: metav1.ConditionTrue,
Reason: "InitializationSuccess",
LastTransitionTime: metav1.Now(),
})
ws.Status.SetCondition(workspacev1.NewWorkspaceConditionContentReady(metav1.ConditionTrue, "InitializationSuccess", ""))
}

return wsc.Status().Update(ctx, ws)
Expand Down Expand Up @@ -276,20 +265,9 @@ func (wsc *WorkspaceController) handleWorkspaceStop(ctx context.Context, ws *wor

if disposeErr != nil {
log.Error(disposeErr, "failed to dispose workspace", "name", ws.Name)
ws.Status.Conditions = wsk8s.AddUniqueCondition(ws.Status.Conditions, metav1.Condition{
Type: string(workspacev1.WorkspaceConditionBackupFailure),
Status: metav1.ConditionTrue,
Reason: "BackupFailed",
Message: disposeErr.Error(),
LastTransitionTime: metav1.Now(),
})
ws.Status.SetCondition(workspacev1.NewWorkspaceConditionBackupFailure(disposeErr.Error()))
} else {
ws.Status.Conditions = wsk8s.AddUniqueCondition(ws.Status.Conditions, metav1.Condition{
Type: string(workspacev1.WorkspaceConditionBackupComplete),
Status: metav1.ConditionTrue,
Reason: "BackupComplete",
LastTransitionTime: metav1.Now(),
})
ws.Status.SetCondition(workspacev1.NewWorkspaceConditionBackupComplete())
}

return wsc.Status().Update(ctx, ws)
Expand Down
98 changes: 98 additions & 0 deletions components/ws-manager-api/go/crd/v1/workspace_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
package v1

import (
wsk8s "github.com/gitpod-io/gitpod/common-go/kubernetes"
corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)
Expand Down Expand Up @@ -140,6 +141,10 @@ type WorkspaceStatus struct {
Runtime *WorkspaceRuntimeStatus `json:"runtime,omitempty"`
}

func (s *WorkspaceStatus) SetCondition(cond metav1.Condition) {
s.Conditions = wsk8s.AddUniqueCondition(s.Conditions, cond)
}

// +kubebuilder:validation:Enum=Deployed;Failed;Timeout;FirstUserActivity;Closed;HeadlessTaskFailed;StoppedByRequest;Aborted;ContentReady;BackupComplete;BackupFailure
type WorkspaceCondition string

Expand Down Expand Up @@ -180,6 +185,99 @@ const (
WorkspaceConditionBackupFailure WorkspaceCondition = "BackupFailure"
)

func NewWorkspaceConditionDeployed() metav1.Condition {
return metav1.Condition{
Type: string(WorkspaceConditionDeployed),
LastTransitionTime: metav1.Now(),
Status: metav1.ConditionTrue,
}
}

func NewWorkspaceConditionFailed(message string) metav1.Condition {
return metav1.Condition{
Type: string(WorkspaceConditionFailed),
LastTransitionTime: metav1.Now(),
Status: metav1.ConditionTrue,
Message: message,
}
}

func NewWorkspaceConditionTimeout(message string) metav1.Condition {
return metav1.Condition{
Type: string(WorkspaceConditionTimeout),
LastTransitionTime: metav1.Now(),
Status: metav1.ConditionTrue,
Reason: "TimedOut",
Message: message,
}
}

func NewWorkspaceConditionFirstUserActivity() metav1.Condition {
return metav1.Condition{
Type: string(WorkspaceConditionFirstUserActivity),
LastTransitionTime: metav1.Now(),
Status: metav1.ConditionTrue,
Reason: "MarkActiveRequest",
Copy link
Member

Choose a reason for hiding this comment

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

maybe we should change the Reason now, as it might be called from other places than the MarkActive request handler

}
}

func NewWorkspaceConditionClosed(status metav1.ConditionStatus) metav1.Condition {
return metav1.Condition{
Type: string(WorkspaceConditionClosed),
LastTransitionTime: metav1.Now(),
Status: status,
Reason: "MarkActiveRequest",
}
}

func NewWorkspaceConditionStoppedByRequest(message string) metav1.Condition {
return metav1.Condition{
Type: string(WorkspaceConditionStoppedByRequest),
LastTransitionTime: metav1.Now(),
Status: metav1.ConditionTrue,
Reason: "StopWorkspaceRequest",
Message: message,
}
}

func NewWorkspaceConditionAborted(reason string) metav1.Condition {
return metav1.Condition{
Type: string(WorkspaceConditionAborted),
LastTransitionTime: metav1.Now(),
Status: metav1.ConditionTrue,
Reason: reason,
}
}

func NewWorkspaceConditionContentReady(status metav1.ConditionStatus, reason, message string) metav1.Condition {
return metav1.Condition{
Type: string(WorkspaceConditionContentReady),
LastTransitionTime: metav1.Now(),
Status: status,
Reason: reason,
Message: message,
}
}

func NewWorkspaceConditionBackupComplete() metav1.Condition {
return metav1.Condition{
Type: string(WorkspaceConditionBackupComplete),
LastTransitionTime: metav1.Now(),
Status: metav1.ConditionTrue,
Reason: "BackupComplete",
}
}

func NewWorkspaceConditionBackupFailure(message string) metav1.Condition {
return metav1.Condition{
Type: string(WorkspaceConditionBackupFailure),
LastTransitionTime: metav1.Now(),
Status: metav1.ConditionTrue,
Reason: "BackupFailed",
Message: message,
}
}

// +kubebuilder:validation:Enum:=Unknown;Pending;Imagebuild;Creating;Initializing;Running;Stopping;Stopped
type WorkspacePhase string

Expand Down
15 changes: 3 additions & 12 deletions components/ws-manager-mk2/controllers/status.go
Original file line number Diff line number Diff line change
Expand Up @@ -48,22 +48,13 @@ func updateWorkspaceStatus(ctx context.Context, workspace *workspacev1.Workspace
// continue below
default:
// This is exceptional - not sure what to do here. Probably fail the pod
workspace.Status.Conditions = wsk8s.AddUniqueCondition(workspace.Status.Conditions, metav1.Condition{
Type: string(workspacev1.WorkspaceConditionFailed),
Status: metav1.ConditionTrue,
LastTransitionTime: metav1.Now(),
Message: "multiple pods exists - this should never happen",
})

workspace.Status.SetCondition(
workspacev1.NewWorkspaceConditionFailed("multiple pods exists - this should never happen"))
return nil
}

if c := wsk8s.GetCondition(workspace.Status.Conditions, string(workspacev1.WorkspaceConditionDeployed)); c == nil {
workspace.Status.Conditions = wsk8s.AddUniqueCondition(workspace.Status.Conditions, metav1.Condition{
Type: string(workspacev1.WorkspaceConditionDeployed),
Status: metav1.ConditionTrue,
LastTransitionTime: metav1.Now(),
})
workspace.Status.SetCondition(workspacev1.NewWorkspaceConditionDeployed())
}

pod := &pods.Items[0]
Expand Down
10 changes: 1 addition & 9 deletions components/ws-manager-mk2/controllers/timeout_controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ import (
"time"

apierrors "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/types"
"k8s.io/client-go/util/retry"
ctrl "sigs.k8s.io/controller-runtime"
Expand Down Expand Up @@ -103,14 +102,7 @@ func (r *TimeoutReconciler) Reconcile(ctx context.Context, req ctrl.Request) (re
return err
}

workspace.Status.Conditions = wsk8s.AddUniqueCondition(workspace.Status.Conditions, metav1.Condition{
Type: string(workspacev1.WorkspaceConditionTimeout),
Status: metav1.ConditionTrue,
LastTransitionTime: metav1.Now(),
Reason: "TimedOut",
Message: timedout,
})

workspace.Status.SetCondition(workspacev1.NewWorkspaceConditionTimeout(timedout))
return r.Status().Update(ctx, &workspace)
}); err != nil {
log.Error(err, "Failed to update workspace status with Timeout condition")
Expand Down
38 changes: 6 additions & 32 deletions components/ws-manager-mk2/service/manager.go
Original file line number Diff line number Diff line change
Expand Up @@ -356,25 +356,14 @@ func (wsm *WorkspaceManagerServer) StopWorkspace(ctx context.Context, req *wsman
span.LogKV("policy", "abort")
gracePeriod = stopWorkspaceImmediatelyGracePeriod
if err = wsm.modifyWorkspace(ctx, req.Id, true, func(ws *workspacev1.Workspace) error {
ws.Status.Conditions = wsk8s.AddUniqueCondition(ws.Status.Conditions, metav1.Condition{
Type: string(workspacev1.WorkspaceConditionAborted),
Status: metav1.ConditionTrue,
Reason: "StopWorkspaceRequest",
LastTransitionTime: metav1.Now(),
})
ws.Status.SetCondition(workspacev1.NewWorkspaceConditionAborted("StopWorkspaceRequest"))
return nil
}); err != nil {
log.Error(err, "failed to add Aborted condition to workspace")
}
}
err = wsm.modifyWorkspace(ctx, req.Id, true, func(ws *workspacev1.Workspace) error {
ws.Status.Conditions = wsk8s.AddUniqueCondition(ws.Status.Conditions, metav1.Condition{
Type: string(workspacev1.WorkspaceConditionStoppedByRequest),
Status: metav1.ConditionTrue,
LastTransitionTime: metav1.Now(),
Message: gracePeriod.String(),
Reason: "StopWorkspaceRequest",
})
ws.Status.SetCondition(workspacev1.NewWorkspaceConditionStoppedByRequest(gracePeriod.String()))
return nil
})
if err != nil {
Expand Down Expand Up @@ -473,27 +462,17 @@ func (wsm *WorkspaceManagerServer) MarkActive(ctx context.Context, req *wsmanapi
now := time.Now().UTC()
wsm.activity.Store(req.Id, now)

// We do however maintain the the "closed" flag as annotation on the workspace. This flag should not change
// We do however maintain the the "closed" flag as condition on the workspace. This flag should not change
// very often and provides a better UX if it persists across ws-manager restarts.
isMarkedClosed := wsk8s.ConditionPresentAndTrue(ws.Status.Conditions, string(workspacev1.WorkspaceConditionClosed))
if req.Closed && !isMarkedClosed {
err = wsm.modifyWorkspace(ctx, req.Id, true, func(ws *workspacev1.Workspace) error {
ws.Status.Conditions = wsk8s.AddUniqueCondition(ws.Status.Conditions, metav1.Condition{
Type: string(workspacev1.WorkspaceConditionClosed),
Status: metav1.ConditionTrue,
LastTransitionTime: metav1.NewTime(now),
Reason: "MarkActiveRequest",
})
ws.Status.SetCondition(workspacev1.NewWorkspaceConditionClosed(metav1.ConditionTrue))
return nil
})
} else if !req.Closed && isMarkedClosed {
err = wsm.modifyWorkspace(ctx, req.Id, true, func(ws *workspacev1.Workspace) error {
ws.Status.Conditions = wsk8s.AddUniqueCondition(ws.Status.Conditions, metav1.Condition{
Type: string(workspacev1.WorkspaceConditionClosed),
Status: metav1.ConditionFalse,
LastTransitionTime: metav1.NewTime(now),
Reason: "MarkActiveRequest",
})
ws.Status.SetCondition(workspacev1.NewWorkspaceConditionClosed(metav1.ConditionFalse))
return nil
})
}
Expand All @@ -508,12 +487,7 @@ func (wsm *WorkspaceManagerServer) MarkActive(ctx context.Context, req *wsmanapi
// If it's the first call: Mark the pod with FirstUserActivity condition.
if firstUserActivity == nil {
err := wsm.modifyWorkspace(ctx, req.Id, true, func(ws *workspacev1.Workspace) error {
ws.Status.Conditions = wsk8s.AddUniqueCondition(ws.Status.Conditions, metav1.Condition{
Type: string(workspacev1.WorkspaceConditionFirstUserActivity),
Status: metav1.ConditionTrue,
LastTransitionTime: metav1.NewTime(now),
Reason: "MarkActiveRequest",
})
ws.Status.SetCondition(workspacev1.NewWorkspaceConditionFirstUserActivity())
return nil
})
if err != nil {
Expand Down